class FlexMock

FlexMock is a flexible mock object framework for supporting testing.

FlexMock has a simple interface that's easy to remember, and leaves the hard stuff to all those other mock object implementations.

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
  include FlexMock::TestCase

  def test_something
    m = flexmock("name")
    m.should_receive(:hi).and_return("Hello")
    m.hi
  end
end

Note: When using Test::Unit integeration, don't forget to include FlexMock::TestCase. 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.

+++

Constants

ANY
CallRecord
ContainerHelper
OPTIONAL_PROC_MATCHER
SpecModule
VERSION

Attributes

framework_adapter[R]
partials_are_based[RW]
flexmock_container[RW]
flexmock_name[R]

Public Class Methods

format_args(args) click to toggle source

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
new(name="unknown", container=nil) click to toggle source

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 63
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() click to toggle source

Undefined is normally available as ::undefined

# File lib/flexmock/undefined.rb, line 47
def self.undefined
  @undefined
end
use(*names) { |*mocks| ... } click to toggle source

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

Public Instance Methods

by_default() click to toggle source
# File lib/flexmock/core.rb, line 102
def by_default
  @last_expectation.by_default
  self
end
flexmock_based_on(base_class) click to toggle source
# File lib/flexmock/core.rb, line 160
def flexmock_based_on(base_class)
  @base_class = base_class
  should_receive(:class => base_class)
end
flexmock_calls() click to toggle source

Return the list of calls made on this mock. Used in formatting error messages.

# File lib/flexmock/core.rb, line 188
def flexmock_calls
  @calls
end
flexmock_define_expectation(location, *args) click to toggle source
# File lib/flexmock/core.rb, line 233
def flexmock_define_expectation(location, *args)
  @last_expectation = ContainerHelper.parse_should_args(self, args) do |sym|
    @expectations[sym] ||= ExpectationDirector.new(sym)
    result = Expectation.new(self, sym, location)
    @expectations[sym] << result
    override_existing_method(sym) if flexmock_respond_to?(sym)
    result = ExplicitNeeded.new(result, sym, @base_class) if
      @base_class && ! @base_class.flexmock_defined?(sym)
    result
  end
end
flexmock_invoke_original(sym, args) click to toggle source

Invocke the original non-mocked functionality for the given symbol.

# File lib/flexmock/core.rb, line 194
def flexmock_invoke_original(sym, args)
  return FlexMock.undefined
end
flexmock_received?(sym, args, options={}) click to toggle source

True if the mock received the given method and arguments.

# File lib/flexmock/core.rb, line 166
def flexmock_received?(sym, args, options={})
  count = 0
  additional = options[:and] || []
  additional = [additional] if additional.is_a?(Proc)
  @calls.each { |call_record|
    if call_record.matches?(sym, args, options)
      count += 1
      if options[:on_count].nil? || count == options[:on_count]
        additional.each do |add| add.call(*call_record.args) end
      end
    end
  }
  if options[:times]
    result = count == options[:times]
  else
    result = count > 0
  end
  result
end
flexmock_respond_to?(sym, *args) click to toggle source

Save the original definition of respond_to? for use a bit later.

Alias for: respond_to?
flexmock_teardown() click to toggle source

Teardown and infrastructure setup for this mock.

# File lib/flexmock/core.rb, line 92
def flexmock_teardown
end
flexmock_verify() click to toggle source

Verify that each method that had an explicit expected count was actually called that many times.

# File lib/flexmock/core.rb, line 81
def flexmock_verify
  return if @verified
  @verified = true
  flexmock_wrap do
    @expectations.each do |sym, handler|
      handler.flexmock_verify
    end
  end
end
inspect() click to toggle source

Return the inspection string for a mock.

# File lib/flexmock/core.rb, line 75
def inspect
  "<FlexMock:#{flexmock_name}>"
end
method(sym) click to toggle source

Override the built-in method to include the mocked methods.

# File lib/flexmock/core.rb, line 199
def method(sym)
  @expectations[sym] || super
rescue NameError => ex
  if @ignore_missing
    proc { FlexMock.undefined }
  else
    raise ex
  end
end
method_missing(sym, *args, &block) click to toggle source

Handle missing methods by attempting to look up a handler.

# File lib/flexmock/core.rb, line 124
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
mock_ignore_missing() click to toggle source
respond_to?(sym, *args) click to toggle source

Override the built-in respond_to? to include the mocked methods.

# File lib/flexmock/core.rb, line 145
def respond_to?(sym, *args)
  super || (@expectations[sym] ? true : @ignore_missing)
end
Also aliased as: flexmock_respond_to?
should_expect() { |recorder| ... } click to toggle source

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 257
def should_expect
  yield Recorder.new(self)
end
should_ignore_missing() click to toggle source

Ignore all undefined (missing) method calls.

# File lib/flexmock/core.rb, line 96
def should_ignore_missing
  @ignore_missing = true
  self
end
Also aliased as: mock_ignore_missing
should_receive(:method_name) click to toggle source
should_receive(:method1, method2, ...)
should_receive(:meth1 => result1, :meth2 → result2, ...)

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 228
def should_receive(*args)
  location = caller.first
  flexmock_define_expectation(location, *args)
end