-
-
Notifications
You must be signed in to change notification settings - Fork 41
/
Copy pathBaseMatcher.html
451 lines (451 loc) · 20.5 KB
/
BaseMatcher.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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RSpec::Rails::Matchers::BaseMatcher
— 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::BaseMatcher";
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 (B)</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">BaseMatcher</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::BaseMatcher
<span class="private note title">Private</span>
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">RSpec::Rails::Matchers::BaseMatcher</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd>Matchers::Composable, <span class='object_link'><a href="BaseMatcher/DefaultFailureMessages.html" title="RSpec::Rails::Matchers::BaseMatcher::DefaultFailureMessages (module)">DefaultFailureMessages</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rspec/rails/matchers/base_matcher.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>Base class to build matchers. Should not be instantiated directly.</p>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="BeANew.html" title="RSpec::Rails::Matchers::BeANew (class)">BeANew</a></span>, <span class='object_link'><a href="HaveHttpStatus/GenericStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus::GenericStatus (class)">HaveHttpStatus::GenericStatus</a></span>, <span class='object_link'><a href="HaveHttpStatus/NumericCode.html" title="RSpec::Rails::Matchers::HaveHttpStatus::NumericCode (class)">HaveHttpStatus::NumericCode</a></span>, <span class='object_link'><a href="HaveHttpStatus/SymbolicStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus::SymbolicStatus (class)">HaveHttpStatus::SymbolicStatus</a></span>, <span class='object_link'><a href="SendEmail.html" title="RSpec::Rails::Matchers::SendEmail (class)">SendEmail</a></span></p>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="BaseMatcher/DefaultFailureMessages.html" title="RSpec::Rails::Matchers::BaseMatcher::DefaultFailureMessages (module)">DefaultFailureMessages</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="UNDEFINED-constant" class="">UNDEFINED =
<div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This constant is part of a private API.</strong>
You should avoid using this constant if possible, as it may be removed or be changed in the future.
</p>
<p>Used to detect when no arg is passed to <code>initialize</code>.
<code>nil</code> cannot be used because it's a valid value to pass.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='const'>Object</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
<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'><p>Generates a description using Matchers::EnglishPhrasing.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#diffable%3F-instance_method" title="#diffable? (instance method)">#<strong>diffable?</strong> ⇒ Boolean </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Matchers are not diffable by default.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#expects_call_stack_jump%3F-instance_method" title="#expects_call_stack_jump? (instance method)">#<strong>expects_call_stack_jump?</strong> ⇒ Boolean </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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(expected = UNDEFINED) ⇒ BaseMatcher </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 BaseMatcher.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#match_unless_raises-instance_method" title="#match_unless_raises (instance method)">#<strong>match_unless_raises</strong>(*exceptions) ⇒ Object </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Used to wrap a block of code that will indicate failure by raising one of the named exceptions.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#matches%3F-instance_method" title="#matches? (instance method)">#<strong>matches?</strong>(actual) ⇒ Boolean </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Indicates if the match is successful.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#supports_block_expectations%3F-instance_method" title="#supports_block_expectations? (instance method)">#<strong>supports_block_expectations?</strong> ⇒ Boolean </a>
</span>
<span class="private note title">private</span>
<span class="summary_desc"><div class='inline'><p>Most matchers are value matchers (i.e. meant to work with <code>expect(value)</code>) rather than block matchers (i.e. meant to work with <code>expect { }</code>), so this defaults to false.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods included from <span class='object_link'><a href="BaseMatcher/DefaultFailureMessages.html" title="RSpec::Rails::Matchers::BaseMatcher::DefaultFailureMessages (module)">DefaultFailureMessages</a></span></h3>
<p class="inherited"><span class='object_link'><a href="BaseMatcher/DefaultFailureMessages.html#failure_message-instance_method" title="RSpec::Rails::Matchers::BaseMatcher::DefaultFailureMessages#failure_message (method)">#failure_message</a></span>, <span class='object_link'><a href="BaseMatcher/DefaultFailureMessages.html#failure_message_when_negated-instance_method" title="RSpec::Rails::Matchers::BaseMatcher::DefaultFailureMessages#failure_message_when_negated (method)">#failure_message_when_negated</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>(expected = UNDEFINED) ⇒ <tt><span class='object_link'><a href="" title="RSpec::Rails::Matchers::BaseMatcher (class)">BaseMatcher</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 BaseMatcher.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/base_matcher.rb', line 21</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_expected'>expected</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#UNDEFINED-constant" title="RSpec::Rails::Matchers::BaseMatcher::UNDEFINED (constant)">UNDEFINED</a></span></span><span class='rparen'>)</span>
<span class='ivar'>@expected</span> <span class='op'>=</span> <span class='id identifier rubyid_expected'>expected</span> <span class='kw'>unless</span> <span class='const'><span class='object_link'><a href="#UNDEFINED-constant" title="RSpec::Rails::Matchers::BaseMatcher::UNDEFINED (constant)">UNDEFINED</a></span></span><span class='period'>.</span><span class='id identifier rubyid_equal?'>equal?</span><span class='lparen'>(</span><span class='id identifier rubyid_expected'>expected</span><span class='rparen'>)</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>
<p>Generates a description using Matchers::EnglishPhrasing.</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">
53
54
55
56
57</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/base_matcher.rb', line 53</span>
<span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
<span class='id identifier rubyid_desc'>desc</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../../../RSpec.html" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'>Matchers</span><span class='op'>::</span><span class='const'>EnglishPhrasing</span><span class='period'>.</span><span class='id identifier rubyid_split_words'>split_words</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_matcher_name'>matcher_name</span><span class='rparen'>)</span>
<span class='id identifier rubyid_desc'>desc</span> <span class='op'><<</span> <span class='const'><span class='object_link'><a href="../../../RSpec.html" title="RSpec (module)">RSpec</a></span></span><span class='op'>::</span><span class='const'>Matchers</span><span class='op'>::</span><span class='const'>EnglishPhrasing</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='ivar'>@expected</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='ivar'>@expected</span><span class='rparen'>)</span>
<span class='id identifier rubyid_desc'>desc</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="diffable?-instance_method">
#<strong>diffable?</strong> ⇒ <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>Matchers are not diffable by default. Override this to make your
subclass diffable.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/base_matcher.rb', line 62</span>
<span class='kw'>def</span> <span class='id identifier rubyid_diffable?'>diffable?</span>
<span class='kw'>false</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="expects_call_stack_jump?-instance_method">
#<strong>expects_call_stack_jump?</strong> ⇒ <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>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
75
76
77</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/base_matcher.rb', line 75</span>
<span class='kw'>def</span> <span class='id identifier rubyid_expects_call_stack_jump?'>expects_call_stack_jump?</span>
<span class='kw'>false</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="match_unless_raises-instance_method">
#<strong>match_unless_raises</strong>(*exceptions) ⇒ <tt>Object</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>Used to wrap a block of code that will indicate failure by
raising one of the named exceptions.</p>
<p>This is used by rspec-rails for some of its matchers that
wrap rails' assertions.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42
43
44
45
46
47
48</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/base_matcher.rb', line 40</span>
<span class='kw'>def</span> <span class='id identifier rubyid_match_unless_raises'>match_unless_raises</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_exceptions'>exceptions</span><span class='rparen'>)</span>
<span class='id identifier rubyid_exceptions'>exceptions</span><span class='period'>.</span><span class='id identifier rubyid_unshift'>unshift</span> <span class='const'>Exception</span> <span class='kw'>if</span> <span class='id identifier rubyid_exceptions'>exceptions</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
<span class='kw'>begin</span>
<span class='kw'>yield</span>
<span class='kw'>true</span>
<span class='kw'>rescue</span> <span class='op'>*</span><span class='id identifier rubyid_exceptions'>exceptions</span> <span class='op'>=></span> <span class='ivar'>@rescued_exception</span>
<span class='kw'>false</span>
<span class='kw'>end</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>(actual) ⇒ <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>Indicates if the match is successful. Delegates to <code>match</code>, which
should be defined on a subclass. Takes care of consistently
initializing the <code>actual</code> attribute.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
29
30
31
32</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/base_matcher.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_matches?'>matches?</span><span class='lparen'>(</span><span class='id identifier rubyid_actual'>actual</span><span class='rparen'>)</span>
<span class='ivar'>@actual</span> <span class='op'>=</span> <span class='id identifier rubyid_actual'>actual</span>
<span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_expected'>expected</span><span class='comma'>,</span> <span class='id identifier rubyid_actual'>actual</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="supports_block_expectations?-instance_method">
#<strong>supports_block_expectations?</strong> ⇒ <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>Most matchers are value matchers (i.e. meant to work with <code>expect(value)</code>)
rather than block matchers (i.e. meant to work with <code>expect { }</code>), so
this defaults to false. Block matchers must override this to return true.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
70
71
72</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/base_matcher.rb', line 70</span>
<span class='kw'>def</span> <span class='id identifier rubyid_supports_block_expectations?'>supports_block_expectations?</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>