version_gem 1.1.8 → 1.1.9

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.
Files changed (27) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/CHANGELOG.md +72 -41
  4. data/CITATION.cff +20 -0
  5. data/CODE_OF_CONDUCT.md +3 -4
  6. data/CONTRIBUTING.md +116 -53
  7. data/FUNDING.md +77 -0
  8. data/README.md +359 -197
  9. data/REEK +0 -0
  10. data/RUBOCOP.md +71 -0
  11. data/lib/version_gem/version.rb +1 -1
  12. data/sig/all_formatters.rbs +1 -0
  13. data/sig/debug.rbs +1 -0
  14. data/sig/debug_ide.rbs +1 -0
  15. data/sig/debug_jruby.rbs +1 -0
  16. data/sig/debugging.rbs +1 -0
  17. data/sig/run_coverage.rbs +1 -0
  18. data/sig/version_gem/api.rbs +27 -0
  19. data/sig/version_gem/basic.rbs +5 -0
  20. data/sig/version_gem/epoch.rbs +26 -0
  21. data/sig/version_gem/error.rbs +4 -0
  22. data/sig/version_gem/ruby.rbs +11 -0
  23. data/sig/version_gem/version.rbs +9 -0
  24. data/sig/version_gem.rbs +2 -0
  25. data.tar.gz.sig +0 -0
  26. metadata +160 -21
  27. metadata.gz.sig +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f457e0e7c9cc404965d171bec3c4a3703a90450291032992f4ea50e8a27933b7
4
- data.tar.gz: c68b6defc2beeb3bc81a131cead2b865d3ad62ec39419a3eb9cb90a41fcf3672
3
+ metadata.gz: cd4a5c38f28eb3f9c215684dfeb3d7b8eed4e26a76e5a5fbab98937aa17a147c
4
+ data.tar.gz: 494810d3d25c269eb3867fa9c600df69354c45438c35bae8087912e3165e086c
5
5
  SHA512:
6
- metadata.gz: 2d03578bb83c1bfb270d81cb041ce2e9fb1689ce1dfbefaab4f69c28661e4f2c34ecf752d941f501d978167c232dcf7012b12a3d99e96e74d0bf949c51d1eaed
7
- data.tar.gz: a24a29785103417074f6bf6e8ec8a8281c71fe67a3ab079386b44a31a82bdac2218625084e8ee8db6a95af8ceefd635ef51daefac30ddd8f8ddc166c438163c6
6
+ metadata.gz: e85bc0c821117c19ed6c08427b4dee64792b49453bad2885d03e195236ba863c2048eba779fab77c15efefcbba8eccff20eaca9f1465adba96736b3081e4cef8
7
+ data.tar.gz: d1e488c79e04c025dd1cb6fe33d6908513b3e15275d8f4e682a7f61ce258ec7d8b6d47e9f948f9bb1c10ad86cf63f0855ec9aa2c3605112b77470da3c91d6bca
checksums.yaml.gz.sig CHANGED
Binary file
data/CHANGELOG.md CHANGED
@@ -19,12 +19,30 @@ Please file a bug if you notice a violation of semantic versioning.
19
19
  ## [Unreleased]
20
20
  ### Added
21
21
  ### Changed
22
- ### Fixed
22
+ ### Deprecated
23
23
  ### Removed
24
+ ### Fixed
25
+ ### Security
24
26
 
25
- ## [1.1.8] 2025-05-06 ([tag][1.1.8t])
26
- - Line Coverage: 100.0% (117 / 117)
27
- - Branch Coverage: 100.0% (4 / 4)
27
+ ## [1.1.9] - 2025-09-02
28
+ - TAG: [v1.1.9][1.1.9t]
29
+ - COVERAGE: 100.00% -- 118/118 lines in 8 files
30
+ - BRANCH COVERAGE: 100.00% -- 4/4 branches in 8 files
31
+ - 84.62% documented
32
+ ### Added
33
+ - re-templated gem using kettle-dev v1.1.2
34
+ - new binstubs for changelog, readme, commit message, & release management
35
+ - new CI workflows
36
+ - enhanced project documentation
37
+ - More RBS types
38
+ - docs site: https://version-gem.galtzo.com
39
+ ### Fixed
40
+ - RBS types are more accurate
41
+
42
+ ## [1.1.8] 2025-05-06
43
+ - TAG: [1.1.8][1.1.8t]
44
+ - COVERAGE: 100.00% -- 118/118 lines in 8 files
45
+ - BRANCH COVERAGE: 100.00% -- 4/4 branches in 8 files
28
46
  - 84.62% documented
29
47
  ### Added
30
48
  - CITATION.cff (@pboling)
@@ -34,7 +52,8 @@ Please file a bug if you notice a violation of semantic versioning.
34
52
  - Addressed entire REEK list (@pboling)
35
53
  - GitLab CI, as an addition to existing GHA (@pboling)
36
54
 
37
- ## [1.1.7] 2025-04-15 ([tag][1.1.7t])
55
+ ## [1.1.7] 2025-04-15
56
+ - TAG: [1.1.7][1.1.7t]
38
57
  - Line Coverage: 100.0% (117 / 117)
39
58
  - Branch Coverage: 100.0% (4 / 4)
40
59
  - 76.92% documented
@@ -47,7 +66,8 @@ Please file a bug if you notice a violation of semantic versioning.
47
66
  - Ruby 2.2 removed from CI, though technically still supported
48
67
  - can't run directly in GHA anymore
49
68
 
50
- ## [1.1.6] 2025-02-24 ([tag][1.1.6t])
69
+ ## [1.1.6] 2025-02-24
70
+ - TAG: [1.1.6][1.1.6t]
51
71
  - Line Coverage: 100.0% (77 / 77)
52
72
  - Branch Coverage: 100.0% (2 / 2)
53
73
  - 77.78% documented
@@ -62,7 +82,8 @@ Please file a bug if you notice a violation of semantic versioning.
62
82
  ### Changed
63
83
  - Code of Conduct updated - Contributor Covenant v2.0 => v2.1 (@pboling)
64
84
 
65
- ## [1.1.5] 2025-02-22 ([tag][1.1.5t])
85
+ ## [1.1.5] 2025-02-22
86
+ - TAG: [1.1.5][1.1.5t]
66
87
  - Line Coverage: 100.0% (77 / 77)
67
88
  - Branch Coverage: 100.0% (2 / 2)
68
89
  - 77.78% documented
@@ -71,19 +92,21 @@ Please file a bug if you notice a violation of semantic versioning.
71
92
  - More documentation, and yard task for documentation (@pboling)
72
93
  - Documentation of Ruby version and SemVer support (@pboling)
73
94
  ### Fixed
74
- - [#3](https://gitlab.com/oauth-xx/version_gem/-/issues/3) - Allow packaging without signing (@pboling)
95
+ - [#3](https://gitlab.com/ruby-oauth/version_gem/-/issues/3) - Allow packaging without signing (@pboling)
75
96
  - to support secure linux distros which have alternate means of signing packages within their package managers
76
97
  - Code coverage tracking (@pboling)
77
98
  - Documentation of usage in gemspec via `Kernel.load` (@pboling)
78
99
  - Improved gemspec config (@pboling)
79
100
 
80
- ## [1.1.4] 2024-03-21 ([tag][1.1.4t])
101
+ ## [1.1.4] 2024-03-21
102
+ - TAG: [1.1.4][1.1.4t]
81
103
  ### Added
82
104
  - Ruby 3.3 to CI (@pboling)
83
105
  ### Fixed
84
106
  - Remove the executable bit from non-executable files (@Fryguy)
85
107
 
86
- ## [1.1.3] 2023-06-05 ([tag][1.1.3t])
108
+ ## [1.1.3] 2023-06-05
109
+ - TAG: [1.1.3][1.1.3t]
87
110
  ### Added
88
111
  - More test coverage (now 100% 🎉) (@pboling)
89
112
  - Improved documentation (now 77% 🎉) (@pboling)
@@ -103,14 +126,16 @@ Please file a bug if you notice a violation of semantic versioning.
103
126
  - Formally drop Ruby 2.2 support
104
127
  - Ruby 2.2 was already de facto minimum version supported, which is why this wasn't a 2.0 release.
105
128
 
106
- ## [1.1.2] - 2023-03-17 ([tag][1.1.2t])
129
+ ## [1.1.2] - 2023-03-17
130
+ - TAG: [1.1.2][1.1.2t]
107
131
  ### Added
108
132
  - `VersionGem::Ruby` to help library CI integration against many different versions of Ruby (@pboling)
109
133
  - Experimental, optional, require (not loaded by default, which is why this can be in a patch)
110
134
  - Spec coverage is now 100%, lines and branches, including the fabled `version.rb` (@pboling)
111
135
  - Full RBS Signatures (@pboling)
112
136
 
113
- ## [1.1.1] - 2022-09-19 ([tag][1.1.1t])
137
+ ## [1.1.1] - 2022-09-19
138
+ - TAG: [1.1.1][1.1.1t]
114
139
  ### Added
115
140
  - Alternatives section to README.md (@pboling)
116
141
  - Signing cert for gem releases (@pboling)
@@ -121,49 +146,55 @@ Please file a bug if you notice a violation of semantic versioning.
121
146
  - Version methods are now memoized (||=) on initial call for performance (@pboling)
122
147
  - Gem releases are now cryptographically signed (@pboling)
123
148
 
124
- ## [1.1.0] - 2022-06-24 ([tag][1.1.0t])
149
+ ## [1.1.0] - 2022-06-24
150
+ - TAG: [1.1.0][1.1.0t]
125
151
  ### Added
126
152
  - RSpec Matchers and Shared Example (@pboling)
127
153
  ### Fixed
128
154
  - `to_a` uses same type casting as major, minor, patch, and pre (@pboling)
129
155
 
130
- ## [1.0.2] - 2022-06-23 ([tag][1.0.2t])
156
+ ## [1.0.2] - 2022-06-23
157
+ - TAG: [1.0.2][1.0.2t]
131
158
  ### Added
132
159
  - Delay loading of library code until after code coverage tool is loaded (@pboling)
133
160
 
134
- ## [1.0.1] - 2022-06-23 ([tag][1.0.1t])
161
+ ## [1.0.1] - 2022-06-23
162
+ - TAG: [1.0.1][1.0.1t]
135
163
  ### Added
136
164
  - CI Build improvements (@pboling)
137
165
  - Code coverage reporting (@pboling)
138
166
  - Documentation improvements (@pboling)
139
167
  - Badges! (@pboling)
140
168
 
141
- ## [1.0.0] - 2022-06-21 ([tag][1.0.0t])
169
+ ## [1.0.0] - 2022-06-21
170
+ - TAG: [1.0.0][1.0.0t]
142
171
  ### Added
143
172
  - Initial release, with basic version parsing API (@pboling)
144
173
 
145
- [Unreleased]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.8...main
146
- [1.1.8]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.7...v1.1.8
147
- [1.1.8t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.8
148
- [1.1.7]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.6...v1.1.7
149
- [1.1.7t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.7
150
- [1.1.6]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.5...v1.1.6
151
- [1.1.6t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.6
152
- [1.1.5]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.4...v1.1.5
153
- [1.1.5t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.5
154
- [1.1.4]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.3...v1.1.4
155
- [1.1.4t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.4
156
- [1.1.3]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.2...v1.1.3
157
- [1.1.3t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.3
158
- [1.1.2]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.1...v1.1.2
159
- [1.1.2t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.2
160
- [1.1.1]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.0...v1.1.1
161
- [1.1.1t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.1
162
- [1.1.0]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.0.2...v1.1.0
163
- [1.1.0t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.0
164
- [1.0.2]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.0.1...v1.0.2
165
- [1.0.2t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.0.2
166
- [1.0.1]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.0.0...v1.0.1
167
- [1.0.1t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.0.1
168
- [1.0.0]: https://gitlab.com/oauth-xx/version_gem/-/compare/a3055964517c159bf214712940982034b75264be...v1.0.0
169
- [1.0.0t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.0.0
174
+ [Unreleased]: https://github.com/ruby-oauth/version_gem/compare/v1.1.9...HEAD
175
+ [1.1.9]: https://github.com/ruby-oauth/version_gem/compare/v1.1.8...v1.1.9
176
+ [1.1.9t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.9
177
+ [1.1.8]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.7...v1.1.8
178
+ [1.1.8t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.8
179
+ [1.1.7]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.6...v1.1.7
180
+ [1.1.7t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.7
181
+ [1.1.6]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.5...v1.1.6
182
+ [1.1.6t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.6
183
+ [1.1.5]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.4...v1.1.5
184
+ [1.1.5t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.5
185
+ [1.1.4]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.3...v1.1.4
186
+ [1.1.4t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.4
187
+ [1.1.3]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.2...v1.1.3
188
+ [1.1.3t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.3
189
+ [1.1.2]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.1...v1.1.2
190
+ [1.1.2t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.2
191
+ [1.1.1]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.0...v1.1.1
192
+ [1.1.1t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.1
193
+ [1.1.0]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.0.2...v1.1.0
194
+ [1.1.0t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.0
195
+ [1.0.2]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.0.1...v1.0.2
196
+ [1.0.2t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.0.2
197
+ [1.0.1]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.0.0...v1.0.1
198
+ [1.0.1t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.0.1
199
+ [1.0.0]: https://github.com/ruby-oauth/version_gem/compare/a3055964517c159bf214712940982034b75264be...v1.0.0
200
+ [1.0.0t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.0.0
data/CITATION.cff ADDED
@@ -0,0 +1,20 @@
1
+ cff-version: 1.2.0
2
+ title: version_gem
3
+ message: >-
4
+ If you use this work and you want to cite it,
5
+ then you can use the metadata from this file.
6
+ type: software
7
+ authors:
8
+ - given-names: Peter Hurn
9
+ family-names: Boling
10
+ email: peter@railsbling.com
11
+ affiliation: railsbling.com
12
+ orcid: 'https://orcid.org/0009-0008-8519-441X'
13
+ identifiers:
14
+ - type: url
15
+ value: 'https://github.com/ruby-oauth/version_gem'
16
+ description: version_gem
17
+ repository-code: 'https://github.com/ruby-oauth/version_gem'
18
+ abstract: >-
19
+ version_gem
20
+ license: See license file
data/CODE_OF_CONDUCT.md CHANGED
@@ -1,4 +1,3 @@
1
-
2
1
  # Contributor Covenant Code of Conduct
3
2
 
4
3
  ## Our Pledge
@@ -61,7 +60,7 @@ representative at an online or offline event.
61
60
 
62
61
  Instances of abusive, harassing, or otherwise unacceptable behavior may be
63
62
  reported to the community leaders responsible for enforcement at
64
- [![Contact BDFL][🚂bdfl-contact-img]][🚂bdfl-contact].
63
+ [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
65
64
  All complaints will be reviewed and investigated promptly and fairly.
66
65
 
67
66
  All community leaders are obligated to respect the privacy and security of the
@@ -131,5 +130,5 @@ For answers to common questions about this code of conduct, see the FAQ at
131
130
  [Mozilla CoC]: https://github.com/mozilla/diversity
132
131
  [FAQ]: https://www.contributor-covenant.org/faq
133
132
  [translations]: https://www.contributor-covenant.org/translations
134
- [🚂bdfl-contact]: http://www.railsbling.com/contact
135
- [🚂bdfl-contact-img]: https://img.shields.io/badge/Contact-BDFL-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
133
+ [🚂maint-contact]: http://www.railsbling.com/contact
134
+ [🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
data/CONTRIBUTING.md CHANGED
@@ -1,42 +1,73 @@
1
1
  # Contributing
2
2
 
3
- Bug reports and pull requests are welcome on GitHub at [https://gitlab.com/oauth-xx/version_gem][🚎src-main]
4
- . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
3
+ Bug reports and pull requests are welcome on [CodeBerg][📜src-cb], [GitLab][📜src-gl], or [GitHub][📜src-gh].
4
+ This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
5
5
  the [code of conduct][🤝conduct].
6
6
 
7
- To submit a patch, please fork the project and create a patch with
8
- tests. Once you're happy with it send a pull request and post a message to the
9
- [google group][⛳mail-list] or on the [gitter chat][🏘chat].
7
+ To submit a patch, please fork the project, create a patch with tests, and send a pull request.
10
8
 
11
- We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
9
+ Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
12
10
 
13
- ## You can help!
11
+ ## Help out!
14
12
 
15
- Simply follow these instructions:
13
+ Take a look at the `reek` list which is the file called `REEK` and find something to improve.
14
+
15
+ Follow these instructions:
16
16
 
17
17
  1. Fork the repository
18
- 2. Create your feature branch (`git checkout -b my-new-feature`)
18
+ 2. Create a feature branch (`git checkout -b my-new-feature`)
19
19
  3. Make some fixes.
20
- 4. Commit your changes (`git commit -am 'Added some feature'`)
20
+ 4. Commit changes (`git commit -am 'Added some feature'`)
21
21
  5. Push to the branch (`git push origin my-new-feature`)
22
22
  6. Make sure to add tests for it. This is important, so it doesn't break in a future release.
23
23
  7. Create new Pull Request.
24
24
 
25
- ## Appraisals
25
+ ## Environment Variables for Local Development
26
26
 
27
- From time to time the appraisal gemfiles in `gemfiles/` will need to be updated.
28
- They are created and updated with the commands:
27
+ Below are the primary environment variables recognized by stone_checksums (and its integrated tools). Unless otherwise noted, set boolean values to the string "true" to enable.
28
+
29
+ General/runtime
30
+ - DEBUG: Enable extra internal logging for this library (default: false)
31
+ - REQUIRE_BENCH: Enable `require_bench` to profile requires (default: false)
32
+ - CI: When set to true, adjusts default rake tasks toward CI behavior
33
+
34
+ Coverage (kettle-soup-cover / SimpleCov)
35
+ - K_SOUP_COV_DO: Enable coverage collection (default: true in .envrc)
36
+ - K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
37
+ - K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
38
+ - K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
39
+ - K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
40
+ - K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
41
+ - K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
42
+ - MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
43
+ Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
29
44
 
30
- NOTE: We run on a [fork][🚎appraisal-fork] of Appraisal.
45
+ GitHub API and CI helpers
46
+ - GITHUB_TOKEN or GH_TOKEN: Token used by `ci:act` and release workflow checks to query GitHub Actions status at higher rate limits
47
+
48
+ Releasing and signing
49
+ - SKIP_GEM_SIGNING: If set, skip gem signing during build/release
50
+ - 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.
52
+
53
+ Git hooks and commit message helpers (exe/kettle-commit-msg)
54
+ - GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
55
+ - GIT_HOOK_FOOTER_APPEND: Append a footer to commit messages when goalie allows (true/false)
56
+ - GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
57
+ - GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
58
+
59
+ For a quick starting point, this repository’s `.envrc` shows sane defaults, and `.env.local` can override them locally.
60
+
61
+ ## Appraisals
31
62
 
32
- Please upvote the PR for `eval_gemfile` [support][🚎appraisal-eval-gemfile-pr]
63
+ From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
64
+ They are created and updated with the commands:
33
65
 
34
- ```shell
35
- BUNDLE_GEMFILE=Appraisal.root.gemfile bundle
36
- BUNDLE_GEMFILE=Appraisal.root.gemfile bundle exec appraisal update
66
+ ```console
67
+ bin/rake appraisal:update
37
68
  ```
38
69
 
39
- When adding an appraisal to CI check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
70
+ When adding an appraisal to CI, check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
40
71
 
41
72
  ## The Reek List
42
73
 
@@ -44,7 +75,7 @@ Take a look at the `reek` list which is the file called `REEK` and find somethin
44
75
 
45
76
  To refresh the `reek` list:
46
77
 
47
- ```bash
78
+ ```console
48
79
  bundle exec reek > REEK
49
80
  ```
50
81
 
@@ -52,24 +83,44 @@ bundle exec reek > REEK
52
83
 
53
84
  To run all tests
54
85
 
55
- ```bash
86
+ ```console
56
87
  bundle exec rake test
57
88
  ```
58
89
 
90
+ ### Spec organization (required)
91
+
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.
94
+ - 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
+
59
97
  ## Lint It
60
98
 
61
99
  Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
62
100
 
63
- ```bash
101
+ ```console
64
102
  bundle exec rake
65
103
  ```
66
104
 
67
105
  Or just run the linter.
68
106
 
69
- ```bash
107
+ ```console
70
108
  bundle exec rake rubocop_gradual:autocorrect
71
109
  ```
72
110
 
111
+ For more detailed information about using RuboCop in this project, please see the [RUBOCOP.md](RUBOCOP.md) guide. This project uses `rubocop_gradual` instead of vanilla RuboCop, which requires specific commands for checking violations.
112
+
113
+ ### Important: Do not add inline RuboCop disables
114
+
115
+ 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
+
117
+ - 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:
119
+ - `bundle exec rake rubocop_gradual:autocorrect` (preferred)
120
+ - `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
121
+
122
+ As a general rule, fix style issues rather than ignoring them. For example, our specs should follow RSpec conventions like using `described_class` for the class under test.
123
+
73
124
  ## Contributors
74
125
 
75
126
  Your picture could be here!
@@ -78,60 +129,72 @@ Your picture could be here!
78
129
 
79
130
  Made with [contributors-img][🖐contrib-rocks].
80
131
 
81
- Also see GitLab Contributors: [https://gitlab.com/oauth-xx/version_gem/-/graphs/main][🚎contributors-gl]
132
+ Also see GitLab Contributors: [https://gitlab.com/ruby-oauth/version_gem/-/graphs/main][🚎contributors-gl]
82
133
 
83
134
  ## For Maintainers
84
135
 
85
136
  ### One-time, Per-maintainer, Setup
86
137
 
87
- **IMPORTANT**: If you want to sign the build you create,
88
- your public key for signing gems will need to be picked up by the line in the
138
+ **IMPORTANT**: To sign a build,
139
+ a public key for signing gems will need to be picked up by the line in the
89
140
  `gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
90
- All releases to RubyGems.org will be signed.
141
+ All releases to RubyGems.org are signed releases.
91
142
  See: [RubyGems Security Guide][🔒️rubygems-security-guide]
92
143
 
93
- NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some value in your environment.
144
+ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
94
145
 
95
146
  ### To release a new version:
96
147
 
97
- 1. Run `bin/setup && bin/rake` as a tests, coverage, & linting sanity check
148
+ #### Automated process
149
+
150
+ 1. Update version.rb to contian the correct version-to-be-released.
151
+ 2. Run `bundle exec kettle-changelog`.
152
+ 3. Run `bundle exec kettle-release`.
153
+
154
+ #### Manual process
155
+
156
+ 1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
98
157
  2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
99
158
  3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
100
159
  4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
101
- 5. Run `git push` to trigger the final CI pipeline before release, & merge PRs
102
- - NOTE: Remember to [check the build][🧪build]!
160
+ 5. Run `git push` to trigger the final CI pipeline before release, and merge PRs
161
+ - NOTE: Remember to [check the build][🧪build].
103
162
  6. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
104
163
  7. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
105
- 8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure you will release the latest trunk code
106
- 9. Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use same timestamp, and generate same checksums
107
- - Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
108
- - If the echo above has no output, then it didn't work.
109
- - Note that you'll need the `zsh/datetime` module, if running `zsh`.
110
- - In `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
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
166
+ - If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
167
+ - Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
168
+ - If the echo above has no output, then it didn't work.
169
+ - Note: `zsh/datetime` module is needed, if running `zsh`.
170
+ - In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
111
171
  10. Run `bundle exec rake build`
112
- 11. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr] and [2][🔒️rubygems-guides-pr])
113
- to create SHA-256 and SHA-512 checksums
114
- - Checksums will be committed automatically by the script, but not pushed
115
- 12. Run `bundle exec rake release` which will create a git tag for the version,
116
- push git commits and tags, and push the `.gem` file to [rubygems.org][💎rubygems]
117
-
118
- [⛳mail-list]: http://groups.google.com/group/oauth-ruby
119
- [🚎src-main]: https://gitlab.com/oauth-xx/version_gem
120
- [🧪build]: https://github.com/oauth-xx/version_gem/actions
121
- [🏘chat]: https://matrix.to/#/#pboling_version_gem:gitter.im
122
- [🤝conduct]: https://gitlab.com/oauth-xx/version_gem/-/blob/main/CODE_OF_CONDUCT.md
172
+ 11. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
173
+ to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
174
+ [gem][💎stone_checksums].
175
+ - 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:
177
+ - `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]
180
+
181
+ [📜src-gl]: https://gitlab.com/ruby-oauth/version_gem/
182
+ [📜src-cb]: https://codeberg.org/ruby-oauth/version_gem
183
+ [📜src-gh]: https://github.com/ruby-oauth/version_gem
184
+ [🧪build]: https://github.com/ruby-oauth/version_gem/actions
185
+ [🤝conduct]: https://gitlab.com/ruby-oauth/version_gem/-/blob/main/CODE_OF_CONDUCT.md
123
186
  [🖐contrib-rocks]: https://contrib.rocks
124
- [🖐contributors]: https://github.com/oauth-xx/version_gem/graphs/contributors
125
- [🚎contributors-gl]: https://gitlab.com/oauth-xx/version_gem/-/graphs/main
126
- [🖐contributors-img]: https://contrib.rocks/image?repo=oauth-xx/version_gem
187
+ [🖐contributors]: https://github.com/ruby-oauth/version_gem/graphs/contributors
188
+ [🚎contributors-gl]: https://gitlab.com/ruby-oauth/version_gem/-/graphs/main
189
+ [🖐contributors-img]: https://contrib.rocks/image?repo=ruby-oauth/version_gem
127
190
  [💎rubygems]: https://rubygems.org
128
191
  [🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
129
192
  [🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
130
193
  [🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
194
+ [💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
131
195
  [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
132
196
  [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
133
197
  [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
134
198
  [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
135
- [🚎appraisal-eval-gemfile-pr]: https://github.com/thoughtbot/appraisal/pull/248
136
- [🚎appraisal-fork]: https://github.com/pboling/appraisal/tree/galtzo
199
+ [🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
137
200
  [🏃‍♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
data/FUNDING.md ADDED
@@ -0,0 +1,77 @@
1
+ <!-- RELEASE-NOTES-FOOTER-START -->
2
+
3
+ Official Discord 👉️ [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
4
+
5
+ Many paths lead to being a sponsor or a backer of this project. Are you on such a path?
6
+
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
+
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]
10
+
11
+ [⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
12
+ [⛳liberapay]: https://liberapay.com/pboling/donate
13
+ [🖇osc-backers]: https://opencollective.com/ruby-oauth#backer
14
+ [🖇osc-backers-i]: https://opencollective.com/ruby-oauth/backers/badge.svg?style=flat
15
+ [🖇osc-sponsors]: https://opencollective.com/ruby-oauth#sponsor
16
+ [🖇osc-sponsors-i]: https://opencollective.com/ruby-oauth/sponsors/badge.svg?style=flat
17
+ [🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
18
+ [🖇sponsor]: https://github.com/sponsors/pboling
19
+ [🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
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
23
+ [🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
24
+ [🖇patreon]: https://patreon.com/galtzo
25
+ [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-✓-a51611.svg?style=flat
26
+ [🖇buyme]: https://www.buymeacoffee.com/pboling
27
+ [🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
28
+ [🖇paypal]: https://www.paypal.com/paypalme/peterboling
29
+ [✉️discord-invite]: https://discord.gg/3qme4XHNKN
30
+ [✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=flat
31
+
32
+ <!-- RELEASE-NOTES-FOOTER-END -->
33
+
34
+ # 🤑 Request for Help
35
+
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.
39
+ I'm hoping to be able to pay for my kids' health insurance this month,
40
+ so if you value the work I am doing, I need your support.
41
+ Please consider sponsoring me or the project.
42
+
43
+ To join the community or get help 👇️ Join the Discord.
44
+
45
+ [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
46
+
47
+ To say "thanks for maintaining such a great tool" ☝️ Join the Discord or 👇️ send money.
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]
50
+
51
+ # Another Way to Support Open Source Software
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).
57
+
58
+ 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
+
60
+ I’m developing a new library, [floss_funding][🖇floss-funding-gem], designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
61
+
62
+ **[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
63
+
64
+ [⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
65
+ [🖇osc-all-img]: https://img.shields.io/opencollective/all/ruby-oauth
66
+ [🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/ruby-oauth
67
+ [🖇osc-backers-img]: https://img.shields.io/opencollective/backers/ruby-oauth
68
+ [🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/ruby-oauth?style=for-the-badge
69
+ [🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/ruby-oauth?style=for-the-badge
70
+ [🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/ruby-oauth?style=for-the-badge
71
+ [🖇osc]: https://opencollective.com/ruby-oauth
72
+ [🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
73
+ [🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
74
+ [🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
75
+ [🖇floss-funding.dev]: https://floss-funding.dev
76
+ [🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
77
+ [✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge