mocha 2.1.0 → 2.8.2

data/lib/mocha/parameter_matchers/any_of.rb

@@ -1,37 +1,44 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches if any +matchers+ match.
-    #
-    # @param [*Array<Base>] matchers parameter matchers.
-    # @return [AnyOf] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example One parameter matcher matches.
-    #   object = mock()
-    #   object.expects(:method_1).with(any_of(1, 3))
-    #   object.method_1(1)
-    #   # no error raised
-    #
-    # @example The other parameter matcher matches.
-    #   object = mock()
-    #   object.expects(:method_1).with(any_of(1, 3))
-    #   object.method_1(3)
-    #   # no error raised
-    #
-    # @example Neither parameter matcher matches.
-    #   object = mock()
-    #   object.expects(:method_1).with(any_of(1, 3))
-    #   object.method_1(2)
-    #   # error raised, because method_1 was not called with 1 or 3
-    def any_of(*matchers)
-      AnyOf.new(*matchers)
+    module Methods
+      # Matches if any +matchers+ match.
+      #
+      # @param [*Array<BaseMethods>] matchers parameter matchers.
+      # @return [AnyOf] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example One parameter matcher matches.
+      #   object = mock()
+      #   object.expects(:method_1).with(any_of(1, 3))
+      #   object.method_1(1)
+      #   # no error raised
+      #
+      # @example The other parameter matcher matches.
+      #   object = mock()
+      #   object.expects(:method_1).with(any_of(1, 3))
+      #   object.method_1(3)
+      #   # no error raised
+      #
+      # @example Neither parameter matcher matches.
+      #   object = mock()
+      #   object.expects(:method_1).with(any_of(1, 3))
+      #   object.method_1(2)
+      #   # error raised, because method_1 was not called with 1 or 3
+      def any_of(*matchers)
+        AnyOf.new(*matchers)
+      end
     end
 
+    define_deprecated_matcher_method(:any_of)
+
     # Parameter matcher which combines a number of other matchers using a logical OR.
-    class AnyOf < Base
+    class AnyOf
+      include BaseMethods
+
       # @private
       def initialize(*matchers)
         @matchers = matchers
@@ -48,5 +55,7 @@ module Mocha
         "any_of(#{@matchers.map(&:mocha_inspect).join(', ')})"
       end
     end
+
+    provide_deprecated_access_to(:AnyOf)
   end
 end

data/lib/mocha/parameter_matchers/any_parameters.rb

@@ -1,29 +1,36 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches any parameters. This is used as the default for a newly built expectation.
-    #
-    # @return [AnyParameters] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Any parameters will match.
-    #   object = mock()
-    #   object.expects(:method_1).with(any_parameters)
-    #   object.method_1(1, 2, 3, 4)
-    #   # no error raised
-    #
-    #   object = mock()
-    #   object.expects(:method_1).with(any_parameters)
-    #   object.method_1(5, 6, 7, 8, 9, 0)
-    #   # no error raised
-    def any_parameters
-      AnyParameters.new
+    module Methods
+      # Matches any parameters. This is used as the default for a newly built expectation.
+      #
+      # @return [AnyParameters] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Any parameters will match.
+      #   object = mock()
+      #   object.expects(:method_1).with(any_parameters)
+      #   object.method_1(1, 2, 3, 4)
+      #   # no error raised
+      #
+      #   object = mock()
+      #   object.expects(:method_1).with(any_parameters)
+      #   object.method_1(5, 6, 7, 8, 9, 0)
+      #   # no error raised
+      def any_parameters
+        AnyParameters.new
+      end
     end
 
+    define_deprecated_matcher_method(:any_parameters)
+
     # Parameter matcher which always matches whatever the parameters.
-    class AnyParameters < Base
+    class AnyParameters
+      include BaseMethods
+
       # @private
       def matches?(available_parameters)
         until available_parameters.empty?
@@ -37,5 +44,7 @@ module Mocha
         'any_parameters'
       end
     end
+
+    provide_deprecated_access_to(:AnyParameters)
   end
 end

data/lib/mocha/parameter_matchers/anything.rb

@@ -1,26 +1,33 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches any object.
-    #
-    # @return [Anything] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Any object will match.
-    #   object = mock()
-    #   object.expects(:method_1).with(anything)
-    #   object.method_1('foo')
-    #   object.method_1(789)
-    #   object.method_1(:bar)
-    #   # no error raised
-    def anything
-      Anything.new
+    module Methods
+      # Matches any object.
+      #
+      # @return [Anything] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Any object will match.
+      #   object = mock()
+      #   object.expects(:method_1).with(anything)
+      #   object.method_1('foo')
+      #   object.method_1(789)
+      #   object.method_1(:bar)
+      #   # no error raised
+      def anything
+        Anything.new
+      end
     end
 
+    define_deprecated_matcher_method(:anything)
+
     # Parameter matcher which always matches a single parameter.
-    class Anything < Base
+    class Anything
+      include BaseMethods
+
       # @private
       def matches?(available_parameters)
         available_parameters.shift
@@ -32,5 +39,7 @@ module Mocha
         'anything'
       end
     end
+
+    provide_deprecated_access_to(:Anything)
   end
 end

data/lib/mocha/parameter_matchers/base.rb

@@ -1,19 +1,17 @@
+require 'mocha/deprecation'
+require 'mocha/parameter_matchers/deprecations'
+
 module Mocha
   module ParameterMatchers
-    # @abstract Subclass and implement +#matches?+ and +#mocha_inspect+ to define a custom matcher. Also add a suitably named instance method to {ParameterMatchers} to build an instance of the new matcher c.f. {#equals}.
-    class Base
-      # @private
-      def to_matcher(_expectation = nil)
-        self
-      end
-
+    # @abstract Include and implement +#matches?+ and +#mocha_inspect+ to define a custom matcher. Also add a suitably named instance method to {Methods} to build an instance of the new matcher c.f. {Methods#equals}.
+    module BaseMethods
       # A shorthand way of combining two matchers when both must match.
       #
       # Returns a new {AllOf} parameter matcher combining two matchers using a logical AND.
       #
       # This shorthand will not work with an implicit equals match. Instead, an explicit {Equals} matcher should be used.
       #
-      # @param [Base] other parameter matcher.
+      # @param [BaseMethods] other parameter matcher.
       # @return [AllOf] parameter matcher.
       #
       # @see Expectation#with
@@ -21,12 +19,12 @@ module Mocha
       # @example Alternative ways to combine matchers with a logical AND.
       #   object = mock()
       #   object.expects(:run).with(all_of(has_key(:foo), has_key(:bar)))
-      #   object.run(:foo => 'foovalue', :bar => 'barvalue')
+      #   object.run(foo: 'foovalue', bar: 'barvalue')
       #
       #   # is exactly equivalent to
       #
       #   object.expects(:run).with(has_key(:foo) & has_key(:bar))
-      #   object.run(:foo => 'foovalue', :bar => 'barvalue)
+      #   object.run(foo: 'foovalue', bar: 'barvalue)
       def &(other)
         AllOf.new(self, other)
       end
@@ -37,7 +35,7 @@ module Mocha
       #
       # This shorthand will not work with an implicit equals match. Instead, an explicit {Equals} matcher should be used.
       #
-      # @param [Base] other parameter matcher.
+      # @param [BaseMethods] other parameter matcher.
       # @return [AnyOf] parameter matcher.
       #
       # @see Expectation#with
@@ -45,12 +43,12 @@ module Mocha
       # @example Alternative ways to combine matchers with a logical OR.
       #   object = mock()
       #   object.expects(:run).with(any_of(has_key(:foo), has_key(:bar)))
-      #   object.run(:foo => 'foovalue')
+      #   object.run(foo: 'foovalue')
       #
       #   # is exactly equivalent to
       #
       #   object.expects(:run).with(has_key(:foo) | has_key(:bar))
-      #   object.run(:foo => 'foovalue')
+      #   object.run(foo: 'foovalue')
       #
       # @example Using an explicit {Equals} matcher in combination with {#|}.
       #   object.expects(:run).with(equals(1) | equals(2))
@@ -61,5 +59,22 @@ module Mocha
         AnyOf.new(self, other)
       end
     end
+
+    provide_deprecated_access_to(:BaseMethods)
+
+    # @deprecated Include +BaseMethods+ module instead.
+    class Base
+      include BaseMethods
+
+      # @private
+      def self.inherited(subclass)
+        super
+        Deprecation.warning(
+          "Include #{BaseMethods} module into #{subclass} instead of inheriting from #{self}."
+        )
+      end
+    end
+
+    provide_deprecated_access_to(:Base)
   end
 end

data/lib/mocha/parameter_matchers/deprecations.rb

@@ -0,0 +1,44 @@
+require 'mocha/deprecation'
+require 'set'
+
+module Mocha
+  module ParameterMatchers
+    module Deprecations
+      # @private
+      def const_missing(name)
+        if ParameterMatchers.access_deprecated?(name)
+          mod = ParameterMatchers.const_get(name)
+          Deprecation.warning(
+            "Referencing #{name} outside its namespace is deprecated. Use fully-qualified #{mod} instead."
+          )
+          mod
+        else
+          super(name)
+        end
+      end
+    end
+
+    # @private
+    @classes_with_access_deprecated = Set.new
+
+    # @private
+    def self.provide_deprecated_access_to(name)
+      @classes_with_access_deprecated.add(name)
+    end
+
+    # @private
+    def self.access_deprecated?(name)
+      @classes_with_access_deprecated.include?(name)
+    end
+
+    # @private
+    def self.define_deprecated_matcher_method(name)
+      define_method(name) do |*args|
+        Deprecation.warning(
+          "Calling #{ParameterMatchers}##{name} is deprecated. Use #{Methods}##{name} instead."
+        )
+        Methods.instance_method(name).bind(self).call(*args)
+      end
+    end
+  end
+end

data/lib/mocha/parameter_matchers/equals.rb

@@ -1,32 +1,39 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches any +Object+ equalling +value+.
-    #
-    # @param [Object] value expected value.
-    # @return [Equals] parameter matcher.
-    #
-    # @see Expectation#with
-    # @see Object#==
-    #
-    # @example Actual parameter equals expected parameter.
-    #   object = mock()
-    #   object.expects(:method_1).with(equals(2))
-    #   object.method_1(2)
-    #   # no error raised
-    #
-    # @example Actual parameter does not equal expected parameter.
-    #   object = mock()
-    #   object.expects(:method_1).with(equals(2))
-    #   object.method_1(3)
-    #   # error raised, because method_1 was not called with an +Object+ that equals 2
-    def equals(value)
-      Equals.new(value)
+    module Methods
+      # Matches any +Object+ equalling +value+.
+      #
+      # @param [Object] value expected value.
+      # @return [Equals] parameter matcher.
+      #
+      # @see Expectation#with
+      # @see Object#==
+      #
+      # @example Actual parameter equals expected parameter.
+      #   object = mock()
+      #   object.expects(:method_1).with(equals(2))
+      #   object.method_1(2)
+      #   # no error raised
+      #
+      # @example Actual parameter does not equal expected parameter.
+      #   object = mock()
+      #   object.expects(:method_1).with(equals(2))
+      #   object.method_1(3)
+      #   # error raised, because method_1 was not called with an +Object+ that equals 2
+      def equals(value)
+        Equals.new(value)
+      end
     end
 
+    define_deprecated_matcher_method(:equals)
+
     # Parameter matcher which matches when actual parameter equals expected value.
-    class Equals < Base
+    class Equals
+      include BaseMethods
+
       # @private
       def initialize(value)
         @value = value
@@ -43,5 +50,7 @@ module Mocha
         @value.mocha_inspect
       end
     end
+
+    provide_deprecated_access_to(:Equals)
   end
 end

data/lib/mocha/parameter_matchers/equivalent_uri.rb

@@ -1,33 +1,40 @@
 require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/deprecations'
 require 'uri'
 require 'cgi'
 
 module Mocha
   module ParameterMatchers
-    # Matches a URI without regard to the ordering of parameters in the query string.
-    #
-    # @param [String] uri URI to match.
-    # @return [EquivalentUri] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Actual URI is equivalent.
-    #   object = mock()
-    #   object.expects(:method_1).with(equivalent_uri('http://example.com/foo?a=1&b=2))
-    #   object.method_1('http://example.com/foo?b=2&a=1')
-    #   # no error raised
-    #
-    # @example Actual URI is not equivalent.
-    #   object = mock()
-    #   object.expects(:method_1).with(equivalent_uri('http://example.com/foo?a=1&b=2))
-    #   object.method_1('http://example.com/foo?a=1&b=3')
-    #   # error raised, because the query parameters were different
-    def equivalent_uri(uri)
-      EquivalentUri.new(uri)
+    module Methods
+      # Matches a URI without regard to the ordering of parameters in the query string.
+      #
+      # @param [String] uri URI to match.
+      # @return [EquivalentUri] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual URI is equivalent.
+      #   object = mock()
+      #   object.expects(:method_1).with(equivalent_uri('http://example.com/foo?a=1&b=2))
+      #   object.method_1('http://example.com/foo?b=2&a=1')
+      #   # no error raised
+      #
+      # @example Actual URI is not equivalent.
+      #   object = mock()
+      #   object.expects(:method_1).with(equivalent_uri('http://example.com/foo?a=1&b=2))
+      #   object.method_1('http://example.com/foo?a=1&b=3')
+      #   # error raised, because the query parameters were different
+      def equivalent_uri(uri)
+        EquivalentUri.new(uri)
+      end
     end
 
+    define_deprecated_matcher_method(:equivalent_uri)
+
     # Parameter matcher which matches URIs with equivalent query strings.
-    class EquivalentUri < Base
+    class EquivalentUri
+      include BaseMethods
+
       # @private
       def initialize(uri)
         @uri = URI.parse(uri)
@@ -53,5 +60,7 @@ module Mocha
         URI::Generic::COMPONENT.inject({}) { |h, k| h.merge(k => uri.__send__(k)) }.merge(query: query_hash)
       end
     end
+
+    provide_deprecated_access_to(:EquivalentUri)
   end
 end

data/lib/mocha/parameter_matchers/has_entries.rb

@@ -1,50 +1,64 @@
 require 'mocha/parameter_matchers/base'
 require 'mocha/parameter_matchers/all_of'
 require 'mocha/parameter_matchers/has_entry'
+require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    # Matches +Hash+ containing all +entries+.
-    #
-    # @param [Hash] entries expected +Hash+ entries.
-    # @return [HasEntries] parameter matcher.
-    #
-    # @see Expectation#with
-    #
-    # @example Actual parameter contains all expected entries.
-    #   object = mock()
-    #   object.expects(:method_1).with(has_entries('key_1' => 1, 'key_2' => 2))
-    #   object.method_1('key_1' => 1, 'key_2' => 2, 'key_3' => 3)
-    #   # no error raised
-    #
-    # @example Actual parameter does not contain all expected entries.
-    #   object = mock()
-    #   object.expects(:method_1).with(has_entries('key_1' => 1, 'key_2' => 2))
-    #   object.method_1('key_1' => 1, 'key_2' => 99)
-    #   # error raised, because method_1 was not called with Hash containing entries: 'key_1' => 1, 'key_2' => 2
-    #
-    def has_entries(entries) # rubocop:disable Naming/PredicateName
-      HasEntries.new(entries)
+    module Methods
+      # Matches +Hash+ containing all +entries+.
+      #
+      # @param [Hash] entries expected +Hash+ entries.
+      # @return [HasEntries] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter contains all expected entries.
+      #   object = mock()
+      #   object.expects(:method_1).with(has_entries('key_1' => 1, 'key_2' => 2))
+      #   object.method_1('key_1' => 1, 'key_2' => 2, 'key_3' => 3)
+      #   # no error raised
+      #
+      # @example Actual parameter does not contain all expected entries.
+      #   object = mock()
+      #   object.expects(:method_1).with(has_entries('key_1' => 1, 'key_2' => 2))
+      #   object.method_1('key_1' => 1, 'key_2' => 99)
+      #   # error raised, because method_1 was not called with Hash containing entries: 'key_1' => 1, 'key_2' => 2
+      #
+      def has_entries(entries) # rubocop:disable Naming/PredicateName
+        HasEntries.new(entries)
+      end
     end
 
+    define_deprecated_matcher_method(:has_entries)
+
     # Parameter matcher which matches when actual parameter contains all expected +Hash+ entries.
-    class HasEntries < Base
+    class HasEntries
+      include BaseMethods
+
       # @private
-      def initialize(entries)
+      def initialize(entries, exact: false)
         @entries = entries
+        @exact = exact
       end
 
       # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
+        return false unless parameter
+        return false unless parameter.respond_to?(:keys)
+        return false if @exact && @entries.length != parameter.keys.length
+
         has_entry_matchers = @entries.map { |key, value| HasEntry.new(key, value) }
         AllOf.new(*has_entry_matchers).matches?([parameter])
       end
 
       # @private
       def mocha_inspect
-        "has_entries(#{@entries.mocha_inspect})"
+        @exact ? @entries.mocha_inspect : "has_entries(#{@entries.mocha_inspect})"
       end
     end
+
+    provide_deprecated_access_to(:HasEntries)
   end
 end