mocha 2.7.0 → 2.8.0

data/lib/mocha/parameter_matchers/responds_with.rb

@@ -1,60 +1,67 @@
 require 'mocha/parameter_matchers/base'
 require 'mocha/parameter_matchers/all_of'
+require 'mocha/parameter_matchers/deprecations'
 require 'yaml'
 
 module Mocha
   module ParameterMatchers
-    # @overload def responds_with(message, result)
-    #   Matches any object that responds to +message+ with +result+. To put it another way, it tests the quack, not the duck.
-    #   @param [Symbol] message method to invoke.
-    #   @param [Object] result expected result of sending +message+.
-    # @overload def responds_with(messages_vs_results)
-    #   Matches any object that responds to all the messages with the corresponding results as specified by +messages_vs_results+.
-    #   @param [Hash<Symbol,Object>] messages_vs_results +Hash+ of messages vs results.
-    #   @raise [ArgumentError] if +messages_vs_results+ does not contain at least one entry.
-    #
-    # @return [RespondsWith] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Actual parameter responds with "FOO" when :upcase is invoked.
-    #   object = mock()
-    #   object.expects(:method_1).with(responds_with(:upcase, "FOO"))
-    #   object.method_1("foo")
-    #   # no error raised, because "foo".upcase == "FOO"
-    #
-    # @example Actual parameter does not respond with "FOO" when :upcase is invoked.
-    #   object = mock()
-    #   object.expects(:method_1).with(responds_with(:upcase, "BAR"))
-    #   object.method_1("foo")
-    #   # error raised, because "foo".upcase != "BAR"
-    #
-    # @example Actual parameter responds with "FOO" when :upcase is invoked and "oof" when :reverse is invoked.
-    #   object = mock()
-    #   object.expects(:method_1).with(responds_with(upcase: "FOO", reverse: "oof"))
-    #   object.method_1("foo")
-    #   # no error raised, because "foo".upcase == "FOO" and "foo".reverse == "oof"
-    def responds_with(*options)
-      case options.length
-      when 0
-        raise ArgumentError, 'No arguments. Expecting at least one.'
-      when 1
-        option = options.first
-        raise ArgumentError, 'Argument is not a Hash.' unless option.is_a?(Hash)
-        raise ArgumentError, 'Argument has no entries.' if option.empty?
+    module Methods
+      # @overload def responds_with(message, result)
+      #   Matches any object that responds to +message+ with +result+. To put it another way, it tests the quack, not the duck.
+      #   @param [Symbol] message method to invoke.
+      #   @param [Object] result expected result of sending +message+.
+      # @overload def responds_with(messages_vs_results)
+      #   Matches any object that responds to all the messages with the corresponding results as specified by +messages_vs_results+.
+      #   @param [Hash<Symbol,Object>] messages_vs_results +Hash+ of messages vs results.
+      #   @raise [ArgumentError] if +messages_vs_results+ does not contain at least one entry.
+      #
+      # @return [RespondsWith] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter responds with "FOO" when :upcase is invoked.
+      #   object = mock()
+      #   object.expects(:method_1).with(responds_with(:upcase, "FOO"))
+      #   object.method_1("foo")
+      #   # no error raised, because "foo".upcase == "FOO"
+      #
+      # @example Actual parameter does not respond with "FOO" when :upcase is invoked.
+      #   object = mock()
+      #   object.expects(:method_1).with(responds_with(:upcase, "BAR"))
+      #   object.method_1("foo")
+      #   # error raised, because "foo".upcase != "BAR"
+      #
+      # @example Actual parameter responds with "FOO" when :upcase is invoked and "oof" when :reverse is invoked.
+      #   object = mock()
+      #   object.expects(:method_1).with(responds_with(upcase: "FOO", reverse: "oof"))
+      #   object.method_1("foo")
+      #   # no error raised, because "foo".upcase == "FOO" and "foo".reverse == "oof"
+      def responds_with(*options)
+        case options.length
+        when 0
+          raise ArgumentError, 'No arguments. Expecting at least one.'
+        when 1
+          option = options.first
+          raise ArgumentError, 'Argument is not a Hash.' unless option.is_a?(Hash)
+          raise ArgumentError, 'Argument has no entries.' if option.empty?
 
-        matchers = option.map { |message, result| RespondsWith.new(message, result) }
-        AllOf.new(*matchers)
-      when 2
-        message, result = options
-        RespondsWith.new(message, result)
-      else
-        raise ArgumentError, 'Too many arguments; use either a single argument (must be a Hash) or two arguments (a message and a result).'
+          matchers = option.map { |message, result| RespondsWith.new(message, result) }
+          AllOf.new(*matchers)
+        when 2
+          message, result = options
+          RespondsWith.new(message, result)
+        else
+          raise ArgumentError, 'Too many arguments; use either a single argument (must be a Hash) or two arguments (a message and a result).'
+        end
       end
     end
 
+    define_deprecated_matcher_method(:responds_with)
+
     # Parameter matcher which matches if actual parameter returns expected result when specified method is invoked.
-    class RespondsWith < Base
+    class RespondsWith
+      include BaseMethods
+
       # @private
       def initialize(message, result)
         @message = message
@@ -72,5 +79,7 @@ module Mocha
         "responds_with(#{@message.mocha_inspect}, #{@result.mocha_inspect})"
       end
     end
+
+    provide_deprecated_access_to(:RespondsWith)
   end
 end

data/lib/mocha/parameter_matchers/yaml_equivalent.rb

@@ -1,32 +1,39 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 require 'yaml'
 
 module Mocha
   module ParameterMatchers
-    # Matches any YAML that represents the specified +object+
-    #
-    # @param [Object] object object whose YAML to compare.
-    # @return [YamlEquivalent] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Actual parameter is YAML equivalent of specified +object+.
-    #   object = mock()
-    #   object.expects(:method_1).with(yaml_equivalent(1, 2, 3))
-    #   object.method_1("--- \n- 1\n- 2\n- 3\n")
-    #   # no error raised
-    #
-    # @example Actual parameter is not YAML equivalent of specified +object+.
-    #   object = mock()
-    #   object.expects(:method_1).with(yaml_equivalent(1, 2, 3))
-    #   object.method_1("--- \n- 1\n- 2\n")
-    #   # error raised, because method_1 was not called with YAML representing the specified Array
-    def yaml_equivalent(object)
-      YamlEquivalent.new(object)
+    module Methods
+      # Matches any YAML that represents the specified +object+
+      #
+      # @param [Object] object object whose YAML to compare.
+      # @return [YamlEquivalent] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter is YAML equivalent of specified +object+.
+      #   object = mock()
+      #   object.expects(:method_1).with(yaml_equivalent(1, 2, 3))
+      #   object.method_1("--- \n- 1\n- 2\n- 3\n")
+      #   # no error raised
+      #
+      # @example Actual parameter is not YAML equivalent of specified +object+.
+      #   object = mock()
+      #   object.expects(:method_1).with(yaml_equivalent(1, 2, 3))
+      #   object.method_1("--- \n- 1\n- 2\n")
+      #   # error raised, because method_1 was not called with YAML representing the specified Array
+      def yaml_equivalent(object)
+        YamlEquivalent.new(object)
+      end
     end
 
+    define_deprecated_matcher_method(:yaml_equivalent)
+
     # Parameter matcher which matches if actual parameter is YAML equivalent of specified object.
-    class YamlEquivalent < Base
+    class YamlEquivalent
+      include BaseMethods
+
       # @private
       def initialize(object)
         @object = object
@@ -45,5 +52,7 @@ module Mocha
         "yaml_equivalent(#{@object.mocha_inspect})"
       end
     end
+
+    provide_deprecated_access_to(:YamlEquivalent)
   end
 end

data/lib/mocha/parameter_matchers.rb

@@ -1,8 +1,12 @@
 module Mocha
-  # Used as parameters for {Expectation#with} to restrict the parameter values which will match the expectation. Can be nested.
-  module ParameterMatchers; end
+  # Matcher classes used as parameters for {Expectation#with} to restrict the parameter values which will match the expectation. Can be nested. Build matcher instances in tests using methods in {Methods}, e.g. {Methods#includes}.
+  module ParameterMatchers
+    # These methods build instances of the {ParameterMatchers} classes which are used with {Expectation#with} to restrict the parameter values. Can be nested, e.g. see {Methods#all_of} examples.
+    module Methods; end
+  end
 end
 
+require 'mocha/parameter_matchers/deprecations'
 require 'mocha/parameter_matchers/instance_methods'
 
 require 'mocha/parameter_matchers/all_of'

data/lib/mocha/parameters_matcher.rb

@@ -22,9 +22,13 @@ module Mocha
     end
 
     def mocha_inspect
-      signature = matchers.mocha_inspect
-      signature = signature.gsub(/^\[|\]$/, '')
-      "(#{signature})"
+      if @matching_block
+        '(arguments_accepted_by_custom_matching_block)'
+      else
+        signature = matchers.mocha_inspect
+        signature = signature.gsub(/^\[|\]$/, '')
+        "(#{signature})"
+      end
     end
 
     def matchers

data/lib/mocha/version.rb

@@ -1,3 +1,3 @@
 module Mocha
-  VERSION = '2.7.0'.freeze
+  VERSION = '2.8.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mocha
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - James Mead
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-07 00:00:00.000000000 Z
+date: 2025-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby2_keywords
@@ -94,6 +94,7 @@ files:
 - lib/mocha/parameter_matchers/any_parameters.rb
 - lib/mocha/parameter_matchers/anything.rb
 - lib/mocha/parameter_matchers/base.rb
+- lib/mocha/parameter_matchers/deprecations.rb
 - lib/mocha/parameter_matchers/equals.rb
 - lib/mocha/parameter_matchers/equivalent_uri.rb
 - lib/mocha/parameter_matchers/has_entries.rb
@@ -154,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Mocking and stubbing library