Module: RSpec::Mocks::ArgumentMatchers

### Home Classes Methods

### In Files

- lib/rspec/mocks/argument_matchers.rb

### Namespace

- CLASS RSpec::Mocks::ArgumentMatchers::AnyArgMatcher
- CLASS RSpec::Mocks::ArgumentMatchers::AnyArgsMatcher
- CLASS RSpec::Mocks::ArgumentMatchers::BooleanMatcher
- CLASS RSpec::Mocks::ArgumentMatchers::DuckTypeMatcher
- CLASS RSpec::Mocks::ArgumentMatchers::EqualityProxy
- CLASS RSpec::Mocks::ArgumentMatchers::HashExcludingMatcher
- CLASS RSpec::Mocks::ArgumentMatchers::HashIncludingMatcher
- CLASS RSpec::Mocks::ArgumentMatchers::InstanceOf
- CLASS RSpec::Mocks::ArgumentMatchers::KindOf
- CLASS RSpec::Mocks::ArgumentMatchers::MatcherMatcher
- CLASS RSpec::Mocks::ArgumentMatchers::NoArgsMatcher
- CLASS RSpec::Mocks::ArgumentMatchers::RegexpMatcher

### Methods

- #a_kind_of
- #an_instance_of
- #any_args
- #anything
- #boolean
- #duck_type
- #hash_excluding
- #hash_including
- #hash_not_including
- #instance_of
- #kind_of
- #no_args

### Class/Module Index

Quicksearch

- RSpec
- RSpec::Mocks
- RSpec::Mocks::AllowanceTarget
- RSpec::Mocks::AmbiguousReturnError
- RSpec::Mocks::AndCallOriginalImplementation
- RSpec::Mocks::AndReturnImplementation
- RSpec::Mocks::AndYieldImplementation
- RSpec::Mocks::AnyInstance
- RSpec::Mocks::AnyInstance::Chain
- RSpec::Mocks::AnyInstance::Chain::Customizations
- RSpec::Mocks::AnyInstance::ExpectationChain
- RSpec::Mocks::AnyInstance::MessageChains
- RSpec::Mocks::AnyInstance::PositiveExpectationChain
- RSpec::Mocks::AnyInstance::Recorder
- RSpec::Mocks::AnyInstance::StubChain
- RSpec::Mocks::AnyInstance::StubChainChain
- RSpec::Mocks::AnyInstanceAllowanceTarget
- RSpec::Mocks::AnyInstanceExpectationTarget
- RSpec::Mocks::ArgumentListMatcher
- RSpec::Mocks::ArgumentMatchers
- RSpec::Mocks::ArgumentMatchers::AnyArgMatcher
- RSpec::Mocks::ArgumentMatchers::AnyArgsMatcher
- RSpec::Mocks::ArgumentMatchers::BooleanMatcher
- RSpec::Mocks::ArgumentMatchers::DuckTypeMatcher
- RSpec::Mocks::ArgumentMatchers::EqualityProxy
- RSpec::Mocks::ArgumentMatchers::HashExcludingMatcher
- RSpec::Mocks::ArgumentMatchers::HashIncludingMatcher
- RSpec::Mocks::ArgumentMatchers::InstanceOf
- RSpec::Mocks::ArgumentMatchers::KindOf
- RSpec::Mocks::ArgumentMatchers::MatcherMatcher
- RSpec::Mocks::ArgumentMatchers::NoArgsMatcher
- RSpec::Mocks::ArgumentMatchers::RegexpMatcher
- RSpec::Mocks::Configuration
- RSpec::Mocks::Constant
- RSpec::Mocks::ConstantMutator
- RSpec::Mocks::ConstantMutator::BaseMutator
- RSpec::Mocks::ConstantMutator::ConstantHider
- RSpec::Mocks::ConstantMutator::DefinedConstantReplacer
- RSpec::Mocks::ConstantMutator::UndefinedConstantSetter
- RSpec::Mocks::ConstantStubber
- RSpec::Mocks::Deprecation
- RSpec::Mocks::ErrorGenerator
- RSpec::Mocks::ExampleMethods
- RSpec::Mocks::ExampleMethods::ExpectHost
- RSpec::Mocks::ExpectationTarget
- RSpec::Mocks::Implementation
- RSpec::Mocks::InstanceExec
- RSpec::Mocks::InstanceMethodStasher
- RSpec::Mocks::Matchers
- RSpec::Mocks::Matchers::HaveReceived
- RSpec::Mocks::Matchers::Receive
- RSpec::Mocks::Matchers::Receive::Customization
- RSpec::Mocks::MessageExpectation
- RSpec::Mocks::MethodDouble
- RSpec::Mocks::MethodDouble::ProcWithBlock
- RSpec::Mocks::Mock
- RSpec::Mocks::MockExpectationError
- RSpec::Mocks::OrderGroup
- RSpec::Mocks::Proxy
- RSpec::Mocks::ProxyForNil
- RSpec::Mocks::RecursiveConstMethods
- RSpec::Mocks::Space
- RSpec::Mocks::StubChain
- RSpec::Mocks::Syntax
- RSpec::Mocks::TargetBase
- RSpec::Mocks::TestDouble
- RSpec::Mocks::Version
- Marshal

No matching classes.

# RSpec::Mocks::ArgumentMatchers

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 ArgumentListMatcher

### Public Instance Methods

a_kind_of(klass) click to toggle source
Alias for: kind_of
an_instance_of(klass) click to toggle source
Alias for: instance_of
any_args() click to toggle source

Matches any args at all. Supports a more explicit variation of `object.should_receive(:message)`

@example

    object.should_receive(:message).with(any_args)

    # File lib/rspec/mocks/argument_matchers.rb, line 142
    def any_args
      AnyArgsMatcher.new
    end

anything() click to toggle source

Matches any argument at all.

@example

    object.should_receive(:message).with(anything)

    # File lib/rspec/mocks/argument_matchers.rb, line 151
    def anything
      AnyArgMatcher.new(nil)
    end

boolean() click to toggle source

Matches a boolean value.

@example

    object.should_receive(:message).with(boolean())

    # File lib/rspec/mocks/argument_matchers.rb, line 179
    def boolean
      BooleanMatcher.new(nil)
    end

duck_type(*args) click to toggle source

Matches if the actual argument responds to the specified messages.

@example

    object.should_receive(:message).with(duck_type(:hello))
    object.should_receive(:message).with(duck_type(:hello, :goodbye))

    # File lib/rspec/mocks/argument_matchers.rb, line 170
    def duck_type(*args)
      DuckTypeMatcher.new(*args)
    end

hash_excluding(*args) click to toggle source

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

@example

    object.should_receive(:message).with(hash_excluding(:key => val))
    object.should_receive(:message).with(hash_excluding(:key))
    object.should_receive(:message).with(hash_excluding(:key, :key2 => :val2))

    # File lib/rspec/mocks/argument_matchers.rb, line 202
    def hash_excluding(*args)
      HashExcludingMatcher.new(anythingize_lonely_keys(*args))
    end

Also aliased as: hash_not_including
hash_including(*args) click to toggle source

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

@example

    object.should_receive(:message).with(hash_including(:key => val))
    object.should_receive(:message).with(hash_including(:key))
    object.should_receive(:message).with(hash_including(:key, :key2 => val2))

    # File lib/rspec/mocks/argument_matchers.rb, line 191
    def hash_including(*args)
      HashIncludingMatcher.new(anythingize_lonely_keys(*args))
    end

hash_not_including(*args) click to toggle source
Alias for: hash_excluding
instance_of(klass) click to toggle source

Matches if `arg.instance_of?(klass)`

@example

    object.should_receive(:message).with(instance_of(Thing))

    # File lib/rspec/mocks/argument_matchers.rb, line 213
    def instance_of(klass)
      InstanceOf.new(klass)
    end

Also aliased as: an_instance_of
kind_of(klass) click to toggle source

Matches if `arg.kind_of?(klass)` @example

    object.should_receive(:message).with(kind_of(Thing))

    # File lib/rspec/mocks/argument_matchers.rb, line 223
    def kind_of(klass)
      KindOf.new(klass)
    end

Also aliased as: a_kind_of
no_args() click to toggle source

Matches no arguments.

@example

    object.should_receive(:message).with(no_args)

    # File lib/rspec/mocks/argument_matchers.rb, line 160
    def no_args
      NoArgsMatcher.new
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.