Class/Module Index [+]

Quicksearch

Mocha::ParameterMatchers

Used as parameters for {Expectation#with} to restrict the parameter values which will match the expectation. Can be nested.

Public Instance Methods

Not(matcher) click to toggle source

Matches if matcher does not match.

@param [Base] matcher matcher whose logic to invert. @return [Not] parameter matcher.

@see Expectation#with

@example Actual parameter does not include the value 1.

object = mock()
object.expects(:method_1).with(Not(includes(1)))
object.method_1([0, 2, 3])
# no error raised

@example Actual parameter does include the value 1.

object = mock()
object.expects(:method_1).with(Not(includes(1)))
object.method_1([0, 1, 2, 3])
# error raised, because method_1 was not called with object not including 1
# File lib/mocha/parameter_matchers/not.rb, line 25
def Not(matcher)
  Not.new(matcher)
end
all_of(*matchers) click to toggle source

Matches if all matchers match.

@param [*Array<Base>] parameter_matchers parameter matchers. @return [AllOf] parameter matcher.

@see Expectation#with

@example All parameter matchers match.

object = mock()
object.expects(:method_1).with(all_of(includes(1), includes(3)))
object.method_1([1, 3])
# no error raised

@example One of the parameter matchers does not match.

object = mock()
object.expects(:method_1).with(all_of(includes(1), includes(3)))
object.method_1([1, 2])
# error raised, because method_1 was not called with object including 1 and 3
# File lib/mocha/parameter_matchers/all_of.rb, line 25
def all_of(*matchers)
  AllOf.new(*matchers)
end
any_of(*matchers) click to toggle source

Matches if any matchers match.

@param [*Array<Base>] parameter_matchers parameter matchers. @return [AnyOf] parameter matcher.

@see Expectation#with

@example One parameter matcher matches.

object = mock()
object.expects(:method_1).with(any_of(1, 3))
object.method_1(1)
# no error raised

@example The other parameter matcher matches.

object = mock()
object.expects(:method_1).with(any_of(1, 3))
object.method_1(3)
# no error raised

@example Neither parameter matcher matches.

object = mock()
object.expects(:method_1).with(any_of(1, 3))
object.method_1(2)
# error raised, because method_1 was not called with 1 or 3
# File lib/mocha/parameter_matchers/any_of.rb, line 31
def any_of(*matchers)
  AnyOf.new(*matchers)
end
any_parameters() click to toggle source

Matches any parameters. This is used as the default for a newly built expectation.

@return [AnyParameters] parameter matcher.

@see Expectation#with

@example Any parameters will match.

object = mock()
object.expects(:method_1).with(any_parameters)
object.method_1(1, 2, 3, 4)
# no error raised

object = mock()
object.expects(:method_1).with(any_parameters)
object.method_1(5, 6, 7, 8, 9, 0)
# no error raised
# File lib/mocha/parameter_matchers/any_parameters.rb, line 23
def any_parameters
  AnyParameters.new
end
anything() click to toggle source

Matches any object.

@return [Anything] parameter matcher.

@see Expectation#with

@example Any object will match.

object = mock()
object.expects(:method_1).with(anything)
object.method_1('foo')
object.method_1(789)
object.method_1(:bar)
# no error raised
# File lib/mocha/parameter_matchers/anything.rb, line 20
def anything
  Anything.new
end
equals(value) click to toggle source

Matches any Object equalling value.

@param [Object] value expected value. @return [Equals] parameter matcher.

@see Expectation#with @see Object#==

@example Actual parameter equals expected parameter.

object = mock()
object.expects(:method_1).with(equals(2))
object.method_1(2)
# no error raised

@example Actual parameter does not equal expected parameter.

object = mock()
object.expects(:method_1).with(equals(2))
object.method_1(3)
# error raised, because method_1 was not called with an +Object+ that equals 3
# File lib/mocha/parameter_matchers/equals.rb, line 26
def equals(value)
  Equals.new(value)
end
has_entries(entries) click to toggle source

Matches Hash containing all entries.

@param [Hash] entries expected Hash entries. @return [HasEntries] parameter matcher.

@see Expectation#with

@example Actual parameter contains all expected entries.

object = mock()
object.expects(:method_1).with(has_entries('key_1' => 1, 'key_2' => 2))
object.method_1('key_1' => 1, 'key_2' => 2, 'key_3' => 3)
# no error raised

@example Actual parameter does not contain all expected entries.

object = mock()
object.expects(:method_1).with(has_entries('key_1' => 1, 'key_2' => 2))
object.method_1('key_1' => 1, 'key_2' => 99)
# error raised, because method_1 was not called with Hash containing entries: 'key_1' => 1, 'key_2' => 2
# File lib/mocha/parameter_matchers/has_entries.rb, line 27
def has_entries(entries)
  HasEntries.new(entries)
end
has_entry(*options) click to toggle source

Matches Hash containing entry with key and value.

@overload def has_entry(key, value)

@param [Object] key key for entry.
@param [Object] value value for entry.

@overload def has_entry(single_entry_hash)

@param [Hash] single_entry_hash +Hash+ with single entry.
@raise [ArgumentError] if +single_entry_hash+ does not contain exactly one entry.

@return [HasEntry] parameter matcher.

@see Expectation#with

@example Actual parameter contains expected entry supplied as key and value.

object = mock()
object.expects(:method_1).with(has_entry('key_1', 1))
object.method_1('key_1' => 1, 'key_2' => 2)
# no error raised

@example Actual parameter contains expected entry supplied as Hash entry.

object = mock()
object.expects(:method_1).with(has_entry('key_1' => 1))
object.method_1('key_1' => 1, 'key_2' => 2)
# no error raised

@example Actual parameter does not contain expected entry supplied as key and value.

object = mock()
object.expects(:method_1).with(has_entry('key_1', 1))
object.method_1('key_1' => 2, 'key_2' => 1)
# error raised, because method_1 was not called with Hash containing entry: 'key_1' => 1

@example Actual parameter does not contain expected entry supplied as Hash entry.

object = mock()
object.expects(:method_1).with(has_entry('key_1' => 1))
object.method_1('key_1' => 2, 'key_2' => 1)
# error raised, because method_1 was not called with Hash containing entry: 'key_1' => 1
# File lib/mocha/parameter_matchers/has_entry.rb, line 44
def has_entry(*options)
  key, value = options.shift, options.shift
  if key.is_a?(Hash)
    case key.length
    when 0
      raise ArgumentError.new("Argument has no entries.")
    when 1
      key, value = key.to_a.flatten
    else
      raise ArgumentError.new("Argument has multiple entries. Use Mocha::ParameterMatchers#has_entries instead.")
    end
  end
  HasEntry.new(key, value)
end
has_equivalent_query_string(uri) click to toggle source

Matches a URI without regard to the ordering of parameters in the query string.

@param [String] uri URI to match. @return [QueryStringMatches] parameter matcher.

@see Expectation#with

@example Actual URI has equivalent query string.

object = mock()
object.expects(:method_1).with(has_equivalent_query_string('http://example.com/foo?a=1&b=2))
object.method_1('http://example.com/foo?b=2&a=1')
# no error raised

@example Actual URI does not have equivalent query string.

object = mock()
object.expects(:method_1).with(has_equivalent_query_string('http://example.com/foo?a=1&b=2))
object.method_1('http://example.com/foo?a=1&b=3')
# error raised, because the query parameters were different
# File lib/mocha/parameter_matchers/query_string.rb, line 25
def has_equivalent_query_string(uri)
  QueryStringMatches.new(uri)
end
has_key(key) click to toggle source

Matches Hash containing key.

@param [Object] key expected key. @return [HasKey] parameter matcher.

@see Expectation#with

@example Actual parameter contains entry with expected key.

object = mock()
object.expects(:method_1).with(has_key('key_1'))
object.method_1('key_1' => 1, 'key_2' => 2)
# no error raised

@example Actual parameter does not contain entry with expected key.

object = mock()
object.expects(:method_1).with(has_key('key_1'))
object.method_1('key_2' => 2)
# error raised, because method_1 was not called with Hash containing key: 'key_1'
# File lib/mocha/parameter_matchers/has_key.rb, line 25
def has_key(key)
  HasKey.new(key)
end
has_value(value) click to toggle source

Matches Hash containing value.

@param [Object] value expected value. @return [HasValue] parameter matcher.

@see Expectation#with

@example Actual parameter contains entry with expected value.

object = mock()
object.expects(:method_1).with(has_value(1))
object.method_1('key_1' => 1, 'key_2' => 2)
# no error raised

@example Actual parameter does not contain entry with expected value.

object = mock()
object.expects(:method_1).with(has_value(1))
object.method_1('key_2' => 2)
# error raised, because method_1 was not called with Hash containing value: 1
# File lib/mocha/parameter_matchers/has_value.rb, line 25
def has_value(value)
  HasValue.new(value)
end
includes(item) click to toggle source

Matches any object that responds with true to +include?(item)+.

@param [Object] item expected item. @return [Includes] parameter matcher.

@see Expectation#with

@example Actual parameter includes item.

object = mock()
object.expects(:method_1).with(includes('foo'))
object.method_1(['foo', 'bar'])
# no error raised

@example Actual parameter does not include item.

object.method_1(['baz'])
# error raised, because ['baz'] does not include 'foo'.
# File lib/mocha/parameter_matchers/includes.rb, line 23
def includes(item)
  Includes.new(item)
end
instance_of(klass) click to toggle source

Matches any object that is an instance of klass

@param [Class] klass expected class. @return [InstanceOf] parameter matcher.

@see Expectation#with @see Kernel#instance_of?

@example Actual parameter is an instance of String.

object = mock()
object.expects(:method_1).with(instance_of(String))
object.method_1('string')
# no error raised

@example Actual parameter is not an instance of String.

object = mock()
object.expects(:method_1).with(instance_of(String))
object.method_1(99)
# error raised, because method_1 was not called with an instance of String
# File lib/mocha/parameter_matchers/instance_of.rb, line 26
def instance_of(klass)
  InstanceOf.new(klass)
end
is_a(klass) click to toggle source

Matches any object that is a klass.

@param [Class] klass expected class. @return [IsA] parameter matcher.

@see Expectation#with @see Kernel#is_a?

@example Actual parameter is a Integer.

object = mock()
object.expects(:method_1).with(is_a(Integer))
object.method_1(99)
# no error raised

@example Actual parameter is not a Integer.

object = mock()
object.expects(:method_1).with(is_a(Integer))
object.method_1('string')
# error raised, because method_1 was not called with an Integer
# File lib/mocha/parameter_matchers/is_a.rb, line 26
def is_a(klass)
  IsA.new(klass)
end
kind_of(klass) click to toggle source

Matches any Object that is a kind of klass.

@param [Class] klass expected class. @return [KindOf] parameter matcher.

@see Expectation#with @see Kernel#kind_of?

@example Actual parameter is a kind of Integer.

object = mock()
object.expects(:method_1).with(kind_of(Integer))
object.method_1(99)
# no error raised

@example Actual parameter is not a kind of Integer.

object = mock()
object.expects(:method_1).with(kind_of(Integer))
object.method_1('string')
# error raised, because method_1 was not called with a kind of Integer
# File lib/mocha/parameter_matchers/kind_of.rb, line 26
def kind_of(klass)
  KindOf.new(klass)
end
optionally(*matchers) click to toggle source

Matches optional parameters if available.

@param [*Array<Base>] matchers matchers for optional parameters. @return [Optionally] parameter matcher.

@see Expectation#with

@example Only the two required parameters are supplied and they both match their expected value.

object = mock()
object.expects(:method_1).with(1, 2, optionally(3, 4))
object.method_1(1, 2)
# no error raised

@example Both required parameters and one of the optional parameters are supplied and they all match their expected value.

object = mock()
object.expects(:method_1).with(1, 2, optionally(3, 4))
object.method_1(1, 2, 3)
# no error raised

@example Both required parameters and both of the optional parameters are supplied and they all match their expected value.

object = mock()
object.expects(:method_1).with(1, 2, optionally(3, 4))
object.method_1(1, 2, 3, 4)
# no error raised

@example One of the actual optional parameters does not match the expected value.

object = mock()
object.expects(:method_1).with(1, 2, optionally(3, 4))
object.method_1(1, 2, 3, 5)
# error raised, because optional parameters did not match
# File lib/mocha/parameter_matchers/optionally.rb, line 35
def optionally(*matchers)
  Optionally.new(*matchers)
end
regexp_matches(regexp) click to toggle source

Matches any object that matches regexp.

@param [Regexp] regexp regular expression to match. @return [RegexpMatches] parameter matcher.

@see Expectation#with

@example Actual parameter is matched by specified regular expression.

object = mock()
object.expects(:method_1).with(regexp_matches(/e/))
object.method_1('hello')
# no error raised

@example Actual parameter is not matched by specified regular expression.

object = mock()
object.expects(:method_1).with(regexp_matches(/a/))
object.method_1('hello')
# error raised, because method_1 was not called with a parameter that matched the
# regular expression
# File lib/mocha/parameter_matchers/regexp_matches.rb, line 26
def regexp_matches(regexp)
  RegexpMatches.new(regexp)
end
responds_with(message, result) click to toggle source

Matches any object that responds to message with result. To put it another way, it tests the quack, not the duck.

@param [Symbol] message method to invoke. @param [Object] result expected result of sending message. @return [RespondsWith] parameter matcher.

@see Expectation#with

@example Actual parameter responds with "FOO" when :upcase is invoked.

object = mock()
object.expects(:method_1).with(responds_with(:upcase, "FOO"))
object.method_1("foo")
# no error raised, because "foo".upcase == "FOO"

@example Actual parameter does not respond with "FOO" when :upcase is invoked.

object = mock()
object.expects(:method_1).with(responds_with(:upcase, "BAR"))
object.method_1("foo")
# error raised, because "foo".upcase != "BAR"
# File lib/mocha/parameter_matchers/responds_with.rb, line 27
def responds_with(message, result)
  RespondsWith.new(message, result)
end
yaml_equivalent(object) click to toggle source

Matches any YAML that represents the specified object

@param [Object] object object whose YAML to compare. @return [YamlEquivalent] parameter matcher.

@see Expectation#with

@example Actual parameter is YAML equivalent of specified object.

object = mock()
object.expects(:method_1).with(yaml_equivalent(1, 2, 3))
object.method_1("--- \n- 1\n- 2\n- 3\n")
# no error raised

@example Actual parameter is not YAML equivalent of specified object.

object = mock()
object.expects(:method_1).with(yaml_equivalent(1, 2, 3))
object.method_1("--- \n- 1\n- 2\n")
# error raised, because method_1 was not called with YAML representing the specified Array
# File lib/mocha/parameter_matchers/yaml_equivalent.rb, line 26
def yaml_equivalent(object)
  YamlEquivalent.new(object)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.