rspec 1.0.0 → 1.3.1

data/lib/spec/mocks/message_expectation.rb

@@ -3,159 +3,269 @@ module Spec
 
     class BaseExpectation
       attr_reader :sym
-      
-      def initialize(error_generator, expectation_ordering, expected_from, sym, method_block, expected_received_count=1, opts={})
+      attr_writer :expected_received_count, :method_block, :expected_from
+      protected :expected_received_count=, :method_block=, :expected_from=
+      attr_accessor :error_generator
+      protected :error_generator, :error_generator=
+
+      def initialize(error_generator, expectation_ordering, expected_from, sym, method_block, expected_received_count=1, opts={}, &implementation)
         @error_generator = error_generator
         @error_generator.opts = opts
         @expected_from = expected_from
         @sym = sym
         @method_block = method_block
-        @return_block = lambda {}
-        @received_count = 0
+        @actual_received_count = 0
         @expected_received_count = expected_received_count
-        @args_expectation = ArgumentExpectation.new([:any_args])
+        @args_expectation = ArgumentExpectation.new([ArgumentMatchers::AnyArgsMatcher.new])
         @consecutive = false
         @exception_to_raise = nil
         @symbol_to_throw = nil
         @order_group = expectation_ordering
         @at_least = nil
         @at_most = nil
-        @args_to_yield = nil
+        @args_to_yield = []
+        @failed_fast = nil
+        @args_to_yield_were_cloned = false
+        @return_block = implementation
+        @eval_context = nil
+      end
+
+      def build_child(expected_from, method_block, expected_received_count, opts={})
+        child = clone
+        child.expected_from = expected_from
+        child.method_block = method_block
+        child.expected_received_count = expected_received_count
+        child.clear_actual_received_count!
+        new_gen = error_generator.clone
+        new_gen.opts = opts
+        child.error_generator = new_gen
+        child.clone_args_to_yield @args_to_yield
+        child
       end
-      
+
       def expected_args
         @args_expectation.args
       end
 
       def and_return(*values, &return_block)
         Kernel::raise AmbiguousReturnError unless @method_block.nil?
-        if values.size == 0
-          value = nil
-        elsif values.size == 1
-          value = values[0]
+        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 @expected_received_count != :any &&
+          @expected_received_count = values.size if !ignoring_args? &&
                                                     @expected_received_count < values.size
         end
         @return_block = block_given? ? return_block : lambda { value }
       end
-      
+
+      # :call-seq:
+      #   and_raise()
+      #   and_raise(Exception) #any exception class
+      #   and_raise(exception) #any exception object
+      #
+      # == Warning
+      #
+      # When you pass an exception class, the MessageExpectation will
+      # raise an instance of it, creating it with +new+. If the exception
+      # class initializer requires any parameters, you must pass in an
+      # instance and not the class.
       def and_raise(exception=Exception)
         @exception_to_raise = exception
       end
-      
+
       def and_throw(symbol)
         @symbol_to_throw = symbol
       end
-      
-      def and_yield(*args)
-        @args_to_yield = args
+
+      def and_yield(*args, &block)
+        if @args_to_yield_were_cloned
+          @args_to_yield.clear
+          @args_to_yield_were_cloned = false
+        end
+
+        if block
+          require 'spec/extensions/instance_exec'
+          @eval_context = Object.new
+          @eval_context.extend Spec::Matchers::InstanceExec
+          yield @eval_context
+        end
+        @args_to_yield << args
+        self
       end
-  
+
       def matches(sym, args)
-        @sym == sym and @args_expectation.check_args(args)
+        @sym == sym and @args_expectation.args_match?(args)
       end
-      
-      def invoke(args, block)
+
+      def invoke(*args, &block)
+        if @expected_received_count == 0
+          @failed_fast = true
+          @actual_received_count += 1
+          @error_generator.raise_expectation_error @sym, @expected_received_count, @actual_received_count, *args
+        end
+
         @order_group.handle_order_constraint self
 
         begin
-          if @exception_to_raise.class == Class
-            @exception_instance_to_raise = @exception_to_raise.new
-          else 
-            @exception_instance_to_raise = @exception_to_raise
-          end
           Kernel::raise @exception_to_raise unless @exception_to_raise.nil?
           Kernel::throw @symbol_to_throw unless @symbol_to_throw.nil?
 
+
           if !@method_block.nil?
-            return invoke_method_block(args)
-          elsif !@args_to_yield.nil?
-            return invoke_with_yield(block)
-          elsif @consecutive
-            return invoke_consecutive_return_block(args, block)
+            default_return_val = invoke_method_block(*args)
+          elsif @args_to_yield.size > 0 || @eval_context
+            default_return_val = invoke_with_yield(&block)
           else
-            return invoke_return_block(args, block)
+            default_return_val = nil
+          end
+
+          if @consecutive
+            return invoke_consecutive_return_block(*args, &block)
+          elsif @return_block
+            return invoke_return_block(*args, &block)
+          else
+            return default_return_val
           end
         ensure
-          @received_count += 1
+          @actual_received_count += 1
         end
       end
-      
+
+      def called_max_times?
+        @expected_received_count != :any && @expected_received_count > 0 &&
+          @actual_received_count >= @expected_received_count
+      end
+
+      def invoke_return_block(*args, &block)
+        args << block unless block.nil?
+        # Ruby 1.9 - when we set @return_block to return values
+        # regardless of arguments, any arguments will result in
+        # a "wrong number of arguments" error
+        @return_block.arity == 0 ? @return_block.call : @return_block.call(*args)
+      end
+
       protected
 
-      def invoke_method_block(args)
+      def invoke_method_block(*args)
         begin
           @method_block.call(*args)
         rescue => detail
           @error_generator.raise_block_failed_error @sym, detail.message
         end
       end
-      
-      def invoke_with_yield(block)
+
+      def invoke_with_yield(&block)
         if block.nil?
           @error_generator.raise_missing_block_error @args_to_yield
         end
-        if block.arity > -1 && @args_to_yield.length != block.arity
-          @error_generator.raise_wrong_arity_error @args_to_yield, block.arity
+        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
+          end
+          value = eval_block(*args_to_yield_this_time, &block)
         end
-        block.call(*@args_to_yield)
+        value
       end
-      
-      def invoke_consecutive_return_block(args, block)
-        args << block unless block.nil?
-        value = @return_block.call(*args)
-        
-        index = [@received_count, value.size-1].min
+
+      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]
       end
-      
-      def invoke_return_block(args, block)
-        args << block unless block.nil?
-        value = @return_block.call(*args)
-    
-        value
+
+      def clone_args_to_yield(args)
+        @args_to_yield = args.clone
+        @args_to_yield_were_cloned = true
+      end
+
+      def failed_fast?
+        @failed_fast
       end
     end
-    
+
     class MessageExpectation < BaseExpectation
-      
+
+      def matches_name?(sym)
+        @sym == sym
+      end
+
       def matches_name_but_not_args(sym, args)
-        @sym == sym and not @args_expectation.check_args(args)
-      end
-       
-      def verify_messages_received        
-        return if @expected_received_count == :any
-        return if (@at_least) && (@received_count >= @expected_received_count)
-        return if (@at_most) && (@received_count <= @expected_received_count)
-        return if @expected_received_count == @received_count
-    
-        begin
-          @error_generator.raise_expectation_error(@sym, @expected_received_count, @received_count, *@args_expectation.args)
-        rescue => error
-          error.backtrace.insert(0, @expected_from)
-          Kernel::raise error
+        matches_name?(sym) and not @args_expectation.args_match?(args)
+      end
+
+      def verify_messages_received
+        return if expected_messages_received? || failed_fast?
+
+        generate_error
+      rescue Spec::Mocks::MockExpectationError => error
+        error.backtrace.insert(0, @expected_from)
+        Kernel::raise error
+      end
+
+      def expected_messages_received?
+        ignoring_args? || matches_exact_count? ||
+           matches_at_least_count? || matches_at_most_count?
+      end
+
+      def ignoring_args?
+        @expected_received_count == :any
+      end
+
+      def matches_at_least_count?
+        @at_least && @actual_received_count >= @expected_received_count
+      end
+
+      def matches_at_most_count?
+        @at_most && @actual_received_count <= @expected_received_count
+      end
+
+      def matches_exact_count?
+        @expected_received_count == @actual_received_count
+      end
+
+      def similar_messages
+        @similar_messages ||= []
+      end
+
+      def advise(args, block)
+        similar_messages << args
+      end
+
+      def generate_error
+        if similar_messages.empty?
+          @error_generator.raise_expectation_error(@sym, @expected_received_count, @actual_received_count, *@args_expectation.args)
+        else
+          @error_generator.raise_unexpected_message_args_error(self, *@similar_messages)
         end
       end
 
       def with(*args, &block)
-        @method_block = block if block
-        @args_expectation = ArgumentExpectation.new(args)
+        @args_expectation = ArgumentExpectation.new(args, &block)
         self
       end
-      
+
       def exactly(n)
         set_expected_received_count :exactly, n
         self
       end
-      
+
       def at_least(n)
         set_expected_received_count :at_least, n
         self
       end
-      
+
       def at_most(n)
         set_expected_received_count :at_most, n
         self
@@ -165,67 +275,70 @@ module Spec
         @method_block = block if block
         self
       end
-  
+
       def any_number_of_times(&block)
         @method_block = block if block
         @expected_received_count = :any
         self
       end
-  
+
       def never
         @expected_received_count = 0
         self
       end
-  
+
       def once(&block)
         @method_block = block if block
         @expected_received_count = 1
         self
       end
-  
+
       def twice(&block)
         @method_block = block if block
         @expected_received_count = 2
         self
       end
-  
+
       def ordered(&block)
         @method_block = block if block
         @order_group.register(self)
         @ordered = true
         self
       end
-      
+
       def negative_expectation_for?(sym)
         return false
       end
-      
+
       protected
         def set_expected_received_count(relativity, n)
           @at_least = (relativity == :at_least)
           @at_most = (relativity == :at_most)
-          @expected_received_count = 1 if n == :once
-          @expected_received_count = 2 if n == :twice
-          @expected_received_count = n if n.kind_of? Numeric
+          @expected_received_count = case n
+            when Numeric
+              n
+            when :once
+              1
+            when :twice
+              2
+          end
         end
-      
+
+        def clear_actual_received_count!
+          @actual_received_count = 0
+        end
+
     end
-    
+
     class NegativeMessageExpectation < MessageExpectation
       def initialize(message, expectation_ordering, expected_from, sym, method_block)
         super(message, expectation_ordering, expected_from, sym, method_block, 0)
       end
-      
+
       def negative_expectation_for?(sym)
         return @sym == sym
       end
     end
-    
-    class MethodStub < BaseExpectation
-      def initialize(message, expectation_ordering, expected_from, sym, method_block)
-        super(message, expectation_ordering, expected_from, sym, method_block, 0)
-        @expected_received_count = :any
-      end
-    end
+
   end
 end

data/lib/spec/mocks/methods.rb

@@ -2,19 +2,74 @@ module Spec
   module Mocks
     module Methods
       def should_receive(sym, opts={}, &block)
-        __mock_proxy.add_message_expectation(opts[:expected_from] || caller(1)[0], sym, opts, &block)
+        __mock_proxy.add_message_expectation(opts[:expected_from] || caller(1)[0], sym.to_sym, opts, &block)
       end
 
       def should_not_receive(sym, &block)
-        __mock_proxy.add_negative_message_expectation(caller(1)[0], sym, &block)
+        __mock_proxy.add_negative_message_expectation(caller(1)[0], sym.to_sym, &block)
       end
       
-      def stub!(sym)
-        __mock_proxy.add_stub(caller(1)[0], sym)
+      def stub!(sym_or_hash, opts={}, &block)
+        if Hash === sym_or_hash
+          sym_or_hash.each {|method, value| stub!(method).and_return value }
+        else
+          __mock_proxy.add_stub(caller(1)[0], sym_or_hash.to_sym, opts, &block)
+        end
+      end
+      
+      alias_method :stub, :stub!
+
+      def unstub!(message)
+        __mock_proxy.remove_stub(message)
+      end
+
+      alias_method :unstub, :unstub!
+
+      # :call-seq:
+      #   object.stub_chain(:first, :second, :third).and_return(:this)
+      #
+      # Supports stubbing a chain of methods. Each argument represents
+      # a method name to stub, and each one returns a proxy object that
+      # can accept more stubs, until the last, which returns whatever
+      # is passed to +and_return_.
+      #
+      # == Examples
+      #   
+      #   # with this in an example ...
+      #   article = double('article')
+      #   Article.stub_chain(:authored_by, :published, :recent).and_return([article])
+      #   # then this will return an Array with the article double in it:
+      #   Article.authored_by(params[:author_id]).published.recent
+      def stub_chain(*methods)
+        if methods.length > 1
+          if matching_stub = __mock_proxy.find_matching_method_stub(methods[0])
+            methods.shift
+            matching_stub.invoke_return_block.stub_chain(*methods)
+          else
+            next_in_chain = Object.new
+            stub!(methods.shift) {next_in_chain}
+            next_in_chain.stub_chain(*methods)
+          end
+        else
+          stub!(methods.shift)
+        end
+      end
+      
+      # Record and otherwise ignore all messages that aren't specified,
+      # with +stub+, +stub!+, or +should_receive+.
+      # 
+      # == Returns
+      #   self
+      def as_null_object
+        __mock_proxy.as_null_object
+      end
+      
+      def null_object?
+        __mock_proxy.null_object?
       end
       
       def received_message?(sym, *args, &block) #:nodoc:
-        __mock_proxy.received_message?(sym, *args, &block)
+        __mock_proxy.received_message?(sym.to_sym, *args, &block)
       end
       
       def rspec_verify #:nodoc:
@@ -28,8 +83,12 @@ module Spec
     private
 
       def __mock_proxy
-        @mock_proxy ||= Proxy.new(self, @name, @options)
+        if Mock === self
+          @mock_proxy ||= Proxy.new(self, @name, @options)
+        else
+          @mock_proxy ||= Proxy.new(self)
+        end
       end
     end
   end
-end
+end

data/lib/spec/mocks/mock.rb

@@ -3,27 +3,69 @@ module Spec
     class Mock
       include Methods
 
-      # Creates a new mock with a +name+ (that will be used in error messages only)
-      # == Options:
-      # * <tt>:null_object</tt> - if true, the mock object acts as a forgiving null object allowing any message to be sent to it.
-      def initialize(name, options={})
-        @name = name
-        @options = options
+      # Creates a new mock with a +name+ (that will be used in error messages
+      # only) == Options:
+      # * <tt>:null_object</tt> - if true, the mock object acts as a forgiving
+      #   null object allowing any message to be sent to it.
+      def initialize(name=nil, stubs_and_options={})
+        if name.is_a?(Hash) && stubs_and_options.empty?
+          stubs_and_options = name
+          @name = nil
+        else
+          @name = name
+        end
+        @options = extract_options(stubs_and_options)
+        assign_stubs(stubs_and_options)
+      end
+
+      # This allows for comparing the mock to other objects that proxy such as
+      # ActiveRecords belongs_to proxy objects. By making the other object run
+      # the comparison, we're sure the call gets delegated to the proxy
+      # target.
+      def ==(other)
+        other == __mock_proxy
+      end
+
+      def inspect
+        "#<#{self.class}:#{sprintf '0x%x', self.object_id} @name=#{@name.inspect}>"
+      end
+
+      def to_s
+        inspect.gsub('<','[').gsub('>',']')
       end
 
+    private
+
       def method_missing(sym, *args, &block)
-        __mock_proxy.instance_eval {@messages_received << [sym, args, block]}
+        __mock_proxy.record_message_received(sym, args, block)
         begin
           return self if __mock_proxy.null_object?
           super(sym, *args, &block)
-        rescue NoMethodError
+        rescue NameError
           __mock_proxy.raise_unexpected_message_error sym, *args
         end
       end
+
+      def extract_options(stubs_and_options)
+        options = {}
+        extract_option(stubs_and_options, options, :null_object)
+        extract_option(stubs_and_options, options, :__declared_as, 'Mock')
+        options
+      end
       
-      def inspect
-        "#<#{self.class}:#{sprintf '0x%x', self.object_id} @name=#{@name.inspect}>"
+      def extract_option(source, target, key, default=nil)
+        if source[key]
+          target[key] = source.delete(key)
+        elsif default
+          target[key] = default
+        end
+      end
+
+      def assign_stubs(stubs)
+        stubs.each_pair do |message, response|
+          stub!(message).and_return(response)
+        end
       end
     end
   end
-end
+end