mocha 2.8.2 → 3.0.0.pre.rc.1

data/lib/mocha/parameter_matchers/includes.rb

@@ -1,77 +1,74 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/all_of'
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    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
+    # 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
 
-    define_deprecated_matcher_method(:includes)
-
     # Parameter matcher which matches when actual parameter includes expected values.
     class Includes
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(*items)
@@ -79,25 +76,22 @@ module Mocha
       end
 
       # @private
-      # rubocop:disable Metrics/PerceivedComplexity
       def matches?(available_parameters)
         parameter = available_parameters.shift
         return false unless parameter.respond_to?(:include?)
+
         if @items.size == 1
-          # rubocop:disable Style/GuardClause
           if parameter.respond_to?(:any?) && !parameter.is_a?(String)
             parameter = parameter.keys if parameter.is_a?(Hash)
-            return parameter.any? { |p| @items.first.to_matcher.matches?([p]) }
+            parameter.any? { |p| @items.first.to_matcher.matches?([p]) }
           else
-            return parameter.include?(@items.first)
+            parameter.include?(@items.first)
           end
-          # rubocop:enable Style/GuardClause
         else
           includes_matchers = @items.map { |item| Includes.new(item) }
           AllOf.new(*includes_matchers).matches?([parameter])
         end
       end
-      # rubocop:enable Metrics/PerceivedComplexity
 
       # @private
       def mocha_inspect
@@ -105,7 +99,5 @@ module Mocha
         "includes(#{item_descriptions.join(', ')})"
       end
     end
-
-    provide_deprecated_access_to(:Includes)
   end
 end

data/lib/mocha/parameter_matchers/instance_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
 require 'mocha/parameter_matchers/equals'
 require 'mocha/parameter_matchers/positional_or_keyword_hash'
@@ -7,11 +9,11 @@ module Mocha
     # @private
     module InstanceMethods
       # @private
-      def to_matcher(expectation: nil, top_level: false)
-        if is_a?(BaseMethods)
+      def to_matcher(expectation: nil, top_level: false, last: false)
+        if Base === self
           self
         elsif Hash === self && top_level
-          Mocha::ParameterMatchers::PositionalOrKeywordHash.new(self, expectation)
+          Mocha::ParameterMatchers::PositionalOrKeywordHash.new(self, expectation, last)
         else
           Mocha::ParameterMatchers::Equals.new(self)
         end

data/lib/mocha/parameter_matchers/instance_of.rb

@@ -1,38 +1,35 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    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
+    # 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
 
-    define_deprecated_matcher_method(:instance_of)
-
     # Parameter matcher which matches when actual parameter is an instance of the specified class.
     class InstanceOf
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(klass)
@@ -50,7 +47,5 @@ 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,39 +1,36 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    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
+    # 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
 
-    define_deprecated_matcher_method(:is_a)
-
     # Parameter matcher which matches when actual parameter is a specific class.
     class IsA
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(klass)
@@ -51,7 +48,5 @@ 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,38 +1,35 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    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
+    # 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
 
-    define_deprecated_matcher_method(:kind_of)
-
     # Parameter matcher which matches when actual parameter is a kind of specified class.
     class KindOf
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(klass)
@@ -52,7 +49,5 @@ module Mocha
         "kind_of(#{@klass.mocha_inspect})"
       end
     end
-
-    provide_deprecated_access_to(:KindOf)
   end
 end

data/lib/mocha/parameter_matchers/not.rb

@@ -1,38 +1,35 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    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
+    # 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)
     end
 
-    define_deprecated_matcher_method(:Not)
-
     # Parameter matcher which inverts the logic of the specified matcher using a logical NOT operation.
     class Not
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(matcher)
@@ -50,7 +47,5 @@ module Mocha
         "Not(#{@matcher.mocha_inspect})"
       end
     end
-
-    provide_deprecated_access_to(:Not)
   end
 end

data/lib/mocha/parameter_matchers/optionally.rb

@@ -1,48 +1,44 @@
-require 'mocha/parameter_matchers/deprecations'
+# frozen_string_literal: true
 
 module Mocha
   module ParameterMatchers
-    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
+    # 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)
     end
 
-    define_deprecated_matcher_method(:optionally)
-
     # Parameter matcher which allows optional parameters to be specified.
     class Optionally
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(*parameters)
@@ -55,6 +51,7 @@ module Mocha
         while !available_parameters.empty? && (index < @matchers.length)
           matcher = @matchers[index]
           return false unless matcher.matches?(available_parameters)
+
           index += 1
         end
         true
@@ -65,7 +62,5 @@ module Mocha
         "optionally(#{@matchers.map(&:mocha_inspect).join(', ')})"
       end
     end
-
-    provide_deprecated_access_to(:Optionally)
   end
 end