Class: FlexMock::PartialMockProxy

Inherits:
Object
  • Object
show all
Includes:
Ordering
Defined in:
lib/flexmock/partial_mock.rb,
lib/flexmock/deprecated_methods.rb

Overview

PartialMockProxy is used to mate the mock framework to an existing object. The object is “enhanced” with a reference to a mock object (stored in @flexmock_proxy). When the should_receive method is sent to the proxy, it overrides the existing object’s method by creating singleton method that forwards to the mock. When testing is complete, PartialMockProxy will erase the mocking infrastructure from the object being mocked (e.g. remove instance variables and mock singleton methods).

Defined Under Namespace

Classes: ProxyBox

Constant Summary collapse

MOCK_METHODS =

The following methods are added to partial mocks so that they can act like a mock.

[
  :should_receive, :new_instances,
  :should_receive_with_location,
  :flexmock_get,   :flexmock_teardown, :flexmock_verify,
  :flexmock_received?, :flexmock_calls, :flexmock_find_expectation,
  :invoke_original
]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Ordering

#flexmock_allocate_order, #flexmock_current_order, #flexmock_current_order=, #flexmock_groups, #flexmock_validate_order

Constructor Details

#initialize(obj, mock, safe_mode) ⇒ PartialMockProxy

Initialize a PartialMockProxy object.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/flexmock/partial_mock.rb', line 66

def initialize(obj, mock, safe_mode)
  @obj = obj
  @mock = mock
  @method_definitions = {}
  @methods_proxied = []
  @proxy_definition_module = nil
  @initialize_override = nil
  unless safe_mode
    add_mock_method(:should_receive)
    MOCK_METHODS.each do |sym|
      unless @obj.respond_to?(sym)
        add_mock_method(sym)
      end
    end
  end
end

Instance Attribute Details

#mock ⇒ Object (readonly)

Returns the value of attribute mock.



29
30
31
 
# File 'lib/flexmock/partial_mock.rb', line 29

def mock
  @mock
end

Class Method Details

.make_proxy_for(obj, container, name, safe_mode) ⇒ Object

Make a partial mock proxy and install it on the target obj.



34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/flexmock/partial_mock.rb', line 34

def self.make_proxy_for(obj, container, name, safe_mode)
  name ||= "flexmock(#{obj.class.to_s})"
  if ! proxy_defined_on?(obj)
    mock = FlexMock.new(name, container)
    proxy = PartialMockProxy.new(obj, mock, safe_mode)
    if obj.instance_variable_defined?("@flexmock_proxy")
      obj.instance_variable_get("@flexmock_proxy").proxy = proxy
    else
      obj.instance_variable_set("@flexmock_proxy", ProxyBox.new(proxy))
    end
  end
  obj.instance_variable_get("@flexmock_proxy").proxy
end

.proxy_defined_on?(obj) ⇒ Boolean

Is there a mock proxy defined on the domain object?

Returns:

  • (Boolean) 


49
50
51
52
 
# File 'lib/flexmock/partial_mock.rb', line 49

def self.proxy_defined_on?(obj)
  obj.instance_variable_defined?("@flexmock_proxy") &&
    obj.instance_variable_get("@flexmock_proxy").proxy
end

Instance Method Details

#add_mock_method(method_name) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/flexmock/partial_mock.rb', line 142

def add_mock_method(method_name)
  stow_existing_definition(method_name)
  proxy_module_eval do
    define_method(method_name) { |*args, &block|
      proxy = __flexmock_proxy or
        fail "Missing FlexMock proxy " +
             "(for method_name=#{method_name.inspect}, self=\#{self})"
      proxy.send(method_name, *args, &block)
    }
  end
end

#any_instance(&block) ⇒ Object

Deprecated.

any_instance is present for backwards compatibility with version 0.5.0.



54
55
56
57
 
# File 'lib/flexmock/deprecated_methods.rb', line 54

def any_instance(&block)
  $stderr.puts "any_instance is deprecated, use new_instances instead."
  new_instances(&block)
end

#flexmock_based_on(*args) ⇒ Object

Forward the based on request.



313
314
315
 
# File 'lib/flexmock/partial_mock.rb', line 313

def flexmock_based_on(*args)
  @mock.flexmock_based_on(*args)
end

#flexmock_calls ⇒ Object

Forward to the mock



298
299
300
 
# File 'lib/flexmock/partial_mock.rb', line 298

def flexmock_calls
  @mock.flexmock_calls
end

#flexmock_container ⇒ Object

Forward to the mock’s container.



288
289
290
 
# File 'lib/flexmock/partial_mock.rb', line 288

def flexmock_container
  @mock.flexmock_container
end

#flexmock_container=(container) ⇒ Object

Set the proxy’s mock container. This set value is ignored because the proxy always uses the container of its mock.



304
305
 
# File 'lib/flexmock/partial_mock.rb', line 304

def flexmock_container=(container)
end

#flexmock_define_expectation(location, *args) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/flexmock/partial_mock.rb', line 122

def flexmock_define_expectation(location, *args)
  EXP_BUILDER.parse_should_args(self, args) do |method_name|
    if !@methods_proxied.include?(method_name)
      hide_existing_method(method_name)
    end
    ex = @mock.flexmock_define_expectation(location, method_name)
    if FlexMock.partials_verify_signatures
      if existing_method = @method_definitions[method_name]
        ex.with_signature_matching(existing_method)
      end
    end
    ex.mock = self
    ex
  end
end

#flexmock_expectations_for(method_name) ⇒ Object

Forward the request for the expectation director to the mock.



308
309
310
 
# File 'lib/flexmock/partial_mock.rb', line 308

def flexmock_expectations_for(method_name)
  @mock.flexmock_expectations_for(method_name)
end

#flexmock_find_expectation(*args) ⇒ Object 



138
139
140
 
# File 'lib/flexmock/partial_mock.rb', line 138

def flexmock_find_expectation(*args)
  @mock.flexmock_find_expectation(*args)
end

#flexmock_get ⇒ Object

Get the mock object for the partial mock.



84
85
86
 
# File 'lib/flexmock/partial_mock.rb', line 84

def flexmock_get
  @mock
end

#flexmock_invoke_original(method, args) ⇒ Object

Invoke the original definition of method on the object supported by the stub.



251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/flexmock/partial_mock.rb', line 251

def flexmock_invoke_original(method, args)
  if original_method = @method_definitions[method]
    if Proc === args.last
      block = args.last
      args = args[0..-2]
    end
    original_method.bind(@obj).call(*args, &block)
  else
    @obj.__send__(:method_missing, method, *args, &block)
  end
end

#flexmock_received?(*args) ⇒ Boolean

Forward to the mock

Returns:

  • (Boolean) 


293
294
295
 
# File 'lib/flexmock/partial_mock.rb', line 293

def flexmock_received?(*args)
  @mock.flexmock_received?(*args)
end

#flexmock_teardown ⇒ Object

Remove all traces of the mocking framework from the existing object.



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/flexmock/partial_mock.rb', line 270

def flexmock_teardown
  if ! detached?
    initialize_stub_remove
    proxy_module_eval do
      methods = instance_methods(false).to_a
      methods.each do |m|
        remove_method m
      end
    end
    if @obj.instance_variable_defined?(:@flexmock_proxy) &&
        (box = @obj.instance_variable_get(:@flexmock_proxy))
      box.proxy = nil
    end
    @obj = nil
  end
end

#flexmock_verify ⇒ Object

Verify that the mock has been properly called. After verification, detach the mocking infrastructure from the existing object.



265
266
267
 
# File 'lib/flexmock/partial_mock.rb', line 265

def flexmock_verify
  @mock.flexmock_verify
end

#initialize_stub(recorder, expectations_block) ⇒ Object

Stubs the #initialize method on a class



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/flexmock/partial_mock.rb', line 194

def initialize_stub(recorder, expectations_block)
  if !@initialize_override
    expectation_blocks    = @initialize_expectation_blocks = Array.new
    expectation_recorders = @initialize_expectation_recorders = Array.new
    @initialize_override = Module.new do
      define_method :initialize do |*args, &block|
        if self.class.respond_to?(:__flexmock_proxy) && (mock = self.class.__flexmock_proxy)
          container = mock.flexmock_container
          mock = container.flexmock(self)
          expectation_blocks.each do |b|
            b.call(mock)
          end
          expectation_recorders.each do |r|
            r.apply(mock)
          end
        end
        super(*args, &block)
      end
    end
    override = @initialize_override
    @obj.class_eval { prepend override }
  end
  if expectations_block
    @initialize_expectation_blocks    << expectations_block
  end
  @initialize_expectation_recorders << recorder
end

#initialize_stub? ⇒ Boolean

Returns:

  • (Boolean) 


222
223
224
 
# File 'lib/flexmock/partial_mock.rb', line 222

def initialize_stub?
  !!@initialize_override
end

#initialize_stub_remove ⇒ Object 



226
227
228
229
230
231
 
# File 'lib/flexmock/partial_mock.rb', line 226

def initialize_stub_remove
  if initialize_stub?
    @initialize_expectation_blocks.clear
    @initialize_expectation_recorders.clear
  end
end

#invoke_original(m, *args, &block) ⇒ Object

Invoke the original of a mocked method

Usually called in a #and_return statement



115
116
117
118
119
120
 
# File 'lib/flexmock/partial_mock.rb', line 115

def invoke_original(m, *args, &block)
  if block
    args << block
  end
  flexmock_invoke_original(m, args)
end

#new_instances(*allocators, &block) ⇒ Object

:call-seq:

new_instances.should_receive(...)
new_instances { |instance|  instance.should_receive(...) }

new_instances is a short cut method for overriding the behavior of any new instances created via a mocked class object.

By default, new_instances will mock the behaviour of the :new method. If you wish to mock a different set of class methods, just pass a list of symbols to as arguments. (previous versions also mocked :allocate by default. If you need :allocate to be mocked, just request it explicitly).

For example, to stub only objects created by :make (and not :new), use:

flexmock(ClassName).new_instances(:make).should_receive(...)



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/flexmock/partial_mock.rb', line 172

def new_instances(*allocators, &block)
  fail ArgumentError, "new_instances requires a Class to stub" unless
    Class === @obj
  location = caller
  allocators = [:initialize] if allocators.empty?

  expectation_recorder = ExpectationRecorder.new

  if allocators.delete(:initialize)
    initialize_stub(expectation_recorder, block)
  end

  allocators.each do |allocate_method|
    flexmock_define_expectation(location, allocate_method).and_return { |*args|
      create_new_mocked_object(
        allocate_method, args, expectation_recorder, block)
    }
  end
  expectation_recorder
end

#should_receive(*args) ⇒ Object

:call-seq:

should_receive(:method_name)
should_receive(:method1, method2, ...)
should_receive(:meth1 => result1, :meth2 => result2, ...)

Declare that the partial mock should receive a message with the given name.

If more than one method name is given, then the mock object should expect to receive all the listed melthods. If a hash of method name/value pairs is given, then the each method will return the associated result. Any expectations applied to the result of should_receive will be applied to all the methods defined in the argument list.

An expectation object for the method name is returned as the result of this method. Further expectation constraints can be added by chaining to the result.

See Expectation for a list of declarators that can be used.



108
109
110
 
# File 'lib/flexmock/partial_mock.rb', line 108

def should_receive(*args)
  flexmock_define_expectation(caller, *args)
end