MiniTest::Mock

All mock objects are an instance of Mock

Public Instance Methods

expect(name, retval, args=[], &blk) click to toggle source

Expect that method name is called, optionally with args or a blk, and returns retval.

@mock.expect(:meaning_of_life, 42)
@mock.meaning_of_life # => 42

@mock.expect(:do_something_with, true, [some_obj, true])
@mock.do_something_with(some_obj, true) # => true

@mock.expect(:do_something_else, true) do |a1, a2|
  a1 == "buggs" && a2 == :bunny
end

args is compared to the expected args using case equality (ie, the '===' operator), allowing for less specific expectations.

@mock.expect(:uses_any_string, true, [String])
@mock.uses_any_string("foo") # => true
@mock.verify  # => true

@mock.expect(:uses_one_string, true, ["foo"]
@mock.uses_one_string("bar") # => true
@mock.verify  # => raises MockExpectationError

 
               # File minitest/mock.rb, line 56
def expect(name, retval, args=[], &blk)
  if block_given?
    raise ArgumentError, "args ignored when block given" unless args.empty?
    @expected_calls[name] << { :retval => retval, :block => blk }
  else
    raise ArgumentError, "args must be an array" unless Array === args
    @expected_calls[name] << { :retval => retval, :args => args }
  end
  self
end

verify() click to toggle source

Verify that all methods were called as expected. Raises MockExpectationError if the mock object was not called as expected.

 
               # File minitest/mock.rb, line 81
def verify
  @expected_calls.each do |name, calls|
    calls.each do |expected|
      msg1 = "expected #{__call name, expected}"
      msg2 = "#{msg1}, got [#{__call name, @actual_calls[name]}]"

      raise MockExpectationError, msg2 if
        @actual_calls.has_key?(name) and
        not @actual_calls[name].include?(expected)

      raise MockExpectationError, msg1 unless
        @actual_calls.has_key?(name) and
        @actual_calls[name].include?(expected)
    end
  end
  true
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

Home Classes Methods

In Files

Parent

Methods

Class/Module Index

MiniTest::Mock

Public Instance Methods