-
-
Notifications
You must be signed in to change notification settings - Fork 41
/
Copy pathNumericCode.html
373 lines (373 loc) · 18.4 KB
/
NumericCode.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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RSpec::Rails::Matchers::HaveHttpStatus::NumericCode
— Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/7.0/rspec-rails/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/7.0/rspec-rails/css/common.css" type="text/css" />
<link rel="stylesheet" href="/documentation/7.0/rspec-rails/css/rspec.css" type="text/css" />
<script type="text/javascript">
pathId = "RSpec::Rails::Matchers::HaveHttpStatus::NumericCode";
relpath = '../../../../';
</script>
<script type="text/javascript" charset="utf-8" src="/documentation/7.0/rspec-rails/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="/documentation/7.0/rspec-rails/js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../../../_index.html">Index (N)</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'><span class='object_link'><a href="../../Matchers.html" title="RSpec::Rails::Matchers (module)">Matchers</a></span></span> » <span class='title'><span class='object_link'><a href="../HaveHttpStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus (module)">HaveHttpStatus</a></span></span>
»
<span class="title">NumericCode</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: RSpec::Rails::Matchers::HaveHttpStatus::NumericCode
<span class="private note title">Private</span>
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../BaseMatcher.html" title="RSpec::Rails::Matchers::BaseMatcher (class)">BaseMatcher</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="../BaseMatcher.html" title="RSpec::Rails::Matchers::BaseMatcher (class)">BaseMatcher</a></span></li>
<li class="next">RSpec::Rails::Matchers::HaveHttpStatus::NumericCode</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="../HaveHttpStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus (module)">RSpec::Rails::Matchers::HaveHttpStatus</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/rails/matchers/have_http_status.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This class is part of a private API.</strong>
You should avoid using this class if possible, as it may be removed or be changed in the future.
</p>
<p>Provides an implementation for <code>have_http_status</code> matching against
numeric http status codes.</p>
<p>Not intended to be instantiated directly.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h4 class="tag_title">Examples:</h4>
<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></code></pre>
</div>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="../../Matchers.html#have_http_status-instance_method" title="RSpec::Rails::Matchers#have_http_status (method)">RSpec::Rails::Matchers#have_http_status</a></span></li>
</ul>
</div>
<h2>Constant Summary</h2>
<h3 class="inherited">Constants inherited
from <span class='object_link'><a href="../BaseMatcher.html" title="RSpec::Rails::Matchers::BaseMatcher (class)">BaseMatcher</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../BaseMatcher.html#UNDEFINED-constant" title="RSpec::Rails::Matchers::BaseMatcher::UNDEFINED (constant)">BaseMatcher::UNDEFINED</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="#description-instance_method" title="#description (instance method)">#<strong>description</strong> ⇒ String </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#failure_message-instance_method" title="#failure_message (instance method)">#<strong>failure_message</strong> ⇒ String </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Explaining why the match failed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#failure_message_when_negated-instance_method" title="#failure_message_when_negated (instance method)">#<strong>failure_message_when_negated</strong> ⇒ String </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Explaining why the match failed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(code) ⇒ NumericCode </a>
</span>
<span class="note title constructor">constructor</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>A new instance of NumericCode.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#matches%3F-instance_method" title="#matches? (instance method)">#<strong>matches?</strong>(response) ⇒ Boolean </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p><code>true</code> if the numeric code matched the <code>response</code> code.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../HaveHttpStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus (module)">RSpec::Rails::Matchers::HaveHttpStatus</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../HaveHttpStatus.html#as_test_response-class_method" title="RSpec::Rails::Matchers::HaveHttpStatus.as_test_response (method)">as_test_response</a></span>, <span class='object_link'><a href="../HaveHttpStatus.html#invalid_response_type_message-instance_method" title="RSpec::Rails::Matchers::HaveHttpStatus#invalid_response_type_message (method)">#invalid_response_type_message</a></span>, <span class='object_link'><a href="../HaveHttpStatus.html#matcher_for_status-class_method" title="RSpec::Rails::Matchers::HaveHttpStatus.matcher_for_status (method)">matcher_for_status</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../BaseMatcher.html" title="RSpec::Rails::Matchers::BaseMatcher (class)">BaseMatcher</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../BaseMatcher.html#diffable%3F-instance_method" title="RSpec::Rails::Matchers::BaseMatcher#diffable? (method)">#diffable?</a></span>, <span class='object_link'><a href="../BaseMatcher.html#expects_call_stack_jump%3F-instance_method" title="RSpec::Rails::Matchers::BaseMatcher#expects_call_stack_jump? (method)">#expects_call_stack_jump?</a></span>, <span class='object_link'><a href="../BaseMatcher.html#match_unless_raises-instance_method" title="RSpec::Rails::Matchers::BaseMatcher#match_unless_raises (method)">#match_unless_raises</a></span>, <span class='object_link'><a href="../BaseMatcher.html#supports_block_expectations%3F-instance_method" title="RSpec::Rails::Matchers::BaseMatcher#supports_block_expectations? (method)">#supports_block_expectations?</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(code) ⇒ <tt><span class='object_link'><a href="" title="RSpec::Rails::Matchers::HaveHttpStatus::NumericCode (class)">NumericCode</a></span></tt>
</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>Returns a new instance of NumericCode.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82
83
84</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/have_http_status.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_code'>code</span><span class='rparen'>)</span>
<span class='ivar'>@expected</span> <span class='op'>=</span> <span class='id identifier rubyid_code'>code</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='ivar'>@actual</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='ivar'>@invalid_response</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="description-instance_method">
#<strong>description</strong> ⇒ <tt>String</tt>
</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>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
98
99
100</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/have_http_status.rb', line 98</span>
<span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>respond with numeric status code </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_expected'>expected</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="failure_message-instance_method">
#<strong>failure_message</strong> ⇒ <tt>String</tt>
</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>Returns explaining why the match failed.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>explaining why the match failed</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
103
104
105
106
107</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/have_http_status.rb', line 103</span>
<span class='kw'>def</span> <span class='id identifier rubyid_failure_message'>failure_message</span>
<span class='id identifier rubyid_invalid_response_type_message'>invalid_response_type_message</span> <span class='op'>||</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>expected the response to have status code </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_expected'>expected</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> \
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> but it was </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_actual'>actual</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="failure_message_when_negated-instance_method">
#<strong>failure_message_when_negated</strong> ⇒ <tt>String</tt>
</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>Returns explaining why the match failed.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>explaining why the match failed</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
110
111
112
113
114</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/have_http_status.rb', line 110</span>
<span class='kw'>def</span> <span class='id identifier rubyid_failure_message_when_negated'>failure_message_when_negated</span>
<span class='id identifier rubyid_invalid_response_type_message'>invalid_response_type_message</span> <span class='op'>||</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>expected the response not to have status code </span><span class='tstring_end'>"</span></span> \
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_expected'>expected</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'> but it did</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="matches?-instance_method">
#<strong>matches?</strong>(response) ⇒ <tt>Boolean</tt>
</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>Returns <code>true</code> if the numeric code matched the <code>response</code> code.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>response</span>
<span class='type'>(<tt>Object</tt>)</span>
—
<div class='inline'><p>object providing an http code to match</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p><code>true</code> if the numeric code matched the <code>response</code> code</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
88
89
90
91
92
93
94
95</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/have_http_status.rb', line 88</span>
<span class='kw'>def</span> <span class='id identifier rubyid_matches?'>matches?</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
<span class='id identifier rubyid_test_response'>test_response</span> <span class='op'>=</span> <span class='id identifier rubyid_as_test_response'>as_test_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
<span class='ivar'>@actual</span> <span class='op'>=</span> <span class='id identifier rubyid_test_response'>test_response</span><span class='period'>.</span><span class='id identifier rubyid_response_code'>response_code</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
<span class='id identifier rubyid_expected'>expected</span> <span class='op'>==</span> <span class='ivar'>@actual</span>
<span class='kw'>rescue</span> <span class='const'>TypeError</span> <span class='op'>=></span> <span class='id identifier rubyid__ignored'>_ignored</span>
<span class='ivar'>@invalid_response</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span>
<span class='kw'>false</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Oct 9 21:42:10 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
</html>