kettle-drift 1.0.0
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 +7 -0
- checksums.yaml.gz.sig +2 -0
- data/CHANGELOG.md +49 -0
- data/CITATION.cff +20 -0
- data/CODE_OF_CONDUCT.md +134 -0
- data/CONTRIBUTING.md +251 -0
- data/FUNDING.md +74 -0
- data/LICENSE.md +12 -0
- data/README.md +477 -0
- data/RUBOCOP.md +71 -0
- data/SECURITY.md +21 -0
- data/certs/pboling.pem +27 -0
- data/exe/kettle-drift +6 -0
- data/lib/kettle/drift/cli.rb +72 -0
- data/lib/kettle/drift/diff.rb +29 -0
- data/lib/kettle/drift/duplicate_line_validator.rb +238 -0
- data/lib/kettle/drift/lock_file.rb +32 -0
- data/lib/kettle/drift/outcome.rb +49 -0
- data/lib/kettle/drift/plugin.rb +80 -0
- data/lib/kettle/drift/process/calculate_diff.rb +68 -0
- data/lib/kettle/drift/process/printer.rb +63 -0
- data/lib/kettle/drift/process.rb +64 -0
- data/lib/kettle/drift/rakelib/drift.rake +65 -0
- data/lib/kettle/drift/serializer.rb +86 -0
- data/lib/kettle/drift/tasks.rb +10 -0
- data/lib/kettle/drift/version.rb +10 -0
- data/lib/kettle/drift.rb +150 -0
- data/sig/kettle/drift/version.rbs +9 -0
- data/sig/kettle/drift.rbs +6 -0
- data.tar.gz.sig +3 -0
- metadata +302 -0
- metadata.gz.sig +0 -0
data/README.md
ADDED
|
@@ -0,0 +1,477 @@
|
|
|
1
|
+
[![Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0][🖼️galtzo-floss-i]][🖼️galtzo-floss] [![ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5][🖼️ruby-lang-i]][🖼️ruby-lang] [![kettle-rb Logo by Aboling0, CC BY-SA 4.0][🖼️kettle-rb-i]][🖼️kettle-rb] [![kettle-drift Logo by Aboling0, CC BY-SA 4.0][🖼️kettle-rb-kettle-drift-i]][🖼️kettle-rb-kettle-drift]
|
|
2
|
+
|
|
3
|
+
[🖼️galtzo-floss-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px.svg
|
|
4
|
+
[🖼️galtzo-floss]: https://discord.gg/3qme4XHNKN
|
|
5
|
+
[🖼️ruby-lang-i]: https://logos.galtzo.com/assets/images/ruby-lang/avatar-128px.svg
|
|
6
|
+
[🖼️ruby-lang]: https://www.ruby-lang.org/
|
|
7
|
+
[🖼️kettle-rb-i]: https://logos.galtzo.com/assets/images/kettle-rb/avatar-128px.svg
|
|
8
|
+
[🖼️kettle-rb]: https://github.com/kettle-rb
|
|
9
|
+
[🖼️kettle-rb-kettle-drift-i]: https://logos.galtzo.com/assets/images/kettle-rb/kettle-drift/avatar-128px.svg
|
|
10
|
+
[🖼️kettle-rb-kettle-drift]: https://github.com/kettle-rb/kettle-drift
|
|
11
|
+
|
|
12
|
+
# 🔮 Kettle::Drift
|
|
13
|
+
|
|
14
|
+
[![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: AGPL-3.0-only][📄license-img]][📄license] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![CodeQL][🖐codeQL-img]][🖐codeQL]
|
|
15
|
+
|
|
16
|
+
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][🖼️galtzo-floss], as I may have missed the [discord notification][🖼️galtzo-floss].
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
`if ci_badges.map(&:color).all? { it == "green"}` 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.
|
|
21
|
+
|
|
22
|
+
[![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] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate at ko-fi.com][🖇kofi-img]][🖇kofi]
|
|
23
|
+
|
|
24
|
+
<details>
|
|
25
|
+
<summary>👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️</summary>
|
|
26
|
+
|
|
27
|
+
I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).
|
|
28
|
+
|
|
29
|
+
</details>
|
|
30
|
+
|
|
31
|
+
## 🌻 Synopsis
|
|
32
|
+
|
|
33
|
+
`kettle-drift` tracks repeated adjacent-line chunks that usually signal
|
|
34
|
+
template drift or copy/paste corruption. When it is injected into a project by
|
|
35
|
+
the `kettle-jem` plugin, the rake tasks default to the `kettle-jem` template
|
|
36
|
+
surface and baseline, so they validate only template-managed files instead of
|
|
37
|
+
the whole repository.
|
|
38
|
+
|
|
39
|
+
## 💡 Info you can shake a stick at
|
|
40
|
+
|
|
41
|
+
| Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
|
|
42
|
+
|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
43
|
+
| Works with JRuby | [![JRuby current Compat][💎jruby-c-i]][🚎10-j-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf]|
|
|
44
|
+
| Works with Truffle Ruby | [![Truffle Ruby 24.2 Compat][💎truby-24.2i]][🚎truby-24.2-wf] [![Truffle Ruby 25.0 Compat][💎truby-25.0i]][🚎truby-25.0-wf] [![Truffle Ruby current Compat][💎truby-c-i]][🚎9-t-wf]|
|
|
45
|
+
| Works with MRI Ruby 4 | [![Ruby 4.0 Compat][💎ruby-4.0i]][🚎11-c-wf] [![Ruby current Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf]|
|
|
46
|
+
| Works with MRI Ruby 3 | [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎ruby-3.2-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎ruby-3.3-wf] [![Ruby 3.4 Compat][💎ruby-3.4i]][🚎ruby-3.4-wf]|
|
|
47
|
+
| Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork] [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor] |
|
|
48
|
+
| Source | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on Github.com][📜src-gh-img]][📜src-gh] [![The best SHA: dQw4w9WgXcQ!][🧮kloc-img]][🧮kloc] |
|
|
49
|
+
| Documentation | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog] [![GitLab Wiki][📜gl-wiki-img]][📜gl-wiki] [![GitHub Wiki][📜gh-wiki-img]][📜gh-wiki] |
|
|
50
|
+
| Compliance | [![License: AGPL-3.0-only][📄license-img]][📄license] [![Apache license compatibility: Category X][📄license-compat-img]][📄license-compat] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
|
|
51
|
+
| Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] [![Compatibility appraised by: appraisal2][💎appraisal2-img]][💎appraisal2] |
|
|
52
|
+
| Maintainer 🎖️ | [![Follow Me on LinkedIn][💖🖇linkedin-img]][💖🖇linkedin] [![Follow Me on Ruby.Social][💖🐘ruby-mast-img]][💖🐘ruby-mast] [![Follow Me on Bluesky][💖🦋bluesky-img]][💖🦋bluesky] [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact] [![My technical writing][💖💁🏼♂️devto-img]][💖💁🏼♂️devto] |
|
|
53
|
+
| `...` 💖 | [![Find Me on WellFound:][💖✌️wellfound-img]][💖✌️wellfound] [![Find Me on CrunchBase][💖💲crunchbase-img]][💖💲crunchbase] [![My LinkTree][💖🌳linktree-img]][💖🌳linktree] [![More About Me][💖💁🏼♂️aboutme-img]][💖💁🏼♂️aboutme] [🧊][💖🧊berg] [🐙][💖🐙hub] [🛖][💖🛖hut] [🧪][💖🧪lab] |
|
|
54
|
+
|
|
55
|
+
### Compatibility
|
|
56
|
+
|
|
57
|
+
Compatible with MRI Ruby 3.2.0+, and concordant releases of JRuby, and TruffleRuby.
|
|
58
|
+
|
|
59
|
+
| 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
|
|
60
|
+
|------------------------------------------------|--------------------------------------------------------|
|
|
61
|
+
| 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
|
|
62
|
+
|
|
63
|
+
### Federated DVCS
|
|
64
|
+
|
|
65
|
+
<details markdown="1">
|
|
66
|
+
<summary>Find this repo on federated forges (Coming soon!)</summary>
|
|
67
|
+
|
|
68
|
+
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
|
|
69
|
+
|-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
|
|
70
|
+
| 🧪 [kettle-rb/kettle-drift on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ |
|
|
71
|
+
| 🧊 [kettle-rb/kettle-drift on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
|
|
72
|
+
| 🐙 [kettle-rb/kettle-drift on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
|
|
73
|
+
| 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
|
|
74
|
+
|
|
75
|
+
</details>
|
|
76
|
+
|
|
77
|
+
[gh-discussions]: https://github.com/kettle-rb/kettle-drift/discussions
|
|
78
|
+
|
|
79
|
+
### Enterprise Support [](https://tidelift.com/subscription/pkg/rubygems-kettle-drift?utm_source=rubygems-kettle-drift&utm_medium=referral&utm_campaign=readme)
|
|
80
|
+
|
|
81
|
+
Available as part of the Tidelift Subscription.
|
|
82
|
+
|
|
83
|
+
<details markdown="1">
|
|
84
|
+
<summary>Need enterprise-level guarantees?</summary>
|
|
85
|
+
|
|
86
|
+
The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.
|
|
87
|
+
|
|
88
|
+
[![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
|
|
89
|
+
|
|
90
|
+
- 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies
|
|
91
|
+
- 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
|
|
92
|
+
- 💡Tidelift pays maintainers to maintain the software you depend on!<br/>📊`@`Pointy Haired Boss: An [enterprise support][🏙️entsup-tidelift] subscription is "[never gonna let you down][🧮kloc]", and *supports* open source maintainers
|
|
93
|
+
|
|
94
|
+
Alternatively:
|
|
95
|
+
|
|
96
|
+
- [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
97
|
+
- [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork]
|
|
98
|
+
- [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor]
|
|
99
|
+
|
|
100
|
+
</details>
|
|
101
|
+
|
|
102
|
+
## ✨ Installation
|
|
103
|
+
|
|
104
|
+
Install the gem and add to the application's Gemfile by executing:
|
|
105
|
+
|
|
106
|
+
```console
|
|
107
|
+
bundle add kettle-drift
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
If bundler is not being used to manage dependencies, install the gem by executing:
|
|
111
|
+
|
|
112
|
+
```console
|
|
113
|
+
gem install kettle-drift
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## ⚙️ Configuration
|
|
117
|
+
|
|
118
|
+
The injected rake tasks and the standalone CLI expose the same three operating
|
|
119
|
+
modes, but they differ in default scan scope:
|
|
120
|
+
|
|
121
|
+
| Entry point | Scope default | Mode | Writes lockfile? | Fails when |
|
|
122
|
+
|--------------------------------------|--------------------------------------------------------------|----------------|------------------------------------------|------------------------------------------------------------------|
|
|
123
|
+
| `bin/rake kettle:drift` | Template-managed files via `kettle-jem` when available | `update` | Yes, unless new untracked drift appeared | any new untracked drift appeared |
|
|
124
|
+
| `bin/rake kettle:drift:update` | Template-managed files via `kettle-jem` when available | `update` | Yes, unless new untracked drift appeared | any new untracked drift appeared |
|
|
125
|
+
| `bin/rake kettle:drift:check` | Template-managed files via `kettle-jem` when available | `check` | No | any lockfile difference |
|
|
126
|
+
| `bin/rake kettle:drift:force_update` | Template-managed files via `kettle-jem` when available | `force-update` | Yes | never, for drift-state reasons |
|
|
127
|
+
| `kettle-drift --update` | Whole repo target set unless `--template-dir=PATH` is passed | `update` | Yes, unless new untracked drift appeared | any new untracked drift appeared |
|
|
128
|
+
| `kettle-drift --check` | Whole repo target set unless `--template-dir=PATH` is passed | `check` | No | any lockfile difference except the already-clean `complete` case |
|
|
129
|
+
| `kettle-drift --force-update` | Whole repo target set unless `--template-dir=PATH` is passed | `force-update` | Yes | never, for drift-state reasons |
|
|
130
|
+
|
|
131
|
+
Behavior notes:
|
|
132
|
+
|
|
133
|
+
| Term | Meaning |
|
|
134
|
+
|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
135
|
+
| `acknowledged drift` | Drift already recorded in the lockfile |
|
|
136
|
+
| `new untracked drift` | Drift present in the current scan but not yet recorded in the lockfile |
|
|
137
|
+
| `update` mode | Writes the current results when establishing the first baseline, when acknowledged drift was reduced, or when drift is gone entirely; fails instead of writing whenever new untracked drift appeared |
|
|
138
|
+
| `check` mode | Never writes; fails whenever current results differ from the lockfile, except for the already-clean `complete`-with-no-lock case |
|
|
139
|
+
| `force-update` mode | Always writes the current results (or deletes the lockfile for `complete`) and does not fail just because new untracked drift appeared |
|
|
140
|
+
|
|
141
|
+
## 🔧 Basic Usage
|
|
142
|
+
|
|
143
|
+
For `kettle-jem`-managed repos, prefer the injected rake tasks:
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
bin/rake kettle:drift
|
|
147
|
+
bin/rake kettle:drift:update
|
|
148
|
+
bin/rake kettle:drift:check
|
|
149
|
+
bin/rake kettle:drift:force_update
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
Use the standalone CLI when you intentionally want a broader or explicitly
|
|
153
|
+
configured scan:
|
|
154
|
+
|
|
155
|
+
```bash
|
|
156
|
+
kettle-drift
|
|
157
|
+
kettle-drift --update
|
|
158
|
+
kettle-drift --check
|
|
159
|
+
kettle-drift --force-update
|
|
160
|
+
kettle-drift --template-dir=template
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
## 🔐 Security
|
|
164
|
+
|
|
165
|
+
See [SECURITY.md][🔐security].
|
|
166
|
+
|
|
167
|
+
## 🤝 Contributing
|
|
168
|
+
|
|
169
|
+
If you need some ideas of where to help, you could work on adding more code coverage,
|
|
170
|
+
or if it is already 💯 (see [below](#code-coverage)) check [issues][🤝gh-issues] or [PRs][🤝gh-pulls],
|
|
171
|
+
or use the gem and think about how it could be better.
|
|
172
|
+
|
|
173
|
+
We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
|
|
174
|
+
|
|
175
|
+
See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
|
|
176
|
+
|
|
177
|
+
### 🚀 Release Instructions
|
|
178
|
+
|
|
179
|
+
See [CONTRIBUTING.md][🤝contributing].
|
|
180
|
+
|
|
181
|
+
### Code Coverage
|
|
182
|
+
|
|
183
|
+
<details markdown="1">
|
|
184
|
+
<summary>Coverage service badges</summary>
|
|
185
|
+
|
|
186
|
+
[![Coverage Graph][🏀codecov-g]][🏀codecov]
|
|
187
|
+
|
|
188
|
+
[![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
|
|
189
|
+
|
|
190
|
+
[![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
|
|
191
|
+
|
|
192
|
+
</details>
|
|
193
|
+
|
|
194
|
+
### 🪇 Code of Conduct
|
|
195
|
+
|
|
196
|
+
Everyone interacting with this project's codebases, issue trackers,
|
|
197
|
+
chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
|
|
198
|
+
|
|
199
|
+
## 🌈 Contributors
|
|
200
|
+
|
|
201
|
+
[![Contributors][🖐contributors-img]][🖐contributors]
|
|
202
|
+
|
|
203
|
+
Made with [contributors-img][🖐contrib-rocks].
|
|
204
|
+
|
|
205
|
+
Also see GitLab Contributors: [https://gitlab.com/kettle-rb/kettle-drift/-/graphs/main][🚎contributors-gl]
|
|
206
|
+
|
|
207
|
+
<details>
|
|
208
|
+
<summary>⭐️ Star History</summary>
|
|
209
|
+
|
|
210
|
+
<a href="https://star-history.com/kettle-rb/kettle-drift&Date">
|
|
211
|
+
<picture>
|
|
212
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=kettle-rb/kettle-drift&type=Date&theme=dark" />
|
|
213
|
+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=kettle-rb/kettle-drift&type=Date" />
|
|
214
|
+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=kettle-rb/kettle-drift&type=Date" />
|
|
215
|
+
</picture>
|
|
216
|
+
</a>
|
|
217
|
+
|
|
218
|
+
</details>
|
|
219
|
+
|
|
220
|
+
## 📌 Versioning
|
|
221
|
+
|
|
222
|
+
This library follows [![Semantic Versioning 2.0.0][📌semver-img]][📌semver] for its public API where practical.
|
|
223
|
+
For most applications, prefer the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
|
|
224
|
+
|
|
225
|
+
For example:
|
|
226
|
+
|
|
227
|
+
```ruby
|
|
228
|
+
spec.add_dependency("kettle-drift", "~> 1.0")
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
<details markdown="1">
|
|
232
|
+
<summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
|
|
233
|
+
|
|
234
|
+
Dropping support for a platform can be a breaking change for affected users.
|
|
235
|
+
If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.
|
|
236
|
+
|
|
237
|
+
To get a better understanding of how SemVer is intended to work over a project's lifetime,
|
|
238
|
+
read this article from the creator of SemVer:
|
|
239
|
+
|
|
240
|
+
- ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
|
|
241
|
+
|
|
242
|
+
</details>
|
|
243
|
+
|
|
244
|
+
See [CHANGELOG.md][📌changelog] for a list of releases.
|
|
245
|
+
|
|
246
|
+
## 📄 License
|
|
247
|
+
|
|
248
|
+
The gem is available under the following license: [AGPL-3.0-only](AGPL-3.0-only.md).
|
|
249
|
+
See [LICENSE.md][📄license] for details.
|
|
250
|
+
|
|
251
|
+
If none of the available licenses suit your use case, please [contact us](mailto:floss@galtzo.com) to discuss a custom commercial license.
|
|
252
|
+
|
|
253
|
+
### © Copyright
|
|
254
|
+
|
|
255
|
+
See [LICENSE.md][📄license] for the official copyright notice.
|
|
256
|
+
|
|
257
|
+
<details markdown="1">
|
|
258
|
+
<summary>Copyright holders</summary>
|
|
259
|
+
|
|
260
|
+
- Copyright (c) 2026 Peter H. Boling
|
|
261
|
+
|
|
262
|
+
</details>
|
|
263
|
+
|
|
264
|
+
## 🤑 A request for help
|
|
265
|
+
|
|
266
|
+
Maintainers have teeth and need to pay their dentists.
|
|
267
|
+
After getting laid off in an RIF in March, and encountering difficulty finding a new one,
|
|
268
|
+
I began spending most of my time building open source tools.
|
|
269
|
+
I'm hoping to be able to pay for my kids' health insurance this month,
|
|
270
|
+
so if you value the work I am doing, I need your support.
|
|
271
|
+
Please consider sponsoring me or the project.
|
|
272
|
+
|
|
273
|
+
To join the community or get help 👇️ Join the Discord.
|
|
274
|
+
|
|
275
|
+
[![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
276
|
+
|
|
277
|
+
To say "thanks!" ☝️ Join the Discord or 👇️ send money.
|
|
278
|
+
|
|
279
|
+
[![Sponsor kettle-rb/kettle-drift 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]
|
|
280
|
+
|
|
281
|
+
### Please give the project a star ⭐ ♥.
|
|
282
|
+
|
|
283
|
+
Thanks for RTFM. ☺️
|
|
284
|
+
|
|
285
|
+
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
|
|
286
|
+
[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
|
|
287
|
+
[⛳liberapay]: https://liberapay.com/pboling/donate
|
|
288
|
+
[🖇osc-all-img]: https://img.shields.io/opencollective/all/kettle-rb
|
|
289
|
+
[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/kettle-rb
|
|
290
|
+
[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/kettle-rb
|
|
291
|
+
[🖇osc-backers]: https://opencollective.com/kettle-rb#backer
|
|
292
|
+
[🖇osc-backers-i]: https://opencollective.com/kettle-rb/backers/badge.svg?style=flat
|
|
293
|
+
[🖇osc-sponsors]: https://opencollective.com/kettle-rb#sponsor
|
|
294
|
+
[🖇osc-sponsors-i]: https://opencollective.com/kettle-rb/sponsors/badge.svg?style=flat
|
|
295
|
+
[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/kettle-rb?style=for-the-badge
|
|
296
|
+
[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/kettle-rb?style=for-the-badge
|
|
297
|
+
[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/kettle-rb?style=for-the-badge
|
|
298
|
+
[🖇osc]: https://opencollective.com/kettle-rb
|
|
299
|
+
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
|
|
300
|
+
[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
|
|
301
|
+
[🖇sponsor]: https://github.com/sponsors/pboling
|
|
302
|
+
[🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
|
|
303
|
+
[🖇polar]: https://polar.sh/pboling
|
|
304
|
+
[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
|
|
305
|
+
[🖇kofi]: https://ko-fi.com/pboling
|
|
306
|
+
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
|
|
307
|
+
[🖇patreon]: https://patreon.com/galtzo
|
|
308
|
+
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
|
|
309
|
+
[🖇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
|
|
310
|
+
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
|
311
|
+
[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
|
|
312
|
+
[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
|
|
313
|
+
[🖇paypal]: https://www.paypal.com/paypalme/peterboling
|
|
314
|
+
[🖇floss-funding.dev]: https://floss-funding.dev
|
|
315
|
+
[🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
|
|
316
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
|
317
|
+
[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
|
|
318
|
+
[✉️ruby-friends-img]: https://img.shields.io/badge/daily.dev-%F0%9F%92%8E_Ruby_Friends-0A0A0A?style=for-the-badge&logo=dailydotdev&logoColor=white
|
|
319
|
+
[✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
|
|
320
|
+
|
|
321
|
+
[✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
|
|
322
|
+
[⛳️gem-namespace]: https://github.com/kettle-rb/kettle-drift
|
|
323
|
+
[⛳️namespace-img]: https://img.shields.io/badge/namespace-Kettle::Drift-3C2D2D.svg?style=square&logo=ruby&logoColor=white
|
|
324
|
+
[⛳️gem-name]: https://bestgems.org/gems/kettle-drift
|
|
325
|
+
[⛳️name-img]: https://img.shields.io/badge/name-kettle--drift-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
|
|
326
|
+
[⛳️tag-img]: https://img.shields.io/github/tag/kettle-rb/kettle-drift.svg
|
|
327
|
+
[⛳️tag]: https://github.com/kettle-rb/kettle-drift/releases
|
|
328
|
+
[🚂maint-blog]: http://www.railsbling.com/tags/kettle-drift
|
|
329
|
+
[🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
|
|
330
|
+
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
331
|
+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
|
332
|
+
[💖🖇linkedin]: http://www.linkedin.com/in/peterboling
|
|
333
|
+
[💖🖇linkedin-img]: https://img.shields.io/badge/LinkedIn-Profile-0B66C2?style=flat&logo=newjapanprowrestling
|
|
334
|
+
[💖✌️wellfound]: https://wellfound.com/u/peter-boling
|
|
335
|
+
[💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
|
|
336
|
+
[💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
|
|
337
|
+
[💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
|
|
338
|
+
[💖🐘ruby-mast]: https://ruby.social/@galtzo
|
|
339
|
+
[💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@galtzo
|
|
340
|
+
[💖🦋bluesky]: https://bsky.app/profile/galtzo.com
|
|
341
|
+
[💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
|
|
342
|
+
[💖🌳linktree]: https://linktr.ee/galtzo
|
|
343
|
+
[💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
|
|
344
|
+
[💖💁🏼♂️devto]: https://dev.to/galtzo
|
|
345
|
+
[💖💁🏼♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
|
|
346
|
+
[💖💁🏼♂️aboutme]: https://about.me/peter.boling
|
|
347
|
+
[💖💁🏼♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
|
|
348
|
+
[💖🧊berg]: https://codeberg.org/pboling
|
|
349
|
+
[💖🐙hub]: https://github.org/pboling
|
|
350
|
+
[💖🛖hut]: https://sr.ht/~galtzo/
|
|
351
|
+
[💖🧪lab]: https://gitlab.com/pboling
|
|
352
|
+
[👨🏼🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
|
|
353
|
+
[👨🏼🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
|
|
354
|
+
[👨🏼🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
|
|
355
|
+
[👨🏼🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
|
|
356
|
+
[🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-kettle-drift?utm_source=rubygems-kettle-drift&utm_medium=referral&utm_campaign=readme
|
|
357
|
+
[🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
|
|
358
|
+
[🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
|
|
359
|
+
[💁🏼♂️peterboling]: http://www.peterboling.com
|
|
360
|
+
[🚂railsbling]: http://www.railsbling.com
|
|
361
|
+
[📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
|
|
362
|
+
[📜src-gl]: https://gitlab.com/kettle-rb/kettle-drift
|
|
363
|
+
[📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
|
|
364
|
+
[📜src-cb]: https://codeberg.org/kettle-rb/kettle-drift
|
|
365
|
+
[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
|
|
366
|
+
[📜src-gh]: https://github.com/kettle-rb/kettle-drift
|
|
367
|
+
[📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
368
|
+
[📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
369
|
+
[📜gl-wiki]: https://gitlab.com/kettle-rb/kettle-drift/-/wikis/home
|
|
370
|
+
[📜gh-wiki]: https://github.com/kettle-rb/kettle-drift/wiki
|
|
371
|
+
[📜gl-wiki-img]: https://img.shields.io/badge/wiki-gitlab-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
|
|
372
|
+
[📜gh-wiki-img]: https://img.shields.io/badge/wiki-github-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
|
|
373
|
+
[👽dl-rank]: https://bestgems.org/gems/kettle-drift
|
|
374
|
+
[👽dl-ranki]: https://img.shields.io/gem/rd/kettle-drift.svg
|
|
375
|
+
[👽version]: https://bestgems.org/gems/kettle-drift
|
|
376
|
+
[👽versioni]: https://img.shields.io/gem/v/kettle-drift.svg
|
|
377
|
+
[🏀qlty-mnt]: https://qlty.sh/gh/kettle-rb/projects/kettle-drift
|
|
378
|
+
[🏀qlty-mnti]: https://qlty.sh/gh/kettle-rb/projects/kettle-drift/maintainability.svg
|
|
379
|
+
[🏀qlty-cov]: https://qlty.sh/gh/kettle-rb/projects/kettle-drift/metrics/code?sort=coverageRating
|
|
380
|
+
[🏀qlty-covi]: https://qlty.sh/gh/kettle-rb/projects/kettle-drift/coverage.svg
|
|
381
|
+
[🏀codecov]: https://codecov.io/gh/kettle-rb/kettle-drift
|
|
382
|
+
[🏀codecovi]: https://codecov.io/gh/kettle-rb/kettle-drift/graph/badge.svg
|
|
383
|
+
[🏀coveralls]: https://coveralls.io/github/kettle-rb/kettle-drift?branch=main
|
|
384
|
+
[🏀coveralls-img]: https://coveralls.io/repos/github/kettle-rb/kettle-drift/badge.svg?branch=main
|
|
385
|
+
[🖐codeQL]: https://github.com/kettle-rb/kettle-drift/security/code-scanning
|
|
386
|
+
[🖐codeQL-img]: https://github.com/kettle-rb/kettle-drift/actions/workflows/codeql-analysis.yml/badge.svg
|
|
387
|
+
[🚎ruby-3.2-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/ruby-3.2.yml
|
|
388
|
+
[🚎ruby-3.3-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/ruby-3.3.yml
|
|
389
|
+
[🚎ruby-3.4-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/ruby-3.4.yml
|
|
390
|
+
[🚎truby-24.2-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/truffleruby-24.2.yml
|
|
391
|
+
[🚎truby-25.0-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/truffleruby-25.0.yml
|
|
392
|
+
[🚎2-cov-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/coverage.yml
|
|
393
|
+
[🚎2-cov-wfi]: https://github.com/kettle-rb/kettle-drift/actions/workflows/coverage.yml/badge.svg
|
|
394
|
+
[🚎3-hd-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/heads.yml
|
|
395
|
+
[🚎3-hd-wfi]: https://github.com/kettle-rb/kettle-drift/actions/workflows/heads.yml/badge.svg
|
|
396
|
+
[🚎5-st-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/style.yml
|
|
397
|
+
[🚎5-st-wfi]: https://github.com/kettle-rb/kettle-drift/actions/workflows/style.yml/badge.svg
|
|
398
|
+
[🚎9-t-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/truffle.yml
|
|
399
|
+
[🚎9-t-wfi]: https://github.com/kettle-rb/kettle-drift/actions/workflows/truffle.yml/badge.svg
|
|
400
|
+
[🚎10-j-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/jruby.yml
|
|
401
|
+
[🚎10-j-wfi]: https://github.com/kettle-rb/kettle-drift/actions/workflows/jruby.yml/badge.svg
|
|
402
|
+
[🚎11-c-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/current.yml
|
|
403
|
+
[🚎11-c-wfi]: https://github.com/kettle-rb/kettle-drift/actions/workflows/current.yml/badge.svg
|
|
404
|
+
[🚎12-crh-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/dep-heads.yml
|
|
405
|
+
[🚎12-crh-wfi]: https://github.com/kettle-rb/kettle-drift/actions/workflows/dep-heads.yml/badge.svg
|
|
406
|
+
[🚎13-🔒️-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/locked_deps.yml
|
|
407
|
+
[🚎13-🔒️-wfi]: https://github.com/kettle-rb/kettle-drift/actions/workflows/locked_deps.yml/badge.svg
|
|
408
|
+
[🚎14-🔓️-wf]: https://github.com/kettle-rb/kettle-drift/actions/workflows/unlocked_deps.yml
|
|
409
|
+
[🚎14-🔓️-wfi]: https://github.com/kettle-rb/kettle-drift/actions/workflows/unlocked_deps.yml/badge.svg
|
|
410
|
+
[💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
411
|
+
[💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
412
|
+
[💎ruby-3.4i]: https://img.shields.io/badge/Ruby-3.4-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
413
|
+
[💎ruby-4.0i]: https://img.shields.io/badge/Ruby-4.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
414
|
+
[💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
|
|
415
|
+
[💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
|
|
416
|
+
[💎truby-24.2i]: https://img.shields.io/badge/Truffle_Ruby-24.2-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
|
|
417
|
+
[💎truby-25.0i]: https://img.shields.io/badge/Truffle_Ruby-25.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
|
|
418
|
+
[💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
|
|
419
|
+
[💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
|
|
420
|
+
[💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
|
|
421
|
+
[🤝gh-issues]: https://github.com/kettle-rb/kettle-drift/issues
|
|
422
|
+
[🤝gh-pulls]: https://github.com/kettle-rb/kettle-drift/pulls
|
|
423
|
+
[🤝gl-issues]: https://gitlab.com/kettle-rb/kettle-drift/-/issues
|
|
424
|
+
[🤝gl-pulls]: https://gitlab.com/kettle-rb/kettle-drift/-/merge_requests
|
|
425
|
+
[🤝cb-issues]: https://codeberg.org/kettle-rb/kettle-drift/issues
|
|
426
|
+
[🤝cb-pulls]: https://codeberg.org/kettle-rb/kettle-drift/pulls
|
|
427
|
+
[🤝cb-donate]: https://donate.codeberg.org/
|
|
428
|
+
[🤝contributing]: https://github.com/kettle-rb/kettle-drift/blob/main/CONTRIBUTING.md
|
|
429
|
+
[🏀codecov-g]: https://codecov.io/gh/kettle-rb/kettle-drift/graph/badge.svg
|
|
430
|
+
[🖐contrib-rocks]: https://contrib.rocks
|
|
431
|
+
[🖐contributors]: https://github.com/kettle-rb/kettle-drift/graphs/contributors
|
|
432
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=kettle-rb/kettle-drift
|
|
433
|
+
[🚎contributors-gl]: https://gitlab.com/kettle-rb/kettle-drift/-/graphs/main
|
|
434
|
+
[🪇conduct]: https://github.com/kettle-rb/kettle-drift/blob/main/CODE_OF_CONDUCT.md
|
|
435
|
+
[🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
|
|
436
|
+
[📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
|
|
437
|
+
[📌semver]: https://semver.org/spec/v2.0.0.html
|
|
438
|
+
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
|
|
439
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
440
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
441
|
+
[📌changelog]: https://github.com/kettle-rb/kettle-drift/blob/main/CHANGELOG.md
|
|
442
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
443
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
|
|
444
|
+
[📌gitmoji]: https://gitmoji.dev
|
|
445
|
+
[📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
|
|
446
|
+
[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
|
|
447
|
+
[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.483-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
|
|
448
|
+
[🔐security]: https://github.com/kettle-rb/kettle-drift/blob/main/SECURITY.md
|
|
449
|
+
[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
|
|
450
|
+
[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
|
|
451
|
+
[📄license]: LICENSE.md
|
|
452
|
+
[📄license-ref]: AGPL-3.0-only.md
|
|
453
|
+
[📄license-img]: https://img.shields.io/badge/License-AGPL--3.0--only-259D6C.svg
|
|
454
|
+
[📄license-compat]: https://www.apache.org/legal/resolved.html#category-x
|
|
455
|
+
[📄license-compat-img]: https://img.shields.io/badge/Apache_Incompatible:_Category_X-✗-C0392B.svg?style=flat&logo=Apache
|
|
456
|
+
[📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
|
|
457
|
+
[📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
|
|
458
|
+
[🚎yard-current]: http://rubydoc.info/gems/kettle-drift
|
|
459
|
+
[🚎yard-head]: https://kettle-drift.galtzo.com
|
|
460
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
461
|
+
[💎SHA_checksums]: https://gitlab.com/kettle-rb/kettle-drift/-/tree/main/checksums
|
|
462
|
+
[💎rlts]: https://github.com/rubocop-lts/rubocop-lts
|
|
463
|
+
[💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
464
|
+
[💎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
465
|
+
[💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
466
|
+
[💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
|
|
467
|
+
|
|
468
|
+
<!-- kettle-jem:metadata:start -->
|
|
469
|
+
| Field | Value |
|
|
470
|
+
|---|---|
|
|
471
|
+
| Package | kettle-drift |
|
|
472
|
+
| Description | 🔮 Kettle::Drift tracks repeated adjacent-line chunks that usually signal template drift or copy/paste corruption. |
|
|
473
|
+
| Homepage | https://github.com/kettle-rb/kettle-drift |
|
|
474
|
+
| Source | https://github.com/kettle-rb/kettle-drift/tree/v1.0.0 |
|
|
475
|
+
| License | `AGPL-3.0-only` |
|
|
476
|
+
| Funding | https://github.com/sponsors/pboling, https://issuehunt.io/u/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/kettle-rb, https://patreon.com/galtzo, https://polar.sh/pboling, https://thanks.dev/u/gh/pboling, https://tidelift.com/funding/github/rubygems/kettle-drift, https://www.buymeacoffee.com/pboling |
|
|
477
|
+
<!-- kettle-jem:metadata:end -->
|
data/RUBOCOP.md
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# RuboCop Usage Guide
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
A tale of two RuboCop plugin gems.
|
|
6
|
+
|
|
7
|
+
### RuboCop Gradual
|
|
8
|
+
|
|
9
|
+
This project uses `rubocop_gradual` instead of vanilla RuboCop for code style checking. The `rubocop_gradual` tool allows for gradual adoption of RuboCop rules by tracking violations in a lock file.
|
|
10
|
+
|
|
11
|
+
### RuboCop LTS
|
|
12
|
+
|
|
13
|
+
This project uses `rubocop-lts` to ensure, on a best-effort basis, compatibility with Ruby >= 1.9.2.
|
|
14
|
+
RuboCop rules are meticulously configured by the `rubocop-lts` family of gems to ensure that a project is compatible with a specific version of Ruby. See: https://rubocop-lts.gitlab.io for more.
|
|
15
|
+
|
|
16
|
+
## Checking RuboCop Violations
|
|
17
|
+
|
|
18
|
+
To check for RuboCop violations in this project, always use:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
bundle exec rake rubocop_gradual:check
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
**Do not use** the standard RuboCop commands like:
|
|
25
|
+
- `bundle exec rubocop`
|
|
26
|
+
- `rubocop`
|
|
27
|
+
|
|
28
|
+
## Understanding the Lock File
|
|
29
|
+
|
|
30
|
+
The `.rubocop_gradual.lock` file tracks all current RuboCop violations in the project. This allows the team to:
|
|
31
|
+
|
|
32
|
+
1. Prevent new violations while gradually fixing existing ones
|
|
33
|
+
2. Track progress on code style improvements
|
|
34
|
+
3. Ensure CI builds don't fail due to pre-existing violations
|
|
35
|
+
|
|
36
|
+
## Common Commands
|
|
37
|
+
|
|
38
|
+
- **Check violations**
|
|
39
|
+
- `bundle exec rake rubocop_gradual`
|
|
40
|
+
- `bundle exec rake rubocop_gradual:check`
|
|
41
|
+
- **(Safe) Autocorrect violations, and update lockfile if no new violations**
|
|
42
|
+
- `bundle exec rake rubocop_gradual:autocorrect`
|
|
43
|
+
- **Force update the lock file (w/o autocorrect) to match violations present in code**
|
|
44
|
+
- `bundle exec rake rubocop_gradual:force_update`
|
|
45
|
+
|
|
46
|
+
## Workflow
|
|
47
|
+
|
|
48
|
+
1. Before submitting a PR, run `bundle exec rake rubocop_gradual:autocorrect`
|
|
49
|
+
a. or just the default `bundle exec rake`, as autocorrection is a pre-requisite of the default task.
|
|
50
|
+
2. If there are new violations, either:
|
|
51
|
+
- Fix them in your code
|
|
52
|
+
- Run `bundle exec rake rubocop_gradual:force_update` to update the lock file (only for violations you can't fix immediately)
|
|
53
|
+
3. Commit the updated `.rubocop_gradual.lock` file along with your changes
|
|
54
|
+
|
|
55
|
+
## Never add inline RuboCop disables
|
|
56
|
+
|
|
57
|
+
Do not add inline `rubocop:disable` / `rubocop:enable` comments anywhere in the codebase (including specs, except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). We handle exceptions in two supported ways:
|
|
58
|
+
|
|
59
|
+
- Permanent/structural exceptions: prefer adjusting the RuboCop configuration (e.g., in `.rubocop.yml`) to exclude a rule for a path or file pattern when it makes sense project-wide.
|
|
60
|
+
- Temporary exceptions while improving code: record the current violations in `.rubocop_gradual.lock` via the gradual workflow:
|
|
61
|
+
- `bundle exec rake rubocop_gradual:autocorrect` (preferred; will autocorrect what it can and update the lock only if no new violations were introduced)
|
|
62
|
+
- If needed, `bundle exec rake rubocop_gradual:force_update` (as a last resort when you cannot fix the newly reported violations immediately)
|
|
63
|
+
|
|
64
|
+
In general, treat the rules as guidance to follow; fix violations rather than ignore them. For example, RSpec conventions in this project expect `described_class` to be used in specs that target a specific class under test.
|
|
65
|
+
|
|
66
|
+
## Benefits of rubocop_gradual
|
|
67
|
+
|
|
68
|
+
- Allows incremental adoption of code style rules
|
|
69
|
+
- Prevents CI failures due to pre-existing violations
|
|
70
|
+
- Provides a clear record of code style debt
|
|
71
|
+
- Enables focused efforts on improving code quality over time
|
data/SECURITY.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
| Version | Supported |
|
|
6
|
+
|----------|-----------|
|
|
7
|
+
| 1.latest | ✅ |
|
|
8
|
+
|
|
9
|
+
## Security contact information
|
|
10
|
+
|
|
11
|
+
To report a security vulnerability, please use the
|
|
12
|
+
[Tidelift security contact](https://tidelift.com/security).
|
|
13
|
+
Tidelift will coordinate the fix and disclosure.
|
|
14
|
+
|
|
15
|
+
## Additional Support
|
|
16
|
+
|
|
17
|
+
If you are interested in support for versions older than the latest release,
|
|
18
|
+
please consider sponsoring the project / maintainer @ https://liberapay.com/pboling/donate,
|
|
19
|
+
or find other sponsorship links in the [README].
|
|
20
|
+
|
|
21
|
+
[README]: README.md
|
data/certs/pboling.pem
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
-----BEGIN CERTIFICATE-----
|
|
2
|
+
MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
|
|
3
|
+
ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
|
|
4
|
+
A2NvbTAeFw0yNTA1MDQxNTMzMDlaFw00NTA0MjkxNTMzMDlaMEMxFTATBgNVBAMM
|
|
5
|
+
DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
|
|
6
|
+
LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAruUoo0WA
|
|
7
|
+
uoNuq6puKWYeRYiZekz/nsDeK5x/0IEirzcCEvaHr3Bmz7rjo1I6On3gGKmiZs61
|
|
8
|
+
LRmQ3oxy77ydmkGTXBjruJB+pQEn7UfLSgQ0xa1/X3kdBZt6RmabFlBxnHkoaGY5
|
|
9
|
+
mZuZ5+Z7walmv6sFD9ajhzj+oIgwWfnEHkXYTR8I6VLN7MRRKGMPoZ/yvOmxb2DN
|
|
10
|
+
coEEHWKO9CvgYpW7asIihl/9GMpKiRkcYPm9dGQzZc6uTwom1COfW0+ZOFrDVBuV
|
|
11
|
+
FMQRPswZcY4Wlq0uEBLPU7hxnCL9nKK6Y9IhdDcz1mY6HZ91WImNslOSI0S8hRpj
|
|
12
|
+
yGOWxQIhBT3fqCBlRIqFQBudrnD9jSNpSGsFvbEijd5ns7Z9ZMehXkXDycpGAUj1
|
|
13
|
+
to/5cuTWWw1JqUWrKJYoifnVhtE1o1DZ+LkPtWxHtz5kjDG/zR3MG0Ula0UOavlD
|
|
14
|
+
qbnbcXPBnwXtTFeZ3C+yrWpE4pGnl3yGkZj9SMTlo9qnTMiPmuWKQDatAgMBAAGj
|
|
15
|
+
fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQE8uWvNbPVNRXZ
|
|
16
|
+
HlgPbc2PCzC4bjAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
|
|
17
|
+
A1UdEgQaMBiBFnBldGVyLmJvbGluZ0BnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
|
|
18
|
+
ggGBAJbnUwfJQFPkBgH9cL7hoBfRtmWiCvdqdjeTmi04u8zVNCUox0A4gT982DE9
|
|
19
|
+
wmuN12LpdajxZONqbXuzZvc+nb0StFwmFYZG6iDwaf4BPywm2e/Vmq0YG45vZXGR
|
|
20
|
+
L8yMDSK1cQXjmA+ZBKOHKWavxP6Vp7lWvjAhz8RFwqF9GuNIdhv9NpnCAWcMZtpm
|
|
21
|
+
GUPyIWw/Cw/2wZp74QzZj6Npx+LdXoLTF1HMSJXZ7/pkxLCsB8m4EFVdb/IrW/0k
|
|
22
|
+
kNSfjtAfBHO8nLGuqQZVH9IBD1i9K6aSs7pT6TW8itXUIlkIUI2tg5YzW6OFfPzq
|
|
23
|
+
QekSkX3lZfY+HTSp/o+YvKkqWLUV7PQ7xh1ZYDtocpaHwgxe/j3bBqHE+CUPH2vA
|
|
24
|
+
0V/FwdTRWcwsjVoOJTrYcff8pBZ8r2MvtAc54xfnnhGFzeRHfcltobgFxkAXdE6p
|
|
25
|
+
DVjBtqT23eugOqQ73umLcYDZkc36vnqGxUBSsXrzY9pzV5gGr2I8YUxMqf6ATrZt
|
|
26
|
+
L9nRqA==
|
|
27
|
+
-----END CERTIFICATE-----
|