forked from rspec/rspec.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMatchers.html
718 lines (718 loc) · 80.4 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
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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec::Rails::Matchers
— Documentation by YARD 0.9.24
</title>
<link rel="stylesheet" href="/documentation/4.0/rspec-rails/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/4.0/rspec-rails/css/common.css" type="text/css" />
<link rel="stylesheet" href="/documentation/4.0/rspec-rails/css/rspec.css" type="text/css" />
<script type="text/javascript">
pathId = "RSpec::Rails::Matchers";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="/documentation/4.0/rspec-rails/js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="/documentation/4.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 (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>
<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>Module: RSpec::Rails::Matchers
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>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/active_job.rb,<br /> lib/rspec/rails/matchers/redirect_to.rb,<br /> lib/rspec/rails/matchers/action_cable.rb,<br /> lib/rspec/rails/matchers/base_matcher.rb,<br /> lib/rspec/rails/matchers/be_new_record.rb,<br /> lib/rspec/rails/matchers/have_rendered.rb,<br /> lib/rspec/rails/matchers/action_mailbox.rb,<br /> lib/rspec/rails/matchers/have_http_status.rb,<br /> lib/rspec/rails/matchers/routing_matchers.rb,<br /> lib/rspec/rails/matchers/have_enqueued_mail.rb,<br /> lib/rspec/rails/matchers/action_cable/have_streams.rb,<br /> lib/rspec/rails/matchers/action_cable/have_broadcasted_to.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<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/ActionCable.html" title="RSpec::Rails::Matchers::ActionCable (module)">ActionCable</a></span>, <span class='object_link'><a href="Matchers/ActionMailbox.html" title="RSpec::Rails::Matchers::ActionMailbox (module)">ActionMailbox</a></span>, <span class='object_link'><a href="Matchers/ActiveJob.html" title="RSpec::Rails::Matchers::ActiveJob (module)">ActiveJob</a></span>, <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/BaseMatcher.html" title="RSpec::Rails::Matchers::BaseMatcher (class)">BaseMatcher</a></span>, <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)">#<strong>be_a_new</strong>(model_class) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Passes if actual is an instance of <code>model_class</code> and returns <code>true</code> for <code>new_record?</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)">#<strong>be_new_record</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Passes if actual returns <code>true</code> for <code>new_record?</code>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#be_valid-instance_method" title="#be_valid (instance method)">#<strong>be_valid</strong>(*args) ⇒ Object </a>
</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_been_enqueued-instance_method" title="#have_been_enqueued (instance method)">#<strong>have_been_enqueued</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Passes if a job has been enqueued.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#have_been_performed-instance_method" title="#have_been_performed (instance method)">#<strong>have_been_performed</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Passes if a job has been performed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#have_broadcasted_to-instance_method" title="#have_broadcasted_to (instance method)">#<strong>have_broadcasted_to</strong>(target = nil) ⇒ Object </a>
(also: #broadcast_to)
</span>
<span class="summary_desc"><div class='inline'><p>Passes if a message has been sent to a stream/object inside a block.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#have_enqueued_job-instance_method" title="#have_enqueued_job (instance method)">#<strong>have_enqueued_job</strong>(job = nil) ⇒ Object </a>
(also: #enqueue_job)
</span>
<span class="summary_desc"><div class='inline'><p>Passes if a job has been enqueued inside block.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#have_enqueued_mail-instance_method" title="#have_enqueued_mail (instance method)">#<strong>have_enqueued_mail</strong>(mailer_class = nil, mail_method_name = nil) ⇒ Object </a>
(also: #have_enqueued_email, #enqueue_mail, #enqueue_email)
</span>
<span class="summary_desc"><div class='inline'><p>Passes if an email has been enqueued inside block.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#have_http_status-instance_method" title="#have_http_status (instance method)">#<strong>have_http_status</strong>(target) ⇒ Object </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>
<li class="public ">
<span class="summary_signature">
<a href="#have_performed_job-instance_method" title="#have_performed_job (instance method)">#<strong>have_performed_job</strong>(job = nil) ⇒ Object </a>
(also: #perform_job)
</span>
<span class="summary_desc"><div class='inline'><p>Passes if a job has been performed inside block.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#receive_inbound_email-instance_method" title="#receive_inbound_email (instance method)">#<strong>receive_inbound_email</strong>(message) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Passes if the given inbound email would be routed to the subject inbox.</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">
#<strong>be_a_new</strong>(model_class) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if actual is an instance of <code>model_class</code> and returns <code>true</code> for
<code>new_record?</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">
78
79
80</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/be_a_new.rb', line 78</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'><span class='object_link'><a href="Matchers/BeANew.html" title="RSpec::Rails::Matchers::BeANew (class)">BeANew</a></span></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">
#<strong>be_new_record</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if actual returns <code>true</code> for <code>new_record?</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">
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/be_new_record.rb', line 25</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'><span class='object_link'><a href="Matchers/BaseMatcher.html#initialize-instance_method" title="RSpec::Rails::Matchers::BaseMatcher#initialize (method)">new</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="be_valid-instance_method">
#<strong>be_valid</strong>(*args) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<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">
44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/be_valid.rb', line 44</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_been_enqueued-instance_method">
#<strong>have_been_enqueued</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if a job has been enqueued. May chain at_least, at_most or exactly to specify a number of times.</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_before'>before</span> <span class='lbrace'>{</span> <span class='const'><span class='object_link'><a href="Matchers/ActiveJob.html" title="RSpec::Rails::Matchers::ActiveJob (module)">ActiveJob</a></span></span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id identifier rubyid_queue_adapter'>queue_adapter</span><span class='period'>.</span><span class='id identifier rubyid_enqueued_jobs'>enqueued_jobs</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span> <span class='rbrace'>}</span>
<span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HeavyLiftingJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_enqueued'>have_been_enqueued</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HeavyLiftingJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_enqueued'>have_been_enqueued</span><span class='period'>.</span><span class='id identifier rubyid_exactly'>exactly</span><span class='lparen'>(</span><span class='symbol'>:once</span><span class='rparen'>)</span>
<span class='int'>3</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_enqueued'>have_been_enqueued</span><span class='period'>.</span><span class='id identifier rubyid_at_least'>at_least</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_enqueue_job'>enqueue_job</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at_most'>at_most</span><span class='lparen'>(</span><span class='symbol'>:twice</span><span class='rparen'>)</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_enqueued'>have_been_enqueued</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HeavyLiftingJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_enqueued'>have_been_enqueued</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span><span class='label'>wait_until:</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_tomorrow'>tomorrow</span><span class='period'>.</span><span class='id identifier rubyid_noon'>noon</span><span class='comma'>,</span> <span class='label'>queue:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>low</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span><span class='lparen'>(</span><span class='int'>42</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_enqueued'>have_been_enqueued</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='int'>42</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_on_queue'>on_queue</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>low</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_tomorrow'>tomorrow</span><span class='period'>.</span><span class='id identifier rubyid_noon'>noon</span><span class='rparen'>)</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span><span class='label'>queue:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>low</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span><span class='lparen'>(</span><span class='int'>42</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_enqueued'>have_been_enqueued</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='int'>42</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_on_queue'>on_queue</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>low</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='symbol'>:no_wait</span><span class='rparen'>)</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
351
352
353
354</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/active_job.rb', line 351</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_been_enqueued'>have_been_enqueued</span>
<span class='id identifier rubyid_check_active_job_adapter'>check_active_job_adapter</span>
<span class='const'><span class='object_link'><a href="Matchers/ActiveJob.html" title="RSpec::Rails::Matchers::ActiveJob (module)">ActiveJob</a></span></span><span class='op'>::</span><span class='const'>HaveBeenEnqueued</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="have_been_performed-instance_method">
#<strong>have_been_performed</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if a job has been performed. May chain at_least, at_most or exactly to specify a number of times.</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_before'>before</span> <span class='kw'>do</span>
<span class='const'><span class='object_link'><a href="Matchers/ActiveJob.html" title="RSpec::Rails::Matchers::ActiveJob (module)">ActiveJob</a></span></span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id identifier rubyid_queue_adapter'>queue_adapter</span><span class='period'>.</span><span class='id identifier rubyid_performed_jobs'>performed_jobs</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span>
<span class='const'><span class='object_link'><a href="Matchers/ActiveJob.html" title="RSpec::Rails::Matchers::ActiveJob (module)">ActiveJob</a></span></span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id identifier rubyid_queue_adapter'>queue_adapter</span><span class='period'>.</span><span class='id identifier rubyid_perform_enqueued_jobs'>perform_enqueued_jobs</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='const'><span class='object_link'><a href="Matchers/ActiveJob.html" title="RSpec::Rails::Matchers::ActiveJob (module)">ActiveJob</a></span></span><span class='op'>::</span><span class='const'>Base</span><span class='period'>.</span><span class='id identifier rubyid_queue_adapter'>queue_adapter</span><span class='period'>.</span><span class='id identifier rubyid_perform_enqueued_at_jobs'>perform_enqueued_at_jobs</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='kw'>end</span>
<span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HeavyLiftingJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_performed'>have_been_performed</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HeavyLiftingJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_performed'>have_been_performed</span><span class='period'>.</span><span class='id identifier rubyid_exactly'>exactly</span><span class='lparen'>(</span><span class='symbol'>:once</span><span class='rparen'>)</span>
<span class='int'>3</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_performed'>have_been_performed</span><span class='period'>.</span><span class='id identifier rubyid_at_least'>at_least</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_performed'>have_been_performed</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HeavyLiftingJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_performed'>have_been_performed</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span><span class='label'>wait_until:</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_tomorrow'>tomorrow</span><span class='period'>.</span><span class='id identifier rubyid_noon'>noon</span><span class='comma'>,</span> <span class='label'>queue:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>low</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span><span class='lparen'>(</span><span class='int'>42</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_been_performed'>have_been_performed</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='int'>42</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_on_queue'>on_queue</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>low</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_tomorrow'>tomorrow</span><span class='period'>.</span><span class='id identifier rubyid_noon'>noon</span><span class='rparen'>)</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
424
425
426
427</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/active_job.rb', line 424</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_been_performed'>have_been_performed</span>
<span class='id identifier rubyid_check_active_job_adapter'>check_active_job_adapter</span>
<span class='const'><span class='object_link'><a href="Matchers/ActiveJob.html" title="RSpec::Rails::Matchers::ActiveJob (module)">ActiveJob</a></span></span><span class='op'>::</span><span class='const'>HaveBeenPerformed</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="have_broadcasted_to-instance_method">
#<strong>have_broadcasted_to</strong>(target = nil) ⇒ <tt>Object</tt>
<span class="aliases">Also known as:
<span class="names"><span id='broadcast_to-instance_method'>broadcast_to</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if a message has been sent to a stream/object inside a block.
May chain <code>at_least</code>, <code>at_most</code> or <code>exactly</code> to specify a number of times.
To specify channel from which message has been broadcasted to object use <code>from_channel</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_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'><span class='object_link'><a href="Matchers/ActionCable.html" title="RSpec::Rails::Matchers::ActionCable (module)">ActionCable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_broadcast'>broadcast</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>messages</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>text:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Hi!</span><span class='tstring_end'>'</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_broadcasted_to'>have_broadcasted_to</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>messages</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>SomeChannel</span><span class='period'>.</span><span class='id identifier rubyid_broadcast_to'>broadcast_to</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_broadcasted_to'>have_broadcasted_to</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_from_channel'>from_channel</span><span class='lparen'>(</span><span class='const'>SomeChannel</span><span class='rparen'>)</span>
<span class='comment'># Using alias
</span><span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'><span class='object_link'><a href="Matchers/ActionCable.html" title="RSpec::Rails::Matchers::ActionCable (module)">ActionCable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_broadcast'>broadcast</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>messages</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>text:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Hi!</span><span class='tstring_end'>'</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_broadcast_to'>broadcast_to</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>messages</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'><span class='object_link'><a href="Matchers/ActionCable.html" title="RSpec::Rails::Matchers::ActionCable (module)">ActionCable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_broadcast'>broadcast</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>messages</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>text:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Hi!</span><span class='tstring_end'>'</span></span>
<span class='const'><span class='object_link'><a href="Matchers/ActionCable.html" title="RSpec::Rails::Matchers::ActionCable (module)">ActionCable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_broadcast'>broadcast</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>all</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>text:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Hi!</span><span class='tstring_end'>'</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_broadcasted_to'>have_broadcasted_to</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>messages</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_exactly'>exactly</span><span class='lparen'>(</span><span class='symbol'>:once</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='int'>3</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='const'><span class='object_link'><a href="Matchers/ActionCable.html" title="RSpec::Rails::Matchers::ActionCable (module)">ActionCable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_broadcast'>broadcast</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>messages</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>text:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Hi!</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_broadcasted_to'>have_broadcasted_to</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>messages</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at_least'>at_least</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'><span class='object_link'><a href="Matchers/ActionCable.html" title="RSpec::Rails::Matchers::ActionCable (module)">ActionCable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_broadcast'>broadcast</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>messages</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>text:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Hi!</span><span class='tstring_end'>'</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_broadcasted_to'>have_broadcasted_to</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>messages</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at_most'>at_most</span><span class='lparen'>(</span><span class='symbol'>:twice</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'><span class='object_link'><a href="Matchers/ActionCable.html" title="RSpec::Rails::Matchers::ActionCable (module)">ActionCable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_broadcast'>broadcast</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>messages</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>text:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Hi!</span><span class='tstring_end'>'</span></span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_broadcasted_to'>have_broadcasted_to</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>messages</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='label'>text:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Hi!</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
48
49
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/action_cable.rb', line 48</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_broadcasted_to'>have_broadcasted_to</span><span class='lparen'>(</span><span class='id identifier rubyid_target'>target</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_check_action_cable_adapter'>check_action_cable_adapter</span>
<span class='const'><span class='object_link'><a href="Matchers/ActionCable.html" title="RSpec::Rails::Matchers::ActionCable (module)">ActionCable</a></span></span><span class='op'>::</span><span class='const'>HaveBroadcastedTo</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='label'>channel:</span> <span class='id identifier rubyid_described_class'>described_class</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="have_enqueued_job-instance_method">
#<strong>have_enqueued_job</strong>(job = nil) ⇒ <tt>Object</tt>
<span class="aliases">Also known as:
<span class="names"><span id='enqueue_job-instance_method'>enqueue_job</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if a job has been enqueued inside block. May chain at_least, at_most or exactly to specify a number of times.</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_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_job'>have_enqueued_job</span>
<span class='comment'># Using alias
</span><span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_enqueue_job'>enqueue_job</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_job'>have_enqueued_job</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_exactly'>exactly</span><span class='lparen'>(</span><span class='symbol'>:once</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='int'>3</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span> <span class='rbrace'>}</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_job'>have_enqueued_job</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at_least'>at_least</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_job'>have_enqueued_job</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at_most'>at_most</span><span class='lparen'>(</span><span class='symbol'>:twice</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_job'>have_enqueued_job</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_and'>and</span> <span class='id identifier rubyid_have_enqueued_job'>have_enqueued_job</span><span class='lparen'>(</span><span class='const'>HeavyLiftingJob</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span><span class='label'>wait_until:</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_tomorrow'>tomorrow</span><span class='period'>.</span><span class='id identifier rubyid_noon'>noon</span><span class='comma'>,</span> <span class='label'>queue:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>low</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span><span class='lparen'>(</span><span class='int'>42</span><span class='rparen'>)</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_job'>have_enqueued_job</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='int'>42</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_on_queue'>on_queue</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>low</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_tomorrow'>tomorrow</span><span class='period'>.</span><span class='id identifier rubyid_noon'>noon</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span><span class='label'>queue:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>low</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span><span class='lparen'>(</span><span class='int'>42</span><span class='rparen'>)</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_job'>have_enqueued_job</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='int'>42</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_on_queue'>on_queue</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>low</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='symbol'>:no_wait</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rspec_rails</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rails</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='int'>42</span><span class='rparen'>)</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_job'>have_enqueued_job</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_from'>from</span><span class='comma'>,</span> <span class='id identifier rubyid_to'>to</span><span class='comma'>,</span> <span class='id identifier rubyid_times'>times</span><span class='op'>|</span>
<span class='comment'># Perform more complex argument matching using dynamic arguments
</span> <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_from'>from</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_to'>to</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='rbrace'>}</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
316
317
318
319</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/active_job.rb', line 316</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_enqueued_job'>have_enqueued_job</span><span class='lparen'>(</span><span class='id identifier rubyid_job'>job</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_check_active_job_adapter'>check_active_job_adapter</span>
<span class='const'><span class='object_link'><a href="Matchers/ActiveJob.html" title="RSpec::Rails::Matchers::ActiveJob (module)">ActiveJob</a></span></span><span class='op'>::</span><span class='const'>HaveEnqueuedJob</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_job'>job</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="have_enqueued_mail-instance_method">
#<strong>have_enqueued_mail</strong>(mailer_class = nil, mail_method_name = nil) ⇒ <tt>Object</tt>
<span class="aliases">Also known as:
<span class="names"><span id='have_enqueued_email-instance_method'>have_enqueued_email</span>, <span id='enqueue_mail-instance_method'>enqueue_mail</span>, <span id='enqueue_email-instance_method'>enqueue_email</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if an email has been enqueued inside block.
May chain with to specify expected arguments.
May chain at_least, at_most or exactly to specify a number of times.
May chain at to specify a send time.
May chain on_queue to specify a queue.</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_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>MyMailer</span><span class='period'>.</span><span class='id identifier rubyid_welcome'>welcome</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_deliver_later'>deliver_later</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_mail'>have_enqueued_mail</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>MyMailer</span><span class='period'>.</span><span class='id identifier rubyid_welcome'>welcome</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_deliver_later'>deliver_later</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_mail'>have_enqueued_mail</span><span class='lparen'>(</span><span class='const'>MyMailer</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>MyMailer</span><span class='period'>.</span><span class='id identifier rubyid_welcome'>welcome</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_deliver_later'>deliver_later</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_mail'>have_enqueued_mail</span><span class='lparen'>(</span><span class='const'>MyMailer</span><span class='comma'>,</span> <span class='symbol'>:welcome</span><span class='rparen'>)</span>
<span class='comment'># Using alias
</span><span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>MyMailer</span><span class='period'>.</span><span class='id identifier rubyid_welcome'>welcome</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_deliver_later'>deliver_later</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_enqueue_mail'>enqueue_mail</span><span class='lparen'>(</span><span class='const'>MyMailer</span><span class='comma'>,</span> <span class='symbol'>:welcome</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>MyMailer</span><span class='period'>.</span><span class='id identifier rubyid_welcome'>welcome</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_deliver_later'>deliver_later</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_mail'>have_enqueued_mail</span><span class='lparen'>(</span><span class='const'>MyMailer</span><span class='comma'>,</span> <span class='symbol'>:welcome</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>MyMailer</span><span class='period'>.</span><span class='id identifier rubyid_welcome'>welcome</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_deliver_later'>deliver_later</span>
<span class='const'>MyMailer</span><span class='period'>.</span><span class='id identifier rubyid_welcome'>welcome</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_deliver_later'>deliver_later</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_mail'>have_enqueued_mail</span><span class='lparen'>(</span><span class='const'>MyMailer</span><span class='comma'>,</span> <span class='symbol'>:welcome</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at_least'>at_least</span><span class='lparen'>(</span><span class='symbol'>:once</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>MyMailer</span><span class='period'>.</span><span class='id identifier rubyid_welcome'>welcome</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_deliver_later'>deliver_later</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_mail'>have_enqueued_mail</span><span class='lparen'>(</span><span class='const'>MyMailer</span><span class='comma'>,</span> <span class='symbol'>:welcome</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at_most'>at_most</span><span class='lparen'>(</span><span class='symbol'>:twice</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>MyMailer</span><span class='period'>.</span><span class='id identifier rubyid_welcome'>welcome</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_deliver_later'>deliver_later</span><span class='lparen'>(</span><span class='label'>wait_until:</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_tomorrow'>tomorrow</span><span class='period'>.</span><span class='id identifier rubyid_noon'>noon</span><span class='rparen'>)</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_mail'>have_enqueued_mail</span><span class='lparen'>(</span><span class='const'>MyMailer</span><span class='comma'>,</span> <span class='symbol'>:welcome</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_tomorrow'>tomorrow</span><span class='period'>.</span><span class='id identifier rubyid_noon'>noon</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='const'>MyMailer</span><span class='period'>.</span><span class='id identifier rubyid_welcome'>welcome</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_deliver_later'>deliver_later</span><span class='lparen'>(</span><span class='label'>queue:</span> <span class='symbol'>:urgent_mail</span><span class='rparen'>)</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_enqueued_mail'>have_enqueued_mail</span><span class='lparen'>(</span><span class='const'>MyMailer</span><span class='comma'>,</span> <span class='symbol'>:welcome</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_on_queue'>on_queue</span><span class='lparen'>(</span><span class='symbol'>:urgent_mail</span><span class='rparen'>)</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
190
191
192</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/have_enqueued_mail.rb', line 190</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_enqueued_mail'>have_enqueued_mail</span><span class='lparen'>(</span><span class='id identifier rubyid_mailer_class'>mailer_class</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_mail_method_name'>mail_method_name</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='const'>HaveEnqueuedMail</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_mailer_class'>mailer_class</span><span class='comma'>,</span> <span class='id identifier rubyid_mail_method_name'>mail_method_name</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">
#<strong>have_http_status</strong>(target) ⇒ <tt>Object</tt>
</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">
378
379
380
381
382</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/have_http_status.rb', line 378</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'><span class='object_link'><a href="Matchers/HaveHttpStatus.html" title="RSpec::Rails::Matchers::HaveHttpStatus (module)">HaveHttpStatus</a></span></span><span class='period'>.</span><span class='id identifier rubyid_matcher_for_status'><span class='object_link'><a href="Matchers/HaveHttpStatus.html#matcher_for_status-class_method" title="RSpec::Rails::Matchers::HaveHttpStatus.matcher_for_status (method)">matcher_for_status</a></span></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 class="method_details ">
<h3 class="signature " id="have_performed_job-instance_method">
#<strong>have_performed_job</strong>(job = nil) ⇒ <tt>Object</tt>
<span class="aliases">Also known as:
<span class="names"><span id='perform_job-instance_method'>perform_job</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if a job has been performed inside block. May chain at_least, at_most or exactly to specify a number of times.</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_expect'>expect</span> <span class='lbrace'>{</span>
<span class='id identifier rubyid_perform_jobs'>perform_jobs</span> <span class='lbrace'>{</span> <span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span> <span class='rbrace'>}</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_performed_job'>have_performed_job</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='id identifier rubyid_perform_jobs'>perform_jobs</span> <span class='lbrace'>{</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='rbrace'>}</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_performed_job'>have_performed_job</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_exactly'>exactly</span><span class='lparen'>(</span><span class='symbol'>:once</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='id identifier rubyid_perform_jobs'>perform_jobs</span> <span class='lbrace'>{</span> <span class='int'>3</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_performed_job'>have_performed_job</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at_least'>at_least</span><span class='lparen'>(</span><span class='int'>2</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='id identifier rubyid_perform_jobs'>perform_jobs</span> <span class='lbrace'>{</span> <span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span> <span class='rbrace'>}</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_performed_job'>have_performed_job</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at_most'>at_most</span><span class='lparen'>(</span><span class='symbol'>:twice</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='id identifier rubyid_perform_jobs'>perform_jobs</span> <span class='lbrace'>{</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='const'>HeavyLiftingJob</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span>
<span class='rbrace'>}</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_performed_job'>have_performed_job</span><span class='lparen'>(</span><span class='const'>HelloJob</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_and'>and</span> <span class='id identifier rubyid_have_performed_job'>have_performed_job</span><span class='lparen'>(</span><span class='const'>HeavyLiftingJob</span><span class='rparen'>)</span>
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
<span class='id identifier rubyid_perform_jobs'>perform_jobs</span> <span class='lbrace'>{</span>
<span class='const'>HelloJob</span><span class='period'>.</span><span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span><span class='label'>wait_until:</span> <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_tomorrow'>tomorrow</span><span class='period'>.</span><span class='id identifier rubyid_noon'>noon</span><span class='comma'>,</span> <span class='label'>queue:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>low</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_perform_later'>perform_later</span><span class='lparen'>(</span><span class='int'>42</span><span class='rparen'>)</span>
<span class='rbrace'>}</span>
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_performed_job'>have_performed_job</span><span class='period'>.</span><span class='id identifier rubyid_with'>with</span><span class='lparen'>(</span><span class='int'>42</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_on_queue'>on_queue</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>low</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_tomorrow'>tomorrow</span><span class='period'>.</span><span class='id identifier rubyid_noon'>noon</span><span class='rparen'>)</span></code></pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
391
392
393
394</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/active_job.rb', line 391</span>
<span class='kw'>def</span> <span class='id identifier rubyid_have_performed_job'>have_performed_job</span><span class='lparen'>(</span><span class='id identifier rubyid_job'>job</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_check_active_job_adapter'>check_active_job_adapter</span>
<span class='const'><span class='object_link'><a href="Matchers/ActiveJob.html" title="RSpec::Rails::Matchers::ActiveJob (module)">ActiveJob</a></span></span><span class='op'>::</span><span class='const'>HavePerformedJob</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_job'>job</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="receive_inbound_email-instance_method">
#<strong>receive_inbound_email</strong>(message) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Passes if the given inbound email would be routed to the subject inbox.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>message</span>
<span class='type'>(<tt>Hash</tt>, <tt>Mail::Message</tt>)</span>
—
<div class='inline'><p>a mail message or hash of
attributes used to build one</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
59
60
61</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rspec/rails/matchers/action_mailbox.rb', line 59</span>
<span class='kw'>def</span> <span class='id identifier rubyid_receive_inbound_email'>receive_inbound_email</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="Matchers/ActionMailbox.html" title="RSpec::Rails::Matchers::ActionMailbox (module)">ActionMailbox</a></span></span><span class='op'>::</span><span class='const'>ReceiveInboundEmail</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Apr 8 23:32:17 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.24 (ruby-2.6.3).
</div>
</div>
</body>
</html>