grift 2.0.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06800e91cb7e76be9232c7cf700d99ede4ba25212ed323abd1d5a4e944de455d'
-  data.tar.gz: 2d844fc80a5edcb9eb809c4946d7ee464465e8423b7a42e2f3a4ff4657e791d7
+  metadata.gz: aa5b5344bca43ca62082d11f90cea53e27b02ee4defc424916aa7ffa123099f0
+  data.tar.gz: dcc8fe58f1f753b15dc040a2663467d159de298bf08b51177d61652ac6105a9f
 SHA512:
-  metadata.gz: c3a2e6a02bab0921a5c91c48c5fbbf67d1a9dd0b0d50bd3c4d9dfb49d6f686623ca0c017d1d51f1df3220b4c1c83c1fd9a26070daa05c36c38d657a2476a4602
-  data.tar.gz: a7197e5fb4f7bbaf506426c9f4ed2a04733201f8a27a4f015df9af7466c9bd8563e700c2adaaef34211690c5ecf795ded15308701877bd5a0fbb6ed5278b366a
+  metadata.gz: cc2aa7d33cfd5296bc24a8fb10d5dc678c3b71781d9ff63a7c475055997310a41fa6963ff351c14384a321224ba3bbf2159b2ae94c06ce03b5997725da46f1ae
+  data.tar.gz: 2809aeaf6fde5122e733e0dd25e84d9989051b9e5d25ca7d2593e77b005785182bede7d0caf81e7743f500d389f834c4fa67b89a28d7e85d10ed4cb3f0c29006

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# github sponsors
+github: 
+  - clarkedb

data/.github/workflows/ci.yml

@@ -15,12 +15,12 @@ jobs:
       BUNDLE_WITHOUT: development:test
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - name: Set up Ruby 2.7
+      - name: Set up Ruby 3.3
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.3
           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", "3.3"]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - 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,6 +8,21 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 None
 
+## [2.2.0](https://github.com/clarkedb/grift/releases/tag/v2.2.0) - 2024-01-13
+
+### Added
+
+* Official support for Ruby 3.3 ([#203](https://github.com/clarkedb/grift/pull/203))
+
+## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grift (2.0.1)
+    grift (2.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,53 +10,61 @@ 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)
-    minitest-reporters (1.5.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
+    minitest-reporters (1.6.1)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    overcommit (0.58.0)
+    overcommit (0.60.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
       rexml (~> 3.2)
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    parallel (1.24.0)
+    parser (3.3.0.3)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.2.1)
-    rexml (3.2.5)
-    rubocop (1.26.0)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.2.4)
       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.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
-    rubocop-minitest (0.18.0)
-      rubocop (>= 0.90, < 2.0)
-    rubocop-packaging (0.5.1)
-      rubocop (>= 0.89, < 2.0)
-    rubocop-performance (1.13.3)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.34.4)
+      rubocop (>= 1.39, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    rubocop-packaging (0.5.2)
+      rubocop (>= 1.33, < 2.0)
+    rubocop-performance (1.19.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
+    ruby-progressbar (1.13.0)
+    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.5.0)
 
 PLATFORMS
   ruby

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)
 
@@ -123,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.3).
 
 ## Development
 

data/lib/grift/mock_method.rb

@@ -11,6 +11,22 @@ module Grift
     CACHE_METHOD_PREFIX = 'grift_cache'
     private_constant :CACHE_METHOD_PREFIX
 
+    ##
+    # Hashes the class and method for tracking mocks.
+    #
+    # @example
+    #   Grift::MockMethod.hash_key(String, :upcase)
+    #   #=> 'String#upcase'
+    #
+    # @param klass [Class]
+    # @param method_name [Symbol]
+    #
+    # @return [String] the hash of the class and method
+    #
+    def self.hash_key(klass, method_name)
+      "#{klass}##{method_name}"
+    end
+
     ##
     # A new instance of MockMethod. Should be initialized via {Grift.mock} or {Grift.spy_on}
     #
@@ -36,7 +52,7 @@ module Grift
       @method_name = method_name
       @true_method_cached = false
       @mock_executions = MockExecutions.new
-      @cache_method_name = "#{CACHE_METHOD_PREFIX}_#{method_name}".to_sym
+      @cache_method_name = :"#{CACHE_METHOD_PREFIX}_#{method_name}"
 
       # class methods are really instance methods of the singleton class
       @class_method = klass.singleton_class.method_defined?(method_name, true) ||
@@ -145,7 +161,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)
 
@@ -175,7 +300,7 @@ 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)
 
@@ -183,30 +308,151 @@ module Grift
     end
 
     ##
-    # String representation of the MockMethod
+    # 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.
     #
-    # @see Grift::MockMethod.hash_key
+    # @example
+    #   my_mock = Grift.spy_on(String, :upcase).mock_return_value_once("BANANA")
+    #   ["apple", "apple"].map(&:upcase)
+    #   #=> ["BANANA", "APPLE"]
     #
-    # @return [String]
+    # @param return_value the value to return from the method once
     #
-    def to_s
-      Grift::MockMethod.hash_key(@klass, @method_name)
+    # @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
 
     ##
-    # Hashes the class and method for tracking mocks.
+    # 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
-    #   Grift::MockMethod.hash_key(String, :upcase)
-    #   #=> 'String#upcase'
+    #   my_mock = Grift.spy_on(String, :upcase).mock_return_value_n_times(2, "BANANA")
+    #   ["apple", "apple", "apple"].map(&:upcase)
+    #   #=> ["BANANA", "BANANA", "APPLE"]
     #
-    # @param klass [Class]
-    # @param method_name [Symbol]
+    # @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"]
     #
-    # @return [String] the hash of the class and method
+    # @param n [Number] the number of times to mock the return value
+    # @param return_value the value to return from the method +n+ times
     #
-    def self.hash_key(klass, method_name)
-      "#{klass}\##{method_name}"
+    # @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)
+
+      self
+    end
+
+    ##
+    # String representation of the MockMethod
+    #
+    # @see Grift::MockMethod.hash_key
+    #
+    # @return [String]
+    #
+    def to_s
+      Grift::MockMethod.hash_key(@klass, @method_name)
     end
 
     private
@@ -227,7 +473,7 @@ module Grift
 
         # 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.1'
+  VERSION = '2.2.0'
   public_constant :VERSION
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grift
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Clark Brown
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-27 00:00:00.000000000 Z
+date: 2024-01-13 00:00:00.000000000 Z
 dependencies: []
 description: A gem for simple mocking and spying in Ruby's MiniTest framework.
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
 - ".github/CONTRIBUTING.md"
+- ".github/FUNDING.yml"
 - ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".gitignore"
@@ -54,7 +55,7 @@ metadata:
   homepage_uri: https://github.com/clarkedb/grift
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/clarkedb/grift
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -69,8 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.5.3
+signing_key: 
 specification_version: 4
 summary: Mocking and spying in MiniTest
 test_files: []