nomono 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 +0 -0
- data/CHANGELOG.md +40 -0
- data/CITATION.cff +20 -0
- data/CODE_OF_CONDUCT.md +155 -0
- data/CONTRIBUTING.md +227 -0
- data/FUNDING.md +74 -0
- data/LICENSE.txt +21 -0
- data/README.md +569 -0
- data/REEK +0 -0
- data/RUBOCOP.md +71 -0
- data/SECURITY.md +21 -0
- data/lib/nomono/bundler.rb +5 -0
- data/lib/nomono/dsl.rb +15 -0
- data/lib/nomono/resolver.rb +101 -0
- data/lib/nomono/version.rb +8 -0
- data/lib/nomono.rb +33 -0
- data/sig/nomono.rbs +4 -0
- data.tar.gz.sig +0 -0
- metadata +311 -0
- metadata.gz.sig +2 -0
data/README.md
ADDED
|
@@ -0,0 +1,569 @@
|
|
|
1
|
+
[![Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0][🖼️galtzo-i]][🖼️galtzo-discord] [![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]
|
|
2
|
+
|
|
3
|
+
[🖼️galtzo-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-192px.svg
|
|
4
|
+
[🖼️galtzo-discord]: https://discord.gg/3qme4XHNKN
|
|
5
|
+
[🖼️ruby-lang-i]: https://logos.galtzo.com/assets/images/ruby-lang/avatar-192px.svg
|
|
6
|
+
[🖼️ruby-lang]: https://www.ruby-lang.org/
|
|
7
|
+
[🖼️kettle-rb-i]: https://logos.galtzo.com/assets/images/kettle-rb/avatar-192px.svg
|
|
8
|
+
[🖼️kettle-rb]: https://github.com/kettle-rb
|
|
9
|
+
|
|
10
|
+
# 🍲 Nomono
|
|
11
|
+
|
|
12
|
+
[![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license-ref] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![Open Source Helpers][👽oss-helpi]][👽oss-help] [![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] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
|
|
13
|
+
|
|
14
|
+
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][🖼️galtzo-discord], as I may have missed the [discord notification][🖼️galtzo-discord].
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
`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.
|
|
19
|
+
|
|
20
|
+
[![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]
|
|
21
|
+
|
|
22
|
+
<details>
|
|
23
|
+
<summary>👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️</summary>
|
|
24
|
+
|
|
25
|
+
I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).
|
|
26
|
+
|
|
27
|
+
</details>
|
|
28
|
+
|
|
29
|
+
## 🌻 Synopsis
|
|
30
|
+
|
|
31
|
+
`nomono` standardizes local sibling-gem dependency loading for multi-repo setups.
|
|
32
|
+
|
|
33
|
+
It provides two Gemfile macros:
|
|
34
|
+
|
|
35
|
+
- `nomono_gems(**opts)` returns `{ gem_name => absolute_path }`
|
|
36
|
+
- `eval_nomono_gems(**opts)` directly emits `gem "name", path: "..."`
|
|
37
|
+
|
|
38
|
+
The API mirrors existing `*_local.gemfile` patterns used in kettle-rb projects, but centralizes path/env logic in one reusable library.
|
|
39
|
+
|
|
40
|
+
## 💡 Info you can shake a stick at
|
|
41
|
+
|
|
42
|
+
| Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
|
|
43
|
+
|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
44
|
+
| Works with JRuby | [![JRuby current Compat][💎jruby-c-i]][🚎10-j-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf]|
|
|
45
|
+
| Works with Truffle Ruby | [![Truffle Ruby 23.2 Compat][💎truby-23.2i]][🚎truby-23.2-wf] [![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]|
|
|
46
|
+
| 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]|
|
|
47
|
+
| 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]|
|
|
48
|
+
| 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] |
|
|
49
|
+
| 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] |
|
|
50
|
+
| 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] |
|
|
51
|
+
| Compliance | [![License: MIT][📄license-img]][📄license-ref] [![Compatible with Apache Software Projects: Verified by SkyWalking Eyes][📄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] |
|
|
52
|
+
| 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] |
|
|
53
|
+
| 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] |
|
|
54
|
+
| `...` 💖 | [![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] |
|
|
55
|
+
|
|
56
|
+
### Compatibility
|
|
57
|
+
|
|
58
|
+
Compatible with MRI Ruby 3.2.0+, and concordant releases of JRuby, and TruffleRuby.
|
|
59
|
+
|
|
60
|
+
| 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
|
|
61
|
+
|------------------------------------------------|--------------------------------------------------------|
|
|
62
|
+
| 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
|
|
63
|
+
|
|
64
|
+
### Federated DVCS
|
|
65
|
+
|
|
66
|
+
<details markdown="1">
|
|
67
|
+
<summary>Find this repo on federated forges (Coming soon!)</summary>
|
|
68
|
+
|
|
69
|
+
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
|
|
70
|
+
|-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
|
|
71
|
+
| 🧪 [kettle-rb/nomono on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ |
|
|
72
|
+
| 🧊 [kettle-rb/nomono on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
|
|
73
|
+
| 🐙 [kettle-rb/nomono on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
|
|
74
|
+
| 🎮️ [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] |
|
|
75
|
+
|
|
76
|
+
</details>
|
|
77
|
+
|
|
78
|
+
[gh-discussions]: https://github.com/kettle-rb/nomono/discussions
|
|
79
|
+
|
|
80
|
+
### Enterprise Support [](https://tidelift.com/subscription/pkg/rubygems-nomono?utm_source=rubygems-nomono&utm_medium=referral&utm_campaign=readme)
|
|
81
|
+
|
|
82
|
+
Available as part of the Tidelift Subscription.
|
|
83
|
+
|
|
84
|
+
<details markdown="1">
|
|
85
|
+
<summary>Need enterprise-level guarantees?</summary>
|
|
86
|
+
|
|
87
|
+
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.
|
|
88
|
+
|
|
89
|
+
[![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
|
|
90
|
+
|
|
91
|
+
- 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies
|
|
92
|
+
- 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
|
|
93
|
+
- 💡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
|
|
94
|
+
|
|
95
|
+
Alternatively:
|
|
96
|
+
|
|
97
|
+
- [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
98
|
+
- [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork]
|
|
99
|
+
- [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor]
|
|
100
|
+
|
|
101
|
+
</details>
|
|
102
|
+
|
|
103
|
+
## ✨ Installation
|
|
104
|
+
|
|
105
|
+
Install the gem and add to the application's Gemfile by executing:
|
|
106
|
+
|
|
107
|
+
```console
|
|
108
|
+
bundle add nomono
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
If bundler is not being used to manage dependencies, install the gem by executing:
|
|
112
|
+
|
|
113
|
+
```console
|
|
114
|
+
gem install nomono
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### 🔒 Secure Installation
|
|
118
|
+
|
|
119
|
+
<details markdown="1">
|
|
120
|
+
<summary>For Medium or High Security Installations</summary>
|
|
121
|
+
|
|
122
|
+
This gem is cryptographically signed and has verifiable [SHA-256 and SHA-512][💎SHA_checksums] checksums by
|
|
123
|
+
[stone_checksums][💎stone_checksums]. Be sure the gem you install hasn’t been tampered with
|
|
124
|
+
by following the instructions below.
|
|
125
|
+
|
|
126
|
+
Add my public key (if you haven’t already; key expires 2045-04-29) as a trusted certificate:
|
|
127
|
+
|
|
128
|
+
```console
|
|
129
|
+
gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
You only need to do that once. Then proceed to install with:
|
|
133
|
+
|
|
134
|
+
```console
|
|
135
|
+
gem install nomono -P HighSecurity
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
The `HighSecurity` trust profile will verify signed gems, and not allow the installation of unsigned dependencies.
|
|
139
|
+
|
|
140
|
+
If you want to up your security game full-time:
|
|
141
|
+
|
|
142
|
+
```console
|
|
143
|
+
bundle config set --global trust-policy MediumSecurity
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
`MediumSecurity` instead of `HighSecurity` is necessary if not all the gems you use are signed.
|
|
147
|
+
|
|
148
|
+
NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
|
|
149
|
+
|
|
150
|
+
</details>
|
|
151
|
+
|
|
152
|
+
## ⚙️ Configuration
|
|
153
|
+
|
|
154
|
+
Nomono has an *environment contract*. By default (`prefix: "NOMONO_GEMS"`):
|
|
155
|
+
|
|
156
|
+
- `NOMONO_GEMS_DEV` controls local mode (`false` disables; `true` uses `~/src/kettle-rb`; any other value is a path)
|
|
157
|
+
- `NOMONO_GEMS_VENDORED_GEMS` (or legacy `VENDORED_GEMS`) is a comma-delimited list of gems resolved from vendor dir
|
|
158
|
+
- `NOMONO_GEMS_VENDOR_GEM_DIR` (or legacy `VENDOR_GEM_DIR`) points at the vendor base path
|
|
159
|
+
- `NOMONO_GEMS_DEBUG` enables debug output
|
|
160
|
+
|
|
161
|
+
Override env variable names with options:
|
|
162
|
+
|
|
163
|
+
```ruby
|
|
164
|
+
nomono_gems(
|
|
165
|
+
gems: %w[rubocop-lts rubocop-ruby3_2],
|
|
166
|
+
prefix: "RUBOCOP_LTS",
|
|
167
|
+
path_env: "RUBOCOP_LTS_LOCAL",
|
|
168
|
+
vendored_gems_env: "VENDORED_GEMS",
|
|
169
|
+
vendor_gem_dir_env: "VENDOR_GEM_DIR",
|
|
170
|
+
debug_env: "RUBOCOP_LTS_DEBUG",
|
|
171
|
+
)
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## 🔧 Basic Usage
|
|
175
|
+
|
|
176
|
+
In your Gemfile (or a modular Gemfile loaded via `eval_gemfile`):
|
|
177
|
+
|
|
178
|
+
```ruby
|
|
179
|
+
require "nomono/bundler"
|
|
180
|
+
|
|
181
|
+
local_gems = %w[
|
|
182
|
+
kettle-dev
|
|
183
|
+
kettle-test
|
|
184
|
+
kettle-soup-cover
|
|
185
|
+
]
|
|
186
|
+
|
|
187
|
+
if ENV.fetch("KETTLE_RB_DEV", "false").casecmp("false").zero?
|
|
188
|
+
# remote/released gems
|
|
189
|
+
gem "kettle-soup-cover", require: false
|
|
190
|
+
else
|
|
191
|
+
eval_nomono_gems(gems: local_gems, prefix: "KETTLE_RB")
|
|
192
|
+
end
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
## 🦷 FLOSS Funding
|
|
196
|
+
|
|
197
|
+
While kettle-rb tools are free software and will always be, the project would benefit immensely from some funding.
|
|
198
|
+
Raising a monthly budget of... "dollars" would make the project more sustainable.
|
|
199
|
+
|
|
200
|
+
We welcome both individual and corporate sponsors! We also offer a
|
|
201
|
+
wide array of funding channels to account for your preferences
|
|
202
|
+
(although currently [Open Collective][🖇osc] is our preferred funding platform).
|
|
203
|
+
|
|
204
|
+
**If you're working in a company that's making significant use of kettle-rb tools we'd
|
|
205
|
+
appreciate it if you suggest to your company to become a kettle-rb sponsor.**
|
|
206
|
+
|
|
207
|
+
You can support the development of kettle-rb tools via
|
|
208
|
+
[GitHub Sponsors][🖇sponsor],
|
|
209
|
+
[Liberapay][⛳liberapay],
|
|
210
|
+
[PayPal][🖇paypal],
|
|
211
|
+
[Open Collective][🖇osc]
|
|
212
|
+
and [Tidelift][🏙️entsup-tidelift].
|
|
213
|
+
|
|
214
|
+
| 📍 NOTE |
|
|
215
|
+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
216
|
+
| 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. |
|
|
217
|
+
|
|
218
|
+
### Open Collective for Individuals
|
|
219
|
+
|
|
220
|
+
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/kettle-rb#backer)]
|
|
221
|
+
|
|
222
|
+
NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
|
|
223
|
+
|
|
224
|
+
<!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
|
|
225
|
+
No backers yet. Be the first!
|
|
226
|
+
<!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
|
|
227
|
+
|
|
228
|
+
### Open Collective for Organizations
|
|
229
|
+
|
|
230
|
+
Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/kettle-rb#sponsor)]
|
|
231
|
+
|
|
232
|
+
NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
|
|
233
|
+
|
|
234
|
+
<!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
|
|
235
|
+
No sponsors yet. Be the first!
|
|
236
|
+
<!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
|
|
237
|
+
|
|
238
|
+
[kettle-readme-backers]: https://github.com/kettle-rb/nomono/blob/main/exe/kettle-readme-backers
|
|
239
|
+
|
|
240
|
+
### Another way to support open-source
|
|
241
|
+
|
|
242
|
+
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).
|
|
243
|
+
|
|
244
|
+
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`.
|
|
245
|
+
|
|
246
|
+
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.
|
|
247
|
+
|
|
248
|
+
**[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
|
|
249
|
+
|
|
250
|
+
[![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]
|
|
251
|
+
|
|
252
|
+
## 🔐 Security
|
|
253
|
+
|
|
254
|
+
See [SECURITY.md][🔐security].
|
|
255
|
+
|
|
256
|
+
## 🤝 Contributing
|
|
257
|
+
|
|
258
|
+
If you need some ideas of where to help, you could work on adding more code coverage,
|
|
259
|
+
or if it is already 💯 (see [below](#code-coverage)) check [reek](REEK), [issues][🤝gh-issues], or [PRs][🤝gh-pulls],
|
|
260
|
+
or use the gem and think about how it could be better.
|
|
261
|
+
|
|
262
|
+
We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
|
|
263
|
+
|
|
264
|
+
See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
|
|
265
|
+
|
|
266
|
+
### 🚀 Release Instructions
|
|
267
|
+
|
|
268
|
+
See [CONTRIBUTING.md][🤝contributing].
|
|
269
|
+
|
|
270
|
+
### Code Coverage
|
|
271
|
+
|
|
272
|
+
[![Coverage Graph][🏀codecov-g]][🏀codecov]
|
|
273
|
+
|
|
274
|
+
[![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
|
|
275
|
+
|
|
276
|
+
[![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
|
|
277
|
+
|
|
278
|
+
### 🪇 Code of Conduct
|
|
279
|
+
|
|
280
|
+
Everyone interacting with this project's codebases, issue trackers,
|
|
281
|
+
chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
|
|
282
|
+
|
|
283
|
+
## 🌈 Contributors
|
|
284
|
+
|
|
285
|
+
[![Contributors][🖐contributors-img]][🖐contributors]
|
|
286
|
+
|
|
287
|
+
Made with [contributors-img][🖐contrib-rocks].
|
|
288
|
+
|
|
289
|
+
Also see GitLab Contributors: [https://gitlab.com/kettle-rb/nomono/-/graphs/main][🚎contributors-gl]
|
|
290
|
+
|
|
291
|
+
<details>
|
|
292
|
+
<summary>⭐️ Star History</summary>
|
|
293
|
+
|
|
294
|
+
<a href="https://star-history.com/#kettle-rb/nomono&Date">
|
|
295
|
+
<picture>
|
|
296
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=kettle-rb/nomono&type=Date&theme=dark" />
|
|
297
|
+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=kettle-rb/nomono&type=Date" />
|
|
298
|
+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=kettle-rb/nomono&type=Date" />
|
|
299
|
+
</picture>
|
|
300
|
+
</a>
|
|
301
|
+
|
|
302
|
+
</details>
|
|
303
|
+
|
|
304
|
+
## 📌 Versioning
|
|
305
|
+
|
|
306
|
+
This Library adheres to [![Semantic Versioning 2.0.0][📌semver-img]][📌semver].
|
|
307
|
+
Violations of this scheme should be reported as bugs.
|
|
308
|
+
Specifically, if a minor or patch version is released that breaks backward compatibility,
|
|
309
|
+
a new version should be immediately released that restores compatibility.
|
|
310
|
+
Breaking changes to the public API will only be introduced with new major versions.
|
|
311
|
+
|
|
312
|
+
> dropping support for a platform is both obviously and objectively a breaking change <br/>
|
|
313
|
+
>—Jordan Harband ([@ljharb](https://github.com/ljharb), maintainer of SemVer) [in SemVer issue 716][📌semver-breaking]
|
|
314
|
+
|
|
315
|
+
I understand that policy doesn't work universally ("exceptions to every rule!"),
|
|
316
|
+
but it is the policy here.
|
|
317
|
+
As such, in many cases it is good to specify a dependency on this library using
|
|
318
|
+
the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
|
|
319
|
+
|
|
320
|
+
For example:
|
|
321
|
+
|
|
322
|
+
```ruby
|
|
323
|
+
spec.add_dependency("nomono", "~> 1.0")
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
<details markdown="1">
|
|
327
|
+
<summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
|
|
328
|
+
|
|
329
|
+
SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms
|
|
330
|
+
is a *breaking change* to an API, and for that reason the bike shedding is endless.
|
|
331
|
+
|
|
332
|
+
To get a better understanding of how SemVer is intended to work over a project's lifetime,
|
|
333
|
+
read this article from the creator of SemVer:
|
|
334
|
+
|
|
335
|
+
- ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
|
|
336
|
+
|
|
337
|
+
</details>
|
|
338
|
+
|
|
339
|
+
See [CHANGELOG.md][📌changelog] for a list of releases.
|
|
340
|
+
|
|
341
|
+
## 📄 License
|
|
342
|
+
|
|
343
|
+
The gem is available as open source under the terms of
|
|
344
|
+
the [MIT License][📄license] [![License: MIT][📄license-img]][📄license-ref].
|
|
345
|
+
See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright-notice-explainer].
|
|
346
|
+
|
|
347
|
+
### © Copyright
|
|
348
|
+
|
|
349
|
+
<ul>
|
|
350
|
+
<li>
|
|
351
|
+
Copyright (c) 2026 Peter H. Boling, of
|
|
352
|
+
<a href="https://discord.gg/3qme4XHNKN">
|
|
353
|
+
Galtzo.com
|
|
354
|
+
<picture>
|
|
355
|
+
<img src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px-blank.svg" alt="Galtzo.com Logo (Wordless) by Aboling0, CC BY-SA 4.0" width="24">
|
|
356
|
+
</picture>
|
|
357
|
+
</a>, and nomono contributors.
|
|
358
|
+
</li>
|
|
359
|
+
</ul>
|
|
360
|
+
|
|
361
|
+
## 🤑 A request for help
|
|
362
|
+
|
|
363
|
+
Maintainers have teeth and need to pay their dentists.
|
|
364
|
+
After getting laid off in an RIF in March, and encountering difficulty finding a new one,
|
|
365
|
+
I began spending most of my time building open source tools.
|
|
366
|
+
I'm hoping to be able to pay for my kids' health insurance this month,
|
|
367
|
+
so if you value the work I am doing, I need your support.
|
|
368
|
+
Please consider sponsoring me or the project.
|
|
369
|
+
|
|
370
|
+
To join the community or get help 👇️ Join the Discord.
|
|
371
|
+
|
|
372
|
+
[![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
373
|
+
|
|
374
|
+
To say "thanks!" ☝️ Join the Discord or 👇️ send money.
|
|
375
|
+
|
|
376
|
+
[![Sponsor kettle-rb/nomono 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]
|
|
377
|
+
|
|
378
|
+
### Please give the project a star ⭐ ♥.
|
|
379
|
+
|
|
380
|
+
Thanks for RTFM. ☺️
|
|
381
|
+
|
|
382
|
+
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
|
|
383
|
+
[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
|
|
384
|
+
[⛳liberapay]: https://liberapay.com/pboling/donate
|
|
385
|
+
[🖇osc-all-img]: https://img.shields.io/opencollective/all/kettle-rb
|
|
386
|
+
[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/kettle-rb
|
|
387
|
+
[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/kettle-rb
|
|
388
|
+
[🖇osc-backers]: https://opencollective.com/kettle-rb#backer
|
|
389
|
+
[🖇osc-backers-i]: https://opencollective.com/kettle-rb/backers/badge.svg?style=flat
|
|
390
|
+
[🖇osc-sponsors]: https://opencollective.com/kettle-rb#sponsor
|
|
391
|
+
[🖇osc-sponsors-i]: https://opencollective.com/kettle-rb/sponsors/badge.svg?style=flat
|
|
392
|
+
[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/kettle-rb?style=for-the-badge
|
|
393
|
+
[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/kettle-rb?style=for-the-badge
|
|
394
|
+
[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/kettle-rb?style=for-the-badge
|
|
395
|
+
[🖇osc]: https://opencollective.com/kettle-rb
|
|
396
|
+
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
|
|
397
|
+
[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
|
|
398
|
+
[🖇sponsor]: https://github.com/sponsors/pboling
|
|
399
|
+
[🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
|
|
400
|
+
[🖇polar]: https://polar.sh/pboling
|
|
401
|
+
[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
|
|
402
|
+
[🖇kofi]: https://ko-fi.com/pboling
|
|
403
|
+
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
|
|
404
|
+
[🖇patreon]: https://patreon.com/galtzo
|
|
405
|
+
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
|
|
406
|
+
[🖇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
|
|
407
|
+
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
|
408
|
+
[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
|
|
409
|
+
[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
|
|
410
|
+
[🖇paypal]: https://www.paypal.com/paypalme/peterboling
|
|
411
|
+
[🖇floss-funding.dev]: https://floss-funding.dev
|
|
412
|
+
[🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
|
|
413
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
|
414
|
+
[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
|
|
415
|
+
[✉️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
|
|
416
|
+
[✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
|
|
417
|
+
|
|
418
|
+
[✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
|
|
419
|
+
[⛳️gem-namespace]: https://github.com/kettle-rb/nomono
|
|
420
|
+
[⛳️namespace-img]: https://img.shields.io/badge/namespace-Nomono-3C2D2D.svg?style=square&logo=ruby&logoColor=white
|
|
421
|
+
[⛳️gem-name]: https://bestgems.org/gems/nomono
|
|
422
|
+
[⛳️name-img]: https://img.shields.io/badge/name-nomono-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
|
|
423
|
+
[⛳️tag-img]: https://img.shields.io/github/tag/kettle-rb/nomono.svg
|
|
424
|
+
[⛳️tag]: http://github.com/kettle-rb/nomono/releases
|
|
425
|
+
[🚂maint-blog]: http://www.railsbling.com/tags/nomono
|
|
426
|
+
[🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
|
|
427
|
+
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
428
|
+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
|
429
|
+
[💖🖇linkedin]: http://www.linkedin.com/in/peterboling
|
|
430
|
+
[💖🖇linkedin-img]: https://img.shields.io/badge/LinkedIn-Profile-0B66C2?style=flat&logo=newjapanprowrestling
|
|
431
|
+
[💖✌️wellfound]: https://wellfound.com/u/peter-boling
|
|
432
|
+
[💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
|
|
433
|
+
[💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
|
|
434
|
+
[💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
|
|
435
|
+
[💖🐘ruby-mast]: https://ruby.social/@galtzo
|
|
436
|
+
[💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@galtzo
|
|
437
|
+
[💖🦋bluesky]: https://bsky.app/profile/galtzo.com
|
|
438
|
+
[💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
|
|
439
|
+
[💖🌳linktree]: https://linktr.ee/galtzo
|
|
440
|
+
[💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
|
|
441
|
+
[💖💁🏼♂️devto]: https://dev.to/galtzo
|
|
442
|
+
[💖💁🏼♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
|
|
443
|
+
[💖💁🏼♂️aboutme]: https://about.me/peter.boling
|
|
444
|
+
[💖💁🏼♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
|
|
445
|
+
[💖🧊berg]: https://codeberg.org/pboling
|
|
446
|
+
[💖🐙hub]: https://github.org/pboling
|
|
447
|
+
[💖🛖hut]: https://sr.ht/~galtzo/
|
|
448
|
+
[💖🧪lab]: https://gitlab.com/pboling
|
|
449
|
+
[👨🏼🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
|
|
450
|
+
[👨🏼🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
|
|
451
|
+
[👨🏼🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
|
|
452
|
+
[👨🏼🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
|
|
453
|
+
[🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-nomono?utm_source=rubygems-nomono&utm_medium=referral&utm_campaign=readme
|
|
454
|
+
[🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
|
|
455
|
+
[🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
|
|
456
|
+
[💁🏼♂️peterboling]: http://www.peterboling.com
|
|
457
|
+
[🚂railsbling]: http://www.railsbling.com
|
|
458
|
+
[📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
|
|
459
|
+
[📜src-gl]: https://gitlab.com/kettle-rb/nomono/
|
|
460
|
+
[📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
|
|
461
|
+
[📜src-cb]: https://codeberg.org/kettle-rb/nomono
|
|
462
|
+
[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
|
|
463
|
+
[📜src-gh]: https://github.com/kettle-rb/nomono
|
|
464
|
+
[📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
465
|
+
[📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
466
|
+
[📜gl-wiki]: https://gitlab.com/kettle-rb/nomono/-/wikis/home
|
|
467
|
+
[📜gh-wiki]: https://github.com/kettle-rb/nomono/wiki
|
|
468
|
+
[📜gl-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
|
|
469
|
+
[📜gh-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
|
|
470
|
+
[👽dl-rank]: https://bestgems.org/gems/nomono
|
|
471
|
+
[👽dl-ranki]: https://img.shields.io/gem/rd/nomono.svg
|
|
472
|
+
[👽oss-help]: https://www.codetriage.com/kettle-rb/nomono
|
|
473
|
+
[👽oss-helpi]: https://www.codetriage.com/kettle-rb/nomono/badges/users.svg
|
|
474
|
+
[👽version]: https://bestgems.org/gems/nomono
|
|
475
|
+
[👽versioni]: https://img.shields.io/gem/v/nomono.svg
|
|
476
|
+
[🏀qlty-mnt]: https://qlty.sh/gh/kettle-rb/projects/nomono
|
|
477
|
+
[🏀qlty-mnti]: https://qlty.sh/gh/kettle-rb/projects/nomono/maintainability.svg
|
|
478
|
+
[🏀qlty-cov]: https://qlty.sh/gh/kettle-rb/projects/nomono/metrics/code?sort=coverageRating
|
|
479
|
+
[🏀qlty-covi]: https://qlty.sh/gh/kettle-rb/projects/nomono/coverage.svg
|
|
480
|
+
[🏀codecov]: https://codecov.io/gh/kettle-rb/nomono
|
|
481
|
+
[🏀codecovi]: https://codecov.io/gh/kettle-rb/nomono/graph/badge.svg
|
|
482
|
+
[🏀coveralls]: https://coveralls.io/github/kettle-rb/nomono?branch=main
|
|
483
|
+
[🏀coveralls-img]: https://coveralls.io/repos/github/kettle-rb/nomono/badge.svg?branch=main
|
|
484
|
+
[🖐codeQL]: https://github.com/kettle-rb/nomono/security/code-scanning
|
|
485
|
+
[🖐codeQL-img]: https://github.com/kettle-rb/nomono/actions/workflows/codeql-analysis.yml/badge.svg
|
|
486
|
+
[🚎ruby-3.2-wf]: https://github.com/kettle-rb/nomono/actions/workflows/ruby-3.2.yml
|
|
487
|
+
[🚎ruby-3.3-wf]: https://github.com/kettle-rb/nomono/actions/workflows/ruby-3.3.yml
|
|
488
|
+
[🚎ruby-3.4-wf]: https://github.com/kettle-rb/nomono/actions/workflows/ruby-3.4.yml
|
|
489
|
+
[🚎truby-23.2-wf]: https://github.com/kettle-rb/nomono/actions/workflows/truffleruby-23.2.yml
|
|
490
|
+
[🚎truby-24.2-wf]: https://github.com/kettle-rb/nomono/actions/workflows/truffleruby-24.2.yml
|
|
491
|
+
[🚎truby-25.0-wf]: https://github.com/kettle-rb/nomono/actions/workflows/truffleruby-25.0.yml
|
|
492
|
+
[🚎2-cov-wf]: https://github.com/kettle-rb/nomono/actions/workflows/coverage.yml
|
|
493
|
+
[🚎2-cov-wfi]: https://github.com/kettle-rb/nomono/actions/workflows/coverage.yml/badge.svg
|
|
494
|
+
[🚎3-hd-wf]: https://github.com/kettle-rb/nomono/actions/workflows/heads.yml
|
|
495
|
+
[🚎3-hd-wfi]: https://github.com/kettle-rb/nomono/actions/workflows/heads.yml/badge.svg
|
|
496
|
+
[🚎5-st-wf]: https://github.com/kettle-rb/nomono/actions/workflows/style.yml
|
|
497
|
+
[🚎5-st-wfi]: https://github.com/kettle-rb/nomono/actions/workflows/style.yml/badge.svg
|
|
498
|
+
[🚎9-t-wf]: https://github.com/kettle-rb/nomono/actions/workflows/truffle.yml
|
|
499
|
+
[🚎9-t-wfi]: https://github.com/kettle-rb/nomono/actions/workflows/truffle.yml/badge.svg
|
|
500
|
+
[🚎10-j-wf]: https://github.com/kettle-rb/nomono/actions/workflows/jruby.yml
|
|
501
|
+
[🚎10-j-wfi]: https://github.com/kettle-rb/nomono/actions/workflows/jruby.yml/badge.svg
|
|
502
|
+
[🚎11-c-wf]: https://github.com/kettle-rb/nomono/actions/workflows/current.yml
|
|
503
|
+
[🚎11-c-wfi]: https://github.com/kettle-rb/nomono/actions/workflows/current.yml/badge.svg
|
|
504
|
+
[🚎12-crh-wf]: https://github.com/kettle-rb/nomono/actions/workflows/dep-heads.yml
|
|
505
|
+
[🚎12-crh-wfi]: https://github.com/kettle-rb/nomono/actions/workflows/dep-heads.yml/badge.svg
|
|
506
|
+
[🚎13-🔒️-wf]: https://github.com/kettle-rb/nomono/actions/workflows/locked_deps.yml
|
|
507
|
+
[🚎13-🔒️-wfi]: https://github.com/kettle-rb/nomono/actions/workflows/locked_deps.yml/badge.svg
|
|
508
|
+
[🚎14-🔓️-wf]: https://github.com/kettle-rb/nomono/actions/workflows/unlocked_deps.yml
|
|
509
|
+
[🚎14-🔓️-wfi]: https://github.com/kettle-rb/nomono/actions/workflows/unlocked_deps.yml/badge.svg
|
|
510
|
+
[🚎15-🪪-wf]: https://github.com/kettle-rb/nomono/actions/workflows/license-eye.yml
|
|
511
|
+
[🚎15-🪪-wfi]: https://github.com/kettle-rb/nomono/actions/workflows/license-eye.yml/badge.svg
|
|
512
|
+
[💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
513
|
+
[💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
514
|
+
[💎ruby-3.4i]: https://img.shields.io/badge/Ruby-3.4-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
515
|
+
[💎ruby-4.0i]: https://img.shields.io/badge/Ruby-4.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
516
|
+
[💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
|
|
517
|
+
[💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
|
|
518
|
+
[💎truby-23.2i]: https://img.shields.io/badge/Truffle_Ruby-23.2-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
|
|
519
|
+
[💎truby-24.2i]: https://img.shields.io/badge/Truffle_Ruby-24.2-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
|
|
520
|
+
[💎truby-25.0i]: https://img.shields.io/badge/Truffle_Ruby-25.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
|
|
521
|
+
[💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
|
|
522
|
+
[💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
|
|
523
|
+
[💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
|
|
524
|
+
[🤝gh-issues]: https://github.com/kettle-rb/nomono/issues
|
|
525
|
+
[🤝gh-pulls]: https://github.com/kettle-rb/nomono/pulls
|
|
526
|
+
[🤝gl-issues]: https://gitlab.com/kettle-rb/nomono/-/issues
|
|
527
|
+
[🤝gl-pulls]: https://gitlab.com/kettle-rb/nomono/-/merge_requests
|
|
528
|
+
[🤝cb-issues]: https://codeberg.org/kettle-rb/nomono/issues
|
|
529
|
+
[🤝cb-pulls]: https://codeberg.org/kettle-rb/nomono/pulls
|
|
530
|
+
[🤝cb-donate]: https://donate.codeberg.org/
|
|
531
|
+
[🤝contributing]: CONTRIBUTING.md
|
|
532
|
+
[🏀codecov-g]: https://codecov.io/gh/kettle-rb/nomono/graphs/tree.svg
|
|
533
|
+
[🖐contrib-rocks]: https://contrib.rocks
|
|
534
|
+
[🖐contributors]: https://github.com/kettle-rb/nomono/graphs/contributors
|
|
535
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=kettle-rb/nomono
|
|
536
|
+
[🚎contributors-gl]: https://gitlab.com/kettle-rb/nomono/-/graphs/main
|
|
537
|
+
[🪇conduct]: CODE_OF_CONDUCT.md
|
|
538
|
+
[🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
|
|
539
|
+
[📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
|
|
540
|
+
[📌semver]: https://semver.org/spec/v2.0.0.html
|
|
541
|
+
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
|
|
542
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
543
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
544
|
+
[📌changelog]: CHANGELOG.md
|
|
545
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
546
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
|
|
547
|
+
[📌gitmoji]: https://gitmoji.dev
|
|
548
|
+
[📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
|
|
549
|
+
[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
|
|
550
|
+
[🧮kloc-img]: https://img.shields.io/badge/KLOC-5.053-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
|
|
551
|
+
[🔐security]: SECURITY.md
|
|
552
|
+
[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
|
|
553
|
+
[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
|
|
554
|
+
[📄license]: LICENSE.txt
|
|
555
|
+
[📄license-ref]: https://opensource.org/licenses/MIT
|
|
556
|
+
[📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
|
|
557
|
+
[📄license-compat]: https://dev.to/galtzo/how-to-check-license-compatibility-41h0
|
|
558
|
+
[📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-%E2%9C%93-259D6C.svg?style=flat&logo=Apache
|
|
559
|
+
[📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
|
|
560
|
+
[📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
|
|
561
|
+
[🚎yard-current]: http://rubydoc.info/gems/nomono
|
|
562
|
+
[🚎yard-head]: https://nomono.galtzo.com
|
|
563
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
564
|
+
[💎SHA_checksums]: https://gitlab.com/kettle-rb/nomono/-/tree/main/checksums
|
|
565
|
+
[💎rlts]: https://github.com/rubocop-lts/rubocop-lts
|
|
566
|
+
[💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
567
|
+
[💎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
568
|
+
[💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
569
|
+
[💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
|
data/REEK
ADDED
|
File without changes
|
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
|