mocha 2.7.1 → 2.8.0

data/lib/mocha/parameter_matchers/is_a.rb

@@ -1,33 +1,40 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches any object that is a +klass+.
-    #
-    # @param [Class] klass expected class.
-    # @return [IsA] parameter matcher.
-    #
-    # @see Expectation#with
-    # @see Kernel#is_a?
-    #
-    # @example Actual parameter is a +Integer+.
-    #   object = mock()
-    #   object.expects(:method_1).with(is_a(Integer))
-    #   object.method_1(99)
-    #   # no error raised
-    #
-    # @example Actual parameter is not a +Integer+.
-    #   object = mock()
-    #   object.expects(:method_1).with(is_a(Integer))
-    #   object.method_1('string')
-    #   # error raised, because method_1 was not called with an Integer
-    #
-    def is_a(klass) # rubocop:disable Naming/PredicateName
-      IsA.new(klass)
+    module Methods
+      # Matches any object that is a +klass+.
+      #
+      # @param [Class] klass expected class.
+      # @return [IsA] parameter matcher.
+      #
+      # @see Expectation#with
+      # @see Kernel#is_a?
+      #
+      # @example Actual parameter is a +Integer+.
+      #   object = mock()
+      #   object.expects(:method_1).with(is_a(Integer))
+      #   object.method_1(99)
+      #   # no error raised
+      #
+      # @example Actual parameter is not a +Integer+.
+      #   object = mock()
+      #   object.expects(:method_1).with(is_a(Integer))
+      #   object.method_1('string')
+      #   # error raised, because method_1 was not called with an Integer
+      #
+      def is_a(klass) # rubocop:disable Naming/PredicateName
+        IsA.new(klass)
+      end
     end
 
+    define_deprecated_matcher_method(:is_a)
+
     # Parameter matcher which matches when actual parameter is a specific class.
-    class IsA < Base
+    class IsA
+      include BaseMethods
+
       # @private
       def initialize(klass)
         @klass = klass
@@ -44,5 +51,7 @@ module Mocha
         "is_a(#{@klass.mocha_inspect})"
       end
     end
+
+    provide_deprecated_access_to(:IsA)
   end
 end

data/lib/mocha/parameter_matchers/kind_of.rb

@@ -1,32 +1,39 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches any +Object+ that is a kind of +klass+.
-    #
-    # @param [Class] klass expected class.
-    # @return [KindOf] parameter matcher.
-    #
-    # @see Expectation#with
-    # @see Kernel#kind_of?
-    #
-    # @example Actual parameter is a kind of +Integer+.
-    #   object = mock()
-    #   object.expects(:method_1).with(kind_of(Integer))
-    #   object.method_1(99)
-    #   # no error raised
-    #
-    # @example Actual parameter is not a kind of +Integer+.
-    #   object = mock()
-    #   object.expects(:method_1).with(kind_of(Integer))
-    #   object.method_1('string')
-    #   # error raised, because method_1 was not called with a kind of Integer
-    def kind_of(klass)
-      KindOf.new(klass)
+    module Methods
+      # Matches any +Object+ that is a kind of +klass+.
+      #
+      # @param [Class] klass expected class.
+      # @return [KindOf] parameter matcher.
+      #
+      # @see Expectation#with
+      # @see Kernel#kind_of?
+      #
+      # @example Actual parameter is a kind of +Integer+.
+      #   object = mock()
+      #   object.expects(:method_1).with(kind_of(Integer))
+      #   object.method_1(99)
+      #   # no error raised
+      #
+      # @example Actual parameter is not a kind of +Integer+.
+      #   object = mock()
+      #   object.expects(:method_1).with(kind_of(Integer))
+      #   object.method_1('string')
+      #   # error raised, because method_1 was not called with a kind of Integer
+      def kind_of(klass)
+        KindOf.new(klass)
+      end
     end
 
+    define_deprecated_matcher_method(:kind_of)
+
     # Parameter matcher which matches when actual parameter is a kind of specified class.
-    class KindOf < Base
+    class KindOf
+      include BaseMethods
+
       # @private
       def initialize(klass)
         @klass = klass
@@ -45,5 +52,7 @@ module Mocha
         "kind_of(#{@klass.mocha_inspect})"
       end
     end
+
+    provide_deprecated_access_to(:KindOf)
   end
 end

data/lib/mocha/parameter_matchers/not.rb

@@ -1,32 +1,39 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches if +matcher+ does *not* match.
-    #
-    # @param [Base] matcher matcher whose logic to invert.
-    # @return [Not] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Actual parameter does not include the value +1+.
-    #   object = mock()
-    #   object.expects(:method_1).with(Not(includes(1)))
-    #   object.method_1([0, 2, 3])
-    #   # no error raised
-    #
-    # @example Actual parameter does include the value +1+.
-    #   object = mock()
-    #   object.expects(:method_1).with(Not(includes(1)))
-    #   object.method_1([0, 1, 2, 3])
-    #   # error raised, because method_1 was not called with object not including 1
-    #
-    def Not(matcher) # rubocop:disable Naming/MethodName
-      Not.new(matcher)
+    module Methods
+      # Matches if +matcher+ does *not* match.
+      #
+      # @param [BaseMethods] matcher matcher whose logic to invert.
+      # @return [Not] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter does not include the value +1+.
+      #   object = mock()
+      #   object.expects(:method_1).with(Not(includes(1)))
+      #   object.method_1([0, 2, 3])
+      #   # no error raised
+      #
+      # @example Actual parameter does include the value +1+.
+      #   object = mock()
+      #   object.expects(:method_1).with(Not(includes(1)))
+      #   object.method_1([0, 1, 2, 3])
+      #   # error raised, because method_1 was not called with object not including 1
+      #
+      def Not(matcher) # rubocop:disable Naming/MethodName
+        Not.new(matcher)
+      end
     end
 
+    define_deprecated_matcher_method(:Not)
+
     # Parameter matcher which inverts the logic of the specified matcher using a logical NOT operation.
-    class Not < Base
+    class Not
+      include BaseMethods
+
       # @private
       def initialize(matcher)
         @matcher = matcher
@@ -43,5 +50,7 @@ module Mocha
         "Not(#{@matcher.mocha_inspect})"
       end
     end
+
+    provide_deprecated_access_to(:Not)
   end
 end

data/lib/mocha/parameter_matchers/optionally.rb

@@ -1,41 +1,49 @@
+require 'mocha/parameter_matchers/deprecations'
+
 module Mocha
   module ParameterMatchers
-    # Matches optional parameters if available.
-    #
-    # @param [*Array<Base>] matchers matchers for optional parameters.
-    # @return [Optionally] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Only the two required parameters are supplied and they both match their expected value.
-    #   object = mock()
-    #   object.expects(:method_1).with(1, 2, optionally(3, 4))
-    #   object.method_1(1, 2)
-    #   # no error raised
-    #
-    # @example Both required parameters and one of the optional parameters are supplied and they all match their expected value.
-    #   object = mock()
-    #   object.expects(:method_1).with(1, 2, optionally(3, 4))
-    #   object.method_1(1, 2, 3)
-    #   # no error raised
-    #
-    # @example Both required parameters and both of the optional parameters are supplied and they all match their expected value.
-    #   object = mock()
-    #   object.expects(:method_1).with(1, 2, optionally(3, 4))
-    #   object.method_1(1, 2, 3, 4)
-    #   # no error raised
-    #
-    # @example One of the actual optional parameters does not match the expected value.
-    #   object = mock()
-    #   object.expects(:method_1).with(1, 2, optionally(3, 4))
-    #   object.method_1(1, 2, 3, 5)
-    #   # error raised, because optional parameters did not match
-    def optionally(*matchers)
-      Optionally.new(*matchers)
+    module Methods
+      # Matches optional parameters if available.
+      #
+      # @param [*Array<BaseMethods>] matchers matchers for optional parameters.
+      # @return [Optionally] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Only the two required parameters are supplied and they both match their expected value.
+      #   object = mock()
+      #   object.expects(:method_1).with(1, 2, optionally(3, 4))
+      #   object.method_1(1, 2)
+      #   # no error raised
+      #
+      # @example Both required parameters and one of the optional parameters are supplied and they all match their expected value.
+      #   object = mock()
+      #   object.expects(:method_1).with(1, 2, optionally(3, 4))
+      #   object.method_1(1, 2, 3)
+      #   # no error raised
+      #
+      # @example Both required parameters and both of the optional parameters are supplied and they all match their expected value.
+      #   object = mock()
+      #   object.expects(:method_1).with(1, 2, optionally(3, 4))
+      #   object.method_1(1, 2, 3, 4)
+      #   # no error raised
+      #
+      # @example One of the actual optional parameters does not match the expected value.
+      #   object = mock()
+      #   object.expects(:method_1).with(1, 2, optionally(3, 4))
+      #   object.method_1(1, 2, 3, 5)
+      #   # error raised, because optional parameters did not match
+      def optionally(*matchers)
+        Optionally.new(*matchers)
+      end
     end
 
+    define_deprecated_matcher_method(:optionally)
+
     # Parameter matcher which allows optional parameters to be specified.
-    class Optionally < Base
+    class Optionally
+      include BaseMethods
+
       # @private
       def initialize(*parameters)
         @matchers = parameters.map(&:to_matcher)
@@ -57,5 +65,7 @@ module Mocha
         "optionally(#{@matchers.map(&:mocha_inspect).join(', ')})"
       end
     end
+
+    provide_deprecated_access_to(:Optionally)
   end
 end

data/lib/mocha/parameter_matchers/positional_or_keyword_hash.rb

@@ -2,11 +2,14 @@ require 'mocha/configuration'
 require 'mocha/deprecation'
 require 'mocha/parameter_matchers/base'
 require 'mocha/parameter_matchers/has_entries'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
     # @private
-    class PositionalOrKeywordHash < Base
+    class PositionalOrKeywordHash
+      include BaseMethods
+
       def initialize(value, expectation)
         @value = value
         @expectation = expectation
@@ -62,5 +65,7 @@ module Mocha
         "defined at #{@expectation.definition_location}"
       end
     end
+
+    provide_deprecated_access_to(:PositionalOrKeywordHash)
   end
 end

data/lib/mocha/parameter_matchers/regexp_matches.rb

@@ -1,32 +1,39 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches any object that matches +regexp+.
-    #
-    # @param [Regexp] regexp regular expression to match.
-    # @return [RegexpMatches] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Actual parameter is matched by specified regular expression.
-    #   object = mock()
-    #   object.expects(:method_1).with(regexp_matches(/e/))
-    #   object.method_1('hello')
-    #   # no error raised
-    #
-    # @example Actual parameter is not matched by specified regular expression.
-    #   object = mock()
-    #   object.expects(:method_1).with(regexp_matches(/a/))
-    #   object.method_1('hello')
-    #   # error raised, because method_1 was not called with a parameter that matched the
-    #   # regular expression
-    def regexp_matches(regexp)
-      RegexpMatches.new(regexp)
+    module Methods
+      # Matches any object that matches +regexp+.
+      #
+      # @param [Regexp] regexp regular expression to match.
+      # @return [RegexpMatches] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter is matched by specified regular expression.
+      #   object = mock()
+      #   object.expects(:method_1).with(regexp_matches(/e/))
+      #   object.method_1('hello')
+      #   # no error raised
+      #
+      # @example Actual parameter is not matched by specified regular expression.
+      #   object = mock()
+      #   object.expects(:method_1).with(regexp_matches(/a/))
+      #   object.method_1('hello')
+      #   # error raised, because method_1 was not called with a parameter that matched the
+      #   # regular expression
+      def regexp_matches(regexp)
+        RegexpMatches.new(regexp)
+      end
     end
 
+    define_deprecated_matcher_method(:regexp_matches)
+
     # Parameter matcher which matches if specified regular expression matches actual paramter.
-    class RegexpMatches < Base
+    class RegexpMatches
+      include BaseMethods
+
       # @private
       def initialize(regexp)
         @regexp = regexp
@@ -44,5 +51,7 @@ module Mocha
         "regexp_matches(#{@regexp.mocha_inspect})"
       end
     end
+
+    provide_deprecated_access_to(:RegexpMatches)
   end
 end

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

@@ -1,3 +1,3 @@
 module Mocha
-  VERSION = '2.7.1'.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.1
+  version: 2.8.0
 platform: ruby
 authors:
 - James Mead
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-09 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