Class: MiniTest::Mock

Inherits:
Object show all
Defined in:
lib/minitest/mock.rb

Overview

All mock objects are an instance of Mock

Instance Method Summary collapse

Constructor Details

#initializeMock

:nodoc:


27
28
29
30
# File 'lib/minitest/mock.rb', line 27

def initialize # :nodoc:
  @expected_calls = Hash.new { |calls, name| calls[name] = [] }
  @actual_calls   = Hash.new { |calls, name| calls[name] = [] }
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args) ⇒ Object

:nodoc:


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/minitest/mock.rb', line 100

def method_missing(sym, *args) # :nodoc:
  unless @expected_calls.has_key?(sym) then
    raise NoMethodError, "unmocked method %p, expected one of %p" %
      [sym, @expected_calls.keys.sort_by(&:to_s)]
  end

  index = @actual_calls[sym].length
  expected_call = @expected_calls[sym][index]

  unless expected_call then
    raise MockExpectationError, "No more expects available for %p: %p" %
      [sym, args]
  end

  expected_args, retval, val_block =
    expected_call.values_at(:args, :retval, :block)

  if val_block then
    raise MockExpectationError, "mocked method %p failed block w/ %p" %
      [sym, args] unless val_block.call(args)

    # keep "verify" happy
    @actual_calls[sym] << expected_call
    return retval
  end

  if expected_args.size != args.size then
    raise ArgumentError, "mocked method %p expects %d arguments, got %d" %
      [sym, expected_args.size, args.size]
  end

  fully_matched = expected_args.zip(args).all? { |mod, a|
    mod === a or mod == a
  }

  unless fully_matched then
    raise MockExpectationError, "mocked method %p called with unexpected arguments %p" %
      [sym, args]
  end

  @actual_calls[sym] << {
    :retval => retval,
    :args => expected_args.zip(args).map { |mod, a| mod === a ? mod : a }
  }

  retval
end

Instance Method Details

#__call(name, data) ⇒ Object

:nodoc:


68
69
70
71
72
73
74
75
# File 'lib/minitest/mock.rb', line 68

def __call name, data # :nodoc:
  case data
  when Hash then
    "#{name}(#{data[:args].inspect[1..-2]}) => #{data[:retval].inspect}"
  else
    data.map { |d| __call name, d }.join ", "
  end
end

#__respond_to?Object


19
# File 'lib/minitest/mock.rb', line 19

alias :__respond_to? :respond_to?

#expect(name, retval, args = [], &blk) ⇒ Object

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

57
58
59
60
61
62
63
64
65
66
# File 'lib/minitest/mock.rb', line 57

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

#respond_to?(sym, include_private = false) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)

148
149
150
151
# File 'lib/minitest/mock.rb', line 148

def respond_to?(sym, include_private = false) # :nodoc:
  return true if @expected_calls.has_key?(sym.to_sym)
  return __respond_to?(sym, include_private)
end

#verifyObject

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


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/minitest/mock.rb', line 82

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