newbamboo-rspec 1.1.12

data/lib/spec/mocks/message_expectation.rb

@@ -0,0 +1,331 @@
+module Spec
+  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={})
+        @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 = []
+      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 }
+        # Ruby 1.9 - see where this is used below
+        @ignore_args = !block_given?
+      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)
+        args << block unless block.nil?
+        value = @return_block.call(*args)
+        
+        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
+        if @ignore_args
+          @return_block.call()
+        else
+          @return_block.call(*args)
+        end
+      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 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.first)
+        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/spec/mocks/methods.rb

@@ -0,0 +1,51 @@
+module Spec
+  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={})
+        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)
+        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

data/lib/spec/mocks/mock.rb

@@ -0,0 +1,55 @@
+module Spec
+  module Mocks
+    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, stubs_and_options={})
+        @name = name
+        @options = parse_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 method_missing(sym, *args, &block)
+        __mock_proxy.record_message_received(sym, args, block)
+        begin
+          return self if __mock_proxy.null_object?
+          super(sym, *args, &block)
+        rescue NameError
+          __mock_proxy.raise_unexpected_message_error sym, *args
+        end
+      end
+      
+      def inspect
+        "#<#{self.class}:#{sprintf '0x%x', self.object_id} @name=#{@name.inspect}>"
+      end
+      
+      def to_s
+        inspect.gsub('<','[').gsub('>',']')
+      end
+      
+      private
+      
+        def parse_options(options)
+          options.has_key?(:null_object) ? {:null_object => options.delete(:null_object)} : {}
+        end
+        
+        def assign_stubs(stubs)
+          stubs.each_pair do |message, response|
+            stub!(message).and_return(response)
+          end
+        end
+    end
+  end
+end

data/lib/spec/mocks/order_group.rb

@@ -0,0 +1,29 @@
+module Spec
+  module Mocks
+    class OrderGroup
+      def initialize error_generator
+        @error_generator = error_generator
+        @ordering = Array.new
+      end
+      
+      def register(expectation)
+        @ordering << expectation
+      end
+      
+      def ready_for?(expectation)
+        return @ordering.first == expectation
+      end
+      
+      def consume
+        @ordering.shift
+      end
+      
+      def handle_order_constraint expectation
+        return unless @ordering.include? expectation
+        return consume if ready_for?(expectation)
+        @error_generator.raise_out_of_order_error expectation.sym
+      end
+      
+    end
+  end
+end

data/lib/spec/mocks/proxy.rb

@@ -0,0 +1,230 @@
+module Spec
+  module Mocks
+    class Proxy
+      DEFAULT_OPTIONS = {
+        :null_object => false,
+      }
+      
+      @@warn_about_expectations_on_nil = true
+      
+      def self.allow_message_expectations_on_nil
+        @@warn_about_expectations_on_nil = false
+        
+        # ensure nil.rspec_verify is called even if an expectation is not set in the example
+        # otherwise the allowance would effect subsequent examples
+        $rspec_mocks.add(nil) unless $rspec_mocks.nil?
+      end
+
+      def initialize(target, name=nil, options={})
+        @target = target
+        @name = name
+        @error_generator = ErrorGenerator.new target, name
+        @expectation_ordering = OrderGroup.new @error_generator
+        @expectations = []
+        @messages_received = []
+        @stubs = []
+        @proxied_methods = []
+        @options = options ? DEFAULT_OPTIONS.dup.merge(options) : DEFAULT_OPTIONS
+      end
+
+      def null_object?
+        @options[:null_object]
+      end
+      
+      def as_null_object
+        @options[:null_object] = true
+        @target
+      end
+
+      def add_message_expectation(expected_from, sym, opts={}, &block)        
+        __add sym
+        warn_if_nil_class sym
+        if existing_stub = @stubs.detect {|s| s.sym == sym }
+          expectation = existing_stub.build_child(expected_from, block_given?? block : nil, 1, opts)
+        else
+          expectation = MessageExpectation.new(@error_generator, @expectation_ordering, expected_from, sym, block_given? ? block : nil, 1, opts)
+        end
+        @expectations << expectation
+        @expectations.last
+      end
+
+      def add_negative_message_expectation(expected_from, sym, &block)
+        __add sym
+        warn_if_nil_class sym
+        @expectations << NegativeMessageExpectation.new(@error_generator, @expectation_ordering, expected_from, sym, block_given? ? block : nil)
+        @expectations.last
+      end
+
+      def add_stub(expected_from, sym, opts={})
+        __add sym
+        @stubs.unshift MessageExpectation.new(@error_generator, @expectation_ordering, expected_from, sym, nil, :any, opts)
+        @stubs.first
+      end
+      
+      def verify #:nodoc:
+        verify_expectations
+      ensure
+        reset
+      end
+
+      def reset
+        clear_expectations
+        clear_stubs
+        reset_proxied_methods
+        clear_proxied_methods
+        reset_nil_expectations_warning
+      end
+
+      def received_message?(sym, *args, &block)
+        @messages_received.any? {|array| array == [sym, args, block]}
+      end
+
+      def has_negative_expectation?(sym)
+        @expectations.detect {|expectation| expectation.negative_expectation_for?(sym)}
+      end
+      
+      def record_message_received(sym, args, block)
+        @messages_received << [sym, args, block]
+      end
+
+      def message_received(sym, *args, &block)
+        expectation = find_matching_expectation(sym, *args)
+        stub = find_matching_method_stub(sym, *args)
+
+        if (stub && expectation && expectation.called_max_times?) || (stub && !expectation)
+          if expectation = find_almost_matching_expectation(sym, *args)
+            expectation.advise(args, block) unless expectation.expected_messages_received?
+          end
+          stub.invoke(args, block)
+        elsif expectation
+          expectation.invoke(args, block)
+        elsif expectation = find_almost_matching_expectation(sym, *args)
+          expectation.advise(args, block) if null_object? unless expectation.expected_messages_received?
+          raise_unexpected_message_args_error(expectation, *args) unless (has_negative_expectation?(sym) or null_object?)
+        else
+          @target.__send__ :method_missing, sym, *args, &block
+        end
+      end
+
+      def raise_unexpected_message_args_error(expectation, *args)
+        @error_generator.raise_unexpected_message_args_error expectation, *args
+      end
+
+      def raise_unexpected_message_error(sym, *args)
+        @error_generator.raise_unexpected_message_error sym, *args
+      end
+      
+    private
+
+      def __add(sym)
+        $rspec_mocks.add(@target) unless $rspec_mocks.nil?
+        define_expected_method(sym)
+      end
+      
+      def warn_if_nil_class(sym)
+        if proxy_for_nil_class? && @@warn_about_expectations_on_nil          
+          Kernel.warn("An expectation of :#{sym} was set on nil. Called from #{caller[2]}. Use allow_message_expectations_on_nil to disable warnings.")
+        end
+      end
+      
+      def define_expected_method(sym)
+        visibility_string = "#{visibility(sym)} :#{sym}"
+        unless @proxied_methods.include?(sym)
+          if target_responds_to?(sym)
+            munged_sym = munge(sym)
+            target_metaclass.instance_eval do
+              alias_method munged_sym, sym if method_defined?(sym.to_s)
+            end
+            @proxied_methods << sym
+          end
+        end
+
+        target_metaclass.class_eval(<<-EOF, __FILE__, __LINE__)
+          def #{sym}(*args, &block)
+            __mock_proxy.message_received :#{sym}, *args, &block
+          end
+          #{visibility_string}
+        EOF
+      end
+
+      def target_responds_to?(sym)
+        return @target.__send__(munge(:respond_to?),sym) if @already_proxied_respond_to
+        return @already_proxied_respond_to = true if sym == :respond_to?
+        return @target.respond_to?(sym, true)
+      end
+
+      def visibility(sym)
+        if Mock === @target
+          'public'
+        elsif target_metaclass.private_method_defined?(sym)
+          'private'
+        elsif target_metaclass.protected_method_defined?(sym)
+          'protected'
+        else
+          'public'
+        end
+      end
+
+      def munge(sym)
+        "proxied_by_rspec__#{sym.to_s}".to_sym
+      end
+
+      def clear_expectations
+        @expectations.clear
+      end
+
+      def clear_stubs
+        @stubs.clear
+      end
+
+      def clear_proxied_methods
+        @proxied_methods.clear
+      end
+
+      def target_metaclass
+        class << @target; self; end
+      end
+
+      def verify_expectations
+        @expectations.each do |expectation|
+          expectation.verify_messages_received
+        end
+      end
+
+      def reset_proxied_methods
+        @proxied_methods.each do |sym|
+          munged_sym = munge(sym)
+          target_metaclass.instance_eval do
+            if method_defined?(munged_sym.to_s)
+              alias_method sym, munged_sym
+              undef_method munged_sym
+            else
+              remove_method sym
+            end
+          end
+        end
+      end
+      
+      def proxy_for_nil_class?
+        @target.nil?
+      end
+      
+      def reset_nil_expectations_warning
+        @@warn_about_expectations_on_nil = true if proxy_for_nil_class?
+      end
+
+      def find_matching_expectation(sym, *args)
+        @expectations.find {|expectation| expectation.matches(sym, args)}
+      end
+
+      def find_almost_matching_expectation(sym, *args)
+        @expectations.find {|expectation| expectation.matches_name_but_not_args(sym, args)}
+      end
+
+      def find_matching_method_stub(sym, *args)
+        @stubs.find {|stub| stub.matches(sym, args)}
+      end
+
+    end
+  end
+end