rspec-mocks 2.10.1 → 2.11.0

data/lib/rspec/mocks/any_instance/recorder.rb

@@ -56,7 +56,12 @@ module RSpec
         def should_receive(method_name, &block)
           @expectation_set = true
           observe!(method_name)
-          message_chains.add(method_name, ExpectationChain.new(method_name, &block))
+          message_chains.add(method_name, PositiveExpectationChain.new(method_name, &block))
+        end
+
+        def should_not_receive(method_name, &block)
+          observe!(method_name)
+          message_chains.add(method_name, NegativeExpectationChain.new(method_name, &block))
         end
 
         # Removes any previously recorded stubs, stub_chains or message

data/lib/rspec/mocks/any_instance/stub_chain.rb

@@ -0,0 +1,37 @@
+module RSpec
+  module Mocks
+    module AnyInstance
+      # @private
+      class StubChain < Chain
+
+        # @private
+        def initialize(*args, &block)
+          record(:stub, *args, &block)
+        end
+
+        # @private
+        def expectation_fulfilled?
+          true
+        end
+
+        private
+
+        def invocation_order
+          @invocation_order ||= {
+            :stub => [nil],
+            :with => [:stub],
+            :and_return => [:with, :stub],
+            :and_raise => [:with, :stub],
+            :and_yield => [:with, :stub]
+          }
+        end
+
+        def verify_invocation_order(rspec_method_name, *args, &block)
+          unless invocation_order[rspec_method_name].include?(last_message)
+            raise(NoMethodError, "Undefined method #{rspec_method_name}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/mocks/any_instance/stub_chain_chain.rb

@@ -0,0 +1,25 @@
+module RSpec
+  module Mocks
+    module AnyInstance
+      # @private
+      class StubChainChain < StubChain
+
+        # @private
+        def initialize(*args, &block)
+          record(:stub_chain, *args, &block)
+        end
+
+        private
+
+        def invocation_order
+          @invocation_order ||= {
+            :stub_chain => [nil],
+            :and_return => [:stub_chain],
+            :and_raise => [:stub_chain],
+            :and_yield => [:stub_chain]
+          }
+        end
+      end
+    end
+  end
+end

data/lib/rspec/mocks/argument_list_matcher.rb

@@ -0,0 +1,93 @@
+require 'rspec/mocks/argument_matchers'
+
+module RSpec
+  module Mocks
+    # Wrapper for matching arguments against a list of expected values. Used by
+    # the `with` method on a `MessageExpectation`:
+    #
+    #     object.should_receive(:message).with(:a, 'b', 3)
+    #     object.message(:a, 'b', 3)
+    #
+    # Values passed to `with` can be literal values or argument matchers that
+    # match against the real objects .e.g.
+    #
+    #     object.should_receive(:message).with(hash_including(:a => 'b'))
+    #
+    # Can also be used directly to match the contents of any `Array`. This
+    # enables 3rd party mocking libs to take advantage of rspec's argument
+    # matching without using the rest of rspec-mocks.
+    #
+    #     require 'rspec/mocks/argument_list_matcher'
+    #     include RSpec::Mocks::ArgumentMatchers
+    #
+    #     arg_list_matcher = RSpec::Mocks::ArgumentListMatcher.new(123, hash_including(:a => 'b'))
+    #     arg_list_matcher.args_match?(123, :a => 'b')
+    #
+    # @see ArgumentMatchers
+    class ArgumentListMatcher
+      # @private
+      attr_reader :expected_args
+
+      # @api public
+      # @param [Array] *expected_args a list of expected literals and/or argument matchers
+      # @param [Block] block a block with arity matching the expected 
+      #
+      # Initializes an `ArgumentListMatcher` with a collection of literal
+      # values and/or argument matchers, or a block that handles the evaluation
+      # for you.
+      #
+      # @see ArgumentMatchers
+      # @see #args_match?
+      def initialize(*expected_args, &block)
+        @expected_args = expected_args
+        @block = expected_args.empty? ? block : nil
+        @match_any_args = false
+        @matchers = nil
+
+        case expected_args.first
+        when ArgumentMatchers::AnyArgsMatcher
+          @match_any_args = true
+        when ArgumentMatchers::NoArgsMatcher
+          @matchers = []
+        else
+          @matchers = expected_args.collect {|arg| matcher_for(arg)}
+        end
+      end
+
+      # @api public
+      # @param [Array] *args
+      #
+      # Matches each element in the `expected_args` against the element in the same
+      # position of the arguments passed to `new`.
+      #
+      # @see #initialize
+      def args_match?(*args)
+        match_any_args? || block_passes?(*args) || matchers_match?(*args)
+      end
+
+      private
+
+      def matcher_for(arg)
+        return ArgumentMatchers::MatcherMatcher.new(arg) if is_matcher?(arg)
+        return ArgumentMatchers::RegexpMatcher.new(arg)  if arg.is_a?(Regexp)
+        return ArgumentMatchers::EqualityProxy.new(arg)
+      end
+
+      def is_matcher?(obj)
+        !obj.null_object? & obj.respond_to?(:matches?) & [:failure_message_for_should, :failure_message].any? { |m| obj.respond_to?(m) }
+      end
+
+      def block_passes?(*args)
+        @block.call(*args) if @block
+      end
+
+      def matchers_match?(*args)
+        @matchers == args
+      end
+
+      def match_any_args?
+        @match_any_args
+      end
+    end
+  end
+end

data/lib/rspec/mocks/argument_matchers.rb

@@ -7,6 +7,8 @@ module RSpec
     #
     # With the exception of `any_args` and `no_args`, they all match against
     # the arg in same position in the argument list.
+    #
+    # @see ArgumentListMatcher
     module ArgumentMatchers
 
       class AnyArgsMatcher
@@ -64,7 +66,7 @@ module RSpec
           "hash_including(#{@expected.inspect.sub(/^\{/,"").sub(/\}$/,"")})"
         end
       end
-      
+
       class HashExcludingMatcher
         def initialize(expected)
           @expected = expected
@@ -80,7 +82,7 @@ module RSpec
           "hash_not_including(#{@expected.inspect.sub(/^\{/,"").sub(/\}$/,"")})"
         end
       end
-      
+
       class DuckTypeMatcher
         def initialize(*methods_to_respond_to)
           @methods_to_respond_to = methods_to_respond_to
@@ -110,47 +112,47 @@ module RSpec
           @given == expected
         end
       end
-      
+
       class InstanceOf
         def initialize(klass)
           @klass = klass
         end
-        
+
         def ==(actual)
           actual.instance_of?(@klass)
         end
       end
-      
+
       class KindOf
         def initialize(klass)
           @klass = klass
         end
-        
+
         def ==(actual)
           actual.kind_of?(@klass)
         end
       end
 
-      # Passes if object receives `:message` with any args at all. This is
-      # really a more explicit variation of `object.should_receive(:message)`
+      # Matches any args at all. Supports a more explicit variation of
+      # `object.should_receive(:message)`
       #
       # @example
       #
-      #   object.should_receive(:message).with(any_args())
+      #   object.should_receive(:message).with(any_args)
       def any_args
         AnyArgsMatcher.new
       end
-      
-      # Passes as long as there is an argument.
+
+      # Matches any argument at all.
       #
       # @example
       #
-      #   object.should_receive(:message).with(anything())
+      #   object.should_receive(:message).with(anything)
       def anything
         AnyArgMatcher.new(nil)
       end
-      
-      # Passes if no arguments are passed along with the message
+
+      # Matches no arguments.
       #
       # @example
       #
@@ -158,8 +160,8 @@ module RSpec
       def no_args
         NoArgsMatcher.new
       end
-      
-      # Passes if the argument responds to the specified messages.
+
+      # Matches if the actual argument responds to the specified messages.
       #
       # @example
       #
@@ -169,7 +171,7 @@ module RSpec
         DuckTypeMatcher.new(*args)
       end
 
-      # Passes if the argument is boolean.
+      # Matches a boolean value.
       #
       # @example
       #
@@ -177,9 +179,9 @@ module RSpec
       def boolean
         BooleanMatcher.new(nil)
       end
-      
-      # Passes if the argument is a hash that includes the specified key(s) or
-      # key/value pairs. If the hash includes other keys, it will still pass.
+
+      # Matches a hash that includes the specified key(s) or key/value pairs.
+      # Ignores any additional keys.
       #
       # @example
       #
@@ -189,9 +191,8 @@ module RSpec
       def hash_including(*args)
         HashIncludingMatcher.new(anythingize_lonely_keys(*args))
       end
-      
-      # Passes if the argument is a hash that doesn't include the specified
-      # key(s) or key/value
+
+      # Matches a hash that doesn't include the specified key(s) or key/value.
       #
       # @example
       #
@@ -203,23 +204,30 @@ module RSpec
       end
 
       alias_method :hash_not_including, :hash_excluding
-      
-      # Passes if `arg.instance_of?(klass)`
+
+      # Matches if `arg.instance_of?(klass)`
+      #
+      # @example
+      #
+      #   object.should_receive(:message).with(instance_of(Thing))
       def instance_of(klass)
         InstanceOf.new(klass)
       end
-      
+
       alias_method :an_instance_of, :instance_of
-      
-      # Passes if `arg.kind_of?(klass)`
+
+      # Matches if `arg.kind_of?(klass)`
+      # @example
+      #
+      #   object.should_receive(:message).with(kind_of(Thing))
       def kind_of(klass)
         KindOf.new(klass)
       end
-      
+
       alias_method :a_kind_of, :kind_of
-      
+
       private
-      
+
       def anythingize_lonely_keys(*args)
         hash = args.last.class == Hash ? args.delete_at(-1) : {}
         args.each { | arg | hash[arg] = anything }

data/lib/rspec/mocks/error_generator.rb

@@ -27,6 +27,13 @@ module RSpec
         __raise "#{intro} received #{expectation.message.inspect} with unexpected arguments\n  expected: #{expected_args}\n       got: #{actual_args}"
       end
 
+      # @private
+      def raise_missing_default_stub_error(expectation,*args)
+        expected_args = format_args(*expectation.expected_args)
+        actual_args = args.collect {|a| format_args(*a)}.join(", ")
+        __raise "#{intro} received #{expectation.message.inspect} with unexpected arguments\n Please stub a default value first if message might be received with other args as well. \n"
+      end
+
       # @private
       def raise_similar_message_args_error(expectation, *args)
         expected_args = format_args(*expectation.expected_args)

data/lib/rspec/mocks/example_methods.rb

@@ -41,6 +41,47 @@ module RSpec
         Proxy.allow_message_expectations_on_nil
       end
 
+      # Stubs the named constant with the given value.
+      # Like method stubs, the constant will be restored
+      # to its original value (or lack of one, if it was
+      # undefined) when the example completes.
+      #
+      # @param constant_name [String] The fully qualified name of the constant. The current
+      #   constant scoping at the point of call is not considered.
+      # @param value [Object] The value to make the constant refer to. When the
+      #   example completes, the constant will be restored to its prior state.
+      # @param options [Hash] Stubbing options.
+      # @option options :transfer_nested_constants [Boolean, Array<Symbol>] Determines
+      #   what nested constants, if any, will be transferred from the original value
+      #   of the constant to the new value of the constant. This only works if both
+      #   the original and new values are modules (or classes).
+      # @return [Object] the stubbed value of the constant
+      #
+      # @example
+      #
+      #   stub_const("MyClass", Class.new) # => Replaces (or defines) MyClass with a new class object.
+      #   stub_const("SomeModel::PER_PAGE", 5) # => Sets SomeModel::PER_PAGE to 5.
+      #
+      #   class CardDeck
+      #     SUITS = [:Spades, :Diamonds, :Clubs, :Hearts]
+      #     NUM_CARDS = 52
+      #   end
+      #
+      #   stub_const("CardDeck", Class.new)
+      #   CardDeck::SUITS # => uninitialized constant error
+      #   CardDeck::NUM_CARDS # => uninitialized constant error
+      #
+      #   stub_const("CardDeck", Class.new, :transfer_nested_constants => true)
+      #   CardDeck::SUITS # => our suits array
+      #   CardDeck::NUM_CARDS # => 52
+      #
+      #   stub_const("CardDeck", Class.new, :transfer_nested_constants => [:SUITS])
+      #   CardDeck::SUITS # => our suits array
+      #   CardDeck::NUM_CARDS # => uninitialized constant error
+      def stub_const(constant_name, value, options = {})
+        ConstantStubber.stub(constant_name, value, options)
+      end
+
     private
       
       def declare_double(declared_as, *args)

data/lib/rspec/mocks/framework.rb

@@ -9,7 +9,7 @@ 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/argument_list_matcher'
 require 'rspec/mocks/message_expectation'
 require 'rspec/mocks/order_group'
 require 'rspec/mocks/errors'
@@ -17,3 +17,4 @@ require 'rspec/mocks/error_generator'
 require 'rspec/mocks/space'
 require 'rspec/mocks/serialization'
 require 'rspec/mocks/any_instance'
+require 'rspec/mocks/stub_const'

data/lib/rspec/mocks/message_expectation.rb

@@ -3,11 +3,10 @@ module RSpec
 
     class MessageExpectation
       # @private
-      attr_reader :message
-      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=
+      attr_reader :message
+      attr_writer :expected_received_count, :expected_from, :argument_list_matcher
+      protected :expected_received_count=, :expected_from=, :error_generator, :error_generator=
 
       # @private
       def initialize(error_generator, expectation_ordering, expected_from, message, expected_received_count=1, opts={}, &implementation)
@@ -17,7 +16,7 @@ module RSpec
         @message = message
         @actual_received_count = 0
         @expected_received_count = expected_received_count
-        @argument_expectation = ArgumentExpectation.new(ArgumentMatchers::AnyArgsMatcher.new)
+        @argument_list_matcher = ArgumentListMatcher.new(ArgumentMatchers::AnyArgsMatcher.new)
         @consecutive = false
         @exception_to_raise = nil
         @args_to_throw = []
@@ -30,6 +29,12 @@ module RSpec
         @implementation = implementation
       end
 
+      def implementation=(implementation)
+        @consecutive = false
+        @implementation = implementation
+      end
+      protected :implementation=
+
       # @private
       def build_child(expected_from, expected_received_count, opts={}, &implementation)
         child = clone
@@ -41,13 +46,13 @@ module RSpec
         new_gen.opts = opts
         child.error_generator = new_gen
         child.clone_args_to_yield(*@args_to_yield)
-        child.argument_expectation = ArgumentExpectation.new(ArgumentMatchers::AnyArgsMatcher.new)
+        child.argument_list_matcher = ArgumentListMatcher.new(ArgumentMatchers::AnyArgsMatcher.new)
         child
       end
 
       # @private
       def expected_args
-        @argument_expectation.args
+        @argument_list_matcher.expected_args
       end
 
       # @overload and_return(value)
@@ -110,7 +115,7 @@ module RSpec
       #   car.stub(:go).and_raise
       #   car.stub(:go).and_raise(OutOfGas)
       #   car.stub(:go).and_raise(OutOfGas.new(2, :oz))
-      def and_raise(exception=Exception)
+      def and_raise(exception=RuntimeError)
         @exception_to_raise = exception
       end
 
@@ -148,7 +153,7 @@ module RSpec
 
       # @private
       def matches?(message, *args)
-        @message == message && @argument_expectation.args_match?(*args)
+        @message == message && @argument_list_matcher.args_match?(*args)
       end
 
       # @private
@@ -194,12 +199,15 @@ MESSAGE
 
       # @private
       def called_max_times?
-        @expected_received_count != :any && @expected_received_count > 0 && @actual_received_count >= @expected_received_count
+        @expected_received_count != :any &&
+          !@at_least &&
+          @expected_received_count > 0 &&
+          @actual_received_count >= @expected_received_count
       end
 
       # @private
       def matches_name_but_not_args(message, *args)
-        @message == message and not @argument_expectation.args_match?(*args)
+        @message == message and not @argument_list_matcher.args_match?(*args)
       end
 
       # @private
@@ -248,7 +256,7 @@ MESSAGE
       # @private
       def generate_error
         if similar_messages.empty?
-          @error_generator.raise_expectation_error(@message, @expected_received_count, @actual_received_count, *@argument_expectation.args)
+          @error_generator.raise_expectation_error(@message, @expected_received_count, @actual_received_count, *expected_args)
         else
           @error_generator.raise_similar_message_args_error(self, *@similar_messages)
         end
@@ -284,7 +292,7 @@ MESSAGE
       #   # => passes
       def with(*args, &block)
         @implementation = block if block_given? unless args.empty?
-        @argument_expectation = ArgumentExpectation.new(*args, &block)
+        @argument_list_matcher = ArgumentListMatcher.new(*args, &block)
         self
       end