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