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
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Module: Spec::Matchers</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Module</strong></td>
<td class="class-name-in-header">Spec::Matchers</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/spec/matchers/be_rb.html">
lib/spec/matchers/be.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/be_close_rb.html">
lib/spec/matchers/be_close.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/change_rb.html">
lib/spec/matchers/change.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/eql_rb.html">
lib/spec/matchers/eql.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/equal_rb.html">
lib/spec/matchers/equal.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/has_rb.html">
lib/spec/matchers/has.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/have_rb.html">
lib/spec/matchers/have.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/include_rb.html">
lib/spec/matchers/include.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/match_rb.html">
lib/spec/matchers/match.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/operator_matcher_rb.html">
lib/spec/matchers/operator_matcher.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/raise_error_rb.html">
lib/spec/matchers/raise_error.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/respond_to_rb.html">
lib/spec/matchers/respond_to.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/satisfy_rb.html">
lib/spec/matchers/satisfy.rb
</a>
<br />
<a href="../../files/lib/spec/matchers/throw_symbol_rb.html">
lib/spec/matchers/throw_symbol.rb
</a>
<br />
<a href="../../files/lib/spec/matchers_rb.html">
lib/spec/matchers.rb
</a>
<br />
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
RSpec ships with a number of useful Expression <a
href="Matchers.html">Matchers</a>. An Expression Matcher is any object that
responds to the following methods:
</p>
<pre>
matches?(actual)
failure_message
negative_failure_message #optional
description #optional
</pre>
<p>
See <a href="Expectations.html">Spec::Expectations</a> to learn how to use
these as Expectation <a href="Matchers.html">Matchers</a>. See <a
href="Mocks.html">Spec::Mocks</a> to learn how to use them as Mock Argument
Constraints.
</p>
<h2>Predicates</h2>
<p>
In addition to those Expression <a href="Matchers.html">Matchers</a> that
are defined explicitly, RSpec will create custom <a
href="Matchers.html">Matchers</a> on the fly for any arbitrary predicate,
giving your specs a much more natural language feel.
</p>
<p>
A Ruby predicate is a method that ends with a "?" and returns
true or false. Common examples are +empty?+, +nil?+, and +instance_of?+.
</p>
<p>
All you need to do is write +should be_+ followed by the predicate without
the question mark, and RSpec will figure it out from there. For example:
</p>
<pre>
[].should be_empty => [].empty? #passes
[].should_not be_empty => [].empty? #fails
</pre>
<p>
In addtion to prefixing the predicate matchers with "be_", you
can also use "be_a_" and "be_an_", making your specs
read much more naturally:
</p>
<pre>
"a string".should be_an_instance_of(String) =>"a string".instance_of?(String) #passes
3.should be_a_kind_of(Fixnum) => 3.kind_of?(Numeric) #passes
3.should be_a_kind_of(Numeric) => 3.kind_of?(Numeric) #passes
3.should be_an_instance_of(Fixnum) => 3.instance_of?(Fixnum) #passes
3.should_not be_instance_of(Numeric) => 3.instance_of?(Numeric) #fails
</pre>
<p>
RSpec will also create custom matchers for predicates like +has_key?+. To
use this feature, just state that the object should have_key(:key) and
RSpec will call has_key?(:key) on the target. For example:
</p>
<pre>
{:a => "A"}.should have_key(:a) => {:a => "A"}.has_key?(:a) #passes
{:a => "A"}.should have_key(:b) => {:a => "A"}.has_key?(:b) #fails
</pre>
<p>
You can use this feature to invoke any predicate that begins with
"has_", whether it is part of the Ruby libraries (like
+Hash#has_key?+) or a method you wrote on your own class.
</p>
<h2>Custom Expectation <a href="Matchers.html">Matchers</a></h2>
<p>
When you find that none of the stock Expectation <a
href="Matchers.html">Matchers</a> provide a natural feeling expectation,
you can very easily write your own.
</p>
<p>
For example, imagine that you are writing a game in which players can <a
href="Matchers.html#M000122">be</a> in various zones on a virtual board. To
specify that bob should <a href="Matchers.html#M000122">be</a> in zone 4,
you could say:
</p>
<pre>
bob.current_zone.should eql(Zone.new("4"))
</pre>
<p>
But you might find it more expressive to say:
</p>
<pre>
bob.should be_in_zone("4")
</pre>
<p>
and/or
</p>
<pre>
bob.should_not be_in_zone("3")
</pre>
<p>
To do this, you would need to write a class like this:
</p>
<pre>
class BeInZone
def initialize(expected)
@expected = expected
end
def matches?(target)
@target = target
@target.current_zone.eql?(Zone.new(@expected))
end
def failure_message
"expected #{@target.inspect} to be in Zone #{@expected}"
end
def negative_failure_message
"expected #{@target.inspect} not to be in Zone #{@expected}"
end
end
</pre>
<p>
… and a method like this:
</p>
<pre>
def be_in_zone(expected)
BeInZone.new(expected)
end
</pre>
<p>
And then expose the method to your specs. This is normally done by
including the method and the class in a module, which is then included in
your spec:
</p>
<pre>
module CustomGameMatchers
class BeInZone
...
end
def be_in_zone(expected)
...
end
end
describe "Player behaviour" do
include CustomGameMatchers
...
end
</pre>
<p>
or you can <a href="Matchers.html#M000131">include</a> in globally in a
spec_helper.rb file <tt>require</tt>d from your spec file(s):
</p>
<pre>
Spec::Runner.configure do |config|
config.include(CustomGameMatchers)
end
</pre>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000122">be</a>
<a href="#M000123">be_close</a>
<a href="#M000124">change</a>
<a href="#M000125">eql</a>
<a href="#M000126">equal</a>
<a href="#M000127">have</a>
<a href="#M000129">have_at_least</a>
<a href="#M000130">have_at_most</a>
<a href="#M000128">have_exactly</a>
<a href="#M000131">include</a>
<a href="#M000132">match</a>
<a href="#M000133">raise_error</a>
<a href="#M000134">respond_to</a>
<a href="#M000135">satisfy</a>
<a href="#M000136">throw_symbol</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="class-list">
<h3 class="section-bar">Classes and Modules</h3>
Module <a href="Matchers/ModuleMethods.html" class="link">Spec::Matchers::ModuleMethods</a><br />
Class <a href="Matchers/BaseOperatorMatcher.html" class="link">Spec::Matchers::BaseOperatorMatcher</a><br />
Class <a href="Matchers/MatcherError.html" class="link">Spec::Matchers::MatcherError</a><br />
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000122" class="method-detail">
<a name="M000122"></a>
<div class="method-heading">
<a href="#M000122" class="method-signature">
<span class="method-name">should be_true<br />
should be_false<br />
should be_nil<br />
should be_arbitrary_predicate(*args)<br />
should_not be_nil<br />
should_not be_arbitrary_predicate(*args)<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Given true, false, or nil, will pass if actual is true, false or nil
(respectively).
</p>
<p>
Predicates are any Ruby method that ends in a "?" and returns
true or false. Given be_ followed by arbitrary_predicate (without the
"?"), RSpec will <a href="Matchers.html#M000132">match</a>
convert that into a query against the target object.
</p>
<p>
The arbitrary_predicate feature will handle any predicate prefixed with
"be_an_" (e.g. be_an_instance_of), "be_a_" (e.g.
be_a_kind_of) or "be_" (e.g. be_empty), letting you choose the
prefix that best suits the predicate.
</p>
<h2>Examples</h2>
<pre>
target.should be_true
target.should be_false
target.should be_nil
target.should_not be_nil
collection.should be_empty #passes if target.empty?
"this string".should be_an_intance_of(String)
target.should_not be_empty #passes unless target.empty?
target.should_not be_old_enough(16) #passes unless target.old_enough?(16)
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000122-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000122-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/be.rb, line 202</span>
202: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">be</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
203: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">Be</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
204: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000123" class="method-detail">
<a name="M000123"></a>
<div class="method-heading">
<a href="#M000123" class="method-signature">
<span class="method-name">should be_close(expected, delta)<br />
should_not be_close(expected, delta)<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Passes if actual == expected +/- delta
</p>
<h2>Example</h2>
<pre>
result.should be_close(3.0, 0.5)
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000123-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000123-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/be_close.rb, line 33</span>
33: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">be_close</span>(<span class="ruby-identifier">expected</span>, <span class="ruby-identifier">delta</span>)
34: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">BeClose</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">expected</span>, <span class="ruby-identifier">delta</span>)
35: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000124" class="method-detail">
<a name="M000124"></a>
<div class="method-heading">
<a href="#M000124" class="method-signature">
<span class="method-name">should change(receiver, message, &block)<br />
should change(receiver, message, &block).by(value)<br />
should change(receiver, message, &block).from(old).to(new)<br />
should_not change(receiver, message, &block)<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Allows you to specify that a Proc will cause some value to <a
href="Matchers.html#M000124">change</a>.
</p>
<h2>Examples</h2>
<pre>
lambda {
team.add_player(player)
}.should change(roster, :count)
lambda {
team.add_player(player)
}.should change(roster, :count).by(1)
string = "string"
lambda {
string.reverse
}.should change { string }.from("string").to("gnirts")
lambda {
person.happy_birthday
}.should change(person, :birthday).from(32).to(33)
lambda {
employee.develop_great_new_social_networking_app
}.should change(employee, :title).from("Mail Clerk").to("CEO")
</pre>
<p>
Evaluates +receiver.message+ or <tt>block</tt> before and after it
evaluates the c object (generated by the lambdas in the examples above).
</p>
<p>
Then compares the values before and after the +receiver.message+ and
evaluates the difference compared to the expected difference.
</p>
<h2>Warning</h2>
<p>
<tt>should_not</tt> <tt><a href="Matchers.html#M000124">change</a></tt>
only supports the form with no subsequent calls to <tt><a
href="Matchers.html#M000122">be</a></tt>, <tt>to</tt> or <tt>from</tt>.
</p>
<p>
blocks passed to <tt>should</tt> <tt><a
href="Matchers.html#M000124">change</a></tt> and <tt>should_not</tt> <tt><a
href="Matchers.html#M000124">change</a></tt> must use the <tt>{}</tt> form
(<tt>do/end</tt> is not supported)
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000124-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000124-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/change.rb, line 117</span>
117: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">change</span>(<span class="ruby-identifier">target</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">message</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
118: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">Change</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">target</span>, <span class="ruby-identifier">message</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
119: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000125" class="method-detail">
<a name="M000125"></a>
<div class="method-heading">
<a href="#M000125" class="method-signature">
<span class="method-name">should eql(expected)<br />
should_not eql(expected)<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Passes if actual and expected are of <a
href="Matchers.html#M000126">equal</a> value, but not necessarily the same
object.
</p>
<p>
See <a
href="http://www.ruby-doc.org/core/classes/Object.html#M001057">www.ruby-doc.org/core/classes/Object.html#M001057</a>
for more information about equality in Ruby.
</p>
<h2>Examples</h2>
<pre>
5.should eql(5)
5.should_not eql(3)
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000125-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000125-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/eql.rb, line 39</span>
39: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">eql</span>(<span class="ruby-identifier">expected</span>)
40: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">Eql</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">expected</span>)
41: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000126" class="method-detail">
<a name="M000126"></a>
<div class="method-heading">
<a href="#M000126" class="method-signature">
<span class="method-name">should equal(expected)<br />
should_not equal(expected)<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Passes if actual and expected are the same object (object identity).
</p>
<p>
See <a
href="http://www.ruby-doc.org/core/classes/Object.html#M001057">www.ruby-doc.org/core/classes/Object.html#M001057</a>
for more information about equality in Ruby.
</p>
<h2>Examples</h2>
<pre>
5.should equal(5) #Fixnums are equal
"5".should_not equal("5") #Strings that look the same are not the same object
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000126-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000126-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/equal.rb, line 39</span>
39: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">equal</span>(<span class="ruby-identifier">expected</span>)
40: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">Equal</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">expected</span>)
41: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000127" class="method-detail">
<a name="M000127"></a>
<div class="method-heading">
<a href="#M000127" class="method-signature">
<span class="method-name">should have(number).named_collection__or__sugar<br />
should_not have(number).named_collection__or__sugar<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Passes if receiver is a collection with the submitted number of items OR if
the receiver OWNS a collection with the submitted number of items.
</p>
<p>
If the receiver OWNS the collection, you must use the name of the
collection. So if a <tt>Team</tt> instance has a collection named
<tt>players</tt>, you must use that name to set the expectation.
</p>
<p>
If the receiver IS the collection, you can use any name you like for
<tt>named_collection</tt>. We‘d recommend using either
"elements", "members", or "items" as these
are all standard ways of describing the things IN a collection.
</p>
<p>
This also works for Strings, letting you set an expectation about its
length
</p>
<h2>Examples</h2>
<pre>
# Passes if team.players.size == 11
team.should have(11).players
# Passes if [1,2,3].length == 3
[1,2,3].should have(3).items #"items" is pure sugar
# Passes if "this string".length == 11
"this string".should have(11).characters #"characters" is pure sugar
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000127-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000127-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/have.rb, line 115</span>
115: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">have</span>(<span class="ruby-identifier">n</span>)
116: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">Have</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">n</span>)
117: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000129" class="method-detail">
<a name="M000129"></a>
<div class="method-heading">
<a href="#M000129" class="method-signature">
<span class="method-name">should have_at_least(number).items<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Exactly like <a href="Matchers.html#M000127">have</a>() with >=.
</p>
<h2>Warning</h2>
<p>
<tt>should_not</tt> <tt><a
href="Matchers.html#M000129">have_at_least</a></tt> is not supported
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000129-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000129-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/have.rb, line 128</span>
128: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">have_at_least</span>(<span class="ruby-identifier">n</span>)
129: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">Have</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">n</span>, <span class="ruby-identifier">:at_least</span>)
130: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000130" class="method-detail">
<a name="M000130"></a>
<div class="method-heading">
<a href="#M000130" class="method-signature">
<span class="method-name">should have_at_most(number).items<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Exactly like <a href="Matchers.html#M000127">have</a>() with <=.
</p>
<h2>Warning</h2>
<p>
<tt>should_not</tt> <tt><a
href="Matchers.html#M000130">have_at_most</a></tt> is not supported
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000130-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000130-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/have.rb, line 140</span>
140: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">have_at_most</span>(<span class="ruby-identifier">n</span>)
141: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">Have</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">n</span>, <span class="ruby-identifier">:at_most</span>)
142: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000128" class="method-detail">
<a name="M000128"></a>
<div class="method-heading">
<span class="method-name">have_exactly</span><span class="method-args">(n)</span>
</div>
<div class="method-description">
<p>
Alias for <a href="Matchers.html#M000127">have</a>
</p>
</div>
</div>
<div id="method-M000131" class="method-detail">
<a name="M000131"></a>
<div class="method-heading">
<a href="#M000131" class="method-signature">
<span class="method-name">should include(expected)<br />
should_not include(expected)<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Passes if actual includes expected. This works for collections and Strings.
You can also pass in multiple args and it will only pass if all args are
found in collection.
</p>
<h2>Examples</h2>
<pre>
[1,2,3].should include(3)
[1,2,3].should include(2,3) #would pass
[1,2,3].should include(2,3,4) #would fail
[1,2,3].should_not include(4)
"spread".should include("read")
"spread".should_not include("red")
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000131-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000131-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/include.rb, line 66</span>
66: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">include</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">expected</span>)
67: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">Include</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">expected</span>)
68: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000132" class="method-detail">
<a name="M000132"></a>
<div class="method-heading">
<a href="#M000132" class="method-signature">
<span class="method-name">should match(regexp)<br />
should_not match(regexp)<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Given a Regexp, passes if actual =~ regexp
</p>
<h2>Examples</h2>
<pre>
email.should match(/^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i)
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000132-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000132-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/match.rb, line 37</span>
37: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">match</span>(<span class="ruby-identifier">regexp</span>)
38: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">Match</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">regexp</span>)
39: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000133" class="method-detail">
<a name="M000133"></a>
<div class="method-heading">
<a href="#M000133" class="method-signature">
<span class="method-name">should raise_error()<br />
should raise_error(NamedError)<br />
should raise_error(NamedError, String)<br />
should raise_error(NamedError, Regexp)<br />
should_not raise_error()<br />
should_not raise_error(NamedError)<br />
should_not raise_error(NamedError, String)<br />
should_not raise_error(NamedError, Regexp)<br />
</span>
</a>
</div>
<div class="method-description">
<p>
With no args, matches if any error is raised. With a named error, matches
only if that specific error is raised. With a named error and messsage
specified as a <a href="../String.html">String</a>, matches only if both <a
href="Matchers.html#M000132">match</a>. With a named error and messsage
specified as a Regexp, matches only if both <a
href="Matchers.html#M000132">match</a>.
</p>
<h2>Examples</h2>
<pre>
lambda { do_something_risky }.should raise_error
lambda { do_something_risky }.should raise_error(PoorRiskDecisionError)
lambda { do_something_risky }.should raise_error(PoorRiskDecisionError, "that was too risky")
lambda { do_something_risky }.should raise_error(PoorRiskDecisionError, /oo ri/)
lambda { do_something_risky }.should_not raise_error
lambda { do_something_risky }.should_not raise_error(PoorRiskDecisionError)
lambda { do_something_risky }.should_not raise_error(PoorRiskDecisionError, "that was too risky")
lambda { do_something_risky }.should_not raise_error(PoorRiskDecisionError, /oo ri/)
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000133-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000133-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/raise_error.rb, line 101</span>
101: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">raise_error</span>(<span class="ruby-identifier">error</span>=<span class="ruby-constant">Exception</span>, <span class="ruby-identifier">message</span>=<span class="ruby-keyword kw">nil</span>)
102: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">RaiseError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">error</span>, <span class="ruby-identifier">message</span>)
103: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000134" class="method-detail">
<a name="M000134"></a>
<div class="method-heading">
<a href="#M000134" class="method-signature">
<span class="method-name">should respond_to(*names)<br />
should_not respond_to(*names)<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Matches if the target object responds to all of the names provided. Names
can <a href="Matchers.html#M000122">be</a> Strings or Symbols.
</p>
<h2>Examples</h2>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000134-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000134-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/respond_to.rb, line 41</span>
41: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">respond_to</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">names</span>)
42: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">RespondTo</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">names</span>)
43: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000135" class="method-detail">
<a name="M000135"></a>
<div class="method-heading">
<a href="#M000135" class="method-signature">
<span class="method-name">should satisfy {}<br />
should_not satisfy {}<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Passes if the submitted block returns true. Yields target to the block.
</p>
<p>
Generally speaking, this should <a href="Matchers.html#M000122">be</a>
thought of as a last resort when you can‘t find any other way to
specify the behaviour you wish to specify.
</p>
<p>
If you do find yourself in such a situation, you could always write a
custom matcher, which would likely make your specs more expressive.
</p>
<h2>Examples</h2>
<pre>
5.should satisfy { |n|
n > 3
}
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000135-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000135-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/satisfy.rb, line 43</span>
43: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">satisfy</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
44: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">Satisfy</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
45: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000136" class="method-detail">
<a name="M000136"></a>
<div class="method-heading">
<a href="#M000136" class="method-signature">
<span class="method-name">should throw_symbol()<br />
should throw_symbol(:sym)<br />
should_not throw_symbol()<br />
should_not throw_symbol(:sym)<br />
</span>
</a>
</div>
<div class="method-description">
<p>
Given a <a href="../Symbol.html">Symbol</a> argument, matches if a proc
throws the specified <a href="../Symbol.html">Symbol</a>.
</p>
<p>
Given no argument, matches if a proc throws any <a
href="../Symbol.html">Symbol</a>.
</p>
<h2>Examples</h2>
<pre>
lambda { do_something_risky }.should throw_symbol
lambda { do_something_risky }.should throw_symbol(:that_was_risky)
lambda { do_something_risky }.should_not throw_symbol
lambda { do_something_risky }.should_not throw_symbol(:that_was_risky)
</pre>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000136-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000136-source">
<pre>
<span class="ruby-comment cmt"># File lib/spec/matchers/throw_symbol.rb, line 68</span>
68: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">throw_symbol</span>(<span class="ruby-identifier">sym</span>=<span class="ruby-keyword kw">nil</span>)
69: <span class="ruby-constant">Matchers</span><span class="ruby-operator">::</span><span class="ruby-constant">ThrowSymbol</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">sym</span>)
70: <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|
