Merge pull request #54 from clarkedb/develop

v1.1.0

Author: clarkedb

.github/workflows/ci.yml

@@ -26,13 +26,13 @@ jobs:
         run: bundle exec rubocop --format progress
 
   build:
-    needs: [ linting ]
+    needs: [linting]
     runs-on: ubuntu-latest
     name: build (ruby v${{ matrix.ruby }})
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+        ruby: ["2.5", "2.6", "2.7", "3.0", "3.1"]
 
     steps:
       - uses: actions/checkout@v2

CHANGELOG.md

@@ -8,6 +8,22 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 N/A
 
+## [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
+
+### Updated
+
+* Updates `minitest`
+* Updates `minitest-reporters`
+* Updates `rubocop`
+* Updates `rubocop-minitest`
+* Updates `rubocop-performance`
+
 ## [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.

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grift (1.0.2)
+    grift (1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,35 +10,35 @@ GEM
     ast (2.4.2)
     builder (3.2.4)
     docile (1.4.0)
-    minitest (5.14.4)
-    minitest-reporters (1.4.3)
+    minitest (5.15.0)
+    minitest-reporters (1.5.0)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
-    rubocop (1.22.3)
+    rubocop (1.25.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
+    rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
-    rubocop-minitest (0.15.2)
+    rubocop-minitest (0.17.1)
       rubocop (>= 0.90, < 2.0)
     rubocop-packaging (0.5.1)
       rubocop (>= 0.89, < 2.0)
-    rubocop-performance (1.12.0)
+    rubocop-performance (1.13.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)

README.md

@@ -106,12 +106,20 @@ my_mock.mock.results
 #=> ['result1', 'result2']
 ```
 
+## Requirements
+
+Grift supports all Ruby versions >= 2.5 (including 3.1).
+
 ## Development
 
 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` . 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).
 
+### 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.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [clarkedb/grift](https://github.com/clarkedb/grift). Before submitting a pull request, see [CONTRIBUTING](.github/CONTRIBUTING.md).

docs/Grift.html

@@ -6,7 +6,7 @@
 <title>
   Module: Grift
 
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
 
 </title>
 
@@ -131,7 +131,7 @@ <h2>
 
 </div>
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.0.2</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.1.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
 
     </dl>
 
@@ -663,7 +663,7 @@ <h3 class="signature " id="mock-class_method">
 </h3><div class="docstring">
   <div class="discussion">
 
-<p>Mocks the given method to return the provided value. This is syntactical sugar equivalent to calling `spy_on` and then `mock_return_value`.</p>
+<p>Mocks the given method to return the provided value. This is syntactical sugar equivalent to calling ‘spy_on` and then `mock_return_value`.</p>
 
 
   </div>
@@ -1494,9 +1494,9 @@ <h3 class="signature " id="spy_on-class_method">
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 11 08:39:35 2021 by
+  Generated on Thu Feb  3 20:35:19 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.1).
+  0.9.27 (ruby-3.1.0).
 </div>
 
     </div>

docs/Grift/Config.html

@@ -6,7 +6,7 @@
 <title>
   Module: Grift::Config
 
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
 
 </title>
 
@@ -153,7 +153,7 @@ <h3 class="signature first" id="restricted_methods-class_method">
 </h3><div class="docstring">
   <div class="discussion">
 
-<p>The restricted methods as a hash organized by class as the key and then the methods in an array as the value. A &#39;*&#39; means all methods are restricted. A &#39;^&#39; preceding a method overrides the wildcard restriction.</p>
+<p>The restricted methods as a hash organized by class as the key and then the methods in an array as the value. A ‘*’ means all methods are restricted. A ‘^’ preceding a method overrides the wildcard restriction.</p>
 
 
   </div>
@@ -215,9 +215,9 @@ <h3 class="signature first" id="restricted_methods-class_method">
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 11 08:39:35 2021 by
+  Generated on Thu Feb  3 20:35:19 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.1).
+  0.9.27 (ruby-3.1.0).
 </div>
 
     </div>

docs/Grift/Error.html

@@ -6,7 +6,7 @@
 <title>
   Exception: Grift::Error
 
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
 
 </title>
 
@@ -125,9 +125,9 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 11 08:39:35 2021 by
+  Generated on Thu Feb  3 20:35:19 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.1).
+  0.9.27 (ruby-3.1.0).
 </div>
 
     </div>

docs/Grift/MinitestPlugin.html

@@ -6,7 +6,7 @@
 <title>
   Module: Grift::MinitestPlugin
 
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
 
 </title>
 
@@ -88,7 +88,7 @@ <h2>Overview</h2><div class="docstring">
 
 <p>A plugin to clean up mocks after tests in Minitest. It is recommended that you include this plugin to avoid needing to cleanup the mocks after each test.</p>
 
-<p>To setup the plugin for your tests, you should include the following code in your `test_helper`</p>
+<p>To setup the plugin for your tests, you should include the following code in your ‘test_helper`</p>
 
 <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Minitest</span><span class='op'>::</span><span class='const'>Test</span>
   <span class='id identifier rubyid_include'>include</span> <span class='const'><span class='object_link'><a href="../Grift.html" title="Grift (module)">Grift</a></span></span><span class='op'>::</span><span class='const'>MinitestPlugin</span>
@@ -210,9 +210,9 @@ <h3 class="signature first" id="after_teardown-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 11 08:39:35 2021 by
+  Generated on Thu Feb  3 20:35:19 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.1).
+  0.9.27 (ruby-3.1.0).
 </div>
 
     </div>

docs/Grift/MockMethod.html

@@ -6,7 +6,7 @@
 <title>
   Class: Grift::MockMethod
 
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
 
 </title>
 
@@ -378,7 +378,7 @@ <h2>
 
 
     <span class="summary_desc"><div class='inline'>
-<p>Clears the mock execution and calls data for this mock, and mocks the method to return `nil`.</p>
+<p>Clears the mock execution and calls data for this mock, and mocks the method to return ‘nil`.</p>
 </div></span>
 
 </li>
@@ -1104,7 +1104,7 @@ <h3 class="signature " id="mock_reset-instance_method">
 </h3><div class="docstring">
   <div class="discussion">
 
-<p>Clears the mock execution and calls data for this mock, and mocks the method to return `nil`.</p>
+<p>Clears the mock execution and calls data for this mock, and mocks the method to return ‘nil`.</p>
 
 
   </div>
@@ -1416,9 +1416,9 @@ <h3 class="signature " id="to_s-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 11 08:39:35 2021 by
+  Generated on Thu Feb  3 20:35:20 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.1).
+  0.9.27 (ruby-3.1.0).
 </div>
 
     </div>

docs/Grift/MockMethod/MockExecutions.html

@@ -6,7 +6,7 @@
 <title>
   Class: Grift::MockMethod::MockExecutions
 
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.27
 
 </title>
 
@@ -692,9 +692,9 @@ <h3 class="signature " id="store-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Thu Nov 11 08:39:35 2021 by
+  Generated on Thu Feb  3 20:35:20 2022 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.1).
+  0.9.27 (ruby-3.1.0).
 </div>
 
     </div>