mocha 1.0.0.alpha → 1.10.0.alpha

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,14 @@ 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
+    # rubocop:disable Naming/PredicateName
     def has_entries(entries)
       HasEntries.new(entries)
     end
+    # rubocop:enable Naming/PredicateName
 
     # Parameter matcher which matches when actual parameter contains all expected +Hash+ entries.
     class HasEntries < Base
-
       # @private
       def initialize(entries)
         @entries = entries
@@ -47,9 +46,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,6 +39,7 @@ 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
+    # rubocop:disable Naming/PredicateName
     def has_entry(*options)
       case options.length
       when 1
@@ -48,29 +47,30 @@ module Mocha
         when Hash
           case options[0].length
           when 0
-            raise ArgumentError.new("Argument has no entries.")
+            raise ArgumentError, '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.")
+            raise ArgumentError, 'Argument has multiple entries. Use Mocha::ParameterMatchers#has_entries instead.'
           end
         else
-          raise ArgumentError.new("Argument is not a Hash.")
+          raise ArgumentError, 'Argument is not a Hash.'
         end
       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
+    # rubocop:enable Naming/PredicateName
 
     # 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 +85,6 @@ module Mocha
       def mocha_inspect
         "has_entry(#{@key.mocha_inspect} => #{@value.mocha_inspect})"
       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,14 @@ 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'
+    # rubocop:disable Naming/PredicateName
     def has_key(key)
       HasKey.new(key)
     end
+    # rubocop:enable Naming/PredicateName
 
     # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected key.
     class HasKey < Base
-
       # @private
       def initialize(key)
         @key = key
@@ -45,9 +44,6 @@ module Mocha
       def mocha_inspect
         "has_key(#{@key.mocha_inspect})"
       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,14 @@ 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
+    # rubocop:disable Naming/PredicateName
     def has_value(value)
       HasValue.new(value)
     end
+    # rubocop:enable Naming/PredicateName
 
     # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected value.
     class HasValue < Base
-
       # @private
       def initialize(value)
         @value = value
@@ -45,9 +44,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.
     #
@@ -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,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,14 @@ 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
+    # rubocop:disable Naming/PredicateName
     def is_a(klass)
       IsA.new(klass)
     end
+    # rubocop:enable Naming/PredicateName
 
     # Parameter matcher which matches when actual parameter is a specific class.
     class IsA < Base
-
       # @private
       def initialize(klass)
         @klass = klass
@@ -45,9 +44,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