rspec-expectations 3.12.0 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5413e8a8c30666edf6019de490d1c2e99d35e43b67899191a2d34e829956661f
-  data.tar.gz: d73b4b8c9dd99cbd80059a46364c032e8e4a0915493c0ee32bb50c5b4efacccc
+  metadata.gz: f09f6ee084c32b2e2090849e672c3f71479b002183e0a3731ee6dd72c08352bf
+  data.tar.gz: 997ea963ec0460e393ac82075843e67aaf47513d9de082c88c083ad38da49a6d
 SHA512:
-  metadata.gz: 7f664fe108b8bac4a0796e0c7dd6d42b69aae2a182e035e3399baa4d9a5ae078b10ea2ec717731b9e999a18d244e99d4f249871a5f7c7e9efef78f31755455a8
-  data.tar.gz: 5bca9deb0af76504bf6e885b9243ecc0200ebc418b00424d729db0d731ff356f65642f33b714553cded35353132091ea231e35ee4cc3c12c69cd5b36857a9601
+  metadata.gz: 58cb3644c01f1771f2109faf971acba2bdc04c6e528ff68a55765ea850666ab27bec8ffcaf39e23b72b194f936e09de263136b5ac8cbc2cbc3d51d7e2d1dddee
+  data.tar.gz: 73204c1e6f84100a10e27f78ea853e1282ca26daf39927dd5a72f3c8294ff0555ea49ca01fcf5626faedc9af972a56f8641a7496e765eedd7936b647dcb28b5a

data/Changelog.md

@@ -1,5 +1,47 @@
 ### Development
-[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.12.0...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)
+
+Bug Fixes:
+
+* Fix `include` matcher when fuzzy matching on keys with a hash-like actual which
+  has a non standard `key?` method which may raise.
+  (Jon Rowe, #1416)
+
+### 3.12.2 / 2023-01-07
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.12.1...v3.12.2)
+
+Bug Fixes:
+
+* Prevent deprecation warning when using the `exist` matcher with `Dir`.
+  (Steve Dierker, #1398)
+
+### 3.12.1 / 2022-12-16
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.12.0...v3.12.1)
+
+Bug Fixes:
+
+* Pass keyword arguments through to aliased (and thus negated) matchers. (Jon Rowe, #1394)
+* When handling failures in an aggregated_failures block (or example) prevent
+  the failure list leaking out. (Maciek Rząsa, #1392)
 
 ### 3.12.0 / 2022-10-26
 [Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.11.1...v3.12.0)
@@ -314,10 +356,8 @@ Enhancements:
   can cause uses of `super` to trigger infinite recursion. (Myron Marston, #816)
 * Stop rescuing `NoMemoryError`, `SignalExcepetion`, `Interrupt` and
   `SystemExit`. It is dangerous to interfere with these. (Myron Marston, #845)
-* Add `#with_captures` to the
-  [match matcher](https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers/match-matcher)
-  which allows a user to specify expected captures when matching a regex
-  against a string. (Sam Phippen, #848)
+* Add `#with_captures` to the match matcher which allows a user to specify expected
+  captures when matching a regex against a string. (Sam Phippen, #848)
 * Always print compound failure messages in the multi-line form. Trying
   to print it all on a single line didn't read very well. (Myron Marston, #859)
 

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/failure_aggregator.rb

@@ -4,6 +4,21 @@ module RSpec
     class FailureAggregator
       attr_reader :block_label, :metadata
 
+      # @private
+      class AggregatedFailure
+        # @private
+        MESSAGE =
+          'AggregatedFailure: This method caused a failure which has been ' \
+          'suppressed to be aggregated into our failure report by returning ' \
+          'this value, further errors can be ignored.'
+
+        def inspect
+          MESSAGE
+        end
+      end
+
+      AGGREGATED_FAILURE = AggregatedFailure.new
+
       def aggregate
         RSpec::Support.with_failure_notifier(self) do
           begin
@@ -48,6 +63,8 @@ module RSpec
         @seen_source_ids[source_id] = true
         assign_backtrace(failure) unless failure.backtrace
         failures << failure
+
+        AGGREGATED_FAILURE
       end
 
     private

data/lib/rspec/expectations/version.rb

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

data/lib/rspec/matchers/aliased_matcher.rb

@@ -99,14 +99,14 @@ module RSpec
       # by going through the effort of defining a negated matcher.
       #
       # However, if the override didn't actually change anything, then we
-      # should return the opposite failure message instead -- the overriden
+      # should return the opposite failure message instead -- the overridden
       # message is going to be confusing if we return it as-is, as it represents
       # the non-negated failure message for a negated match (or vice versa).
       def optimal_failure_message(same, inverted)
         if DefaultFailureMessages.has_default_failure_messages?(@base_matcher)
           base_message = @base_matcher.__send__(same)
-          overriden    = @description_block.call(base_message)
-          return overriden if overriden != base_message
+          overridden    = @description_block.call(base_message)
+          return overridden if overridden != base_message
         end
 
         @base_matcher.__send__(inverted)

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
@@ -171,7 +171,7 @@ module RSpec
             @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 " \
+               "local jump occurs. Perhaps one of your matchers needs to " \
                "declare `expects_call_stack_jump?` as `true`?"
             end
           end

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/built_in/exist.rb

@@ -81,7 +81,7 @@ module RSpec
           end
 
           def deprecated(predicate, actual)
-            predicate == :exists? && (File == actual || FileTest == actual)
+            predicate == :exists? && (File == actual || FileTest == actual || Dir == actual)
           end
         end
       end

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

@@ -153,8 +153,15 @@ module RSpec
         def actual_hash_has_key?(expected_key)
           # We check `key?` first for perf:
           # `key?` is O(1), but `any?` is O(N).
-          actual.key?(expected_key) ||
-          actual.keys.any? { |key| values_match?(expected_key, key) }
+
+          has_exact_key =
+            begin
+              actual.key?(expected_key)
+            rescue
+              false
+            end
+
+          has_exact_key || actual.keys.any? { |key| values_match?(expected_key, key) }
         end
 
         def actual_collection_includes?(expected_item)

data/lib/rspec/matchers/composable.rb

@@ -83,7 +83,7 @@ module RSpec
         RSpec::Support::ObjectFormatter.format(object)
       end
 
-      # Transforms the given data structue (typically a hash or array)
+      # Transforms the given data structure (typically a hash or array)
       # into a new data structure that, when `#inspect` is called on it,
       # will provide descriptions of any contained matchers rather than
       # the normal `#inspect` output.

data/lib/rspec/matchers/dsl.rb

@@ -4,7 +4,7 @@ module RSpec
   module Matchers
     # Defines the custom matcher DSL.
     module DSL
-      # Defines a matcher alias. The returned matcher's `description` will be overriden
+      # Defines a matcher alias. The returned matcher's `description` will be overridden
       # to reflect the phrasing of the new name, which will be used in failure messages
       # when passed as an argument to another matcher in a composed matcher expression.
       #
@@ -25,7 +25,7 @@ module RSpec
       # @param old_name [Symbol] the original name for the matcher
       # @param options  [Hash] options for the aliased matcher
       # @option options [Class] :klass the ruby class to use as the decorator. (Not normally used).
-      # @yield [String] optional block that, when given, is used to define the overriden
+      # @yield [String] optional block that, when given, is used to define the overridden
       #   logic. The yielded arg is the original description or failure message. If no
       #   block is provided, a default override is used based on the old and new names.
       # @see RSpec::Matchers
@@ -40,10 +40,11 @@ module RSpec
           matcher.matcher_name = new_name if matcher.respond_to?(:matcher_name=)
           klass.new(matcher, description_override)
         end
+        ruby2_keywords new_name if respond_to?(:ruby2_keywords, true)
       end
 
       # Defines a negated matcher. The returned matcher's `description` and `failure_message`
-      # will be overriden to reflect the phrasing of the new name, and the match logic will
+      # will be overridden to reflect the phrasing of the new name, and the match logic will
       # be based on the original matcher but negated.
       #
       # @example
@@ -53,7 +54,7 @@ module RSpec
       #
       # @param negated_name [Symbol] the name for the negated matcher
       # @param base_name [Symbol] the name of the original matcher that will be negated
-      # @yield [String] optional block that, when given, is used to define the overriden
+      # @yield [String] optional block that, when given, is used to define the overridden
       #   logic. The yielded arg is the original description or failure message. If no
       #   block is provided, a default override is used based on the old and new names.
       # @see RSpec::Matchers
@@ -197,7 +198,7 @@ module RSpec
           end
         end
 
-        # Customizes the failure messsage to use when this matcher is
+        # Customizes the failure message to use when this matcher is
         # asked to positively match. Only use this when the message
         # generated by default doesn't suit your needs.
         #
@@ -216,7 +217,7 @@ module RSpec
           define_user_override(__method__, definition)
         end
 
-        # Customize the failure messsage to use when this matcher is asked
+        # Customize the failure message to use when this matcher is asked
         # to negatively match. Only use this when the message generated by
         # default doesn't suit your needs.
         #
@@ -330,7 +331,7 @@ module RSpec
         # - Defines the named method using a user-provided block
         #   in @user_method_defs, which is included as an ancestor
         #   in the singleton class in which we eval the `define` block.
-        # - Defines an overriden definition for the same method
+        # - Defines an overridden definition for the same method
         #   usign the provided `our_def` block.
         # - Provides a default `our_def` block for the common case
         #   of needing to call the user's definition with `@actual`

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
@@ -704,7 +704,7 @@ module RSpec
 
     # An alternate form of `contain_exactly` that accepts
     # the expected contents as a single array arg rather
-    # that splatted out as individual items.
+    # than splatted out as individual items.
     #
     # @example
     #   expect(results).to contain_exactly(1, 2)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-expectations
 version: !ruby/object:Gem::Version
-  version: 3.12.0
+  version: 3.13.0
 platform: ruby
 authors:
 - Steven Baker
@@ -45,7 +45,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2022-10-26 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.0/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
@@ -223,8 +223,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
-summary: rspec-expectations-3.12.0
+summary: rspec-expectations-3.13.0
 test_files: []

metadata.gz.sig

@@ -1,3 +1,2 @@
-���`z0M�ȗr��s`#��X�[=�s�T���sj���\P-�z��C��)I���Ƒ`�N�u����-3������[.�4��2#�xs���.х�rܶ�
-�]�p�4��g?X�M�`��v�p�fT�6k!�-��GH�ZfairU0|
2�a�T�<7�����1>
-'I^q�[����PS4:���VY8@.@�HF%�4��3E
+:���-t$r�9z�p�{\�' O�<.m�J�p�口C���M7Et������h�vt��76S<V��Ұ��ar�|
+B"��)���(l%ϋ�d�*Z�ad%��L)u����vyD��n� ^��v��dZyC����d��'zNc�2�x.��U�iZ�n�X�E6ͬ����a;~RF������U3�Lqg��^΀����ENʥ��i���l�z�/M��i���|���WD�c�2��wa�r�O�ab�xq�٥�Db<c��tmf�k�R�D�,p�I�d1b�䟭������YvF��ܔ~�e��ѱtk��8�ȑ�e�:���Y�c�z>�N��Mg%���$����T٩�]"V�$vHj&�2��܇��ʊ�Mh����/��c`����ӪOf�l����G�a
�O�g��s3��#�1Q������l�$��q޶�`��u[��j$h����m�v�wT����K��@�`��8��(�]�T7���Wd�6:��z�˯�~���