micro_mock 0.0.6 → 0.0.7

data/README.md

@@ -1,59 +1,75 @@
 # MicroMock
 
-### A tiny mocking script.
+### Perhaps the lightest mocking strategy available
 
-MicroMock doesn't make any assumptions about the testing framework.
-It leaves assertions/expectations up to you.
-
-Calling it a mocking script is a bit of a misnomer
-since its really a dynamic class generator.
-The term "stub" is used loosely since it adds real behavior...
-and "mocking" a class with real behavior proves to be quite useful.
+Calling it a mocking script is a bit of a misnomer since its really a dynamic class generator. The term "stub" is used loosely since it adds real behavior...
+and "mocking" with real behavior proves to be quite useful.
 
 ## Intall
+
 ```bash
 gem install micro_mock
 ```
 
-## Usage
+## Quick Start
+
 ```ruby
-# mock a class method
-Mock = MicroMock.make
-Mock.stub(:foo) { true }
-
-# make assertions
-assert Mock.foo # Test::Unit
-Mock.foo.should be_true # RSpec
-
-# mock an instance method
-m = Mock.new
-m.stub(:bar) { false }
-
-# make assertions
-assert_equal false, m.bar # Test::Unit
-m.bar.should eq false # RSpec
-
-# setup mock internal behavior
-count = 1
-m.stub(:a) { count += 1 }
-m.stub(:b) { |i| self.a if i > 5 }
-
-# make assertions
-10.times { |i| m.b(i) }
-assert_equal 5, count # Test::Unit
-count.should eq 5 # RSpec
+# create a mock class
+MyMock = MicroMock.make
+
+# stub a class method
+MyMock.stub(:foo) { "foo" }
+
+# create a mock instance
+mock = MyMock.new
+
+# stub an instance method
+mock.stub(:bar) { "#{self.class.foo}bar" }
+
+MyMock.foo # => "foo"
+mock.bar # => "foobar"
 ```
 
-Of course you wouldn't normally test the mock itself... rather the code that uses the mock.
-I'll work on adding some real world examples.
+## Next Steps
 
 ```ruby
 # create a mock that subclasses Array
-Mock = MicroMock.make(Array)
-list = Mock.new
-list << 1
-list.stub :say_hi do |name|
-  "Hi #{name}!"
+MockList = MicroMock.make(Array)
+
+list = MockList.new
+
+# stub an instance method that does something interesting
+list.stub :prefixed do |prefix|
+  map { |value| "#{prefix}:#{value}"}
 end
-list.say_hi "Nate" # => "Hi Nate!"
+
+list.concat [1, 2, 3]
+list.prefixed(:num) # => ["num:1", "num:2", "num:3"]
 ```
+
+## Deep Cuts
+
+Here is an example that mocks part of ActiveRecord.
+
+```ruby
+Model = MicroMock.make
+model = Model.new
+model.stub(:destroy) { @destroyed = true }
+model.stub(:destroyed?) { @destroyed }
+model.stub(:update_attributes) { |*args| @attributes_updated = true }
+model.stub(:save) { |*args| @saved = true }
+Model.stub(:find) { |*args| model.clone }
+Model.stub(:all) { (1..5).map { model.clone } }
+
+# try it out
+list = Model.all # => [#<MicroMock70331390241500:0x007fee9b1b1bb0 @args=[]>, #<MicroMock...]
+m = Model.find(1) # => #<MicroMock70331390241500:0x007fee9b17b6a0 @args=[]>
+m.update_attributes(:foo, "bar") # => true
+m.save # => true
+m.destroy # => true
+m.destroyed? # => true
+```
+
+For a more complete example, check out [Coast's test suite](https://github.com/hopsoft/coast/blob/master/test/test_coast.rb) which mocks a significant portion of Rails.
+
+Enjoy!

data/lib/micro_mock/version.rb

@@ -1,3 +1,3 @@
 module MicroMock
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: micro_mock
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-17 00:00:00.000000000 Z
+date: 2012-11-19 00:00:00.000000000 Z
 dependencies: []
-description: ! '    MicroMock might just be the lightest mocking strategy available.
+description: ! '    Perhaps the lightest mocking strategy available.
 
 '
 email: