mocha 1.1.0 → 2.0.2

data/lib/mocha/parameter_matchers/includes.rb

@@ -2,9 +2,7 @@ require 'mocha/parameter_matchers/all_of'
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any object that responds with +true+ to +include?(item)+
     # for all items.
     #
@@ -22,39 +20,83 @@ module Mocha
     # @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
 
     # Parameter matcher which matches when actual parameter includes expected values.
     class Includes < Base
-
       # @private
       def initialize(*items)
         @items = items
       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
-          return parameter.include?(@items.first)
+          # 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]) }
+          else
+            return 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
         item_descriptions = @items.map(&:mocha_inspect)
         "includes(#{item_descriptions.join(', ')})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/instance_methods.rb

@@ -0,0 +1,27 @@
+require 'mocha/parameter_matchers/equals'
+require 'mocha/parameter_matchers/positional_or_keyword_hash'
+
+module Mocha
+  module ParameterMatchers
+    # @private
+    module InstanceMethods
+      # @private
+      def to_matcher(_expectation = nil)
+        Mocha::ParameterMatchers::Equals.new(self)
+      end
+    end
+  end
+end
+
+# @private
+class Object
+  include Mocha::ParameterMatchers::InstanceMethods
+end
+
+# @private
+class Hash
+  # @private
+  def to_matcher(expectation = nil)
+    Mocha::ParameterMatchers::PositionalOrKeywordHash.new(self, expectation)
+  end
+end

data/lib/mocha/parameter_matchers/instance_of.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any object that is an instance of +klass+
     #
     # @param [Class] klass expected class.
@@ -29,7 +27,6 @@ module Mocha
 
     # Parameter matcher which matches when actual parameter is an instance of the specified class.
     class InstanceOf < Base
-
       # @private
       def initialize(klass)
         @klass = klass
@@ -45,9 +42,6 @@ module Mocha
       def mocha_inspect
         "instance_of(#{@klass.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/is_a.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any object that is a +klass+.
     #
     # @param [Class] klass expected class.
@@ -23,13 +21,13 @@ module Mocha
     #   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)
+    #
+    def is_a(klass) # rubocop:disable Naming/PredicateName
       IsA.new(klass)
     end
 
     # Parameter matcher which matches when actual parameter is a specific class.
     class IsA < Base
-
       # @private
       def initialize(klass)
         @klass = klass
@@ -45,9 +43,6 @@ module Mocha
       def mocha_inspect
         "is_a(#{@klass.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/kind_of.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any +Object+ that is a kind of +klass+.
     #
     # @param [Class] klass expected class.
@@ -29,7 +27,6 @@ module Mocha
 
     # Parameter matcher which matches when actual parameter is a kind of specified class.
     class KindOf < Base
-
       # @private
       def initialize(klass)
         @klass = klass
@@ -38,16 +35,15 @@ module Mocha
       # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
+        # rubocop:disable Style/ClassCheck
         parameter.kind_of?(@klass)
+        # rubocop:enable Style/ClassCheck
       end
 
       # @private
       def mocha_inspect
         "kind_of(#{@klass.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/not.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches if +matcher+ does *not* match.
     #
     # @param [Base] matcher matcher whose logic to invert.
@@ -22,13 +20,13 @@ module Mocha
     #   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)
+    #
+    def Not(matcher) # rubocop:disable Naming/MethodName
       Not.new(matcher)
     end
 
     # Parameter matcher which inverts the logic of the specified matcher using a logical NOT operation.
     class Not < Base
-
       # @private
       def initialize(matcher)
         @matcher = matcher
@@ -44,9 +42,6 @@ module Mocha
       def mocha_inspect
         "Not(#{@matcher.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/optionally.rb

@@ -1,7 +1,5 @@
 module Mocha
-
   module ParameterMatchers
-
     # Matches optional parameters if available.
     #
     # @param [*Array<Base>] matchers matchers for optional parameters.
@@ -38,30 +36,26 @@ module Mocha
 
     # Parameter matcher which allows optional parameters to be specified.
     class Optionally < Base
-
       # @private
       def initialize(*parameters)
-        @matchers = parameters.map { |parameter| parameter.to_matcher }
+        @matchers = parameters.map(&:to_matcher)
       end
 
       # @private
       def matches?(available_parameters)
         index = 0
-        while (available_parameters.length > 0) && (index < @matchers.length) do
+        while !available_parameters.empty? && (index < @matchers.length)
           matcher = @matchers[index]
           return false unless matcher.matches?(available_parameters)
           index += 1
         end
-        return true
+        true
       end
 
       # @private
       def mocha_inspect
-        "optionally(#{@matchers.map { |matcher| matcher.mocha_inspect }.join(", ") })"
+        "optionally(#{@matchers.map(&:mocha_inspect).join(', ')})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/positional_or_keyword_hash.rb

@@ -0,0 +1,64 @@
+require 'mocha/configuration'
+require 'mocha/deprecation'
+require 'mocha/parameter_matchers/base'
+
+module Mocha
+  module ParameterMatchers
+    # @private
+    class PositionalOrKeywordHash < Base
+      def initialize(value, expectation)
+        @value = value
+        @expectation = expectation
+      end
+
+      def matches?(available_parameters)
+        parameter, is_last_parameter = extract_parameter(available_parameters)
+        return false unless parameter == @value
+
+        if is_last_parameter && !same_type_of_hash?(parameter, @value)
+          return false if Mocha.configuration.strict_keyword_argument_matching?
+
+          deprecation_warning(parameter, @value) if Mocha::RUBY_V27_PLUS
+        end
+
+        true
+      end
+
+      def mocha_inspect
+        @value.mocha_inspect
+      end
+
+      private
+
+      def extract_parameter(available_parameters)
+        [available_parameters.shift, available_parameters.empty?]
+      end
+
+      def same_type_of_hash?(actual, expected)
+        ruby2_keywords_hash?(actual) == ruby2_keywords_hash?(expected)
+      end
+
+      def deprecation_warning(actual, expected)
+        details1 = "Expectation #{expectation_definition} expected #{hash_type(expected)} (#{expected.mocha_inspect}),".squeeze(' ')
+        details2 = "but received #{hash_type(actual)} (#{actual.mocha_inspect})."
+        sentence1 = 'These will stop matching when strict keyword argument matching is enabled.'
+        sentence2 = 'See the documentation for Mocha::Configuration#strict_keyword_argument_matching=.'
+        Deprecation.warning([details1, details2, sentence1, sentence2].join(' '))
+      end
+
+      def hash_type(hash)
+        ruby2_keywords_hash?(hash) ? 'keyword arguments' : 'positional hash'
+      end
+
+      def ruby2_keywords_hash?(hash)
+        hash.is_a?(Hash) && ::Hash.ruby2_keywords_hash?(hash)
+      end
+
+      def expectation_definition
+        return nil unless @expectation
+
+        "defined at #{@expectation.definition_location}"
+      end
+    end
+  end
+end

data/lib/mocha/parameter_matchers/regexp_matches.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any object that matches +regexp+.
     #
     # @param [Regexp] regexp regular expression to match.
@@ -29,7 +27,6 @@ module Mocha
 
     # Parameter matcher which matches if specified regular expression matches actual paramter.
     class RegexpMatches < Base
-
       # @private
       def initialize(regexp)
         @regexp = regexp
@@ -46,9 +43,6 @@ module Mocha
       def mocha_inspect
         "regexp_matches(#{@regexp.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/responds_with.rb

@@ -2,9 +2,7 @@ require 'mocha/parameter_matchers/base'
 require 'yaml'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any object that responds to +message+ with +result+. To put it another way, it tests the quack, not the duck.
     #
     # @param [Symbol] message method to invoke.
@@ -30,25 +28,22 @@ module Mocha
 
     # Parameter matcher which matches if actual parameter returns expected result when specified method is invoked.
     class RespondsWith < Base
-
       # @private
       def initialize(message, result)
-        @message, @result = message, result
+        @message = message
+        @result = result
       end
 
       # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
-        @result.to_matcher.matches?( [parameter.__send__(@message)] )
+        @result.to_matcher.matches?([parameter.__send__(@message)])
       end
 
       # @private
       def mocha_inspect
         "responds_with(#{@message.mocha_inspect}, #{@result.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/yaml_equivalent.rb

@@ -2,9 +2,7 @@ require 'mocha/parameter_matchers/base'
 require 'yaml'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches any YAML that represents the specified +object+
     #
     # @param [Object] object object whose YAML to compare.
@@ -29,7 +27,6 @@ module Mocha
 
     # Parameter matcher which matches if actual parameter is YAML equivalent of specified object.
     class YamlEquivalent < Base
-
       # @private
       def initialize(object)
         @object = object
@@ -38,16 +35,15 @@ module Mocha
       # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
+        # rubocop:disable Security/YAMLLoad
         @object == YAML.load(parameter)
+        # rubocop:enable Security/YAMLLoad
       end
 
       # @private
       def mocha_inspect
         "yaml_equivalent(#{@object.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers.rb

@@ -1,11 +1,9 @@
 module Mocha
-
   # Used as parameters for {Expectation#with} to restrict the parameter values which will match the expectation. Can be nested.
   module ParameterMatchers; end
-
 end
 
-require 'mocha/parameter_matchers/object'
+require 'mocha/parameter_matchers/instance_methods'
 
 require 'mocha/parameter_matchers/all_of'
 require 'mocha/parameter_matchers/any_of'
@@ -15,6 +13,7 @@ require 'mocha/parameter_matchers/equals'
 require 'mocha/parameter_matchers/has_entry'
 require 'mocha/parameter_matchers/has_entries'
 require 'mocha/parameter_matchers/has_key'
+require 'mocha/parameter_matchers/has_keys'
 require 'mocha/parameter_matchers/has_value'
 require 'mocha/parameter_matchers/includes'
 require 'mocha/parameter_matchers/instance_of'
@@ -25,4 +24,4 @@ require 'mocha/parameter_matchers/optionally'
 require 'mocha/parameter_matchers/regexp_matches'
 require 'mocha/parameter_matchers/responds_with'
 require 'mocha/parameter_matchers/yaml_equivalent'
-require 'mocha/parameter_matchers/query_string'
+require 'mocha/parameter_matchers/equivalent_uri'

data/lib/mocha/parameters_matcher.rb

@@ -2,36 +2,33 @@ require 'mocha/inspect'
 require 'mocha/parameter_matchers'
 
 module Mocha
-
   class ParametersMatcher
-
-    def initialize(expected_parameters = [ParameterMatchers::AnyParameters.new], &matching_block)
-      @expected_parameters, @matching_block = expected_parameters, matching_block
+    def initialize(expected_parameters = [ParameterMatchers::AnyParameters.new], expectation = nil, &matching_block)
+      @expected_parameters = expected_parameters
+      @expectation = expectation
+      @matching_block = matching_block
     end
 
     def match?(actual_parameters = [])
       if @matching_block
-        return @matching_block.call(*actual_parameters)
+        @matching_block.call(*actual_parameters)
       else
-        return parameters_match?(actual_parameters)
+        parameters_match?(actual_parameters)
       end
     end
 
     def parameters_match?(actual_parameters)
-      matchers.all? { |matcher| matcher.matches?(actual_parameters) } && (actual_parameters.length == 0)
+      matchers.all? { |matcher| matcher.matches?(actual_parameters) } && actual_parameters.empty?
     end
 
     def mocha_inspect
       signature = matchers.mocha_inspect
       signature = signature.gsub(/^\[|\]$/, '')
-      signature = signature.gsub(/^\{|\}$/, '') if matchers.length == 1
       "(#{signature})"
     end
 
     def matchers
-      @expected_parameters.map { |parameter| parameter.to_matcher }
+      @expected_parameters.map { |p| p.to_matcher(@expectation) }
     end
-
   end
-
 end

data/lib/mocha/raised_exception.rb

@@ -0,0 +1,11 @@
+module Mocha
+  class RaisedException
+    def initialize(exception)
+      @exception = exception
+    end
+
+    def mocha_inspect
+      "raised #{@exception}"
+    end
+  end
+end

data/lib/mocha/receivers.rb

@@ -1,41 +1,39 @@
 module Mocha
-
   class ObjectReceiver
-
     def initialize(object)
       @object = object
     end
 
     def mocks
-      object, mocks = @object, []
-      while object do
-        mocks << object.mocha
+      object = @object
+      mocks = []
+      while object
+        mocha = object.mocha(false)
+        mocks << mocha if mocha
         object = object.is_a?(Class) ? object.superclass : nil
       end
       mocks
     end
-
   end
 
   class AnyInstanceReceiver
-
     def initialize(klass)
       @klass = klass
     end
 
     def mocks
-      klass, mocks = @klass, []
-      while klass do
-        mocks << klass.any_instance.mocha
+      klass = @klass
+      mocks = []
+      while klass
+        mocha = klass.any_instance.mocha(false)
+        mocks << mocha if mocha
         klass = klass.superclass
       end
       mocks
     end
-
   end
 
   class DefaultReceiver
-
     def initialize(mock)
       @mock = mock
     end
@@ -43,7 +41,5 @@ module Mocha
     def mocks
       [@mock]
     end
-
   end
-
 end

data/lib/mocha/return_values.rb

@@ -1,9 +1,7 @@
 require 'mocha/single_return_value'
 
 module Mocha
-
   class ReturnValues
-
     def self.build(*values)
       new(*values.map { |value| SingleReturnValue.new(value) })
     end
@@ -14,18 +12,16 @@ module Mocha
       @values = values
     end
 
-    def next
+    def next(invocation)
       case @values.length
-        when 0 then nil
-        when 1 then @values.first.evaluate
-        else @values.shift.evaluate
+      when 0 then nil
+      when 1 then @values.first.evaluate(invocation)
+      else @values.shift.evaluate(invocation)
       end
     end
 
     def +(other)
       self.class.new(*(@values + other.values))
     end
-
   end
-
 end

data/lib/mocha/ruby_version.rb

@@ -0,0 +1,3 @@
+module Mocha
+  RUBY_V27_PLUS = Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.7')
+end