rspec-expectations 3.12.4 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a4b2b9ff3e6aa95cb68edc11fb142d4ed9af33134ece089bb4fa2f524b4fed9
-  data.tar.gz: cde69140cecbddef69efa9a51148983786cec5023695c56686ef4141490dd657
+  metadata.gz: f09f6ee084c32b2e2090849e672c3f71479b002183e0a3731ee6dd72c08352bf
+  data.tar.gz: 997ea963ec0460e393ac82075843e67aaf47513d9de082c88c083ad38da49a6d
 SHA512:
-  metadata.gz: a391ea2eb336a05f2cabaea19ddd759499dac7f0ca1578504ad9668752d0c758f83f75281b4ba041db55ff62695e99368fb37576566068baf0ad95de43f16b1a
-  data.tar.gz: 1f2b528c2073230317a0557b371a28be61a35895b8849f310f6696ce6cf6cc7074878ea8657a8e137cae9da5f7c58219716946fe56229b49eb91a60ae2125dfc
+  metadata.gz: 58cb3644c01f1771f2109faf971acba2bdc04c6e528ff68a55765ea850666ab27bec8ffcaf39e23b72b194f936e09de263136b5ac8cbc2cbc3d51d7e2d1dddee
+  data.tar.gz: 73204c1e6f84100a10e27f78ea853e1282ca26daf39927dd5a72f3c8294ff0555ea49ca01fcf5626faedc9af972a56f8641a7496e765eedd7936b647dcb28b5a

data/Changelog.md

@@ -1,5 +1,13 @@
 ### Development
-[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.12.4...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)

data/lib/rspec/expectations/version.rb

@@ -2,7 +2,7 @@ module RSpec
   module Expectations
     # @private
     module Version
-      STRING = '3.12.4'
+      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/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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-expectations
 version: !ruby/object:Gem::Version
-  version: 3.12.4
+  version: 3.13.0
 platform: ruby
 authors:
 - Steven Baker
@@ -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
@@ -203,7 +203,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rspec/rspec-expectations/issues
-  changelog_uri: https://github.com/rspec/rspec-expectations/blob/v3.12.4/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.4
+summary: rspec-expectations-3.13.0
 test_files: []