docs/documentation/2.99/rspec-rails/RSpec/Rails/Matchers.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::Matchers
    &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 (M)</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">Matchers</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::Matchers
</h1>
<dl class="box">
    <dt class="r1">Included in:</dt>
    <dd class="r1"><span class='object_link'><a href="RailsExampleGroup.html" title="RSpec::Rails::RailsExampleGroup (module)">RailsExampleGroup</a></span></dd>
    <dt class="r2 last">Defined in:</dt>
    <dd class="r2 last">lib/rspec/rails/matchers.rb<span class="defines">,<br />
  lib/rspec/rails/matchers/be_a_new.rb,<br /> lib/rspec/rails/matchers/be_valid.rb,<br /> lib/rspec/rails/matchers/redirect_to.rb,<br /> lib/rspec/rails/matchers/be_new_record.rb,<br /> lib/rspec/rails/matchers/have_rendered.rb,<br /> lib/rspec/rails/matchers/have_extension.rb,<br /> lib/rspec/rails/matchers/routing_matchers.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Defined Under Namespace</h2>
<p class="children">
      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Matchers/HaveExtensions.html" title="RSpec::Rails::Matchers::HaveExtensions (module)">HaveExtensions</a></span>, <span class='object_link'><a href="Matchers/RedirectTo.html" title="RSpec::Rails::Matchers::RedirectTo (module)">RedirectTo</a></span>, <span class='object_link'><a href="Matchers/RenderTemplate.html" title="RSpec::Rails::Matchers::RenderTemplate (module)">RenderTemplate</a></span>, <span class='object_link'><a href="Matchers/RoutingMatchers.html" title="RSpec::Rails::Matchers::RoutingMatchers (module)">RoutingMatchers</a></span>
      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Matchers/BeANew.html" title="RSpec::Rails::Matchers::BeANew (class)">BeANew</a></span>, <span class='object_link'><a href="Matchers/BeANewRecord.html" title="RSpec::Rails::Matchers::BeANewRecord (class)">BeANewRecord</a></span>, <span class='object_link'><a href="Matchers/BeValid.html" title="RSpec::Rails::Matchers::BeValid (class)">BeValid</a></span>
</p>
    <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="#be_a_new-instance_method" title="#be_a_new (instance method)">- (Object) <strong>be_a_new</strong>(model_class) </a>
  </span>
    <span class="summary_desc"><div class='inline'><p>Passes if actual is an instance of <code>model_class</code> and returns <code>false</code> for <code>persisted?</code>.</p>
</div></span>
</li>
        <li class="public ">
  <span class="summary_signature">
      <a href="#be_new_record-instance_method" title="#be_new_record (instance method)">- (Object) <strong>be_new_record</strong> </a>
  </span>
    <span class="summary_desc"><div class='inline'><p>Passes if actual returns <code>false</code> for <code>persisted?</code>.</p>
</div></span>
</li>
        <li class="public ">
  <span class="summary_signature">
      <a href="#be_valid-instance_method" title="#be_valid (instance method)">- (Object) <strong>be_valid</strong>(*args) </a>
  </span>
    <span class="summary_desc"><div class='inline'><p>Passes if the given model instance&#39;s <code>valid?</code> method is true, meaning all of the <code>ActiveModel::Validations</code> passed and no errors exist.</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="be_a_new-instance_method">
    - (<tt>Object</tt>) <strong>be_a_new</strong>(model_class) 
</h3><div class="docstring">
  <div class="discussion">
    <p>Passes if actual is an instance of <code>model_class</code> and returns <code>false</code> for
<code>persisted?</code>. Typically used to specify instance variables assigned to
views by controller actions</p>
  </div>
</div>
<div class="tags">
  <div class="examples">
    <p class="tag_title">Examples:</p>
      <pre class="example code"><code>
<span class='id identifier rubyid_get'>get</span> <span class='symbol'>:new</span>
<span class='id identifier rubyid_assigns'>assigns</span><span class='lparen'>(</span><span class='symbol'>:thing</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_should'>should</span> <span class='id identifier rubyid_be_a_new'>be_a_new</span><span class='lparen'>(</span><span class='const'>Thing</span><span class='rparen'>)</span>
<span class='id identifier rubyid_post'>post</span> <span class='symbol'>:create</span><span class='comma'>,</span> <span class='symbol'>:thing</span> <span class='op'>=&gt;</span> <span class='lbrace'>{</span> <span class='symbol'>:name</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Illegal Value</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_assigns'>assigns</span><span class='lparen'>(</span><span class='symbol'>:thing</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_should'>should</span> <span class='id identifier rubyid_be_a_new'>be_a_new</span><span class='lparen'>(</span><span class='const'>Thing</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='symbol'>:name</span> <span class='op'>=&gt;</span> <span class='kw'>nil</span><span class='rparen'>)</span></code></pre>
  </div>
</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/matchers/be_a_new.rb', line 73</span>
<span class='kw'>def</span> <span class='id identifier rubyid_be_a_new'>be_a_new</span><span class='lparen'>(</span><span class='id identifier rubyid_model_class'>model_class</span><span class='rparen'>)</span>
  <span class='const'>BeANew</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_model_class'>model_class</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
      <div class="method_details ">
  <h3 class="signature " id="be_new_record-instance_method">
    - (<tt>Object</tt>) <strong>be_new_record</strong> 
</h3><div class="docstring">
  <div class="discussion">
    <p>Passes if actual returns <code>false</code> for <code>persisted?</code>.</p>
  </div>
</div>
<div class="tags">
  <div class="examples">
    <p class="tag_title">Examples:</p>
      <pre class="example code"><code>
<span class='id identifier rubyid_get'>get</span> <span class='symbol'>:new</span>
<span class='id identifier rubyid_assigns'>assigns</span><span class='lparen'>(</span><span class='symbol'>:thing</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_should'>should</span> <span class='id identifier rubyid_be_new_record'>be_new_record</span></code></pre>
  </div>
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">
24
25
26</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/be_new_record.rb', line 24</span>
<span class='kw'>def</span> <span class='id identifier rubyid_be_new_record'>be_new_record</span>
  <span class='const'>BeANewRecord</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
      <div class="method_details ">
  <h3 class="signature " id="be_valid-instance_method">
    - (<tt>Object</tt>) <strong>be_valid</strong>(*args) 
</h3><div class="docstring">
  <div class="discussion">
    <p>Passes if the given model instance&#39;s <code>valid?</code> method is true, meaning all
of the <code>ActiveModel::Validations</code> passed and no errors exist. If a message
is not given, a default message is shown listing each error.</p>
  </div>
</div>
<div class="tags">
  <div class="examples">
    <p class="tag_title">Examples:</p>
      <pre class="example code"><code>
<span class='id identifier rubyid_thing'>thing</span> <span class='op'>=</span> <span class='const'>Thing</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
<span class='id identifier rubyid_thing'>thing</span><span class='period'>.</span><span class='id identifier rubyid_should'>should</span> <span class='id identifier rubyid_be_valid'>be_valid</span></code></pre>
  </div>
</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">
37
38
39</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/be_valid.rb', line 37</span>
<span class='kw'>def</span> <span class='id identifier rubyid_be_valid'>be_valid</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
  <span class='const'>BeValid</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
  </div>
</div>
    <div id="footer">
  Generated on Thu Jan 29 14:01:33 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>