grift 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e43df3a93829be7aaf802bf4799dd2c12e741bf254e15fd08a7db816278003d4
-  data.tar.gz: 5811b46cb932445c62824e87367258563ec7bed4accc78eb04dc8833472662ce
+  metadata.gz: 4aff61073e962068bf8db43ccf6b17746c504a889725bbce4a7b545d81acece7
+  data.tar.gz: 96239a0ee6e279db817d13cd65566a74c193929e3bafcc8f2a2f2f5a2d594b60
 SHA512:
-  metadata.gz: e2d9170206163bc65f9542c92d5c6d981cf19d89eba2afd86e578ac587fbb800a3a2c63704438dcf4eed3e46a7bf03e9277b32c09dec364860c3d9e4cbcd7f71
-  data.tar.gz: 647225ba9c65ecb2707fe1c6eca06fa02c6a8b8e12a4052e6c686e8b6edb58df8c3043cab1a7cb6dda428aa75e36cc9d6c79329a54291e47f58e37c2cd69e132
+  metadata.gz: 5bac2eec9ca2ae6a986aa778620eeb3af3b354cd9b63ce8bb94c5b58441be4b1b1a475d079309e03b9a81deec67e5d27dd3eeba3c7434cdea477f5c779763004
+  data.tar.gz: dad5770bb188d57df66c438ac77b989ad480cad1936d425394496ad4675b270b1aa6ab56096d633587545972644162db96b466b3751bb0f0968373f1280c6f52

data/CHANGELOG.md

@@ -4,117 +4,144 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## [3.2.0](https://github.com/clarkedb/grift/compare/v3.1.1...v3.2.0) (2026-10-14)
 
-None
 
-## [3.1.0](https://github.com/clarkedb/grift/releases/tag/v3.1.0) - 2026-01-03
+### Added
+
+* add an instance option to Grift.spy_on ([#308](https://github.com/clarkedb/grift/issues/308)) ([ffaea83](https://github.com/clarkedb/grift/commit/ffaea8395879241906f7fe5b3533647eafd40ea9))
+* add Minitest assertions for mocks ([#312](https://github.com/clarkedb/grift/issues/312)) ([b4b6117](https://github.com/clarkedb/grift/commit/b4b61173489d6fa03e98892eab984d0d225068a0)), closes [#130](https://github.com/clarkedb/grift/issues/130)
+
+
+### Fixed
+
+* record keyword arguments for mocked implementations ([#311](https://github.com/clarkedb/grift/issues/311)) ([858873e](https://github.com/clarkedb/grift/commit/858873ed332834f0bfc31ed20fade25209e283e9)), closes [#310](https://github.com/clarkedb/grift/issues/310)
+
+## [3.1.1](https://github.com/clarkedb/grift/compare/v3.1.0...v3.1.1) (2026-10-14)
+
+
+### Fixed
+
+* package only runtime files in the gem ([#292](https://github.com/clarkedb/grift/issues/292)) ([0e6e3fd](https://github.com/clarkedb/grift/commit/0e6e3fdf2e99696468144ce490b015bdee3f13d4))
+
+## [3.1.0](https://github.com/clarkedb/grift/compare/v3.0.0...v3.1.0) (2026-01-03)
+
 
 ### Added
 
-- Official support for Ruby 4.0 ([#274](https://github.com/clarkedb/grift/pull/274))
+* Official support for Ruby 4.0 ([#274](https://github.com/clarkedb/grift/pull/274))
 
 ### Fixed
 
-- Migrate rubocop setup to use plugins ([#275](https://github.com/clarkedb/grift/pull/275))
-- Use preferred `method_defined?` for style ([#276](https://github.com/clarkedb/grift/pull/276))
+* Migrate rubocop setup to use plugins ([#275](https://github.com/clarkedb/grift/pull/275))
+* Use preferred `method_defined?` for style ([#276](https://github.com/clarkedb/grift/pull/276))
+
+## [3.0.0](https://github.com/clarkedb/grift/compare/v2.2.0...v3.0.0) (2024-12-26)
 
-## [3.0.0](https://github.com/clarkedb/grift/releases/tag/v3.0.0) - 2024-12-26
 
-### Breaking
+### ⚠ BREAKING CHANGES
 
-- 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
+* 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))
+* 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/compare/v2.1.0...v2.2.0) (2024-01-13)
 
-## [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/compare/v2.0.1...v2.1.0) (2022-12-27)
 
-## [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/compare/v2.0.0...v2.0.1) (2022-03-27)
 
-## [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/compare/v1.1.0...v2.0.0) (2022-03-14)
 
-## [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
+### ⚠ BREAKING CHANGES
 
-- 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/compare/v1.0.2...v1.1.0) (2022-02-03)
 
-## [1.1.0](https://github.com/clarkedb/grift/releases/tag/v1.1.0) - 2022-02-03
 
 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/compare/v1.0.1...v1.0.2) (2021-11-11)
 
-## [1.0.2](https://github.com/clarkedb/grift/releases/tag/v1.0.2) - 2021-11-11
 
 This version fixes a bug that prevented the mocking of methods defined by a class's super class.
 
 ### 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/compare/v1.0.0...v1.0.1) (2021-11-10)
 
-## [1.0.1](https://github.com/clarkedb/grift/releases/tag/v1.0.1) - 2021-11-10
 
 This version fixes a bug that prevented most mocking features in Grift from functioning as expected.
 
 ### 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/compare/v0.1.0...v1.0.0) (2021-11-06)
 
-## [1.0.0](https://github.com/clarkedb/grift/releases/tag/v1.0.0) - 2021-11-06
 
 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 (2021-10-12)
 
-## [0.1.0](https://github.com/clarkedb/grift/releases/tag/v0.1.0) - 2021-10-12
 
 The initial version of Grift. This was never intended for use and should be considered **deprecated**.

data/README.md

@@ -28,7 +28,7 @@ gem install grift
 
 ### MiniTest Plugin
 
-We recommend using the plugin so that mocks are cleaned up after each test automatically. To enable the plugin, add the following lines of code to your `test_helper` file.
+We recommend using the plugin so that mocks are cleaned up after each test automatically. The plugin also adds [assertions](#assertions) for mocks. To enable the plugin, add the following lines of code to your `test_helper` file.
 
 ```ruby
 class Minitest::Test
@@ -87,6 +87,14 @@ my_spy.mock_implementation do |arg1, arg2, **kwargs|
 end
 ```
 
+### Class and instance methods with the same name
+
+When a class responds to a method itself, Grift mocks the class method. That includes methods every class has, like `name`, `to_s`, and `==`. To mock the instance method instead, pass `instance: true` to `spy_on`:
+
+```ruby
+my_mock = Grift.spy_on(MyClass, :name, instance: true).mock_return_value('mocked')
+```
+
 ### Chaining
 
 You can chain `mock_return_value` and `mock_implementation` after initializing the mock.
@@ -120,6 +128,24 @@ my_mock.results
 #=> ['result1', 'result2']
 ```
 
+### Assertions
+
+With the [MiniTest Plugin](#minitest-plugin) included, you can assert on mocks directly in your tests.
+
+```ruby
+assert_mocked MyClass, :my_method
+refute_mocked MyClass, :other_method
+
+assert_mock_called my_mock
+refute_mock_called my_mock
+
+# passes if any call used exactly these arguments
+assert_mock_called_with my_mock, 'first_arg', key: 'value'
+refute_mock_called_with my_mock, 'other_arg'
+```
+
+When an assertion fails, the message lists the calls to the mocked method.
+
 ## Requirements
 
 Grift supports all Ruby versions >= 2.7 (including 4.x versions).
@@ -132,11 +158,20 @@ For now Grift is not guaranteed to be compatible with [`Ruby::Box`](https://docs
 
 After forking the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-When developing, to install Grift whith your changes onto your local machine, run `bundle exec rake install` . For those with write access: to release a new version, update the version number in `version.rb` , and then run `bundle exec rake release` , which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+When developing, to install Grift whith your changes onto your local machine, run `bundle exec rake install` .
+
+### Releasing
+
+Releases are managed by [release-please](https://github.com/googleapis/release-please). When releasable commits (`feat`, `fix`, `perf`, or breaking changes; see [CONTRIBUTING](.github/CONTRIBUTING.md#pull-request-titles)) land on `main`, it opens (or updates) a release pull request that bumps `lib/grift/version.rb` and `CHANGELOG.md`. For those with write access:
+
+1. Merge the release pull request, which tags the version and creates the GitHub release
+1. Once CI passes on `main`, approve the `release` deployment in GitHub Actions, which pushes the `.gem` file to [rubygems.org](https://rubygems.org) via trusted publishing and then deploys the [docs](#docs)
+
+If publishing fails, use "Re-run failed jobs" on the workflow run. "Re-run all jobs" re-runs release-please, which finds the release already exists and skips publishing.
 
 ### Docs
 
-The docs are generated using YARD. To build the docs, first `gem install yard` . Then run `yardoc` to build the new docs. This is always done before a release to update the docs that get published and made available with the gem.
+The docs are generated using YARD and deployed to [GitHub Pages](https://clarkedb.github.io/grift/) after each release. To redeploy them, run the Docs workflow manually with the latest release tag. To build them locally, run `BUNDLE_WITH=docs bundle install` and then `bundle exec yard` (output goes to the gitignored `docs/` folder).
 
 ## Contributing
 

data/lib/grift/minitest_plugin.rb

@@ -2,7 +2,7 @@
 
 module Grift
   ##
-  # A plugin to clean up mocks after tests in Minitest.
+  # A plugin to clean up mocks after tests in Minitest and to assert on mocks.
   # It is recommended that you include this plugin to avoid
   # needing to cleanup the mocks after each test.
   #
@@ -23,5 +23,157 @@ module Grift
       super
       Grift.restore_all_mocks(watch: false)
     end
+
+    ##
+    # Asserts that the given method is currently mocked.
+    #
+    # @see Grift.mock_method?
+    #
+    # @example
+    #   Grift.spy_on(MyClass, :my_method)
+    #   assert_mocked(MyClass, :my_method)
+    #
+    # @param klass [Class] the class of the method to be checked
+    # @param method [Symbol] the symbol representing the method to be checked
+    # @param msg [String, Proc] a message to show before the failure message
+    #
+    # @return [true]
+    #
+    def assert_mocked(klass, method, msg = nil)
+      key = Grift::MockMethod.hash_key(klass, method)
+      assert Grift.mock_method?(klass, method), message(msg) { "Expected #{key} to be mocked" }
+    end
+
+    ##
+    # Asserts that the given method is not currently mocked.
+    #
+    # @see Grift.mock_method?
+    #
+    # @example
+    #   refute_mocked(MyClass, :my_method)
+    #
+    # @param klass [Class] the class of the method to be checked
+    # @param method [Symbol] the symbol representing the method to be checked
+    # @param msg [String, Proc] a message to show before the failure message
+    #
+    # @return [true]
+    #
+    def refute_mocked(klass, method, msg = nil)
+      key = Grift::MockMethod.hash_key(klass, method)
+      refute Grift.mock_method?(klass, method), message(msg) { "Expected #{key} to not be mocked" }
+    end
+
+    ##
+    # Asserts that the mocked method has been called at least once.
+    #
+    # @example
+    #   my_mock = Grift.spy_on(MyClass, :my_method)
+    #   MyClass.my_method
+    #   assert_mock_called(my_mock)
+    #
+    # @param mock [Grift::MockMethod] the mock to be checked
+    # @param msg [String, Proc] a message to show before the failure message
+    #
+    # @return [true]
+    #
+    def assert_mock_called(mock, msg = nil)
+      refute mock.empty?, message(msg) { "Expected #{mock} to be called" }
+    end
+
+    ##
+    # Asserts that the mocked method has not been called.
+    #
+    # @example
+    #   my_mock = Grift.spy_on(MyClass, :my_method)
+    #   refute_mock_called(my_mock)
+    #
+    # @param mock [Grift::MockMethod] the mock to be checked
+    # @param msg [String, Proc] a message to show before the failure message
+    #
+    # @return [true]
+    #
+    def refute_mock_called(mock, msg = nil)
+      failure = message(msg, '') do
+        "Expected #{mock} to not be called, but it was called with:\n#{mock_calls_description(mock)}"
+      end
+      assert mock.empty?, failure
+    end
+
+    ##
+    # Asserts that the mocked method has been called at least once with exactly the given arguments.
+    # Every argument is matched against the calls, so there is no custom message parameter.
+    #
+    # @example
+    #   my_mock = Grift.spy_on(MyClass, :my_method)
+    #   MyClass.my_method('first', second: 2)
+    #   assert_mock_called_with(my_mock, 'first', second: 2)
+    #
+    # @param mock [Grift::MockMethod] the mock to be checked
+    # @param args [Array] the expected positional arguments
+    # @param kwargs [Hash] the expected keyword arguments
+    #
+    # @return [true]
+    #
+    def assert_mock_called_with(mock, *args, **kwargs)
+      failure = proc do
+        expected = "Expected #{mock} to be called with #{mock_call_description(args, kwargs)}"
+        if mock.empty?
+          "#{expected}, but it was not called."
+        else
+          "#{expected}, but it was called with:\n#{mock_calls_description(mock)}"
+        end
+      end
+      assert mock_called_with?(mock, args, kwargs), failure
+    end
+
+    ##
+    # Asserts that the mocked method has not been called with exactly the given arguments.
+    # Every argument is matched against the calls, so there is no custom message parameter.
+    #
+    # @example
+    #   my_mock = Grift.spy_on(MyClass, :my_method)
+    #   MyClass.my_method('first', second: 2)
+    #   refute_mock_called_with(my_mock, 'first', second: 3)
+    #
+    # @param mock [Grift::MockMethod] the mock to be checked
+    # @param args [Array] the positional arguments that should not have been used
+    # @param kwargs [Hash] the keyword arguments that should not have been used
+    #
+    # @return [true]
+    #
+    def refute_mock_called_with(mock, *args, **kwargs)
+      failure = proc { "Expected #{mock} to not be called with #{mock_call_description(args, kwargs)}." }
+      refute mock_called_with?(mock, args, kwargs), failure
+    end
+
+    private
+
+    ##
+    # Checks if any call to the mock used exactly the given arguments.
+    #
+    # @return [Boolean]
+    #
+    def mock_called_with?(mock, args, kwargs)
+      mock.calls.any? { |call| args == call.args && kwargs == call.kwargs }
+    end
+
+    ##
+    # Formats the arguments of a call like they would be written in Ruby.
+    #
+    # @return [String]
+    #
+    def mock_call_description(args, kwargs)
+      values = args.map { |arg| mu_pp(arg) } + kwargs.map { |key, value| "#{key}: #{mu_pp(value)}" }
+      "(#{values.join(', ')})"
+    end
+
+    ##
+    # Formats every call to the mock, one per line.
+    #
+    # @return [String]
+    #
+    def mock_calls_description(mock)
+      mock.calls.map { |call| "  #{mock_call_description(call.args, call.kwargs)}" }.join("\n")
+    end
   end
 end

data/lib/grift/mock_method.rb

@@ -40,10 +40,11 @@ module Grift
     # @param klass [Class] the class to be mocked
     # @param method_name [Symbol] the method to be mocked
     # @param watch [Boolean] whether to start watching the method
+    # @param instance [Boolean] whether to mock the instance method even if the class responds to the method itself
     #
     # @return [Grift::MockMethod]
     #
-    def initialize(klass, method_name, watch: true)
+    def initialize(klass, method_name, watch: true, instance: false)
       if Grift.restricted_method?(klass, method_name)
         raise(Grift::Error, "Cannot mock restricted method #{method_name} for class #{klass}")
       end
@@ -55,15 +56,11 @@ module Grift
       @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) ||
-        klass.singleton_class.private_method_defined?(method_name, true)
+      @class_method = !instance && defined_on?(klass.singleton_class, method_name)
 
       @method_access, @inherited = method_access_definition
       raise(Grift::Error, "Cannot mock unknown method #{method_name} for class #{klass}") unless @method_access
-
-      if class_instance.method_defined?(@cache_method_name)
-        raise(Grift::Error, "Cannot mock already mocked method #{method_name} for class #{klass}")
-      end
+      raise(Grift::Error, "Cannot mock already mocked method #{method_name} for class #{klass}") if already_mocked?
 
       watch_method if watch
     end
@@ -160,7 +157,7 @@ module Grift
         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)
+        mock_executions.store(args: args, kwargs: kwargs, result: return_value)
         return_value
       end
       class_instance.send(@method_access, @method_name)
@@ -203,7 +200,7 @@ module Grift
         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)
+        mock_executions.store(args: args, kwargs: kwargs, result: return_value)
 
         clean_mock.call
 
@@ -266,7 +263,7 @@ module Grift
         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)
+        mock_executions.store(args: args, kwargs: kwargs, result: return_value)
 
         clean_mock.call if mock_executions.count == n
 
@@ -618,8 +615,34 @@ module Grift
     # @return [Boolean]
     #
     def method_defined?
-      class_instance.method_defined?(@method_name, false) ||
-        class_instance.private_instance_methods(false).include?(@method_name)
+      defined_on?(class_instance, @method_name, inherit: false)
+    end
+
+    ##
+    # Checks if the method is already mocked. A class method and an instance method
+    # with the same name share a key in the mock store, so mocking either one counts.
+    #
+    # @return [Boolean]
+    #
+    def already_mocked?
+      owners = [@klass.singleton_class]
+      # an object can be mocked directly, and it has no instance methods of its own
+      owners << @klass if @klass.is_a?(Module)
+
+      owners.any? { |owner| defined_on?(owner, @cache_method_name) }
+    end
+
+    ##
+    # Checks if the owner defines the method with any access (public, protected, private).
+    #
+    # @param owner [Module] the class or singleton class to check
+    # @param method_name [Symbol] the method to look for
+    # @param inherit [Boolean] whether to include methods defined by ancestors
+    #
+    # @return [Boolean]
+    #
+    def defined_on?(owner, method_name, inherit: true)
+      owner.method_defined?(method_name, inherit) || owner.private_method_defined?(method_name, inherit)
     end
 
     ##

data/lib/grift/version.rb

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

data/lib/grift.rb

@@ -25,7 +25,9 @@ module Grift
     ##
     # 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+. To mock an instance method
+    # when the class responds to a method of the same name, use +spy_on+
+    # with +instance: true+.
     #
     # @example
     #   my_mock = Grift.mock(MyClass, :some_method, true)
@@ -46,18 +48,27 @@ module Grift
     # Creates a mock for the given method without mocking
     # the implementation or return values.
     #
+    # If the class responds to the method itself, the class method is
+    # watched. This includes methods every class has, like +name+,
+    # +to_s+, and +==+. Pass +instance: true+ to watch the instance
+    # method of the same name instead.
+    #
     # @example
     #   my_mock = Grift.spy_on(MyClass, :some_method)
     #
+    # @example
+    #   my_mock = Grift.spy_on(MyClass, :name, instance: true)
+    #
     # @param klass [Class] the class of the method to be watched
     # @param method [Symbol] the symbol representing the method to be watched
+    # @param instance [Boolean] if true, watch the instance method even if the class responds to the method itself
     #
     # @raise [Grift::Error] exception if method is already mocked or does not exist
     #
     # @return [Grift::MockMethod]
     #
-    def spy_on(klass, method)
-      MockMethod.new(klass, method)
+    def spy_on(klass, method, instance: false)
+      MockMethod.new(klass, method, instance: instance)
     end
 
     ##

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grift
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Clark Brown
@@ -16,23 +16,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
-- ".github/CONTRIBUTING.md"
-- ".github/FUNDING.yml"
-- ".github/dependabot.yml"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".overcommit.yml"
-- ".rubocop.yml"
-- ".yardopts"
 - CHANGELOG.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- grift.gemspec
 - lib/grift.rb
 - lib/grift/config.rb
 - lib/grift/config/restricted.yml
@@ -67,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Mocking and spying in MiniTest
 test_files: []

data/.github/CODEOWNERS

@@ -1 +0,0 @@
-.github/ @clarkedb

data/.github/CONTRIBUTING.md

@@ -1,37 +0,0 @@
-# How to become a contributor and submit your own code
-
-1. Submit an issue on GitHub describing your proposed change to this repo
-1. A repo owner will respond to your issue promptly
-1. Fork the repo, develop and test your code changes
-1. Ensure that your code adheres to the existing style in the code to which you are contributing
-1. Ensure that your code has an appropriate set of tests which all pass
-1. Title your pull request following [Conventional Commits](https://www.conventionalcommits.org/) styling
-1. Submit a pull request.
-
-## Policy on inclusive language
-
-To make Grift a pleasant and effective experience for everyone, we use try to use inclusive language.
-
-These resources can help:
-
-- Google's tutorial [Writing inclusive documentation](https://developers.google.com/style/inclusive-documentation) teaches by example, how to reword non-inclusive things.
-- Linux kernel mailing list's [Coding Style: Inclusive Terminology](https://lkml.org/lkml/2020/7/4/229) said "Add no new instances of non-inclusive words, here is a list of words not include new ones of."
-- Linguistic Society of America published [Guidelines for Inclusive Language](https://www.linguisticsociety.org/resource/guidelines-inclusive-language) which concluded: "We encourage all linguists to consider the possible reactions of their potential audience to their writing and, in so doing, to choose expository practices and content that is positive, inclusive, and respectful."
-
-This project attempts to improve in these areas. Join us in doing that important work.
-
-## Required checks
-
-Before pushing your code and opening a PR, we recommend you run the following checks to avoid
-our GitHub Actions Workflow to block your contribution.
-
-```bash
-# install dependencies
-$ bundle install
-
-# Run unit tests and check code coverage
-$ bundle exec rake test
-
-# Check code style
-$ bundle exec rubocop
-```

data/.github/FUNDING.yml

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

data/.github/dependabot.yml

@@ -1,13 +0,0 @@
-version: 2
-
-updates:
-  - directory: /
-    open-pull-requests-limit: 10
-    package-ecosystem: bundler
-    target-branch: main
-    schedule:
-      interval: monthly
-    labels:
-      - dependencies
-    assignees:
-      - clarkedb

data/.github/workflows/ci.yml

@@ -1,63 +0,0 @@
-name: CI
-
-on: push
-
-env:
-  CI: true
-  GIT_COMMIT_SHA: ${{ github.sha }}
-  GIT_BRANCH: ${{ github.ref }}
-
-jobs:
-  linting:
-    runs-on: ubuntu-latest
-    env:
-      BUNDLE_WITH: lint
-      BUNDLE_WITHOUT: development:test
-
-    steps:
-      - uses: actions/checkout@v6
-
-      - name: Set up Ruby 3.3
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.3
-          bundler-cache: true
-
-      - name: Rubocop
-        run: bundle exec rubocop --format progress
-
-  build:
-    needs: [linting]
-    runs-on: ubuntu-latest
-    name: build (ruby v${{ matrix.ruby }})
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby:
-          - "2.7"
-          - "3.0"
-          - "3.1"
-          - "3.2"
-          - "3.3"
-          - "3.4"
-          - "4.0"
-
-    steps:
-      - uses: actions/checkout@v6
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - name: Test
-        run: bundle exec rake --trace test
-
-      - name: Upload coverage to Codecov
-        if: always()
-        uses: codecov/codecov-action@v5
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          files: ./coverage/.resultset.json
-          name: codecov-umbrella
-          verbose: true
-          fail_ci_if_error: true

data/.gitignore

@@ -1,44 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-.env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# 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
-.ruby-version
-.ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*
-
-# IDE and system files
-.vscode/
-**/.DS_STORE

data/.overcommit.yml

@@ -1,8 +0,0 @@
-PreCommit:
-  RuboCop:
-    enabled: true
-    on_warn: fail # Treat all warnings as failures
-
-CommitMsg:
-  ALL:
-    enabled: false

data/.rubocop.yml

@@ -1,181 +0,0 @@
-# The behavior of RuboCop can be controlled via the .rubocop.yml
-# configuration file. It makes it possible to enable/disable
-# certain cops (checks) and to alter their behavior if they accept
-# any parameters. The file can be placed either in your home
-# directory or in some project directory.
-#
-# RuboCop will start looking for the configuration file in the directory
-# where the inspected file is and continue its way up to the root directory.
-#
-# See https://docs.rubocop.org/rubocop/configuration
-
-plugins:
-  - rubocop-minitest
-  - rubocop-packaging
-  - rubocop-performance
-
-# General
-AllCops:
-  NewCops: enable
-  SuggestExtensions: false
-
-# Layout
-Layout/BlockAlignment:
-  Enabled: true
-  EnforcedStyleAlignWith: start_of_block
-
-Layout/ClassStructure:
-  Enabled: true
-
-Layout/DotPosition:
-  Enabled: true
-  EnforcedStyle: leading
-
-Layout/FirstArrayElementIndentation:
-  Enabled: true
-  EnforcedStyle: consistent
-
-Layout/FirstHashElementIndentation:
-  Enabled: true
-  EnforcedStyle: consistent
-
-Layout/HashAlignment:
-  Enabled: true
-  EnforcedColonStyle: key
-  EnforcedLastArgumentHashStyle: always_inspect
-
-Layout/LineEndStringConcatenationIndentation:
-  Enabled: true
-  EnforcedStyle: aligned
-
-Layout/LineLength:
-  Enabled: true
-  Max: 120
-
-Layout/MultilineArrayLineBreaks:
-  Enabled: true
-
-Layout/MultilineAssignmentLayout:
-  Enabled: false
-
-Layout/MultilineHashKeyLineBreaks:
-  Enabled: true
-
-Layout/MultilineMethodArgumentLineBreaks:
-  Enabled: true
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: true
-  EnforcedStyle: indented_relative_to_receiver
-
-Layout/MultilineOperationIndentation:
-  Enabled: true
-  EnforcedStyle: indented
-
-Layout/ParameterAlignment:
-  Enabled: true
-  EnforcedStyle: with_first_parameter
-
-Layout/RedundantLineBreak:
-  Enabled: true
-  InspectBlocks: false
-
-Layout/SingleLineBlockChain:
-  Enabled: false
-
-Layout/SpaceBeforeBrackets:
-  Enabled: true
-
-Layout/TrailingEmptyLines:
-  Enabled: true
-  EnforcedStyle: final_newline
-
-# Lint
-Lint/AmbiguousAssignment:
-  Enabled: true
-
-Lint/AmbiguousOperatorPrecedence:
-  Enabled: true
-
-Lint/AmbiguousRange:
-  Enabled: true
-
-# Metrics
-Metrics/AbcSize:
-  Max: 25
-  Exclude:
-    - "test/**/*"
-
-Metrics/ClassLength:
-  Max: 225
-  CountAsOne:
-    - array
-    - hash
-    - heredoc
-  Exclude:
-    - "test/**/*"
-
-Metrics/MethodLength:
-  Max: 20
-  CountAsOne:
-    - array
-    - hash
-    - heredoc
-  Exclude:
-    - "test/**/*"
-
-# Minitest
-Minitest/AssertPredicate:
-  Enabled: false
-
-Minitest/EmptyLineBeforeAssertionMethods:
-  Enabled: false
-
-Minitest/MultipleAssertions:
-  Max: 10
-
-Minitest/RefutePredicate:
-  Enabled: false
-
-# Naming
-Naming/InclusiveLanguage:
-  Enabled: true
-
-Naming/MethodParameterName:
-  AllowedNames:
-    - n
-
-Naming/VariableNumber:
-  EnforcedStyle: snake_case
-
-# Style
-Style/AndOr:
-  EnforcedStyle: always
-
-Style/ArrayCoercion:
-  Enabled: true
-
-Style/CollectionCompact:
-  Enabled: true
-
-Style/ConstantVisibility:
-  Enabled: true
-  IgnoreModules: true
-
-Style/Documentation:
-  Exclude:
-    - "test/**/*"
-
-Style/DocumentationMethod:
-  Enabled: true
-  Exclude:
-    - "test/**/*"
-
-Style/SelectByRegexp:
-  Enabled: false
-
-Style/SwapValues:
-  Enabled: true
-
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: comma

data/.yardopts

@@ -1 +0,0 @@
--o ./docs - LICENSE

data/Gemfile

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Grift's gem dependencies are defined in grift.gemspec
-gemspec
-
-gem 'rake', '>= 12.0'
-
-group :development, :test do
-  gem 'minitest', '~> 5.25'
-  gem 'minitest-reporters', '~> 1.7'
-  gem 'simplecov', '~> 0.22'
-  gem 'simplecov-cobertura', '~> 3.1'
-end
-
-group :development, :lint do
-  gem 'overcommit', '>= 0.64'
-  gem 'rubocop', '~> 1.82.1'
-  gem 'rubocop-minitest', '~> 0.38.2'
-  gem 'rubocop-packaging', '~> 0.6.0'
-  gem 'rubocop-performance', '~> 1.26.0'
-end

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-task default: :test

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'grift'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/grift.gemspec

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/grift/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'grift'
-  spec.version       = Grift::VERSION
-  spec.authors       = ['Clark Brown']
-  spec.email         = ['clark@clark-brown.com']
-
-  spec.summary       = 'Mocking and spying in MiniTest'
-  spec.description   = "A gem for simple mocking and spying in Ruby's MiniTest framework."
-  spec.homepage      = 'https://github.com/clarkedb/grift'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
-
-  spec.metadata = {
-    'bug_tracker_uri' => "#{spec.homepage}/issues",
-    'changelog_uri' => "#{spec.homepage}/blob/main/CHANGELOG.md",
-    'documentation_uri' => spec.homepage.to_s,
-    'homepage_uri' => spec.homepage.to_s,
-    'rubygems_mfa_required' => 'true',
-    'source_code_uri' => spec.homepage.to_s
-  }
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|docs|spec|features)/}) } # rubocop:disable Packaging/GemspecGit
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-end