rspec-expectations 3.12.3 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d167a03fcf6e4519b628fefcf03b644e6436e1f6769058d84431fab3181e5119
-  data.tar.gz: dccb3d8b5ed822e523989e59e897085584173d65a503be30166b9d14bba675ef
+  metadata.gz: f09f6ee084c32b2e2090849e672c3f71479b002183e0a3731ee6dd72c08352bf
+  data.tar.gz: 997ea963ec0460e393ac82075843e67aaf47513d9de082c88c083ad38da49a6d
 SHA512:
-  metadata.gz: dc027c3d982da4f60e13924ef494fe4df964ee64ccd405eaf69a522494e23d394d0560dfa32c2007a8f43831118ad20df6480ed5692dbe70b389dfcc724e7266
-  data.tar.gz: 61e1c4f7ce7514869e63d24e7eb3270861ea4ad6343c34127b04f757bd80009dd599ae94be25c925b1de265fb4dc5a68f9619b9e3293de46b4aabd0cd1595dae
+  metadata.gz: 58cb3644c01f1771f2109faf971acba2bdc04c6e528ff68a55765ea850666ab27bec8ffcaf39e23b72b194f936e09de263136b5ac8cbc2cbc3d51d7e2d1dddee
+  data.tar.gz: 73204c1e6f84100a10e27f78ea853e1282ca26daf39927dd5a72f3c8294ff0555ea49ca01fcf5626faedc9af972a56f8641a7496e765eedd7936b647dcb28b5a

data/Changelog.md

@@ -1,5 +1,21 @@
 ### Development
-[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.12.3...3-12-maintenance)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.12.3...main)
+
+### 3.13.0 / 2024-02-04
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.12.4...v3.13.0)
+
+Enhancements:
+
+* Update `eq` and `eql` matchers to better highlight difference in string encoding.
+  (Alan Foster, #1425)
+
+### 3.12.4 / 2024-02-04
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.12.3...v3.12.4)
+
+Bug Fixes:
+
+* Fix the diff for redefined `actual` and reassigned `@actual` in compound
+  expectations failure messages. (Phil Pirozhkov, #1440)
 
 ### 3.12.3 / 2023-04-20
 [Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.12.2...v3.12.3)

data/lib/rspec/expectations/fail_with.rb

@@ -30,7 +30,7 @@ module RSpec
                                "appropriate failure_message[_when_negated] method to return a string?"
         end
 
-        message = ::RSpec::Matchers::ExpectedsForMultipleDiffs.from(expected).message_with_diff(message, differ, actual)
+        message = ::RSpec::Matchers::MultiMatcherDiff.from(expected, actual).message_with_diff(message, differ)
 
         RSpec::Support.notify_failure(RSpec::Expectations::ExpectationNotMetError.new message)
       end

data/lib/rspec/expectations/version.rb

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

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

@@ -161,6 +161,47 @@ module RSpec
 
         include HashFormatting
 
+        # @private
+        module StringEncodingFormatting
+          # @api private
+          # @return [Boolean] True if the actual and expected string encoding are different.
+          #   i.e. the failure may be related to encoding differences and the encoding
+          #   should be shown to the user. false otherwise.
+          if String.method_defined?(:encoding)
+            def string_encoding_differs?
+              actual.is_a?(String) && expected.is_a?(String) && actual.encoding != expected.encoding
+            end
+          else
+            # @api private
+            # @return [Boolean] False always as the curent Ruby version does not support String encoding
+            def string_encoding_differs?
+              false
+            end
+          end
+          module_function :string_encoding_differs?
+
+          if String.method_defined?(:encoding)
+            # @api private
+            # Formats a String's encoding as a human readable string
+            # @param value [String]
+            # @return [String]
+            def format_encoding(value)
+              "#<Encoding:#{value.encoding.name}>"
+            end
+          else
+            # @api private
+            # Formats a String's encoding as a human readable string
+            # @param _value [String]
+            # @return [nil] nil as the curent Ruby version does not support String encoding
+            def format_encoding(_value)
+              nil
+            end
+          end
+          module_function :format_encoding
+        end
+
+        include StringEncodingFormatting
+
         # @api private
         # Provides default implementations of failure messages, based on the `description`.
         module DefaultFailureMessages

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

@@ -51,10 +51,10 @@ module RSpec
         end
 
         # @api private
-        # @return [RSpec::Matchers::ExpectedsForMultipleDiffs]
+        # @return [RSpec::Matchers::MultiMatcherDiff]
         def expected
           return nil unless evaluator
-          ::RSpec::Matchers::ExpectedsForMultipleDiffs.for_many_matchers(diffable_matcher_list)
+          ::RSpec::Matchers::MultiMatcherDiff.for_many_matchers(diffable_matcher_list)
         end
 
       protected

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

@@ -8,7 +8,11 @@ module RSpec
         # @api private
         # @return [String]
         def failure_message
-          "\nexpected: #{expected_formatted}\n     got: #{actual_formatted}\n\n(compared using ==)\n"
+          if string_encoding_differs?
+            "\nexpected: #{format_encoding(expected)} #{expected_formatted}\n     got: #{format_encoding(actual)} #{actual_formatted}\n\n(compared using ==)\n"
+          else
+            "\nexpected: #{expected_formatted}\n     got: #{actual_formatted}\n\n(compared using ==)\n"
+          end
         end
 
         # @api private

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

@@ -8,7 +8,11 @@ module RSpec
         # @api private
         # @return [String]
         def failure_message
-          "\nexpected: #{expected_formatted}\n     got: #{actual_formatted}\n\n(compared using eql?)\n"
+          if string_encoding_differs?
+            "\nexpected: #{format_encoding(expected)} #{expected_formatted}\n     got: #{format_encoding(actual)} #{actual_formatted}\n\n(compared using eql?)\n"
+          else
+            "\nexpected: #{expected_formatted}\n     got: #{actual_formatted}\n\n(compared using eql?)\n"
+          end
         end
 
         # @api private

data/lib/rspec/matchers/matcher_delegator.rb

@@ -1,8 +1,34 @@
 module RSpec
   module Matchers
+    # Provides a base class with as little methods as possible, so that
+    # most methods can be delegated via `method_missing`.
+    #
+    # On Ruby 2.0+ BasicObject could be used for this purpose, but it
+    # introduce some extra complexity with constant resolution, so the
+    # BlankSlate pattern was prefered.
+    # @private
+    class BaseDelegator
+      kept_methods = [
+        # Methods that raise warnings if removed.
+        :__id__, :__send__, :object_id,
+
+        # Methods that are explicitly undefined in some subclasses.
+        :==, :===,
+
+        # Methods we keep on purpose.
+        :class, :respond_to?, :__method__, :method, :dup,
+        :clone, :initialize_dup, :initialize_copy, :initialize_clone,
+      ]
+      instance_methods.each do |method|
+        unless kept_methods.include?(method.to_sym)
+          undef_method(method)
+        end
+      end
+    end
+
     # Provides the necessary plumbing to wrap a matcher with a decorator.
     # @private
-    class MatcherDelegator
+    class MatcherDelegator < BaseDelegator
       include Composable
       attr_reader :base_matcher
 

data/lib/rspec/matchers/{expecteds_for_multiple_diffs.rb → multi_matcher_diff.rb}

@@ -1,9 +1,9 @@
 module RSpec
   module Matchers
     # @api private
-    # Handles list of expected values when there is a need to render
-    # multiple diffs. Also can handle one value.
-    class ExpectedsForMultipleDiffs
+    # Handles list of expected and actual value pairs when there is a need
+    # to render multiple diffs. Also can handle one pair.
+    class MultiMatcherDiff
       # @private
       # Default diff label when there is only one matcher in diff
       # output
@@ -19,22 +19,23 @@ module RSpec
 
       # @api private
       # Wraps provided expected value in instance of
-      # ExpectedForMultipleDiffs. If provided value is already an
-      # ExpectedForMultipleDiffs then it just returns it.
+      # MultiMatcherDiff. If provided value is already an
+      # MultiMatcherDiff then it just returns it.
       # @param [Any] expected value to be wrapped
-      # @return [RSpec::Matchers::ExpectedsForMultipleDiffs]
-      def self.from(expected)
+      # @param [Any] actual value
+      # @return [RSpec::Matchers::MultiMatcherDiff]
+      def self.from(expected, actual)
         return expected if self === expected
-        new([[expected, DEFAULT_DIFF_LABEL]])
+        new([[expected, DEFAULT_DIFF_LABEL, actual]])
       end
 
       # @api private
       # Wraps provided matcher list in instance of
-      # ExpectedForMultipleDiffs.
+      # MultiMatcherDiff.
       # @param [Array<Any>] matchers list of matchers to wrap
-      # @return [RSpec::Matchers::ExpectedsForMultipleDiffs]
+      # @return [RSpec::Matchers::MultiMatcherDiff]
       def self.for_many_matchers(matchers)
-        new(matchers.map { |m| [m.expected, diff_label_for(m)] })
+        new(matchers.map { |m| [m.expected, diff_label_for(m), m.actual] })
       end
 
       # @api private
@@ -42,10 +43,9 @@ module RSpec
       # factory and actual value if there are any
       # @param [String] message original failure message
       # @param [Proc] differ
-      # @param [Any] actual value
       # @return [String]
-      def message_with_diff(message, differ, actual)
-        diff = diffs(differ, actual)
+      def message_with_diff(message, differ)
+        diff = diffs(differ)
         message = "#{message}\n#{diff}" unless diff.empty?
         message
       end
@@ -65,8 +65,8 @@ module RSpec
         end
       end
 
-      def diffs(differ, actual)
-        @expected_list.map do |(expected, diff_label)|
+      def diffs(differ)
+        @expected_list.map do |(expected, diff_label, actual)|
           diff = differ.diff(actual, expected)
           next if diff.strip.empty?
           if diff == "\e[0m\n\e[0m"

data/lib/rspec/matchers.rb

@@ -10,7 +10,7 @@ RSpec::Support.define_optimized_require_for_rspec(:matchers) { |f| require_relat
   dsl
   matcher_delegator
   aliased_matcher
-  expecteds_for_multiple_diffs
+  multi_matcher_diff
 ].each { |file| RSpec::Support.require_rspec_matchers(file) }
 
 # RSpec's top level namespace. All of rspec-expectations is contained

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-expectations
 version: !ruby/object:Gem::Version
-  version: 3.12.3
+  version: 3.13.0
 platform: ruby
 authors:
 - Steven Baker
@@ -45,7 +45,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2023-04-20 00:00:00.000000000 Z
+date: 2024-02-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.12.0
+        version: 3.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -193,17 +193,17 @@ files:
 - lib/rspec/matchers/composable.rb
 - lib/rspec/matchers/dsl.rb
 - lib/rspec/matchers/english_phrasing.rb
-- lib/rspec/matchers/expecteds_for_multiple_diffs.rb
 - lib/rspec/matchers/fail_matchers.rb
 - lib/rspec/matchers/generated_descriptions.rb
 - lib/rspec/matchers/matcher_delegator.rb
 - lib/rspec/matchers/matcher_protocol.rb
+- lib/rspec/matchers/multi_matcher_diff.rb
 homepage: https://github.com/rspec/rspec-expectations
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rspec/rspec-expectations/issues
-  changelog_uri: https://github.com/rspec/rspec-expectations/blob/v3.12.3/Changelog.md
+  changelog_uri: https://github.com/rspec/rspec-expectations/blob/v3.13.0/Changelog.md
   documentation_uri: https://rspec.info/documentation/
   mailing_list_uri: https://groups.google.com/forum/#!forum/rspec
   source_code_uri: https://github.com/rspec/rspec-expectations
@@ -226,5 +226,5 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
-summary: rspec-expectations-3.12.3
+summary: rspec-expectations-3.13.0
 test_files: []