Module: RSpec::Mocks::ArgumentMatchers

Included in:
ExampleMethods
Defined in:
lib/rspec/mocks/argument_matchers.rb

Overview

ArgumentMatchers are placeholders that you can include in message expectations to match arguments against a broader check than simple equality.

With the exception of any_args and no_args, they all match against the arg in same position in the argument list.

See Also:

Instance Method Summary (collapse)

Instance Method Details

- (Object) any_args

Acts like an arg splat, matching any number of args at any point in an arg list.

Examples:

expect(object).to receive(:message).with(1, 2, any_args)
# matches any of these:
object.message(1, 2)
object.message(1, 2, 3)
object.message(1, 2, 3, 4)
26
27
28
 
# File 'lib/rspec/mocks/argument_matchers.rb', line 26
def any_args
  AnyArgsMatcher::INSTANCE
end

- (Object) anything

Matches any argument at all.

Examples:

expect(object).to receive(:message).with(anything)
34
35
36
 
# File 'lib/rspec/mocks/argument_matchers.rb', line 34
def anything
  AnyArgMatcher::INSTANCE
end

- (Object) array_including(*args)

Matches an array that includes the specified items at least once. Ignores duplicates and additional values

Examples:

expect(object).to receive(:message).with(array_including(1,2,3))
expect(object).to receive(:message).with(array_including([1,2,3]))
80
81
82
83
 
# File 'lib/rspec/mocks/argument_matchers.rb', line 80
def array_including(*args)
  actually_an_array = Array === args.first && args.count == 1 ? args.first : args
  ArrayIncludingMatcher.new(actually_an_array)
end

- (Object) boolean

Matches a boolean value.

Examples:

expect(object).to receive(:message).with(boolean())
59
60
61
 
# File 'lib/rspec/mocks/argument_matchers.rb', line 59
def boolean
  BooleanMatcher::INSTANCE
end

- (Object) duck_type(*args)

Matches if the actual argument responds to the specified messages.

Examples:

expect(object).to receive(:message).with(duck_type(:hello))
expect(object).to receive(:message).with(duck_type(:hello, :goodbye))
51
52
53
 
# File 'lib/rspec/mocks/argument_matchers.rb', line 51
def duck_type(*args)
  DuckTypeMatcher.new(*args)
end

- (Object) hash_excluding(*args) Also known as: hash_not_including

Matches a hash that doesn't include the specified key(s) or key/value.

Examples:

expect(object).to receive(:message).with(hash_excluding(:key => val))
expect(object).to receive(:message).with(hash_excluding(:key))
expect(object).to receive(:message).with(hash_excluding(:key, :key2 => :val2))
91
92
93
 
# File 'lib/rspec/mocks/argument_matchers.rb', line 91
def hash_excluding(*args)
  HashExcludingMatcher.new(ArgumentMatchers.anythingize_lonely_keys(*args))
end

- (Object) hash_including(*args)

Matches a hash that includes the specified key(s) or key/value pairs. Ignores any additional keys.

Examples:

expect(object).to receive(:message).with(hash_including(:key => val))
expect(object).to receive(:message).with(hash_including(:key))
expect(object).to receive(:message).with(hash_including(:key, :key2 => val2))
70
71
72
 
# File 'lib/rspec/mocks/argument_matchers.rb', line 70
def hash_including(*args)
  HashIncludingMatcher.new(ArgumentMatchers.anythingize_lonely_keys(*args))
end

- (Object) instance_of(klass) Also known as: an_instance_of

Matches if arg.instance_of?(klass)

Examples:

expect(object).to receive(:message).with(instance_of(Thing))
101
102
103
 
# File 'lib/rspec/mocks/argument_matchers.rb', line 101
def instance_of(klass)
  InstanceOf.new(klass)
end

- (Object) kind_of(klass) Also known as: a_kind_of

Matches if arg.kind_of?(klass)

Examples:

expect(object).to receive(:message).with(kind_of(Thing))
111
112
113
 
# File 'lib/rspec/mocks/argument_matchers.rb', line 111
def kind_of(klass)
  KindOf.new(klass)
end

- (Object) no_args

Matches no arguments.

Examples:

expect(object).to receive(:message).with(no_args)
42
43
44
 
# File 'lib/rspec/mocks/argument_matchers.rb', line 42
def no_args
  NoArgsMatcher::INSTANCE
end