Class: RSpec::Mocks::ArgumentListMatcher

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec/mocks/argument_list_matcher.rb

Overview

Wrapper for matching arguments against a list of expected values. Used by the with method on a MessageExpectation:

expect(object).to receive(:message).with(:a, 'b', 3)
object.message(:a, 'b', 3)

Values passed to with can be literal values or argument matchers that match against the real objects .e.g.

expect(object).to receive(:message).with(hash_including(:a => 'b'))

Can also be used directly to match the contents of any Array. This enables 3rd party mocking libs to take advantage of rspec's argument matching without using the rest of rspec-mocks.

require 'rspec/mocks/argument_list_matcher'
include RSpec::Mocks::ArgumentMatchers
arg_list_matcher = RSpec::Mocks::ArgumentListMatcher.new(123, hash_including(:a => 'b'))
arg_list_matcher.args_match?(123, :a => 'b')

This class is immutable.

See Also:

Instance Method Summary collapse

Constructor Details

#initialize(*expected_args) ⇒ ArgumentListMatcher

Initializes an ArgumentListMatcher with a collection of literal values and/or argument matchers.

Parameters:

  • expected_args (Array) —

    a list of expected literals and/or argument matchers

See Also:

45
46
47
48
 
# File 'lib/rspec/mocks/argument_list_matcher.rb', line 45
def initialize(*expected_args)
  @expected_args = expected_args
  ensure_expected_args_valid!
end

Instance Method Details

#args_match?(*actual_args) ⇒ Boolean

Matches each element in the expected_args against the element in the same position of the arguments passed to new.

Parameters:

  • actual_args (Array)

Returns:

  • (Boolean)

See Also:

58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/rspec/mocks/argument_list_matcher.rb', line 58
def args_match?(*actual_args)
  expected_args = resolve_expected_args_based_on(actual_args)
  return false if expected_args.size != actual_args.size
  if RUBY_VERSION >= "3"
    # if both arguments end with Hashes, and if one is a keyword hash and the other is not, they don't match
    if Hash === expected_args.last && Hash === actual_args.last
      if !Hash.ruby2_keywords_hash?(actual_args.last) && Hash.ruby2_keywords_hash?(expected_args.last)
        return false
      end
    end
  end
  Support::FuzzyMatcher.values_match?(expected_args, actual_args)
end