docs/documentation/3.1/rspec-rails/RSpec/Rails/ViewExampleGroup/ExampleMethods.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
  Module: RSpec::Rails::ViewExampleGroup::ExampleMethods
    &mdash; Documentation by YARD 0.8.7.3
</title>
  <link rel="stylesheet" href="/stylesheets/docs/style.css" type="text/css" charset="utf-8" />
  <link rel="stylesheet" href="/stylesheets/docs/common.css" type="text/css" charset="utf-8" />
  <link rel="stylesheet" href="/stylesheets/docs/rspec.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
  hasFrames = window.top.frames.main ? true : false;
  relpath = '../../../';
  framesUrl = "../../../frames.html#!" + escape(window.location.href);
</script>
  <script type="text/javascript" charset="utf-8" src="/javascripts/docs/jquery.js"></script>
  <script type="text/javascript" charset="utf-8" src="/javascripts/docs/app.js"></script>
  </head>
  <body>
    <div id="header">
      <div id="menu">
    <a href="../../../_index.html">Index (E)</a> &raquo;
    <span class='title'><span class='object_link'><a href="../../../RSpec.html" title="RSpec (module)">RSpec</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Rails.html" title="RSpec::Rails (module)">Rails</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../ViewExampleGroup.html" title="RSpec::Rails::ViewExampleGroup (module)">ViewExampleGroup</a></span></span>
     &raquo; 
    <span class="title">ExampleMethods</span>
  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
      <div id="search">
    <a class="full_list_link" id="class_list_link"
        href="../../../class_list.html">
      Class List
    </a>
    <a class="full_list_link" id="method_list_link"
        href="../../../method_list.html">
      Method List
    </a>
    <a class="full_list_link" id="file_list_link"
        href="../../../file_list.html">
      File List
    </a>
</div>
      <div class="clear"></div>
    </div>
    <iframe id="search_frame"></iframe>
    <div id="content"><h1>Module: RSpec::Rails::ViewExampleGroup::ExampleMethods
  <span class="private note title">Private</span>
</h1>
<dl class="box">
    <dt class="r1 last">Defined in:</dt>
    <dd class="r1 last">lib/rspec/rails/example/view_example_group.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    <p class="note private">
  <strong>This module is part of a private API.</strong>
  You should avoid using this module if possible, as it may be removed or be changed in the future.
</p>
<p>DSL exposed to view specs.</p>
  </div>
</div>
<div class="tags">
</div>
    <h2>
      Instance Method Summary
      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
    </h2>
    <ul class="summary">
        <li class="public ">
  <span class="summary_signature">
      <a href="#params-instance_method" title="#params (instance method)">- (Object) <strong>params</strong> </a>
  </span>
  <span class="private note title">private</span>
    <span class="summary_desc"><div class='inline'><p>Provides access to the params hash that will be available within the view.</p>
</div></span>
</li>
        <li class="public ">
  <span class="summary_signature">
      <a href="#render-instance_method" title="#render (instance method)">- (Object) <strong>render</strong>(options = {}, local_assigns = {}, &amp;block) </a>
  </span>
  <span class="private note title">private</span>
    <span class="summary_desc"><div class='inline'><p>Delegates to ActionView::Base#render, so see documentation on that for more info.</p>
</div></span>
</li>
        <li class="public deprecated">
  <span class="summary_signature">
      <a href="#response-instance_method" title="#response (instance method)">- (Object) <strong>response</strong> </a>
  </span>
  <span class="deprecated note title">deprecated</span>
  <span class="private note title">private</span>
    <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'><p>Use <code>rendered</code> instead.</p>
</div></span>
</li>
        <li class="public ">
  <span class="summary_signature">
      <a href="#stub_template-instance_method" title="#stub_template (instance method)">- (Object) <strong>stub_template</strong>(hash) </a>
  </span>
  <span class="private note title">private</span>
    <span class="summary_desc"><div class='inline'><p>Simulates the presence of a template on the file system by adding a Rails&#39; FixtureResolver to the front of the view_paths list.</p>
</div></span>
</li>
        <li class="public deprecated">
  <span class="summary_signature">
      <a href="#template-instance_method" title="#template (instance method)">- (Object) <strong>template</strong> </a>
  </span>
  <span class="deprecated note title">deprecated</span>
  <span class="private note title">private</span>
    <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'><p>Use <code>view</code> instead.</p>
</div></span>
</li>
        <li class="public ">
  <span class="summary_signature">
      <a href="#view-instance_method" title="#view (instance method)">- (Object) <strong>view</strong> </a>
  </span>
  <span class="private note title">private</span>
    <span class="summary_desc"><div class='inline'><p>The instance of <code>ActionView::Base</code> that is used to render the template.</p>
</div></span>
</li>
    </ul>
  <div id="instance_method_details" class="method_details_list">
    <h2>Instance Method Details</h2>
      <div class="method_details first">
  <h3 class="signature first" id="params-instance_method">
    - (<tt>Object</tt>) <strong>params</strong> 
</h3><div class="docstring">
  <div class="discussion">
    <p class="note private">
  <strong>This method is part of a private API.</strong>
  You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Provides access to the params hash that will be available within the
view.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:foo</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>bar</span><span class='tstring_end'>&#39;</span></span>
</code></pre>
  </div>
</div>
<div class="tags">
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">
81
82
83</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rspec/rails/example/view_example_group.rb', line 81</span>
<span class='kw'>def</span> <span class='id identifier rubyid_params'>params</span>
  <span class='id identifier rubyid_controller'>controller</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
      <div class="method_details ">
  <h3 class="signature " id="render-instance_method">
      <span class="overload">- (<tt>Object</tt>) <strong>render</strong> </span>
      <span class="overload">- (<tt>Object</tt>) <strong>render</strong>({:partial = &gt; path_to_file}) </span>
      <span class="overload">- (<tt>Object</tt>) <strong>render</strong>({:partial = &gt; path_to_file}, {... locals ...}) </span>
      <span class="overload">- (<tt>Object</tt>) <strong>render</strong>({:partial = &gt; path_to_file}, {... locals ...}) </span>
</h3><div class="docstring">
  <div class="discussion">
    <p class="note private">
  <strong>This method is part of a private API.</strong>
  You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Delegates to ActionView::Base#render, so see documentation on that
for more info.</p>
<p>The only addition is that you can call render with no arguments, and
RSpec will pass the top level description to render:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_describe'>describe</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>widgets/new.html.erb</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
  <span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>shows all the widgets</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
    <span class='id identifier rubyid_render'>render</span> <span class='comment'># =&gt; view.render(:file =&gt; &quot;widgets/new.html.erb&quot;)
</span>    <span class='comment'># ...
</span>  <span class='kw'>end</span>
<span class='kw'>end</span>
</code></pre>
  </div>
</div>
<div class="tags">
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">
48
49
50
51</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rspec/rails/example/view_example_group.rb', line 48</span>
<span class='kw'>def</span> <span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_local_assigns'>local_assigns</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='id identifier rubyid__default_render_options'>_default_render_options</span> <span class='kw'>if</span> <span class='const'>Hash</span> <span class='op'>===</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
  <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_local_assigns'>local_assigns</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
      <div class="method_details ">
  <h3 class="signature " id="response-instance_method">
    - (<tt>Object</tt>) <strong>response</strong> 
</h3><div class="docstring">
  <div class="discussion">
    <p class="note private">
  <strong>This method is part of a private API.</strong>
  You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'><p>Use <code>rendered</code> instead.</p>
</div></div>
  </div>
</div>
<div class="tags">
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">
92
93
94
95
96
97
98
99
100
101
102
103
104
105</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rspec/rails/example/view_example_group.rb', line 92</span>
<span class='kw'>def</span> <span class='id identifier rubyid_response'>response</span>
  <span class='comment'># `assert_template` expects `response` to implement a #body method
</span>  <span class='comment'># like an `ActionDispatch::Response` does to force the view to
</span>  <span class='comment'># render. For backwards compatibility, we use #response as an alias
</span>  <span class='comment'># for #rendered, but it needs to implement #body to avoid
</span>  <span class='comment'># `assert_template` raising a `NoMethodError`.
</span>  <span class='kw'>unless</span> <span class='id identifier rubyid_rendered'>rendered</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:body</span><span class='rparen'>)</span>
    <span class='kw'>def</span> <span class='id identifier rubyid_rendered'>rendered</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
      <span class='kw'>self</span>
    <span class='kw'>end</span>
  <span class='kw'>end</span>
  <span class='id identifier rubyid_rendered'>rendered</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
      <div class="method_details ">
  <h3 class="signature " id="stub_template-instance_method">
    - (<tt>Object</tt>) <strong>stub_template</strong>(hash) 
</h3><div class="docstring">
  <div class="discussion">
    <p class="note private">
  <strong>This method is part of a private API.</strong>
  You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>Simulates the presence of a template on the file system by adding a
Rails&#39; FixtureResolver to the front of the view_paths list. Designed to
help isolate view examples from partials rendered by the view template
that is the subject of the example.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_stub_template'>stub_template</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>widgets/_widget.html.erb</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>This content.</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
</code></pre>
  </div>
</div>
<div class="tags">
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">
73
74
75</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rspec/rails/example/view_example_group.rb', line 73</span>
<span class='kw'>def</span> <span class='id identifier rubyid_stub_template'>stub_template</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
  <span class='id identifier rubyid_view'>view</span><span class='period'>.</span><span class='id identifier rubyid_view_paths'>view_paths</span><span class='period'>.</span><span class='id identifier rubyid_unshift'>unshift</span><span class='lparen'>(</span><span class='const'>ActionView</span><span class='op'>::</span><span class='const'>FixtureResolver</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
      <div class="method_details ">
  <h3 class="signature " id="template-instance_method">
    - (<tt>Object</tt>) <strong>template</strong> 
</h3><div class="docstring">
  <div class="discussion">
    <p class="note private">
  <strong>This method is part of a private API.</strong>
  You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'><p>Use <code>view</code> instead.</p>
</div></div>
  </div>
</div>
<div class="tags">
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">
86
87
88
89</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rspec/rails/example/view_example_group.rb', line 86</span>
<span class='kw'>def</span> <span class='id identifier rubyid_template'>template</span>
  <span class='const'>RSpec</span><span class='period'>.</span><span class='id identifier rubyid_deprecate'>deprecate</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>template</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:replacement</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>view</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
  <span class='id identifier rubyid_view'>view</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
      <div class="method_details ">
  <h3 class="signature " id="view-instance_method">
    - (<tt>Object</tt>) <strong>view</strong> 
</h3><div class="docstring">
  <div class="discussion">
    <p class="note private">
  <strong>This method is part of a private API.</strong>
  You should avoid using this method if possible, as it may be removed or be changed in the future.
</p>
<p>The instance of <code>ActionView::Base</code> that is used to render the template.
Use this to stub methods <em>before</em> calling <code>render</code>.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_describe'>describe</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>widgets/new.html.erb</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
  <span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>shows all the widgets</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
    <span class='id identifier rubyid_view'>view</span><span class='period'>.</span><span class='id identifier rubyid_stub'>stub</span><span class='lparen'>(</span><span class='symbol'>:foo</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>foo</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
    <span class='id identifier rubyid_render'>render</span>
    <span class='comment'># ...
</span>  <span class='kw'>end</span>
<span class='kw'>end</span>
</code></pre>
  </div>
</div>
<div class="tags">
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">
63
64
65</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rspec/rails/example/view_example_group.rb', line 63</span>
<span class='kw'>def</span> <span class='id identifier rubyid_view'>view</span>
  <span class='id identifier rubyid__view'>_view</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
  </div>
</div>
    <div id="footer">
  Generated on Thu Jan 29 13:55:22 2015 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.7.3 (ruby-2.1.5).
</div>
  </body>
</html>