rspec-expectations 3.11.0 → 3.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e651e80dd869915779a72a9ea43b38d20327f3dbfaf94a4851eff7974d1f3d0a
-  data.tar.gz: e1788055c911b97cbad1b3747fe9b9be005a999e2e97e6c361df4c91fa4fda25
+  metadata.gz: d167a03fcf6e4519b628fefcf03b644e6436e1f6769058d84431fab3181e5119
+  data.tar.gz: dccb3d8b5ed822e523989e59e897085584173d65a503be30166b9d14bba675ef
 SHA512:
-  metadata.gz: ec1b6b68b80fddae764dbf88312817c35c1e76228c29748e2b89d8d9a69d95384aa4fe9daf7b8a650dd307dd32aca13bae590d8960f0989beea67c54f7f6d7d5
-  data.tar.gz: 7a8a129e74ccec6299ab3af1c728cab2754a1cc98911507704c3f52a01c33b321250bfe715deef835b61963e22c66ec878500d10c6fea93d4fda7cc39b101676
+  metadata.gz: dc027c3d982da4f60e13924ef494fe4df964ee64ccd405eaf69a522494e23d394d0560dfa32c2007a8f43831118ad20df6480ed5692dbe70b389dfcc724e7266
+  data.tar.gz: 61e1c4f7ce7514869e63d24e7eb3270861ea4ad6343c34127b04f757bd80009dd599ae94be25c925b1de265fb4dc5a68f9619b9e3293de46b4aabd0cd1595dae

data/Changelog.md

@@ -1,5 +1,49 @@
 ### Development
-[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.11.0...3-11-maintenance)
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.12.3...3-12-maintenance)
+
+### 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)
+
+Enhancements:
+
+* Add `an_array_matching` alias for `match_array` to improve readability as an argument
+  matcher. (Mark Schneider, #1361)
+
+### 3.11.1 / 2022-09-12
+[Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.11.0...v3.11.1)
+
+Bug Fixes:
+
+* Allow the `contain_exactly` matcher to be reused by resetting its
+  internals on `matches?` (@bclayman-sq, #1326)
+* Using the exist matcher on `FileTest` no longer produces a deprecation warning.
+  (Ryo Nakamura, #1383)
 
 ### 3.11.0 / 2022-02-09
 [Full Changelog](http://github.com/rspec/rspec-expectations/compare/v3.10.2...v3.11.0)
@@ -296,10 +340,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/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.11.0'
+      STRING = '3.12.3'
     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/compound.rb

@@ -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/contain_exactly.rb

@@ -1,7 +1,7 @@
 module RSpec
   module Matchers
     module BuiltIn
-      # rubocop:disable ClassLength
+      # rubocop:disable Metrics/ClassLength
       # @api private
       # Provides the implementation for `contain_exactly` and `match_array`.
       # Not intended to be instantiated directly.
@@ -31,6 +31,14 @@ module RSpec
           "contain exactly#{list}"
         end
 
+        def matches?(actual)
+          @pairings_maximizer = nil
+          @best_solution = nil
+          @extra_items = nil
+          @missing_items = nil
+          super(actual)
+        end
+
       private
 
         def generate_failure_message
@@ -296,7 +304,7 @@ module RSpec
           end
         end
       end
-      # rubocop:enable ClassLength
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end

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

@@ -2,7 +2,7 @@ module RSpec
   module Matchers
     module BuiltIn
       # @api private
-      # Asbtract class to implement `once`, `at_least` and other
+      # Abstract class to implement `once`, `at_least` and other
       # count constraints.
       module CountExpectation
         # @api public

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

@@ -81,7 +81,7 @@ module RSpec
           end
 
           def deprecated(predicate, actual)
-            predicate == :exists? && File == 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/built_in/raise_error.rb

@@ -4,8 +4,8 @@ module RSpec
       # @api private
       # Provides the implementation for `raise_error`.
       # Not intended to be instantiated directly.
-      # rubocop:disable ClassLength
-      # rubocop:disable RescueException
+      # rubocop:disable Metrics/ClassLength
+      # rubocop:disable Lint/RescueException
       class RaiseError
         include Composable
 
@@ -43,7 +43,7 @@ module RSpec
           self
         end
 
-        # rubocop:disable MethodLength
+        # rubocop:disable Metrics/MethodLength
         # @private
         def matches?(given_proc, negative_expectation=false, &block)
           @given_proc = given_proc
@@ -73,7 +73,7 @@ module RSpec
 
           expectation_matched?
         end
-        # rubocop:enable MethodLength
+        # rubocop:enable Metrics/MethodLength
 
         # @private
         def does_not_match?(given_proc)
@@ -264,8 +264,8 @@ module RSpec
           warning if @actual_error
         end
       end
-      # rubocop:enable RescueException
-      # rubocop:enable ClassLength
+      # rubocop:enable Lint/RescueException
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end

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

@@ -13,7 +13,7 @@ module RSpec
           @caught_symbol = @caught_arg = nil
         end
 
-        # rubocop:disable MethodLength
+        # rubocop:disable Metrics/MethodLength
         # @private
         def matches?(given_proc)
           @block = given_proc
@@ -48,7 +48,7 @@ module RSpec
           rescue => other_exception
             raise
           ensure
-            # rubocop:disable EnsureReturn
+            # rubocop:disable Lint/EnsureReturn
             unless other_exception
               if @expected_symbol.nil?
                 return !!@caught_symbol
@@ -60,10 +60,10 @@ module RSpec
                 end
               end
             end
-            # rubocop:enable EnsureReturn
+            # rubocop:enable Lint/EnsureReturn
           end
         end
-        # rubocop:enable MethodLength
+        # rubocop:enable Metrics/MethodLength
 
         def does_not_match?(given_proc)
           !matches?(given_proc) && Proc === given_proc

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
@@ -122,7 +123,7 @@ module RSpec
         #
         # By default the match block will swallow expectation errors (e.g.
         # caused by using an expectation such as `expect(1).to eq 2`), if you
-        # with to allow these to bubble up, pass in the option
+        # wish to allow these to bubble up, pass in the option
         # `:notify_expectation_failures => true`.
         #
         # @param [Hash] options for defining the behavior of the match block.
@@ -151,7 +152,7 @@ module RSpec
         #
         # By default the match block will swallow expectation errors (e.g.
         # caused by using an expectation such as `expect(1).to eq 2`), if you
-        # with to allow these to bubble up, pass in the option
+        # wish to allow these to bubble up, pass in the option
         # `:notify_expectation_failures => true`.
         #
         # @param [Hash] options for defining the behavior of the match block.
@@ -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.rb

@@ -36,7 +36,7 @@ module RSpec
   #     expect([]).to be_empty     # => [].empty?() | passes
   #     expect([]).not_to be_empty # => [].empty?() | fails
   #
-  # In addtion to prefixing the predicate matchers with "be_", you can also use "be_a_"
+  # In addition to prefixing the predicate matchers with "be_", you can also use "be_a_"
   # and "be_an_", making your specs read much more naturally:
   #
   #     expect("a string").to be_an_instance_of(String) # =>"a string".instance_of?(String) # passes
@@ -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)
@@ -715,6 +715,9 @@ module RSpec
     def match_array(items)
       contain_exactly(*items)
     end
+    alias_matcher :an_array_matching, :match_array do |desc|
+      desc.sub("contain exactly", "an array containing exactly")
+    end
 
     # With no arg, passes if the block outputs `to_stdout` or `to_stderr`.
     # With a string, passes if the block outputs that specific string `to_stdout` or `to_stderr`.
@@ -753,8 +756,8 @@ module RSpec
 
     # With no args, matches if any error is raised.
     # With a named error, matches only if that specific error is raised.
-    # With a named error and messsage specified as a String, matches only if both match.
-    # With a named error and messsage specified as a Regexp, matches only if both match.
+    # With a named error and message specified as a String, matches only if both match.
+    # With a named error and message specified as a Regexp, matches only if both match.
     # Pass an optional block to perform extra verifications on the exception matched
     #
     # @example

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-expectations
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.12.3
 platform: ruby
 authors:
 - Steven Baker
@@ -45,7 +45,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2023-04-20 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.11.0
+        version: 3.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.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.11.0/Changelog.md
+  changelog_uri: https://github.com/rspec/rspec-expectations/blob/v3.12.3/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.11.0
+summary: rspec-expectations-3.12.3
 test_files: []