grift 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa5b5344bca43ca62082d11f90cea53e27b02ee4defc424916aa7ffa123099f0
-  data.tar.gz: dcc8fe58f1f753b15dc040a2663467d159de298bf08b51177d61652ac6105a9f
+  metadata.gz: bf2421884afdf8fff5e1b01f197d7249352312fcd7463818f54dee8bd665b251
+  data.tar.gz: 2491a5140014420c3ee5324c30caa32f8911b5b618417fa525dd9e34b82e6c4f
 SHA512:
-  metadata.gz: cc2aa7d33cfd5296bc24a8fb10d5dc678c3b71781d9ff63a7c475055997310a41fa6963ff351c14384a321224ba3bbf2159b2ae94c06ce03b5997725da46f1ae
-  data.tar.gz: 2809aeaf6fde5122e733e0dd25e84d9989051b9e5d25ca7d2593e77b005785182bede7d0caf81e7743f500d389f834c4fa67b89a28d7e85d10ed4cb3f0c29006
+  metadata.gz: 554d8d9425f55e7c8dd803db4311e76153614e13415aaaba44ccab586b4699a2192891f3c731b404f8cb5d4acaef796460ff15f6dca4fa50911e22590b236a97
+  data.tar.gz: f6fa5b36f3c80ec589a1e6d51c833611cd6ea1170765750a8623e84916d8c2ae9d795ed06474f0c4411d8828bb715845e78cf688d45b60581e480a630229d6c9

data/.github/dependabot.yml

@@ -6,7 +6,7 @@ updates:
     package-ecosystem: bundler
     target-branch: main
     schedule:
-      interval: weekly
+      interval: monthly
     labels:
       - dependencies
     assignees:

data/.github/workflows/ci.yml

@@ -33,7 +33,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1", "3.2", "3.3"]
+        ruby: ["2.7", "3.0", "3.1", "3.2", "3.3", "3.4"]
 
     steps:
       - uses: actions/checkout@v4
@@ -43,11 +43,11 @@ jobs:
           bundler-cache: true
 
       - name: Test
-        continue-on-error: ${{ matrix.experimental }}
-        run: bundle exec rake test
+        run: bundle exec rake --trace test
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
+        if: always()
+        uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: ./coverage/.resultset.json

data/.gitignore

@@ -29,7 +29,7 @@
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 .ruby-version
 .ruby-gemset
 

data/CHANGELOG.md

@@ -8,27 +8,40 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 None
 
+## [3.0.0](https://github.com/clarkedb/grift/releases/tag/v3.0.0) - 2024-12-26
+
+### Breaking
+
+- All mocks are now scoped to the current thread for thread-safety ([#256](https://github.com/clarkedb/grift/pull/256))
+  - For parallelized test suites using processes this is not a breaking change
+  - This fixes intermittent test failures sometimes seen when codebases have threads calling mocked methods
+
+### Added
+
+- Official support for Ruby 3.4 ([#257](https://github.com/clarkedb/grift/pull/257))
+- Direct access to mock results/calls without calling `mock` ([#258](https://github.com/clarkedb/grift/pull/258))
+
 ## [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))
+- 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))
+- 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))
+- 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
 
@@ -36,23 +49,23 @@ This version adds true keyword argument support for Ruby 3. See below for how to
 
 ### Changed
 
-* Dropped support for Ruby 2.5 ([#69](https://github.com/clarkedb/grift/pull/69))
-* Dropped support for Ruby 2.6 ([#72](https://github.com/clarkedb/grift/pull/72))
-* 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[i]`
+- Dropped support for Ruby 2.5 ([#69](https://github.com/clarkedb/grift/pull/69))
+- Dropped support for Ruby 2.6 ([#72](https://github.com/clarkedb/grift/pull/72))
+- 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[i]`
 
 ### Added
 
-* Support for mocking private instance and class methods ([#68](https://github.com/clarkedb/grift/pull/68))
-* Support for mocking methods that take positional and keyword arguments ([#72](https://github.com/clarkedb/grift/pull/72))
+- Support for mocking private instance and class methods ([#68](https://github.com/clarkedb/grift/pull/68))
+- Support for mocking methods that take positional and keyword arguments ([#72](https://github.com/clarkedb/grift/pull/72))
 
 ### Fixed
 
-* When mocking protected methods, the method now remains protected while mocked and after unmocking ([#68](https://github.com/clarkedb/grift/pull/68))
-* When mocking inherited methods, the method goes back to the ancestor's definition after unmocking ([#69](https://github.com/clarkedb/grift/pull/69))
-* When mocking methods with keyword arugments in Ruby 3.x, no error is thrown ([#72](https://github.com/clarkedb/grift/pull/72))
+- When mocking protected methods, the method now remains protected while mocked and after unmocking ([#68](https://github.com/clarkedb/grift/pull/68))
+- When mocking inherited methods, the method goes back to the ancestor's definition after unmocking ([#69](https://github.com/clarkedb/grift/pull/69))
+- When mocking methods with keyword arugments in Ruby 3.x, no error is thrown ([#72](https://github.com/clarkedb/grift/pull/72))
 
 ## [1.1.0](https://github.com/clarkedb/grift/releases/tag/v1.1.0) - 2022-02-03
 
@@ -60,7 +73,7 @@ This version adds support for Ruby 3.1 and updates various dependencies.
 
 ### Added
 
-* Support Ruby 3.1 ([#52](https://github.com/clarkedb/grift/pull/52))
+- Support Ruby 3.1 ([#52](https://github.com/clarkedb/grift/pull/52))
 
 ## [1.0.2](https://github.com/clarkedb/grift/releases/tag/v1.0.2) - 2021-11-11
 
@@ -68,7 +81,7 @@ This version fixes a bug that prevented the mocking of methods defined by a clas
 
 ### Fixed
 
-* Allow mocks of inherited methods ([#34](https://github.com/clarkedb/grift/pull/34))
+- Allow mocks of inherited methods ([#34](https://github.com/clarkedb/grift/pull/34))
 
 ## [1.0.1](https://github.com/clarkedb/grift/releases/tag/v1.0.1) - 2021-11-10
 
@@ -76,7 +89,7 @@ This version fixes a bug that prevented most mocking features in Grift from func
 
 ### Fixed
 
-* Uses relative path for yaml config files ([#28](https://github.com/clarkedb/grift/pull/28))
+- Uses relative path for yaml config files ([#28](https://github.com/clarkedb/grift/pull/28))
 
 ## [1.0.0](https://github.com/clarkedb/grift/releases/tag/v1.0.0) - 2021-11-06
 
@@ -84,12 +97,12 @@ The first major version of Grift! 100% documentation and 100% code coverage.
 
 ### Added
 
-* Spying on method ([#9](https://github.com/clarkedb/grift/pull/9))
-* Mocking method return values ([#9](https://github.com/clarkedb/grift/pull/9))
-* Mocking method implementation ([#13](https://github.com/clarkedb/grift/pull/13))
-* Restricted methods that cannot be mocked ([#20](https://github.com/clarkedb/grift/pull/20))
-* MiniTest Plugin to use hooks and clean up after tests ([#17](https://github.com/clarkedb/grift/pull/17))
-* Documentation! ([#23](https://github.com/clarkedb/grift/pull/23))
+- Spying on method ([#9](https://github.com/clarkedb/grift/pull/9))
+- Mocking method return values ([#9](https://github.com/clarkedb/grift/pull/9))
+- Mocking method implementation ([#13](https://github.com/clarkedb/grift/pull/13))
+- Restricted methods that cannot be mocked ([#20](https://github.com/clarkedb/grift/pull/20))
+- MiniTest Plugin to use hooks and clean up after tests ([#17](https://github.com/clarkedb/grift/pull/17))
+- Documentation! ([#23](https://github.com/clarkedb/grift/pull/23))
 
 ## [0.1.0](https://github.com/clarkedb/grift/releases/tag/v0.1.0) - 2021-10-12
 

data/Gemfile

@@ -8,16 +8,16 @@ gemspec
 gem 'rake', '>= 12.0'
 
 group :development, :test do
-  gem 'codecov'
-  gem 'minitest', '>= 5.0'
-  gem 'minitest-reporters', '>= 1.4.3'
-  gem 'simplecov', '>= 0.21.2'
+  gem 'minitest', '~> 5.25'
+  gem 'minitest-reporters', '~> 1.7'
+  gem 'simplecov', '~> 0.22'
+  gem 'simplecov-cobertura', '~> 2.1'
 end
 
 group :development, :lint do
-  gem 'overcommit'
-  gem 'rubocop'
-  gem 'rubocop-minitest'
-  gem 'rubocop-packaging', '>= 0.5'
-  gem 'rubocop-performance', '>= 1.0'
+  gem 'overcommit', '>= 0.64'
+  gem 'rubocop', '~> 1.69.2'
+  gem 'rubocop-minitest', '~> 0.36.0'
+  gem 'rubocop-packaging', '~> 0.5.2'
+  gem 'rubocop-performance', '~> 1.23.0'
 end

data/README.md

@@ -100,29 +100,29 @@ end
 
 ### Results
 
-To get the results and details of the calls, call `mock` on your mock method object.
+To get the results and details of the calls, call `calls` or `results` on your mock method object.
 
 ```ruby
 # get the number of times the mocked method has been called
-my_mock.mock.count
+my_mock.count
 #=> 2
 
 # get args for each call to the method while mocked
-my_mock.mock.calls[0].args
+my_mock.calls[0].args
 #=> ['first_arg1', 'second_arg1']
 
 # get kwargs for each call to the method while mocked
-my_mock.mock.calls[0].kwargs
+my_mock.calls[0].kwargs
 #=> { first_arg1: 'value' }
 
 # get results (return value) for each call to the method while mocked
-my_mock.mock.results
+my_mock.results
 #=> ['result1', 'result2']
 ```
 
 ## Requirements
 
-Grift supports all Ruby versions >= 2.7 (including 3.3).
+Grift supports all Ruby versions >= 2.7 (including 3.4).
 
 ## Development
 

data/lib/grift/config/restricted.yml

@@ -29,3 +29,6 @@ String:
 Symbol:
   - "=="
   - to_s
+
+Thread:
+  - "current"

data/lib/grift/minitest_plugin.rb

@@ -7,7 +7,7 @@ module Grift
   # needing to cleanup the mocks after each test.
   #
   # To setup the plugin for your tests, you should include the
-  # following code in your `test_helper`
+  # following code in your +test_helper+
   #
   #   class Minitest::Test
   #     include Grift::MinitestPlugin

data/lib/grift/mock_method.rb

@@ -101,7 +101,7 @@ module Grift
 
     ##
     # Clears the mock execution and calls data for this mock, and
-    # mocks the method to return `nil`.
+    # mocks the method to return +nil+.
     #
     # @return [Grift::MockMethod::MockExecutions]
     #
@@ -455,6 +455,84 @@ module Grift
       Grift::MockMethod.hash_key(@klass, @method_name)
     end
 
+    ##
+    # Returns an array of the args used in each call to the mocked method
+    # This is syntactical sugar equivalent to calling +mock+ and then +calls+.
+    #
+    # @see Grift::MockMethod::MockExecutions#calls
+    #
+    # @example
+    #   my_mock = Grift.spy_on(Number, :+)
+    #   x = (3 + 4) + 5
+    #   my_mock.calls.map(&:values)
+    #   #=> [[4], [5]]
+    #
+    # @return [Array<Grift::MockMethod::MockExecutions::MockArguments>] an array of MockArguments
+    #
+    def calls
+      @mock_executions.calls
+    end
+
+    ##
+    # Returns true if there have been no calls to the mock.
+    # This is syntactical sugar equivalent to calling +mock+ and then +empty?+.
+    #
+    # @see Grift::MockMethod::MockExecutions#empty?
+    #
+    # @example
+    #   my_mock = Grift.mock(String, :upcase)
+    #   my_mock.mock.empty?
+    #   #=> true
+    #   "apple".upcase
+    #   #=> "APPLE"
+    #   my_mock.empty?
+    #   #=> false
+    #
+    # @return [Boolean] if the executions are empty
+    #
+    def empty?
+      @mock_executions.empty?
+    end
+
+    ##
+    # Returns the count of mock executions.
+    # This is syntactical sugar equivalent to calling +mock+ and then +count+.
+    #
+    # @see Grift::MockMethod::MockExecutions#count
+    #
+    # @example
+    #   my_mock = Grift.mock(String, :upcase)
+    #   my_mock.mock.count
+    #   #=> 0
+    #   "apple".upcase
+    #   #=> "APPLE"
+    #   my_mock.count
+    #   #=> 1
+    #
+    # @return [Number] the number of executions
+    #
+    def count
+      @mock_executions.count
+    end
+
+    ##
+    # Returns an array of the results of each call to the mocked method
+    # This is syntactical sugar equivalent to calling +mock+ and then +results+.
+    #
+    # @see Grift::MockMethod::MockExecutions#results
+    #
+    # @example
+    #   my_mock = Grift.spy_on(Number, :+)
+    #   x = (3 + 4) + 5
+    #   my_mock.results
+    #   #=> [7, 12]
+    #
+    # @return [Array] an array of results
+    #
+    def results
+      @mock_executions.results
+    end
+
     private
 
     ##
@@ -547,7 +625,7 @@ module Grift
     ##
     # Checks for the original access of the method (public, protected, private),
     # and if that definition is inherited from an ancestor (super) class.
-    # Returns `nil` if no definition for the method is found.
+    # Returns +nil+ if no definition for the method is found.
     #
     # @return [Symbol] the method access
     # @return [Boolean] true if the method is inherited

data/lib/grift/version.rb

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

data/lib/grift.rb

@@ -14,18 +14,18 @@ require 'grift/version'
 # through this base module.
 #
 module Grift
-  @mock_store = Grift::MockStore.new
-
   class << self
     # @example
     #   Grift.mock_store
-    # @return [Grift::MockStore] the current store of mocked methods
-    attr_reader :mock_store
+    # @return [Grift::MockStore] the current store of mocked methods scoped to the thread
+    def mock_store
+      Thread.current[:grift_internal_mock_store] ||= Grift::MockStore.new
+    end
 
     ##
     # Mocks the given method to return the provided value.
     # This is syntactical sugar equivalent to calling
-    # `spy_on` and then `mock_return_value`.
+    # +spy_on+ and then +mock_return_value+.
     #
     # @example
     #   my_mock = Grift.mock(MyClass, :some_method, true)
@@ -79,7 +79,7 @@ module Grift
     #
     def mock_method?(klass, method)
       hash_key = Grift::MockMethod.hash_key(klass, method)
-      @mock_store.include?(hash_key)
+      mock_store.include?(hash_key)
     end
 
     ##
@@ -121,7 +121,7 @@ module Grift
     # @return [Array<Grift::MockMethod::MockExecutions>]
     #
     def clear_mocks(klass)
-      @mock_store.mocks(klass: klass).each(&:mock_clear)
+      mock_store.mocks(klass: klass).each(&:mock_clear)
     end
 
     ##
@@ -134,7 +134,7 @@ module Grift
     # @return [Array<Grift::MockMethod::MockExecutions>]
     #
     def clear_all_mocks
-      @mock_store.mocks.each(&:mock_clear)
+      mock_store.mocks.each(&:mock_clear)
     end
 
     ##
@@ -149,7 +149,7 @@ module Grift
     # @return [Array<Grift::MockMethod::MockExecutions>]
     #
     def reset_mocks(klass)
-      @mock_store.mocks(klass: klass).each(&:mock_reset)
+      mock_store.mocks(klass: klass).each(&:mock_reset)
     end
 
     ##
@@ -162,7 +162,7 @@ module Grift
     # @return [Array<Grift::MockMethod::MockExecutions>]
     #
     def reset_all_mocks
-      @mock_store.mocks.each(&:mock_reset)
+      mock_store.mocks.each(&:mock_reset)
     end
 
     ##
@@ -183,9 +183,9 @@ module Grift
     #
     def restore_mocks(klass, watch: false)
       if watch
-        @mock_store.mocks(klass: klass).each { |m| m.mock_restore(watch: true) }
+        mock_store.mocks(klass: klass).each { |m| m.mock_restore(watch: true) }
       else
-        @mock_store.remove(klass: klass)
+        mock_store.remove(klass: klass)
       end
     end
 
@@ -206,9 +206,9 @@ module Grift
     #
     def restore_all_mocks(watch: false)
       if watch
-        @mock_store.mocks.each { |m| m.mock_restore(watch: true) }
+        mock_store.mocks.each { |m| m.mock_restore(watch: true) }
       else
-        @mock_store.remove
+        mock_store.remove
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grift
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Clark Brown
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-13 00:00:00.000000000 Z
+date: 2024-12-26 00:00:00.000000000 Z
 dependencies: []
 description: A gem for simple mocking and spying in Ruby's MiniTest framework.
 email:
@@ -28,7 +28,6 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -55,7 +54,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
@@ -70,8 +69,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Mocking and spying in MiniTest
 test_files: []

data/Gemfile.lock

@@ -1,86 +0,0 @@
-PATH
-  remote: .
-  specs:
-    grift (2.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    ast (2.4.2)
-    builder (3.2.4)
-    childprocess (4.1.0)
-    codecov (0.2.12)
-      json
-      simplecov
-    docile (1.4.0)
-    iniparse (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.60.0)
-      childprocess (>= 0.6.3, < 5)
-      iniparse (~> 1.4)
-      rexml (~> 3.2)
-    parallel (1.24.0)
-    parser (3.3.0.3)
-      ast (~> 2.4.1)
-      racc
-    racc (1.7.3)
-    rainbow (3.1.1)
-    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.2.2.4)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      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.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.4)
-    unicode-display_width (2.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  codecov
-  grift!
-  minitest (>= 5.0)
-  minitest-reporters (>= 1.4.3)
-  overcommit
-  rake (>= 12.0)
-  rubocop
-  rubocop-minitest
-  rubocop-packaging (>= 0.5)
-  rubocop-performance (>= 1.0)
-  simplecov (>= 0.21.2)
-
-BUNDLED WITH
-   2.2.32