muack 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee7881104f617fa965f32fb46340cd71f6de26d5
+  data.tar.gz: 5047ee579c7fdf9118139d34823c53d1224abbd2
+SHA512:
+  metadata.gz: 10d056827ffb86c201c3720019782e510168a288186b057f4b25f0550a90448fa91b77dd87c36eb976bd94eff8b0600e4bc0dc8d1f4ccdf6c904bc280594838e
+  data.tar.gz: 433d4c055de69a0fd83251aa3e4b0b1e1a012753690470c6b5d738ad7452f1b6e6f9eca586a1fe24c87c4b19c7d19d226c324b14d8f424f8009cd8f5ed3158ec

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "task"]
+	path = task
+	url = git://github.com/godfat/gemgem.git

data/.travis.yml

@@ -0,0 +1,11 @@
+before_install: 'git submodule update --init'
+script: 'ruby -r bundler/setup -S rake test'
+
+env:
+  - 'RBXOPT=-X19'
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - rbx-head
+  - jruby-head

data/CHANGES.md

@@ -0,0 +1,5 @@
+# CHANGES
+
+## Muack 0.5.0 -- 2013-06-24
+
+* Birthday!

data/Gemfile

@@ -0,0 +1,7 @@
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'bacon'

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,494 @@
+# Muack [![Build Status](https://secure.travis-ci.org/godfat/muack.png?branch=master)](http://travis-ci.org/godfat/muack)
+
+by Lin Jen-Shin ([godfat](http://godfat.org))
+
+## LINKS:
+
+* [github](https://github.com/godfat/muack)
+* [rubygems](https://rubygems.org/gems/muack)
+* [rdoc](http://rdoc.info/github/godfat/muack)
+
+## DESCRIPTION:
+
+Muack -- Yet another mocking library.
+
+Basically it's an [RR][] clone, but much faster under heavy use.
+It's 32x times faster (750s vs 23s) for running [Rib][] tests.
+
+[RR]: https://github.com/rr/rr
+[Rib]: https://github.com/godfat/rib
+
+## REQUIREMENTS:
+
+* Tested with MRI (official CRuby) 1.9.3, 2.0.0, Rubinius and JRuby.
+
+## INSTALLATION:
+
+    gem install muack
+
+## SYNOPSIS:
+
+Basically it's an [RR][] clone. Let's see a [Bacon][] example.
+
+``` ruby
+require 'bacon'
+require 'muack'
+
+include Muack::API
+
+describe 'Hello' do
+  before{ Muack.reset  }
+  after { Muack.verify }
+
+  should 'say world!' do
+    str = 'Hello'
+    mock(str).say('!'){ |arg| "World#{arg}" }
+    str.say('!').should.equal 'World!'
+  end
+end
+```
+
+[Bacon]: https://github.com/chneukirchen/bacon
+
+### Coming from RR?
+
+Basically since it's an RR clone, the APIs are much the same.
+Let's see what's the different with code snippets. All codes
+were extracted from
+[RR's API document](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md).
+
+#### [mock](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#mock)
+
+`mock` is the same as RR.
+
+``` ruby
+view = controller.template
+mock(view).render(:partial => "user_info") {"Information"}
+```
+
+There's no `twice` modifier in Muack, use `times(2)` instead.
+
+``` ruby
+mock(view).render.with_any_args.times(2) do |*args|
+  if args.first == {:partial => "user_info"}
+    "User Info"
+  else
+    "Stuff in the view #{args.inspect}"
+  end
+end
+```
+
+#### [stub](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#stub)
+
+`stub` is the same as RR.
+
+``` ruby
+jane = User.new
+bob = User.new
+stub(User).find('42') {jane}
+stub(User).find('99') {bob}
+stub(User).find do |id|
+  raise "Unexpected id #{id.inspect} passed to me"
+end
+```
+
+#### [times(0)](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#dont_allow-aliased-to-do_not_allow-dont_call-and-do_not_call)
+
+There's no dont_allow method in Muack, use `times(0)` instead.
+
+``` ruby
+User.find('42').times(0)
+User.find('42') # raises a Muack::Unexpected
+```
+
+#### [mock_proxy](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#mockproxy)
+
+Since I don't see how we gain from calling it mock.proxy, in Muack we
+just call it `mock_proxy`.
+
+``` ruby
+view = controller.template
+mock_proxy(view).render(:partial => "right_navigation")
+mock_proxy(view).render(:partial => "user_info") do |html|
+  html.should include("John Doe")
+  "Different html"
+end
+```
+
+#### [stub_proxy](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#stubproxy)
+
+The same goes to `stub_proxy`.
+
+``` ruby
+view = controller.template
+stub_proxy(view).render(:partial => "user_info") do |html|
+  html.should include("Joe Smith")
+  html
+end
+```
+
+#### [any_instance_of](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#any_instance_of)
+
+Only this form of `any_instance_of` is supported. On the other hand,
+any of the above is supported as well, not only stub.
+
+``` ruby
+any_instance_of(User) do |u|
+  stub(u).valid? { false }
+  mock(u).errors { []    }
+  mock_proxy.save
+  stub_proxy.reload
+end
+```
+
+#### [Block form](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#block-syntax)
+
+Block form is also supported. However we don't support `instance_eval` form.
+There's little point to use instance_eval since it's much more complicated
+and much slower.
+
+``` ruby
+script = MyScript.new
+mock(script) do |expect|
+  expect.system("cd #{RAILS_ENV}") {true}
+  expect.system("rake foo:bar") {true}
+  expect.system("rake baz") {true}
+end
+```
+
+#### [Nested mocks](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#double-graphs)
+
+The shortest API (which might be a bit tricky) is not supported,
+but we do support:
+
+``` ruby
+stub(object).foo { stub.bar{ :baz }.object }
+object.foo.bar  #=> :baz
+```
+
+And of course the verbose way:
+
+``` ruby
+bar = stub.bar{ :baz }.object
+stub(object).foo { bar }
+object.foo.bar  #=> :baz
+```
+
+Or even more verbose, of course:
+
+``` ruby
+bar = Object.new
+stub(bar).bar{ :baz }
+stub(object).foo { bar }
+object.foo.bar  #=> :baz
+```
+
+#### [Modifier](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#modifying-doubles)
+
+After defining a mock method, you get a `Muack::Modifier` back.
+
+``` ruby
+stub(object).foo     #=> Muack::Modifier
+```
+
+However, you cannot flip around methods like RR. Whenever you define a
+mock/stub method, you must provide the block immediately.
+
+``` ruby
+mock(object).foo{ 'bar' }.times(2)
+```
+
+If unfortunately, the method name you want to mock is already defined,
+you can call `method_missing` directly to mock it. For example, `inspect`
+is already defined in `Muack::Mock` to avoid crashing with [Bacon][].
+In this case, you should do this to mock `inspect`:
+
+``` ruby
+mock(object).method_missing(:inspect){ 'bar' }.times(2)
+```
+
+#### [Stubbing method implementation / return value](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#stubbing-method-implementation--return-value)
+
+Again, there's only one true API form you can use. On the other hand,
+since Muack is more strict than RR. Passing no arguments means you
+really don't want any argument. Here we need to specify the argument
+for Muack. The example should be changed to:
+
+``` ruby
+stub(object).foo(is_a(Fixnum), anything){ |age, count, &block|
+  raise 'hell' if age < 16
+  ret = block.call count
+  blue? ? ret : 'whatever'
+}
+```
+
+#### [Stubbing method implementation based on argument expectation](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#stubbing-method-implementation-based-on-argument-expectation)
+
+Here is exactly the same as RR.
+
+``` ruby
+stub(object).foo { 'bar' }
+stub(object).foo(1, 2) { 'baz' }
+object.foo        #=> 'bar'
+object.foo(1, 2)  #=> 'baz'
+```
+
+#### [Stubbing method to yield given block](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#stubbing-method-to-yield-given-block)
+
+Always use the block to pass whatever back.
+
+``` ruby
+stub(object).foo{ |&block| block.call(1, 2, 3) }
+object.foo {|*args| args } # [1, 2, 3]
+```
+
+#### [Expecting method to be called with exact argument list](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#expecting-method-to-be-called-with-exact-argument-list)
+
+Muack is strict, you always have to specify the argument list.
+
+``` ruby
+mock(object).foo(1, 2)
+object.foo(1, 2)   # ok
+object.foo(3)      # fails
+```
+
+Passing no arguments really means passing no arguments.
+
+``` ruby
+stub(object).foo
+stub(object).foo(1, 2)
+object.foo(1, 2)   # ok
+object.foo         # ok
+object.foo(3)      # fails
+```
+
+#### [Expecting method to be called with any arguments](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#expecting-method-to-be-called-with-any-arguments)
+
+Muack also provides `with_any_args` if we don't really care.
+
+``` ruby
+stub(object).foo.with_any_args
+object.foo        # ok
+object.foo(1)     # also ok
+object.foo(1, 2)  # also ok
+                  # ... you get the idea
+```
+
+#### [Expecting method to be called with no arguments](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#expecting-method-to-be-called-with-no-arguments)
+
+Just don't pass any argument :)
+
+``` ruby
+stub(object).foo
+object.foo        # ok
+object.foo(1)     # fails
+```
+
+#### [Expecting method to never be called](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#expecting-method-to-never-be-called)
+
+Simply use `times(0)`.
+
+``` ruby
+mock(object).foo.times(0)
+object.foo        # fails
+```
+
+Multiple mock with different argument set is fine, too.
+
+```
+mock(object).foo(1, 2).times(0)
+mock(object).foo(3, 4)
+object.foo(3, 4)  # ok
+object.foo(1, 2)  # fails
+```
+
+#### [Expecting method to be called only once](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#expecting-method-to-be-called-only-once)
+
+By default, a mock only expects a call. Using `times(1)` is actually a no-op.
+
+``` ruby
+mock(object).foo.times(1)
+object.foo
+object.foo    # fails
+```
+
+#### [Expecting method to called exact number of times](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#expecting-method-to-called-exact-number-of-times)
+
+Times! Which is the same as RR.
+
+``` ruby
+mock(object).foo.times(3)
+object.foo
+object.foo
+object.foo
+object.foo    # fails
+```
+
+Alternatively, you could also do this. It's exactly the same.
+
+``` ruby
+3.times{ mock(object).foo }
+object.foo
+object.foo
+object.foo
+object.foo    # fails
+```
+
+#### [Expecting method to be called minimum number of times](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#expecting-method-to-be-called-minimum-number-of-times)
+
+It's not supported in Muack, but we could emulate it somehow:
+
+``` ruby
+times = 0
+stub(object).foo{ times += 1 }
+object.foo
+object.foo
+raise "BOOM" if times <= 3
+```
+
+#### [Expecting method to be called maximum number of times](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#expecting-method-to-be-called-maximum-number-of-times)
+
+
+It's not supported in Muack, but we could emulate it somehow:
+
+``` ruby
+times = 0
+stub(object).foo{ times += 1; raise "BOOM" if times > 3 }
+object.foo
+object.foo
+object.foo
+object.foo
+```
+
+#### [Expecting method to be called any number of times](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#expecting-method-to-be-called-any-number-of-times)
+
+Just use `stub`, which is exactly why it is designed.
+
+``` ruby
+stub(object).foo
+object.foo
+object.foo
+object.foo
+```
+
+#### [Argument wildcard matchers](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#argument-wildcard-matchers)
+
+`anything` is the same as RR.
+
+``` ruby
+mock(object).foobar(1, anything)
+object.foobar(1, :my_symbol)
+```
+
+`is_a` is the same as RR.
+
+``` ruby
+mock(object).foobar(is_a(Time))
+object.foobar(Time.now)
+```
+
+No numeric supports. Simply use `is_a(Numeric)`
+
+``` ruby
+mock(object).foobar(is_a(Numeric))
+object.foobar(99)
+```
+
+No boolean supports. Pass a custom satisfy block for it:
+
+``` ruby
+mock(object).foobar(
+  satisfy{ |a| a.kind_of?(TrueClass) || a.kind_of?(FalseClass) })
+object.foobar(false)
+```
+
+No duck_type supports. Pass a custom satisfy block for it:
+
+``` ruby
+mock(object).foobar(
+  satisfy{ |a| a.respond_to?(:walk) && a.respond_to?(:talk) })
+arg = Object.new
+def arg.walk; 'waddle'; end
+def arg.talk; 'quack'; end
+object.foobar(arg)
+```
+
+Don't pass ranges directly for ranges, use `within`. Or how do we tell
+if we really want the argument to be a `Range` object?
+
+``` ruby
+mock(object).foobar(within(1..10))
+object.foobar(5)
+```
+
+The same goes to regular expression. Use `match` instead.
+
+``` ruby
+mock(object).foobar(match(/on/))
+object.foobar("ruby on rails")
+```
+
+`hash_including` is the same as RR.
+
+``` ruby
+mock(object).foobar(hash_including(:red => "#FF0000", :blue => "#0000FF"))
+object.foobar({:red => "#FF0000", :blue => "#0000FF", :green => "#00FF00"})
+```
+
+`satisfy` is the same as RR.
+
+``` ruby
+mock(object).foobar(satisfy {|arg| arg.length == 2 })
+object.foobar("xy")
+```
+
+#### [Writing your own argument matchers](https://github.com/rr/rr/blob/e4b4907fd0488738affb4dab8ce88cbe9fa6580e/doc/03_api_overview.md#writing-your-own-argument-matchers)
+
+See [`lib/muack.rb`][muack.rb] and [`lib/muack/satisfy.rb`][satisfy.rb],
+you would get the idea soon. Here's how `is_a` implemented.
+
+``` ruby
+module Muack::API
+  module_function
+  def is_a klass
+    Muack::IsA.new(klass)
+  end
+end
+
+class Muack::IsA < Muack::Satisfy
+  def initialize klass
+    super lambda{ |actual_arg| actual_arg.kind_of?(klass) }, [klass]
+  end
+end
+```
+
+[muack.rb]: https://github.com/godfat/muack/blob/master/lib/muack.rb
+[satisfy.rb]: https://github.com/godfat/muack/blob/master/lib/muack/satisfy.rb
+
+## USERS:
+
+* [Rib][]
+* [rest-core](https://github.com/cardinalblue/rest-core)
+* [rest-more](https://github.com/cardinalblue/rest-more)
+
+## CONTRIBUTORS:
+
+* Lin Jen-Shin (@godfat)
+
+## LICENSE:
+
+Apache License 2.0
+
+Copyright (c) 2013, Lin Jen-Shin (godfat)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.