rspec-mocks 2.0.0.a1

data/lib/rspec/mocks/mock.rb

@@ -0,0 +1,65 @@
+module Rspec
+  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='mock', stubs_and_options={})
+        if name.is_a?(Hash) && stubs_and_options.empty?
+          stubs_and_options = name
+          build_name_from_options stubs_and_options
+        else
+          @name = name
+        end
+        @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 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.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 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
+
+      def build_name_from_options(options)
+        vals = options.inject([]) {|coll, pair| coll << "#{pair.first}: #{pair.last.inspect}"}
+        @name = '{' + vals.join(', ') + '}'
+      end
+    end
+  end
+end

data/lib/rspec/mocks/order_group.rb

@@ -0,0 +1,29 @@
+module Rspec
+  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/rspec/mocks/proxy.rb

@@ -0,0 +1,230 @@
+module Rspec
+  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
+        @already_proxied_respond_to = false
+      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={}, &implementation)
+        __add sym
+        @stubs.unshift MessageExpectation.new(@error_generator, @expectation_ordering, expected_from, sym, nil, :any, opts, &implementation)
+        @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)
+        unless @proxied_methods.include?(sym)
+          visibility_string = "#{visibility(sym)} :#{sym}"
+          if target_responds_to?(sym)
+            munged_sym = munge(sym)
+            target_metaclass.instance_eval do
+              alias_method munged_sym, sym if method_defined?(sym)
+            end
+            @proxied_methods << sym
+          end
+          target_metaclass.class_eval(<<-EOF, __FILE__, __LINE__)
+            def #{sym}(*args, &block)
+              __mock_proxy.message_received :#{sym}, *args, &block
+            end
+            #{visibility_string}
+          EOF
+        end
+      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}"
+      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
+            remove_method sym
+            if method_defined?(munged_sym)
+              alias_method sym, munged_sym
+              remove_method munged_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) && !expectation.called_max_times?} || 
+        @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

data/lib/rspec/mocks/space.rb

@@ -0,0 +1,28 @@
+module Rspec
+  module Mocks
+    class Space
+      def add(obj)
+        mocks << obj unless mocks.detect {|m| m.equal? obj}
+      end
+
+      def verify_all
+        mocks.each do |mock|
+          mock.rspec_verify
+        end
+      end
+      
+      def reset_all
+        mocks.each do |mock|
+          mock.rspec_reset
+        end
+        mocks.clear
+      end
+      
+    private
+    
+      def mocks
+        @mocks ||= []
+      end
+    end
+  end
+end

data/lib/rspec/mocks/spec_methods.rb

@@ -0,0 +1,39 @@
+module Rspec
+  module Mocks
+    module ExampleMethods
+      include Rspec::Mocks::ArgumentMatchers
+
+      # Shortcut for creating an instance of Rspec::Mocks::Mock.
+      #
+      # +name+ is used for failure reporting, so you should use the
+      # role that the mock is playing in the example.
+      #
+      # +stubs_and_options+ lets you assign options and stub values
+      # at the same time. The only option available is :null_object.
+      # Anything else is treated as a stub value.
+      #
+      # == Examples
+      #
+      #   stub_thing = mock("thing", :a => "A")
+      #   stub_thing.a == "A" => true
+      #
+      #   stub_person = stub("thing", :name => "Joe", :email => "joe@domain.com")
+      #   stub_person.name => "Joe"
+      #   stub_person.email => "joe@domain.com"
+      def mock(*args)
+        Rspec::Mocks::Mock.new(*args)
+      end
+
+      alias :stub :mock
+
+      # Disables warning messages about expectations being set on nil.
+      #
+      # By default warning messages are issued when expectations are set on nil.  This is to
+      # prevent false-positives and to catch potential bugs early on.
+      def allow_message_expectations_on_nil
+        Proxy.allow_message_expectations_on_nil
+      end
+
+    end
+  end
+end

data/lib/spec/mocks.rb

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

data/spec/rspec/mocks/any_number_of_times_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+module Rspec
+  module Mocks
+    
+    describe "AnyNumberOfTimes" do
+      before(:each) do
+        @mock = Mock.new("test mock")
+      end
+
+      it "should pass if any number of times method is called many times" do
+        @mock.should_receive(:random_call).any_number_of_times
+        (1..10).each do
+          @mock.random_call
+        end
+      end
+
+      it "should pass if any number of times method is called once" do
+        @mock.should_receive(:random_call).any_number_of_times
+        @mock.random_call
+      end
+      
+      it "should pass if any number of times method is not called" do
+        @mock.should_receive(:random_call).any_number_of_times
+      end
+
+      it "should return the mocked value when called after a similar stub" do
+        @mock.stub!(:message).and_return :stub_value
+        @mock.should_receive(:message).any_number_of_times.and_return(:mock_value)
+        @mock.message.should == :mock_value
+        @mock.message.should == :mock_value
+      end
+    end
+
+  end
+end

data/spec/rspec/mocks/argument_expectation_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+module Rspec
+  module Mocks
+    describe ArgumentExpectation do
+      it "should consider an object that responds to #matches? and #description to be a matcher" do
+        argument_expecatation = Rspec::Mocks::ArgumentExpectation.new([])
+        obj = mock("matcher")
+        obj.should_receive(:respond_to?).with(:matches?).and_return(true)
+        obj.should_receive(:respond_to?).with(:description).and_return(true)
+        argument_expecatation.is_matcher?(obj).should be_true
+      end
+
+      it "should NOT consider an object that only responds to #matches? to be a matcher" do
+        argument_expecatation = Rspec::Mocks::ArgumentExpectation.new([])
+        obj = mock("matcher")
+        obj.should_receive(:respond_to?).with(:matches?).and_return(true)
+        obj.should_receive(:respond_to?).with(:description).and_return(false)
+        argument_expecatation.is_matcher?(obj).should be_false
+      end
+    end
+  end
+end