rspec-mocks 2.9.0 → 2.10.0

data/.document

@@ -1,5 +1,5 @@
-README.markdown
 lib/**/*.rb
-bin/*
-features/**/*.feature
+-
+README.md
 License.txt
+Changelog.md

data/.yardopts

@@ -1,7 +1,6 @@
 --exclude features
 --no-private
 --markup markdown
-lib/**/*.rb
 -
 Changelog.md
 License.txt

data/Changelog.md

@@ -1,3 +1,10 @@
+### 2.10.0 / 2012-05-03
+[full changelog](http://github.com/rspec/rspec-mocks/compare/v2.9.0...v2.10.0)
+
+Bug fixes
+
+* fail fast when an `exactly` or `at_most` expectation is exceeded 
+
 ### 2.9.0 / 2012-03-17
 [full changelog](http://github.com/rspec/rspec-mocks/compare/v2.8.0...v2.9.0)
 

data/README.md

@@ -116,12 +116,19 @@ Person.stub(:find) { person }
 ```
 
 In this case we're instrumenting Person to return the person object we've
-defined whenever it receives the `find` message. We can do this with any
-object in a system because rspec-mocks adds the `stub` and `should_receive`
-methods to every object. When we use either, RSpec replaces the method
-we're stubbing or mocking with its own test-double-like method. At the
-end of the example, RSpec verifies any message expectations, and then
-restores the original methods.
+defined whenever it receives the `find` message. We can also set a message
+expectation so that the example fails if `find` is not called:
+
+```ruby
+person = double("person")
+Person.should_receive(:find) { person }
+```
+
+We can do this with any object in a system because rspec-mocks adds the `stub`
+and `should_receive` methods to every object, including class objects. When we
+use either, RSpec replaces the method we're stubbing or mocking with its own
+test-double-like method. At the end of the example, RSpec verifies any message
+expectations, and then restores the original methods.
 
 ## Expecting Arguments
 
@@ -176,7 +183,7 @@ double.should_receive(:other_msg).ordered
   #This will fail if the messages are received out of order
 ```
 
-## Setting Reponses
+## Setting Responses
 
 Whether you are setting a message expectation or a method stub, you can
 tell the object precisely how to respond. The most generic way is to pass

data/lib/rspec/mocks/error_generator.rb

@@ -64,7 +64,7 @@ module RSpec
       def intro
         if @name
           "#{@declared_as} #{@name.inspect}"
-        elsif Mock === @target
+        elsif TestDouble === @target
           @declared_as
         elsif Class === @target
           "<#{@target.inspect} (class)>"

data/lib/rspec/mocks/framework.rb

@@ -7,6 +7,7 @@ require 'rspec/mocks/method_double'
 require 'rspec/mocks/methods'
 require 'rspec/mocks/argument_matchers'
 require 'rspec/mocks/proxy'
+require 'rspec/mocks/test_double'
 require 'rspec/mocks/mock'
 require 'rspec/mocks/argument_expectation'
 require 'rspec/mocks/message_expectation'

data/lib/rspec/mocks/message_expectation.rb

@@ -4,19 +4,17 @@ module RSpec
     class MessageExpectation
       # @private
       attr_reader :message
-      attr_writer :expected_received_count, :method_block, :expected_from, :argument_expectation
-      protected :expected_received_count=, :method_block=, :expected_from=
+      attr_writer :expected_received_count, :expected_from, :argument_expectation, :implementation
+      protected :expected_received_count=, :expected_from=, :implementation=
       attr_accessor :error_generator
       protected :error_generator, :error_generator=
 
       # @private
-      def initialize(error_generator, expectation_ordering, expected_from, message, method_block, expected_received_count=1, opts={}, &implementation)
+      def initialize(error_generator, expectation_ordering, expected_from, message, expected_received_count=1, opts={}, &implementation)
         @error_generator = error_generator
         @error_generator.opts = opts
         @expected_from = expected_from
         @message = message
-        @method_block = method_block
-        @return_block = nil
         @actual_received_count = 0
         @expected_received_count = expected_received_count
         @argument_expectation = ArgumentExpectation.new(ArgumentMatchers::AnyArgsMatcher.new)
@@ -24,21 +22,19 @@ module RSpec
         @exception_to_raise = nil
         @args_to_throw = []
         @order_group = expectation_ordering
-        @at_least = nil
-        @at_most = nil
-        @exactly = nil
+        @at_least = @at_most = @exactly = nil
         @args_to_yield = []
         @failed_fast = nil
         @args_to_yield_were_cloned = false
-        @return_block = implementation
         @eval_context = nil
+        @implementation = implementation
       end
 
       # @private
-      def build_child(expected_from, method_block, expected_received_count, opts={})
+      def build_child(expected_from, expected_received_count, opts={}, &implementation)
         child = clone
         child.expected_from = expected_from
-        child.method_block = method_block
+        child.implementation = implementation if implementation
         child.expected_received_count = expected_received_count
         child.clear_actual_received_count!
         new_gen = error_generator.clone
@@ -90,18 +86,10 @@ module RSpec
       #   # ... this is prefered
       #   counter.stub(:count) { 1 }
       #   counter.count # => 1
-      def and_return(*values, &return_block)
-        Kernel::raise AmbiguousReturnError unless @method_block.nil?
-        case values.size
-        when 0 then value = nil
-        when 1 then value = values[0]
-        else
-          value = values
-          @consecutive = true
-          @expected_received_count = values.size if !ignoring_args? &&
-            @expected_received_count < values.size
-        end
-        @return_block = block_given? ? return_block : lambda { value }
+      def and_return(*values, &implementation)
+        @expected_received_count = [@expected_received_count, values.size].max unless ignoring_args?
+        @consecutive = true if values.size > 1
+        @implementation = implementation || build_implementation(values)
       end
 
       # @overload and_raise
@@ -137,8 +125,7 @@ module RSpec
       #   car.stub(:go).and_throw(:out_of_gas)
       #   car.stub(:go).and_throw(:out_of_gas, :level => 0.1)
       def and_throw(symbol, object = nil)
-        @args_to_throw << symbol
-        @args_to_throw << object if object
+        @args_to_throw = [symbol, object].compact
       end
 
       # Tells the object to yield one or more args to a block when the message
@@ -153,11 +140,7 @@ module RSpec
           @args_to_yield_were_cloned = false
         end
 
-        if block
-          @eval_context = Object.new
-          @eval_context.extend RSpec::Mocks::InstanceExec
-          yield @eval_context
-        end
+        yield @eval_context = Object.new.extend(RSpec::Mocks::InstanceExec) if block
 
         @args_to_yield << args
         self
@@ -165,42 +148,29 @@ module RSpec
 
       # @private
       def matches?(message, *args)
-        @message == message and @argument_expectation.args_match?(*args)
+        @message == message && @argument_expectation.args_match?(*args)
       end
 
       # @private
       def invoke(*args, &block)
-        if @expected_received_count == 0
-          @failed_fast = true
+        if @expected_received_count == 0 || ((@exactly || @at_most) && (@actual_received_count == @expected_received_count))
           @actual_received_count += 1
+          @failed_fast = true
           @error_generator.raise_expectation_error(@message, @expected_received_count, @actual_received_count, *args)
         end
 
         @order_group.handle_order_constraint self
 
         begin
-          begin
-            raise(@exception_to_raise) unless @exception_to_raise.nil?
-          rescue ArgumentError => e
-            raise e.exception(<<-MESSAGE)
-'and_raise' can only accept an Exception class if an instance can be constructed with no arguments.
-#{@exception_to_raise.to_s}'s initialize method requires #{@exception_to_raise.instance_method(:initialize).arity} arguments, so you have to supply an instance instead.
-MESSAGE
-          end
+          raise_exception unless @exception_to_raise.nil?
           Kernel::throw(*@args_to_throw) unless @args_to_throw.empty?
 
-          default_return_val = if !@method_block.nil?
-                                 invoke_method_block(*args, &block)
-                               elsif !@args_to_yield.empty? || @eval_context
-                                 invoke_with_yield(&block)
-                               else
-                                 nil
-                               end
+          default_return_val = call_with_yield(&block) if !@args_to_yield.empty? || @eval_context
 
           if @consecutive
-            invoke_consecutive_return_block(*args, &block)
-          elsif @return_block
-            invoke_return_block(*args, &block)
+            call_implementation_consecutive(*args, &block)
+          elsif @implementation
+            call_implementation(*args, &block)
           else
             default_return_val
           end
@@ -209,10 +179,22 @@ MESSAGE
         end
       end
 
+      # @private
+      def raise_exception
+        if !@exception_to_raise.respond_to?(:instance_method) ||
+            @exception_to_raise.instance_method(:initialize).arity <= 0
+          raise(@exception_to_raise)
+        else
+          raise ArgumentError.new(<<-MESSAGE)
+'and_raise' can only accept an Exception class if an instance can be constructed with no arguments.
+#{@exception_to_raise.to_s}'s initialize method requires #{@exception_to_raise.instance_method(:initialize).arity} arguments, so you have to supply an instance instead.
+MESSAGE
+        end
+      end
+
       # @private
       def called_max_times?
-        @expected_received_count != :any && @expected_received_count > 0 &&
-          @actual_received_count >= @expected_received_count
+        @expected_received_count != :any && @expected_received_count > 0 && @actual_received_count >= @expected_received_count
       end
 
       # @private
@@ -301,7 +283,7 @@ MESSAGE
       #   cart.add(Book.new(:isbn => 1934356379))
       #   # => passes
       def with(*args, &block)
-        @return_block = block if block_given? unless args.empty?
+        @implementation = block if block_given? unless args.empty?
         @argument_expectation = ArgumentExpectation.new(*args, &block)
         self
       end
@@ -313,7 +295,7 @@ MESSAGE
       #
       #   dealer.should_recieve(:deal_card).exactly(10).times
       def exactly(n, &block)
-        @method_block = block if block
+        @implementation = block if block
         set_expected_received_count :exactly, n
         self
       end
@@ -325,7 +307,7 @@ MESSAGE
       #
       #   dealer.should_recieve(:deal_card).at_least(9).times
       def at_least(n, &block)
-        @method_block = block if block
+        @implementation = block if block
         set_expected_received_count :at_least, n
         self
       end
@@ -337,7 +319,7 @@ MESSAGE
       #
       #   dealer.should_recieve(:deal_card).at_most(10).times
       def at_most(n, &block)
-        @method_block = block if block
+        @implementation = block if block
         set_expected_received_count :at_most, n
         self
       end
@@ -350,14 +332,14 @@ MESSAGE
       #   dealer.should_recieve(:deal_card).at_least(10).times
       #   dealer.should_recieve(:deal_card).at_most(10).times
       def times(&block)
-        @method_block = block if block
+        @implementation = block if block
         self
       end
 
 
       # Allows an expected message to be received any number of times.
       def any_number_of_times(&block)
-        @method_block = block if block
+        @implementation = block if block
         @expected_received_count = :any
         self
       end
@@ -378,7 +360,7 @@ MESSAGE
       #
       #   car.should_receive(:go).once
       def once(&block)
-        @method_block = block if block
+        @implementation = block if block
         set_expected_received_count :exactly, 1
         self
       end
@@ -389,7 +371,7 @@ MESSAGE
       #
       #   car.should_receive(:go).twice
       def twice(&block)
-        @method_block = block if block
+        @implementation = block if block
         set_expected_received_count :exactly, 2
         self
       end
@@ -402,7 +384,7 @@ MESSAGE
       #   api.should_receive(:run).ordered
       #   api.should_receive(:finish).ordered
       def ordered(&block)
-        @method_block = block if block
+        @implementation = block if block
         @order_group.register(self)
         @ordered = true
         self
@@ -425,44 +407,25 @@ MESSAGE
 
       protected
 
-      def invoke_method_block(*args, &block)
-        begin
-          @method_block.call(*args, &block)
-        rescue => detail
-          @error_generator.raise_block_failed_error(@message, detail.message)
-        end
-      end
-
-      def invoke_with_yield(&block)
-        if block.nil?
-          @error_generator.raise_missing_block_error @args_to_yield
-        end
+      def call_with_yield(&block)
+        @error_generator.raise_missing_block_error @args_to_yield unless block
         value = nil
-        @args_to_yield.each do |args_to_yield_this_time|
-          if block.arity > -1 && args_to_yield_this_time.length != block.arity
-            @error_generator.raise_wrong_arity_error args_to_yield_this_time, block.arity
+        @args_to_yield.each do |args|
+          if block.arity > -1 && args.length != block.arity
+            @error_generator.raise_wrong_arity_error args, block.arity
           end
-          value = eval_block(*args_to_yield_this_time, &block)
+          value = @eval_context ? @eval_context.instance_exec(*args, &block) : block.call(*args)
         end
         value
       end
 
-      def eval_block(*args, &block)
-        if @eval_context
-          @eval_context.instance_exec(*args, &block)
-        else
-          block.call(*args)
-        end
-      end
-
-      def invoke_consecutive_return_block(*args, &block)
-        value = invoke_return_block(*args, &block)
-        index = [@actual_received_count, value.size-1].min
-        value[index]
+      def call_implementation_consecutive(*args, &block)
+        @value ||= call_implementation(*args, &block)
+        @value[[@actual_received_count, @value.size-1].min]
       end
 
-      def invoke_return_block(*args, &block)
-        @return_block.arity == 0 ? @return_block.call(&block) : @return_block.call(*args, &block)
+      def call_implementation(*args, &block)
+        @implementation.arity == 0 ? @implementation.call(&block) : @implementation.call(*args, &block)
       end
 
       def clone_args_to_yield(*args)
@@ -488,13 +451,20 @@ MESSAGE
       def clear_actual_received_count!
         @actual_received_count = 0
       end
+
+      private
+
+      def build_implementation(values)
+        value = values.size == 1 ? values.first : values
+        lambda { value }
+      end
     end
 
     # @private
     class NegativeMessageExpectation < MessageExpectation
       # @private
-      def initialize(error_generator, expectation_ordering, expected_from, message, method_block)
-        super(error_generator, expectation_ordering, expected_from, message, method_block, 0)
+      def initialize(error_generator, expectation_ordering, expected_from, message, &implementation)
+        super(error_generator, expectation_ordering, expected_from, message, 0, {}, &implementation)
       end
 
       # @private

data/lib/rspec/mocks/method_double.rb

@@ -27,7 +27,7 @@ module RSpec
 
       # @private
       def visibility
-        if Mock === @object
+        if TestDouble === @object
           'public'
         elsif object_singleton_class.private_method_defined?(@method_name)
           'private'
@@ -131,12 +131,12 @@ module RSpec
       end
 
       # @private
-      def add_expectation(error_generator, expectation_ordering, expected_from, opts, &block)
+      def add_expectation(error_generator, expectation_ordering, expected_from, opts, &implementation)
         configure_method
         expectation = if existing_stub = stubs.first
-                        existing_stub.build_child(expected_from, block, 1, opts)
+                        existing_stub.build_child(expected_from, 1, opts, &implementation)
                       else
-                        MessageExpectation.new(error_generator, expectation_ordering, expected_from, @method_name, block, 1, opts)
+                        MessageExpectation.new(error_generator, expectation_ordering, expected_from, @method_name, 1, opts, &implementation)
                       end
         expectations << expectation
         expectation
@@ -145,7 +145,7 @@ module RSpec
       # @private
       def add_negative_expectation(error_generator, expectation_ordering, expected_from, &implementation)
         configure_method
-        expectation = NegativeMessageExpectation.new(error_generator, expectation_ordering, expected_from, @method_name, implementation)
+        expectation = NegativeMessageExpectation.new(error_generator, expectation_ordering, expected_from, @method_name, &implementation)
         expectations.unshift expectation
         expectation
       end
@@ -153,7 +153,7 @@ module RSpec
       # @private
       def add_stub(error_generator, expectation_ordering, expected_from, opts={}, &implementation)
         configure_method
-        stub = MessageExpectation.new(error_generator, expectation_ordering, expected_from, @method_name, nil, :any, opts, &implementation)
+        stub = MessageExpectation.new(error_generator, expectation_ordering, expected_from, @method_name, :any, opts, &implementation)
         stubs.unshift stub
         stub
       end