mocha 2.7.1 → 2.8.0

data/lib/mocha/parameter_matchers/has_entry.rb

@@ -1,61 +1,68 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches +Hash+ containing entry with +key+ and +value+.
-    #
-    # @overload def has_entry(key, value)
-    #   @param [Object] key key for entry.
-    #   @param [Object] value value for entry.
-    # @overload def has_entry(single_entry_hash)
-    #   @param [Hash] single_entry_hash +Hash+ with single entry.
-    #   @raise [ArgumentError] if +single_entry_hash+ does not contain exactly one entry.
-    #
-    # @return [HasEntry] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Actual parameter contains expected entry supplied as key and value.
-    #   object = mock()
-    #   object.expects(:method_1).with(has_entry('key_1', 1))
-    #   object.method_1('key_1' => 1, 'key_2' => 2)
-    #   # no error raised
-    #
-    # @example Actual parameter contains expected entry supplied as +Hash+ entry.
-    #   object = mock()
-    #   object.expects(:method_1).with(has_entry('key_1' => 1))
-    #   object.method_1('key_1' => 1, 'key_2' => 2)
-    #   # no error raised
-    #
-    # @example Actual parameter does not contain expected entry supplied as key and value.
-    #   object = mock()
-    #   object.expects(:method_1).with(has_entry('key_1', 1))
-    #   object.method_1('key_1' => 2, 'key_2' => 1)
-    #   # error raised, because method_1 was not called with Hash containing entry: 'key_1' => 1
-    #
-    # @example Actual parameter does not contain expected entry supplied as +Hash+ entry.
-    #
-    #   object = mock()
-    #   object.expects(:method_1).with(has_entry('key_1' => 1))
-    #   object.method_1('key_1' => 2, 'key_2' => 1)
-    #   # error raised, because method_1 was not called with Hash containing entry: 'key_1' => 1
-    #
-    def has_entry(*options) # rubocop:disable Naming/PredicateName
-      case options.length
-      when 0
-        raise ArgumentError, 'No arguments. Expecting at least one.'
-      when 1
-        key, value = parse_option(options[0])
-      when 2
-        key, value = options
-      else
-        raise ArgumentError, 'Too many arguments; use either a single argument (must be a Hash) or two arguments (a key and a value).'
+    module Methods
+      # Matches +Hash+ containing entry with +key+ and +value+.
+      #
+      # @overload def has_entry(key, value)
+      #   @param [Object] key key for entry.
+      #   @param [Object] value value for entry.
+      # @overload def has_entry(single_entry_hash)
+      #   @param [Hash] single_entry_hash +Hash+ with single entry.
+      #   @raise [ArgumentError] if +single_entry_hash+ does not contain exactly one entry.
+      #
+      # @return [HasEntry] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter contains expected entry supplied as key and value.
+      #   object = mock()
+      #   object.expects(:method_1).with(has_entry('key_1', 1))
+      #   object.method_1('key_1' => 1, 'key_2' => 2)
+      #   # no error raised
+      #
+      # @example Actual parameter contains expected entry supplied as +Hash+ entry.
+      #   object = mock()
+      #   object.expects(:method_1).with(has_entry('key_1' => 1))
+      #   object.method_1('key_1' => 1, 'key_2' => 2)
+      #   # no error raised
+      #
+      # @example Actual parameter does not contain expected entry supplied as key and value.
+      #   object = mock()
+      #   object.expects(:method_1).with(has_entry('key_1', 1))
+      #   object.method_1('key_1' => 2, 'key_2' => 1)
+      #   # error raised, because method_1 was not called with Hash containing entry: 'key_1' => 1
+      #
+      # @example Actual parameter does not contain expected entry supplied as +Hash+ entry.
+      #
+      #   object = mock()
+      #   object.expects(:method_1).with(has_entry('key_1' => 1))
+      #   object.method_1('key_1' => 2, 'key_2' => 1)
+      #   # error raised, because method_1 was not called with Hash containing entry: 'key_1' => 1
+      #
+      def has_entry(*options) # rubocop:disable Naming/PredicateName
+        case options.length
+        when 0
+          raise ArgumentError, 'No arguments. Expecting at least one.'
+        when 1
+          key, value = HasEntry.parse_option(options[0])
+        when 2
+          key, value = options
+        else
+          raise ArgumentError, 'Too many arguments; use either a single argument (must be a Hash) or two arguments (a key and a value).'
+        end
+        HasEntry.new(key, value)
       end
-      HasEntry.new(key, value)
     end
 
+    define_deprecated_matcher_method(:has_entry)
+
     # Parameter matcher which matches when actual parameter contains expected +Hash+ entry.
-    class HasEntry < Base
+    class HasEntry
+      include BaseMethods
+
       # @private
       def initialize(key, value)
         @key = key
@@ -74,25 +81,25 @@ module Mocha
       def mocha_inspect
         "has_entry(#{@key.mocha_inspect} => #{@value.mocha_inspect})"
       end
-    end
-
-    private
 
-    # @private
-    def parse_option(option)
-      case option
-      when Hash
-        case option.length
-        when 0
-          raise ArgumentError, 'Argument has no entries.'
-        when 1
-          option.first
+      # @private
+      def self.parse_option(option)
+        case option
+        when Hash
+          case option.length
+          when 0
+            raise ArgumentError, 'Argument has no entries.'
+          when 1
+            option.first
+          else
+            raise ArgumentError, 'Argument has multiple entries. Use Mocha::ParameterMatchers#has_entries instead.'
+          end
         else
-          raise ArgumentError, 'Argument has multiple entries. Use Mocha::ParameterMatchers#has_entries instead.'
+          raise ArgumentError, 'Argument is not a Hash.'
         end
-      else
-        raise ArgumentError, 'Argument is not a Hash.'
       end
     end
+
+    provide_deprecated_access_to(:HasEntry)
   end
 end

data/lib/mocha/parameter_matchers/has_key.rb

@@ -1,32 +1,39 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches +Hash+ containing +key+.
-    #
-    # @param [Object] key expected key.
-    # @return [HasKey] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Actual parameter contains entry with expected key.
-    #   object = mock()
-    #   object.expects(:method_1).with(has_key('key_1'))
-    #   object.method_1('key_1' => 1, 'key_2' => 2)
-    #   # no error raised
-    #
-    # @example Actual parameter does not contain entry with expected key.
-    #   object = mock()
-    #   object.expects(:method_1).with(has_key('key_1'))
-    #   object.method_1('key_2' => 2)
-    #   # error raised, because method_1 was not called with Hash containing key: 'key_1'
-    #
-    def has_key(key) # rubocop:disable Naming/PredicateName
-      HasKey.new(key)
+    module Methods
+      # Matches +Hash+ containing +key+.
+      #
+      # @param [Object] key expected key.
+      # @return [HasKey] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter contains entry with expected key.
+      #   object = mock()
+      #   object.expects(:method_1).with(has_key('key_1'))
+      #   object.method_1('key_1' => 1, 'key_2' => 2)
+      #   # no error raised
+      #
+      # @example Actual parameter does not contain entry with expected key.
+      #   object = mock()
+      #   object.expects(:method_1).with(has_key('key_1'))
+      #   object.method_1('key_2' => 2)
+      #   # error raised, because method_1 was not called with Hash containing key: 'key_1'
+      #
+      def has_key(key) # rubocop:disable Naming/PredicateName
+        HasKey.new(key)
+      end
     end
 
+    define_deprecated_matcher_method(:has_key)
+
     # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected key.
-    class HasKey < Base
+    class HasKey
+      include BaseMethods
+
       # @private
       def initialize(key)
         @key = key
@@ -44,5 +51,7 @@ module Mocha
         "has_key(#{@key.mocha_inspect})"
       end
     end
+
+    provide_deprecated_access_to(:HasKey)
   end
 end

data/lib/mocha/parameter_matchers/has_keys.rb

@@ -1,32 +1,39 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches +Hash+ containing +keys+.
-    #
-    # @param [*Array<Object>] keys expected keys.
-    # @return [HasKeys] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Actual parameter contains entry with expected keys.
-    #   object = mock()
-    #   object.expects(:method_1).with(has_keys(:key_1, :key_2))
-    #   object.method_1(:key_1 => 1, :key_2 => 2, :key_3 => 3)
-    #   # no error raised
-    #
-    # @example Actual parameter does not contain all expected keys.
-    #   object = mock()
-    #   object.expects(:method_1).with(has_keys(:key_1, :key_2))
-    #   object.method_1(:key_2 => 2)
-    #   # error raised, because method_1 was not called with Hash containing key: :key_1
-    #
-    def has_keys(*keys) # rubocop:disable Naming/PredicateName
-      HasKeys.new(*keys)
+    module Methods
+      # Matches +Hash+ containing +keys+.
+      #
+      # @param [*Array<Object>] keys expected keys.
+      # @return [HasKeys] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter contains entry with expected keys.
+      #   object = mock()
+      #   object.expects(:method_1).with(has_keys(:key_1, :key_2))
+      #   object.method_1(:key_1 => 1, :key_2 => 2, :key_3 => 3)
+      #   # no error raised
+      #
+      # @example Actual parameter does not contain all expected keys.
+      #   object = mock()
+      #   object.expects(:method_1).with(has_keys(:key_1, :key_2))
+      #   object.method_1(:key_2 => 2)
+      #   # error raised, because method_1 was not called with Hash containing key: :key_1
+      #
+      def has_keys(*keys) # rubocop:disable Naming/PredicateName
+        HasKeys.new(*keys)
+      end
     end
 
+    define_deprecated_matcher_method(:has_keys)
+
     # Parameter matcher which matches when actual parameter contains +Hash+ with all expected keys.
-    class HasKeys < Base
+    class HasKeys
+      include BaseMethods
+
       # @private
       def initialize(*keys)
         raise ArgumentError, 'No arguments. Expecting at least one.' if keys.empty?
@@ -49,5 +56,7 @@ module Mocha
         "has_keys(#{@keys.mocha_inspect(false)})"
       end
     end
+
+    provide_deprecated_access_to(:HasKeys)
   end
 end

data/lib/mocha/parameter_matchers/has_value.rb

@@ -1,32 +1,39 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches +Hash+ containing +value+.
-    #
-    # @param [Object] value expected value.
-    # @return [HasValue] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Actual parameter contains entry with expected value.
-    #   object = mock()
-    #   object.expects(:method_1).with(has_value(1))
-    #   object.method_1('key_1' => 1, 'key_2' => 2)
-    #   # no error raised
-    #
-    # @example Actual parameter does not contain entry with expected value.
-    #   object = mock()
-    #   object.expects(:method_1).with(has_value(1))
-    #   object.method_1('key_2' => 2)
-    #   # error raised, because method_1 was not called with Hash containing value: 1
-    #
-    def has_value(value) # rubocop:disable Naming/PredicateName
-      HasValue.new(value)
+    module Methods
+      # Matches +Hash+ containing +value+.
+      #
+      # @param [Object] value expected value.
+      # @return [HasValue] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter contains entry with expected value.
+      #   object = mock()
+      #   object.expects(:method_1).with(has_value(1))
+      #   object.method_1('key_1' => 1, 'key_2' => 2)
+      #   # no error raised
+      #
+      # @example Actual parameter does not contain entry with expected value.
+      #   object = mock()
+      #   object.expects(:method_1).with(has_value(1))
+      #   object.method_1('key_2' => 2)
+      #   # error raised, because method_1 was not called with Hash containing value: 1
+      #
+      def has_value(value) # rubocop:disable Naming/PredicateName
+        HasValue.new(value)
+      end
     end
 
+    define_deprecated_matcher_method(:has_value)
+
     # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected value.
-    class HasValue < Base
+    class HasValue
+      include BaseMethods
+
       # @private
       def initialize(value)
         @value = value
@@ -44,5 +51,7 @@ module Mocha
         "has_value(#{@value.mocha_inspect})"
       end
     end
+
+    provide_deprecated_access_to(:HasValue)
   end
 end

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