mocha 0.5.6 → 3.1.0

data/lib/mocha/parameter_matchers/has_value.rb

@@ -1,42 +1,55 @@
-require 'mocha/parameter_matchers/base'
+# frozen_string_literal: true
+
+require 'mocha/parameter_matchers/base_methods'
 
 module Mocha
-  
   module ParameterMatchers
-
-    # :call-seq: has_value(value) -> parameter_matcher
-    #
-    # Matches +Hash+ containing +value+.
-    #   object = mock()
-    #   object.expects(:method_1).with(has_value(1))
-    #   object.method_1('key_1' => 1, 'key_2' => 2)
-    #   # no error raised
-    #
-    #   object = mock()
-    #   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)
-      HasValue.new(value)
+    module Methods
+      # Matches +Hash+ containing +value+.
+      #
+      # @param [Object] value expected value.
+      # @return [HasValue] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter contains entry with expected value.
+      #   object = mock()
+      #   object.expects(:method_1).with(has_value(1))
+      #   object.method_1('key_1' => 1, 'key_2' => 2)
+      #   # no error raised
+      #
+      # @example Actual parameter does not contain entry with expected value.
+      #   object = mock()
+      #   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) # rubocop:disable Naming/PredicatePrefix
+        HasValue.new(value)
+      end
     end
 
-    class HasValue < Base # :nodoc:
-      
+    # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected value.
+    class HasValue
+      include BaseMethods
+
+      # @private
       def initialize(value)
         @value = value
       end
-      
+
+      # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
-        parameter.values.include?(@value)
+        return false unless parameter.respond_to?(:values)
+
+        parameter.values.any? { |value| @value.to_matcher.matches?([value]) }
       end
-      
+
+      # @private
       def mocha_inspect
         "has_value(#{@value.mocha_inspect})"
       end
-      
     end
-    
   end
-  
-end
+end

data/lib/mocha/parameter_matchers/includes.rb

@@ -1,40 +1,105 @@
-require 'mocha/parameter_matchers/base'
+# frozen_string_literal: true
+
+require 'mocha/parameter_matchers/all_of'
+require 'mocha/parameter_matchers/base_methods'
 
 module Mocha
-  
   module ParameterMatchers
-
-    # :call-seq: includes(item) -> parameter_matcher
-    #
-    # Matches any object that responds true to include?(item)
-    #   object = mock()
-    #   object.expects(:method_1).with(includes('foo'))
-    #   object.method_1(['foo', 'bar'])
-    #   # no error raised
-    #
-    #   object.method_1(['baz'])
-    #   # error raised, because ['baz'] does not include 'foo'.
-    def includes(item)
-      Includes.new(item)
+    module Methods
+      # Matches any object that responds with +true+ to +include?(item)+
+      # for all items.
+      #
+      # @param [*Array] items expected items.
+      # @return [Includes] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter includes all items.
+      #   object = mock()
+      #   object.expects(:method_1).with(includes('foo', 'bar'))
+      #   object.method_1(['foo', 'bar', 'baz'])
+      #   # no error raised
+      #
+      # @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
     end
 
-    class Includes < Base # :nodoc:
+    # Parameter matcher which matches when actual parameter includes expected values.
+    class Includes
+      include BaseMethods
 
-      def initialize(item)
-        @item = item
+      # @private
+      def initialize(*items)
+        @items = items
       end
 
+      # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
-        return parameter.include?(@item)
+        return false unless parameter.respond_to?(:include?)
+
+        if @items.size == 1
+          if parameter.respond_to?(:any?) && !parameter.is_a?(String)
+            parameter = parameter.keys if parameter.is_a?(Hash)
+            parameter.any? { |p| @items.first.to_matcher.matches?([p]) }
+          else
+            parameter.include?(@items.first)
+          end
+        else
+          includes_matchers = @items.map { |item| Includes.new(item) }
+          AllOf.new(*includes_matchers).matches?([parameter])
+        end
       end
 
+      # @private
       def mocha_inspect
-        "includes(#{@item.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,28 @@
+# frozen_string_literal: true
+
+require 'mocha/parameter_matchers/base_methods'
+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, top_level: false, last: false)
+        if is_a?(BaseMethods)
+          self
+        elsif Hash === self && top_level
+          Mocha::ParameterMatchers::PositionalOrKeywordHash.new(self, expectation, last)
+        else
+          Mocha::ParameterMatchers::Equals.new(self)
+        end
+      end
+    end
+  end
+end
+
+# @private
+class Object # rubocop:disable Style/OneClassPerFile
+  include Mocha::ParameterMatchers::InstanceMethods
+end

data/lib/mocha/parameter_matchers/instance_of.rb

@@ -1,42 +1,53 @@
-require 'mocha/parameter_matchers/base'
+# frozen_string_literal: true
+
+require 'mocha/parameter_matchers/base_methods'
 
 module Mocha
-  
   module ParameterMatchers
-
-    # :call-seq: instance_of(klass) -> parameter_matcher
-    #
-    # Matches any object that is an instance of +klass+
-    #   object = mock()
-    #   object.expects(:method_1).with(instance_of(String))
-    #   object.method_1('string')
-    #   # no error raised
-    #
-    #   object = mock()
-    #   object.expects(:method_1).with(instance_of(String))
-    #   object.method_1(99)
-    #   # error raised, because method_1 was not called with an instance of String
-    def instance_of(klass)
-      InstanceOf.new(klass)
+    module Methods
+      # Matches any object that is an instance of +klass+
+      #
+      # @param [Class] klass expected class.
+      # @return [InstanceOf] parameter matcher.
+      #
+      # @see Expectation#with
+      # @see Kernel#instance_of?
+      #
+      # @example Actual parameter is an instance of +String+.
+      #   object = mock()
+      #   object.expects(:method_1).with(instance_of(String))
+      #   object.method_1('string')
+      #   # no error raised
+      #
+      # @example Actual parameter is not an instance of +String+.
+      #   object = mock()
+      #   object.expects(:method_1).with(instance_of(String))
+      #   object.method_1(99)
+      #   # error raised, because method_1 was not called with an instance of String
+      def instance_of(klass)
+        InstanceOf.new(klass)
+      end
     end
-    
-    class InstanceOf < Base # :nodoc:
-      
+
+    # Parameter matcher which matches when actual parameter is an instance of the specified class.
+    class InstanceOf
+      include BaseMethods
+
+      # @private
       def initialize(klass)
         @klass = klass
       end
-    
+
+      # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
         parameter.instance_of?(@klass)
       end
-      
+
+      # @private
       def mocha_inspect
         "instance_of(#{@klass.mocha_inspect})"
       end
-      
     end
-    
   end
-  
-end
+end

data/lib/mocha/parameter_matchers/is_a.rb

@@ -1,42 +1,54 @@
-require 'mocha/parameter_matchers/base'
+# frozen_string_literal: true
+
+require 'mocha/parameter_matchers/base_methods'
 
 module Mocha
-  
   module ParameterMatchers
-
-    # :call-seq: is_a(klass) -> parameter_matcher
-    #
-    # Matches any object that is a +klass+
-    #   object = mock()
-    #   object.expects(:method_1).with(is_a(Integer))
-    #   object.method_1(99)
-    #   # no error raised
-    #
-    #   object = mock()
-    #   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)
-      IsA.new(klass)
+    module Methods
+      # Matches any object that is a +klass+.
+      #
+      # @param [Class] klass expected class.
+      # @return [IsA] parameter matcher.
+      #
+      # @see Expectation#with
+      # @see Kernel#is_a?
+      #
+      # @example Actual parameter is a +Integer+.
+      #   object = mock()
+      #   object.expects(:method_1).with(is_a(Integer))
+      #   object.method_1(99)
+      #   # no error raised
+      #
+      # @example Actual parameter is not a +Integer+.
+      #   object = mock()
+      #   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) # rubocop:disable Naming/PredicatePrefix
+        IsA.new(klass)
+      end
     end
-    
-    class IsA < Base # :nodoc:
-      
+
+    # Parameter matcher which matches when actual parameter is a specific class.
+    class IsA
+      include BaseMethods
+
+      # @private
       def initialize(klass)
         @klass = klass
       end
-    
+
+      # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
         parameter.is_a?(@klass)
       end
-      
+
+      # @private
       def mocha_inspect
         "is_a(#{@klass.mocha_inspect})"
       end
-      
     end
-    
   end
-  
-end
+end

data/lib/mocha/parameter_matchers/kind_of.rb

@@ -1,42 +1,55 @@
-require 'mocha/parameter_matchers/base'
+# frozen_string_literal: true
+
+require 'mocha/parameter_matchers/base_methods'
 
 module Mocha
-  
   module ParameterMatchers
-
-    # :call-seq: kind_of(klass) -> parameter_matcher
-    #
-    # Matches any object that is a kind of +klass+
-    #   object = mock()
-    #   object.expects(:method_1).with(kind_of(Integer))
-    #   object.method_1(99)
-    #   # no error raised
-    #
-    #   object = mock()
-    #   object.expects(:method_1).with(kind_of(Integer))
-    #   object.method_1('string')
-    #   # error raised, because method_1 was not called with a kind of Integer
-    def kind_of(klass)
-      KindOf.new(klass)
+    module Methods
+      # Matches any +Object+ that is a kind of +klass+.
+      #
+      # @param [Class] klass expected class.
+      # @return [KindOf] parameter matcher.
+      #
+      # @see Expectation#with
+      # @see Kernel#kind_of?
+      #
+      # @example Actual parameter is a kind of +Integer+.
+      #   object = mock()
+      #   object.expects(:method_1).with(kind_of(Integer))
+      #   object.method_1(99)
+      #   # no error raised
+      #
+      # @example Actual parameter is not a kind of +Integer+.
+      #   object = mock()
+      #   object.expects(:method_1).with(kind_of(Integer))
+      #   object.method_1('string')
+      #   # error raised, because method_1 was not called with a kind of Integer
+      def kind_of(klass)
+        KindOf.new(klass)
+      end
     end
-    
-    class KindOf < Base # :nodoc:
-      
+
+    # Parameter matcher which matches when actual parameter is a kind of specified class.
+    class KindOf
+      include BaseMethods
+
+      # @private
       def initialize(klass)
         @klass = klass
       end
-    
+
+      # @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
+end

data/lib/mocha/parameter_matchers/not.rb

@@ -1,42 +1,53 @@
-require 'mocha/parameter_matchers/base'
+# frozen_string_literal: true
+
+require 'mocha/parameter_matchers/base_methods'
 
 module Mocha
-  
   module ParameterMatchers
-
-    # :call-seq: Not(matcher) -> parameter_matcher
-    #
-    # Matches if +matcher+ does not match.
-    #   object = mock()
-    #   object.expects(:method_1).with(Not(includes(1)))
-    #   object.method_1([0, 2, 3])
-    #   # no error raised
-    #
-    #   object = mock()
-    #   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)
-      Not.new(matcher)
+    module Methods
+      # Matches if +matcher+ does *not* match.
+      #
+      # @param [BaseMethods] matcher matcher whose logic to invert.
+      # @return [Not] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Actual parameter does not include the value +1+.
+      #   object = mock()
+      #   object.expects(:method_1).with(Not(includes(1)))
+      #   object.method_1([0, 2, 3])
+      #   # no error raised
+      #
+      # @example Actual parameter does include the value +1+.
+      #   object = mock()
+      #   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) # rubocop:disable Naming/MethodName
+        Not.new(matcher)
+      end
     end
-    
-    class Not < Base # :nodoc:
-      
+
+    # Parameter matcher which inverts the logic of the specified matcher using a logical NOT operation.
+    class Not
+      include BaseMethods
+
+      # @private
       def initialize(matcher)
         @matcher = matcher
       end
-    
+
+      # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
         !@matcher.matches?([parameter])
       end
-      
+
+      # @private
       def mocha_inspect
         "Not(#{@matcher.mocha_inspect})"
       end
-      
     end
-    
   end
-  
-end
+end

data/lib/mocha/parameter_matchers/optionally.rb

@@ -1,33 +1,68 @@
+# frozen_string_literal: true
+
 module Mocha
-  
   module ParameterMatchers
-
-    def optionally(*matchers)
-      Optionally.new(*matchers)
+    module Methods
+      # Matches optional parameters if available.
+      #
+      # @param [*Array<BaseMethods>] matchers matchers for optional parameters.
+      # @return [Optionally] parameter matcher.
+      #
+      # @see Expectation#with
+      #
+      # @example Only the two required parameters are supplied and they both match their expected value.
+      #   object = mock()
+      #   object.expects(:method_1).with(1, 2, optionally(3, 4))
+      #   object.method_1(1, 2)
+      #   # no error raised
+      #
+      # @example Both required parameters and one of the optional parameters are supplied and they all match their expected value.
+      #   object = mock()
+      #   object.expects(:method_1).with(1, 2, optionally(3, 4))
+      #   object.method_1(1, 2, 3)
+      #   # no error raised
+      #
+      # @example Both required parameters and both of the optional parameters are supplied and they all match their expected value.
+      #   object = mock()
+      #   object.expects(:method_1).with(1, 2, optionally(3, 4))
+      #   object.method_1(1, 2, 3, 4)
+      #   # no error raised
+      #
+      # @example One of the actual optional parameters does not match the expected value.
+      #   object = mock()
+      #   object.expects(:method_1).with(1, 2, optionally(3, 4))
+      #   object.method_1(1, 2, 3, 5)
+      #   # error raised, because optional parameters did not match
+      def optionally(*matchers)
+        Optionally.new(*matchers)
+      end
     end
-    
-    class Optionally < Base # :nodoc:
-      
+
+    # Parameter matcher which allows optional parameters to be specified.
+    class Optionally
+      include BaseMethods
+
+      # @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
+end