Skip to content

Commit 7168c85

Browse files
clarkedbclarkedb
authored
prep v1.1.0 release (#53)
* update CHANGELOG * bump version to 1.1.0 * add doc generation notes to README * update docs for v1.1.0
1 parent 2b061c9 commit 7168c85

17 files changed

+88
-52
lines changed

‎CHANGELOG.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,22 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
88

99
N/A
1010

11+
## [1.1.0](https://github.com/clarkedb/grift/releases/tag/v1.1.0) - 2022-02-03
12+
13+
This version adds support for Ruby 3.1 and updates various dependencies.
14+
15+
### Added
16+
17+
* Support Ruby 3.1
18+
19+
### Updated
20+
21+
* Updates `minitest`
22+
* Updates `minitest-reporters`
23+
* Updates `rubocop`
24+
* Updates `rubocop-minitest`
25+
* Updates `rubocop-performance`
26+
1127
## [1.0.2](https://github.com/clarkedb/grift/releases/tag/v1.0.2) - 2021-11-11
1228

1329
This version fixes a bug that prevented the mocking of methods defined by a class's super class.

‎Gemfile.lock‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
grift (1.0.2)
4+
grift (1.1.0)
55

66
GEM
77
remote: https://rubygems.org/

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,10 @@ After forking the repo, run `bin/setup` to install dependencies. Then, run `rake
116116

117117
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).
118118

119+
### Docs
120+
121+
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.
122+
119123
## Contributing
120124

121125
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‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<title>
77
Module: Grift
88

9-
&mdash; Documentation by YARD 0.9.26
9+
&mdash; Documentation by YARD 0.9.27
1010

1111
</title>
1212

@@ -131,7 +131,7 @@ <h2>
131131

132132
</div>
133133
</dt>
134-
<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>
134+
<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>
135135

136136
</dl>
137137

@@ -663,7 +663,7 @@ <h3 class="signature " id="mock-class_method">
663663
</h3><div class="docstring">
664664
<div class="discussion">
665665

666-
<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>
666+
<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>
667667

668668

669669
</div>
@@ -1494,9 +1494,9 @@ <h3 class="signature " id="spy_on-class_method">
14941494
</div>
14951495

14961496
<div id="footer">
1497-
Generated on Thu Nov 11 08:39:35 2021 by
1497+
Generated on Thu Feb 3 20:35:19 2022 by
14981498
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1499-
0.9.26 (ruby-2.7.1).
1499+
0.9.27 (ruby-3.1.0).
15001500
</div>
15011501

15021502
</div>

‎docs/Grift/Config.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<title>
77
Module: Grift::Config
88

9-
&mdash; Documentation by YARD 0.9.26
9+
&mdash; Documentation by YARD 0.9.27
1010

1111
</title>
1212

@@ -153,7 +153,7 @@ <h3 class="signature first" id="restricted_methods-class_method">
153153
</h3><div class="docstring">
154154
<div class="discussion">
155155

156-
<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>
156+
<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>
157157

158158

159159
</div>
@@ -215,9 +215,9 @@ <h3 class="signature first" id="restricted_methods-class_method">
215215
</div>
216216

217217
<div id="footer">
218-
Generated on Thu Nov 11 08:39:35 2021 by
218+
Generated on Thu Feb 3 20:35:19 2022 by
219219
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
220-
0.9.26 (ruby-2.7.1).
220+
0.9.27 (ruby-3.1.0).
221221
</div>
222222

223223
</div>

‎docs/Grift/Error.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<title>
77
Exception: Grift::Error
88

9-
&mdash; Documentation by YARD 0.9.26
9+
&mdash; Documentation by YARD 0.9.27
1010

1111
</title>
1212

@@ -125,9 +125,9 @@ <h2>Overview</h2><div class="docstring">
125125
</div>
126126

127127
<div id="footer">
128-
Generated on Thu Nov 11 08:39:35 2021 by
128+
Generated on Thu Feb 3 20:35:19 2022 by
129129
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
130-
0.9.26 (ruby-2.7.1).
130+
0.9.27 (ruby-3.1.0).
131131
</div>
132132

133133
</div>

‎docs/Grift/MinitestPlugin.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<title>
77
Module: Grift::MinitestPlugin
88

9-
&mdash; Documentation by YARD 0.9.26
9+
&mdash; Documentation by YARD 0.9.27
1010

1111
</title>
1212

@@ -88,7 +88,7 @@ <h2>Overview</h2><div class="docstring">
8888

8989
<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>
9090

91-
<p>To setup the plugin for your tests, you should include the following code in your `test_helper`</p>
91+
<p>To setup the plugin for your tests, you should include the following code in your ‘test_helper`</p>
9292

9393
<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>
9494
<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">
210210
</div>
211211

212212
<div id="footer">
213-
Generated on Thu Nov 11 08:39:35 2021 by
213+
Generated on Thu Feb 3 20:35:19 2022 by
214214
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
215-
0.9.26 (ruby-2.7.1).
215+
0.9.27 (ruby-3.1.0).
216216
</div>
217217

218218
</div>

‎docs/Grift/MockMethod.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<title>
77
Class: Grift::MockMethod
88

9-
&mdash; Documentation by YARD 0.9.26
9+
&mdash; Documentation by YARD 0.9.27
1010

1111
</title>
1212

@@ -378,7 +378,7 @@ <h2>
378378

379379

380380
<span class="summary_desc"><div class='inline'>
381-
<p>Clears the mock execution and calls data for this mock, and mocks the method to return `nil`.</p>
381+
<p>Clears the mock execution and calls data for this mock, and mocks the method to return ‘nil`.</p>
382382
</div></span>
383383

384384
</li>
@@ -1104,7 +1104,7 @@ <h3 class="signature " id="mock_reset-instance_method">
11041104
</h3><div class="docstring">
11051105
<div class="discussion">
11061106

1107-
<p>Clears the mock execution and calls data for this mock, and mocks the method to return `nil`.</p>
1107+
<p>Clears the mock execution and calls data for this mock, and mocks the method to return ‘nil`.</p>
11081108

11091109

11101110
</div>
@@ -1416,9 +1416,9 @@ <h3 class="signature " id="to_s-instance_method">
14161416
</div>
14171417

14181418
<div id="footer">
1419-
Generated on Thu Nov 11 08:39:35 2021 by
1419+
Generated on Thu Feb 3 20:35:20 2022 by
14201420
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1421-
0.9.26 (ruby-2.7.1).
1421+
0.9.27 (ruby-3.1.0).
14221422
</div>
14231423

14241424
</div>

‎docs/Grift/MockMethod/MockExecutions.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<title>
77
Class: Grift::MockMethod::MockExecutions
88

9-
&mdash; Documentation by YARD 0.9.26
9+
&mdash; Documentation by YARD 0.9.27
1010

1111
</title>
1212

@@ -692,9 +692,9 @@ <h3 class="signature " id="store-instance_method">
692692
</div>
693693

694694
<div id="footer">
695-
Generated on Thu Nov 11 08:39:35 2021 by
695+
Generated on Thu Feb 3 20:35:20 2022 by
696696
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
697-
0.9.26 (ruby-2.7.1).
697+
0.9.27 (ruby-3.1.0).
698698
</div>
699699

700700
</div>

‎docs/Grift/MockStore.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<title>
77
Class: Grift::MockStore
88

9-
&mdash; Documentation by YARD 0.9.26
9+
&mdash; Documentation by YARD 0.9.27
1010

1111
</title>
1212

@@ -946,9 +946,9 @@ <h3 class="signature " id="store-instance_method">
946946
</div>
947947

948948
<div id="footer">
949-
Generated on Thu Nov 11 08:39:35 2021 by
949+
Generated on Thu Feb 3 20:35:19 2022 by
950950
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
951-
0.9.26 (ruby-2.7.1).
951+
0.9.27 (ruby-3.1.0).
952952
</div>
953953

954954
</div>

0 commit comments

Comments
 (0)