grift 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62cac26275a4af88278a38985c4edc2e3d001954fe68e491e242add325e49576
-  data.tar.gz: 03ddad7645f758c5708e353e8780001cfd4ce7b478cee2a4c5d60ae7a180cb80
+  metadata.gz: be076a2312ee3278d68f393d8ace60b12aa44cec9923336fbe0469366be5c9cd
+  data.tar.gz: b38846285534aaf9e56c413c77b84da307655a1ac336aba9c8a4fa3b676a34c7
 SHA512:
-  metadata.gz: 8df483db6759b17e6c8d7d6f05a81ed3b507b4be7d9a3d5b0f0adaa70bc8fec798d8d3e750d6f512a586e128ca0f492288d5b32a6e772a8ca6e2a67903116f41
-  data.tar.gz: c6460882f099ec2622fe92b99882e52b54df86c5aaf86311f86104326a94455235890ca5cc161448f8b7d5ab60d6853c1d65287764b8516eeebb5fd53ba3c8e3
+  metadata.gz: 25cdd247a6c4eacff1c77b099d22475bedb56d7a885beb1365e71e6798bddee87401fe1257e65cfbb5af5137b8458af650f2916f32b000a0712c3494e3f45459
+  data.tar.gz: 2c0e207ea0c7eb8db2719af429aaf0831fcb18169f5167d92f0111207e5a228e9f2a5d49131565dd499043268b65c4481fbd4497dca918c993326d7ed683102f

data/.github/workflows/ci.yml

@@ -15,12 +15,12 @@ jobs:
       BUNDLE_WITHOUT: development:test
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
-      - name: Set up Ruby 2.7
+      - name: Set up Ruby 3.1
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.1
           bundler-cache: true
 
       - name: Rubocop
@@ -33,10 +33,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1"]
+        ruby: ["2.7", "3.0", "3.1", "3.2"]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
@@ -47,7 +47,7 @@ jobs:
         run: bundle exec rake test
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: ./coverage/.resultset.json

data/.rubocop.yml

@@ -102,12 +102,12 @@ Lint/AmbiguousRange:
 
 # Metrics
 Metrics/AbcSize:
-  Max: 20
+  Max: 25
   Exclude:
     - "test/**/*"
 
 Metrics/ClassLength:
-  Max: 150
+  Max: 225
   CountAsOne:
     - array
     - hash
@@ -128,6 +128,9 @@ Metrics/MethodLength:
 Minitest/AssertPredicate:
   Enabled: false
 
+Minitest/EmptyLineBeforeAssertionMethods:
+  Enabled: false
+
 Minitest/MultipleAssertions:
   Max: 10
 
@@ -138,6 +141,10 @@ Minitest/RefutePredicate:
 Naming/InclusiveLanguage:
   Enabled: true
 
+Naming/MethodParameterName:
+  AllowedNames:
+    - n
+
 Naming/VariableNumber:
   EnforcedStyle: snake_case
 

data/CHANGELOG.md

@@ -8,8 +8,26 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 None
 
+## [2.1.0](https://github.com/clarkedb/grift/releases/tag/v2.1.0) - 2022-12-27
+
+### Added
+
+* Official support for Ruby 3.2 ([#126](https://github.com/clarkedb/grift/pull/126))
+* Support for finite/self-terminating mocking for more precision in testing where a method may get called multiple times
+  + The Grift API now supports `mock_return_value_once`,  `mock_return_value_n_times`, and `mock_return_values_in_order` ([#135](https://github.com/clarkedb/grift/pull/135))
+  + The Grift API now supports `mock_implementation_once` and `mock_implementation_n_times` ([#136](https://github.com/clarkedb/grift/pull/136))
+
+## [2.0.1](https://github.com/clarkedb/grift/releases/tag/v2.0.1) - 2022-03-27
+
+### Fixed
+
+* When spying on a method that takes a block, the block now gets forwarded to the original method ([#78](https://github.com/clarkedb/grift/pull/78))
+* When mocking the implementation, if a block is not provided a `Grift::Error` is raised instead of a `LocalJumpError` ([#77](https://github.com/clarkedb/grift/pull/77))
+
 ## [2.0.0](https://github.com/clarkedb/grift/releases/tag/v2.0.0) - 2022-03-14
 
+This version adds true keyword argument support for Ruby 3. See below for how to handle breaking changes.
+
 ### Changed
 
 * Dropped support for Ruby 2.5 ([#69](https://github.com/clarkedb/grift/pull/69))
@@ -17,7 +35,7 @@ None
 * To support keyword arguments, records of call arguments are no longer stored in simple arrays but in a custom Enumerable ([#72](https://github.com/clarkedb/grift/pull/72))
   + This changes the way that your tests will interact with mock calls
   + When before `calls` returned an array, it returns a `Grift::MockMethod::MockExecutions::MockArguments` object
-  + Migrating to maintain previous behavior just requires appending `.args` to `calls`
+  + Migrating to maintain previous behavior just requires appending `.args` to `calls[i]`
 
 ### Added
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grift (2.0.0)
+    grift (2.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,53 +10,56 @@ GEM
     ast (2.4.2)
     builder (3.2.4)
     childprocess (4.1.0)
-    codecov (0.6.0)
-      simplecov (>= 0.15, < 0.22)
+    codecov (0.2.12)
+      json
+      simplecov
     docile (1.4.0)
     iniparse (1.5.0)
-    minitest (5.15.0)
+    json (2.6.3)
+    minitest (5.16.3)
     minitest-reporters (1.5.0)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    overcommit (0.58.0)
+    overcommit (0.59.1)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
       rexml (~> 3.2)
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
-    rubocop (1.26.0)
+    rubocop (1.41.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
-    rubocop-minitest (0.18.0)
+    rubocop-minitest (0.25.1)
       rubocop (>= 0.90, < 2.0)
-    rubocop-packaging (0.5.1)
-      rubocop (>= 0.89, < 2.0)
-    rubocop-performance (1.13.3)
+    rubocop-packaging (0.5.2)
+      rubocop (>= 1.33, < 2.0)
+    rubocop-performance (1.15.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
-    unicode-display_width (2.1.0)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   ruby
@@ -75,4 +78,4 @@ DEPENDENCIES
   simplecov (>= 0.21.2)
 
 BUNDLED WITH
-   2.1.4
+   2.2.32

data/README.md

@@ -1,7 +1,6 @@
 # Grift
 
 [![gem version](https://badge.fury.io/rb/grift.svg)](https://rubygems.org/gems/grift)
-[![downloads](https://ruby-gem-downloads-badge.herokuapp.com/grift)](https://rubygems.org/gems/grift)
 [![build](https://github.com/clarkedb/grift/actions/workflows/ci.yml/badge.svg)](https://github.com/clarkedb/grift/actions?query=workflow%3ACI)
 [![codecov](https://codecov.io/gh/clarkedb/grift/branch/main/graph/badge.svg)](https://codecov.io/gh/clarkedb/grift)
 
@@ -86,6 +85,7 @@ my_spy.mock_implementation do |arg1, arg2, **kwargs|
     x = do_something(arg1, arg2, kwargs[:arg3], kwargs[:arg4])
     do_something_else(x) # the last line will be returned
 end
+```
 
 ### Chaining
 
@@ -122,7 +122,7 @@ my_mock.mock.results
 
 ## Requirements
 
-Grift supports all Ruby versions >= 2.7 (including 3.1).
+Grift supports all Ruby versions >= 2.7 (including 3.2).
 
 ## Development
 

data/lib/grift/mock_method.rb

@@ -134,6 +134,8 @@ module Grift
     # @return [self] the mock itself
     #
     def mock_implementation(*)
+      raise(Grift::Error, 'Must provide a block for the new implementation') unless block_given?
+
       premock_setup
       mock_executions = @mock_executions # required to access inside class instance block
 
@@ -143,7 +145,116 @@ module Grift
 
         # record the args passed in the call to the method and the result
         mock_executions.store(args: args, result: return_value)
-        return return_value
+        return_value
+      end
+      class_instance.send(@method_access, @method_name)
+
+      self
+    end
+
+    ##
+    # Accepts a block and mocks the method to execute that block instead
+    # of the original behavior the next time the method is called while mocked.
+    # After the method has been called once, it will return to its original
+    # behavior. The method will continue to be watched.
+    #
+    # @see #mock_implementation
+    #
+    # @example
+    #   my_mock = Grift.spy_on(String, :downcase).mock_implementation_once do
+    #       x = 3 + 4
+    #       x.to_s
+    #   end
+    #   ["Banana", "Apple"].map(&:downcase)
+    #   #=> ["7", "apple"]
+    #
+    # @return [self] the mock itself
+    #
+    def mock_implementation_once(*)
+      raise(Grift::Error, 'Must provide a block for the new implementation') unless block_given?
+
+      premock_setup
+
+      # required to access inside class instance block
+      mock_executions = @mock_executions
+      clean_mock = lambda do
+        unmock_method
+        watch_method
+      end
+
+      class_instance.remove_method(@method_name) if !@inherited && method_defined?
+      class_instance.define_method @method_name do |*args, **kwargs|
+        return_value = yield(*args, **kwargs)
+
+        # record the args passed in the call to the method and the result
+        mock_executions.store(args: args, result: return_value)
+
+        clean_mock.call
+
+        return_value
+      end
+      class_instance.send(@method_access, @method_name)
+
+      self
+    end
+
+    ##
+    # Accepts a number +n+ and a block and mocks the method to execute that block
+    # instaead of the original behavior the next +n+ times the method is called
+    # while mocked. After the method has been called once, it will return to its
+    # original behavior. The method will continue to be watched.
+    #
+    # **IMPORANT:** Calling {#mock_clear} clears the method call history. If it is
+    # called before the nth execution of the mocked method, the method will remain
+    # mocked for an additonal +n+ calls.
+    #
+    # @see #mock_implementation
+    #
+    # @example
+    #   my_mock = Grift.spy_on(String, :downcase).mock_implementation_n_times(3) do
+    #       x = 3 + 4
+    #       x.to_s
+    #   end
+    #   ["Banana", "Apple", "Orange", "Guava"].map(&:downcase)
+    #   #=> ["7", "7", "7", "guava"]
+    #
+    # @example
+    #   my_mock = Grift.spy_on(String, :downcase).mock_implementation_n_times(5) do
+    #       x = 3 + 4
+    #       x.to_s
+    #   end
+    #   ["Banana", "Apple", "Orange", "Guava"].map(&:downcase)
+    #   #=> ["7", "7", "7", "7"]
+    #   my_mock.mock_clear # clear mock history before 5th (nth) method call
+    #   ["Banana", "Apple", "Orange", "Guava"].map(&:downcase)
+    #   #=> ["7", "7", "7", "7"]
+    #
+    # @param n [Number] the number of times to mock the implementation
+    #
+    # @return [self] the mock itself
+    #
+    def mock_implementation_n_times(n, *)
+      raise(Grift::Error, 'Must provide a block for the new implementation') unless block_given?
+
+      premock_setup
+
+      # required to access inside class instance block
+      mock_executions = @mock_executions
+      clean_mock = lambda do
+        unmock_method
+        watch_method
+      end
+
+      class_instance.remove_method(@method_name) if !@inherited && method_defined?
+      class_instance.define_method @method_name do |*args, **kwargs|
+        return_value = yield(*args, **kwargs)
+
+        # record the args passed in the call to the method and the result
+        mock_executions.store(args: args, result: return_value)
+
+        clean_mock.call if mock_executions.count == n
+
+        return_value
       end
       class_instance.send(@method_access, @method_name)
 
@@ -173,7 +284,144 @@ module Grift
       class_instance.define_method @method_name do |*args, **kwargs|
         # record the args passed in the call to the method and the result
         mock_executions.store(args: args, kwargs: kwargs, result: return_value)
-        return return_value
+        return_value
+      end
+      class_instance.send(@method_access, @method_name)
+
+      self
+    end
+
+    ##
+    # Accepts a value and mocks the method to return that value once instead
+    # of executing its original behavior while mocked. After the method has
+    # been called once, it will return to its original behavior. The method
+    # will continue to be watched.
+    #
+    # @example
+    #   my_mock = Grift.spy_on(String, :upcase).mock_return_value_once("BANANA")
+    #   ["apple", "apple"].map(&:upcase)
+    #   #=> ["BANANA", "APPLE"]
+    #
+    # @param return_value the value to return from the method once
+    #
+    # @return [self] the mock itself
+    #
+    def mock_return_value_once(return_value = nil)
+      premock_setup
+
+      # required to access mock inside class instance block
+      mock_executions = @mock_executions
+      clean_mock = lambda do
+        unmock_method
+        watch_method
+      end
+
+      class_instance.remove_method(@method_name) if !@inherited && method_defined?
+      class_instance.define_method @method_name do |*args, **kwargs|
+        # record the args passed in the call to the method and the result
+        mock_executions.store(args: args, kwargs: kwargs, result: return_value)
+
+        clean_mock.call
+
+        return_value
+      end
+      class_instance.send(@method_access, @method_name)
+
+      self
+    end
+
+    ##
+    # Accepts a value and mocks the method to return that value +n+ times instead
+    # of executing its original behavior while mocked. After the method has
+    # been called +n+ times, it will return to its original behavior. The method
+    # will continue to be watched.
+    #
+    # **IMPORANT:** Calling {#mock_clear} clears the method call history. If it is
+    # called before the nth execution of the mocked method, the method will remain
+    # mocked for an additional +n+ calls.
+    #
+    # @example
+    #   my_mock = Grift.spy_on(String, :upcase).mock_return_value_n_times(2, "BANANA")
+    #   ["apple", "apple", "apple"].map(&:upcase)
+    #   #=> ["BANANA", "BANANA", "APPLE"]
+    #
+    # @example
+    #   my_mock = Grift.spy_on(String, :upcase).mock_return_value_n_times(4, "BANANA")
+    #   ["apple", "apple", "apple"].map(&:upcase)
+    #   #=> ["BANANA", "BANANA", "BANANA"]
+    #   my_mock.mock_clear # clear mock history before 4th (nth) method call
+    #   ["apple", "apple", "apple"].map(&:upcase)
+    #   #=> ["BANANA", "BANANA", "BANANA"]
+    #
+    # @param n [Number] the number of times to mock the return value
+    # @param return_value the value to return from the method +n+ times
+    #
+    # @return [self] the mock itself
+    #
+    def mock_return_value_n_times(n, return_value = nil)
+      premock_setup
+
+      # required to access mock inside class instance block
+      mock_executions = @mock_executions
+      clean_mock = lambda do
+        unmock_method
+        watch_method
+      end
+
+      class_instance.remove_method(@method_name) if !@inherited && method_defined?
+      class_instance.define_method @method_name do |*args, **kwargs|
+        # record the args passed in the call to the method and the result
+        mock_executions.store(args: args, kwargs: kwargs, result: return_value)
+
+        clean_mock.call if mock_executions.count == n
+
+        return_value
+      end
+      class_instance.send(@method_access, @method_name)
+
+      self
+    end
+
+    ##
+    # Accepts an array of values and mocks the method to return those values
+    # in order instead of executing its original behavior while mocked. After
+    # the method has been called enough times to return each of the values,
+    # it will return to its original behavior. The method continue to be watched.
+    #
+    # @example
+    #   mock_values = ["APPLE", "BANANA", "ORANGE"]
+    #   my_mock = Grift.spy_on(String, :upcase).mock_return_values_in_order(mock_values)
+    #   ["pineapple", "orange", "guava", "mango", "watermelon"].map(&:upcase)
+    #   #=> ["APPLE", "BANANA", "ORANGE", "MANGO", "WATERMELON"]
+    #
+    # @param return_values [Array] the values to return from the method in order
+    #
+    # @return [self] the mock itself
+    #
+    def mock_return_values_in_order(return_values)
+      unless return_values.is_a?(Array) && !return_values.empty?
+        raise(Grift::Error, 'Must provide a non-empty array for the return values')
+      end
+
+      premock_setup
+
+      # required to access mock inside class instance block
+      mock_executions = @mock_executions
+      clean_mock = lambda do
+        unmock_method
+        watch_method
+      end
+      return_values_internal = return_values.dup
+
+      class_instance.remove_method(@method_name) if !@inherited && method_defined?
+      class_instance.define_method @method_name do |*args, **kwargs|
+        # record the args passed in the call to the method and the result
+        return_value = return_values_internal.shift
+        mock_executions.store(args: args, kwargs: kwargs, result: return_value)
+
+        clean_mock.call if return_values_internal.empty?
+
+        return_value
       end
       class_instance.send(@method_access, @method_name)
 
@@ -204,7 +452,7 @@ module Grift
     # @return [String] the hash of the class and method
     #
     def self.hash_key(klass, method_name)
-      "#{klass}\##{method_name}"
+      "#{klass}##{method_name}"
     end
 
     private
@@ -220,12 +468,12 @@ module Grift
       cache_method_name = @cache_method_name
 
       class_instance.remove_method(@method_name) if !@inherited && method_defined?
-      class_instance.define_method @method_name do |*args, **kwargs|
-        return_value = send(cache_method_name, *args, **kwargs)
+      class_instance.define_method @method_name do |*args, **kwargs, &block|
+        return_value = send(cache_method_name, *args, **kwargs, &block)
 
         # record the args passed in the call to the method and the result
         mock_executions.store(args: args, kwargs: kwargs, result: return_value)
-        return return_value
+        return_value
       end
       class_instance.send(@method_access, @method_name)
 

data/lib/grift/version.rb

@@ -2,6 +2,6 @@
 
 module Grift
   # gem version
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
   public_constant :VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grift
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Clark Brown
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-15 00:00:00.000000000 Z
+date: 2022-12-27 00:00:00.000000000 Z
 dependencies: []
 description: A gem for simple mocking and spying in Ruby's MiniTest framework.
 email:
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Mocking and spying in MiniTest