mocha 2.7.0 → 2.8.0

data/lib/mocha/parameter_matchers/includes.rb

@@ -1,71 +1,78 @@
 require 'mocha/parameter_matchers/all_of'
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches any object that responds with +true+ to +include?(item)+
-    # for all items.
-    #
-    # @param [*Array] items expected items.
-    # @return [Includes] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Actual parameter includes all items.
-    #   object = mock()
-    #   object.expects(:method_1).with(includes('foo', 'bar'))
-    #   object.method_1(['foo', 'bar', 'baz'])
-    #   # no error raised
-    #
-    # @example Actual parameter does not include all items.
-    #   object.method_1(['foo', 'baz'])
-    #   # error raised, because ['foo', 'baz'] does not include 'bar'.
-    #
-    # @example Actual parameter includes item which matches nested matcher.
-    #   object = mock()
-    #   object.expects(:method_1).with(includes(has_key(:key)))
-    #   object.method_1(['foo', 'bar', {key: 'baz'}])
-    #   # no error raised
-    #
-    # @example Actual parameter does not include item matching nested matcher.
-    #   object.method_1(['foo', 'bar', {:other_key => 'baz'}])
-    #   # error raised, because no element matches `has_key(:key)` matcher
-    #
-    # @example Actual parameter is a String including substring.
-    #   object = mock()
-    #   object.expects(:method_1).with(includes('bar'))
-    #   object.method_1('foobarbaz')
-    #   # no error raised
-    #
-    # @example Actual parameter is a String not including substring.
-    #   object.method_1('foobaz')
-    #   # error raised, because 'foobaz' does not include 'bar'
-    #
-    # @example Actual parameter is a Hash including the given key.
-    #   object = mock()
-    #   object.expects(:method_1).with(includes(:bar))
-    #   object.method_1({foo: 1, bar: 2})
-    #   # no error raised
-    #
-    # @example Actual parameter is a Hash without the given key.
-    #   object.method_1({foo: 1, baz: 2})
-    #   # error raised, because hash does not include key 'bar'
-    #
-    # @example Actual parameter is a Hash with a key matching the given matcher.
-    #   object = mock()
-    #   object.expects(:method_1).with(includes(regexp_matches(/ar/)))
-    #   object.method_1({'foo' => 1, 'bar' => 2})
-    #   # no error raised
-    #
-    # @example Actual parameter is a Hash no key matching the given matcher.
-    #   object.method_1({'foo' => 1, 'baz' => 3})
-    #   # error raised, because hash does not include a key matching /ar/
-    def includes(*items)
-      Includes.new(*items)
+    module Methods
+      # Matches any object that responds with +true+ to +include?(item)+
+      # for all items.
+      #
+      # @param [*Array] items expected items.
+      # @return [Includes] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter includes all items.
+      #   object = mock()
+      #   object.expects(:method_1).with(includes('foo', 'bar'))
+      #   object.method_1(['foo', 'bar', 'baz'])
+      #   # no error raised
+      #
+      # @example Actual parameter does not include all items.
+      #   object.method_1(['foo', 'baz'])
+      #   # error raised, because ['foo', 'baz'] does not include 'bar'.
+      #
+      # @example Actual parameter includes item which matches nested matcher.
+      #   object = mock()
+      #   object.expects(:method_1).with(includes(has_key(:key)))
+      #   object.method_1(['foo', 'bar', {key: 'baz'}])
+      #   # no error raised
+      #
+      # @example Actual parameter does not include item matching nested matcher.
+      #   object.method_1(['foo', 'bar', {:other_key => 'baz'}])
+      #   # error raised, because no element matches `has_key(:key)` matcher
+      #
+      # @example Actual parameter is a String including substring.
+      #   object = mock()
+      #   object.expects(:method_1).with(includes('bar'))
+      #   object.method_1('foobarbaz')
+      #   # no error raised
+      #
+      # @example Actual parameter is a String not including substring.
+      #   object.method_1('foobaz')
+      #   # error raised, because 'foobaz' does not include 'bar'
+      #
+      # @example Actual parameter is a Hash including the given key.
+      #   object = mock()
+      #   object.expects(:method_1).with(includes(:bar))
+      #   object.method_1({foo: 1, bar: 2})
+      #   # no error raised
+      #
+      # @example Actual parameter is a Hash without the given key.
+      #   object.method_1({foo: 1, baz: 2})
+      #   # error raised, because hash does not include key 'bar'
+      #
+      # @example Actual parameter is a Hash with a key matching the given matcher.
+      #   object = mock()
+      #   object.expects(:method_1).with(includes(regexp_matches(/ar/)))
+      #   object.method_1({'foo' => 1, 'bar' => 2})
+      #   # no error raised
+      #
+      # @example Actual parameter is a Hash no key matching the given matcher.
+      #   object.method_1({'foo' => 1, 'baz' => 3})
+      #   # error raised, because hash does not include a key matching /ar/
+      def includes(*items)
+        Includes.new(*items)
+      end
     end
 
+    define_deprecated_matcher_method(:includes)
+
     # Parameter matcher which matches when actual parameter includes expected values.
-    class Includes < Base
+    class Includes
+      include BaseMethods
+
       # @private
       def initialize(*items)
         @items = items
@@ -98,5 +105,7 @@ module Mocha
         "includes(#{item_descriptions.join(', ')})"
       end
     end
+
+    provide_deprecated_access_to(:Includes)
   end
 end

data/lib/mocha/parameter_matchers/instance_methods.rb

@@ -8,7 +8,7 @@ module Mocha
     module InstanceMethods
       # @private
       def to_matcher(expectation: nil, top_level: false)
-        if Base === self
+        if is_a?(BaseMethods)
           self
         elsif Hash === self && top_level
           Mocha::ParameterMatchers::PositionalOrKeywordHash.new(self, expectation)

data/lib/mocha/parameter_matchers/instance_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 an instance of +klass+
-    #
-    # @param [Class] klass expected class.
-    # @return [InstanceOf] parameter matcher.
-    #
-    # @see Expectation#with
-    # @see Kernel#instance_of?
-    #
-    # @example Actual parameter is an instance of +String+.
-    #   object = mock()
-    #   object.expects(:method_1).with(instance_of(String))
-    #   object.method_1('string')
-    #   # no error raised
-    #
-    # @example Actual parameter is not an instance of +String+.
-    #   object = mock()
-    #   object.expects(:method_1).with(instance_of(String))
-    #   object.method_1(99)
-    #   # error raised, because method_1 was not called with an instance of String
-    def instance_of(klass)
-      InstanceOf.new(klass)
+    module Methods
+      # Matches any object that is an instance of +klass+
+      #
+      # @param [Class] klass expected class.
+      # @return [InstanceOf] parameter matcher.
+      #
+      # @see Expectation#with
+      # @see Kernel#instance_of?
+      #
+      # @example Actual parameter is an instance of +String+.
+      #   object = mock()
+      #   object.expects(:method_1).with(instance_of(String))
+      #   object.method_1('string')
+      #   # no error raised
+      #
+      # @example Actual parameter is not an instance of +String+.
+      #   object = mock()
+      #   object.expects(:method_1).with(instance_of(String))
+      #   object.method_1(99)
+      #   # error raised, because method_1 was not called with an instance of String
+      def instance_of(klass)
+        InstanceOf.new(klass)
+      end
     end
 
+    define_deprecated_matcher_method(:instance_of)
+
     # Parameter matcher which matches when actual parameter is an instance of the specified class.
-    class InstanceOf < Base
+    class InstanceOf
+      include BaseMethods
+
       # @private
       def initialize(klass)
         @klass = klass
@@ -43,5 +50,7 @@ module Mocha
         "instance_of(#{@klass.mocha_inspect})"
       end
     end
+
+    provide_deprecated_access_to(:InstanceOf)
   end
 end

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