mocha 0.10.5 → 0.11.0

data/lib/mocha/parameter_matchers/has_entry.rb

@@ -1,28 +1,42 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-  
+
   module ParameterMatchers
 
-    # :call-seq: has_entry(key, value) -> parameter_matcher
-    #            has_entry(key => value) -> parameter_matcher
-    #
     # Matches +Hash+ containing entry with +key+ and +value+.
+    #
+    # @overload def has_entry(key, value)
+    #   @param [Object] key key for entry.
+    #   @param [Object] value value for entry.
+    # @overload def has_entry(single_entry_hash)
+    #   @param [Hash] single_entry_hash +Hash+ with single entry.
+    #   @raise [ArgumentError] if +single_entry_hash+ does not contain exactly one entry.
+    #
+    # @return [HasEntry] parameter matcher.
+    #
+    # @see Expectation#with
+    #
+    # @example Actual parameter contains expected entry supplied as key and value.
     #   object = mock()
     #   object.expects(:method_1).with(has_entry('key_1', 1))
     #   object.method_1('key_1' => 1, 'key_2' => 2)
     #   # no error raised
     #
+    # @example Actual parameter contains expected entry supplied as +Hash+ entry.
     #   object = mock()
     #   object.expects(:method_1).with(has_entry('key_1' => 1))
     #   object.method_1('key_1' => 1, 'key_2' => 2)
     #   # no error raised
     #
+    # @example Actual parameter does not contain expected entry supplied as key and value.
     #   object = mock()
     #   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
     #
+    # @example Actual parameter does not contain expected entry supplied as +Hash+ entry.
+    #
     #   object = mock()
     #   object.expects(:method_1).with(has_entry('key_1' => 1))
     #   object.method_1('key_1' => 2, 'key_2' => 1)
@@ -41,26 +55,30 @@ module Mocha
       end
       HasEntry.new(key, value)
     end
-    
-    class HasEntry < Base # :nodoc:
-      
+
+    # Parameter matcher which matches when actual parameter contains expected +Hash+ entry.
+    class HasEntry < Base
+
+      # @private
       def initialize(key, value)
         @key, @value = key, value
       end
-      
+
+      # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
         return false unless parameter.respond_to?(:keys) && parameter.respond_to?(:[])
         matching_keys = parameter.keys.select { |key| @key.to_matcher.matches?([key]) }
         matching_keys.any? { |key| @value.to_matcher.matches?([parameter[key]]) }
       end
-      
+
+      # @private
       def mocha_inspect
         "has_entry(#{@key.mocha_inspect} => #{@value.mocha_inspect})"
       end
-      
+
     end
-    
+
   end
-  
-end
+
+end

data/lib/mocha/parameter_matchers/has_key.rb

@@ -1,17 +1,23 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-  
+
   module ParameterMatchers
 
-    # :call-seq: has_key(key) -> parameter_matcher
-    #
     # Matches +Hash+ containing +key+.
+    #
+    # @param [Object] key expected key.
+    # @return [HasKey] parameter matcher.
+    #
+    # @see Expectation#with
+    #
+    # @example Actual parameter contains entry with expected key.
     #   object = mock()
     #   object.expects(:method_1).with(has_key('key_1'))
     #   object.method_1('key_1' => 1, 'key_2' => 2)
     #   # no error raised
     #
+    # @example Actual parameter does not contain entry with expected key.
     #   object = mock()
     #   object.expects(:method_1).with(has_key('key_1'))
     #   object.method_1('key_2' => 2)
@@ -20,24 +26,28 @@ module Mocha
       HasKey.new(key)
     end
 
-    class HasKey < Base # :nodoc:
-      
+    # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected key.
+    class HasKey < Base
+
+      # @private
       def initialize(key)
         @key = key
       end
-      
+
+      # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
         return false unless parameter.respond_to?(:keys)
         parameter.keys.any? { |key| @key.to_matcher.matches?([key]) }
       end
-      
+
+      # @private
       def mocha_inspect
         "has_key(#{@key.mocha_inspect})"
       end
-      
+
     end
-    
+
   end
-  
-end
+
+end

data/lib/mocha/parameter_matchers/has_value.rb

@@ -1,17 +1,23 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-  
+
   module ParameterMatchers
 
-    # :call-seq: has_value(value) -> parameter_matcher
-    #
     # 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)
@@ -20,24 +26,28 @@ module Mocha
       HasValue.new(value)
     end
 
-    class HasValue < Base # :nodoc:
-      
+    # Parameter matcher which matches when actual parameter contains +Hash+ entry with expected value.
+    class HasValue < Base
+
+      # @private
       def initialize(value)
         @value = value
       end
-      
+
+      # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
         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,35 +1,45 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-  
+
   module ParameterMatchers
 
-    # :call-seq: includes(item) -> parameter_matcher
+    # Matches any object that responds with +true+ to +include?(item)+.
+    #
+    # @param [Object] item expected item.
+    # @return [Includes] parameter matcher.
     #
-    # Matches any object that responds true to include?(item)
+    # @see Expectation#with
+    #
+    # @example Actual parameter includes item.
     #   object = mock()
     #   object.expects(:method_1).with(includes('foo'))
     #   object.method_1(['foo', 'bar'])
     #   # no error raised
     #
+    # @example Actual parameter does not include item.
     #   object.method_1(['baz'])
     #   # error raised, because ['baz'] does not include 'foo'.
     def includes(item)
       Includes.new(item)
     end
 
-    class Includes < Base # :nodoc:
+    # Parameter matcher which matches when actual parameter includes expected value.
+    class Includes < Base
 
+      # @private
       def initialize(item)
         @item = item
       end
 
+      # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
         return false unless parameter.respond_to?(:include?)
         return parameter.include?(@item)
       end
 
+      # @private
       def mocha_inspect
         "includes(#{@item.mocha_inspect})"
       end
@@ -37,5 +47,5 @@ module Mocha
     end
 
   end
-  
+
 end

data/lib/mocha/parameter_matchers/instance_of.rb

@@ -1,17 +1,24 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-  
+
   module ParameterMatchers
 
-    # :call-seq: instance_of(klass) -> parameter_matcher
-    #
     # 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)
@@ -19,24 +26,28 @@ module Mocha
     def instance_of(klass)
       InstanceOf.new(klass)
     end
-    
-    class InstanceOf < Base # :nodoc:
-      
+
+    # Parameter matcher which matches when actual parameter is an instance of the specified class.
+    class InstanceOf < Base
+
+      # @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,17 +1,24 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-  
+
   module ParameterMatchers
 
-    # :call-seq: is_a(klass) -> parameter_matcher
+    # Matches any object that is a +klass+.
+    #
+    # @param [Class] klass expected class.
+    # @return [IsA] parameter matcher.
+    #
+    # @see Expectation#with
+    # @see Kernel#is_a?
     #
-    # Matches any object that is a +klass+
+    # @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')
@@ -19,24 +26,28 @@ module Mocha
     def is_a(klass)
       IsA.new(klass)
     end
-    
-    class IsA < Base # :nodoc:
-      
+
+    # Parameter matcher which matches when actual parameter is a specific class.
+    class IsA < Base
+
+      # @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,17 +1,24 @@
 require 'mocha/parameter_matchers/base'
 
 module Mocha
-  
+
   module ParameterMatchers
 
-    # :call-seq: kind_of(klass) -> parameter_matcher
+    # 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?
     #
-    # Matches any object that is a kind of +klass+
+    # @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')
@@ -19,24 +26,28 @@ module Mocha
     def kind_of(klass)
       KindOf.new(klass)
     end
-    
-    class KindOf < Base # :nodoc:
-      
+
+    # Parameter matcher which matches when actual parameter is a kind of specified class.
+    class KindOf < Base
+
+      # @private
       def initialize(klass)
         @klass = klass
       end
-    
+
+      # @private
       def matches?(available_parameters)
         parameter = available_parameters.shift
         parameter.kind_of?(@klass)
       end
-      
+
+      # @private
       def mocha_inspect
         "kind_of(#{@klass.mocha_inspect})"
       end
-      
+
     end
-    
+
   end
-  
-end
+
+end