Logo: Relish

  1. Sign up
  2. Sign in

Project: RSpec Expectations 3.5

`all` matcher

Use the all matcher to specify that a collection's objects all pass an expected matcher. This works on any enumerable object.

  expect([1, 3, 5]).to all( be_odd )
  expect([1, 3, 5]).to all( be_an(Integer) )
  expect([1, 3, 5]).to all( be < 10 )
  expect([1, 3, 4]).to all( be_odd ) # fails

The matcher also supports compound matchers:

  expect([1, 3, 5]).to all( be_odd.and be < 10 )
  expect([1, 4, 21]).to all( be_odd.or be < 10 )

If you are looking for "any" member of a collection that passes an expectation, look at the include-matcher.

Scenarios
array usage
Given
a file named "array_all_matcher_spec.rb" with:
RSpec.describe [1, 3, 5] do
  it { is_expected.to all( be_odd ) }
  it { is_expected.to all( be_an(Integer) ) }
  it { is_expected.to all( be < 10 ) }

  # deliberate failures
  it { is_expected.to all( be_even ) }
  it { is_expected.to all( be_a(String) ) }
  it { is_expected.to all( be > 2 ) }
end
When
I run rspec array_all_matcher_spec.rb
Then
the output should contain all of these:
6 examples, 3 failures
expected [1, 3, 5] to all be even
expected [1, 3, 5] to all be a kind of String
expected [1, 3, 5] to all be > 2
compound matcher usage
Given
a file named "compound_all_matcher_spec.rb" with:
RSpec.describe ['anything', 'everything', 'something'] do
  it { is_expected.to all( be_a(String).and include("thing") ) }
  it { is_expected.to all( be_a(String).and end_with("g") ) }
  it { is_expected.to all( start_with("s").or include("y") ) }

  # deliberate failures
  it { is_expected.to all( include("foo").and include("bar") ) }
  it { is_expected.to all( be_a(String).and start_with("a") ) }
  it { is_expected.to all( start_with("a").or include("z") ) }
end
When
I run rspec compound_all_matcher_spec.rb
Then
the output should contain all of these:
6 examples, 3 failures
expected ["anything", "everything", "something"] to all include "foo" and include "bar"
expected ["anything", "everything", "something"] to all be a kind of String and start with "a"
expected ["anything", "everything", "something"] to all start with "a" or include "z"

Last published over 1 year ago by myronmarston.