forked from rspec/rspec.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMatchers.html
299 lines (299 loc) · 18.9 KB
/
Matchers.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
<!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
— 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> »
<span class='title'><span class='object_link'><a href="../../RSpec.html" title="RSpec (module)">RSpec</a></span></span> » <span class='title'><span class='object_link'><a href="../Rails.html" title="RSpec::Rails (module)">Rails</a></span></span>
»
<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
<span class="private note title">Private</span>
</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_valid.rb,<br /> lib/rspec/rails/matchers/be_a_new.rb,<br /> lib/rspec/rails/matchers/redirect_to.rb,<br /> lib/rspec/rails/matchers/have_rendered.rb,<br /> lib/rspec/rails/matchers/be_new_record.rb,<br /> lib/rspec/rails/matchers/routing_matchers.rb,<br /> lib/rspec/rails/matchers/have_http_status.rb</span>
</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>Container module for Rails specific matchers.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Matchers/HaveHttpStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus (module)">HaveHttpStatus</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>
</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="private note title">private</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="private note title">private</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="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Passes if the given model instance's <code>valid?</code> method is true, meaning all of the <code>ActiveModel::Validations</code> passed and no errors exist.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#have_http_status-instance_method" title="#have_http_status (instance method)">- (Object) <strong>have_http_status</strong>(target) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Passes if <code>response</code> has a matching HTTP status code.</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 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>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>
<p>Use the <code>with</code> method to specify the specific attributes to match on the
new record.</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'>=></span> <span class='lbrace'>{</span> <span class='symbol'>:name</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Illegal Value</span><span class='tstring_end'>"</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'>=></span> <span class='kw'>nil</span><span class='rparen'>)</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
76
77
78</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/be_a_new.rb', line 76</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 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>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_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_assigns'>assigns</span><span class='lparen'>(</span><span class='symbol'>:thing</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</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 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>Passes if the given model instance'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_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_thing'>thing</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_valid'>be_valid</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
43
44
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/be_valid.rb', line 43</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 class="method_details ">
<h3 class="signature " id="have_http_status-instance_method">
- (<tt>Object</tt>) <strong>have_http_status</strong>(target)
</h3><div class="docstring">
<div class="discussion">
<p>Passes if <code>response</code> has a matching HTTP status code.</p>
<p>The following symbolic status codes are allowed:</p>
<ul>
<li><code>Rack::Utils::SYMBOL_TO_STATUS_CODE</code></li>
<li>One of the defined <code>ActionDispatch::TestResponse</code> aliases:
<ul>
<li><code>:error</code></li>
<li><code>:missing</code></li>
<li><code>:redirect</code></li>
<li><code>:success</code></li>
</ul></li>
</ul>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'><p>Accepts numeric and symbol statuses</p>
</div></p>
<pre class="example code"><code><span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_http_status'>have_http_status</span><span class='lparen'>(</span><span class='int'>404</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_http_status'>have_http_status</span><span class='lparen'>(</span><span class='symbol'>:created</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_http_status'>have_http_status</span><span class='lparen'>(</span><span class='symbol'>:success</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_http_status'>have_http_status</span><span class='lparen'>(</span><span class='symbol'>:error</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_http_status'>have_http_status</span><span class='lparen'>(</span><span class='symbol'>:missing</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_http_status'>have_http_status</span><span class='lparen'>(</span><span class='symbol'>:redirect</span><span class='rparen'>)</span></code></pre>
<p class="example_title"><div class='inline'><p>Works with standard <code>response</code> objects and Capybara's <code>page</code></p>
</div></p>
<pre class="example code"><code><span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_http_status'>have_http_status</span><span class='lparen'>(</span><span class='int'>404</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_page'>page</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_http_status'>have_http_status</span><span class='lparen'>(</span><span class='symbol'>:created</span><span class='rparen'>)</span></code></pre>
</div>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>ArgumentError</tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/testing/test_response.rb" target="_parent" title="`ActionDispatch::TestResponse`">`ActionDispatch::TestResponse`</a></li>
<li><a href="https://github.com/rack/rack/blob/master/lib/rack/utils.rb" target="_parent" title="`Rack::Utils::SYMBOL_TO_STATUS_CODE`">`Rack::Utils::SYMBOL_TO_STATUS_CODE`</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
355
356
357
358</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/have_http_status.rb', line 355</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_http_status'>have_http_status</span><span class='lparen'>(</span><span class='id identifier rubyid_target'>target</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid HTTP status: nil</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_target'>target</span>
<span class='const'>HaveHttpStatus</span><span class='period'>.</span><span class='id identifier rubyid_matcher_for_status'>matcher_for_status</span><span class='lparen'>(</span><span class='id identifier rubyid_target'>target</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 13:55:21 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>