+
+
FlexMock is a flexible mock object framework for creating and using test doubles (mocks, stubs and spies).
Basic Usage:
m = flexmock("name") m.should_receive(:upcase).with("stuff"). and_return("STUFF") m.should_receive(:downcase).with(String). and_return { |s| s.downcase }.once
With Test::Unit Integration:
class TestSomething < Test::Unit::TestCase def test_something m = flexmock("name") m.should_receive(:hi).and_return("Hello") m.hi end end
Note: Also, if you override teardown
, make sure you call
super
.
Deprecated Methods
The following methods are no longer supported in FlexMock. Include this file for legacy applications.
Permission is granted for use, copying, modification, distribution, and distribution of modified versions of this work as long as the above copyright notice is included.
+++
Permission is granted for use, copying, modification, distribution, and distribution of modified versions of this work as long as the above copyright notice is included.
+++
Permission is granted for use, copying, modification, distribution, and distribution of modified versions of this work as long as the above copyright notice is included.
+++
Permission is granted for use, copying, modification, distribution, and distribution of modified versions of this work as long as the above copyright notice is included.
+++
Class method to format a list of args (the part between the parenthesis).
# File lib/flexmock/core_class_methods.rb, line 59 def format_args(args) if args args.collect { |a| a.inspect }.join(', ') else "*args" end end
Create a FlexMock object with the given name. The name is used in error messages. If no container is given, create a new, one-off container for this mock.
# File lib/flexmock/core.rb, line 58 def initialize(name="unknown", container=nil) @flexmock_name = name @expectations = Hash.new @ignore_missing = false @verified = false @calls = [] @base_class = nil container = UseContainer.new if container.nil? container.flexmock_remember(self) end
Undefined is normally available as ::undefined
# File lib/flexmock/undefined.rb, line 47 def self.undefined @undefined end
Class method to make sure that verify is called at the end of a test. One mock object will be created for each name given to the use method. The mocks will be passed to the block as arguments. If no names are given, then a single anonymous mock object will be created.
At the end of the use block, each mock object will be verified to make sure the proper number of calls have been made.
Usage:
FlexMock.use("name") do |mock| # Creates a mock named "name" mock.should_receive(:meth). returns(0).once end # mock is verified here
NOTE: If you include FlexMock::TestCase into your test case
file, you can create mocks that will be automatically verified in the test
teardown by using the flexmock
method.
# File lib/flexmock/core_class_methods.rb, line 39 def use(*names) names = ["unknown"] if names.empty? container = UseContainer.new mocks = names.collect { |n| container.flexmock(n) } yield(*mocks) rescue Exception => _ container.got_exception = true raise ensure container.flexmock_teardown end
# File lib/flexmock/core.rb, line 97 def by_default @last_expectation.by_default self end
# File lib/flexmock/core.rb, line 139 def flexmock_based_on(base_class) @base_class = base_class should_receive(:class => base_class) end
Return the list of calls made on this mock. Used in formatting error messages.
# File lib/flexmock/core.rb, line 153 def flexmock_calls @calls end
Using location
, define the expectations specified by
args
.
# File lib/flexmock/core.rb, line 199 def flexmock_define_expectation(location, *args) @last_expectation = EXP_BUILDER.parse_should_args(self, args) do |method_name| @expectations[method_name] ||= ExpectationDirector.new(method_name) result = Expectation.new(self, method_name, location) @expectations[method_name] << result override_existing_method(method_name) if flexmock_respond_to?(method_name) result = ExplicitNeeded.new(result, method_name, @base_class) if @base_class && ! @base_class.flexmock_defined?(method_name) result end end
Invocke the original non-mocked functionality for the given symbol.
# File lib/flexmock/core.rb, line 159 def flexmock_invoke_original(method_name, args) return FlexMock.undefined end
True if the mock received the given method and arguments.
# File lib/flexmock/core.rb, line 147 def flexmock_received?(method_name, args, options={}) CALL_VALIDATOR.received?(@calls, method_name, args, options) end
Save the original definition of respond_to? for use a bit later.
Teardown and infrastructure setup for this mock.
# File lib/flexmock/core.rb, line 87 def flexmock_teardown end
Verify that each method that had an explicit expected count was actually called that many times.
# File lib/flexmock/core.rb, line 76 def flexmock_verify return if @verified @verified = true flexmock_wrap do @expectations.each do |sym, handler| handler.flexmock_verify end end end
Return the inspection string for a mock.
# File lib/flexmock/core.rb, line 70 def inspect "<FlexMock:#{flexmock_name}>" end
Override the built-in method
to include the mocked methods.
# File lib/flexmock/core.rb, line 164 def method(method_name) @expectations[method_name] || super rescue NameError => ex if @ignore_missing proc { FlexMock.undefined } else raise ex end end
Handle missing methods by attempting to look up a handler.
# File lib/flexmock/core.rb, line 103 def method_missing(sym, *args, &block) enhanced_args = block_given? ? args + [block] : args call_record = CallRecord.new(sym, enhanced_args, block_given?) @calls << call_record flexmock_wrap do if handler = @expectations[sym] handler.call(enhanced_args, call_record) elsif @base_class && @base_class.flexmock_defined?(sym) FlexMock.undefined elsif @ignore_missing FlexMock.undefined else super(sym, *args, &block) end end end
Override the built-in respond_to? to include the mocked methods.
# File lib/flexmock/core.rb, line 124 def respond_to?(sym, *args) super || (@expectations[sym] ? true : @ignore_missing) end
Declare that the mock object should expect methods by providing a recorder for the methods and having the user invoke the expected methods in a block. Further expectations may be applied the result of the recording call.
Example Usage:
mock.should_expect do |record| record.add(Integer, 4) { |a, b| a + b }.at_least.once
# File lib/flexmock/core.rb, line 223 def should_expect yield Recorder.new(self) end
Ignore all undefined (missing) method calls.
# File lib/flexmock/core.rb, line 91 def should_ignore_missing @ignore_missing = true self end
Declare that the mock object 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.
# File lib/flexmock/core.rb, line 193 def should_receive(*args) location = caller.first flexmock_define_expectation(location, *args) end
Wrap a block of code so the any assertion errors are wrapped so that the mock name is added to the error message .
# File lib/flexmock/core.rb, line 231 def flexmock_wrap(&block) yield rescue FlexMock.framework_adapter.assertion_failed_error => ex raise FlexMock.framework_adapter.assertion_failed_error, "in mock '#{@flexmock_name}': #{ex.message}", ex.backtrace end
Override the existing definition of method method_name
in the
mock. Most methods depend on the #method_missing trick to
be invoked. However, if the method already exists, it will not call
method_missing. This method defines a singleton method on the mock to
explicitly invoke the #method_missing logic.
# File lib/flexmock/core.rb, line 245 def override_existing_method(method_name) sclass.class_eval <<-EOS def #{method_name}(*args, &block) method_missing(:#{method_name}, *args, &block) end EOS end
Return the singleton class of the mock object.
# File lib/flexmock/core.rb, line 254 def sclass class << self; self; end end