appraisal2 3.0.6 → 3.0.8

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: d133d78a6198d0a3b26dd959c3c1f70e7106ca48c188639db816b594cbe821ed
4
- data.tar.gz: 03e9f36d0704cd7f3c8bb6b9a79d318f5793a587e3e719084066f9cf91f395a4
3
+ metadata.gz: 6277235656ba9d2485e73609389937d3bf513737e2eea1e960db4e389087294f
4
+ data.tar.gz: adf3c60ec4209291d9e317423ce902a9c5381ea2bd145a3b46281ab78d4534b1
5
5
  SHA512:
6
- metadata.gz: e9d4d82c677bd83ba21c8590f6a92c5fd475bb9374243744fceb353f3acd985f99fd8ec28b9309b5ffca09f25db5ddef76850fb5f8163f105353b41d7b1abf3a
7
- data.tar.gz: d65eb45d17fd233ac1de8b36d34b186b9f6f8bf82fcc106f16c045df1c943a65fb017f739c9da2a3a01027934a3e9f0d6afb5044531caecffcd86788708b25a8
6
+ metadata.gz: 71792880c8c2dd5e7add14dbdbb6b0bac29c58ff74b2f4b468a4856d1840d676a94b41c790f04fb72cc35a2e37d1c0789cbaaa86941ef6b4e671a3350b81a88a
7
+ data.tar.gz: fa649ea387e3fe3b367311f71918899466009f92732c231ebb0c717cf6fc5351b99c80827b877385c84430fbb79cd92515fb0be4c3d25861a92ad2368e11a1b5
checksums.yaml.gz.sig CHANGED
Binary file
data/CHANGELOG.md CHANGED
@@ -1,9 +1,20 @@
1
1
  # Changelog
2
2
 
3
- This file documents all notable changes to this project.
3
+ [![SemVer 2.0.0][📌semver-img]][📌semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog]
4
4
 
5
- Format: [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
- Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
5
+ All notable changes to this project will be documented in this file.
6
+
7
+ The format is based on [Keep a Changelog][📗keep-changelog],
8
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
9
+ and [yes][📌major-versions-not-sacred], platform and engine support are part of the [public API][📌semver-breaking].
10
+ Please file a bug if you notice a violation of semantic versioning.
11
+
12
+ [📌semver]: https://semver.org/spec/v2.0.0.html
13
+ [📌semver-img]: https://img.shields.io/badge/semver-2.0.0-FFDD67.svg?style=flat
14
+ [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
15
+ [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
16
+ [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
17
+ [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
7
18
 
8
19
  ## [Unreleased]
9
20
 
@@ -19,6 +30,93 @@ Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
19
30
 
20
31
  ### Security
21
32
 
33
+ ## [3.0.8] - 2026-06-05
34
+
35
+ - TAG: [v3.0.8][3.0.8t]
36
+ - COVERAGE: 89.69% -- 748/834 lines in 28 files
37
+ - BRANCH COVERAGE: 80.61% -- 133/165 branches in 28 files
38
+ - 42.69% documented
39
+
40
+ ### Fixed
41
+
42
+ - Fixed generated project metadata and README links to use the `appraisal-rb`
43
+ organization derived from the gemspec homepage instead of `pboling`.
44
+ - Fixed acceptance test Bundler pinning so CI uses `BUNDLER_VERSION` instead of
45
+ RubyGems `_version_` selector arguments that staged `bin/bundle` binstubs do
46
+ not support.
47
+
48
+ ## [3.0.7] - 2026-06-05
49
+
50
+ - TAG: [v3.0.7][3.0.7t]
51
+ - COVERAGE: 89.69% -- 748/834 lines in 28 files
52
+ - BRANCH COVERAGE: 80.61% -- 133/165 branches in 28 files
53
+ - 42.69% documented
54
+
55
+ ### Added
56
+
57
+ - Added `Appraisal2::Version` / `Appraisal2::VERSION` constants backed by
58
+ `version_gem`, including an RBS signature for the version namespace.
59
+ - Added appraisal and CI coverage for runtime dependency HEADs, templating
60
+ self-tests, license scanning, Open Collective backer updates, and
61
+ per-engine/per-version Ruby workflows.
62
+ - Added generated local-development support files, including `mise.toml`,
63
+ `.env.local.example`, StructuredMerge git driver configuration, and refreshed
64
+ contributor/operator guides.
65
+
66
+ ### Changed
67
+
68
+ - Refreshed project automation and CI templates with the current `kettle-jem`
69
+ template output.
70
+ - CI now runs appraisals through `Appraisal.root.gemfile`, installs each
71
+ appraisal with retry handling, and uses `kettle-test` as the default test
72
+ runner.
73
+ - Runtime dependency matrix handling now includes extracted stdlib gem
74
+ appraisals for `erb`, `mutex_m`, and `stringio`, with version-specific
75
+ stdlib gemfiles selected by the active Ruby version.
76
+ - Development tooling floors were refreshed, including `kettle-dev` 2.x,
77
+ `kettle-test` 2.x, `kettle-soup-cover` 2.x, `gitmoji-regex` 2.x, current
78
+ documentation gems, and `turbo_tests2` as the default test runner.
79
+ - Gem metadata now uses the generated `licenses` field, GitHub source,
80
+ changelog, bug tracker, wiki, and funding URLs, and a generated version-gem
81
+ loader in the gemspec.
82
+ - Documentation was refreshed for contributor setup, local environment
83
+ variables, appraisal maintenance, test execution, RuboCop Gradual, Reek, and
84
+ generated project automation.
85
+
86
+ ### Removed
87
+
88
+ - Removed the Ruby 2.3 CI appraisal/workflow and replaced dashed Ruby workflow
89
+ filenames with dotted Ruby-version workflow names.
90
+ - Removed the legacy CodeQL and Discord notifier workflows from the generated
91
+ workflow set.
92
+
93
+ - Removed the stale duplicate Runtime Deps @ HEAD workflow that bypassed the
94
+ generated `dep-heads` appraisal workflow.
95
+
96
+ ### Fixed
97
+
98
+ - Fixed local `kettle-test` acceptance spec isolation so parallel workers use
99
+ process-specific Bundler, gem build, and stage directories instead of
100
+ deleting each other's temporary workspaces.
101
+
102
+ - Rendered generated `LICENSE.md` copyright notice lines as a Markdown list.
103
+
104
+ - Fixed appraisal install commands so lockfiles with `BUNDLED WITH` install and
105
+ select that Bundler version instead of rewriting the lockfile with the parent
106
+ process Bundler.
107
+ - Fixed local acceptance test isolation so `kettle-test` workers do not mix
108
+ Bundler versions or share user-level installer cache state.
109
+ - Fixed JRuby 9.2 CI bootstrapping by installing RubyGems 3.3.27 and Bundler
110
+ 2.3.27 instead of using the default JRuby toolchain versions.
111
+ - Fixed CI failures by preserving Bundler-generated `bin/bundle` test binstubs
112
+ instead of replacing them with custom bundle wrappers.
113
+ - Fixed Ruby 3.0 and 3.1 appraisal stdlib gemfiles so they do not load
114
+ conflicting `erb` version constraints.
115
+ - Fixed TruffleRuby 23.1 CI bootstrapping by routing that workflow through the
116
+ Ruby 3.2 appraisal Gemfile, which applies the `json` ceiling only on
117
+ TruffleRuby 23.1, and by running the test command directly once that Gemfile
118
+ is active.
119
+
22
120
  ## [3.0.6] - 2026-02-17
23
121
 
24
122
  - TAG: [v3.0.6][3.0.6t]
@@ -205,7 +303,11 @@ Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
205
303
  - code coverage tracked with Coveralls, QLTY.sh, and the kettle-soup-cover gem
206
304
  - other minor fixes and improvements
207
305
 
208
- [Unreleased]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.6...HEAD
306
+ [Unreleased]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.8...HEAD
307
+ [3.0.8]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.7...v3.0.8
308
+ [3.0.8t]: https://github.com/appraisal-rb/appraisal2/releases/tag/v3.0.8
309
+ [3.0.7]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.6...v3.0.7
310
+ [3.0.7t]: https://github.com/appraisal-rb/appraisal2/releases/tag/v3.0.7
209
311
  [3.0.6]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.5...v3.0.6
210
312
  [3.0.6t]: https://github.com/appraisal-rb/appraisal2/releases/tag/v3.0.6
211
313
  [3.0.5]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.4...v3.0.5
data/CITATION.cff ADDED
@@ -0,0 +1,20 @@
1
+ cff-version: 1.2.0
2
+ title: "appraisal2"
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 H."
9
+ family-names: "Boling"
10
+ email: "floss@galtzo.com"
11
+ affiliation: "galtzo.com"
12
+ orcid: 'https://orcid.org/0009-0008-8519-441X'
13
+ identifiers:
14
+ - type: url
15
+ value: 'https://github.com/appraisal-rb/appraisal2'
16
+ description: "appraisal2"
17
+ repository-code: 'https://github.com/appraisal-rb/appraisal2'
18
+ abstract: >-
19
+ appraisal2
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,17 +1,24 @@
1
1
  # Contributing
2
2
 
3
- Bug reports and pull requests are welcome on GitLab at [https://gitlab.com/appraisal-rb/appraisal2][🚎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 tests.
8
- Once you're happy with it send a pull request.
7
+ To submit a patch, please fork the project, create a patch with tests, and send a pull request.
9
8
 
10
9
  Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
11
10
 
12
- ## You can help!
11
+ ## Developer Certificate of Origin
13
12
 
14
- Simply follow these instructions:
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
+
17
+ ## Help out!
18
+
19
+ Take a look at the open issues and pull requests, or use the gem and find something to improve.
20
+
21
+ Follow these instructions:
15
22
 
16
23
  1. Join the Discord: [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
17
24
  2. Fork the repository
@@ -20,22 +27,107 @@ Simply follow these instructions:
20
27
  5. Commit your changes (`git commit -am 'Added some feature'`)
21
28
  6. Push to the branch (`git push origin my-new-feature`)
22
29
  7. Make sure to add tests for it. This is important, so it doesn't break in a future release.
23
- 8. Run the at least one workflow of tests via `act`, e.g.,:
24
- ```console
25
- act -W '.github/workflows/ruby-3-3.yml'
26
- ```
27
- NOTE: Because there are so many workflows, running `act` naked might grind your machine to a halt.
28
- 9. Create new Pull Request.
29
- 10. Announce it in the channel for this org in the [Discord][✉️discord-invite]!
30
-
31
- NOTE: Run tests with `act` to have confidence they will pass in CI.
32
- Also, because the spec run makes many changes to local bundle config,
33
- many specs will fail locally in subsequent runs unless run via `act`.
34
- The spec suite is not idempotent. This is a goal for the future, if you'd like to work on it.
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
+ ```
68
+
69
+ ## Environment Variables for Local Development
70
+
71
+ 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.
72
+
73
+ General/runtime
74
+ - DEBUG: Enable extra internal logging for this library (default: false)
75
+ - REQUIRE_BENCH: Enable `require_bench` to profile requires (default: false)
76
+ - CI: When set to true, adjusts default rake tasks toward CI behavior
77
+
78
+ Coverage (kettle-soup-cover / SimpleCov)
79
+ - K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
80
+ - K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
81
+ - K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
82
+ - K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
83
+ - K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
84
+ - K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
85
+ - K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
86
+ - MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
87
+ 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.
88
+
89
+ GitHub API and CI helpers
90
+ - GITHUB_TOKEN or GH_TOKEN: Token used by `ci:act` and release workflow checks to query GitHub Actions status at higher rate limits
91
+
92
+ Releasing and signing
93
+ - SKIP_GEM_SIGNING: If set, skip gem signing during build/release
94
+ - GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
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.
98
+
99
+ Git hooks and commit message helpers (exe/kettle-commit-msg)
100
+ - GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
101
+ - GIT_HOOK_FOOTER_APPEND: Append a footer to commit messages when goalie allows (true/false)
102
+ - GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
103
+ - GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
104
+
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 -- ...`.
35
122
 
36
123
  ## Appraisals
37
124
 
38
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
+
39
131
  They are created and updated with the commands:
40
132
 
41
133
  ```console
@@ -50,30 +142,26 @@ bin/rake appraisal:reset
50
142
 
51
143
  When adding an appraisal to CI, check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
52
144
 
53
- ## The Reek List
54
-
55
- Take a look at the `reek` list which is the file called `REEK` and find something to improve.
145
+ ## Run Tests
56
146
 
57
- 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.
58
150
 
59
151
  ```console
60
- bundle exec reek > REEK
152
+ bundle exec kettle-test
61
153
  ```
62
154
 
63
- ## Run Tests
64
-
65
- To run all tests against the current Ruby release:
155
+ For targeted runs, disable the hard coverage threshold to avoid false failures:
66
156
 
67
157
  ```console
68
- bundle exec rake act
158
+ K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
69
159
  ```
70
160
 
71
- Or the equivalent:
161
+ ### Spec organization (required)
72
162
 
73
- ```console
74
- act -W '.github/workflows/current.yml'
75
- ```
76
- NOTE: Because there are so many workflows, running `act` naked might grind your machine to a halt.
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/appraisal2/my_class.rb` -> `spec/appraisal2/my_class_spec.rb`.
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.
77
165
 
78
166
  ## Lint It
79
167
 
@@ -89,6 +177,19 @@ Or just run the linter.
89
177
  bundle exec rake rubocop_gradual:autocorrect
90
178
  ```
91
179
 
180
+ 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.
181
+
182
+ ### Important: Do not add inline RuboCop disables
183
+
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:
185
+
186
+ - Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
187
+ - When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
188
+ - `bundle exec rake rubocop_gradual:autocorrect` (preferred)
189
+ - `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
190
+
191
+ 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.
192
+
92
193
  ## Contributors
93
194
 
94
195
  Your picture could be here!
@@ -109,7 +210,7 @@ a public key for signing gems will need to be picked up by the line in the
109
210
  All releases are signed releases.
110
211
  See: [RubyGems Security Guide][🔒️rubygems-security-guide]
111
212
 
112
- NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some value in your environment.
213
+ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
113
214
 
114
215
  ### To release a new version:
115
216
 
@@ -125,31 +226,34 @@ NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some v
125
226
  1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
126
227
  2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
127
228
  3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
128
- 4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
129
- 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
130
232
  - NOTE: Remember to [check the build][🧪build].
131
- 6. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
132
- 7. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
133
- 8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
134
- 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
135
237
  - If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
136
238
  - Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
137
239
  - If the echo above has no output, then it didn't work.
138
240
  - Note: `zsh/datetime` module is needed, if running `zsh`.
139
241
  - In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
140
- 10. Run `bundle exec rake build`
141
- 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])
142
244
  to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
143
245
  [gem][💎stone_checksums].
144
246
  - The script automatically commits but does not push the checksums
145
- 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:
146
248
  - `sha256sum pkg/<gem name>-<version>.gem`
147
- 13. Run `bundle exec rake release` which will create a git tag for the version,
249
+ 14. Run `bundle exec rake release` which will create a git tag for the version,
148
250
  push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
149
251
 
150
- [🚎src-main]: https://gitlab.com/appraisal-rb/appraisal2
252
+ [📜src-gl]: https://gitlab.com/appraisal-rb/appraisal2
253
+ [📜src-cb]: https://codeberg.org/appraisal-rb/appraisal2
254
+ [📜src-gh]: https://github.com/appraisal-rb/appraisal2
151
255
  [🧪build]: https://github.com/appraisal-rb/appraisal2/actions
152
- [🤝conduct]: https://gitlab.com/appraisal-rb/appraisal2/-/blob/main/CODE_OF_CONDUCT.md
256
+ [🤝conduct]: https://github.com/appraisal-rb/appraisal2/blob/main/CODE_OF_CONDUCT.md
153
257
  [🖐contrib-rocks]: https://contrib.rocks
154
258
  [🖐contributors]: https://github.com/appraisal-rb/appraisal2/graphs/contributors
155
259
  [🚎contributors-gl]: https://gitlab.com/appraisal-rb/appraisal2/-/graphs/main
@@ -158,10 +262,11 @@ NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some v
158
262
  [🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
159
263
  [🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
160
264
  [🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
161
- [💎stone_checksums]: https://github.com/pboling/stone_checksums
265
+ [💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
162
266
  [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
163
267
  [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
164
- [✉️discord-invite]: https://discord.gg/3qme4XHNKN
165
- [✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge
268
+ [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
269
+ [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
166
270
  [🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
167
271
  [🏃‍♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
272
+ [✉️discord-invite]: https://discord.gg/3qme4XHNKN
data/FUNDING.md ADDED
@@ -0,0 +1,74 @@
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 efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS 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/#backer
14
+ [🖇osc-backers-i]: https://opencollective.com//backers/badge.svg?style=flat
15
+ [🖇osc-sponsors]: https://opencollective.com/#sponsor
16
+ [🖇osc-sponsors-i]: https://opencollective.com//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-%E2%9C%93-a51611.svg?style=flat
22
+ [🖇kofi]: https://ko-fi.com/pboling
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-%E2%9C%93-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
+ # 🤑 A 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 encountering difficulty finding a new one,
38
+ I began spending most of my time 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!" ☝️ Join the Discord or 👇️ send money.
48
+
49
+ [![Sponsor appraisal-rb/appraisal2 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
+
51
+ # Another Way to Support Open Source Software
52
+
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).
54
+
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`.
56
+
57
+ 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.
58
+
59
+ **[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
60
+
61
+ [⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
62
+ [🖇osc-all-img]: https://img.shields.io/opencollective/all/
63
+ [🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/
64
+ [🖇osc-backers-img]: https://img.shields.io/opencollective/backers/
65
+ [🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/?style=for-the-badge
66
+ [🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/?style=for-the-badge
67
+ [🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/?style=for-the-badge
68
+ [🖇osc]: https://opencollective.com/
69
+ [🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
70
+ [🖇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
71
+ [🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
72
+ [🖇floss-funding.dev]: https://floss-funding.dev
73
+ [🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
74
+ [✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge
data/LICENSE.md ADDED
@@ -0,0 +1,49 @@
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) 2010 Joe Ferris
11
+ - Copyright (c) 2011 Dan Croak
12
+ - Copyright (c) 2011-2012 Gabe Berke-Williams
13
+ - Copyright (c) 2011 Joe Ferris
14
+ - Copyright (c) 2011 Joseph Anthony Pasquale Holsten
15
+ - Copyright (c) 2011 Nick Quaranto
16
+ - Copyright (c) 2011 Prem Sichanugrist
17
+ - Copyright (c) 2012 Gregory Ostermayr
18
+ - Copyright (c) 2012 osheroff
19
+ - Copyright (c) 2013 Jason Waldrip
20
+ - Copyright (c) 2013 Marc Ignacio
21
+ - Copyright (c) 2013 Phill Baker
22
+ - Copyright (c) 2013-2016 Prem Sichanugrist
23
+ - Copyright (c) 2013 sanemat
24
+ - Copyright (c) 2014 Juan González
25
+ - Copyright (c) 2014-2015 Prem Sichanugrist
26
+ - Copyright (c) 2015 akihiro17
27
+ - Copyright (c) 2015 Elliot Winkler
28
+ - Copyright (c) 2015 M.Shibuya
29
+ - Copyright (c) 2015 Vlad Bokov
30
+ - Copyright (c) 2016 Geoff Massanek
31
+ - Copyright (c) 2016 Ian Fosbery
32
+ - Copyright (c) 2016 Teo Ljungberg
33
+ - Copyright (c) 2017 Brad Gessler
34
+ - Copyright (c) 2017 Oli Peate
35
+ - Copyright (c) 2017, 2025-2026 Peter H. Boling
36
+ - Copyright (c) 2018 Antonis Berkakis
37
+ - Copyright (c) 2018 Jared Beck
38
+ - Copyright (c) 2018, 2020, 2023-2024 Nick Charlton
39
+ - Copyright (c) 2020 Brian Hawley
40
+ - Copyright (c) 2020 David Rodríguez
41
+ - Copyright (c) 2020 James Ebentier
42
+ - Copyright (c) 2021, 2024 Nicolas Rodriguez
43
+ - Copyright (c) 2022 André Arko
44
+ - Copyright (c) 2022 Joe Sharp
45
+ - Copyright (c) 2023 aymeric-ledorze
46
+ - Copyright (c) 2023 Kyle Fazzari
47
+ - Copyright (c) 2024 Joe Sharp
48
+ - Copyright (c) 2024 Sebastian Cohnen
49
+ - Copyright (c) 2024 Yevhenii Ponomarenko