class Minitest::Mock - minitest-5.7.0 Documentation

# class Minitest::Mock

A simple and clean mock object framework.

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 lib/minitest/mock.rb, line 70
    def expect(name, retval, args = [], &blk)
      name = name.to_sym

      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 lib/minitest/mock.rb, line 97
    def verify
      @expected_calls.each do |name, calls|
        calls.each do |expected|
          raise MockExpectationError, "expected #{__call name, expected}, got [#{__call name, @actual_calls[name]}]" if
            @actual_calls.key?(name) and
            not @actual_calls[name].include?(expected)

          raise MockExpectationError, "expected #{__call name, expected}" unless
            @actual_calls.key?(name) and
            @actual_calls[name].include?(expected)
        end
      end
      true
    end