appraisal2-rubocop 0.1.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.
Files changed (20) hide show
  1. checksums.yaml +7 -0
  2. checksums.yaml.gz.sig +0 -0
  3. data/CHANGELOG.md +59 -0
  4. data/CITATION.cff +20 -0
  5. data/CODE_OF_CONDUCT.md +134 -0
  6. data/CONTRIBUTING.md +272 -0
  7. data/FUNDING.md +74 -0
  8. data/LICENSE.md +10 -0
  9. data/README.md +507 -0
  10. data/RUBOCOP.md +71 -0
  11. data/SECURITY.md +21 -0
  12. data/certs/pboling.pem +27 -0
  13. data/lib/appraisal2/rubocop/runner.rb +44 -0
  14. data/lib/appraisal2/rubocop/version.rb +10 -0
  15. data/lib/appraisal2/rubocop.rb +41 -0
  16. data/lib/appraisal2-rubocop.rb +3 -0
  17. data/sig/appraisal2/rubocop/version.rbs +8 -0
  18. data.tar.gz.sig +0 -0
  19. metadata +336 -0
  20. metadata.gz.sig +0 -0
data/README.md ADDED
@@ -0,0 +1,507 @@
1
+ <a href="https://github.com/appraisal-rb"><img alt="appraisal-rb Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/appraisal-rb/avatar-128px.svg" width="14%" align="right"/></a>
2
+
3
+ # 💎 Appraisal2::Rubocop
4
+
5
+ [![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄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] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
6
+
7
+ `if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][✉️discord-invite], as I may have missed the [discord notification][✉️discord-invite].
8
+
9
+ ---
10
+
11
+ `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.
12
+
13
+ [![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]
14
+
15
+ <details>
16
+ <summary>👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️</summary>
17
+
18
+ I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).
19
+
20
+ </details>
21
+
22
+ ## 🌻 Synopsis <a href="https://discord.gg/3qme4XHNKN"><img alt="Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px.svg" width="8%" align="right"/></a> <a href="https://ruby-toolbox.com"><img alt="ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5" src="https://logos.galtzo.com/assets/images/ruby-lang/avatar-128px.svg" width="8%" align="right"/></a>
23
+
24
+ Runs RuboCop against Appraisal2-generated gemfiles via Appraisal2 lifecycle hooks.
25
+
26
+ This plugin is intended for modern Ruby style-maintenance environments. It does
27
+ not match Appraisal2's legacy runtime floor.
28
+
29
+ Require the plugin before generating appraisal gemfiles:
30
+
31
+ ## 💡 Info you can shake a stick at
32
+
33
+ | Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
34
+ |-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
35
+ | Works with JRuby | [![JRuby 9.4 Compat][💎jruby-9.4i]][🚎jruby-9.4-wf] [![JRuby current Compat][💎jruby-c-i]][🚎10-j-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf]|
36
+ | Works with Truffle Ruby | [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎truby-23.1-wf] <br/> [![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]|
37
+ | 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]|
38
+ | Works with MRI Ruby 3 | [![Ruby 3.1 Compat][💎ruby-3.1i]][🚎ruby-3.1-wf] [![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]|
39
+ | 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] |
40
+ | 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] |
41
+ | 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] |
42
+ | Compliance | [![License: MIT][📄license-img]][📄license] [![Apache license compatibility: Category A][📄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] |
43
+ | 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] |
44
+ | 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] |
45
+ | `...` 💖 | [![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] |
46
+
47
+ ### Compatibility
48
+
49
+ Compatible with MRI Ruby 3.1.0+, and concordant releases of JRuby, and TruffleRuby.
50
+ CI workflows and Appraisals are generated for MRI Ruby 3.1.0+.
51
+ This test floor is configured by `ruby.test_minimum` in `.kettle-jem.yml` and
52
+ may be higher than the gem's runtime compatibility floor when legacy Rubies are
53
+ not practical for the current toolchain.
54
+
55
+ | 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
56
+ |------------------------------------------------|--------------------------------------------------------|
57
+ | 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
58
+
59
+ ### Federated DVCS
60
+
61
+ <details markdown="1">
62
+ <summary>Find this repo on federated forges (Coming soon!)</summary>
63
+
64
+ | Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
65
+ |-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
66
+ | 🧪 [appraisal-rb/appraisal2-rubocop on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ |
67
+ | 🧊 [appraisal-rb/appraisal2-rubocop on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
68
+ | 🐙 [appraisal-rb/appraisal2-rubocop on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
69
+ | 🎮️ [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] |
70
+
71
+ </details>
72
+
73
+ [gh-discussions]: https://github.com/appraisal-rb/appraisal2-rubocop/discussions
74
+
75
+ ### Enterprise Support [![Tidelift](https://tidelift.com/badges/package/rubygems/appraisal2-rubocop)](https://tidelift.com/subscription/pkg/rubygems-appraisal2-rubocop?utm_source=rubygems-appraisal2-rubocop&utm_medium=referral&utm_campaign=readme)
76
+
77
+ Available as part of the Tidelift Subscription.
78
+
79
+ <details markdown="1">
80
+ <summary>Need enterprise-level guarantees?</summary>
81
+
82
+ 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.
83
+
84
+ [![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
85
+
86
+ - 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies
87
+ - 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
88
+ - 💡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
89
+
90
+ Alternatively:
91
+
92
+ - [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
93
+ - [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork]
94
+ - [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor]
95
+
96
+ </details>
97
+
98
+ ## ✨ Installation
99
+
100
+ Install the gem and add to the application's Gemfile by executing:
101
+
102
+ ```console
103
+ bundle add appraisal2-rubocop
104
+ ```
105
+
106
+ If bundler is not being used to manage dependencies, install the gem by executing:
107
+
108
+ ```console
109
+ gem install appraisal2-rubocop
110
+ ```
111
+
112
+ ## ⚙️ Configuration
113
+
114
+ - `APPRAISAL2_RUBOCOP=false` disables the hook.
115
+ - `APPRAISAL2_RUBOCOP_COMMAND` overrides the executable.
116
+ - `APPRAISAL2_RUBOCOP_FLAGS` overrides the default `--autocorrect` flag list.
117
+
118
+ ## 🔧 Basic Usage
119
+
120
+ ```ruby
121
+ require "appraisal2/rubocop"
122
+ ```
123
+
124
+ By default each generated gemfile is processed in memory with:
125
+
126
+ ```sh
127
+ rubocop --stdin path/to/generated.gemfile --autocorrect --stderr --format quiet
128
+ ```
129
+
130
+ <!-- kettle-jem:metadata:start -->
131
+ | Field | Value |
132
+ |---|---|
133
+ | Package | appraisal2-rubocop |
134
+ | Description | 💎 Appraisal2::Rubocop registers Appraisal2 generation hooks that run RuboCop against generated appraisal gemfiles. |
135
+ | Homepage | https://github.com/appraisal-rb/appraisal2-rubocop |
136
+ | Source | https://github.com/appraisal-rb/appraisal2-rubocop/tree/v0.1.0 |
137
+ | License | `MIT` |
138
+ | Funding | https://github.com/sponsors/pboling, https://issuehunt.io/u/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/appraisal-rb, https://patreon.com/galtzo, https://polar.sh/pboling, https://thanks.dev/u/gh/pboling, https://tidelift.com/funding/github/rubygems/appraisal2-rubocop, https://www.buymeacoffee.com/pboling |
139
+ <!-- kettle-jem:metadata:end -->
140
+ ## 🦷 FLOSS Funding
141
+
142
+ While appraisal-rb tools are free software and will always be, the project would benefit immensely from some funding.
143
+ Raising a monthly budget of... "dollars" would make the project more sustainable.
144
+
145
+ We welcome both individual and corporate sponsors! We also offer a
146
+ wide array of funding channels to account for your preferences.
147
+ Currently, [Open Collective][🖇osc] is our preferred funding platform.
148
+
149
+ **If you're working in a company that's making significant use of appraisal-rb tools we'd
150
+ appreciate it if you suggest to your company to become a appraisal-rb sponsor.**
151
+
152
+ You can support the development of appraisal-rb tools via
153
+ [GitHub Sponsors][🖇sponsor],
154
+ [Liberapay][⛳liberapay],
155
+ [PayPal][🖇paypal],
156
+ [Open Collective][🖇osc]
157
+ and [Tidelift][🏙️entsup-tidelift].
158
+
159
+ | 📍 NOTE |
160
+ |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
161
+ | If doing a sponsorship in the form of donation is problematic for your company <br/> from an accounting standpoint, we'd recommend the use of Tidelift, <br/> where you can get a support-like subscription instead. |
162
+
163
+ ### Open Collective for Individuals
164
+
165
+ Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/appraisal-rb#backer)]
166
+
167
+ NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
168
+
169
+ <!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
170
+ No backers yet. Be the first!
171
+ <!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
172
+
173
+ ### Open Collective for Organizations
174
+
175
+ Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/appraisal-rb#sponsor)]
176
+
177
+ NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
178
+
179
+ <!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
180
+ No sponsors yet. Be the first!
181
+ <!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
182
+
183
+ [kettle-readme-backers]: https://github.com/appraisal-rb/appraisal2-rubocop/blob/main/exe/kettle-readme-backers
184
+
185
+ ### Another way to support open-source
186
+
187
+ 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).
188
+
189
+ 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`.
190
+
191
+ 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.
192
+
193
+ **[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
194
+
195
+ [![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 to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS efforts using Patreon][🖇patreon-img]][🖇patreon]
196
+
197
+ ## 🔐 Security
198
+
199
+ See [SECURITY.md][🔐security].
200
+
201
+ ## 🤝 Contributing
202
+
203
+ If you need some ideas of where to help, you could work on adding more code coverage,
204
+ or if it is already 💯 (see [below](#code-coverage)) check [issues][🤝gh-issues] or [PRs][🤝gh-pulls],
205
+ or use the gem and think about how it could be better.
206
+
207
+ We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
208
+
209
+ See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
210
+
211
+ ### 🚀 Release Instructions
212
+
213
+ See [CONTRIBUTING.md][🤝contributing].
214
+
215
+ ### Code Coverage
216
+
217
+ <details markdown="1">
218
+ <summary>Coverage service badges</summary>
219
+
220
+ [![Coverage Graph][🏀codecov-g]][🏀codecov]
221
+
222
+ [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
223
+
224
+ [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
225
+
226
+ </details>
227
+
228
+ ### 🪇 Code of Conduct
229
+
230
+ Everyone interacting with this project's codebases, issue trackers,
231
+ chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
232
+
233
+ ## 🌈 Contributors
234
+
235
+ [![Contributors][🖐contributors-img]][🖐contributors]
236
+
237
+ Made with [contributors-img][🖐contrib-rocks].
238
+
239
+ Also see GitLab Contributors: [https://gitlab.com/appraisal-rb/appraisal2-rubocop/-/graphs/main][🚎contributors-gl]
240
+
241
+ <details>
242
+ <summary>⭐️ Star History</summary>
243
+
244
+ <a href="https://star-history.com/appraisal-rb/appraisal2-rubocop&Date">
245
+ <picture>
246
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=appraisal-rb/appraisal2-rubocop&type=Date&theme=dark" />
247
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=appraisal-rb/appraisal2-rubocop&type=Date" />
248
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=appraisal-rb/appraisal2-rubocop&type=Date" />
249
+ </picture>
250
+ </a>
251
+
252
+ </details>
253
+
254
+ ## 📌 Versioning
255
+
256
+ This library follows [![Semantic Versioning 2.0.0][📌semver-img]][📌semver] for its public API where practical.
257
+ For most applications, prefer the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
258
+
259
+ For example:
260
+
261
+ ```ruby
262
+ spec.add_dependency("appraisal2-rubocop", "~> 0.0")
263
+ ```
264
+
265
+ <details markdown="1">
266
+ <summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
267
+
268
+ Dropping support for a platform can be a breaking change for affected users.
269
+ If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.
270
+
271
+ To get a better understanding of how SemVer is intended to work over a project's lifetime,
272
+ read this article from the creator of SemVer:
273
+
274
+ - ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
275
+
276
+ </details>
277
+
278
+ See [CHANGELOG.md][📌changelog] for a list of releases.
279
+
280
+ ## 📄 License
281
+
282
+ The gem is available as open source under the terms of
283
+ the [MIT](MIT.md) [![License: MIT][📄license-img]][📄license-ref].
284
+
285
+ ### © Copyright
286
+
287
+ See [LICENSE.md][📄license] for the official copyright notice.
288
+
289
+ <details markdown="1">
290
+ <summary>Copyright holders</summary>
291
+
292
+ - Copyright (c) 2026 Peter H. Boling
293
+
294
+ </details>
295
+
296
+ ## 🤑 A request for help
297
+
298
+ Maintainers have teeth and need to pay their dentists.
299
+ After getting laid off in an RIF in March, and encountering difficulty finding a new one,
300
+ I began spending most of my time building open source tools.
301
+ I'm hoping to be able to pay for my kids' health insurance this month,
302
+ so if you value the work I am doing, I need your support.
303
+ Please consider sponsoring me or the project.
304
+
305
+ To join the community or get help 👇️ Join the Discord.
306
+
307
+ [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
308
+
309
+ To say "thanks!" ☝️ Join the Discord or 👇️ send money.
310
+
311
+ [![Sponsor appraisal-rb/appraisal2-rubocop 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]
312
+
313
+ ### Please give the project a star ⭐ ♥.
314
+
315
+ Many parts of this project are actively managed by a [kettle-jem](https://github.com/structuredmerge/structuredmerge-ruby/tree/main/gems/kettle-jem) smart template utilizing [StructuredMerge.org](https://structuredmerge.org) merge contracts.
316
+
317
+ Thanks for RTFM. ☺️
318
+
319
+ [⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
320
+ [⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
321
+ [⛳liberapay]: https://liberapay.com/pboling/donate
322
+ [🖇osc-all-img]: https://img.shields.io/opencollective/all/appraisal-rb
323
+ [🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/appraisal-rb
324
+ [🖇osc-backers-img]: https://img.shields.io/opencollective/backers/appraisal-rb
325
+ [🖇osc-backers]: https://opencollective.com/appraisal-rb#backer
326
+ [🖇osc-backers-i]: https://opencollective.com/appraisal-rb/backers/badge.svg?style=flat
327
+ [🖇osc-sponsors]: https://opencollective.com/appraisal-rb#sponsor
328
+ [🖇osc-sponsors-i]: https://opencollective.com/appraisal-rb/sponsors/badge.svg?style=flat
329
+ [🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/appraisal-rb?style=for-the-badge
330
+ [🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/appraisal-rb?style=for-the-badge
331
+ [🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/appraisal-rb?style=for-the-badge
332
+ [🖇osc]: https://opencollective.com/appraisal-rb
333
+ [🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
334
+ [🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
335
+ [🖇sponsor]: https://github.com/sponsors/pboling
336
+ [🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
337
+ [🖇polar]: https://polar.sh/pboling
338
+ [🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
339
+ [🖇kofi]: https://ko-fi.com/pboling
340
+ [🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
341
+ [🖇patreon]: https://patreon.com/galtzo
342
+ [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
343
+ [🖇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
344
+ [🖇buyme]: https://www.buymeacoffee.com/pboling
345
+ [🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
346
+ [🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
347
+ [🖇paypal]: https://www.paypal.com/paypalme/peterboling
348
+ [🖇floss-funding.dev]: https://floss-funding.dev
349
+ [🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
350
+ [✉️discord-invite]: https://discord.gg/3qme4XHNKN
351
+ [✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
352
+ [✉️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
353
+ [✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
354
+
355
+ [✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
356
+ [⛳️gem-namespace]: https://github.com/appraisal-rb/appraisal2-rubocop
357
+ [⛳️namespace-img]: https://img.shields.io/badge/namespace-Appraisal2::Rubocop-3C2D2D.svg?style=square&logo=ruby&logoColor=white
358
+ [⛳️gem-name]: https://bestgems.org/gems/appraisal2-rubocop
359
+ [⛳️name-img]: https://img.shields.io/badge/name-appraisal2--rubocop-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
360
+ [⛳️tag-img]: https://img.shields.io/github/tag/appraisal-rb/appraisal2-rubocop.svg
361
+ [⛳️tag]: https://github.com/appraisal-rb/appraisal2-rubocop/releases
362
+ [🚂maint-blog]: http://www.railsbling.com/tags/appraisal2-rubocop
363
+ [🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
364
+ [🚂maint-contact]: http://www.railsbling.com/contact
365
+ [🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
366
+ [💖🖇linkedin]: http://www.linkedin.com/in/peterboling
367
+ [💖🖇linkedin-img]: https://img.shields.io/badge/LinkedIn-Profile-0B66C2?style=flat&logo=newjapanprowrestling
368
+ [💖✌️wellfound]: https://wellfound.com/u/peter-boling
369
+ [💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
370
+ [💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
371
+ [💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
372
+ [💖🐘ruby-mast]: https://ruby.social/@galtzo
373
+ [💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@galtzo
374
+ [💖🦋bluesky]: https://bsky.app/profile/galtzo.com
375
+ [💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
376
+ [💖🌳linktree]: https://linktr.ee/galtzo
377
+ [💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
378
+ [💖💁🏼‍♂️devto]: https://dev.to/galtzo
379
+ [💖💁🏼‍♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
380
+ [💖💁🏼‍♂️aboutme]: https://about.me/peter.boling
381
+ [💖💁🏼‍♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
382
+ [💖🧊berg]: https://codeberg.org/pboling
383
+ [💖🐙hub]: https://github.org/pboling
384
+ [💖🛖hut]: https://sr.ht/~galtzo/
385
+ [💖🧪lab]: https://gitlab.com/pboling
386
+ [👨🏼‍🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
387
+ [👨🏼‍🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
388
+ [👨🏼‍🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
389
+ [👨🏼‍🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
390
+ [🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-appraisal2-rubocop?utm_source=rubygems-appraisal2-rubocop&utm_medium=referral&utm_campaign=readme
391
+ [🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
392
+ [🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
393
+ [💁🏼‍♂️peterboling]: http://www.peterboling.com
394
+ [🚂railsbling]: http://www.railsbling.com
395
+ [📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
396
+ [📜src-gl]: https://gitlab.com/appraisal-rb/appraisal2-rubocop
397
+ [📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
398
+ [📜src-cb]: https://codeberg.org/appraisal-rb/appraisal2-rubocop
399
+ [📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
400
+ [📜src-gh]: https://github.com/appraisal-rb/appraisal2-rubocop
401
+ [📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
402
+ [📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
403
+ [📜gl-wiki]: https://gitlab.com/appraisal-rb/appraisal2-rubocop/-/wikis/home
404
+ [📜gh-wiki]: https://github.com/appraisal-rb/appraisal2-rubocop/wiki
405
+ [📜gl-wiki-img]: https://img.shields.io/badge/wiki-gitlab-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
406
+ [📜gh-wiki-img]: https://img.shields.io/badge/wiki-github-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
407
+ [👽dl-rank]: https://bestgems.org/gems/appraisal2-rubocop
408
+ [👽dl-ranki]: https://img.shields.io/gem/rd/appraisal2-rubocop.svg
409
+ [👽version]: https://bestgems.org/gems/appraisal2-rubocop
410
+ [👽versioni]: https://img.shields.io/gem/v/appraisal2-rubocop.svg
411
+ [🏀qlty-mnt]: https://qlty.sh/gh/appraisal-rb/projects/appraisal2-rubocop
412
+ [🏀qlty-mnti]: https://qlty.sh/gh/appraisal-rb/projects/appraisal2-rubocop/maintainability.svg
413
+ [🏀qlty-cov]: https://qlty.sh/gh/appraisal-rb/projects/appraisal2-rubocop/metrics/code?sort=coverageRating
414
+ [🏀qlty-covi]: https://qlty.sh/gh/appraisal-rb/projects/appraisal2-rubocop/coverage.svg
415
+ [🏀codecov]: https://codecov.io/gh/appraisal-rb/appraisal2-rubocop
416
+ [🏀codecovi]: https://codecov.io/gh/appraisal-rb/appraisal2-rubocop/graph/badge.svg
417
+ [🏀coveralls]: https://coveralls.io/github/appraisal-rb/appraisal2-rubocop?branch=main
418
+ [🏀coveralls-img]: https://coveralls.io/repos/github/appraisal-rb/appraisal2-rubocop/badge.svg?branch=main
419
+ [🚎ruby-3.1-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/ruby-3.1.yml
420
+ [🚎ruby-3.2-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/ruby-3.2.yml
421
+ [🚎ruby-3.3-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/ruby-3.3.yml
422
+ [🚎ruby-3.4-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/ruby-3.4.yml
423
+ [🚎jruby-9.4-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/jruby-9.4.yml
424
+ [🚎truby-23.1-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/truffleruby-23.1.yml
425
+ [🚎truby-24.2-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/truffleruby-24.2.yml
426
+ [🚎truby-25.0-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/truffleruby-25.0.yml
427
+ [🚎2-cov-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/coverage.yml
428
+ [🚎2-cov-wfi]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/coverage.yml/badge.svg
429
+ [🚎3-hd-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/heads.yml
430
+ [🚎3-hd-wfi]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/heads.yml/badge.svg
431
+ [🚎5-st-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/style.yml
432
+ [🚎5-st-wfi]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/style.yml/badge.svg
433
+ [🚎9-t-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/truffle.yml
434
+ [🚎9-t-wfi]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/truffle.yml/badge.svg
435
+ [🚎10-j-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/jruby.yml
436
+ [🚎10-j-wfi]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/jruby.yml/badge.svg
437
+ [🚎11-c-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/current.yml
438
+ [🚎11-c-wfi]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/current.yml/badge.svg
439
+ [🚎12-crh-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/dep-heads.yml
440
+ [🚎12-crh-wfi]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/dep-heads.yml/badge.svg
441
+ [🚎13-🔒️-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/locked_deps.yml
442
+ [🚎13-🔒️-wfi]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/locked_deps.yml/badge.svg
443
+ [🚎14-🔓️-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/unlocked_deps.yml
444
+ [🚎14-🔓️-wfi]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/unlocked_deps.yml/badge.svg
445
+ [🚎15-🪪-wf]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/license-eye.yml
446
+ [🚎15-🪪-wfi]: https://github.com/appraisal-rb/appraisal2-rubocop/actions/workflows/license-eye.yml/badge.svg
447
+ [💎ruby-3.1i]: https://img.shields.io/badge/Ruby-3.1-CC342D?style=for-the-badge&logo=ruby&logoColor=white
448
+ [💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
449
+ [💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
450
+ [💎ruby-3.4i]: https://img.shields.io/badge/Ruby-3.4-CC342D?style=for-the-badge&logo=ruby&logoColor=white
451
+ [💎ruby-4.0i]: https://img.shields.io/badge/Ruby-4.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
452
+ [💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
453
+ [💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
454
+ [💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
455
+ [💎truby-24.2i]: https://img.shields.io/badge/Truffle_Ruby-24.2-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
456
+ [💎truby-25.0i]: https://img.shields.io/badge/Truffle_Ruby-25.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
457
+ [💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
458
+ [💎jruby-9.4i]: https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red
459
+ [💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
460
+ [💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
461
+ [🤝gh-issues]: https://github.com/appraisal-rb/appraisal2-rubocop/issues
462
+ [🤝gh-pulls]: https://github.com/appraisal-rb/appraisal2-rubocop/pulls
463
+ [🤝gl-issues]: https://gitlab.com/appraisal-rb/appraisal2-rubocop/-/issues
464
+ [🤝gl-pulls]: https://gitlab.com/appraisal-rb/appraisal2-rubocop/-/merge_requests
465
+ [🤝cb-issues]: https://codeberg.org/appraisal-rb/appraisal2-rubocop/issues
466
+ [🤝cb-pulls]: https://codeberg.org/appraisal-rb/appraisal2-rubocop/pulls
467
+ [🤝cb-donate]: https://donate.codeberg.org/
468
+ [🤝contributing]: https://github.com/appraisal-rb/appraisal2-rubocop/blob/main/CONTRIBUTING.md
469
+ [🏀codecov-g]: https://codecov.io/gh/appraisal-rb/appraisal2-rubocop/graph/badge.svg
470
+ [🖐contrib-rocks]: https://contrib.rocks
471
+ [🖐contributors]: https://github.com/appraisal-rb/appraisal2-rubocop/graphs/contributors
472
+ [🖐contributors-img]: https://contrib.rocks/image?repo=appraisal-rb/appraisal2-rubocop
473
+ [🚎contributors-gl]: https://gitlab.com/appraisal-rb/appraisal2-rubocop/-/graphs/main
474
+ [🪇conduct]: https://github.com/appraisal-rb/appraisal2-rubocop/blob/main/CODE_OF_CONDUCT.md
475
+ [🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
476
+ [📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
477
+ [📌semver]: https://semver.org/spec/v2.0.0.html
478
+ [📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
479
+ [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
480
+ [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
481
+ [📌changelog]: https://github.com/appraisal-rb/appraisal2-rubocop/blob/main/CHANGELOG.md
482
+ [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
483
+ [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
484
+ [📌gitmoji]: https://gitmoji.dev
485
+ [📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
486
+ [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
487
+ [🧮kloc-img]: https://img.shields.io/badge/KLOC-0.051-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
488
+ [🔐security]: https://github.com/appraisal-rb/appraisal2-rubocop/blob/main/SECURITY.md
489
+ [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
490
+ [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
491
+ [📄license]: LICENSE.md
492
+ [📄license-ref]: MIT.md
493
+ [📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
494
+ [📄license-compat]: https://www.apache.org/legal/resolved.html#category-a
495
+ [📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-✓-259D6C.svg?style=flat&logo=Apache
496
+
497
+ [📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
498
+ [📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
499
+ [🚎yard-current]: http://rubydoc.info/gems/appraisal2-rubocop
500
+ [🚎yard-head]: https://appraisal2-rubocop.galtzo.com
501
+ [💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
502
+ [💎SHA_checksums]: https://gitlab.com/appraisal-rb/appraisal2-rubocop/-/tree/main/checksums
503
+ [💎rlts]: https://github.com/rubocop-lts/rubocop-lts
504
+ [💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
505
+ [💎appraisal2]: https://github.com/appraisal-rb/appraisal2
506
+ [💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
507
+ [💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
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
+ | 0.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-----