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
|
require 'spec_helper'
require 'uri'
describe "#include matcher" do
it "is diffable" do
expect(include("a")).to be_diffable
end
describe "expect(...).to include(with_one_arg)" do
it_behaves_like "an RSpec matcher", :valid_value => [1, 2], :invalid_value => [1] do
let(:matcher) { include(2) }
end
context "for a string target" do
it "passes if target includes expected" do
expect("abc").to include("a")
end
it "fails if target does not include expected" do
expect {
expect("abc").to include("d")
}.to fail_matching("expected \"abc\" to include \"d\"")
end
it "includes a diff when actual is multiline" do
expect {
expect("abc\ndef").to include("g")
}.to fail_matching("expected \"abc\\ndef\" to include \"g\"\nDiff")
end
it "includes a diff when actual is multiline and there are multiple expecteds" do
expect {
expect("abc\ndef").to include("g", "h")
}.to fail_matching("expected \"abc\\ndef\" to include \"g\" and \"h\"\nDiff")
end
end
context "for an array target" do
it "passes if target includes expected" do
expect([1,2,3]).to include(3)
end
it "fails if target does not include expected" do
expect {
expect([1,2,3]).to include(4)
}.to fail_matching("expected [1, 2, 3] to include 4")
end
it 'fails when given differing null doubles' do
dbl_1 = double.as_null_object
dbl_2 = double.as_null_object
expect {
expect([dbl_1]).to include(dbl_2)
}.to fail_matching("expected [#{dbl_1.inspect}] to include")
end
it 'passes when given the same null double' do
dbl = double.as_null_object
expect([dbl]).to include(dbl)
end
end
context "for a hash target" do
it 'passes if target has the expected as a key' do
expect({:key => 'value'}).to include(:key)
end
it "fails if target does not include expected" do
expect {
expect({:key => 'value'}).to include(:other)
}.to fail_matching(%Q|expected {:key=>"value"} to include :other|)
end
it "fails if target doesn't have a key and we expect nil" do
expect {
expect({}).to include(:something => nil)
}.to fail_matching(%Q|expected {} to include {:something=>nil}|)
end
it 'works even when an entry in the hash overrides #send' do
hash = { :key => 'value' }
def hash.send; :sent; end
expect(hash).to include(hash)
end
context 'that overrides #send' do
it 'still works' do
array = [1, 2]
def array.send; :sent; end
expect(array).to include(*array)
end
end
end
end
describe "expect(...).to include(with, multiple, args)" do
it "has a description" do
matcher = include("a")
expect(matcher.description).to eq("include \"a\"")
end
context "for a string target" do
it "passes if target includes all items" do
expect("a string").to include("str", "a")
end
it "fails if target does not include any one of the items" do
expect {
expect("a string").to include("str", "a", "foo")
}.to fail_matching(%Q{expected "a string" to include "str", "a", and "foo"})
end
end
context "for an array target" do
it "passes if target includes all items" do
expect([1,2,3]).to include(1,2,3)
end
it "fails if target does not include any one of the items" do
expect {
expect([1,2,3]).to include(1,2,4)
}.to fail_matching("expected [1, 2, 3] to include 1, 2, and 4")
end
end
context "for a hash target" do
it 'passes if target includes all items as keys' do
expect({:key => 'value', :other => 'value'}).to include(:key, :other)
end
it 'fails if target is missing any item as a key' do
expect {
expect({:key => 'value'}).to include(:key, :other)
}.to fail_matching(%Q|expected {:key=>"value"} to include :key and :other|)
end
end
end
describe "expect(...).not_to include(expected)" do
context "for a string target" do
it "passes if target does not include expected" do
expect("abc").not_to include("d")
end
it "fails if target includes expected" do
expect {
expect("abc").not_to include("c")
}.to fail_with("expected \"abc\" not to include \"c\"")
end
end
context "for an array target" do
it "passes if target does not include expected" do
expect([1,2,3]).not_to include(4)
end
it "fails if target includes expected" do
expect {
expect([1,2,3]).not_to include(3)
}.to fail_with("expected [1, 2, 3] not to include 3")
end
it 'passes when given differing null doubles' do
expect([double.as_null_object]).not_to include(double.as_null_object)
end
it 'fails when given the same null double' do
dbl = double.as_null_object
expect {
expect([dbl]).not_to include(dbl)
}.to fail_matching("expected [#{dbl.inspect}] not to include")
end
end
context "for a hash target" do
it 'passes if target does not have the expected as a key' do
expect({:other => 'value'}).not_to include(:key)
end
it "fails if target includes expected key" do
expect {
expect({:key => 'value'}).not_to include(:key)
}.to fail_matching(%Q|expected {:key=>"value"} not to include :key|)
end
end
end
describe "expect(...).not_to include(with, multiple, args)" do
context "for a string target" do
it "passes if the target does not include any of the expected" do
expect("abc").not_to include("d", "e", "f")
end
it "fails if the target includes all of the expected" do
expect {
expect("abc").not_to include("c", "a")
}.to fail_with('expected "abc" not to include "c" and "a"')
end
it "fails if the target includes some (but not all) of the expected" do
expect {
expect("abc").not_to include("d", "a")
}.to fail_with(%q{expected "abc" not to include "d" and "a"})
end
end
context "for a hash target" do
it "passes if it does not include any of the expected keys" do
expect({ :a => 1, :b => 2 }).not_to include(:c, :d)
end
it "fails if the target includes all of the expected keys" do
expect {
expect({ :a => 1, :b => 2 }).not_to include(:a, :b)
}.to fail_matching(%Q|expected #{{:a=>1, :b=>2}.inspect} not to include :a and :b|)
end
it "fails if the target includes some (but not all) of the expected keys" do
expect {
expect({ :a => 1, :b => 2 }).not_to include(:d, :b)
}.to fail_matching(%Q|expected #{{:a=>1, :b=>2}.inspect} not to include :d and :b|)
end
end
context "for an array target" do
it "passes if the target does not include any of the expected" do
expect([1, 2, 3]).not_to include(4, 5, 6)
end
it "fails if the target includes all of the expected" do
expect {
expect([1, 2, 3]).not_to include(3, 1)
}.to fail_with(%q{expected [1, 2, 3] not to include 3 and 1})
end
it "fails if the target includes some (but not all) of the expected" do
expect {
expect([1, 2, 3]).not_to include(4, 1)
}.to fail_with(%q{expected [1, 2, 3] not to include 4 and 1})
end
end
end
describe "expect(...).to include(:key => value)" do
context 'for a hash target' do
it "passes if target includes the key/value pair" do
expect({:key => 'value'}).to include(:key => 'value')
end
it "passes if target includes the key/value pair among others" do
expect({:key => 'value', :other => 'different'}).to include(:key => 'value')
end
it "fails if target has a different value for key" do
expect {
expect({:key => 'different'}).to include(:key => 'value')
}.to fail_matching(%Q|expected {:key=>"different"} to include {:key=>"value"}|)
end
it "fails if target has a different key" do
expect {
expect({:other => 'value'}).to include(:key => 'value')
}.to fail_matching(%Q|expected {:other=>"value"} to include {:key=>"value"}|)
end
end
context 'for a non-hash target' do
it "fails if the target does not contain the given hash" do
expect {
expect(['a', 'b']).to include(:key => 'value')
}.to fail_matching(%q|expected ["a", "b"] to include {:key=>"value"}|)
end
it "passes if the target contains the given hash" do
expect(['a', { :key => 'value' } ]).to include(:key => 'value')
end
end
end
describe "expect(...).not_to include(:key => value)" do
context 'for a hash target' do
it "fails if target includes the key/value pair" do
expect {
expect({:key => 'value'}).not_to include(:key => 'value')
}.to fail_matching(%Q|expected {:key=>"value"} not to include {:key=>"value"}|)
end
it "fails if target includes the key/value pair among others" do
expect {
expect({:key => 'value', :other => 'different'}).not_to include(:key => 'value')
}.to fail_matching(%Q|expected #{{:key=>"value", :other=>"different"}.inspect} not to include {:key=>"value"}|)
end
it "passes if target has a different value for key" do
expect({:key => 'different'}).not_to include(:key => 'value')
end
it "passes if target has a different key" do
expect({:other => 'value'}).not_to include(:key => 'value')
end
end
context "for a non-hash target" do
it "passes if the target does not contain the given hash" do
expect(['a', 'b']).not_to include(:key => 'value')
end
it "fails if the target contains the given hash" do
expect {
expect(['a', { :key => 'value' } ]).not_to include(:key => 'value')
}.to fail_matching(%Q|expected ["a", {:key=>"value"}] not to include {:key=>"value"}|)
end
end
end
describe "expect(...).to include(:key1 => value1, :key2 => value2)" do
context 'for a hash target' do
it "passes if target includes the key/value pairs" do
expect({:a => 1, :b => 2}).to include(:b => 2, :a => 1)
end
it "passes if target includes the key/value pairs among others" do
expect({:a => 1, :c => 3, :b => 2}).to include(:b => 2, :a => 1)
end
it "fails if target has a different value for one of the keys" do
expect {
expect({:a => 1, :b => 2}).to include(:a => 2, :b => 2)
}.to fail_matching(%Q|expected #{{:a=>1, :b=>2}.inspect} to include #{{:a=>2, :b=>2}.inspect}|)
end
it "fails if target has a different value for both of the keys" do
expect {
expect({:a => 1, :b => 1}).to include(:a => 2, :b => 2)
}.to fail_matching(%Q|expected #{{:a=>1, :b=>1}.inspect} to include #{{:a=>2, :b=>2}.inspect}|)
end
it "fails if target lacks one of the keys" do
expect {
expect({:a => 1, :b => 1}).to include(:a => 1, :c => 1)
}.to fail_matching(%Q|expected #{{:a=>1, :b=>1}.inspect} to include #{{:a=>1, :c=>1}.inspect}|)
end
it "fails if target lacks both of the keys" do
expect {
expect({:a => 1, :b => 1}).to include(:c => 1, :d => 1)
}.to fail_matching(%Q|expected #{{:a=>1, :b=>1}.inspect} to include #{{:c=>1, :d=>1}.inspect}|)
end
end
context 'for a non-hash target' do
it "fails if the target does not contain the given hash" do
expect {
expect(['a', 'b']).to include(:a => 1, :b => 1)
}.to fail_matching(%Q|expected ["a", "b"] to include #{{:a=>1, :b=>1}.inspect}|)
end
it "passes if the target contains the given hash" do
expect(['a', { :a => 1, :b => 2 } ]).to include(:a => 1, :b => 2)
end
end
end
describe "expect(...).not_to include(:key1 => value1, :key2 => value2)" do
context 'for a hash target' do
it "fails if target includes the key/value pairs" do
expect {
expect({:a => 1, :b => 2}).not_to include(:a => 1, :b => 2)
}.to fail_matching(%Q|expected #{{:a=>1, :b=>2}.inspect} not to include #{{:a=>1, :b=>2}.inspect}|)
end
it "fails if target includes the key/value pairs among others" do
hash = {:a => 1, :b => 2, :c => 3}
expect {
expect(hash).not_to include(:a => 1, :b => 2)
}.to fail_matching(%Q|expected #{hash.inspect} not to include #{{:a=>1, :b=>2}.inspect}|)
end
it "fails if target has a different value for one of the keys" do
expect {
expect({:a => 1, :b => 2}).not_to include(:a => 2, :b => 2)
}.to fail_matching(%Q|expected #{{:a=>1, :b=>2}.inspect} not to include #{{:a=>2, :b=>2}.inspect}|)
end
it "passes if target has a different value for both of the keys" do
expect({:a => 1, :b => 1}).not_to include(:a => 2, :b => 2)
end
it "fails if target lacks one of the keys" do
expect {
expect({:a => 1, :b => 1}).not_to include(:a => 1, :c => 1)
}.to fail_matching(%Q|expected #{{:a=>1, :b=>1}.inspect} not to include #{{:a=>1, :c=>1}.inspect}|)
end
it "passes if target lacks both of the keys" do
expect({:a => 1, :b => 1}).not_to include(:c => 1, :d => 1)
end
end
context 'for a non-hash target' do
it "passes if the target does not contain the given hash" do
expect(['a', 'b']).not_to include(:a => 1, :b => 1)
end
it "fails if the target contains the given hash" do
expect {
expect(['a', { :a => 1, :b => 2 } ]).not_to include(:a => 1, :b => 2)
}.to fail_matching(%Q|expected #{["a", {:a=>1, :b=>2}].inspect} not to include #{{:a=>1, :b=>2}.inspect}|)
end
end
end
end
RSpec::Matchers.define :a_string_containing do |expected|
match do |actual|
actual.include?(expected)
end
description do
"a string containing '#{expected}'"
end
end
describe "expect(...).to include(matcher)" do
context 'for an array target' do
it "passes if target includes an object that satisfies the matcher" do
expect(['foo', 'bar', 'baz']).to include(a_string_containing("ar"))
end
it "fails if target doesn't include object that satisfies the matcher" do
expect {
expect(['foo', 'bar', 'baz']).to include(a_string_containing("abc"))
}.to fail_matching(%Q|expected #{['foo', 'bar', 'baz'].inspect} to include a string containing 'abc'|)
end
it 'does not include a diff when the match fails' do
expect {
expect(['foo', 'bar', 'baz']).to include(a_string_containing("abc"))
}.to raise_error { |e|
expect(e.message).not_to match(/diff/i)
}
end
it 'does not treat an object that only implements #matches? as a matcher' do
domain = Struct.new(:domain) do
def matches?(url)
URI(url).host == self.domain
end
end
expect([domain.new("rspec.info")]).to include(domain.new("rspec.info"))
expect {
expect([domain.new("rspec.info")]).to include(domain.new("foo.com"))
}.to fail_matching("expected [#{domain.new("rspec.info").inspect}] to include")
end
it 'works with an old-style matcher that implements failure_message rather than failure_message_for_should' do
a_multiple_of = Class.new do
def initialize(expected)
@expected = expected
end
def matches?(actual)
(actual % @expected).zero?
end
def failure_message
"expected a multiple of #{@expected}"
end
end
# Verify the matcher works normally
expect(10).to a_multiple_of.new(5)
expect {
expect(10).to a_multiple_of.new(7)
}.to fail_with("expected a multiple of 7")
expect([12, 13, 14]).to include(a_multiple_of.new(6))
expect {
expect([12, 13, 14]).to include(a_multiple_of.new(10))
}.to fail_matching("expected [12, 13, 14] to include")
end
end
end
describe "expect(...).to include(multiple, matcher, arguments)" do
context 'for an array target' do
it "passes if target includes items satisfying all matchers" do
expect(['foo', 'bar', 'baz']).to include(a_string_containing("ar"), a_string_containing('oo'))
end
it "fails if target does not include an item satisfying any one of the items" do
expect {
expect(['foo', 'bar', 'baz']).to include(a_string_containing("ar"), a_string_containing("abc"))
}.to fail_matching(%Q|expected #{['foo', 'bar', 'baz'].inspect} to include a string containing 'ar' and a string containing 'abc'|)
end
it 'does not include a diff when the match fails' do
expect {
expect(['foo', 'bar', 'baz']).to include(a_string_containing("ar"), a_string_containing("abc"))
}.to raise_error { |e|
expect(e.message).not_to match(/diff/i)
}
end
end
end
describe "expect(...).not_to include(multiple, matcher, arguments)" do
it "passes if none of the target values satisfies any of the matchers" do
expect(['foo', 'bar', 'baz']).not_to include(a_string_containing("gh"), a_string_containing('de'))
end
it 'fails if all of the matchers are satisfied by one of the target values' do
expect {
expect(['foo', 'bar', 'baz']).not_to include(a_string_containing("ar"), a_string_containing('az'))
}.to fail_matching(%Q|expected #{['foo', 'bar', 'baz'].inspect} not to include a string containing 'ar' and a string containing 'az'|)
end
it 'fails if the some (but not all) of the matchers are satisifed' do
expect {
expect(['foo', 'bar', 'baz']).not_to include(a_string_containing("ar"), a_string_containing('bz'))
}.to fail_matching(%Q|expected #{['foo', 'bar', 'baz'].inspect} not to include a string containing 'ar' and a string containing 'bz'|)
end
end
|
