mocha 2.8.0 → 3.0.0.pre.rc.1

data/lib/mocha/mockery.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 require 'mocha/central'
 require 'mocha/mock'
-require 'mocha/names'
-require 'mocha/receivers'
+require 'mocha/name'
+require 'mocha/impersonating_name'
+require 'mocha/impersonating_any_instance_name'
+require 'mocha/object_receiver'
+require 'mocha/any_instance_receiver'
 require 'mocha/state_machine'
 require 'mocha/logger'
 require 'mocha/configuration'
@@ -49,9 +54,13 @@ module Mocha
       end
 
       def teardown(origin = nil)
+        if @instances.nil?
+          raise NotInitializedError, 'Mocha::Mockery.teardown called before Mocha::Mockery.setup'
+        end
+
         instance.teardown(origin)
       ensure
-        @instances.pop
+        @instances.pop unless @instances.nil?
       end
     end
 
@@ -124,12 +133,11 @@ module Mocha
     def on_stubbing(object, method)
       signature_proc = lambda { "#{object.mocha_inspect}.#{method}" }
       check(:stubbing_non_existent_method, 'non-existent method', signature_proc) do
-        !(object.stubba_class.__method_exists__?(method, true) || object.respond_to?(method))
+        !(object.stubba_class.__method_exists__?(method) || object.respond_to?(method))
       end
       check(:stubbing_non_public_method, 'non-public method', signature_proc) do
-        object.stubba_class.__method_exists__?(method, false)
+        object.stubba_class.__method_exists__?(method, include_public_methods: false)
       end
-      check(:stubbing_method_on_nil, 'method on nil', signature_proc) { object.nil? }
       check(:stubbing_method_on_non_mock_object, 'method on non-mock object', signature_proc)
     end
 
@@ -144,9 +152,11 @@ module Mocha
     def check(action, description, signature_proc, backtrace = caller)
       treatment = Mocha.configuration.send(action)
       return if (treatment == :allow) || (block_given? && !yield)
+
       method_signature = signature_proc.call
       message = "stubbing #{description}: #{method_signature}"
       raise StubbingError.new(message, backtrace) if treatment == :prevent
+
       logger.warn(message) if treatment == :warn
     end
 

data/lib/mocha/name.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mocha
+  class Name
+    def initialize(name)
+      @name = name.to_s
+    end
+
+    def mocha_inspect
+      "#<Mock:#{@name}>"
+    end
+  end
+end

data/lib/mocha/not_initialized_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/error_with_filtered_backtrace'
 
 module Mocha

data/lib/mocha/object_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mocha/mockery'
 require 'mocha/instance_method'
 require 'mocha/argument_iterator'
@@ -12,7 +14,7 @@ module Mocha
     alias_method :_method, :method
 
     # @private
-    def mocha(instantiate = true)
+    def mocha(instantiate: true)
       if instantiate
         @mocha ||= Mocha::Mockery.instance.mock_impersonating(self)
       else
@@ -75,11 +77,11 @@ module Mocha
       if frozen?
         raise StubbingError.new("can't stub method on frozen object: #{mocha_inspect}", caller)
       end
+
       expectation = nil
       mockery = Mocha::Mockery.instance
       iterator = ArgumentIterator.new(expected_methods_vs_return_values)
-      iterator.each do |*args|
-        method_name = args.shift
+      iterator.each do |method_name, *args|
         mockery.on_stubbing(self, method_name)
         method = stubba_method.new(stubba_object, method_name)
         mockery.stubba.stub(method)
@@ -121,11 +123,11 @@ module Mocha
       if frozen?
         raise StubbingError.new("can't stub method on frozen object: #{mocha_inspect}", caller)
       end
+
       expectation = nil
       mockery = Mocha::Mockery.instance
       iterator = ArgumentIterator.new(stubbed_methods_vs_return_values)
-      iterator.each do |*args|
-        method_name = args.shift
+      iterator.each do |method_name, *args|
         mockery.on_stubbing(self, method_name)
         method = stubba_method.new(stubba_object, method_name)
         mockery.stubba.stub(method)

data/lib/mocha/object_receiver.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Mocha
+  class ObjectReceiver
+    def initialize(object)
+      @object = object
+    end
+
+    def mocks
+      object = @object
+      mocks = []
+      while object
+        mocha = object.mocha(instantiate: false)
+        mocks << mocha if mocha
+        object = object.is_a?(Class) ? object.superclass : nil
+      end
+      mocks
+    end
+  end
+end

data/lib/mocha/parameter_matchers/all_of.rb

@@ -1,37 +1,34 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    module Methods
-      # Matches if all +matchers+ match.
-      #
-      # @param [*Array<BaseMethods>] matchers parameter matchers.
-      # @return [AllOf] parameter matcher.
-      #
-      # @see Expectation#with
-      #
-      # @example All parameter matchers match.
-      #   object = mock()
-      #   object.expects(:method_1).with(all_of(includes(1), includes(3)))
-      #   object.method_1([1, 3])
-      #   # no error raised
-      #
-      # @example One of the parameter matchers does not match.
-      #   object = mock()
-      #   object.expects(:method_1).with(all_of(includes(1), includes(3)))
-      #   object.method_1([1, 2])
-      #   # error raised, because method_1 was not called with object including 1 and 3
-      def all_of(*matchers)
-        AllOf.new(*matchers)
-      end
+    # Matches if all +matchers+ match.
+    #
+    # @param [*Array<Base>] matchers parameter matchers.
+    # @return [AllOf] parameter matcher.
+    #
+    # @see Expectation#with
+    #
+    # @example All parameter matchers match.
+    #   object = mock()
+    #   object.expects(:method_1).with(all_of(includes(1), includes(3)))
+    #   object.method_1([1, 3])
+    #   # no error raised
+    #
+    # @example One of the parameter matchers does not match.
+    #   object = mock()
+    #   object.expects(:method_1).with(all_of(includes(1), includes(3)))
+    #   object.method_1([1, 2])
+    #   # error raised, because method_1 was not called with object including 1 and 3
+    def all_of(*matchers)
+      AllOf.new(*matchers)
     end
 
-    define_deprecated_matcher_method(:all_of)
-
     # Parameter matcher which combines a number of other matchers using a logical AND.
     class AllOf
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(*matchers)
@@ -49,7 +46,5 @@ module Mocha
         "all_of(#{@matchers.map(&:mocha_inspect).join(', ')})"
       end
     end
-
-    provide_deprecated_access_to(:AllOf)
   end
 end

data/lib/mocha/parameter_matchers/any_of.rb

@@ -1,43 +1,40 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    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
+    # 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)
     end
 
-    define_deprecated_matcher_method(:any_of)
-
     # Parameter matcher which combines a number of other matchers using a logical OR.
     class AnyOf
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(*matchers)
@@ -55,7 +52,5 @@ 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,35 +1,32 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    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
+    # 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
 
-    define_deprecated_matcher_method(:any_parameters)
-
     # Parameter matcher which always matches whatever the parameters.
     class AnyParameters
-      include BaseMethods
+      include Base
 
       # @private
       def matches?(available_parameters)
@@ -44,7 +41,5 @@ module Mocha
         'any_parameters'
       end
     end
-
-    provide_deprecated_access_to(:AnyParameters)
   end
 end

data/lib/mocha/parameter_matchers/anything.rb

@@ -1,32 +1,29 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 
 module Mocha
   module ParameterMatchers
-    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
+    # 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
 
-    define_deprecated_matcher_method(:anything)
-
     # Parameter matcher which always matches a single parameter.
     class Anything
-      include BaseMethods
+      include Base
 
       # @private
       def matches?(available_parameters)
@@ -39,7 +36,5 @@ module Mocha
         'anything'
       end
     end
-
-    provide_deprecated_access_to(:Anything)
   end
 end

data/lib/mocha/parameter_matchers/base.rb

@@ -1,17 +1,16 @@
-require 'mocha/deprecation'
-require 'mocha/parameter_matchers/deprecations'
+# frozen_string_literal: true
 
 module Mocha
   module ParameterMatchers
-    # @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
+    # @abstract Include 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}.
+    module Base
       # 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 [BaseMethods] other parameter matcher.
+      # @param [Base] other parameter matcher.
       # @return [AllOf] parameter matcher.
       #
       # @see Expectation#with
@@ -35,7 +34,7 @@ module Mocha
       #
       # This shorthand will not work with an implicit equals match. Instead, an explicit {Equals} matcher should be used.
       #
-      # @param [BaseMethods] other parameter matcher.
+      # @param [Base] other parameter matcher.
       # @return [AnyOf] parameter matcher.
       #
       # @see Expectation#with
@@ -59,20 +58,5 @@ module Mocha
         AnyOf.new(self, other)
       end
     end
-
-    # @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/equals.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+ 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
+    # 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
 
-    define_deprecated_matcher_method(:equals)
-
     # Parameter matcher which matches when actual parameter equals expected value.
     class Equals
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(value)
@@ -50,7 +47,5 @@ module Mocha
         @value.mocha_inspect
       end
     end
-
-    provide_deprecated_access_to(:Equals)
   end
 end

data/lib/mocha/parameter_matchers/equivalent_uri.rb

@@ -1,39 +1,36 @@
+# frozen_string_literal: true
+
 require 'mocha/parameter_matchers/base'
-require 'mocha/parameter_matchers/deprecations'
 require 'uri'
 require 'cgi'
 
 module Mocha
   module ParameterMatchers
-    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
+    # 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
 
-    define_deprecated_matcher_method(:equivalent_uri)
-
     # Parameter matcher which matches URIs with equivalent query strings.
     class EquivalentUri
-      include BaseMethods
+      include Base
 
       # @private
       def initialize(uri)
@@ -60,7 +57,5 @@ 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