mocha 3.0.0.pre.rc.1 → 3.0.0.pre.rc.2

data/lib/mocha/object_methods.rb

@@ -4,14 +4,21 @@ require 'mocha/mockery'
 require 'mocha/instance_method'
 require 'mocha/argument_iterator'
 require 'mocha/expectation_error_factory'
+require 'mocha/ignoring_warning'
 
 module Mocha
   # Methods added to all objects to allow mocking and stubbing on real (i.e. non-mock) objects.
   #
   # Both {#expects} and {#stubs} return an {Expectation} which can be further modified by methods on {Expectation}.
   module ObjectMethods
+    extend IgnoringWarning
+
     # @private
-    alias_method :_method, :method
+    JRUBY_ALIAS_SPECIAL_METHODS_WARNING = /accesses caller method's state and should not be aliased/.freeze
+
+    ignoring_warning(JRUBY_ALIAS_SPECIAL_METHODS_WARNING, if_: RUBY_ENGINE == 'jruby') do
+      alias_method :_method, :method
+    end
 
     # @private
     def mocha(instantiate: true)
@@ -42,6 +49,11 @@ module Mocha
       singleton_class
     end
 
+    # @private
+    def stubba_respond_to?(symbol)
+      respond_to?(symbol)
+    end
+
     # Adds an expectation that the specified method must be called exactly once with any parameters.
     #
     # The original implementation of the method is replaced during the test and then restored at the end of the test. The temporary replacement method has the same visibility as the original method.

data/lib/mocha/parameter_matchers/all_of.rb

@@ -1,34 +1,36 @@
 # frozen_string_literal: true
 
-require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/base_methods'
 
 module Mocha
   module ParameterMatchers
-    # 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)
+    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
     end
 
     # Parameter matcher which combines a number of other matchers using a logical AND.
     class AllOf
-      include Base
+      include BaseMethods
 
       # @private
       def initialize(*matchers)

data/lib/mocha/parameter_matchers/any_of.rb

@@ -1,40 +1,42 @@
 # frozen_string_literal: true
 
-require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/base_methods'
 
 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
 
     # Parameter matcher which combines a number of other matchers using a logical OR.
     class AnyOf
-      include Base
+      include BaseMethods
 
       # @private
       def initialize(*matchers)

data/lib/mocha/parameter_matchers/any_parameters.rb

@@ -1,32 +1,34 @@
 # frozen_string_literal: true
 
-require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/base_methods'
 
 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
 
     # Parameter matcher which always matches whatever the parameters.
     class AnyParameters
-      include Base
+      include BaseMethods
 
       # @private
       def matches?(available_parameters)

data/lib/mocha/parameter_matchers/anything.rb

@@ -1,29 +1,31 @@
 # frozen_string_literal: true
 
-require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/base_methods'
 
 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
 
     # Parameter matcher which always matches a single parameter.
     class Anything
-      include Base
+      include BaseMethods
 
       # @private
       def matches?(available_parameters)

data/lib/mocha/parameter_matchers/{base.rb → base_methods.rb}

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
+require 'mocha/deprecation'
+
 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 {ParameterMatchers} to build an instance of the new matcher c.f. {#equals}.
-    module Base
+    # @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
@@ -34,7 +36,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

data/lib/mocha/parameter_matchers/equals.rb

@@ -1,35 +1,37 @@
 # frozen_string_literal: true
 
-require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/base_methods'
 
 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
 
     # Parameter matcher which matches when actual parameter equals expected value.
     class Equals
-      include Base
+      include BaseMethods
 
       # @private
       def initialize(value)

data/lib/mocha/parameter_matchers/equivalent_uri.rb

@@ -1,36 +1,37 @@
 # frozen_string_literal: true
 
-require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/base_methods'
 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
 
     # Parameter matcher which matches URIs with equivalent query strings.
     class EquivalentUri
-      include Base
+      include BaseMethods
 
       # @private
       def initialize(uri)
@@ -53,7 +54,10 @@ module Mocha
 
       # @private
       def explode(uri)
-        query_hash = CGI.parse(uri.query || '')
+        query_hash = Hash.new { |hash, key| hash[key] = [] }
+        URI.decode_www_form(uri.query || '').each do |key, value|
+          query_hash[key] << value
+        end
         URI::Generic::COMPONENT.inject({}) { |h, k| h.merge(k => uri.__send__(k)) }.merge(query: query_hash)
       end
     end

data/lib/mocha/parameter_matchers/has_entries.rb

@@ -1,37 +1,39 @@
 # frozen_string_literal: true
 
-require 'mocha/parameter_matchers/base'
+require 'mocha/parameter_matchers/base_methods'
 require 'mocha/parameter_matchers/all_of'
 require 'mocha/parameter_matchers/has_entry'
 
 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/PredicatePrefix
+        HasEntries.new(entries)
+      end
     end
 
     # Parameter matcher which matches when actual parameter contains all expected +Hash+ entries.
     class HasEntries
-      include Base
+      include BaseMethods
 
       # @private
       def initialize(entries, exact: false)