version_gem 1.1.9 → 1.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cd4a5c38f28eb3f9c215684dfeb3d7b8eed4e26a76e5a5fbab98937aa17a147c
4
- data.tar.gz: 494810d3d25c269eb3867fa9c600df69354c45438c35bae8087912e3165e086c
3
+ metadata.gz: a1e050fbee99a30a7c0487f45232d51e55823133a7f2cf2ce323068be92d4e98
4
+ data.tar.gz: db60ef481522a78a6387683e3faaf79b8e4b9f1b38ead22a42e6b5a19ede11d5
5
5
  SHA512:
6
- metadata.gz: e85bc0c821117c19ed6c08427b4dee64792b49453bad2885d03e195236ba863c2048eba779fab77c15efefcbba8eccff20eaca9f1465adba96736b3081e4cef8
7
- data.tar.gz: d1e488c79e04c025dd1cb6fe33d6908513b3e15275d8f4e682a7f61ce258ec7d8b6d47e9f948f9bb1c10ad86cf63f0855ec9aa2c3605112b77470da3c91d6bca
6
+ metadata.gz: d61ca6ef9cb96d2ec1a3c03ba4583f03f02a9e3ae705785a79ad31d8d724197eeb983e4085dd0488484f204f275cb1719ee8d8824243b9029f2fc9c3df927448
7
+ data.tar.gz: 9c9f70c2429f930f23b7f052309f5e46edd4593f6c75caa46eb75859eb65ccc0b0e0038885f50ea82b2b5252481efadab62a5a73e081481bcc3ac23254feb116
checksums.yaml.gz.sig CHANGED
Binary file
data/CHANGELOG.md CHANGED
@@ -17,34 +17,118 @@ Please file a bug if you notice a violation of semantic versioning.
17
17
  [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
18
18
 
19
19
  ## [Unreleased]
20
+
20
21
  ### Added
22
+
21
23
  ### Changed
24
+
22
25
  ### Deprecated
26
+
23
27
  ### Removed
28
+
24
29
  ### Fixed
30
+
25
31
  ### Security
26
32
 
33
+ ## [1.1.11] - 2026-06-06
34
+
35
+ - TAG: [v1.1.11][1.1.11t]
36
+ - COVERAGE: 100.00% -- 58/58 lines in 2 files
37
+ - BRANCH COVERAGE: 0.00% -- 0/0 branches in 2 files
38
+ - 85.19% documented
39
+
40
+ ### Added
41
+
42
+ - Added the generated `appraisal2` binstub.
43
+
44
+ ### Changed
45
+
46
+ - Refreshed generated CI workflows, README support badges, gemspec development
47
+ dependency floors, and template metadata from the current kettle-jem
48
+ template.
49
+ - Updated generated Appraisal2 integration to use the `appraisal2-rubocop`
50
+ plugin DSL and raised the generated `appraisal2` / `appraisal2-rubocop`
51
+ dependency floors.
52
+
53
+ ## [1.1.10] - 2026-06-02
54
+
55
+ - TAG: [v1.1.10][1.1.10t]
56
+ - COVERAGE: 100.00% -- 58/58 lines in 2 files
57
+ - BRANCH COVERAGE: 0.00% -- 0/0 branches in 2 files
58
+ - 85.19% documented
59
+
60
+ ### Added
61
+
62
+ - StructuredMerge-managed template configuration under `.structuredmerge/`,
63
+ including semantic Git diff driver settings and kettle-drift integration.
64
+ - `rubocop-gradual` baseline tracking for style checks.
65
+
66
+ ### Changed
67
+
68
+ - Re-templated the project with the current kettle-jem / StructuredMerge
69
+ template.
70
+ - Development and test dependency floors now use current template floors:
71
+ `kettle-dev` 2.0.7, `kettle-test` 2.0.3, `kettle-soup-cover` 2.0.0,
72
+ `turbo_tests2` 3.1.1, `rubocop-lts` 8.3.0, and
73
+ `rubocop-lts-rspec` 1.0.3.
74
+ - Development and test tooling now targets Ruby 2.4 or newer while the
75
+ published runtime Ruby requirement remains Ruby 2.2 or newer.
76
+ - RSpec setup now loads `kettle-test` helpers and kettle-soup-cover coverage
77
+ bootstrap from `spec/spec_helper.rb`.
78
+ - Templating dependencies now load only when `K_JEM_TEMPLATING=true`, with
79
+ local StructuredMerge and Kettle workspace dependencies wired through
80
+ `SMORG_RB_DEV`, `KETTLE_RB_DEV`, and `nomono`.
81
+ - Gem metadata and packaging inventory were refreshed by the template,
82
+ including homepage, wiki, license-file, and packaged file handling.
83
+
84
+ ### Removed
85
+
86
+ - Removed the obsolete `.yard_gfm_support.rb` documentation hook; YARD setup now
87
+ uses the current template-managed plugin configuration.
88
+ - Removed obsolete CI workflows for Ruby 2.3, JRuby 9.1, TruffleRuby 23.2,
89
+ CodeQL, framework CI, and Discord notifications.
90
+ - Removed legacy generated binstubs in favor of the current curated
91
+ `kettle-check-eof`, `kettle-test`, and retained documentation binstubs.
92
+
93
+ ### Fixed
94
+
95
+ - logo at top of README.md
96
+
97
+ - Fixed the Style workflow RBS validation command so CI uses the bundled `rbs`
98
+ executable instead of the non-executable `bin/rbs` binstub.
99
+ - Fixed the Coverage workflow so Codecov repository-registration/upload errors
100
+ do not fail CI after local coverage reports have already been generated and
101
+ verified.
102
+
27
103
  ## [1.1.9] - 2025-09-02
104
+
28
105
  - TAG: [v1.1.9][1.1.9t]
29
106
  - COVERAGE: 100.00% -- 118/118 lines in 8 files
30
107
  - BRANCH COVERAGE: 100.00% -- 4/4 branches in 8 files
31
108
  - 84.62% documented
109
+
32
110
  ### Added
111
+
33
112
  - re-templated gem using kettle-dev v1.1.2
34
113
  - new binstubs for changelog, readme, commit message, & release management
35
114
  - new CI workflows
36
115
  - enhanced project documentation
37
116
  - More RBS types
38
117
  - docs site: https://version-gem.galtzo.com
118
+
39
119
  ### Fixed
120
+
40
121
  - RBS types are more accurate
41
122
 
42
123
  ## [1.1.8] 2025-05-06
124
+
43
125
  - TAG: [1.1.8][1.1.8t]
44
126
  - COVERAGE: 100.00% -- 118/118 lines in 8 files
45
127
  - BRANCH COVERAGE: 100.00% -- 4/4 branches in 8 files
46
128
  - 84.62% documented
129
+
47
130
  ### Added
131
+
48
132
  - CITATION.cff (@pboling)
49
133
  - Cryptographically signed with new 20-year cert (@pboling)
50
134
  - expires 2045-04-29
@@ -53,25 +137,33 @@ Please file a bug if you notice a violation of semantic versioning.
53
137
  - GitLab CI, as an addition to existing GHA (@pboling)
54
138
 
55
139
  ## [1.1.7] 2025-04-15
140
+
56
141
  - TAG: [1.1.7][1.1.7t]
57
142
  - Line Coverage: 100.0% (117 / 117)
58
143
  - Branch Coverage: 100.0% (4 / 4)
59
144
  - 76.92% documented
145
+
60
146
  ### Added
147
+
61
148
  - Support for Epoch Semantic Versioning (@pboling)
62
149
  - `extend VersionGem::Epoch` in your library's `MyLib::Version` module
63
150
  - Support for JRuby 10 (@pboling)
64
151
  - More documentation (@pboling)
152
+
65
153
  ### Removed
154
+
66
155
  - Ruby 2.2 removed from CI, though technically still supported
67
156
  - can't run directly in GHA anymore
68
157
 
69
158
  ## [1.1.6] 2025-02-24
159
+
70
160
  - TAG: [1.1.6][1.1.6t]
71
161
  - Line Coverage: 100.0% (77 / 77)
72
162
  - Branch Coverage: 100.0% (2 / 2)
73
163
  - 77.78% documented
164
+
74
165
  ### Added
166
+
75
167
  - Support for JRuby 9.1, 9.2, 9.3, 9.4, and head (@pboling)
76
168
  - Support for Truffle Ruby 22.3, 23.0, 23.1, 24.1, and head (@pboling)
77
169
  - Evergreen current latest engine release workflow (@pboling)
@@ -79,19 +171,26 @@ Please file a bug if you notice a violation of semantic versioning.
79
171
  - Improved developer experience for contributors (@pboling)
80
172
  - More documentation (@pboling)
81
173
  - Switch to stone_checksums for checksum generation (@pboling)
174
+
82
175
  ### Changed
176
+
83
177
  - Code of Conduct updated - Contributor Covenant v2.0 => v2.1 (@pboling)
84
178
 
85
179
  ## [1.1.5] 2025-02-22
180
+
86
181
  - TAG: [1.1.5][1.1.5t]
87
182
  - Line Coverage: 100.0% (77 / 77)
88
183
  - Branch Coverage: 100.0% (2 / 2)
89
184
  - 77.78% documented
185
+
90
186
  ### Added
187
+
91
188
  - Document approach to get code coverage on your gem's version.rb file (@pboling)
92
189
  - More documentation, and yard task for documentation (@pboling)
93
190
  - Documentation of Ruby version and SemVer support (@pboling)
191
+
94
192
  ### Fixed
193
+
95
194
  - [#3](https://gitlab.com/ruby-oauth/version_gem/-/issues/3) - Allow packaging without signing (@pboling)
96
195
  - to support secure linux distros which have alternate means of signing packages within their package managers
97
196
  - Code coverage tracking (@pboling)
@@ -99,15 +198,23 @@ Please file a bug if you notice a violation of semantic versioning.
99
198
  - Improved gemspec config (@pboling)
100
199
 
101
200
  ## [1.1.4] 2024-03-21
201
+
102
202
  - TAG: [1.1.4][1.1.4t]
203
+
103
204
  ### Added
205
+
104
206
  - Ruby 3.3 to CI (@pboling)
207
+
105
208
  ### Fixed
209
+
106
210
  - Remove the executable bit from non-executable files (@Fryguy)
107
211
 
108
212
  ## [1.1.3] 2023-06-05
213
+
109
214
  - TAG: [1.1.3][1.1.3t]
215
+
110
216
  ### Added
217
+
111
218
  - More test coverage (now 100% 🎉) (@pboling)
112
219
  - Improved documentation (now 77% 🎉) (@pboling)
113
220
  - Gemfile context pattern (@pboling)
@@ -120,58 +227,88 @@ Please file a bug if you notice a violation of semantic versioning.
120
227
  - pry-suite
121
228
  - debase, for IDE debugging
122
229
  - (dev) Rake task for rubocop_gradual (@pboling)
230
+
123
231
  ### Fixed
232
+
124
233
  - (dev) `yard` documentation task (@pboling)
234
+
125
235
  ### Removed
236
+
126
237
  - Formally drop Ruby 2.2 support
127
238
  - Ruby 2.2 was already de facto minimum version supported, which is why this wasn't a 2.0 release.
128
239
 
129
240
  ## [1.1.2] - 2023-03-17
241
+
130
242
  - TAG: [1.1.2][1.1.2t]
243
+
131
244
  ### Added
245
+
132
246
  - `VersionGem::Ruby` to help library CI integration against many different versions of Ruby (@pboling)
133
247
  - Experimental, optional, require (not loaded by default, which is why this can be in a patch)
134
248
  - Spec coverage is now 100%, lines and branches, including the fabled `version.rb` (@pboling)
135
249
  - Full RBS Signatures (@pboling)
136
250
 
137
251
  ## [1.1.1] - 2022-09-19
252
+
138
253
  - TAG: [1.1.1][1.1.1t]
254
+
139
255
  ### Added
256
+
140
257
  - Alternatives section to README.md (@pboling)
141
258
  - Signing cert for gem releases (@pboling)
142
259
  - Mailing List and other metadata URIs (@pboling)
143
260
  - Checksums for released gems (@pboling)
261
+
144
262
  ### Changed
263
+
145
264
  - SECURITY.md policy (@pboling)
146
265
  - Version methods are now memoized (||=) on initial call for performance (@pboling)
147
266
  - Gem releases are now cryptographically signed (@pboling)
148
267
 
149
268
  ## [1.1.0] - 2022-06-24
269
+
150
270
  - TAG: [1.1.0][1.1.0t]
271
+
151
272
  ### Added
273
+
152
274
  - RSpec Matchers and Shared Example (@pboling)
275
+
153
276
  ### Fixed
277
+
154
278
  - `to_a` uses same type casting as major, minor, patch, and pre (@pboling)
155
279
 
156
280
  ## [1.0.2] - 2022-06-23
281
+
157
282
  - TAG: [1.0.2][1.0.2t]
283
+
158
284
  ### Added
285
+
159
286
  - Delay loading of library code until after code coverage tool is loaded (@pboling)
160
287
 
161
288
  ## [1.0.1] - 2022-06-23
289
+
162
290
  - TAG: [1.0.1][1.0.1t]
291
+
163
292
  ### Added
293
+
164
294
  - CI Build improvements (@pboling)
165
295
  - Code coverage reporting (@pboling)
166
296
  - Documentation improvements (@pboling)
167
297
  - Badges! (@pboling)
168
298
 
169
299
  ## [1.0.0] - 2022-06-21
300
+
170
301
  - TAG: [1.0.0][1.0.0t]
302
+
171
303
  ### Added
304
+
172
305
  - Initial release, with basic version parsing API (@pboling)
173
306
 
174
- [Unreleased]: https://github.com/ruby-oauth/version_gem/compare/v1.1.9...HEAD
307
+ [Unreleased]: https://github.com/ruby-oauth/version_gem/compare/v1.1.11...HEAD
308
+ [1.1.11]: https://github.com/ruby-oauth/version_gem/compare/v1.1.10...v1.1.11
309
+ [1.1.11t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.11
310
+ [1.1.10]: https://github.com/ruby-oauth/version_gem/compare/v1.1.9...v1.1.10
311
+ [1.1.10t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.10
175
312
  [1.1.9]: https://github.com/ruby-oauth/version_gem/compare/v1.1.8...v1.1.9
176
313
  [1.1.9t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.9
177
314
  [1.1.8]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.7...v1.1.8
data/CITATION.cff CHANGED
@@ -1,19 +1,19 @@
1
1
  cff-version: 1.2.0
2
- title: version_gem
2
+ title: "version_gem"
3
3
  message: >-
4
4
  If you use this work and you want to cite it,
5
5
  then you can use the metadata from this file.
6
6
  type: software
7
7
  authors:
8
- - given-names: Peter Hurn
9
- family-names: Boling
10
- email: peter@railsbling.com
11
- affiliation: railsbling.com
8
+ - given-names: "Peter H."
9
+ family-names: "Boling"
10
+ email: "floss@galtzo.com"
11
+ affiliation: "galtzo.com"
12
12
  orcid: 'https://orcid.org/0009-0008-8519-441X'
13
13
  identifiers:
14
14
  - type: url
15
15
  value: 'https://github.com/ruby-oauth/version_gem'
16
- description: version_gem
16
+ description: "version_gem"
17
17
  repository-code: 'https://github.com/ruby-oauth/version_gem'
18
18
  abstract: >-
19
19
  version_gem
data/CONTRIBUTING.md CHANGED
@@ -8,19 +8,63 @@ To submit a patch, please fork the project, create a patch with tests, and send
8
8
 
9
9
  Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
10
10
 
11
+ ## Developer Certificate of Origin
12
+
13
+ In order to protect users of this project, we require all contributors to comply with the
14
+ [Developer Certificate of Origin](https://developercertificate.org/).
15
+ This ensures that all contributions are properly licensed and attributed.
16
+
11
17
  ## Help out!
12
18
 
13
- Take a look at the `reek` list which is the file called `REEK` and find something to improve.
19
+ Take a look at the open issues and pull requests, or use the gem and find something to improve.
14
20
 
15
21
  Follow these instructions:
16
22
 
17
- 1. Fork the repository
18
- 2. Create a feature branch (`git checkout -b my-new-feature`)
19
- 3. Make some fixes.
20
- 4. Commit changes (`git commit -am 'Added some feature'`)
21
- 5. Push to the branch (`git push origin my-new-feature`)
22
- 6. Make sure to add tests for it. This is important, so it doesn't break in a future release.
23
- 7. Create new Pull Request.
23
+ 1. Join the Discord: [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
24
+ 2. Fork the repository
25
+ 3. Create your feature branch (`git checkout -b my-new-feature`)
26
+ 4. Make some fixes.
27
+ 5. Commit your changes (`git commit -am 'Added some feature'`)
28
+ 6. Push to the branch (`git push origin my-new-feature`)
29
+ 7. Make sure to add tests for it. This is important, so it doesn't break in a future release.
30
+ 8. Create new Pull Request.
31
+ 9. Announce it in the channel for this org in the [Discord][✉️discord-invite]!
32
+
33
+ ## Executables vs Rake tasks
34
+
35
+ Executables shipped by dependencies, such as kettle-dev, and stone_checksums, are available
36
+ after running `bin/setup`. These include:
37
+
38
+ - gem_checksums
39
+ - kettle-changelog
40
+ - kettle-commit-msg
41
+ - kettle-dev-setup
42
+ - kettle-dvcs
43
+ - kettle-pre-release
44
+ - kettle-readme-backers
45
+ - kettle-release
46
+
47
+ There are many Rake tasks available as well. You can see them by running:
48
+
49
+ ```shell
50
+ bin/rake -T
51
+ ```
52
+
53
+ ## Code quality checks
54
+
55
+ Run the Reek task when you want a smell check that fails on current findings:
56
+
57
+ ```shell
58
+ bin/rake reek
59
+ ```
60
+
61
+ Refresh the checked-in `REEK` backlog through the rake task, not by redirecting
62
+ the raw `reek` executable output. The rake task uses the project bundle and
63
+ avoids stale generated binstubs shadowing the Reek gem executable:
64
+
65
+ ```shell
66
+ bin/rake reek:update
67
+ ```
24
68
 
25
69
  ## Environment Variables for Local Development
26
70
 
@@ -32,7 +76,7 @@ General/runtime
32
76
  - CI: When set to true, adjusts default rake tasks toward CI behavior
33
77
 
34
78
  Coverage (kettle-soup-cover / SimpleCov)
35
- - K_SOUP_COV_DO: Enable coverage collection (default: true in .envrc)
79
+ - K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
36
80
  - K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
37
81
  - K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
38
82
  - K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
@@ -48,7 +92,9 @@ GitHub API and CI helpers
48
92
  Releasing and signing
49
93
  - SKIP_GEM_SIGNING: If set, skip gem signing during build/release
50
94
  - GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
51
- - SOURCE_DATE_EPOCH: Reproducible build timestamp. `kettle-release` will set this automatically for the session.
95
+ - SOURCE_DATE_EPOCH: Reproducible build timestamp.
96
+ - `kettle-release` will set this automatically for the session.
97
+ - Not needed on bundler >= 2.7.0, as reproducible builds have become the default.
52
98
 
53
99
  Git hooks and commit message helpers (exe/kettle-commit-msg)
54
100
  - GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
@@ -56,43 +102,66 @@ Git hooks and commit message helpers (exe/kettle-commit-msg)
56
102
  - GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
57
103
  - GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
58
104
 
59
- For a quick starting point, this repository’s `.envrc` shows sane defaults, and `.env.local` can override them locally.
105
+ Git diff driver setup
106
+ - Local setup writes repository `.gitattributes` entries and local Git `diff.smorg-*` command config so this checkout uses StructuredMerge semantic diffs.
107
+ - Global setup registers `diff.smorg-*` commands once in the user Git config; use it when you work across several StructuredMerge-enabled repositories.
108
+ - Include-file setup writes `.git/smorg/config` and includes it from local Git config, keeping command registrations out of the repository files.
109
+ - Git hosting forges generally ignore external diff drivers, so pull request views may still show raw textual diffs even when local `git diff` uses semantic drivers.
110
+
111
+ ```console
112
+ K_JEM_TEMPLATING=true bundle exec kettle-jem install
113
+ ```
114
+
115
+ Troubleshooting Git diffs
116
+ - Use `git diff --no-ext-diff` to compare against Git's built-in diff output.
117
+ - Use `git diff --no-textconv` when a textconv projection obscures the raw file bytes you need to inspect.
118
+ - If Git reports a missing `smorg-*` executable, rerun `bundle install` and the setup command above, then check `git config --local --get-regexp '^diff\.smorg-'`.
119
+ - To remove managed local entries, run `K_JEM_TEMPLATING=true bundle exec kettle-jem install --undo`; remove global command registrations with `git config --global --unset-all diff.smorg-ruby.command`.
120
+
121
+ For a quick starting point, this repository’s `mise.toml` defines the shared defaults, and `.env.local` can override them locally. Copy `.env.local.example` to `.env.local`, use `KEY=value` lines, and either activate `mise` in your shell or run commands through `mise exec -C /path/to/project -- ...`.
60
122
 
61
123
  ## Appraisals
62
124
 
63
125
  From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
126
+ Generated appraisal and CI workflow floors are controlled by `ruby.test_minimum`
127
+ in `.structuredmerge/kettle-jem.yml`; this project was templated with `ruby.test_minimum: 2.4`.
128
+ That value describes the lowest Ruby version expected to run the test/development
129
+ toolchain, and it may be higher than the gemspec runtime floor.
130
+
64
131
  They are created and updated with the commands:
65
132
 
66
133
  ```console
67
134
  bin/rake appraisal:update
68
135
  ```
69
136
 
70
- When adding an appraisal to CI, check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
137
+ If you need to reset all gemfiles/*.gemfile.lock files:
138
+
139
+ ```console
140
+ bin/rake appraisal:reset
141
+ ```
71
142
 
72
- ## The Reek List
143
+ When adding an appraisal to CI, check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
73
144
 
74
- Take a look at the `reek` list which is the file called `REEK` and find something to improve.
145
+ ## Run Tests
75
146
 
76
- To refresh the `reek` list:
147
+ Run tests via `kettle-test` (provided by `kettle-test`). It runs RSpec, writes the full log to
148
+ `tmp/kettle-test/rspec-TIMESTAMP.log`, and prints a compact highlight block with timing, seed,
149
+ pass/fail count, failing example list, and SimpleCov coverage percentages.
77
150
 
78
151
  ```console
79
- bundle exec reek > REEK
152
+ bundle exec kettle-test
80
153
  ```
81
154
 
82
- ## Run Tests
83
-
84
- To run all tests
155
+ For targeted runs, disable the hard coverage threshold to avoid false failures:
85
156
 
86
157
  ```console
87
- bundle exec rake test
158
+ K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
88
159
  ```
89
160
 
90
161
  ### Spec organization (required)
91
162
 
92
- - One spec file per class/module. For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name exactly: `lib/version_gem/release_cli.rb` -> `spec/version_gem/release_cli_spec.rb`.
93
- - Never add a second spec file for the same class/module. Examples of disallowed names: `*_more_spec.rb`, `*_extra_spec.rb`, `*_status_spec.rb`, or any other suffix that still targets the same class. If you find yourself wanting a second file, merge those examples into the canonical spec file for that class/module.
163
+ - One spec file per class/module. For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name exactly: `lib/version_gem/my_class.rb` -> `spec/version_gem/my_class_spec.rb`.
94
164
  - Exception: Integration specs that intentionally span multiple classes. Place these under `spec/integration/` (or a clearly named integration folder), and do not directly mirror a single class. Name them after the scenario, not a class.
95
- - Migration note: If a duplicate spec file exists, move all examples into the canonical file and delete the duplicate. Do not leave stubs or empty files behind.
96
165
 
97
166
  ## Lint It
98
167
 
@@ -115,7 +184,7 @@ For more detailed information about using RuboCop in this project, please see th
115
184
  Never add `# rubocop:disable ...` / `# rubocop:enable ...` comments to code or specs (except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). Instead:
116
185
 
117
186
  - Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
118
- - When a violation is temporary and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
187
+ - When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
119
188
  - `bundle exec rake rubocop_gradual:autocorrect` (preferred)
120
189
  - `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
121
190
 
@@ -138,7 +207,7 @@ Also see GitLab Contributors: [https://gitlab.com/ruby-oauth/version_gem/-/graph
138
207
  **IMPORTANT**: To sign a build,
139
208
  a public key for signing gems will need to be picked up by the line in the
140
209
  `gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
141
- All releases to RubyGems.org are signed releases.
210
+ All releases are signed releases.
142
211
  See: [RubyGems Security Guide][🔒️rubygems-security-guide]
143
212
 
144
213
  NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
@@ -147,47 +216,49 @@ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in th
147
216
 
148
217
  #### Automated process
149
218
 
150
- 1. Update version.rb to contian the correct version-to-be-released.
219
+ 1. Update version.rb to contain the correct version-to-be-released.
151
220
  2. Run `bundle exec kettle-changelog`.
152
221
  3. Run `bundle exec kettle-release`.
222
+ 4. Stay awake and monitor the release process for any errors, and answer any prompts.
153
223
 
154
224
  #### Manual process
155
225
 
156
226
  1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
157
227
  2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
158
228
  3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
159
- 4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
160
- 5. Run `git push` to trigger the final CI pipeline before release, and merge PRs
229
+ 4. Run `bin/rake yard` to regenerate the docs site using the canonical docs task
230
+ 5. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
231
+ 6. Run `git push` to trigger the final CI pipeline before release, and merge PRs
161
232
  - NOTE: Remember to [check the build][🧪build].
162
- 6. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
163
- 7. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
164
- 8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
165
- 9. Optional for older Bundler (< 2.7.0): Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use the same timestamp and generate the same checksums
233
+ 7. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
234
+ 8. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
235
+ 9. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
236
+ 10. Optional for older Bundler (< 2.7.0): Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use the same timestamp and generate the same checksums
166
237
  - If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
167
238
  - Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
168
239
  - If the echo above has no output, then it didn't work.
169
240
  - Note: `zsh/datetime` module is needed, if running `zsh`.
170
241
  - In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
171
- 10. Run `bundle exec rake build`
172
- 11. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
242
+ 11. Run `bundle exec rake build`
243
+ 12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
173
244
  to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
174
245
  [gem][💎stone_checksums].
175
246
  - The script automatically commits but does not push the checksums
176
- 12. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
247
+ 13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
177
248
  - `sha256sum pkg/<gem name>-<version>.gem`
178
- 13. Run `bundle exec rake release` which will create a git tag for the version,
179
- push git commits and tags, and push the `.gem` file to [rubygems.org][💎rubygems]
249
+ 14. Run `bundle exec rake release` which will create a git tag for the version,
250
+ push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
180
251
 
181
- [📜src-gl]: https://gitlab.com/ruby-oauth/version_gem/
252
+ [📜src-gl]: https://gitlab.com/ruby-oauth/version_gem
182
253
  [📜src-cb]: https://codeberg.org/ruby-oauth/version_gem
183
254
  [📜src-gh]: https://github.com/ruby-oauth/version_gem
184
255
  [🧪build]: https://github.com/ruby-oauth/version_gem/actions
185
- [🤝conduct]: https://gitlab.com/ruby-oauth/version_gem/-/blob/main/CODE_OF_CONDUCT.md
256
+ [🤝conduct]: https://github.com/ruby-oauth/version_gem/blob/main/CODE_OF_CONDUCT.md
186
257
  [🖐contrib-rocks]: https://contrib.rocks
187
258
  [🖐contributors]: https://github.com/ruby-oauth/version_gem/graphs/contributors
188
259
  [🚎contributors-gl]: https://gitlab.com/ruby-oauth/version_gem/-/graphs/main
189
260
  [🖐contributors-img]: https://contrib.rocks/image?repo=ruby-oauth/version_gem
190
- [💎rubygems]: https://rubygems.org
261
+ [💎gem-coop]: https://gem.coop
191
262
  [🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
192
263
  [🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
193
264
  [🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
@@ -198,3 +269,4 @@ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in th
198
269
  [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
199
270
  [🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
200
271
  [🏃‍♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
272
+ [✉️discord-invite]: https://discord.gg/3qme4XHNKN
data/FUNDING.md CHANGED
@@ -6,7 +6,7 @@ Many paths lead to being a sponsor or a backer of this project. Are you on such
6
6
 
7
7
  [![OpenCollective Backers][🖇osc-backers-i]][🖇osc-backers] [![OpenCollective Sponsors][🖇osc-sponsors-i]][🖇osc-sponsors] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal]
8
8
 
9
- [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
9
+ [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS efforts using Patreon][🖇patreon-img]][🖇patreon]
10
10
 
11
11
  [⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
12
12
  [⛳liberapay]: https://liberapay.com/pboling/donate
@@ -18,11 +18,11 @@ Many paths lead to being a sponsor or a backer of this project. Are you on such
18
18
  [🖇sponsor]: https://github.com/sponsors/pboling
19
19
  [🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
20
20
  [🖇polar]: https://polar.sh/pboling
21
- [🖇kofi-img]: https://img.shields.io/badge/ko--fi-✓-a51611.svg?style=flat
22
- [🖇kofi]: https://ko-fi.com/O5O86SNP4
21
+ [🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
22
+ [🖇kofi]: https://ko-fi.com/pboling
23
23
  [🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
24
24
  [🖇patreon]: https://patreon.com/galtzo
25
- [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-✓-a51611.svg?style=flat
25
+ [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
26
26
  [🖇buyme]: https://www.buymeacoffee.com/pboling
27
27
  [🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
28
28
  [🖇paypal]: https://www.paypal.com/paypalme/peterboling
@@ -31,11 +31,11 @@ Many paths lead to being a sponsor or a backer of this project. Are you on such
31
31
 
32
32
  <!-- RELEASE-NOTES-FOOTER-END -->
33
33
 
34
- # 🤑 Request for Help
34
+ # 🤑 A request for help
35
35
 
36
36
  Maintainers have teeth and need to pay their dentists.
37
- After getting laid off in an RIF in March and filled with many dozens of rejections,
38
- I'm now spending ~60+ hours a week building open source tools.
37
+ After getting laid off in an RIF in March, and encountering difficulty finding a new one,
38
+ I began spending most of my time building open source tools.
39
39
  I'm hoping to be able to pay for my kids' health insurance this month,
40
40
  so if you value the work I am doing, I need your support.
41
41
  Please consider sponsoring me or the project.
@@ -44,16 +44,13 @@ To join the community or get help 👇️ Join the Discord.
44
44
 
45
45
  [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
46
46
 
47
- To say "thanks for maintaining such a great tool" ☝️ Join the Discord or 👇️ send money.
47
+ To say "thanks!" ☝️ Join the Discord or 👇️ send money.
48
48
 
49
- [![Sponsor ruby-oauth/version_gem on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay-img] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal-img]
49
+ [![Sponsor ruby-oauth/version_gem on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal]
50
50
 
51
51
  # Another Way to Support Open Source Software
52
52
 
53
- > How wonderful it is that nobody need wait a single moment before starting to improve the world.<br/>
54
- >—Anne Frank
55
-
56
- I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions — totaling 79 hours of FLOSS coding over just the past seven days, a pretty regular week for me. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).
53
+ I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).
57
54
 
58
55
  If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in `bundle fund`.
59
56
 
data/LICENSE.md ADDED
@@ -0,0 +1,11 @@
1
+ # License
2
+
3
+ This project is made available under the following license.
4
+ Choose the option that best fits your use case:
5
+
6
+ - [MIT](MIT.md)
7
+
8
+ ## Copyright Notice
9
+
10
+ - Copyright (c) 2022-2023, 2025-2026 Peter H. Boling
11
+ - Copyright (c) 2024-2025 Aboling0