File: define_matcher.feature

package info (click to toggle)
ruby-rspec 3.9.0c2e2m1s3-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,612 kB
  • sloc: ruby: 67,456; sh: 1,572; makefile: 98
file content (456 lines) | stat: -rw-r--r-- 14,725 bytes parent folder | download
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
Feature: Define a custom matcher

  rspec-expectations provides a DSL for defining custom matchers. These are often useful for expressing expectations in the domain of your application.

  Behind the scenes `RSpec::Matchers.define` evaluates the `define` block in the context of a singleton class. If you need to write a more complex matcher and would like to use the `Class`-approach yourself, please head over to our `API`-documentation and read [the docs](http://rspec.info/documentation/latest/rspec-expectations/RSpec/Matchers/MatcherProtocol.html) about the `MatcherProtocol`.

  Scenario: Define a matcher with default messages
    Given a file named "matcher_with_default_message_spec.rb" with:
      """ruby
      require 'rspec/expectations'

      RSpec::Matchers.define :be_a_multiple_of do |expected|
        match do |actual|
          actual % expected == 0
        end
      end

      RSpec.describe 9 do
        it { is_expected.to be_a_multiple_of(3) }
      end

      RSpec.describe 9 do
        it { is_expected.not_to be_a_multiple_of(4) }
      end

      # fail intentionally to generate expected output
      RSpec.describe 9 do
        it { is_expected.to be_a_multiple_of(4) }
      end

      # fail intentionally to generate expected output
      RSpec.describe 9 do
        it { is_expected.not_to be_a_multiple_of(3) }
      end
      """
    When I run `rspec ./matcher_with_default_message_spec.rb --format documentation`
    Then the exit status should not be 0

    And the output should contain "is expected to be a multiple of 3"
    And the output should contain "is expected not to be a multiple of 4"
    And the output should contain "Failure/Error: it { is_expected.to be_a_multiple_of(4) }"
    And the output should contain "Failure/Error: it { is_expected.not_to be_a_multiple_of(3) }"

    And the output should contain "4 examples, 2 failures"
    And the output should contain "expected 9 to be a multiple of 4"
    And the output should contain "expected 9 not to be a multiple of 3"

  Scenario: Overriding the failure_message
    Given a file named "matcher_with_failure_message_spec.rb" with:
      """ruby
      require 'rspec/expectations'

      RSpec::Matchers.define :be_a_multiple_of do |expected|
        match do |actual|
          actual % expected == 0
        end
        failure_message do |actual|
          "expected that #{actual} would be a multiple of #{expected}"
        end
      end

      # fail intentionally to generate expected output
      RSpec.describe 9 do
        it { is_expected.to be_a_multiple_of(4) }
      end
      """
    When I run `rspec ./matcher_with_failure_message_spec.rb`
    Then the exit status should not be 0
    And the stdout should contain "1 example, 1 failure"
    And the stdout should contain "expected that 9 would be a multiple of 4"

  Scenario: Overriding the failure_message_when_negated
    Given a file named "matcher_with_failure_for_message_spec.rb" with:
      """ruby
      require 'rspec/expectations'

      RSpec::Matchers.define :be_a_multiple_of do |expected|
        match do |actual|
          actual % expected == 0
        end
        failure_message_when_negated do |actual|
          "expected that #{actual} would not be a multiple of #{expected}"
        end
      end

      # fail intentionally to generate expected output
      RSpec.describe 9 do
        it { is_expected.not_to be_a_multiple_of(3) }
      end
      """
    When I run `rspec ./matcher_with_failure_for_message_spec.rb`
    Then the exit status should not be 0
    And the stdout should contain "1 example, 1 failure"
    And the stdout should contain "expected that 9 would not be a multiple of 3"

  Scenario: Overriding the description
    Given a file named "matcher_overriding_description_spec.rb" with:
      """ruby
      require 'rspec/expectations'

      RSpec::Matchers.define :be_a_multiple_of do |expected|
        match do |actual|
          actual % expected == 0
        end
        description do
          "be multiple of #{expected}"
        end
      end

      RSpec.describe 9 do
        it { is_expected.to be_a_multiple_of(3) }
      end

      RSpec.describe 9 do
        it { is_expected.not_to be_a_multiple_of(4) }
      end
      """
    When I run `rspec ./matcher_overriding_description_spec.rb --format documentation`
    Then the exit status should be 0
    And the stdout should contain "2 examples, 0 failures"
    And the stdout should contain "is expected to be multiple of 3"
    And the stdout should contain "is expected not to be multiple of 4"

  Scenario: With no args
    Given a file named "matcher_with_no_args_spec.rb" with:
      """ruby
      require 'rspec/expectations'

      RSpec::Matchers.define :have_7_fingers do
        match do |thing|
          thing.fingers.length == 7
        end
      end

      class Thing
        def fingers; (1..7).collect {"finger"}; end
      end

      RSpec.describe Thing do
        it { is_expected.to have_7_fingers }
      end
      """
    When I run `rspec ./matcher_with_no_args_spec.rb --format documentation`
    Then the exit status should be 0
    And the stdout should contain "1 example, 0 failures"
    And the stdout should contain "is expected to have 7 fingers"

  Scenario: With multiple args
    Given a file named "matcher_with_multiple_args_spec.rb" with:
      """ruby
      require 'rspec/expectations'

      RSpec::Matchers.define :be_the_sum_of do |a,b,c,d|
        match do |sum|
          a + b + c + d == sum
        end
      end

      RSpec.describe 10 do
        it { is_expected.to be_the_sum_of(1,2,3,4) }
      end
      """
    When I run `rspec ./matcher_with_multiple_args_spec.rb --format documentation`
    Then the exit status should be 0
    And the stdout should contain "1 example, 0 failures"
    And the stdout should contain "is expected to be the sum of 1, 2, 3, and 4"

  Scenario: With a block arg
    Given a file named "matcher_with_block_arg_spec.rb" with:
      """ruby
      require 'rspec/expectations'

      RSpec::Matchers.define :be_lazily_equal_to do
        match do |obj|
          obj == block_arg.call
        end

        description { "be lazily equal to #{block_arg.call}" }
      end

      RSpec.describe 10 do
        it { is_expected.to be_lazily_equal_to { 10 } }
      end
      """
    When I run `rspec ./matcher_with_block_arg_spec.rb --format documentation`
    Then the exit status should be 0
    And the stdout should contain "1 example, 0 failures"
    And the stdout should contain "is expected to be lazily equal to 10"

  Scenario: With helper methods
    Given a file named "matcher_with_internal_helper_spec.rb" with:
      """ruby
      require 'rspec/expectations'

      RSpec::Matchers.define :have_same_elements_as do |sample|
        match do |actual|
          similar?(sample, actual)
        end

        def similar?(a, b)
          a.sort == b.sort
        end
      end

      RSpec.describe "these two arrays" do
        specify "should be similar" do
          expect([1,2,3]).to have_same_elements_as([2,3,1])
        end
      end
      """
    When I run `rspec ./matcher_with_internal_helper_spec.rb`
    Then the exit status should be 0
    And the stdout should contain "1 example, 0 failures"

  Scenario: Scoped in a module
    Given a file named "scoped_matcher_spec.rb" with:
      """ruby
      require 'rspec/expectations'

      module MyHelpers
        extend RSpec::Matchers::DSL

        matcher :be_just_like do |expected|
          match {|actual| actual == expected}
        end
      end

      RSpec.describe "group with MyHelpers" do
        include MyHelpers
        it "has access to the defined matcher" do
          expect(5).to be_just_like(5)
        end
      end

      RSpec.describe "group without MyHelpers" do
        it "does not have access to the defined matcher" do
          expect do
            expect(5).to be_just_like(5)
          end.to raise_exception
        end
      end
      """

    When I run `rspec ./scoped_matcher_spec.rb`
    Then the stdout should contain "2 examples, 0 failures"

  Scenario: Scoped in an example group
    Given a file named "scoped_matcher_spec.rb" with:
      """ruby
      require 'rspec/expectations'

      RSpec.describe "group with matcher" do
        matcher :be_just_like do |expected|
          match {|actual| actual == expected}
        end

        it "has access to the defined matcher" do
          expect(5).to be_just_like(5)
        end

        describe "nested group" do
          it "has access to the defined matcher" do
            expect(5).to be_just_like(5)
          end
        end
      end

      RSpec.describe "group without matcher" do
        it "does not have access to the defined matcher" do
          expect do
            expect(5).to be_just_like(5)
          end.to raise_exception
        end
      end
      """

    When I run `rspec scoped_matcher_spec.rb`
    Then the output should contain "3 examples, 0 failures"

  Scenario: Matcher with separate logic for expect().to and expect().not_to
    Given a file named "matcher_with_separate_should_not_logic_spec.rb" with:
      """ruby
      RSpec::Matchers.define :contain do |*expected|
        match do |actual|
          expected.all? { |e| actual.include?(e) }
        end

        match_when_negated do |actual|
          expected.none? { |e| actual.include?(e) }
        end
      end

      RSpec.describe [1, 2, 3] do
        it { is_expected.to contain(1, 2) }
        it { is_expected.not_to contain(4, 5, 6) }

        # deliberate failures
        it { is_expected.to contain(1, 4) }
        it { is_expected.not_to contain(1, 4) }
      end
      """
    When I run `rspec matcher_with_separate_should_not_logic_spec.rb`
    Then the output should contain all of these:
      | 4 examples, 2 failures                    |
      | expected [1, 2, 3] to contain 1 and 4     |
      | expected [1, 2, 3] not to contain 1 and 4 |

  Scenario: Use define_method to create a helper method with access to matcher params
    Given a file named "define_method_spec.rb" with:
      """ruby
      RSpec::Matchers.define :be_a_multiple_of do |expected|
        define_method :is_multiple? do |actual|
          actual % expected == 0
        end
        match { |actual| is_multiple?(actual) }
      end

      RSpec.describe 9 do
        it { is_expected.to be_a_multiple_of(3) }
        it { is_expected.not_to be_a_multiple_of(4) }

        # deliberate failures
        it { is_expected.to be_a_multiple_of(2) }
        it { is_expected.not_to be_a_multiple_of(3) }
      end
      """
    When I run `rspec define_method_spec.rb`
    Then the output should contain all of these:
      | 4 examples, 2 failures               |
      | expected 9 to be a multiple of 2     |
      | expected 9 not to be a multiple of 3 |

  Scenario: Include a module with helper methods in the matcher
    Given a file named "include_module_spec.rb" with:
      """ruby
      module MatcherHelpers
        def is_multiple?(actual, expected)
          actual % expected == 0
        end
      end

      RSpec::Matchers.define :be_a_multiple_of do |expected|
        include MatcherHelpers
        match { |actual| is_multiple?(actual, expected) }
      end

      RSpec.describe 9 do
        it { is_expected.to be_a_multiple_of(3) }
        it { is_expected.not_to be_a_multiple_of(4) }

        # deliberate failures
        it { is_expected.to be_a_multiple_of(2) }
        it { is_expected.not_to be_a_multiple_of(3) }
      end
      """
    When I run `rspec include_module_spec.rb`
    Then the output should contain all of these:
      | 4 examples, 2 failures               |
      | expected 9 to be a multiple of 2     |
      | expected 9 not to be a multiple of 3 |

  Scenario: Using values_match? to compare values and/or compound matchers.

    Given a file named "compare_values_spec.rb" with:
      """ruby
      RSpec::Matchers.define :have_content do |expected|
        match do |actual|
          # The order of arguments is important for `values_match?`, e.g.
          # especially if your matcher should handle `Regexp`-objects
          # (`/regex/`): First comes the `expected` value, second the `actual`
          # one.
          values_match? expected, actual
        end
      end

      RSpec.describe 'a' do
        it { is_expected.to have_content 'a' }
      end

      RSpec.describe 'a' do
        it { is_expected.to have_content /a/ }
      end

      RSpec.describe 'a' do
        it { is_expected.to have_content a_string_starting_with('a') }
      end
      """
    When I run `rspec ./compare_values_spec.rb --format documentation`
    Then the exit status should be 0

  Scenario: Error handling

    Make sure your matcher returns either `true` or `false`. Take care to handle exceptions appropriately in your matcher, e.g. most cases you might want your matcher to return `false` if an exception - e.g. ArgumentError - occures, but there might be edge cases where you want to pass the exception to the user.

    You should handle each `StandardError` with care! Do not handle them all in one.

    ```ruby
    match do |actual|
      begin
        '[...] Some code'
      rescue ArgumentError
        false
      end
    end
    ```

    Given a file named "error_handling_spec.rb" with:
      """ruby
      class CustomClass; end

      RSpec::Matchers.define :is_lower_than do |expected|
        match do |actual|
          begin
            actual < expected
          rescue ArgumentError
            false
          end
        end
      end

      RSpec.describe 1 do
        it { is_expected.to is_lower_than 2 }
      end

      RSpec.describe 1 do
        it { is_expected.not_to is_lower_than 'a' }
      end

      RSpec.describe CustomClass do
        it { expect { is_expected.not_to is_lower_than 2 }.to raise_error NoMethodError }
      end

      """
    When I run `rspec ./error_handling_spec.rb --format documentation`
    Then the exit status should be 0

  Scenario: Define aliases for your matcher

    If you want your matcher to be readable in different contexts, you can use the `.alias_matcher`-method to provide an alias for your matcher.

    Given a file named "alias_spec.rb" with:
      """ruby
      RSpec::Matchers.define :be_a_multiple_of do |expected|
        match do |actual|
          actual % expected == 0
        end
      end

      RSpec::Matchers.alias_matcher :be_n_of , :be_a_multiple_of

      RSpec.describe 9 do
        it { is_expected.to be_n_of(3) }
      end
      """
    When I run `rspec ./alias_spec.rb --format documentation`
    Then the exit status should be 0