rspec-mocks 3.11.1 → 3.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93e990c0ca803cda14a587b44a4a6148fd60df472f56e58c54be5a2c8ef4a655
-  data.tar.gz: db0535d24fb98fa0da5c5de3356b687e1b95773624dd38132444f74a57c5d0b7
+  metadata.gz: 7b87ed98b8274a1dffb52bebf68a399548e97474d11f3416d0d931e2c9266aae
+  data.tar.gz: c807a54e37b46700d810b2a93bfac5e4d64411e05785c0fbf7405792ce3541a8
 SHA512:
-  metadata.gz: 7e74e72aec89ffce718f693bfda425f142bfd7139d90c57ff02e62ac461d99f9458df2ffba237bd9163e1665fd9b03a0221f723552d84bffb539a567c3b98f71
-  data.tar.gz: 6b2b9c447b777b74fcf50eb62a9674b0a4e321cf71165d340017f1ec9050a676c818a608d4d99bb5bb9c1178f44e57505e52c750b22520cb868b05b02812bfc2
+  metadata.gz: bc2aa6ade579ce757b1ccf004aca65e0f28109cc72664ce1c6dedf67946981f6c05a7b3ad04b2418f018a2057a6c393c698fed99e67fd350744a82cee6bb7047
+  data.tar.gz: cecbb9425505d14aa7eb8abf591eb91efe50b99c9ca7773be8fb56fe0005d7f5e447a4a0b8f1c9b0f0a7f6401b3929435fdd7deef6b91916550ca337c8b91dab

data/Changelog.md

@@ -1,5 +1,49 @@
 ### Development
-[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.11.1...3-11-maintenance)
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.12.1...3-12-maintenance)
+
+### 3.12.2 / 2023-01-07
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.12.1...v3.12.2)
+
+Bug Fixes:
+
+* Fix implementation blocks for mocks using keyword arguments on Ruby 3.2.0.
+  (Adam Steel, #1508)
+* Fix keyword argument assertions when mocking using `with` on Ruby 3.2.0.
+  (Slava Kardakov, Benoit Tigeot, Phil Pirozhkov, Benoit Daloze, #1514)
+
+### 3.12.1 / 2022-12-10
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.12.0...v3.12.1)
+
+Bug Fixes:
+
+* Remove empty diff marker when a diff only contains console codes. (Jon Rowe, #1506)
+* Show keyword vs hash diff marker when arguments are not `==` (Jon Rowe, #1506)
+* Change check to detect frozen objects to rescue errors rather than
+  pre-empting by checking `frozen?` due to some objects mis-behaving.
+  (Keegan Roth, #1401)
+* Prevent unfulfilled expectations using `expect_any_instance_of` across a class
+  inheritance boundary from raising rather than failing. (Jon Rowe, #1496)
+* Prevent a misleading error message when using `allow(...).not_to` with
+  unsupported matchers. (Phil Pirozhkov, #1503)
+
+### 3.12.0 / 2022-10-26
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.11.2...v3.12.0)
+
+Enhancements:
+
+* Improve diff output when diffing keyword arguments against hashes.
+  (Jean Boussier, #1461)
+
+### 3.11.2 / 2022-10-25
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.11.1...v3.11.2)
+
+Bug Fixes:
+
+* Use the original implementation of `Class.new` to detect overridden definitions
+  of `new` rather than the owner, fixing detection of "double aliased" methods
+  in Ruby 3 and above. (Benoit Daloze, #1470, #1476)
+* Support keyword argument semantics when constraining argument expectations using
+  `with` on Ruby 3.0+ with `instance_double` (Andrii Malyshko, #1473)
 
 ### 3.11.1 / 2022-03-31
 [Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.11.0...v3.11.1)

data/lib/rspec/mocks/any_instance/message_chains.rb

@@ -49,7 +49,7 @@ module RSpec
         # @private
         def unfulfilled_expectations
           @chains_by_method_name.map do |method_name, chains|
-            method_name.to_s if ExpectationChain === chains.last unless chains.last.expectation_fulfilled?
+            method_name.to_s if ExpectationChain === chains.last && !chains.last.expectation_fulfilled?
           end.compact
         end
 

data/lib/rspec/mocks/any_instance/proxy.rb

@@ -10,7 +10,7 @@ module RSpec
       #
       # This proxy sits in front of the recorder and delegates both to it
       # and to the `RSpec::Mocks::Proxy` for each already mocked or stubbed
-      # instance of the class, in order to propogates changes to the instances.
+      # instance of the class, in order to propagates changes to the instances.
       #
       # Note that unlike `RSpec::Mocks::Proxy`, this proxy class is stateless
       # and is not persisted in `RSpec::Mocks.space`.

data/lib/rspec/mocks/argument_list_matcher.rb

@@ -61,7 +61,9 @@ module RSpec
         return false if expected_args.size != actual_args.size
 
         if RUBY_VERSION >= "3"
-          # if both arguments end with Hashes, and if one is a keyword hash and the other is not, they don't match
+          # If the expectation was set with keywords, while the actual method was called with a positional hash argument, they don't match.
+          # If the expectation was set without keywords, e.g., with({a: 1}), then it fine to call it with either foo(a: 1) or foo({a: 1}).
+          # This corresponds to Ruby semantics, as if the method was def foo(options).
           if Hash === expected_args.last && Hash === actual_args.last
             if !Hash.ruby2_keywords_hash?(actual_args.last) && Hash.ruby2_keywords_hash?(expected_args.last)
               return false

data/lib/rspec/mocks/error_generator.rb

@@ -268,11 +268,32 @@ module RSpec
       def error_message(expectation, args_for_multiple_calls)
         expected_args = format_args(expectation.expected_args)
         actual_args = format_received_args(args_for_multiple_calls)
+
+        if RSpec::Support::RubyFeatures.distincts_kw_args_from_positional_hash?
+          expected_hash = expectation.expected_args.last
+          actual_hash = args_for_multiple_calls.last.last
+          if Hash === expected_hash && Hash === actual_hash &&
+            (Hash.ruby2_keywords_hash?(expected_hash) != Hash.ruby2_keywords_hash?(actual_hash))
+
+            actual_description = Hash.ruby2_keywords_hash?(actual_hash) ? " (keyword arguments)" : " (options hash)"
+            expected_description = Hash.ruby2_keywords_hash?(expected_hash) ? " (keyword arguments)" : " (options hash)"
+
+            if actual_description != expected_description
+              actual_args += actual_description
+              expected_args += expected_description
+            end
+          end
+        end
+
         message = default_error_message(expectation, expected_args, actual_args)
 
         if args_for_multiple_calls.one?
           diff = diff_message(expectation.expected_args, args_for_multiple_calls.first)
-          message << "\nDiff:#{diff}" unless diff.strip.empty?
+          if RSpec::Mocks.configuration.color?
+            message << "\nDiff:#{diff}" unless diff.gsub(/\e\[\d+m/, '').strip.empty?
+          else
+            message << "\nDiff:#{diff}" unless diff.strip.empty?
+          end
         end
 
         message

data/lib/rspec/mocks/matchers/have_received.rb

@@ -16,7 +16,7 @@ module RSpec
           @subject = nil
         end
 
-        def name
+        def matcher_name
           "have_received"
         end
 

data/lib/rspec/mocks/matchers/receive.rb

@@ -13,7 +13,7 @@ module RSpec
           @recorded_customizations = []
         end
 
-        def name
+        def matcher_name
           "receive"
         end
 

data/lib/rspec/mocks/matchers/receive_message_chain.rb

@@ -20,7 +20,7 @@ module RSpec
           end
         end
 
-        def name
+        def matcher_name
           "receive_message_chain"
         end
 

data/lib/rspec/mocks/matchers/receive_messages.rb

@@ -10,7 +10,7 @@ module RSpec
           @backtrace_line = CallerFilter.first_non_rspec_line
         end
 
-        def name
+        def matcher_name
           "receive_messages"
         end
 

data/lib/rspec/mocks/message_expectation.rb

@@ -406,7 +406,6 @@ module RSpec
       # some collaborators it delegates to for this stuff but for now this was
       # the simplest way to split the public from private stuff to make it
       # easier to publish the docs for the APIs we want published.
-      # rubocop:disable Metrics/ModuleLength
       module ImplementationDetails
         attr_accessor :error_generator, :implementation
         attr_reader :message
@@ -686,7 +685,6 @@ module RSpec
           nil
         end
       end
-      # rubocop:enable Metrics/ModuleLength
 
       include ImplementationDetails
     end

data/lib/rspec/mocks/method_double.rb

@@ -2,6 +2,9 @@ module RSpec
   module Mocks
     # @private
     class MethodDouble
+      # @private TODO: drop in favor of FrozenError in ruby 2.5+
+      FROZEN_ERROR_MSG = /can't modify frozen/
+
       # @private
       attr_reader :method_name, :object, :expectations, :stubs, :method_stasher
 
@@ -70,6 +73,14 @@ module RSpec
         end
 
         @method_is_proxied = true
+      rescue RuntimeError, TypeError => e
+        # TODO: drop in favor of FrozenError in ruby 2.5+
+        #  RuntimeError (and FrozenError) for ruby 2.x
+        #  TypeError for ruby 1.x
+        if (defined?(FrozenError) && e.is_a?(FrozenError)) || FROZEN_ERROR_MSG === e.message
+          raise ArgumentError, "Cannot proxy frozen objects, rspec-mocks relies on proxies for method stubbing and expectations."
+        end
+        raise
       end
 
       # The implementation of the proxied method. Subclasses may override this
@@ -83,7 +94,6 @@ module RSpec
 
       # @private
       def restore_original_method
-        return show_frozen_warning if object_singleton_class.frozen?
         return unless @method_is_proxied
 
         remove_method_from_definition_target
@@ -91,6 +101,14 @@ module RSpec
         restore_original_visibility
 
         @method_is_proxied = false
+      rescue RuntimeError, TypeError => e
+        # TODO: drop in favor of FrozenError in ruby 2.5+
+        #  RuntimeError (and FrozenError) for ruby 2.x
+        #  TypeError for ruby 1.x
+        if (defined?(FrozenError) && e.is_a?(FrozenError)) || FROZEN_ERROR_MSG === e.message
+          return show_frozen_warning
+        end
+        raise
       end
 
       # @private

data/lib/rspec/mocks/method_reference.rb

@@ -185,11 +185,23 @@ module RSpec
       def self.applies_to?(method_name)
         return false unless method_name == :new
         klass = yield
-        return false unless klass.respond_to?(:new, true)
+        return false unless ::Class === klass && klass.respond_to?(:new, true)
 
         # We only want to apply our special logic to normal `new` methods.
         # Methods that the user has monkeyed with should be left as-is.
-        ::RSpec::Support.method_handle_for(klass, :new).owner == ::Class
+        uses_class_new?(klass)
+      end
+
+      if RUBY_VERSION.to_i >= 3
+        CLASS_NEW = ::Class.instance_method(:new)
+
+        def self.uses_class_new?(klass)
+          ::RSpec::Support.method_handle_for(klass, :new) == CLASS_NEW.bind(klass)
+        end
+      else # Ruby 2's Method#== is too strict
+        def self.uses_class_new?(klass)
+          ::RSpec::Support.method_handle_for(klass, :new).owner == ::Class
+        end
       end
 
       def with_signature

data/lib/rspec/mocks/minitest_integration.rb

@@ -37,7 +37,7 @@ if defined?(::Minitest::Expectation)
     # not want to here (or else we would interfere with rspec-expectations' definition).
   else
     # ...otherwise, define those methods now. If `rspec/expectations/minitest_integration`
-    # is loaded after this file, it'll overide the defintion here.
+    # is loaded after this file, it'll override the definition here.
     Minitest::Expectation.class_eval do
       include RSpec::Mocks::ExpectationTargetMethods
 

data/lib/rspec/mocks/mutate_const.rb

@@ -81,7 +81,7 @@ module RSpec
       # Queries rspec-mocks to find out information about the named constant.
       #
       # @param [String] name the name of the constant
-      # @return [Constant] an object contaning information about the named
+      # @return [Constant] an object containing information about the named
       #   constant.
       def self.original(name)
         mutator = ::RSpec::Mocks.space.constant_mutator_for(name)

data/lib/rspec/mocks/proxy.rb

@@ -35,15 +35,9 @@ module RSpec
 
       # @private
       def ensure_can_be_proxied!(object)
-        return unless object.is_a?(Symbol) || object.frozen?
-        return if object.nil?
+        return unless object.is_a?(Symbol)
 
-        msg = "Cannot proxy frozen objects"
-        if Symbol === object
-          msg << ". Symbols such as #{object} cannot be mocked or stubbed."
-        else
-          msg << ", rspec-mocks relies on proxies for method stubbing and expectations."
-        end
+        msg = "Cannot proxy frozen objects. Symbols such as #{object} cannot be mocked or stubbed."
         raise ArgumentError, msg
       end
 
@@ -198,6 +192,7 @@ module RSpec
           @messages_received << [message, args, block]
         end
       end
+      ruby2_keywords :record_message_received if respond_to?(:ruby2_keywords, true)
 
       # @private
       def message_received(message, *args, &block)

data/lib/rspec/mocks/targets.rb

@@ -54,7 +54,7 @@ module RSpec
 
       def raise_negation_unsupported(method_name, matcher)
         raise NegationUnsupportedError,
-              "`#{expression}(...).#{method_name} #{matcher.name}` is not supported since it " \
+              "`#{expression}(...).#{method_name} #{matcher.matcher_name}` is not supported since it " \
               "doesn't really make sense. What would it even mean?"
       end
     end

data/lib/rspec/mocks/verifying_message_expectation.rb

@@ -31,6 +31,7 @@ module RSpec
           end
         end
       end
+      ruby2_keywords(:with) if respond_to?(:ruby2_keywords, true)
 
     private
 

data/lib/rspec/mocks/verifying_proxy.rb

@@ -57,7 +57,7 @@ module RSpec
     # A verifying proxy mostly acts like a normal proxy, except that it
     # contains extra logic to try and determine the validity of any expectation
     # set on it. This includes whether or not methods have been defined and the
-    # validatiy of arguments on method calls.
+    # validity of arguments on method calls.
     #
     # In all other ways this behaves like a normal proxy. It only adds the
     # verification behaviour to specific methods then delegates to the parent
@@ -147,12 +147,12 @@ module RSpec
       end
 
       def add_expectation(*args, &block)
-        # explict params necessary for 1.8.7 see #626
+        # explicit params necessary for 1.8.7 see #626
         super(*args, &block).tap { |x| x.method_reference = @method_reference }
       end
 
       def add_stub(*args, &block)
-        # explict params necessary for 1.8.7 see #626
+        # explicit params necessary for 1.8.7 see #626
         super(*args, &block).tap { |x| x.method_reference = @method_reference }
       end
 
@@ -160,6 +160,7 @@ module RSpec
         validate_arguments!(args)
         super
       end
+      ruby2_keywords :proxy_method_invoked if respond_to?(:ruby2_keywords, true)
 
       def validate_arguments!(actual_args)
         @method_reference.with_signature do |signature|

data/lib/rspec/mocks/version.rb

@@ -3,7 +3,7 @@ module RSpec
     # Version information for RSpec mocks.
     module Version
       # Version of RSpec mocks currently in use in SemVer format.
-      STRING = '3.11.1'
+      STRING = '3.12.2'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-mocks
 version: !ruby/object:Gem::Version
-  version: 3.11.1
+  version: 3.12.2
 platform: ruby
 authors:
 - Steven Baker
@@ -45,7 +45,7 @@ cert_chain:
   ZsVDj6a7lH3cNqtWXZxrb2wO38qV5AkYj8SQK7Hj3/Yui9myUX3crr+PdetazSqQ
   F3MdtaDehhjC
   -----END CERTIFICATE-----
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2023-01-07 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
@@ -194,7 +194,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rspec/rspec-mocks/issues
-  changelog_uri: https://github.com/rspec/rspec-mocks/blob/v3.11.1/Changelog.md
+  changelog_uri: https://github.com/rspec/rspec-mocks/blob/v3.12.2/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-mocks
@@ -214,8 +214,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-mocks-3.11.1
+summary: rspec-mocks-3.12.2
 test_files: []