appraisal2 3.0.5 → 3.0.7
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 +4 -4
- checksums.yaml.gz.sig +0 -0
- data/CHANGELOG.md +129 -4
- data/CITATION.cff +20 -0
- data/CODE_OF_CONDUCT.md +3 -4
- data/CONTRIBUTING.md +192 -56
- data/FUNDING.md +74 -0
- data/LICENSE.md +49 -0
- data/README.md +276 -780
- data/RUBOCOP.md +71 -0
- data/SECURITY.md +2 -2
- data/certs/pboling.pem +27 -0
- data/lib/appraisal/appraisal.rb +1 -1
- data/lib/appraisal/bundler_dsl.rb +12 -12
- data/lib/appraisal/command.rb +124 -9
- data/lib/appraisal/customize.rb +1 -1
- data/lib/appraisal/gem_manager/factory.rb +1 -1
- data/lib/appraisal/gemspec.rb +1 -1
- data/lib/appraisal/version.rb +1 -1
- data/lib/appraisal2/version.rb +8 -0
- data/lib/appraisal2.rb +7 -0
- data/sig/appraisal2/version.rbs +6 -0
- data.tar.gz.sig +0 -0
- metadata +111 -78
- metadata.gz.sig +0 -0
- data/LICENSE.txt +0 -22
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2fd7b2532897ffc8ec3482977b8ac3e7f5dadc6330f03ad5c18fa5350b70d300
|
|
4
|
+
data.tar.gz: b956dae24c70033a97c9473e260ce4b12853d6f349170ce92365a10ad1681650
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3d86e28bfe079c7e27e04f4ca77ee341dc6d34702e45a12ea1683faa634c148c0687543d8b8e39c3d11d1120347e8c044167518b4d1232d2a89465b311bec4db
|
|
7
|
+
data.tar.gz: 0fa994040fd7b1df01da2f0294e191002229fa44e3eb5b6d3b0e0f5ab6e181622735a2da4a9f958a8ec79d27e95196cf828d69c1d130c1012d3dd3c17ee5af9c
|
checksums.yaml.gz.sig
CHANGED
|
Binary file
|
data/CHANGELOG.md
CHANGED
|
@@ -1,9 +1,20 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[![SemVer 2.0.0][📌semver-img]][📌semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog]
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
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
|
|
|
@@ -17,8 +28,118 @@ Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
17
28
|
|
|
18
29
|
### Fixed
|
|
19
30
|
|
|
31
|
+
- Fixed acceptance test Bundler pinning so CI uses `BUNDLER_VERSION` instead of
|
|
32
|
+
RubyGems `_version_` selector arguments that staged `bin/bundle` binstubs do
|
|
33
|
+
not support.
|
|
34
|
+
|
|
20
35
|
### Security
|
|
21
36
|
|
|
37
|
+
## [3.0.7] - 2026-06-05
|
|
38
|
+
|
|
39
|
+
- TAG: [v3.0.7][3.0.7t]
|
|
40
|
+
- COVERAGE: 89.69% -- 748/834 lines in 28 files
|
|
41
|
+
- BRANCH COVERAGE: 80.61% -- 133/165 branches in 28 files
|
|
42
|
+
- 42.69% documented
|
|
43
|
+
|
|
44
|
+
### Added
|
|
45
|
+
|
|
46
|
+
- Added `Appraisal2::Version` / `Appraisal2::VERSION` constants backed by
|
|
47
|
+
`version_gem`, including an RBS signature for the version namespace.
|
|
48
|
+
- Added appraisal and CI coverage for runtime dependency HEADs, templating
|
|
49
|
+
self-tests, license scanning, Open Collective backer updates, and
|
|
50
|
+
per-engine/per-version Ruby workflows.
|
|
51
|
+
- Added generated local-development support files, including `mise.toml`,
|
|
52
|
+
`.env.local.example`, StructuredMerge git driver configuration, and refreshed
|
|
53
|
+
contributor/operator guides.
|
|
54
|
+
|
|
55
|
+
### Changed
|
|
56
|
+
|
|
57
|
+
- Refreshed project automation and CI templates with the current `kettle-jem`
|
|
58
|
+
template output.
|
|
59
|
+
- CI now runs appraisals through `Appraisal.root.gemfile`, installs each
|
|
60
|
+
appraisal with retry handling, and uses `kettle-test` as the default test
|
|
61
|
+
runner.
|
|
62
|
+
- Runtime dependency matrix handling now includes extracted stdlib gem
|
|
63
|
+
appraisals for `erb`, `mutex_m`, and `stringio`, with version-specific
|
|
64
|
+
stdlib gemfiles selected by the active Ruby version.
|
|
65
|
+
- Development tooling floors were refreshed, including `kettle-dev` 2.x,
|
|
66
|
+
`kettle-test` 2.x, `kettle-soup-cover` 2.x, `gitmoji-regex` 2.x, current
|
|
67
|
+
documentation gems, and `turbo_tests2` as the default test runner.
|
|
68
|
+
- Gem metadata now uses the generated `licenses` field, GitHub source,
|
|
69
|
+
changelog, bug tracker, wiki, and funding URLs, and a generated version-gem
|
|
70
|
+
loader in the gemspec.
|
|
71
|
+
- Documentation was refreshed for contributor setup, local environment
|
|
72
|
+
variables, appraisal maintenance, test execution, RuboCop Gradual, Reek, and
|
|
73
|
+
generated project automation.
|
|
74
|
+
|
|
75
|
+
### Removed
|
|
76
|
+
|
|
77
|
+
- Removed the Ruby 2.3 CI appraisal/workflow and replaced dashed Ruby workflow
|
|
78
|
+
filenames with dotted Ruby-version workflow names.
|
|
79
|
+
- Removed the legacy CodeQL and Discord notifier workflows from the generated
|
|
80
|
+
workflow set.
|
|
81
|
+
|
|
82
|
+
- Removed the stale duplicate Runtime Deps @ HEAD workflow that bypassed the
|
|
83
|
+
generated `dep-heads` appraisal workflow.
|
|
84
|
+
|
|
85
|
+
### Fixed
|
|
86
|
+
|
|
87
|
+
- Fixed local `kettle-test` acceptance spec isolation so parallel workers use
|
|
88
|
+
process-specific Bundler, gem build, and stage directories instead of
|
|
89
|
+
deleting each other's temporary workspaces.
|
|
90
|
+
|
|
91
|
+
- Rendered generated `LICENSE.md` copyright notice lines as a Markdown list.
|
|
92
|
+
|
|
93
|
+
- Fixed appraisal install commands so lockfiles with `BUNDLED WITH` install and
|
|
94
|
+
select that Bundler version instead of rewriting the lockfile with the parent
|
|
95
|
+
process Bundler.
|
|
96
|
+
- Fixed local acceptance test isolation so `kettle-test` workers do not mix
|
|
97
|
+
Bundler versions or share user-level installer cache state.
|
|
98
|
+
- Fixed JRuby 9.2 CI bootstrapping by installing RubyGems 3.3.27 and Bundler
|
|
99
|
+
2.3.27 instead of using the default JRuby toolchain versions.
|
|
100
|
+
- Fixed CI failures by preserving Bundler-generated `bin/bundle` test binstubs
|
|
101
|
+
instead of replacing them with custom bundle wrappers.
|
|
102
|
+
- Fixed Ruby 3.0 and 3.1 appraisal stdlib gemfiles so they do not load
|
|
103
|
+
conflicting `erb` version constraints.
|
|
104
|
+
- Fixed TruffleRuby 23.1 CI bootstrapping by routing that workflow through the
|
|
105
|
+
Ruby 3.2 appraisal Gemfile, which applies the `json` ceiling only on
|
|
106
|
+
TruffleRuby 23.1, and by running the test command directly once that Gemfile
|
|
107
|
+
is active.
|
|
108
|
+
|
|
109
|
+
## [3.0.6] - 2026-02-17
|
|
110
|
+
|
|
111
|
+
- TAG: [v3.0.6][3.0.6t]
|
|
112
|
+
- COVERAGE: 88.34% -- 727/823 lines in 27 files
|
|
113
|
+
- BRANCH COVERAGE: 76.05% -- 127/167 branches in 27 files
|
|
114
|
+
- 43.11% documented
|
|
115
|
+
|
|
116
|
+
### Added
|
|
117
|
+
|
|
118
|
+
- Test for bundler handling with pre-existing appraisal lockfiles
|
|
119
|
+
- Added acceptance test that verifies appraisal correctly handles `gemfiles/*.gemfile.lock` files with `BUNDLED WITH` specified
|
|
120
|
+
- Test validates that:
|
|
121
|
+
- Appraisal gemfiles with pre-created lockfiles install correctly
|
|
122
|
+
- Lockfiles preserve the `BUNDLED WITH` section reporting which bundler version was used
|
|
123
|
+
- The bundler version in the lockfile is correctly maintained during installation
|
|
124
|
+
- Note: Multi-version bundler switching in CI would require pre-installing multiple bundler versions; coverage is limited to lockfile preservation and environment handling.
|
|
125
|
+
|
|
126
|
+
### Fixed
|
|
127
|
+
|
|
128
|
+
- Restore bundler's automatic version switching for modern bundler versions (2.2+)
|
|
129
|
+
- Bundler can detect and switch to the version specified in `Gemfile.lock` (or appraisal lockfiles) via `BUNDLED WITH`
|
|
130
|
+
- Previously, `with_original_env` stripped all bundler-related variables, preventing bundler from detecting version mismatches and breaking test isolation
|
|
131
|
+
- Now uses `with_bundler_env` with selective cleanup:
|
|
132
|
+
- Starts from `Bundler.original_env` when available
|
|
133
|
+
- Preserves critical bundler and isolation variables (for example: `BUNDLE_GEMFILE`, `BUNDLE_APP_CONFIG`, `BUNDLE_PATH`, `BUNDLE_USER_CACHE`)
|
|
134
|
+
- Removes `BUNDLER_SETUP` and `BUNDLER_VERSION` activation markers
|
|
135
|
+
- Removes `bundler/setup` from `RUBYOPT` to prevent auto-activation in subprocesses
|
|
136
|
+
- Prevents `BUNDLE_LOCKFILE` lockfile pollution of subprocesses so per-gemfile lockfiles are created correctly
|
|
137
|
+
- This approach:
|
|
138
|
+
- Lets subprocess bundler start fresh and process the target gemfile cleanly
|
|
139
|
+
- Preserves test isolation and prevents global config pollution
|
|
140
|
+
- Enables committing appraisal lockfiles with specific bundler versions for stable, repeatable builds
|
|
141
|
+
- This fix maintains backward compatibility with all bundler versions
|
|
142
|
+
|
|
22
143
|
## [3.0.5] - 2026-02-14
|
|
23
144
|
|
|
24
145
|
- TAG: [v3.0.5][3.0.5t]
|
|
@@ -171,7 +292,11 @@ Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
171
292
|
- code coverage tracked with Coveralls, QLTY.sh, and the kettle-soup-cover gem
|
|
172
293
|
- other minor fixes and improvements
|
|
173
294
|
|
|
174
|
-
[Unreleased]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.
|
|
295
|
+
[Unreleased]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.7...HEAD
|
|
296
|
+
[3.0.7]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.6...v3.0.7
|
|
297
|
+
[3.0.7t]: https://github.com/appraisal-rb/appraisal2/releases/tag/v3.0.7
|
|
298
|
+
[3.0.6]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.5...v3.0.6
|
|
299
|
+
[3.0.6t]: https://github.com/appraisal-rb/appraisal2/releases/tag/v3.0.6
|
|
175
300
|
[3.0.5]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.4...v3.0.5
|
|
176
301
|
[3.0.5t]: https://github.com/appraisal-rb/appraisal2/releases/tag/v3.0.5
|
|
177
302
|
[3.0.4]: https://github.com/appraisal-rb/appraisal2/compare/v3.0.3...v3.0.4
|
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/pboling/appraisal2'
|
|
16
|
+
description: "appraisal2"
|
|
17
|
+
repository-code: 'https://github.com/pboling/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
|
|
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
|
-
[🚂
|
|
135
|
-
[🚂
|
|
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
|
|
4
|
-
|
|
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
|
|
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
|
-
##
|
|
11
|
+
## Developer Certificate of Origin
|
|
13
12
|
|
|
14
|
-
|
|
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,43 +27,141 @@ 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.
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
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:
|
|
30
37
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
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
|
|
35
46
|
|
|
36
|
-
|
|
47
|
+
There are many Rake tasks available as well. You can see them by running:
|
|
37
48
|
|
|
38
|
-
|
|
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
|
+
```
|
|
39
60
|
|
|
40
|
-
|
|
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.
|
|
41
110
|
|
|
42
111
|
```console
|
|
43
|
-
bundle exec
|
|
112
|
+
K_JEM_TEMPLATING=true bundle exec kettle-jem install
|
|
44
113
|
```
|
|
45
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 -- ...`.
|
|
122
|
+
|
|
123
|
+
## Appraisals
|
|
124
|
+
|
|
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
|
+
|
|
131
|
+
They are created and updated with the commands:
|
|
132
|
+
|
|
133
|
+
```console
|
|
134
|
+
bin/rake appraisal:update
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
If you need to reset all gemfiles/*.gemfile.lock files:
|
|
138
|
+
|
|
139
|
+
```console
|
|
140
|
+
bin/rake appraisal:reset
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
When adding an appraisal to CI, check the [runner tool cache][🏃♂️runner-tool-cache] to see which runner to use.
|
|
144
|
+
|
|
46
145
|
## Run Tests
|
|
47
146
|
|
|
48
|
-
|
|
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.
|
|
49
150
|
|
|
50
151
|
```console
|
|
51
|
-
bundle exec
|
|
152
|
+
bundle exec kettle-test
|
|
52
153
|
```
|
|
53
154
|
|
|
54
|
-
|
|
155
|
+
For targeted runs, disable the hard coverage threshold to avoid false failures:
|
|
55
156
|
|
|
56
157
|
```console
|
|
57
|
-
|
|
158
|
+
K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
|
|
58
159
|
```
|
|
59
|
-
|
|
160
|
+
|
|
161
|
+
### Spec organization (required)
|
|
162
|
+
|
|
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.
|
|
60
165
|
|
|
61
166
|
## Lint It
|
|
62
167
|
|
|
@@ -72,6 +177,19 @@ Or just run the linter.
|
|
|
72
177
|
bundle exec rake rubocop_gradual:autocorrect
|
|
73
178
|
```
|
|
74
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
|
+
|
|
75
193
|
## Contributors
|
|
76
194
|
|
|
77
195
|
Your picture could be here!
|
|
@@ -80,57 +198,75 @@ Your picture could be here!
|
|
|
80
198
|
|
|
81
199
|
Made with [contributors-img][🖐contrib-rocks].
|
|
82
200
|
|
|
83
|
-
Also see GitLab Contributors: [https://gitlab.com/
|
|
201
|
+
Also see GitLab Contributors: [https://gitlab.com/pboling/appraisal2/-/graphs/main][🚎contributors-gl]
|
|
84
202
|
|
|
85
203
|
## For Maintainers
|
|
86
204
|
|
|
87
205
|
### One-time, Per-maintainer, Setup
|
|
88
206
|
|
|
89
|
-
**IMPORTANT**:
|
|
90
|
-
|
|
207
|
+
**IMPORTANT**: To sign a build,
|
|
208
|
+
a public key for signing gems will need to be picked up by the line in the
|
|
91
209
|
`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
|
|
92
|
-
All releases
|
|
210
|
+
All releases are signed releases.
|
|
93
211
|
See: [RubyGems Security Guide][🔒️rubygems-security-guide]
|
|
94
212
|
|
|
95
|
-
NOTE: To build without signing the gem
|
|
213
|
+
NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
|
|
96
214
|
|
|
97
215
|
### To release a new version:
|
|
98
216
|
|
|
99
|
-
|
|
217
|
+
#### Automated process
|
|
218
|
+
|
|
219
|
+
1. Update version.rb to contain the correct version-to-be-released.
|
|
220
|
+
2. Run `bundle exec kettle-changelog`.
|
|
221
|
+
3. Run `bundle exec kettle-release`.
|
|
222
|
+
4. Stay awake and monitor the release process for any errors, and answer any prompts.
|
|
223
|
+
|
|
224
|
+
#### Manual process
|
|
225
|
+
|
|
226
|
+
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
|
|
100
227
|
2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
|
|
101
228
|
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
|
|
102
|
-
4. Run `
|
|
103
|
-
5. Run `git
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
7. Run `git
|
|
107
|
-
8. Run `git
|
|
108
|
-
9.
|
|
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
|
|
232
|
+
- NOTE: Remember to [check the build][🧪build].
|
|
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
|
|
237
|
+
- If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
|
|
109
238
|
- Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
|
|
110
239
|
- If the echo above has no output, then it didn't work.
|
|
111
|
-
- Note
|
|
240
|
+
- Note: `zsh/datetime` module is needed, if running `zsh`.
|
|
112
241
|
- In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
|
|
113
|
-
|
|
114
|
-
|
|
242
|
+
11. Run `bundle exec rake build`
|
|
243
|
+
12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
|
|
115
244
|
to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
|
|
116
245
|
[gem][💎stone_checksums].
|
|
117
|
-
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
[
|
|
246
|
+
- The script automatically commits but does not push the checksums
|
|
247
|
+
13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
|
|
248
|
+
- `sha256sum pkg/<gem name>-<version>.gem`
|
|
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.
|
|
251
|
+
|
|
252
|
+
[📜src-gl]: https://gitlab.com/pboling/appraisal2
|
|
253
|
+
[📜src-cb]: https://codeberg.org/pboling/appraisal2
|
|
254
|
+
[📜src-gh]: https://github.com/pboling/appraisal2
|
|
255
|
+
[🧪build]: https://github.com/pboling/appraisal2/actions
|
|
256
|
+
[🤝conduct]: https://github.com/pboling/appraisal2/blob/main/CODE_OF_CONDUCT.md
|
|
124
257
|
[🖐contrib-rocks]: https://contrib.rocks
|
|
125
|
-
[🖐contributors]: https://github.com/
|
|
126
|
-
[🚎contributors-gl]: https://gitlab.com/
|
|
127
|
-
[🖐contributors-img]: https://contrib.rocks/image?repo=
|
|
128
|
-
[💎
|
|
258
|
+
[🖐contributors]: https://github.com/pboling/appraisal2/graphs/contributors
|
|
259
|
+
[🚎contributors-gl]: https://gitlab.com/pboling/appraisal2/-/graphs/main
|
|
260
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=pboling/appraisal2
|
|
261
|
+
[💎gem-coop]: https://gem.coop
|
|
129
262
|
[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
|
|
130
263
|
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
|
|
131
264
|
[🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
|
|
132
|
-
[💎stone_checksums]: https://github.com/
|
|
265
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
133
266
|
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
134
267
|
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
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
|
|
270
|
+
[🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
271
|
+
[🏃♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
|
|
135
272
|
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
|
136
|
-
[✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge
|
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 pboling/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
|