minitest-stub_on_roids 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaef4c0cb77c912a56a222ad9bd287d5bf9f39f386917bea4a7c2ee0ff343498
-  data.tar.gz: 3dc69f5af5f646e6a3497ac3a4481f7d32651ae5e35a6db74cb832733724b378
+  metadata.gz: 23aadaec28be102d543682e9b3e23a7dbae2ee9572b3d60ad8e8ddb714b949e3
+  data.tar.gz: c4fdad4c83ac66b6cb2d4786c6aa97a4ea8a313f9144dd95054e24f935b6bdd2
 SHA512:
-  metadata.gz: 743ed77b28fc873a00364634899354aae4cb686a5eee54317130885b27b2ff6899285d978c8dcf6b2e2b0ab72cffa1dd110efa87a58748866fb145a2319e4e5b
-  data.tar.gz: 11ae76fcc9956d9278f484910527d242f348c548020f44d5ff094bbd1368b82489eea606028c651396392c57a0a96669cb76546cbe80303ad3b4280a6e046ad3
+  metadata.gz: ed323c5833b8cbecc2dc2862de817e83e4571961a4c28c8d8a8bce0c92194806052ecb14384f2262fd83fe2e5e5fdb74744a296d979dd192a1d18fc9b9c20e88
+  data.tar.gz: d87659d4b7a347c6e2c6bc159c7c6e66957b76643c5edc0d0c3f99c217e054f85635b118f4cdba02e8d31791b1c67e4754282af127c8c6389cd1d8851381e900

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-gemspec
+gemspec

data/Gemfile.lock

@@ -1,17 +1,33 @@
 PATH
   remote: .
   specs:
-    minitest-stub_on_roids (0.0.1)
+    minitest-stub_on_roids (0.0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.3)
+    parallel (1.17.0)
+    parser (2.6.4.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   minitest-stub_on_roids!
+  rubocop (= 0.74.0)
 
 BUNDLED WITH
    2.0.1

data/README.md

@@ -4,11 +4,11 @@ Provides a set of helper methods around Minitest's `Object#stub` method.
 
 The following methods are available:
 
-* `#stub_with_args`
+* `.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`
+* `.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.
 
@@ -43,9 +43,9 @@ Banana.extend Minitest::StubOnRoids
 
 This will add the following methods to the class:
 
-### `#stub_with_args`
+### `.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:
+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
@@ -63,11 +63,11 @@ end
 
 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`
+### `.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`.
+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:
+This means that a `MockExpectationError` will be raised if within 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.
 
@@ -88,7 +88,8 @@ 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):
+#### Multiple calls
+Use the `times` keyword argument to expect a method to be called multiple times within the block (default is 1):
 
 ```ruby
 Banana.stub_and_expect(:new, banana_mock, [3.0, "Yellow"], times: 2) do
@@ -99,9 +100,54 @@ end
 # => Works
 ```
 
-### Limitations
+#### Multiple calls with different arguments
+
+Use the `expectations` keyword argument to expect a method to be called a multiple times within the block with different arguments and return values (order must be respected).
+
+Given the following expectations array:
+
+```ruby
+expectations = [
+  { 
+    expected_args: [3.0, "Yellow"],
+    return_value: banana_mock 
+  },
+  { 
+    expected_args: [5.0, "Green"], 
+    return_value: banana_mock2 
+  },
+  { 
+    expected_args: [15.0, "Red"], 
+    return_value: banana_mock3 
+  }
+]
+```
+
+Calling `Banana.new` multiple times exactly as expected works:
+
+```ruby
+Banana.stub_and_expect(:new, expectations: expectations) do
+  Banana.new(3.0, "Yellow")
+  Banana.new(5.0, "Green")
+  Banana.new(15.0, "Red")
+end
+
+# => Works
+```
+
+Calling `Banana.new` with the wrong arguments fails:
+
+```ruby
+Banana.stub_and_expect(:new, expectations: expectations) do
+  Banana.new(3.0, "Yellow")
+  Banana.new(15.0, "Red")
+end
+
+# => MockExpectationError raised
+```
+
+### Notes
 
-* 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

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
@@ -5,4 +7,4 @@ Rake::TestTask.new do |t|
 end
 
 desc "Run tests"
-task :default => :test
+task default: :test

data/lib/minitest/stub_on_roids.rb

@@ -1,34 +1,48 @@
+# frozen_string_literal: true
+
 require "minitest/autorun"
 
-class StubbedMethodArgsError < StandardError; end
-class MethodAlreadyStubbedError < StandardError; end
+class StubbedMethodArgsError < StandardError
+  def initialize(method_name, klass, actual_args)
+    super "Stubbed method :#{method_name} called on #{klass} with " \
+          "unexpected arguments #{actual_args}"
+  end
+end
+
+class MethodAlreadyStubbedError < StandardError
+  def initialize(name)
+    super "Method :#{name} already stubbed"
+  end
+end
 
 module Minitest
   module StubOnRoids
-    def stub_with_args(name, val_or_callable, expected_args, &block)
-      raise MethodAlreadyStubbedError, "Method :#{name} already stubbed" if self.respond_to? "__minitest_stub__#{name}"
+    def stub_with_args(method_name, retval, expected_args = [])
+      raise_if_already_stubbed(method_name)
 
-      asserted_callable = lambda do |*actual_args|
+      retval_with_args_assertion = lambda do |*actual_args|
         expected_args.zip(actual_args).each do |expected_arg, actual_arg|
           next if expected_arg == actual_arg
-          raise StubbedMethodArgsError, "stubbed method :#{name} called on #{self} with unexpected arguments #{actual_args}"
+
+          raise StubbedMethodArgsError.new(method_name, self, actual_args)
         end
-        
-        val_or_callable
+
+        retval
       end
 
-      stub(name, asserted_callable) do
+      stub(method_name, retval_with_args_assertion) do
         yield
       end
     end
 
-    def stub_and_expect(name, val_or_callable = nil, expected_args = [], times: 1)
-      raise MethodAlreadyStubbedError, "Method :#{name} already stubbed" if self.respond_to? "__minitest_stub__#{name}"
-      
-      mock = Minitest::Mock.new
-      times.times { mock.expect :call, val_or_callable, expected_args }
+    def stub_and_expect(method_name, retval = nil, expected_args = [],
+                        times: 1, expectations: [])
+      raise_if_bad_args(retval, expected_args, expectations)
+      raise_if_already_stubbed(method_name)
 
-      stub(name, mock) do
+      mock = build_mock(retval, expected_args, times, expectations)
+
+      stub(method_name, mock) do
         yield
       end
 
@@ -37,5 +51,46 @@ module Minitest
       # Monkeypatching the error message for better readability
       raise e.class, e.message.gsub(":call", ":#{name}")
     end
+
+    private
+
+    def build_mock(retval, expected_args, times, expectations)
+      mock = Minitest::Mock.new
+
+      if expectations.size.zero?
+        times.times { mock.expect :call, retval, expected_args }
+      else
+        expectations.each do |expectation|
+          validate_expectation(expectation)
+          expectation_times = expectation[:times] || 1
+
+          expectation_times.times do
+            mock.expect :call, expectation[:return_value], expectation[:expected_args]
+          end
+        end
+      end
+
+      mock
+    end
+
+    def raise_if_already_stubbed(method_name)
+      return unless respond_to? "__minitest_stub__#{method_name}"
+
+      raise MethodAlreadyStubbedError, method_name
+    end
+
+    def raise_if_bad_args(retval, expected_args, expectations)
+      if (!retval.nil? || expected_args.size.positive?) &&
+         expectations.size.positive?
+        raise ArgumentError,
+              "`retval` and `expected_args` arguments cannot be passed along with `expectations`"
+      end
+    end
+
+    def validate_expectation(expectation)
+      %i[expected_args return_value].each do |k|
+        raise ArgumentError, "Missing key #{k} in expectation definition" if expectation[k].nil?
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-stub_on_roids
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Simon Nizov
@@ -9,7 +9,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-08-05 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.74.0
 description: A set of helper methods based around Minitest's Object#stub method.
 email: simon.nizov@gmail.com
 executables: []