rspec-mocks 2.14.6 → 2.99.0.beta1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWYzOGM0ZDZlNWI1YjhiOGY5N2MxMGEzODNlNzA4NzJiYmRiOWIwMg==
+    OThjNzA2ZTdkZmU2MWE5OWVhMzIzMjI4NjZkNGNlY2QwZTY1ZDMyYQ==
   data.tar.gz: !binary |-
-    MjhlMWMxOWI0MTMxYjQzYmExMWVmODkwMGNhYzczYmY1MWU1ZTliMw==
+    OGY4OTQwMGY4NTZhMGEzMmVhY2NlODAzZTYxMWMyNWFmZjVjMWIwYg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OGM2M2FjZWM0YzJkMjkwOWE5Nzk0NWY3YjNmNGJlN2QxZjBjNmI2ZTU5NTQy
-    ODA3N2EyODNmNGFiYjA3M2FiZDQ5NTc5NThmYzVlNGJhMTY3ZTg0MTQyNjBj
-    NDZjY2Q2Y2ZiZTA1NTBlMjBhYTQzMWU1MDgyNzU1OGNhYzZkOTE=
+    Njc3ODhhZTYxMzMyNWU3MzIxM2MzMTdjNWQ0N2Q4MWNiNTIyZDYwNGIzZjI4
+    NzRmZjk1YjYzNDExMmZkYWNiM2E4NjQ0ZWVkOWM4MGU2NzNiMjNlYjY4ZWEw
+    Zjg5ZDNkOTY0NGNkOTUxZjc1NWM3MDcyM2Y1NThjNDgwNDI1YjQ=
   data.tar.gz: !binary |-
-    MmNjMDFlNDM0MTZhZGNiZjhjMmQ1NDk4OGQ3YzViOGExOTVlMzUzNzI1MTI0
-    NjlkMTdkZmQyNjE5ODljNTc5MWE4M2E3NzQzY2Y0ZWEzZDVkYTQzNmM3OGY3
-    Yjg4ODM5ZmI0NjYyYjEzZGMyZGZjNzA2ZDExOTM3ZDY1OWY2YmQ=
+    MGIzMGMxYzg2OTE4NzY1NzA5ZTM4MDIxZmRhZDQ1NjM0OWE0YjIwOWQ3MTFj
+    YWFiYzQwNGRhMDEzNTc2YWVlNzYyMDcwNTNiZGU5MWE4NmZiMzc4MGYzNzQ5
+    NWM1YjA3OTBmMzg5Njk1MWZkZDFjNmUxNDc4ODA5Y2NiMTAyNGQ=

data/Changelog.md

@@ -1,20 +1,27 @@
-### 2.14.6 development
-[full changelog](http://github.com/rspec/rspec-mocks/compare/v2.14.5...v2.14.6)
+### 2.99.0.beta1 / 2013-11-07
+[full changelog](http://github.com/rspec/rspec-mocks/compare/v2.14.4...v2.99.0.beta1)
 
-Bug Fixes:
-
-* Ensure `any_instance` method stubs and expectations are torn down regardless of
-  expectation failures. (Sam Phippen)
+Deprecations
 
-### 2.14.5 / 2014-02-01
-[full changelog](http://github.com/rspec/rspec-mocks/compare/v2.14.4...v2.14.5)
+* Expecting to use lambdas or other strong arity implementations for stub
+  methods with mis-matched arity is deprecated and support for them will be
+  removed in 3.0. Either provide the right amount of arguments or use a weak
+  arity implementation (methods with splats or procs). (Jon Rowe)
+* Using the same test double instance in multiple examples is deprecated. Test
+  doubles are only meant to live for one example. The mocks and stubs have
+  always been reset between examples; however, in 2.x the `as_null_object`
+  state was not reset and some users relied on this to have a null object
+  double that is used for many examples. This behavior will be removed in 3.0.
+  (Myron Marston)
+* Print a detailed warning when an `any_instance` implementation block is used
+  when the new `yield_receiver_to_any_instance_implementation_blocks` config
+  option is not explicitly set, as RSpec 3.0 will default to enabling this new
+  feature. (Sam Phippen)
 
-Bug Fixes:
+Enhancements:
 
-* Fix regression that caused block implementations to not receive all
-  args on 1.8.7 if the block also receives a block, due to Proc#arity
-  reporting `1` no matter how many args the block receives if it
-  receives a block, too. (Myron Marston)
+* Add a config option to yield the receiver to `any_instance` implementation
+  blocks. (Sam Phippen)
 
 ### 2.14.4 / 2013-10-15
 [full changelog](http://github.com/rspec/rspec-mocks/compare/v2.14.3...v2.14.4)
@@ -119,7 +126,6 @@ Bug fixes
   (Luke Imhoff, Jon Rowe)
 * Fix isolation of `allow_message_expectations_on_nil` (Jon Rowe)
 * Use inspect to format actual arguments on expectations in failure messages (#280, Ben Langfeld)
-* Protect against improperly initialised test doubles (#293) (Joseph Shraibman and Jon Rowe)
 
 Deprecations
 

data/lib/rspec/mocks.rb

@@ -47,7 +47,9 @@ module RSpec
       #   x = 0
       #   RSpec::Mocks.allow_message(bar, :foo) { x += 1 }
       def allow_message(subject, message, opts={}, &block)
-        orig_caller = opts.fetch(:expected_from) { caller(1)[0] }
+        orig_caller = opts.fetch(:expected_from) {
+          CallerFilter.first_non_rspec_line
+        }
         ::RSpec::Mocks.proxy_for(subject).
           add_stub(orig_caller, message.to_sym, opts, &block)
       end
@@ -64,7 +66,9 @@ module RSpec
       #   RSpec::Mocks.expect_message(bar, :foo)
       #   bar.foo
       def expect_message(subject, message, opts={}, &block)
-        orig_caller = opts.fetch(:expected_from) { caller(1)[0] }
+        orig_caller = opts.fetch(:expected_from) {
+          CallerFilter.first_non_rspec_line
+        }
         ::RSpec::Mocks.proxy_for(subject).
           add_message_expectation(orig_caller, message.to_sym, opts, &block)
       end

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

@@ -6,6 +6,8 @@ module RSpec
           @recorder          = recorder
           @expectation_args  = args
           @expectation_block = block
+          @source_line       = CallerFilter.first_non_rspec_line
+          ensure_expectation_block_has_source_location
         end
 
         module Customizations
@@ -71,6 +73,19 @@ module RSpec
 
         private
 
+        def create_message_expectation_on(instance)
+          me = yield(::RSpec::Mocks.proxy_for(instance), IGNORED_BACKTRACE_LINE)
+
+          if RSpec::Mocks.configuration.should_warn_about_any_instance_blocks?
+            me.warn_about_receiver_passing(@source_line)
+            me.display_any_instance_deprecation_warning_if_necessary(@expectation_block)
+          elsif RSpec::Mocks.configuration.yield_receiver_to_any_instance_implementation_blocks?
+            me.and_yield_receiver_to_implementation
+          end
+
+          me
+        end
+
         def negated?
           messages.any? { |(message, *_), _| message.to_sym == :never }
         end
@@ -88,6 +103,19 @@ module RSpec
           messages << [args.unshift(rspec_method_name), block]
           self
         end
+
+        if Proc.method_defined?(:source_location)
+          def ensure_expectation_block_has_source_location; end
+        else
+          def ensure_expectation_block_has_source_location
+            return unless @expectation_block
+            source_location = CallerFilter.first_non_rspec_line.split(':')
+
+            @expectation_block.extend Module.new {
+              define_method(:source_location) { source_location }
+            }
+          end
+        end
       end
     end
   end

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

@@ -12,20 +12,15 @@ module RSpec
           super
         end
 
-        private
+      private
+
         def verify_invocation_order(rspec_method_name, *args, &block)
         end
-      end
-
-      # @api private
-      class PositiveExpectationChain < ExpectationChain
-
-        private
 
         def create_message_expectation_on(instance)
-          proxy = ::RSpec::Mocks.proxy_for(instance)
-          expected_from = IGNORED_BACKTRACE_LINE
-          proxy.add_message_expectation(expected_from, *@expectation_args, &@expectation_block)
+          super do |proxy, expected_from|
+            proxy.add_message_expectation(expected_from, *@expectation_args, &@expectation_block)
+          end
         end
 
         def invocation_order

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

@@ -57,7 +57,7 @@ module RSpec
         def should_receive(method_name, &block)
           @expectation_set = true
           observe!(method_name)
-          message_chains.add(method_name, PositiveExpectationChain.new(self, method_name, &block))
+          message_chains.add(method_name, ExpectationChain.new(self, method_name, &block))
         end
 
         def should_not_receive(method_name, &block)
@@ -88,6 +88,9 @@ module RSpec
           if @expectation_set && !message_chains.all_expectations_fulfilled?
             raise RSpec::Mocks::MockExpectationError, "Exactly one instance should have received the following message(s) but didn't: #{message_chains.unfulfilled_expectations.sort.join(', ')}"
           end
+        ensure
+          stop_all_observation!
+          ::RSpec::Mocks.space.remove_any_instance_recorder_for(@klass)
         end
 
         # @private

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

@@ -12,11 +12,11 @@ module RSpec
         private
 
         def create_message_expectation_on(instance)
-          proxy = ::RSpec::Mocks.proxy_for(instance)
-          expected_from = IGNORED_BACKTRACE_LINE
-          stub = proxy.add_stub(expected_from, *@expectation_args, &@expectation_block)
-          @recorder.stubs[stub.message] << stub
-          stub
+          super do |proxy, expected_from|
+            stub = proxy.add_stub(expected_from, *@expectation_args, &@expectation_block)
+            @recorder.stubs[stub.message] << stub
+            stub
+          end
         end
 
         def invocation_order

data/lib/rspec/mocks/caller_filter.rb

@@ -0,0 +1,55 @@
+module RSpec
+  # Consistent implementation for "cleaning" the caller method to strip out
+  # non-rspec lines. This enables errors to be reported at the call site in
+  # the code using the library, which is far more useful than the particular
+  # internal method that raised an error.
+  class CallerFilter
+
+    RSPEC_LIBS = %w[
+      core
+      mocks
+      expectations
+      matchers
+      rails
+    ]
+
+    ADDITIONAL_TOP_LEVEL_FILES = %w[ autorun ]
+
+    LIB_REGEX = %r{/lib/rspec/(#{(RSPEC_LIBS + ADDITIONAL_TOP_LEVEL_FILES).join('|')})(\.rb|/)}
+
+    if RUBY_VERSION >= '2.0.0'
+      def self.first_non_rspec_line
+        # `caller` is an expensive method that scales linearly with the size of
+        # the stack. The performance hit for fetching it in chunks is small,
+        # and since the target line is probably near the top of the stack, the
+        # overall improvement of a chunked search like this is significant.
+        #
+        # See benchmarks/caller.rb for measurements.
+
+        # Initial value here is mostly arbitrary, but is chosen to give good
+        # performance on the common case of creating a double.
+        increment = 5
+        i         = 1
+        line      = nil
+
+        while !line
+          stack = caller(i, increment)
+          raise "No non-lib lines in stack" unless stack
+
+          line = stack.find { |l| l !~ LIB_REGEX }
+
+          i         += increment
+          increment *= 2 # The choice of two here is arbitrary.
+        end
+
+        line
+      end
+    else
+      # Earlier rubies do not support the two argument form of `caller`. This
+      # fallback is logically the same, but slower.
+      def self.first_non_rspec_line
+        caller.find { |line| line !~ LIB_REGEX }
+      end
+    end
+  end
+end

data/lib/rspec/mocks/configuration.rb

@@ -2,6 +2,25 @@ module RSpec
   module Mocks
     # Provides configuration options for rspec-mocks.
     class Configuration
+
+      def initialize
+        @yield_receiver_to_any_instance_implementation_blocks = false
+        @should_warn_about_any_instance_blocks = true
+      end
+
+      def yield_receiver_to_any_instance_implementation_blocks?
+        @yield_receiver_to_any_instance_implementation_blocks
+      end
+
+      def yield_receiver_to_any_instance_implementation_blocks=(arg)
+        @should_warn_about_any_instance_blocks = false
+        @yield_receiver_to_any_instance_implementation_blocks = arg
+      end
+
+      def should_warn_about_any_instance_blocks?
+        @should_warn_about_any_instance_blocks
+      end
+
       # Adds `stub` and `should_receive` to the given
       # modules or classes. This is usually only necessary
       # if you application uses some proxy classes that

data/lib/rspec/mocks/deprecation.rb

@@ -7,7 +7,15 @@ module RSpec
       def deprecate(deprecated, options={})
         message = "DEPRECATION: #{deprecated} is deprecated."
         message << " Use #{options[:replacement]} instead." if options[:replacement]
-        message << " Called from #{caller(0)[2]}."
+        message << " Called from #{CallerFilter.first_non_rspec_line}."
+        warn message
+      end
+
+      # @private
+      #
+      # Used internally to print deprecation warnings
+      def warn_deprecation(warning)
+        message = "\nDEPRECATION: #{warning}\n"
         warn message
       end
     end

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

@@ -0,0 +1,63 @@
+unless Proc.method_defined? :lambda?
+  module Backports
+    def self.alias_method_chain(mod, target, feature)
+      mod.class_eval do
+        # Strip out punctuation on predicates or bang methods since
+        # e.g. target?_without_feature is not a valid method name.
+        aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
+        yield(aliased_target, punctuation) if block_given?
+
+        with_method, without_method = "#{aliased_target}_with_#{feature}#{punctuation}", "#{aliased_target}_without_#{feature}#{punctuation}"
+
+        alias_method without_method, target
+        alias_method target, with_method
+
+        case
+          when public_method_defined?(without_method)
+            public target
+          when protected_method_defined?(without_method)
+            protected target
+          when private_method_defined?(without_method)
+            private target
+        end
+      end
+    end
+  end
+
+  class Proc
+    # Standard in Ruby 1.9. See official documentation[http://ruby-doc.org/core-1.9/classes/Proc.html]
+    def lambda?
+      !!__is_lambda__
+    end
+
+    attr_accessor :__is_lambda__
+    private :__is_lambda__
+    private :__is_lambda__=
+  end
+
+  class Method
+    def to_proc_with_lambda_tracking
+      proc = to_proc_without_lambda_tracking
+      proc.send :__is_lambda__=, true
+      proc
+    end
+    Backports.alias_method_chain self, :to_proc, :lambda_tracking
+  end
+
+  module Kernel
+    def lambda_with_lambda_tracking(&block)
+      l = lambda_without_lambda_tracking(&block)
+      l.send :__is_lambda__=, true unless block.send(:__is_lambda__) == false
+      l
+    end
+
+    def proc_with_lambda_tracking(&block)
+      l = proc_without_lambda_tracking(&block)
+      l.send :__is_lambda__=, block.send(:__is_lambda__) == true
+      l
+    end
+
+    Backports.alias_method_chain self, :lambda, :lambda_tracking
+    Backports.alias_method_chain self, :proc, :lambda_tracking
+  end
+end

data/lib/rspec/mocks/framework.rb

@@ -2,8 +2,10 @@
 # supports wrapping rspec's mocking functionality without invading every
 # object in the system.
 
+require 'rspec/mocks/caller_filter' unless defined?(::RSpec::CallerFilter)
 require 'rspec/mocks/deprecation'
 require 'rspec/mocks/extensions/instance_exec'
+require 'rspec/mocks/extensions/proc'
 require 'rspec/mocks/instance_method_stasher'
 require 'rspec/mocks/method_double'
 require 'rspec/mocks/argument_matchers'

data/lib/rspec/mocks/matchers/receive.rb

@@ -6,14 +6,7 @@ module RSpec
           @message                 = message
           @block                   = block
           @recorded_customizations = []
-
-          # MRI, JRuby and RBX report the caller inconsistently; MRI
-          # reports an extra "in `new'" line in the backtrace that the
-          # others do not include. The safest way to find the right
-          # line is to search for the first line BEFORE rspec/mocks/syntax.rb.
-          @backtrace_line          = caller.find do |line|
-            !line.split(':').first.end_with?('rspec/mocks/syntax.rb')
-          end
+          @backtrace_line          = CallerFilter.first_non_rspec_line
         end
 
         def setup_expectation(subject, &block)
@@ -49,7 +42,7 @@ module RSpec
         MessageExpectation.public_instance_methods(false).each do |method|
           next if method_defined?(method)
 
-          class_eval(<<-RUBY)
+          class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
             def #{method}(*args, &block)
               @recorded_customizations << Customization.new(#{method.inspect}, args, block)
               self

data/lib/rspec/mocks/message_expectation.rb

@@ -4,7 +4,9 @@ module RSpec
     class MessageExpectation
       # @private
       attr_accessor :error_generator, :implementation
+      attr_accessor :warn_about_yielding_receiver_to_implementation_block
       attr_reader :message
+      attr_reader :orig_object
       attr_writer :expected_received_count, :expected_from, :argument_list_matcher
       protected :expected_received_count=, :expected_from=, :error_generator, :error_generator=, :implementation=
 
@@ -15,6 +17,9 @@ module RSpec
         @error_generator.opts = opts
         @expected_from = expected_from
         @method_double = method_double
+        @have_warned_about_yielding_receiver = false
+        @orig_object = @method_double.object
+        @warn_about_yielding_receiver_to_implementation_block = false
         @message = @method_double.method_name
         @actual_received_count = 0
         @expected_received_count = expected_received_count
@@ -24,6 +29,7 @@ module RSpec
         @args_to_yield = []
         @failed_fast = nil
         @eval_context = nil
+        @yield_receiver_to_implementation_block = false
 
         @implementation = Implementation.new
         self.inner_implementation_action = implementation_block
@@ -87,6 +93,15 @@ module RSpec
         nil
       end
 
+      def and_yield_receiver_to_implementation
+        @yield_receiver_to_implementation_block = true
+        self
+      end
+
+      def yield_receiver_to_implementation_block?
+        @yield_receiver_to_implementation_block
+      end
+
       # Tells the object to delegate to the original unmodified method
       # when it receives the message.
       #
@@ -103,6 +118,7 @@ module RSpec
           @error_generator.raise_only_valid_on_a_partial_mock(:and_call_original)
         else
           @implementation = AndCallOriginalImplementation.new(@method_double.original_method)
+          @yield_receiver_to_implementation_block = false
         end
       end
 
@@ -171,6 +187,10 @@ module RSpec
 
       # @private
       def invoke(parent_stub, *args, &block)
+        if yield_receiver_to_implementation_block?
+          args.unshift(orig_object)
+        end
+
         if negative? || ((@exactly || @at_most) && (@actual_received_count == @expected_received_count))
           @actual_received_count += 1
           @failed_fast = true
@@ -218,6 +238,28 @@ module RSpec
         Kernel::raise error
       end
 
+      # @private
+      def display_any_instance_deprecation_warning_if_necessary(block)
+        if passing_an_additional_arg_would_break_block?(block) &&
+           should_display_any_instance_deprecation_warning
+          line = if block.respond_to?(:source_location)
+                   block.source_location.join(':')
+                 else
+                   @any_instance_source_line
+                 end
+
+          display_any_instance_deprecation_warning(line)
+          @have_warned_about_yielding_receiver = true
+        end
+      end
+
+      # @private
+      def passing_an_additional_arg_would_break_block?(block)
+        return false unless block
+        return true if block.lambda?
+        !block.arity.zero?
+      end
+
       # @private
       def expected_messages_received?
         ignoring_args? || matches_exact_count? || matches_at_least_count? || matches_at_most_count?
@@ -302,7 +344,15 @@ module RSpec
       #   cart.add(Book.new(:isbn => 1934356379))
       #   # => passes
       def with(*args, &block)
-        self.inner_implementation_action = block if block_given? unless args.empty?
+        if block_given?
+          if args.empty?
+            RSpec.deprecate "Using the return value of a `with` block to validate passed arguments rather than as an implementation",
+              :replacement => "the `satisfy` matcher, a custom matcher or validate the arguments in an implementation block"
+          else
+            self.inner_implementation_action = block
+          end
+        end
+
         @argument_list_matcher = ArgumentListMatcher.new(*args, &block)
         self
       end
@@ -430,6 +480,38 @@ module RSpec
         @actual_received_count += 1
       end
 
+      def warn_about_receiver_passing(any_instance_source_line)
+        @any_instance_source_line = any_instance_source_line
+        @warn_about_yielding_receiver_to_implementation_block = true
+      end
+
+      def should_display_any_instance_deprecation_warning
+        warn_about_yielding_receiver_to_implementation_block &&
+          !@have_warned_about_yielding_receiver
+      end
+
+      def display_any_instance_deprecation_warning(block_source_line)
+        RSpec.warn_deprecation(<<MSG
+In RSpec 3, `any_instance` implementation blocks will be yielded the receiving
+instance as the first block argument to allow the implementation block to use
+the state of the receiver.  To maintain compatibility with RSpec 3 you need to
+either set rspec-mocks' `yield_receiver_to_any_instance_implementation_blocks`
+config option to `false` OR set it to `true` and update your `any_instance`
+implementation blocks to account for the first block argument being the receiving instance.
+
+To set the config option, use a snippet like:
+
+RSpec.configure do |rspec|
+  rspec.mock_with :rspec do |mocks|
+    mocks.yield_receiver_to_any_instance_implementation_blocks = false
+  end
+end
+
+Your `any_instance` implementation block is declared at: #{block_source_line}
+MSG
+)
+      end
+
     private
 
       def failed_fast?
@@ -452,6 +534,7 @@ module RSpec
       end
 
       def inner_implementation_action=(action)
+        display_any_instance_deprecation_warning_if_necessary(action)
         implementation.inner_action = action if action
       end
 
@@ -516,31 +599,18 @@ module RSpec
 
       def call(*args, &block)
         actions.map do |action|
+          if action.respond_to?(:lambda?) && action.lambda? && action.arity != args.size
+            RSpec.deprecate "stubbing implementations with mismatched arity",
+              :call_site => CallerFilter.first_non_rspec_line
+          end
           action.call(*arg_slice_for(args, action.arity), &block)
         end.last
       end
 
-      if RUBY_VERSION.to_f > 1.8
-        def arg_slice_for(args, arity)
-          if arity >= 0
-            args.slice(0, arity)
-          else
-            args
-          end
-        end
-      else
-        # 1.8.7's `arity` lies somtimes:
-        # Given:
-        #   def print_arity(&b) puts b.arity; end
-        #
-        # This prints 1:
-        #   print_arity { |a, b, c, &bl| }
-        #
-        # But this prints 3:
-        #   print_arity { |a, b, c| }
-        #
-        # Given that it lies, we can't trust it and we don't slice the args.
-        def arg_slice_for(args, arity)
+      def arg_slice_for(args, arity)
+        if arity >= 0
+          args.slice(0, arity)
+        else
           args
         end
       end