rspec-expectations 3.5.0 → 3.9.0

data/lib/rspec/matchers/built_in/be_instance_of.rb

@@ -14,7 +14,11 @@ module RSpec
       private
 
         def match(expected, actual)
-          actual.instance_of? expected
+          actual.instance_of?(expected)
+        rescue NoMethodError
+          raise ::ArgumentError, "The #{matcher_name} matcher requires that " \
+                                 "the actual object responds to #instance_of? method " \
+                                 "but a `NoMethodError` was encountered instead."
         end
       end
     end

data/lib/rspec/matchers/built_in/be_kind_of.rb

@@ -8,7 +8,11 @@ module RSpec
       private
 
         def match(expected, actual)
-          actual.kind_of? expected
+          actual.kind_of?(expected)
+        rescue NoMethodError
+          raise ::ArgumentError, "The #{matcher_name} matcher requires that " \
+                                 "the actual object responds to #kind_of? method " \
+                                 "but a `NoMethodError` was encountered instead."
         end
       end
     end

data/lib/rspec/matchers/built_in/change.rb

@@ -8,7 +8,7 @@ module RSpec
         # @api public
         # Specifies the delta of the expected change.
         def by(expected_delta)
-          ChangeRelatively.new(@change_details, expected_delta, :by) do |actual_delta|
+          ChangeRelatively.new(change_details, expected_delta, :by) do |actual_delta|
             values_match?(expected_delta, actual_delta)
           end
         end
@@ -16,7 +16,7 @@ module RSpec
         # @api public
         # Specifies a minimum delta of the expected change.
         def by_at_least(minimum)
-          ChangeRelatively.new(@change_details, minimum, :by_at_least) do |actual_delta|
+          ChangeRelatively.new(change_details, minimum, :by_at_least) do |actual_delta|
             actual_delta >= minimum
           end
         end
@@ -24,7 +24,7 @@ module RSpec
         # @api public
         # Specifies a maximum delta of the expected change.
         def by_at_most(maximum)
-          ChangeRelatively.new(@change_details, maximum, :by_at_most) do |actual_delta|
+          ChangeRelatively.new(change_details, maximum, :by_at_most) do |actual_delta|
             actual_delta <= maximum
           end
         end
@@ -32,47 +32,44 @@ module RSpec
         # @api public
         # Specifies the new value you expect.
         def to(value)
-          ChangeToValue.new(@change_details, value)
+          ChangeToValue.new(change_details, value)
         end
 
         # @api public
         # Specifies the original value.
         def from(value)
-          ChangeFromValue.new(@change_details, value)
+          ChangeFromValue.new(change_details, value)
         end
 
         # @private
         def matches?(event_proc)
-          @event_proc = event_proc
-          return false unless Proc === event_proc
           raise_block_syntax_error if block_given?
-          @change_details.perform_change(event_proc)
-          @change_details.changed?
+          perform_change(event_proc) && change_details.changed?
         end
 
         def does_not_match?(event_proc)
           raise_block_syntax_error if block_given?
-          !matches?(event_proc) && Proc === event_proc
+          perform_change(event_proc) && !change_details.changed?
         end
 
         # @api private
         # @return [String]
         def failure_message
-          "expected #{@change_details.message} to have changed, " \
+          "expected #{change_details.value_representation} to have changed, " \
           "but #{positive_failure_reason}"
         end
 
         # @api private
         # @return [String]
         def failure_message_when_negated
-          "expected #{@change_details.message} not to have changed, " \
+          "expected #{change_details.value_representation} not to have changed, " \
           "but #{negative_failure_reason}"
         end
 
         # @api private
         # @return [String]
         def description
-          "change #{@change_details.message}"
+          "change #{change_details.value_representation}"
         end
 
         # @private
@@ -83,7 +80,25 @@ module RSpec
       private
 
         def initialize(receiver=nil, message=nil, &block)
-          @change_details = ChangeDetails.new(receiver, message, &block)
+          @receiver = receiver
+          @message = message
+          @block = block
+        end
+
+        def change_details
+          @change_details ||= ChangeDetails.new(matcher_name, @receiver, @message, &@block)
+        end
+
+        def perform_change(event_proc)
+          @event_proc = event_proc
+          change_details.perform_change(event_proc) do |actual_before|
+            # pre-compute values derived from the `before` value before the
+            # mutation is applied, in case the specified mutation is mutation
+            # of a single object (rather than a changing what object a method
+            # returns). We need to cache these values before the `before` value
+            # they are based on potentially gets mutated.
+            @actual_before_description = description_of(actual_before)
+          end
         end
 
         def raise_block_syntax_error
@@ -93,13 +108,13 @@ module RSpec
 
         def positive_failure_reason
           return "was not given a block" unless Proc === @event_proc
-          "is still #{description_of @change_details.actual_before}"
+          "is still #{@actual_before_description}"
         end
 
         def negative_failure_reason
           return "was not given a block" unless Proc === @event_proc
-          "did change from #{description_of @change_details.actual_before} " \
-          "to #{description_of @change_details.actual_after}"
+          "did change from #{@actual_before_description} " \
+          "to #{description_of change_details.actual_after}"
         end
       end
 
@@ -115,7 +130,7 @@ module RSpec
 
         # @private
         def failure_message
-          "expected #{@change_details.message} to have changed " \
+          "expected #{@change_details.value_representation} to have changed " \
           "#{@relativity.to_s.tr('_', ' ')} " \
           "#{description_of @expected_delta}, but #{failure_reason}"
         end
@@ -123,9 +138,7 @@ module RSpec
         # @private
         def matches?(event_proc)
           @event_proc = event_proc
-          return false unless Proc === event_proc
-          @change_details.perform_change(event_proc)
-          @comparer.call(@change_details.actual_delta)
+          @change_details.perform_change(event_proc) && @comparer.call(@change_details.actual_delta)
         end
 
         # @private
@@ -136,7 +149,7 @@ module RSpec
 
         # @private
         def description
-          "change #{@change_details.message} " \
+          "change #{@change_details.value_representation} " \
           "#{@relativity.to_s.tr('_', ' ')} #{description_of @expected_delta}"
         end
 
@@ -167,21 +180,18 @@ module RSpec
 
         # @private
         def matches?(event_proc)
-          @event_proc = event_proc
-          return false unless Proc === event_proc
-          @change_details.perform_change(event_proc)
-          @change_details.changed? && matches_before? && matches_after?
+          perform_change(event_proc) && @change_details.changed? && @matches_before && matches_after?
         end
 
         # @private
         def description
-          "change #{@change_details.message} #{change_description}"
+          "change #{@change_details.value_representation} #{change_description}"
         end
 
         # @private
         def failure_message
           return not_given_a_block_failure unless Proc === @event_proc
-          return before_value_failure      unless matches_before?
+          return before_value_failure      unless @matches_before
           return did_not_change_failure    unless @change_details.changed?
           after_value_failure
         end
@@ -193,8 +203,17 @@ module RSpec
 
       private
 
-        def matches_before?
-          values_match?(@expected_before, @change_details.actual_before)
+        def perform_change(event_proc)
+          @event_proc = event_proc
+          @change_details.perform_change(event_proc) do |actual_before|
+            # pre-compute values derived from the `before` value before the
+            # mutation is applied, in case the specified mutation is mutation
+            # of a single object (rather than a changing what object a method
+            # returns). We need to cache these values before the `before` value
+            # they are based on potentially gets mutated.
+            @matches_before = values_match?(@expected_before, actual_before)
+            @actual_before_description = description_of(actual_before)
+          end
         end
 
         def matches_after?
@@ -202,30 +221,30 @@ module RSpec
         end
 
         def before_value_failure
-          "expected #{@change_details.message} " \
+          "expected #{@change_details.value_representation} " \
           "to have initially been #{description_of @expected_before}, " \
-          "but was #{description_of @change_details.actual_before}"
+          "but was #{@actual_before_description}"
         end
 
         def after_value_failure
-          "expected #{@change_details.message} " \
+          "expected #{@change_details.value_representation} " \
           "to have changed to #{description_of @expected_after}, " \
           "but is now #{description_of @change_details.actual_after}"
         end
 
         def did_not_change_failure
-          "expected #{@change_details.message} " \
+          "expected #{@change_details.value_representation} " \
           "to have changed #{change_description}, but did not change"
         end
 
         def did_change_failure
-          "expected #{@change_details.message} not to have changed, but " \
-          "did change from #{description_of @change_details.actual_before} " \
+          "expected #{@change_details.value_representation} not to have changed, but " \
+          "did change from #{@actual_before_description} " \
           "to #{description_of @change_details.actual_after}"
         end
 
         def not_given_a_block_failure
-          "expected #{@change_details.message} to have changed " \
+          "expected #{@change_details.value_representation} to have changed " \
           "#{change_description}, but was not given a block"
         end
       end
@@ -254,16 +273,13 @@ module RSpec
               "is not supported"
           end
 
-          @event_proc = event_proc
-          return false unless Proc === event_proc
-          @change_details.perform_change(event_proc)
-          !@change_details.changed? && matches_before?
+          perform_change(event_proc) && !@change_details.changed? && @matches_before
         end
 
         # @private
         def failure_message_when_negated
           return not_given_a_block_failure unless Proc === @event_proc
-          return before_value_failure unless matches_before?
+          return before_value_failure unless @matches_before
           did_change_failure
         end
 
@@ -306,10 +322,22 @@ module RSpec
 
       # @private
       # Encapsulates the details of the before/after values.
+      #
+      # Note that this class exposes the `actual_after` value, to allow the
+      # matchers above to derive failure messages, etc from the value on demand
+      # as needed, but it intentionally does _not_ expose the `actual_before`
+      # value. Some usages of the `change` matcher mutate a specific object
+      # returned by the value proc, which means that failure message snippets,
+      # etc, which are derived from the `before` value may not be accurate if
+      # they are lazily computed as needed. We must pre-compute them before
+      # applying the change in the `expect` block. To ensure that all `change`
+      # matchers do that properly, we do not expose the `actual_before` value.
+      # Instead, matchers must pass a block to `perform_change`, which yields
+      # the `actual_before` value before applying the change.
       class ChangeDetails
-        attr_reader :message, :actual_before, :actual_after
+        attr_reader :actual_after
 
-        def initialize(receiver=nil, message=nil, &block)
+        def initialize(matcher_name, receiver=nil, message=nil, &block)
           if receiver && !message
             raise(
               ArgumentError,
@@ -318,18 +346,51 @@ module RSpec
               "You passed an object but no message."
             )
           end
-          @message    = message ? "##{message}" : "result"
-          @value_proc = block || lambda { receiver.__send__(message) }
+
+          @matcher_name = matcher_name
+          @receiver = receiver
+          @message = message
+          @value_proc = block
+        end
+
+        def value_representation
+          @value_representation ||=
+            if @message
+              "`#{message_notation(@receiver, @message)}`"
+            elsif (value_block_snippet = extract_value_block_snippet)
+              "`#{value_block_snippet}`"
+            else
+              'result'
+            end
         end
 
         def perform_change(event_proc)
           @actual_before = evaluate_value_proc
+          @before_hash = @actual_before.hash
+          yield @actual_before if block_given?
+
+          return false unless Proc === event_proc
           event_proc.call
+
           @actual_after = evaluate_value_proc
+          @actual_hash = @actual_after.hash
+          true
         end
 
         def changed?
-          @actual_before != @actual_after
+          # Consider it changed if either:
+          #
+          # - The before/after values are unequal
+          # - The before/after values have different hash values
+          #
+          # The latter case specifically handles the case when the value proc
+          # returns the exact same object, but it has been mutated.
+          #
+          # Note that it is not sufficient to only check the hashes; it is
+          # possible for two values to be unequal (and of different classes)
+          # but to return the same hash value. Also, some objects may change
+          # their hash after being compared with `==`/`!=`.
+          @actual_before != @actual_after || @before_hash != @actual_hash
         end
 
         def actual_delta
@@ -339,13 +400,26 @@ module RSpec
       private
 
         def evaluate_value_proc
-          case val = @value_proc.call
-          when IO # enumerable, but we don't want to dup it.
-            val
-          when Enumerable, String
-            val.dup
+          @value_proc ? @value_proc.call : @receiver.__send__(@message)
+        end
+
+        def message_notation(receiver, message)
+          case receiver
+          when Module
+            "#{receiver}.#{message}"
           else
-            val
+            "#{Support.class_of(receiver)}##{message}"
+          end
+        end
+
+        if RSpec::Support::RubyFeatures.ripper_supported?
+          def extract_value_block_snippet
+            return nil unless @value_proc
+            Expectations::BlockSnippetExtractor.try_extracting_single_line_body_of(@value_proc, @matcher_name)
+          end
+        else
+          def extract_value_block_snippet
+            nil
           end
         end
       end

data/lib/rspec/matchers/built_in/compound.rb

@@ -3,7 +3,6 @@ module RSpec
     module BuiltIn
       # @api private
       # Base class for `and` and `or` compound matchers.
-      # rubocop:disable ClassLength
       class Compound < BaseMatcher
         # @private
         attr_reader :matcher_1, :matcher_2, :evaluator
@@ -155,7 +154,12 @@ module RSpec
           end
 
           def matcher_matches?(matcher)
-            @match_results.fetch(matcher)
+            @match_results.fetch(matcher) do
+              raise ArgumentError, "Your #{matcher.description} has no match " \
+               "results, this can occur when an unexpected call stack or " \
+               "local jump occurs. Prehaps one of your matchers needs to " \
+               "declare `expects_call_stack_jump?` as `true`?"
+            end
           end
 
         private

data/lib/rspec/matchers/built_in/contain_exactly.rb

@@ -1,6 +1,7 @@
 module RSpec
   module Matchers
     module BuiltIn
+      # rubocop:disable ClassLength
       # @api private
       # Provides the implementation for `contain_exactly` and `match_array`.
       # Not intended to be instantiated directly.
@@ -85,10 +86,10 @@ module RSpec
         def convert_actual_to_an_array
           if actual.respond_to?(:to_ary)
             @actual = actual.to_ary
-          elsif should_enumerate?(actual) && actual.respond_to?(:to_a)
+          elsif actual.respond_to?(:to_a) && !to_a_disallowed?(actual)
             @actual = actual.to_a
           else
-            return false
+            false
           end
         end
 
@@ -98,6 +99,19 @@ module RSpec
           array
         end
 
+        if RUBY_VERSION == "1.8.7"
+          def to_a_disallowed?(object)
+            case object
+            when NilClass, String then true
+            else Kernel == RSpec::Support.method_handle_for(object, :to_a).owner
+            end
+          end
+        else
+          def to_a_disallowed?(object)
+            NilClass === object
+          end
+        end
+
         def missing_items
           @missing_items ||= best_solution.unmatched_expected_indexes.map do |index|
             expected[index]
@@ -162,6 +176,7 @@ module RSpec
         #
         # @private
         class PairingsMaximizer
+          # @private
           Solution = Struct.new(:unmatched_expected_indexes,     :unmatched_actual_indexes,
                                 :indeterminate_expected_indexes, :indeterminate_actual_indexes) do
             def worse_than?(other)
@@ -281,6 +296,7 @@ module RSpec
           end
         end
       end
+      # rubocop:enable ClassLength
     end
   end
 end