rspec-mocks 2.0.0.a1

data/lib/rspec/mocks/error_generator.rb

@@ -0,0 +1,81 @@
+module Rspec
+  module Mocks
+    class ErrorGenerator
+      attr_writer :opts
+      
+      def initialize(target, name)
+        @target = target
+        @name = name
+      end
+      
+      def opts
+        @opts ||= {}
+      end
+
+      def raise_unexpected_message_error(sym, *args)
+        __raise "#{intro} received unexpected message :#{sym}#{arg_message(*args)}"
+      end
+      
+      def raise_unexpected_message_args_error(expectation, *args)
+        expected_args = format_args(*expectation.expected_args)
+        actual_args = args.empty? ? "(no args)" : format_args(*args)
+        __raise "#{intro} expected #{expectation.sym.inspect} with #{expected_args} but received it with #{actual_args}"
+      end
+      
+      def raise_expectation_error(sym, expected_received_count, actual_received_count, *args)
+        __raise "#{intro} expected :#{sym}#{arg_message(*args)} #{count_message(expected_received_count)}, but received it #{count_message(actual_received_count)}"
+      end
+      
+      def raise_out_of_order_error(sym)
+        __raise "#{intro} received :#{sym} out of order"
+      end
+      
+      def raise_block_failed_error(sym, detail)
+        __raise "#{intro} received :#{sym} but passed block failed with: #{detail}"
+      end
+      
+      def raise_missing_block_error(args_to_yield)
+        __raise "#{intro} asked to yield |#{arg_list(*args_to_yield)}| but no block was passed"
+      end
+      
+      def raise_wrong_arity_error(args_to_yield, arity)
+        __raise "#{intro} yielded |#{arg_list(*args_to_yield)}| to block with arity of #{arity}"
+      end
+      
+    private
+
+      def intro
+        @name ? "Mock '#{@name}'" : @target.class == Class ? "<#{@target.inspect} (class)>" : (@target.nil? ? "nil" : @target)
+      end
+      
+      def __raise(message)
+        message = opts[:message] unless opts[:message].nil?
+        Kernel::raise(Rspec::Mocks::MockExpectationError, message)
+      end
+      
+      def arg_message(*args)
+        " with " + format_args(*args)
+      end
+      
+      def format_args(*args)
+        args.empty? ? "(no args)" : "(" + arg_list(*args) + ")"
+      end
+
+      def arg_list(*args)
+        args.collect {|arg| arg.respond_to?(:description) ? arg.description : arg.inspect}.join(", ")
+      end
+      
+      def count_message(count)
+        return "at least #{pretty_print(count.abs)}" if count < 0
+        return pretty_print(count)
+      end
+
+      def pretty_print(count)
+        return "once" if count == 1
+        return "twice" if count == 2
+        return "#{count} times"
+      end
+
+    end
+  end
+end

data/lib/rspec/mocks/errors.rb

@@ -0,0 +1,10 @@
+module Rspec
+  module Mocks
+    class MockExpectationError < Exception
+    end
+    
+    class AmbiguousReturnError < StandardError
+    end
+  end
+end
+

data/lib/rspec/mocks/extensions.rb

@@ -0,0 +1 @@
+require 'rspec/mocks/extensions/object'

data/lib/rspec/mocks/extensions/object.rb

@@ -0,0 +1,3 @@
+class Object
+  include Rspec::Mocks::Methods
+end

data/lib/rspec/mocks/framework.rb

@@ -0,0 +1,15 @@
+# Require everything except the global extensions of class and object. This
+# supports wrapping rspec's mocking functionality without invading every
+# object in the system.
+
+require 'rspec/mocks/methods'
+require 'rspec/mocks/argument_matchers'
+require 'rspec/mocks/spec_methods'
+require 'rspec/mocks/proxy'
+require 'rspec/mocks/mock'
+require 'rspec/mocks/argument_expectation'
+require 'rspec/mocks/message_expectation'
+require 'rspec/mocks/order_group'
+require 'rspec/mocks/errors'
+require 'rspec/mocks/error_generator'
+require 'rspec/mocks/space'

data/lib/rspec/mocks/message_expectation.rb

@@ -0,0 +1,326 @@
+module Rspec
+  module Mocks
+
+    class BaseExpectation
+      attr_reader :sym
+      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 = nil
+        @actual_received_count = 0
+        @expected_received_count = expected_received_count
+        @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 = []
+        @failed_fast = nil
+        @args_to_yield_were_cloned = false
+        @return_block = implementation
+      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?
+        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 }
+      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)
+        if @args_to_yield_were_cloned
+          @args_to_yield.clear
+          @args_to_yield_were_cloned = false
+        end
+        
+        @args_to_yield << args
+        self
+      end
+      
+      def matches(sym, args)
+        @sym == sym and @args_expectation.args_match?(args)
+      end
+      
+      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
+          Kernel::raise @exception_to_raise unless @exception_to_raise.nil?
+          Kernel::throw @symbol_to_throw unless @symbol_to_throw.nil?
+          
+          
+          if !@method_block.nil?
+            default_return_val = invoke_method_block(args)
+          elsif @args_to_yield.size > 0
+            default_return_val = invoke_with_yield(block)
+          else
+            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
+          @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
+      
+      protected
+
+      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)
+        if block.nil?
+          @error_generator.raise_missing_block_error @args_to_yield
+        end
+        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 = block.call(*args_to_yield_this_time)
+        end
+        value
+      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?
+        # 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
+      
+      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_but_not_args(sym, args)
+        @sym == sym and not @args_expectation.args_match?(args)
+      end
+       
+      def verify_messages_received
+        return if expected_messages_received? || failed_fast?
+    
+        generate_error
+      rescue Rspec::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)
+        @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
+      end
+
+      def times(&block)
+        @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 = 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
+    
+  end
+end

data/lib/rspec/mocks/methods.rb

@@ -0,0 +1,63 @@
+module Rspec
+  module Mocks
+    module Methods
+      def should_receive(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.to_sym, &block)
+      end
+      
+      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 stub_chain(*methods)
+        if methods.length > 1
+          next_in_chain = Object.new
+          stub!(methods.shift) {next_in_chain}
+          next_in_chain.stub_chain(*methods)
+        else
+          stub!(methods.shift)
+        end
+      end
+      
+      def received_message?(sym, *args, &block) #:nodoc:
+        __mock_proxy.received_message?(sym.to_sym, *args, &block)
+      end
+      
+      def rspec_verify #:nodoc:
+        __mock_proxy.verify
+      end
+
+      def rspec_reset #:nodoc:
+        __mock_proxy.reset
+      end
+      
+      def as_null_object
+        __mock_proxy.as_null_object
+      end
+      
+      def null_object?
+        __mock_proxy.null_object?
+      end
+
+    private
+
+      def __mock_proxy
+        if Mock === self
+          @mock_proxy ||= Proxy.new(self, @name, @options)
+        else
+          @mock_proxy ||= Proxy.new(self)
+        end
+      end
+    end
+  end
+end