rspec-expectations 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d5dd8b33952790fa1f2558ff0e899938b2e3cab
-  data.tar.gz: b54c4711b21c2865f50be1a44fdf1b52b8cb0b36
+  metadata.gz: c64b53ac0865670b12407e85b12dfef41a915675
+  data.tar.gz: 72290b7d0bfa0774d0a75ba08c9c4f87b3684e9b
 SHA512:
-  metadata.gz: f7fa51873f771382abdf2731b0862510514a8110985b24ca0e5f33ab2e93cd81e06481c8f82d83e806daa0cd2d6325db62e04290274be6c252c5eaf8599dcd70
-  data.tar.gz: 4823b182ad808801c9a0aa9e8aa97cff18221e0e8bb7c77241fb807af96fa5fb6f68ad026a68338d2f0122bc479ee78cf650c5d2dfdfc034439983175973302f
+  metadata.gz: 9c98a819df168dca33a9a74275a8b8034d7670c22e9bf40cfa4c4e483fe0c78d1aba80ff6a846024153b8e31e60fcecfd3b8473ff12172bb58801cea842c921f
+  data.tar.gz: 1901f329e2f9c3023e25a2bd198c0a5aa89efbbf40e33dbd25e31d56c5584bcd30472878fb07a19fa9ca24d743c7f6c60744081c76ab4aeb0081f73efaae5207

data/Changelog.md

@@ -1,5 +1,23 @@
-### 3.8 Development
-[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.7.0...master)
+### 3.8.0 / 2018-08-04
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.7.0...v3.8.0)
+
+Enhancements:
+
+* Improve failure message of `change(receiver, :message)` by including the
+  receiver as `SomeClass#some_message`. (Tomohiro Hashidate, #1005)
+* Improve `change` matcher so that it can correctly detect changes in
+  deeply nested mutable objects (such as arrays-of-hashes-of-arrays).
+  The improved logic uses the before/after `hash` value to see if the
+  object has been mutated, rather than shallow duping the object.
+  (Myron Marston, #1034)
+* Improve `include` matcher so that pseudo-hash objects (e.g. objects
+  that decorate a hash using a `SimpleDelegator` or similar) are treated
+  as a hash, as long as they implement `to_hash`. (Pablo Brasero, #1012)
+* Add `max_formatted_output_length=` to configuration, allowing changing
+  the length at which we truncate large output strings.
+  (Sam Phippen #951, Benoit Tigeot #1056)
+* Improve error message when passing a matcher that doesn't support block
+  expectations to a block based `expect`. (@nicktime, #1066)
 
 ### 3.7.0 / 2017-10-17
 [Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.6.0...v3.7.0)

data/README.md

@@ -20,7 +20,7 @@ RSpec repos as well. Add the following to your `Gemfile`:
 
 ```ruby
 %w[rspec-core rspec-expectations rspec-mocks rspec-support].each do |lib|
-  gem lib, :git => "git://github.com/rspec/#{lib}.git", :branch => 'master'
+  gem lib, :git => "https://github.com/rspec/#{lib}.git", :branch => 'master'
 end
 ```
 

data/lib/rspec/expectations/block_snippet_extractor.rb

@@ -1,7 +1,7 @@
 module RSpec
   module Expectations
     # @private
-    class BlockSnippetExtractor # rubocop:disable Style/ClassLength
+    class BlockSnippetExtractor # rubocop:disable Metrics/ClassLength
       # rubocop should properly handle `Struct.new {}` as an inner class definition.
 
       attr_reader :proc, :method_name

data/lib/rspec/expectations/configuration.rb

@@ -56,6 +56,20 @@ module RSpec
         end
       end
 
+      # Configures the maximum character length that RSpec will print while
+      # formatting an object. You can set length to nil to prevent RSpec from
+      # doing truncation.
+      # @param [Fixnum] length the number of characters to limit the formatted output to.
+      # @example
+      #   RSpec.configure do |rspec|
+      #     rspec.expect_with :rspec do |c|
+      #       c.max_formatted_output_length = 200
+      #     end
+      #   end
+      def max_formatted_output_length=(length)
+        RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = length
+      end
+
       # The list of configured syntaxes.
       # @return [Array<Symbol>] the list of configured syntaxes.
       # @example

data/lib/rspec/expectations/expectation_target.rb

@@ -112,7 +112,7 @@ module RSpec
       def enforce_block_expectation(matcher)
         return if supports_block_expectations?(matcher)
 
-        raise ExpectationNotMetError, "You must pass an argument rather than a block to use the provided " \
+        raise ExpectationNotMetError, "You must pass an argument rather than a block to `expect` to use the provided " \
           "matcher (#{RSpec::Support::ObjectFormatter.format(matcher)}), or the matcher must implement " \
           "`supports_block_expectations?`."
       end

data/lib/rspec/expectations/minitest_integration.rb

@@ -53,6 +53,6 @@ module RSpec
   module Expectations
     remove_const :ExpectationNotMetError
     # Exception raised when an expectation fails.
-    ExpectationNotMetError = ::Minitest::Assertion
+    const_set :ExpectationNotMetError, ::Minitest::Assertion
   end
 end

data/lib/rspec/expectations/syntax.rb

@@ -106,7 +106,7 @@ if defined?(BasicObject)
   # that this syntax does not always play nice with delegate/proxy objects.
   # We recommend you use the non-monkeypatching `:expect` syntax instead.
   class BasicObject
-    # @method should
+    # @method should(matcher, message)
     # Passes if `matcher` returns true.  Available on every `Object`.
     # @example
     #   actual.should eq expected
@@ -118,7 +118,7 @@ if defined?(BasicObject)
     # @note This is only available when you have enabled the `:should` syntax.
     # @see RSpec::Matchers
 
-    # @method should_not
+    # @method should_not(matcher, message)
     # Passes if `matcher` returns false.  Available on every `Object`.
     # @example
     #   actual.should_not eq expected

data/lib/rspec/expectations/version.rb

@@ -2,7 +2,7 @@ module RSpec
   module Expectations
     # @private
     module Version
-      STRING = '3.7.0'
+      STRING = '3.8.0'
     end
   end
 end

data/lib/rspec/matchers.rb

@@ -480,7 +480,10 @@ module RSpec
     # == Notes
     #
     # Evaluates `receiver.message` or `block` before and after it
-    # evaluates the block passed to `expect`.
+    # evaluates the block passed to `expect`. If the value is the same
+    # object, its before/after `hash` value is used to see if it has changed.
+    # Therefore, your object needs to properly implement `hash` to work correctly
+    # with this matcher.
     #
     # `expect( ... ).not_to change` supports the form that specifies `from`
     # (which specifies what you expect the starting, unchanged value to be)

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

@@ -43,16 +43,13 @@ module RSpec
 
         # @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
@@ -92,6 +89,18 @@ module RSpec
           @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
           raise SyntaxError, "Block not received by the `change` matcher. " \
           "Perhaps you want to use `{ ... }` instead of do/end?"
@@ -99,12 +108,12 @@ 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} " \
+          "did change from #{@actual_before_description} " \
           "to #{description_of change_details.actual_after}"
         end
       end
@@ -129,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
@@ -173,10 +180,7 @@ 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
@@ -187,7 +191,7 @@ module RSpec
         # @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
@@ -199,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?
@@ -210,7 +223,7 @@ module RSpec
         def before_value_failure
           "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
@@ -226,7 +239,7 @@ module RSpec
 
         def did_change_failure
           "expected #{@change_details.value_representation} not to have changed, but " \
-          "did change from #{description_of @change_details.actual_before} " \
+          "did change from #{@actual_before_description} " \
           "to #{description_of @change_details.actual_after}"
         end
 
@@ -260,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
 
@@ -312,8 +322,20 @@ 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 :actual_before, :actual_after
+        attr_reader :actual_after
 
         def initialize(matcher_name, receiver=nil, message=nil, &block)
           if receiver && !message
@@ -334,7 +356,7 @@ module RSpec
         def value_representation
           @value_representation ||=
             if @message
-              "##{@message}"
+              "`#{message_notation(@receiver, @message)}`"
             elsif (value_block_snippet = extract_value_block_snippet)
               "`#{value_block_snippet}`"
             else
@@ -344,12 +366,29 @@ module RSpec
 
         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
+          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.
+          @actual_before != @actual_after || @before_hash != @actual_after.hash
         end
 
         def actual_delta
@@ -359,15 +398,15 @@ module RSpec
       private
 
         def evaluate_value_proc
-          value_proc = @value_proc || lambda { @receiver.__send__(@message) }
+          @value_proc ? @value_proc.call : @receiver.__send__(@message)
+        end
 
-          case val = value_proc.call
-          when IO # enumerable, but we don't want to dup it.
-            val
-          when Enumerable, String
-            val.dup
+        def message_notation(receiver, message)
+          case receiver
+          when Module
+            "#{receiver}.#{message}"
           else
-            val
+            "#{Support.class_of(receiver)}##{message}"
           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

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

@@ -89,7 +89,7 @@ module RSpec
           elsif actual.respond_to?(:to_a) && !to_a_disallowed?(actual)
             @actual = actual.to_a
           else
-            return false
+            false
           end
         end
 
@@ -176,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)

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

@@ -77,7 +77,7 @@ module RSpec
         end
 
         def method_description
-          @method_name.to_s.gsub('_', ' ')
+          @method_name.to_s.tr('_', ' ')
         end
 
         def args_description

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

@@ -15,12 +15,14 @@ module RSpec
         # @api private
         # @return [Boolean]
         def matches?(actual)
+          actual = actual.to_hash if actual.respond_to?(:to_hash)
           perform_match(actual) { |v| v }
         end
 
         # @api private
         # @return [Boolean]
         def does_not_match?(actual)
+          actual = actual.to_hash if actual.respond_to?(:to_hash)
           perform_match(actual) { |v| !v }
         end
 

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

@@ -151,7 +151,7 @@ module RSpec
                      @expected_keywords.map(&:inspect).join(' and ')
                    else
                      "#{@expected_keywords[0...-1].map(&:inspect).join(', ')}, and #{@expected_keywords.last.inspect}"
-          end
+                   end
 
           "keyword#{@expected_keywords.count == 1 ? '' : 's'} #{kw_str}"
         end

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

@@ -34,7 +34,7 @@ module RSpec
           "expected #{actual_formatted} not to #{description}"
         end
 
-      private # rubocop:disable Lint/UselessAccessModifier
+      private
 
         if RSpec::Support::RubyFeatures.ripper_supported?
           def block_representation

data/lib/rspec/matchers/composable.rb

@@ -156,10 +156,12 @@ module RSpec
       # Wraps an item in order to surface its `description` via `inspect`.
       # @api private
       DescribableItem = Struct.new(:item) do
+        # Inspectable version of the item description
         def inspect
           "(#{item.description})"
         end
 
+        # A pretty printed version of the item description.
         def pretty_print(pp)
           pp.text "(#{item.description})"
         end

data/lib/rspec/matchers/english_phrasing.rb

@@ -44,14 +44,14 @@ module RSpec
         # So it appears that `Array` can trigger that (e.g. by calling `to_a` on the passed object?)
         # So here we replace `Kernel#Array` with our own warning-free implementation for 1.8.7.
         # @private
-        # rubocop:disable Style/MethodName
+        # rubocop:disable Naming/MethodName
         def self.Array(obj)
           case obj
           when Array then obj
           else [obj]
           end
         end
-        # rubocop:enable Style/MethodName
+        # rubocop:enable Naming/MethodName
       end
     end
   end

data/lib/rspec/matchers/generated_descriptions.rb

@@ -21,8 +21,7 @@ module RSpec
       "#{last_expectation_handler.verb} #{last_description}"
     end
 
-  private
-
+    # @private
     def self.last_description
       last_matcher.respond_to?(:description) ? last_matcher.description : <<-MESSAGE
 When you call a matcher in an example without a String, like this:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-expectations
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - Steven Baker
@@ -45,7 +45,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2018-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-support
@@ -53,14 +53,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -218,9 +218,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: rspec-expectations-3.7.0
+summary: rspec-expectations-3.8.0
 test_files: []
-has_rdoc: 

metadata.gz.sig

@@ -1,5 +1,3 @@
-��+#i*R�S��
-�p^6w��l&�?�G&���h�ϏO�e�$�H�c�x��rv'D�*Ib��[(�^+k�}�CJs��	NB��+G�)��!(&�B�
-f�}�:�Yf��Y��k�\��y=>���Rx��w��'n'�B0\���M|s9�#m�\p�F��{ţ��I��Mm�Of��n�&ȵWGh��O
-/�$!>���878�8�f6���bDGȝI�9�����vZ�_ t��,(
��t$�N�ޔ�.�?�24�5�FD�ǔV�O&��E��^��F�]��V(��W}�y�d(CUw�����Rr8qƤ0�vǣ2髜�:V���-p6q	�h��P#��7�[�5�W͓-�yIl�ػ���'cS<Av��By;���(1��a�I�䝰εY�*����X�R}�v5ڵ�p��o3Q�u����8%:>U���Q��QLܡ���%i��D������nK���o�����@��O_@�k7x}
-=
+�q�/F
+Q3m�_᳼��m0y�v�y%g��yW��_Nk�—e3�8r/��#�
+V�����_�ێ�8����DX[��zwm�&Zg%���?�`=�5������V�h�m�R+,6�H��~c�0I�d�1v�G��h�H����\��}����hr*�N�o֓C����^�OW]v�};W�-�}>�_G�y1��<X������1�j 
q�;�(��Z{�ܦ��d^z��\��/q�[�� P��,�܅7�G