mocha 1.2.1 → 1.16.1

data/lib/mocha/parameter_matchers/{query_string.rb → equivalent_uri.rb}

@@ -1,34 +1,34 @@
+require 'mocha/deprecation'
 require 'mocha/parameter_matchers/base'
 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 [QueryStringMatches] parameter matcher.
+    # @return [EquivalentUri] parameter matcher.
     #
     # @see Expectation#with
     #
-    # @example Actual URI has equivalent query string.
+    # @example Actual URI is equivalent.
     #   object = mock()
-    #   object.expects(:method_1).with(has_equivalent_query_string('http://example.com/foo?a=1&b=2))
+    #   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 does not have equivalent query string.
+    # @example Actual URI is not equivalent.
     #   object = mock()
-    #   object.expects(:method_1).with(has_equivalent_query_string('http://example.com/foo?a=1&b=2))
+    #   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 has_equivalent_query_string(uri)
-      QueryStringMatches.new(uri)
+    def equivalent_uri(uri)
+      EquivalentUri.new(uri)
     end
 
     # Parameter matcher which matches URIs with equivalent query strings.
-    class QueryStringMatches < Base
-
+    class EquivalentUri < Base
       # @private
       def initialize(uri)
         @uri = URI.parse(uri)
@@ -43,16 +43,16 @@ module Mocha
 
       # @private
       def mocha_inspect
-        "has_equivalent_query_string(#{@uri.mocha_inspect})"
+        "equivalent_uri(#{@uri.mocha_inspect})"
       end
 
-    private
+      private
+
       # @private
       def explode(uri)
-        query_hash = (uri.query || '').split('&').inject({}){ |h, kv| h.merge(Hash[*kv.split('=')]) }
-        URI::Generic::COMPONENT.inject({}){ |h, k| h.merge(k => uri.__send__(k)) }.merge(:query => query_hash)
+        query_hash = CGI.parse(uri.query || '')
+        URI::Generic::COMPONENT.inject({}) { |h, k| h.merge(k => uri.__send__(k)) }.merge(:query => query_hash)
       end
-
     end
   end
 end

data/lib/mocha/parameter_matchers/has_entries.rb

@@ -3,9 +3,7 @@ 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.
@@ -24,13 +22,13 @@ module Mocha
     #   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)
+    #
+    def has_entries(entries) # rubocop:disable Naming/PredicateName
       HasEntries.new(entries)
     end
 
     # Parameter matcher which matches when actual parameter contains all expected +Hash+ entries.
     class HasEntries < Base
-
       # @private
       def initialize(entries)
         @entries = entries
@@ -47,9 +45,6 @@ module Mocha
       def mocha_inspect
         "has_entries(#{@entries.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/has_entry.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches +Hash+ containing entry with +key+ and +value+.
     #
     # @overload def has_entry(key, value)
@@ -41,36 +39,27 @@ module Mocha
     #   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)
+    #
+    def has_entry(*options) # rubocop:disable Naming/PredicateName
       case options.length
+      when 0
+        raise ArgumentError, 'No arguments. Expecting at least one.'
       when 1
-        case options[0]
-        when Hash
-          case options[0].length
-          when 0
-            raise ArgumentError.new("Argument has no entries.")
-          when 1
-            key, value = options[0].first
-          else
-            raise ArgumentError.new("Argument has multiple entries. Use Mocha::ParameterMatchers#has_entries instead.")
-          end
-        else
-          raise ArgumentError.new("Argument is not a Hash.")
-        end
+        key, value = parse_option(options[0])
       when 2
         key, value = options
       else
-        raise ArgumentError.new("Too many arguments; use either a single argument (must be a Hash) or two arguments (a key and a value).")
+        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
 
     # Parameter matcher which matches when actual parameter contains expected +Hash+ entry.
     class HasEntry < Base
-
       # @private
       def initialize(key, value)
-        @key, @value = key, value
+        @key = key
+        @value = value
       end
 
       # @private
@@ -85,9 +74,25 @@ module Mocha
       def mocha_inspect
         "has_entry(#{@key.mocha_inspect} => #{@value.mocha_inspect})"
       end
-
     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
+        else
+          raise ArgumentError, 'Argument has multiple entries. Use Mocha::ParameterMatchers#has_entries instead.'
+        end
+      else
+        raise ArgumentError, 'Argument is not a Hash.'
+      end
+    end
+  end
 end

data/lib/mocha/parameter_matchers/has_key.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches +Hash+ containing +key+.
     #
     # @param [Object] key expected key.
@@ -22,13 +20,13 @@ module Mocha
     #   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)
+    #
+    def has_key(key) # rubocop:disable Naming/PredicateName
       HasKey.new(key)
     end
 
     # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected key.
     class HasKey < Base
-
       # @private
       def initialize(key)
         @key = key
@@ -45,9 +43,6 @@ module Mocha
       def mocha_inspect
         "has_key(#{@key.mocha_inspect})"
       end
-
     end
-
   end
-
 end

data/lib/mocha/parameter_matchers/has_keys.rb

@@ -0,0 +1,53 @@
+require 'mocha/parameter_matchers/base'
+
+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)
+    end
+
+    # Parameter matcher which matches when actual parameter contains +Hash+ with all expected keys.
+    class HasKeys < Base
+      # @private
+      def initialize(*keys)
+        raise ArgumentError, 'No arguments. Expecting at least one.' if keys.empty?
+
+        @keys = keys
+      end
+
+      # @private
+      def matches?(available_parameters)
+        parameter = available_parameters.shift
+        return false unless parameter.respond_to?(:keys)
+
+        @keys.map(&:to_matcher).all? do |matcher|
+          parameter.keys.any? { |key| matcher.matches?([key]) }
+        end
+      end
+
+      # @private
+      def mocha_inspect
+        "has_keys(#{@keys.mocha_inspect(false)})"
+      end
+    end
+  end
+end

data/lib/mocha/parameter_matchers/has_value.rb

@@ -1,9 +1,7 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-
   module ParameterMatchers
-
     # Matches +Hash+ containing +value+.
     #
     # @param [Object] value expected value.
@@ -22,13 +20,13 @@ module Mocha
     #   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)
+    #
+    def has_value(value) # rubocop:disable Naming/PredicateName
       HasValue.new(value)
     end
 
     # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected value.
     class HasValue < Base
-
       # @private
       def initialize(value)
         @value = value
@@ -45,9 +43,6 @@ module Mocha
       def mocha_inspect
         "has_value(#{@value.mocha_inspect})"
       end
-
     end
-
   end
-
 end

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.
     #
@@ -68,36 +66,37 @@ module Mocha
 
     # 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
+          # rubocop:disable Style/GuardClause
           if parameter.respond_to?(:any?) && !parameter.is_a?(String)
-            return parameter.any? { |(p,_)| @items.first.to_matcher.matches?([p]) }
+            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,18 @@
+require 'mocha/parameter_matchers/equals'
+
+module Mocha
+  module ParameterMatchers
+    # @private
+    module InstanceMethods
+      # @private
+      def to_matcher
+        Mocha::ParameterMatchers::Equals.new(self)
+      end
+    end
+  end
+end
+
+# @private
+class Object
+  include Mocha::ParameterMatchers::InstanceMethods
+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/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