rspec-mocks 3.11.0 → 3.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12ce7d4b5f6accc3fb2b6af82646843de8ffd500352d4ca5367985e28fec0805
-  data.tar.gz: 9643bc17b54bd21725aa39946eacda8207e327bdb592a9e0be821ee42c59bddb
+  metadata.gz: 26d2a0b4b29906b9299801a379eafbad373822822ad30b769ef2bef2e9a4b22b
+  data.tar.gz: b2196b0f0111c48cb88398bb1071c9047fa637853da0ac684fc3d57d5ec7fc71
 SHA512:
-  metadata.gz: 1a1fc3ad0ca28d5371d74985f236f9c222fc310743062a5e8746c5f995803bfd5b63de26b673b94460c6ec47eedfbb150425fe3bb59f0e5bdaf4d639ffe0bc0d
-  data.tar.gz: 352761f69232f8b5afb6ac918bb596c5961017f622f2aec36052f5f69c426449a51ef2af26394951cad5c7706a165446a9d80d6e01adafeb87e4f6e0804a46af
+  metadata.gz: c96f4c1dc4c9f99e0d222c2aeb054d5aa6d18a7b18e58df7a2235644c3d91745590346cb74ef8102420e658d748ded36ce1c90727bac6158770e3625f4817aed
+  data.tar.gz: 7539266eec67cb3e522855f9a446b9e8a90aef2947d19ce01c69c4e2c6be033cf0e0c01f8b115d0d2f08fc7391e81e355514aeaaa3dc1364bff147bf489e1d19

data/Changelog.md

@@ -1,5 +1,48 @@
 ### Development
-[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.11.0...3-11-maintenance)
+[Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.12.1...3-12-maintenance)
+
+### 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)
+
+Bug Fixes:
+
+* Add extra `ruby2_keywords` calls to properly designate methods using
+ `*args` to pass keyword around, fixes an issue with TruffleRuby.
+ (Benoit Daloze, #1464)
 
 ### 3.11.0 / 2022-02-09
 [Full Changelog](http://github.com/rspec/rspec-mocks/compare/v3.10.3...v3.11.0)

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

@@ -46,7 +46,7 @@ module RSpec
         @expected_args = expected_args
         ensure_expected_args_valid!
       end
-      ruby2_keywords :initialize if Module.private_method_defined?(:ruby2_keywords)
+      ruby2_keywords :initialize if respond_to?(:ruby2_keywords, true)
 
       # @api public
       # @param [Array] actual_args
@@ -71,6 +71,7 @@ module RSpec
 
         Support::FuzzyMatcher.values_match?(expected_args, actual_args)
       end
+      ruby2_keywords :args_match? if respond_to?(:ruby2_keywords, true)
 
       # @private
       # Resolves abstract arg placeholders like `no_args` and `any_args` into

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
 
@@ -62,7 +62,7 @@ module RSpec
             @recorded_customizations << ExpectationCustomization.new(method, args, block)
             self
           end
-          ruby2_keywords(method) if Module.private_method_defined?(:ruby2_keywords)
+          ruby2_keywords(method) if respond_to?(:ruby2_keywords, true)
         end
 
       private

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

@@ -139,9 +139,12 @@ module RSpec
       #   counter.increment
       #   expect(counter.count).to eq(original_count + 1)
       def and_call_original
-        wrap_original(__method__) do |original, *args, &block|
-          original.call(*args, &block)
+        block = lambda do |original, *args, &b|
+          original.call(*args, &b)
         end
+        block = block.ruby2_keywords if block.respond_to?(:ruby2_keywords)
+
+        wrap_original(__method__, &block)
       end
 
       # Decorates the stubbed method with the supplied block. The original
@@ -364,7 +367,7 @@ module RSpec
         @argument_list_matcher = ArgumentListMatcher.new(*args)
         self
       end
-      ruby2_keywords(:with) if Module.private_method_defined?(:ruby2_keywords)
+      ruby2_keywords(:with) if respond_to?(:ruby2_keywords, true)
 
       # Expect messages to be received in a specific order.
       #
@@ -403,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
@@ -461,18 +463,22 @@ module RSpec
         def matches?(message, *args)
           @message == message && @argument_list_matcher.args_match?(*args)
         end
+        ruby2_keywords :matches? if respond_to?(:ruby2_keywords, true)
 
         def safe_invoke(parent_stub, *args, &block)
           invoke_incrementing_actual_calls_by(1, false, parent_stub, *args, &block)
         end
+        ruby2_keywords :safe_invoke if respond_to?(:ruby2_keywords, true)
 
         def invoke(parent_stub, *args, &block)
           invoke_incrementing_actual_calls_by(1, true, parent_stub, *args, &block)
         end
+        ruby2_keywords :invoke if respond_to?(:ruby2_keywords, true)
 
         def invoke_without_incrementing_received_count(parent_stub, *args, &block)
           invoke_incrementing_actual_calls_by(0, true, parent_stub, *args, &block)
         end
+        ruby2_keywords :invoke_without_incrementing_received_count if respond_to?(:ruby2_keywords, true)
 
         def negative?
           @expected_received_count == 0 && !@at_least
@@ -621,6 +627,7 @@ module RSpec
             @actual_received_count += increment
           end
         end
+        ruby2_keywords :invoke_incrementing_actual_calls_by if respond_to?(:ruby2_keywords, true)
 
         def has_been_invoked?
           @actual_received_count > 0
@@ -678,7 +685,6 @@ module RSpec
           nil
         end
       end
-      # rubocop:enable Metrics/ModuleLength
 
       include ImplementationDetails
     end
@@ -755,6 +761,7 @@ module RSpec
           action.call(*args, &block)
         end.last
       end
+      ruby2_keywords :call if respond_to?(:ruby2_keywords, true)
 
       def present?
         actions.any?
@@ -800,6 +807,7 @@ module RSpec
       def call(*args, &block)
         @block.call(@method, *args, &block)
       end
+      ruby2_keywords :call if respond_to?(:ruby2_keywords, true)
 
     private
 

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
 
@@ -63,11 +66,21 @@ module RSpec
           define_method(method_name) do |*args, &block|
             method_double.proxy_method_invoked(self, *args, &block)
           end
+          # This can't be `if respond_to?(:ruby2_keywords, true)`,
+          # see https://github.com/rspec/rspec-mocks/pull/1385#issuecomment-755340298
           ruby2_keywords(method_name) if Module.private_method_defined?(:ruby2_keywords)
           __send__(visibility, method_name)
         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
@@ -77,10 +90,10 @@ module RSpec
       def proxy_method_invoked(_obj, *args, &block)
         @proxy.message_received method_name, *args, &block
       end
+      ruby2_keywords :proxy_method_invoked if respond_to?(:ruby2_keywords, true)
 
       # @private
       def restore_original_method
-        return show_frozen_warning if object_singleton_class.frozen?
         return unless @method_is_proxied
 
         remove_method_from_definition_target
@@ -88,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/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
 
@@ -230,6 +224,7 @@ module RSpec
           @object.__send__(:method_missing, message, *args, &block)
         end
       end
+      ruby2_keywords :message_received if respond_to?(:ruby2_keywords, true)
 
       # @private
       def raise_unexpected_message_error(method_name, args)
@@ -279,12 +274,14 @@ module RSpec
           expectation.matches?(method_name, *args)
         end
       end
+      ruby2_keywords :find_matching_expectation if respond_to?(:ruby2_keywords, true)
 
       def find_almost_matching_expectation(method_name, *args)
         find_best_matching_expectation_for(method_name) do |expectation|
           expectation.matches_name_but_not_args(method_name, *args)
         end
       end
+      ruby2_keywords :find_almost_matching_expectation if respond_to?(:ruby2_keywords, true)
 
       def find_best_matching_expectation_for(method_name)
         first_match = nil
@@ -301,10 +298,12 @@ module RSpec
       def find_matching_method_stub(method_name, *args)
         method_double_for(method_name).stubs.find { |stub| stub.matches?(method_name, *args) }
       end
+      ruby2_keywords :find_matching_method_stub if respond_to?(:ruby2_keywords, true)
 
       def find_almost_matching_stub(method_name, *args)
         method_double_for(method_name).stubs.find { |stub| stub.matches_name_but_not_args(method_name, *args) }
       end
+      ruby2_keywords :find_almost_matching_stub if respond_to?(:ruby2_keywords, true)
     end
 
     # @private
@@ -360,6 +359,7 @@ module RSpec
         end
         super
       end
+      ruby2_keywords :message_received if respond_to?(:ruby2_keywords, true)
 
     private
 

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/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.0'
+      STRING = '3.12.1'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-mocks
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.12.1
 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: 2022-12-10 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.0/Changelog.md
+  changelog_uri: https://github.com/rspec/rspec-mocks/blob/v3.12.1/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.0
+summary: rspec-mocks-3.12.1
 test_files: []