Parent

Class/Module Index [+]

Quicksearch

RSpec::Mocks::ArgumentListMatcher

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 ArgumentMatchers

Constants

MATCH_ALL

Value that will match all argument lists.

@private

Attributes

expected_args[R]

@private

Public Class Methods

new(*expected_args) click to toggle source

@api public @param [Array] expected_args a list of expected literals and/or argument matchers

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

@see ArgumentMatchers @see args_match?

# File lib/rspec/mocks/argument_list_matcher.rb, line 45
def initialize(*expected_args)
  @expected_args = expected_args

  @matchers = case expected_args.first
    when ArgumentMatchers::AnyArgsMatcher then Array
    when ArgumentMatchers::NoArgsMatcher  then []
    else expected_args
  end
end

Public Instance Methods

args_match?(*args) click to toggle source

@api public @param [Array] args

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

@see initialize

# File lib/rspec/mocks/argument_list_matcher.rb, line 62
def args_match?(*args)
  Support::FuzzyMatcher.values_match?(@matchers, args)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.