minitest-stub_on_roids 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0b8760d30284aeb26f44e7771f8b32db37a78d00ea8d04af20f90cbf6c8b439
-  data.tar.gz: c6c64beec89ab4d501d073ab34f4f865c5ecaa9519c5370d660d2ef07f8c0de8
+  metadata.gz: aaef4c0cb77c912a56a222ad9bd287d5bf9f39f386917bea4a7c2ee0ff343498
+  data.tar.gz: 3dc69f5af5f646e6a3497ac3a4481f7d32651ae5e35a6db74cb832733724b378
 SHA512:
-  metadata.gz: 4d0bbc8b817dd275724080971a3a457e9f4eadae6dfc97dabd3b8fbadfd8b264156bd0d5897c3e4764653b633b5af29fe222b08f360476501298165d58787196
-  data.tar.gz: d565173266a7c2731ea36a0d02c2a1a93da885996ec4a5a57003d6cb345ecc57b1c810289e4fc3a25c2fb68486e4166b59e2774ab7d2a49ab8f4fe2cfee6df62
+  metadata.gz: 743ed77b28fc873a00364634899354aae4cb686a5eee54317130885b27b2ff6899285d978c8dcf6b2e2b0ab72cffa1dd110efa87a58748866fb145a2319e4e5b
+  data.tar.gz: 11ae76fcc9956d9278f484910527d242f348c548020f44d5ff094bbd1368b82489eea606028c651396392c57a0a96669cb76546cbe80303ad3b4280a6e046ad3

data/README.md

@@ -1 +1,113 @@
 # minitest-stub_on_roids
+
+Provides a set of helper methods around Minitest's `Object#stub` method.
+
+The following methods are available:
+
+* `#stub_with_args`
+  1. Stubs a class method for the duration of the block.
+  2. *If* the method is called, asserts that it is called with the expected arguments.
+  3. Doesn't mind how many times the method is called, if at all.
+* `#stub_and_expect`
+  1. Stubs a class method for the duration of the block.
+  2. Asserts that the method is called the exact amount of times as expected, and with the expected arguments.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "minitest-stub_on_roids"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-stub_on_roids
+
+## Usage
+
+Require `minitest/stub_on_roids` in your test:
+
+```ruby
+require 'minitest/stub_on_roids'
+```
+
+Extend the class you want to stub methods of:
+
+```ruby
+Banana.extend Minitest::StubOnRoids
+```
+
+This will add the following methods to the class:
+
+### `#stub_with_args`
+
+Use `#stub_with_args` to stub a class method as you normally would but also assert that if it is called - it is called with the expected arguments:
+
+```ruby
+Banana.stub_with_args(:new, banana_mock, [3.0, "Yellow"]) do
+  Banana.new(3.0, "Yellow")
+end
+
+# :new is stubbed and `banana_mock` is returned instead
+
+Banana.stub_with_args(:new, banana_mock, [3.0, "Green"]) do
+  Banana.new(3.0, "Yellow")
+end
+
+# A StubbedMethodArgsError is raised because :new was called with the wrong arguments
+```
+
+Just like with Minitest's `Object#stub` method, there is no expectation on the amount of times the stubbed method is called in the block.
+
+### `#stub_and_expect`
+
+Use `#stub_and_expect` to stub a class method as you normally would but also set expectations on it, similarly to using `Minitest::Mock#expect`.
+
+This means that a `MockExpectationError` will be thrown if inside the block:
+* The method is called with a different set of arguments than expected.
+* The method is called more or less the amount of times it was expected to be called.
+
+```ruby
+Banana.stub_and_expect(:new, banana_mock, [3.0, "Yellow"]) do
+  # Not calling `Banana.new`
+end
+
+# => MockExpectationError raised
+```
+
+```ruby
+Banana.stub_and_expect(:new, banana_mock, [3.0, "Yellow"]) do
+  Banana.new(3.0, "Yellow")
+  Banana.new(3.0, "Yellow")
+end
+
+# => MockExpectationError raised
+```
+
+Use the `times` keyword argument to expect a method to be called a specific amount of times within the block (default is 1):
+
+```ruby
+Banana.stub_and_expect(:new, banana_mock, [3.0, "Yellow"], times: 2) do
+  Banana.new(3.0, "Yellow")
+  Banana.new(3.0, "Yellow")
+end
+
+# => Works
+```
+
+### Limitations
+
+* Nesting blocks is not supported, meaning you can't expect methods to be called with more than one set of arguments at a time.
+* This gem might work with instance methods as well, but its intent is (and it's only tested for) using it on class methods.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thatguysimon/minitest-stub_on_roids. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-stub_on_roids
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Simon Nizov
@@ -10,7 +10,7 @@ bindir: bin
 cert_chain: []
 date: 2019-08-05 00:00:00.000000000 Z
 dependencies: []
-description: ''
+description: A set of helper methods based around Minitest's Object#stub method.
 email: simon.nizov@gmail.com
 executables: []
 extensions: []
@@ -21,7 +21,7 @@ files:
 - README.md
 - Rakefile
 - lib/minitest/stub_on_roids.rb
-homepage: https://rubygems.org/gems/minitest-stub_on_roids
+homepage: https://github.com/thatguysimon/minitest-stub_on_roids
 licenses:
 - MIT
 metadata: {}
@@ -43,5 +43,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: 'Minitest''s #stub but with arguments assertion and expectation'
+summary: 'Minitest''s #stub but on steroids'
 test_files: []