mocha-macruby 0.9.8.20100129120100

data/examples/misc.rb

@@ -0,0 +1,43 @@
+require 'test/unit'
+require 'mocha'
+
+class MiscExampleTest < Test::Unit::TestCase
+  
+  def test_mocking_a_class_method
+    product = Product.new
+    Product.expects(:find).with(1).returns(product)
+    assert_equal product, Product.find(1)
+  end
+
+  def test_mocking_an_instance_method_on_a_real_object
+    product = Product.new
+    product.expects(:save).returns(true)
+    assert product.save
+  end
+
+  def test_stubbing_instance_methods_on_real_objects
+    prices = [stub(:pence => 1000), stub(:pence => 2000)]
+    product = Product.new
+    product.stubs(:prices).returns(prices)
+    assert_equal [1000, 2000], product.prices.collect {|p| p.pence}
+  end
+
+  def test_stubbing_an_instance_method_on_all_instances_of_a_class
+    Product.any_instance.stubs(:name).returns('stubbed_name')
+    product = Product.new
+    assert_equal 'stubbed_name', product.name
+  end
+
+  def test_traditional_mocking
+    object = mock()
+    object.expects(:expected_method).with(:p1, :p2).returns(:result)
+    assert_equal :result, object.expected_method(:p1, :p2)
+  end
+
+  def test_shortcuts
+    object = stub(:method1 => :result1, :method2 => :result2)
+    assert_equal :result1, object.method1
+    assert_equal :result2, object.method2
+  end
+  
+end

data/examples/mocha.rb

@@ -0,0 +1,25 @@
+class Enterprise
+
+  def initialize(dilithium)
+    @dilithium = dilithium
+  end
+
+  def go(warp_factor)
+    warp_factor.times { @dilithium.nuke(:anti_matter) }
+  end
+
+end
+
+require 'test/unit'
+require 'mocha'
+
+class EnterpriseTest < Test::Unit::TestCase
+
+  def test_should_boldly_go
+    dilithium = mock()
+    dilithium.expects(:nuke).with(:anti_matter).at_least_once  # auto-verified at end of test
+    enterprise = Enterprise.new(dilithium)
+    enterprise.go(2)
+  end
+
+end

data/examples/stubba.rb

@@ -0,0 +1,64 @@
+class Order
+
+  attr_accessor :shipped_on
+
+  def total_cost
+    line_items.inject(0) { |total, line_item| total + line_item.price } + shipping_cost
+  end
+
+  def total_weight
+    line_items.inject(0) { |total, line_item| total + line_item.weight }
+  end
+
+  def shipping_cost
+    total_weight * 5 + 10
+  end
+
+  class << self
+
+    def find_all
+      # Database.connection.execute('select * from orders...
+    end
+  
+    def number_shipped_since(date)
+      find_all.select { |order| order.shipped_on > date }.length
+    end
+
+    def unshipped_value
+      find_all.inject(0) { |total, order| order.shipped_on ? total : total + order.total_cost }
+    end
+
+  end
+
+end
+
+require 'test/unit'
+require 'mocha'
+
+class OrderTest < Test::Unit::TestCase
+
+  # illustrates stubbing instance method
+  def test_should_calculate_shipping_cost_based_on_total_weight
+    order = Order.new
+    order.stubs(:total_weight).returns(10)
+    assert_equal 60, order.shipping_cost
+  end
+
+  # illustrates stubbing class method
+  def test_should_count_number_of_orders_shipped_after_specified_date
+    now = Time.now; week_in_secs = 7 * 24 * 60 * 60
+    order_1 = Order.new; order_1.shipped_on = now - 1 * week_in_secs
+    order_2 = Order.new; order_2.shipped_on = now - 3 * week_in_secs
+    Order.stubs(:find_all).returns([order_1, order_2])
+    assert_equal 1, Order.number_shipped_since(now - 2 * week_in_secs)
+  end
+
+  # illustrates stubbing instance method for all instances of a class
+  def test_should_calculate_value_of_unshipped_orders
+    Order.stubs(:find_all).returns([Order.new, Order.new, Order.new])
+    Order.any_instance.stubs(:shipped_on).returns(nil)
+    Order.any_instance.stubs(:total_cost).returns(10)
+    assert_equal 30, Order.unshipped_value
+  end
+
+end

data/lib/mocha.rb

@@ -0,0 +1,3 @@
+require 'mocha_standalone'
+require 'mocha/configuration'
+require 'mocha/integration'

data/lib/mocha/any_instance_method.rb

@@ -0,0 +1,59 @@
+require 'mocha/class_method'
+
+module Mocha
+
+  class AnyInstanceMethod < ClassMethod
+  
+    def unstub
+      remove_new_method
+      restore_original_method
+      stubbee.any_instance.reset_mocha
+    end
+    
+    def mock
+      stubbee.any_instance.mocha
+    end
+   
+    def hide_original_method
+      if method_exists?(method)
+        begin
+          stubbee.send(:alias_method, hidden_method, method)
+        rescue NameError
+          # deal with nasties like ActiveRecord::Associations::AssociationProxy
+        end
+      end
+    end
+
+    def define_new_method
+      stubbee.class_eval(%{
+        def #{method}(*args, &block)
+          self.class.any_instance.mocha.method_missing(:#{method}, *args, &block)
+        end
+      }, __FILE__, __LINE__)
+    end
+
+    def remove_new_method
+      stubbee.send(:remove_method, method)
+    end
+
+    def restore_original_method
+      if method_exists?(hidden_method)
+        begin
+          stubbee.send(:alias_method, method, hidden_method)
+          stubbee.send(:remove_method, hidden_method)
+        rescue NameError
+          # deal with nasties like ActiveRecord::Associations::AssociationProxy
+        end
+      end
+    end
+
+    def method_exists?(method)
+      return true if stubbee.public_instance_methods(false).include?(method)
+      return true if stubbee.protected_instance_methods(false).include?(method)
+      return true if stubbee.private_instance_methods(false).include?(method)
+      return false
+    end
+    
+  end
+  
+end

data/lib/mocha/api.rb

@@ -0,0 +1,173 @@
+require 'mocha/parameter_matchers'
+require 'mocha/mockery'
+require 'mocha/sequence'
+
+module Mocha # :nodoc:
+  
+  # Methods added to Test::Unit::TestCase or equivalent.
+  module API
+    
+    include ParameterMatchers
+    
+    # :call-seq: mock(name, &block) -> mock object
+    #            mock(expected_methods = {}, &block) -> mock object
+    #            mock(name, expected_methods = {}, &block) -> mock object
+    #
+    # Creates a mock object.
+    #
+    # +name+ is a +String+ identifier for the mock object.
+    #
+    # +expected_methods+ is a +Hash+ with expected method name symbols as keys and corresponding return values as values.
+    #
+    # Note that (contrary to expectations set up by #stub) these expectations <b>must</b> be fulfilled during the test.
+    #   def test_product
+    #     product = mock('ipod_product', :manufacturer => 'ipod', :price => 100)
+    #     assert_equal 'ipod', product.manufacturer
+    #     assert_equal 100, product.price
+    #     # an error will be raised unless both Product#manufacturer and Product#price have been called
+    #   end 
+    #
+    # +block+ is an optional block to be evaluated against the mock object instance, giving an alernative way to set up expectations & stubs.
+    #   def test_product
+    #     product = mock('ipod_product') do
+    #       expects(:manufacturer).returns('ipod')
+    #       expects(:price).returns(100)
+    #     end
+    #     assert_equal 'ipod', product.manufacturer
+    #     assert_equal 100, product.price
+    #     # an error will be raised unless both Product#manufacturer and Product#price have been called
+    #   end 
+    def mock(*arguments, &block)
+      name = arguments.shift if arguments.first.is_a?(String)
+      expectations = arguments.shift || {}
+      mock = name ? Mockery.instance.named_mock(name, &block) : Mockery.instance.unnamed_mock(&block)
+      mock.expects(expectations)
+      mock
+    end
+    
+    # :call-seq: stub(name, &block) -> mock object
+    #            stub(stubbed_methods = {}, &block) -> mock object
+    #            stub(name, stubbed_methods = {}, &block) -> mock object
+    #
+    # Creates a mock object.
+    #
+    # +name+ is a +String+ identifier for the mock object.
+    #
+    # +stubbed_methods+ is a +Hash+ with stubbed method name symbols as keys and corresponding return values as values.
+    # Note that (contrary to expectations set up by #mock) these expectations <b>need not</b> be fulfilled during the test.
+    #   def test_product
+    #     product = stub('ipod_product', :manufacturer => 'ipod', :price => 100)
+    #     assert_equal 'ipod', product.manufacturer
+    #     assert_equal 100, product.price
+    #     # an error will not be raised even if Product#manufacturer and Product#price have not been called
+    #   end
+    #
+    # +block+ is an optional block to be evaluated against the mock object instance, giving an alernative way to set up expectations & stubs.
+    #   def test_product
+    #     product = stub('ipod_product') do
+    #       stubs(:manufacturer).returns('ipod')
+    #       stubs(:price).returns(100)
+    #     end
+    #     assert_equal 'ipod', product.manufacturer
+    #     assert_equal 100, product.price
+    #     # an error will not be raised even if Product#manufacturer and Product#price have not been called
+    #   end
+    def stub(*arguments, &block)
+      name = arguments.shift if arguments.first.is_a?(String)
+      expectations = arguments.shift || {}
+      stub = name ? Mockery.instance.named_mock(name, &block) : Mockery.instance.unnamed_mock(&block)
+      stub.stubs(expectations)
+      stub
+    end
+    
+    # :call-seq: stub_everything(name, &block) -> mock object
+    #            stub_everything(stubbed_methods = {}, &block) -> mock object
+    #            stub_everything(name, stubbed_methods = {}, &block) -> mock object
+    #
+    # Creates a mock object that accepts calls to any method.
+    #
+    # By default it will return +nil+ for any method call.
+    #
+    # +block+ is a block to be evaluated against the mock object instance, giving an alernative way to set up expectations & stubs.
+    #
+    # +name+ and +stubbed_methods+ work in the same way as for #stub.
+    #   def test_product
+    #     product = stub_everything('ipod_product', :price => 100)
+    #     assert_nil product.manufacturer
+    #     assert_nil product.any_old_method
+    #     assert_equal 100, product.price
+    #   end
+    def stub_everything(*arguments, &block)
+      name = arguments.shift if arguments.first.is_a?(String)
+      expectations = arguments.shift || {}
+      stub = name ? Mockery.instance.named_mock(name, &block) : Mockery.instance.unnamed_mock(&block)
+      stub.stub_everything
+      stub.stubs(expectations)
+      stub
+    end
+    
+    # :call-seq: sequence(name) -> sequence
+    #
+    # Returns a new sequence that is used to constrain the order in which expectations can occur.
+    #
+    # Specify that an expected invocation must occur in within a named +sequence+ by using Expectation#in_sequence.
+    #
+    # See also Expectation#in_sequence.
+    #   breakfast = sequence('breakfast')
+    #
+    #   egg = mock('egg')
+    #   egg.expects(:crack).in_sequence(breakfast)
+    #   egg.expects(:fry).in_sequence(breakfast)
+    #   egg.expects(:eat).in_sequence(breakfast)
+    def sequence(name)
+      Sequence.new(name)
+    end
+    
+    # :call-seq: states(name) -> state_machine
+    #
+    # Returns a new +state_machine+ that is used to constrain the order in which expectations can occur.
+    #
+    # Specify the initial +state+ of the +state_machine+ by using StateMachine#starts_as.
+    #
+    # Specify that an expected invocation should change the +state+ of the +state_machine+ by using Expectation#then.
+    #
+    # Specify that an expected invocation should be constrained to occur within a particular +state+ by using Expectation#when.
+    #
+    # A test can contain multiple +state_machines+.
+    #
+    # See also Expectation#then, Expectation#when and StateMachine.
+    #   power = states('power').starts_as('off')
+    #
+    #   radio = mock('radio')
+    #   radio.expects(:switch_on).then(power.is('on'))
+    #   radio.expects(:select_channel).with('BBC Radio 4').when(power.is('on'))
+    #   radio.expects(:adjust_volume).with(+5).when(power.is('on'))
+    #   radio.expects(:select_channel).with('BBC World Service').when(power.is('on'))
+    #   radio.expects(:adjust_volume).with(-5).when(power.is('on'))
+    #   radio.expects(:switch_off).then(power.is('off'))
+    def states(name)
+      Mockery.instance.new_state_machine(name)
+    end
+    
+    def mocha_setup # :nodoc:
+    end
+    
+    def mocha_verify(assertion_counter = nil) # :nodoc:
+      Mockery.instance.verify(assertion_counter)
+    end
+    
+    def mocha_teardown # :nodoc:
+      Mockery.instance.teardown
+      Mockery.reset_instance
+    end
+    
+  end
+  
+  def self.const_missing(name)
+    return super unless name == :Standalone
+    require 'mocha/deprecation'
+    Deprecation.warning "Mocha::Standalone has been renamed to Mocha::API"
+    return API
+  end
+  
+end

data/lib/mocha/argument_iterator.rb

@@ -0,0 +1,21 @@
+module Mocha
+  
+  class ArgumentIterator
+  
+    def initialize(argument)
+      @argument = argument
+    end
+  
+    def each(&block)
+      if @argument.is_a?(Hash) then
+        @argument.each do |method_name, return_value|
+          block.call(method_name, return_value)
+        end
+      else
+        block.call(@argument)
+      end
+    end
+  
+  end
+  
+end

data/lib/mocha/backtrace_filter.rb

@@ -0,0 +1,17 @@
+module Mocha
+
+  class BacktraceFilter
+  
+    LIB_DIRECTORY = File.expand_path(File.join(File.dirname(__FILE__), "..")) + File::SEPARATOR
+
+    def initialize(lib_directory = LIB_DIRECTORY)
+      @lib_directory = lib_directory
+    end
+
+    def filtered(backtrace)
+      backtrace.reject { |location| Regexp.new(@lib_directory).match(File.expand_path(location)) }
+    end
+
+  end
+
+end

data/lib/mocha/cardinality.rb

@@ -0,0 +1,95 @@
+module Mocha
+
+  class Cardinality
+    
+    INFINITY = 1 / 0.0
+    
+    class << self
+      
+      def exactly(count)
+        new(count, count)
+      end
+      
+      def at_least(count)
+        new(count, INFINITY)
+      end
+      
+      def at_most(count)
+        new(0, count)
+      end
+      
+      def times(range_or_count)
+        case range_or_count
+          when Range then new(range_or_count.first, range_or_count.last)
+          else new(range_or_count, range_or_count)
+        end
+      end
+      
+    end
+    
+    def initialize(required, maximum)
+      @required, @maximum = required, maximum
+    end
+    
+    def invocations_allowed?(invocation_count)
+      invocation_count < maximum
+    end
+    
+    def satisfied?(invocations_so_far)
+      invocations_so_far >= required
+    end
+    
+    def needs_verifying?
+      !allowed_any_number_of_times?
+    end
+    
+    def verified?(invocation_count)
+      (invocation_count >= required) && (invocation_count <= maximum)
+    end
+    
+    def allowed_any_number_of_times?
+      required == 0 && infinite?(maximum)
+    end
+    
+    def used?(invocation_count)
+      (invocation_count > 0) || (maximum == 0)
+    end
+    
+    def mocha_inspect
+      if allowed_any_number_of_times?
+        "allowed any number of times"
+      else
+        if required == 0 && maximum == 0
+          "expected never"
+        elsif required == maximum
+          "expected exactly #{times(required)}"
+        elsif infinite?(maximum)
+          "expected at least #{times(required)}"
+        elsif required == 0
+          "expected at most #{times(maximum)}"
+        else
+          "expected between #{required} and #{times(maximum)}"
+        end
+      end
+    end
+    
+    protected
+    
+    attr_reader :required, :maximum
+    
+    def times(number)
+      case number
+        when 0 then "no times"
+        when 1 then "once"
+        when 2 then "twice"
+        else "#{number} times"
+      end
+    end
+    
+    def infinite?(number)
+      number.respond_to?(:infinite?) && number.infinite?
+    end
+    
+  end
+  
+end