mock_zen 0.1.0 → 0.2.0

data/README

@@ -1 +1 @@
-Mock zen is a lightweight mocking system for Ruby.
+Mock zen is a mocking/stubbing gem that is currently under development. I developed my own library because I thought that none of the alternatives were really 'rubyist' or idiomatic. Mock zen  is my humble attempt. 

data/Rakefile

@@ -2,7 +2,7 @@ desc "Erases the doc folder and recreates the RDoc"
 task :doc do
   doc_dir = File.join(File.dirname(__FILE__), "doc")
   FileUtils.rm_r(doc_dir) if File.exists?(doc_dir)
-  `rdoc`
+  `rdoc -x test`
 end
 
 desc "Runs all tests"

data/lib/mock/spy.rb

@@ -1,12 +1,27 @@
 module Mock
   
+  # A Spy is a class that records every method call for further verification.
   class Mock::Spy
     
+    # Creates the spy that will record any method calls on it.
+    #   spy = Spy.new
+    #   spy.called?(:method) # false
+    #   spy.method
+    #   spy.called?(:method) # true
     def initialize
       @methods_called = Hash.new(0)
     end
     
+    # Returns true if the method has been called on the Spy.
+    # <code>method_name</code> must respond to to_sym.
     def called?(method_name)
+      @methods_called[method_name.to_sym] > 0 if method_name.respond_to? :to_sym
+    end
+    
+    # Returns the number of times that <code>method_name</code> was called
+    # on the spy object.
+    # <code>method_name</code> must respondo to to_sym.
+    def times_called(method_name)
       @methods_called[method_name.to_sym] if method_name.respond_to? :to_sym
     end
     

data/lib/mock/stub.rb

@@ -1,5 +1,6 @@
 module Mock
   
+  # A Stub is a class that will respond with the recorded action upon method calls.
   class Mock::Stub
     # Creates the stub with the actions passed. The stub will respond to the keys in 
     # the hash and return the corresponding values.
@@ -9,9 +10,12 @@ module Mock
       @actions = actions
     end
   
-    def add_behaviour(options)
-      options = Mock::parse_actions(options)
-      @actions.merge! options
+    # Record a new behaviour to the stub as an alternative to passing all behaviours
+    # on the constructor. 
+    # <br />
+    # Aliased as <code><<</code>
+    def add_behaviour(actions)
+      @actions.merge!(Mock::parse_actions(actions))
       self
     end
 

data/lib/mock/undefined_action_error.rb

@@ -1,5 +1,6 @@
 module Mock
 
+  # Error thrown when a method that wasn't recorded is called on a stub.
   class Mock::UndefinedActionError < RuntimeError
   end
 

data/lib/mock.rb

@@ -9,6 +9,7 @@ module Mock
     Stub.new(parse_actions(actions))
   end
   
+  # Creates a Spy.
   def Mock::Spy()
     Spy.new
   end
@@ -16,12 +17,8 @@ module Mock
 protected
   # Ensures that the actions have Symbol or String keys
   def Mock::parse_actions(actions)
-    actions.reject! do |key, value| 
-      !key.instance_of?(String) and !key.instance_of?(Symbol)
-    end
-    
     actions.each do |key, value|
-      if key.instance_of? String
+      if key.respond_to?(:to_sym)
         actions.delete key
         actions[key.to_sym] = value
       end

data/test/spy_test.rb

@@ -3,19 +3,28 @@ require_relative 'test_helper'
 class SpyTest < Test::Unit::TestCase  
   context "A spy" do
 
-    should "record how many times a given method is called" do
-      spy = Mock::Spy()
-      5.times do
-        spy.method_call
-      end
-      
-      assert_equal 5, spy.called?(:method_call)
+    setup do
+      @spy = Mock::Spy() 
+    end
+
+    should "record if a given method is called" do
+      @spy.method_call
+      assert @spy.called?(:method_call)
+    end
+    
+    should "return false if the method wasn't called at all" do
+      assert not(@spy.called?(:method_call))
     end
     
     should "return 0 if the method wasn't called at all" do
-      spy = Mock::Spy()
-      
-      assert_equal 0, spy.called?(:method_call)
+      assert_equal 0, @spy.times_called(:method_call)
+    end
+    
+    should "return the number of times a method was called" do
+      5.times do
+        @spy.method_call
+      end
+      assert_equal 5, @spy.times_called(:method_call)
     end
   end
   

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Guilherme Carvalho