kettle-soup-cover 1.0.10 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/CHANGELOG.md +135 -5
- data/CITATION.cff +20 -0
- data/LICENSE.txt +1 -1
- data/README.md +549 -162
- data/REEK +0 -0
- data/SECURITY.md +0 -0
- data/exe/kettle-soup-cover +362 -0
- data/lib/kettle/soup/cover/config.rb +10 -3
- data/lib/kettle/soup/cover/constants.rb +24 -8
- data/lib/kettle/soup/cover/version.rb +1 -1
- data/lib/kettle-soup-cover.rb +2 -1
- data/sig/kettle/soup/cover.rbs +5 -5
- data.tar.gz.sig +0 -0
- metadata +55 -110
- metadata.gz.sig +0 -0
data/README.md
CHANGED
|
@@ -1,22 +1,58 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
1
|
+
| 📍 NOTE |
|
|
2
|
+
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
3
|
+
| RubyGems (the [GitHub org][rubygems-org], not the website) [suffered][draper-security] a [hostile takeover][ellen-takeover] in September 2025. |
|
|
4
|
+
| Ultimately [4 maintainers][simi-removed] were [hard removed][martin-removed] and a reason has been given for only 1 of those, while 2 others resigned in protest. |
|
|
5
|
+
| It is a [complicated story][draper-takeover] which is difficult to [parse quickly][draper-lies]. |
|
|
6
|
+
| Simply put - there was active policy for adding or removing maintainers/owners of [rubygems][rubygems-maint-policy] and [bundler][bundler-maint-policy], and those [policies were not followed][policy-fail]. |
|
|
7
|
+
| I'm adding notes like this to gems because I [don't condone theft][draper-theft] of repositories or gems from their rightful owners. |
|
|
8
|
+
| If a similar theft happened with my repos/gems, I'd hope some would stand up for me. |
|
|
9
|
+
| Disenfranchised former-maintainers have started [gem.coop][gem-coop]. |
|
|
10
|
+
| Once available I will publish there exclusively; unless RubyCentral makes amends with the community. |
|
|
11
|
+
| The ["Technology for Humans: Joel Draper"][reinteractive-podcast] podcast episode by [reinteractive][reinteractive] is the most cogent summary I'm aware of. |
|
|
12
|
+
| See [here][gem-naming], [here][gem-coop] and [here][martin-ann] for more info on what comes next. |
|
|
13
|
+
| What I'm doing: A (WIP) proposal for [bundler/gem scopes][gem-scopes], and a (WIP) proposal for a federated [gem server][gem-server]. |
|
|
14
|
+
|
|
15
|
+
[rubygems-org]: https://github.com/rubygems/
|
|
16
|
+
[draper-security]: https://joel.drapper.me/p/ruby-central-security-measures/
|
|
17
|
+
[draper-takeover]: https://joel.drapper.me/p/ruby-central-takeover/
|
|
18
|
+
[ellen-takeover]: https://pup-e.com/blog/goodbye-rubygems/
|
|
19
|
+
[simi-removed]: https://www.reddit.com/r/ruby/s/gOk42POCaV
|
|
20
|
+
[martin-removed]: https://bsky.app/profile/martinemde.com/post/3m3occezxxs2q
|
|
21
|
+
[draper-lies]: https://joel.drapper.me/p/ruby-central-fact-check/
|
|
22
|
+
[draper-theft]: https://joel.drapper.me/p/ruby-central/
|
|
23
|
+
[reinteractive]: https://reinteractive.com/ruby-on-rails
|
|
24
|
+
[gem-coop]: https://gem.coop
|
|
25
|
+
[gem-naming]: https://github.com/gem-coop/gem.coop/issues/12
|
|
26
|
+
[martin-ann]: https://martinemde.com/2025/10/05/announcing-gem-coop.html
|
|
27
|
+
[gem-scopes]: https://github.com/galtzo-floss/bundle-namespace
|
|
28
|
+
[gem-server]: https://github.com/galtzo-floss/gem-server
|
|
29
|
+
[reinteractive-podcast]: https://youtu.be/_H4qbtC5qzU?si=BvuBU90R2wAqD2E6
|
|
30
|
+
[bundler-maint-policy]: https://github.com/ruby/rubygems/blob/b1ab33a3d52310a84d16b193991af07f5a6a07c0/doc/bundler/playbooks/TEAM_CHANGES.md
|
|
31
|
+
[rubygems-maint-policy]: https://github.com/ruby/rubygems/blob/b1ab33a3d52310a84d16b193991af07f5a6a07c0/doc/rubygems/POLICIES.md?plain=1#L187-L196
|
|
32
|
+
[policy-fail]: https://www.reddit.com/r/ruby/comments/1ove9vp/rubycentral_hates_this_one_fact/
|
|
33
|
+
|
|
34
|
+
[![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-soup-cover Logo by Aboling0, CC BY-SA 4.0][🖼️kettle-soup-cover-i]][🖼️kettle-soup-cover]
|
|
35
|
+
|
|
36
|
+
[🖼️galtzo-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-192px.svg
|
|
37
|
+
[🖼️galtzo-discord]: https://discord.gg/3qme4XHNKN
|
|
38
|
+
[🖼️ruby-lang-i]: https://logos.galtzo.com/assets/images/ruby-lang/avatar-192px.svg
|
|
39
|
+
[🖼️ruby-lang]: https://www.ruby-lang.org/
|
|
40
|
+
[🖼️kettle-soup-cover-i]: https://logos.galtzo.com/assets/images/kettle-rb/kettle-soup-cover/avatar-192px.svg
|
|
41
|
+
[🖼️kettle-soup-cover]: https://github.com/kettle-rb/kettle-soup-cover
|
|
12
42
|
|
|
13
43
|
# 🥘 Kettle::Soup::Cover
|
|
14
44
|
|
|
15
|
-
[![Version][👽versioni]][👽version] [![License: MIT][📄license-img]][📄license-ref] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![Open Source Helpers][👽oss-helpi]][👽oss-help] [![
|
|
45
|
+
[![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 Supported][🚎6-s-wfi]][🚎6-s-wf] [![CI Legacy][🚎4-lg-wfi]][🚎4-lg-wf] [![CI Unsupported][🚎7-us-wfi]][🚎7-us-wf] [![CI Ancient][🚎1-an-wfi]][🚎1-an-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]
|
|
46
|
+
|
|
47
|
+
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][🖼️galtzo-discord], as I may have missed the [discord notification][🖼️galtzo-discord].
|
|
16
48
|
|
|
17
49
|
---
|
|
18
50
|
|
|
19
|
-
|
|
51
|
+
`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.
|
|
52
|
+
|
|
53
|
+
[![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]
|
|
54
|
+
|
|
55
|
+
## 🌻 Synopsis
|
|
20
56
|
|
|
21
57
|
Four lines of code to get a configured, curated, opinionated, set of dependencies for Test Coverage, and that's *including* the two lines for `require "simplecov"`, and `SimpleCov.start`.
|
|
22
58
|
|
|
@@ -28,19 +64,35 @@ For apps and libraries. Any test framework. Many code coverage related GitHub
|
|
|
28
64
|
| MiniTest | [test helper][mini-helper] | [.simplecov][mini-simplecov] |
|
|
29
65
|
| RSpec | [spec helper][rpsec-helper] | [.simplecov][rspec-simplecov] |
|
|
30
66
|
|
|
31
|
-
[mini-helper]: https://github.com/pboling/
|
|
32
|
-
[mini-simplecov]: https://github.com/pboling/
|
|
67
|
+
[mini-helper]: https://github.com/pboling/kettle-soup-cover/blob/master/tests/test_kettle-soup-cover.rb
|
|
68
|
+
[mini-simplecov]: https://github.com/pboling/kettle-soup-cover/blob/master/.simplecov
|
|
33
69
|
[rpsec-helper]: https://github.com/oauth-xx/oauth2/blob/main/spec/spec_helper.rb
|
|
34
70
|
[rspec-simplecov]: https://github.com/oauth-xx/oauth2/blob/main/.simplecov
|
|
35
71
|
|
|
36
|
-
|
|
37
|
-
|--------------------------------------------------------|-------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
|
|
38
|
-
| 🧪 [kettle-rb/kettle-soup-cover on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜wiki] | 🏀 Tiny Matrix | ➖ |
|
|
39
|
-
| 🧊 [kettle-rb/kettle-soup-cover on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | ➖ | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
|
|
40
|
-
| 🐙 [kettle-rb/kettle-soup-cover on GitHub][📜src-gh] | A Dirty Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | ➖ | 💯 Full Matrix | [💚][gh-discussions] |
|
|
41
|
-
| 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
|
|
72
|
+
### 📔 DO YOU LIKE PATTERNS?!? 📔
|
|
42
73
|
|
|
43
|
-
|
|
74
|
+
This library's local dev / testing / CI dependency structure serves as an example of a "modular gemfile" pattern
|
|
75
|
+
enabling a discrete gemfile for each CI workflow.
|
|
76
|
+
|
|
77
|
+
<details>
|
|
78
|
+
<summary>What is a modular gemfile?</summary>
|
|
79
|
+
|
|
80
|
+
This modular pattern has the following benefits:
|
|
81
|
+
|
|
82
|
+
- All dependencies are DRY, never repeated.
|
|
83
|
+
- All modular gemfiles are shared between the main `Gemfile`, and the workflow `gemfiles/*.gemfile`s that need them.
|
|
84
|
+
- All gemfiles source from the `gemspec`.
|
|
85
|
+
|
|
86
|
+
If you like this idea, there is an even better alternative.
|
|
87
|
+
|
|
88
|
+
I've codified it for reuse in my [appraisal2](https://github.com/appraisal-rb/appraisal2/) gem,
|
|
89
|
+
which is a hard fork of the venerable `appraisal` gem due to that gem's lack of support for modular gemfiles.
|
|
90
|
+
|
|
91
|
+
</details>
|
|
92
|
+
|
|
93
|
+
📔 ME TOO! 📔
|
|
94
|
+
|
|
95
|
+
### 12-factor
|
|
44
96
|
|
|
45
97
|
One of the major benefits of using this library is not having to figure
|
|
46
98
|
out how to get multiple coverage output formats working. I did that for you,
|
|
@@ -49,12 +101,22 @@ and I got all of them working, at the same time together, or al la carte. Kum-ba
|
|
|
49
101
|
A quick shot of 12-factor coverage power, straight to your brain:
|
|
50
102
|
|
|
51
103
|
```console
|
|
52
|
-
export
|
|
53
|
-
export
|
|
54
|
-
export
|
|
55
|
-
export
|
|
56
|
-
export
|
|
57
|
-
export
|
|
104
|
+
export K_SOUP_COV_COMMAND_NAME="RSpec (COVERAGE)" # Display name for the coverage run
|
|
105
|
+
export K_SOUP_COV_DEBUG=false # Enable debug output for configuration (true/false)
|
|
106
|
+
export K_SOUP_COV_DIR=coverage # Directory where coverage reports are written
|
|
107
|
+
export K_SOUP_COV_DO=true # Enable coverage collection (true/false)
|
|
108
|
+
export K_SOUP_COV_FILTER_DIRS="bin,docs,vendor" # Comma-separated dirs to filter out of coverage
|
|
109
|
+
export K_SOUP_COV_FORMATTERS="html,tty" # Comma-separated list: html,xml,rcov,lcov,json,tty
|
|
110
|
+
export K_SOUP_COV_MERGE_TIMEOUT=3600 # Timeout in seconds when merging multiple coverage results
|
|
111
|
+
export K_SOUP_COV_MIN_BRANCH=53 # Minimum required branch coverage percentage (integer)
|
|
112
|
+
export K_SOUP_COV_MIN_HARD=true # If true, fail the run when coverage thresholds are not met
|
|
113
|
+
export K_SOUP_COV_MIN_LINE=69 # Minimum required line coverage percentage (integer)
|
|
114
|
+
export K_SOUP_COV_MULTI_FORMATTERS=true # Enable multiple SimpleCov formatters (true/false)
|
|
115
|
+
export K_SOUP_COV_PREFIX="K_SOUP_COV_" # Prefix used for the envvars (useful for namespacing)
|
|
116
|
+
export K_SOUP_COV_OPEN_BIN=xdg-open # Command to open HTML report in `coverage` rake task (or empty to disable)
|
|
117
|
+
export K_SOUP_COV_USE_MERGING=false # Enable merging of results for parallel/test matrix runs (true/false)
|
|
118
|
+
export K_SOUP_COV_VERBOSE=false # Enable verbose logging (true/false)
|
|
119
|
+
export MAX_ROWS=5 # simplecov-console setting: limits tty output to the worst N rows of uncovered files
|
|
58
120
|
```
|
|
59
121
|
|
|
60
122
|
I hope I've piqued your interest enough to give it a ⭐️ if the forge you are on supports it.
|
|
@@ -69,91 +131,105 @@ where this library is considered a package of [SOUP](https://en.wikipedia.org/wi
|
|
|
69
131
|
|
|
70
132
|
</details>
|
|
71
133
|
|
|
72
|
-
##
|
|
134
|
+
## 💡 Info you can shake a stick at
|
|
135
|
+
|
|
136
|
+
| Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
|
|
137
|
+
|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
138
|
+
| Works with JRuby | ![JRuby 9.1 Compat][💎jruby-9.1i] ![JRuby 9.2 Compat][💎jruby-9.2i] ![JRuby 9.3 Compat][💎jruby-9.3i] <br/> [![JRuby 9.4 Compat][💎jruby-9.4i]][🚎10-j-wf] [![JRuby 10.0 Compat][💎jruby-c-i]][🚎11-c-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf] |
|
|
139
|
+
| Works with Truffle Ruby | ![Truffle Ruby 22.3 Compat][💎truby-22.3i] ![Truffle Ruby 23.0 Compat][💎truby-23.0i] <br/> [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎9-t-wf] [![Truffle Ruby 24.1 Compat][💎truby-c-i]][🚎11-c-wf] |
|
|
140
|
+
| Works with MRI Ruby 3 | [![Ruby 3.0 Compat][💎ruby-3.0i]][🚎4-lg-wf] [![Ruby 3.1 Compat][💎ruby-3.1i]][🚎6-s-wf] [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎6-s-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎6-s-wf] [![Ruby 3.4 Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf] |
|
|
141
|
+
| Works with MRI Ruby 2 | [![Ruby 2.7 Compat][💎ruby-2.7i]][🚎7-us-wf] |
|
|
142
|
+
| 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] |
|
|
143
|
+
| 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] |
|
|
144
|
+
| 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] |
|
|
145
|
+
| 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] |
|
|
146
|
+
| 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] |
|
|
147
|
+
| 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] |
|
|
148
|
+
| `...` 💖 | [![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] |
|
|
73
149
|
|
|
74
|
-
|
|
75
|
-
I'll try to track that here.
|
|
150
|
+
### Compatibility
|
|
76
151
|
|
|
77
|
-
|
|
78
|
-
|--------|----------------------------|--------|-----|---------------|-------------|---------------|---------------|---------|--------|-----------|----------------|---------------|--------------|
|
|
79
|
-
| `html` | `simplecov-html` | ✅ | ✅ | | | | | | | | | | ✅ |
|
|
80
|
-
| `xml` | `simplecov-cobertura` | ✅ | | | ✅ | | | ✅ | | | | | ✅ |
|
|
81
|
-
| `rcov` | `simplecov-rcov` | ✅ | | | | | | | ✅ | | | | ✅ |
|
|
82
|
-
| `lcov` | `simplecov-lcov` | ✅ | | ✅ | | ✅ | ✅ | | | ✅ | | ✅ | ✅ |
|
|
83
|
-
| `json` | `simplecov_json_formatter` | ✅ | | ✅ | | ✅ | ✅ | | | | ✅ | | ✅ |
|
|
84
|
-
| `tty` | `simplecov-console` | ✅ | | | | | | | | | | | ✅ |
|
|
152
|
+
Compatible with MRI Ruby 2.7+, and concordant releases of JRuby, and TruffleRuby.
|
|
85
153
|
|
|
86
|
-
|
|
154
|
+
| 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 and the color 💚 green 💚 |
|
|
155
|
+
|------------------------------------------------|--------------------------------------------------------|
|
|
156
|
+
| 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
|
|
87
157
|
|
|
88
|
-
|
|
158
|
+
### Federated DVCS
|
|
89
159
|
|
|
90
|
-
|
|
91
|
-
|
|
160
|
+
<details markdown="1">
|
|
161
|
+
<summary>Find this repo on federated forges (Coming soon!)</summary>
|
|
92
162
|
|
|
93
|
-
|
|
163
|
+
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
|
|
164
|
+
|-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
|
|
165
|
+
| 🧪 [kettle-rb/kettle-soup-cover on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ |
|
|
166
|
+
| 🧊 [kettle-rb/kettle-soup-cover on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
|
|
167
|
+
| 🐙 [kettle-rb/kettle-soup-cover on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] |
|
|
168
|
+
| 🎮️ [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] |
|
|
94
169
|
|
|
95
|
-
|
|
96
|
-
* GitHub Actions doesn't parse test output, but...
|
|
97
|
-
* I configure my `coverage` workflow ([see example][example-cov-wf]) to upload coverage reports to SaaS services like:
|
|
98
|
-
* [codecov.io][🔑codecov] (has tokenless OIDC option!)
|
|
99
|
-
* [QLTY.sh](https://qlty.sh) (needs token for upload)
|
|
100
|
-
* [coveralls.io][🔑coveralls]
|
|
101
|
-
* This gem helps me configure my `coverage` workflow to use Github Actions designed to report coverage like:
|
|
102
|
-
* Repo: [irongut/CodeCoverageSummary][GHA-ccs-repo]
|
|
103
|
-
* Repo: [marocchino/sticky-pull-request-comment][GHA-sprc-repo]
|
|
170
|
+
</details>
|
|
104
171
|
|
|
172
|
+
[gh-discussions]: https://github.com/kettle-rb/kettle-soup-cover/discussions
|
|
105
173
|
|
|
106
|
-
[
|
|
107
|
-
[example-cov-wf]: https://github.com/kettle-rb/kettle-soup-cover/blob/main/.github/workflows/coverage.yml
|
|
174
|
+
### Enterprise Support [](https://tidelift.com/subscription/pkg/rubygems-kettle-soup-cover?utm_source=rubygems-kettle-soup-cover&utm_medium=referral&utm_campaign=readme)
|
|
108
175
|
|
|
109
|
-
|
|
176
|
+
Available as part of the Tidelift Subscription.
|
|
110
177
|
|
|
111
|
-
|
|
178
|
+
<details markdown="1">
|
|
179
|
+
<summary>Need enterprise-level guarantees?</summary>
|
|
180
|
+
|
|
181
|
+
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.
|
|
182
|
+
|
|
183
|
+
[![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
|
|
184
|
+
|
|
185
|
+
- 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies
|
|
186
|
+
- 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
|
|
187
|
+
- 💡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
|
|
188
|
+
|
|
189
|
+
Alternatively:
|
|
112
190
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
| Documentation | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![BDFL Blog][🚂bdfl-blog-img]][🚂bdfl-blog] [![Wiki][📜wiki-img]][📜wiki] |
|
|
119
|
-
| Compliance | [![License: MIT][📄license-img]][📄license-ref] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
|
|
120
|
-
| Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] |
|
|
121
|
-
| Support | [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite] [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork] [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor] |
|
|
122
|
-
| Enterprise Support | [![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]<br/>💡Subscribe for support guarantees covering _all_ FLOSS dependencies!<br/>💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]!<br/>💡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! |
|
|
123
|
-
| Comrade BDFL 🎖️ | [![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 BDFL][🚂bdfl-contact-img]][🚂bdfl-contact] [![My technical writing][💖💁🏼♂️devto-img]][💖💁🏼♂️devto] |
|
|
124
|
-
| `...` 💖 | [![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] |
|
|
191
|
+
- [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
192
|
+
- [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork]
|
|
193
|
+
- [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor]
|
|
194
|
+
|
|
195
|
+
</details>
|
|
125
196
|
|
|
126
197
|
## ✨ Installation
|
|
127
198
|
|
|
128
199
|
Install the gem and add to the application's Gemfile by executing:
|
|
129
200
|
|
|
130
|
-
|
|
201
|
+
```console
|
|
202
|
+
bundle add kettle-soup-cover
|
|
203
|
+
```
|
|
131
204
|
|
|
132
205
|
If bundler is not being used to manage dependencies, install the gem by executing:
|
|
133
206
|
|
|
134
|
-
|
|
207
|
+
```console
|
|
208
|
+
gem install kettle-soup-cover
|
|
209
|
+
```
|
|
135
210
|
|
|
136
211
|
### 🔒 Secure Installation
|
|
137
212
|
|
|
138
|
-
|
|
213
|
+
<details markdown="1">
|
|
214
|
+
<summary>For Medium or High Security Installations</summary>
|
|
215
|
+
|
|
216
|
+
This gem is cryptographically signed, and has verifiable [SHA-256 and SHA-512][💎SHA_checksums] checksums by
|
|
139
217
|
[stone_checksums][💎stone_checksums]. Be sure the gem you install hasn’t been tampered with
|
|
140
218
|
by following the instructions below.
|
|
141
219
|
|
|
142
220
|
Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:
|
|
143
221
|
|
|
144
222
|
```console
|
|
145
|
-
gem cert --add <(curl -Ls https://raw.github.com/
|
|
223
|
+
gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)
|
|
146
224
|
```
|
|
147
225
|
|
|
148
226
|
You only need to do that once. Then proceed to install with:
|
|
149
227
|
|
|
150
228
|
```console
|
|
151
|
-
gem install kettle-soup-cover -P
|
|
229
|
+
gem install kettle-soup-cover -P HighSecurity
|
|
152
230
|
```
|
|
153
231
|
|
|
154
|
-
The `
|
|
155
|
-
|
|
156
|
-
This is necessary because not all of `kettle-soup-cover`’s dependencies are signed, so we cannot use `HighSecurity`.
|
|
232
|
+
The `HighSecurity` trust profile will verify signed gems, and not allow the installation of unsigned dependencies.
|
|
157
233
|
|
|
158
234
|
If you want to up your security game full-time:
|
|
159
235
|
|
|
@@ -161,8 +237,92 @@ If you want to up your security game full-time:
|
|
|
161
237
|
bundle config set --global trust-policy MediumSecurity
|
|
162
238
|
```
|
|
163
239
|
|
|
240
|
+
`MediumSecurity` instead of `HighSecurity` is necessary if not all the gems you use are signed.
|
|
241
|
+
|
|
164
242
|
NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
|
|
165
243
|
|
|
244
|
+
</details>
|
|
245
|
+
|
|
246
|
+
## ⚙️ Configuration
|
|
247
|
+
|
|
248
|
+
### Merging
|
|
249
|
+
|
|
250
|
+
Below is some part of the Rakefile pulled from the [tree_haver](https://github.com/kettle-rb/tree_haver) gem which merges the results of various discrete RSpec test suites that are impossible to run at the same time. The pattern should also work for minitest / test unit.
|
|
251
|
+
|
|
252
|
+
```ruby
|
|
253
|
+
### SPEC TASKS
|
|
254
|
+
# Run FFI specs first (before the collision of MRI+FFI backends pollutes the environment),
|
|
255
|
+
# then run remaining specs. This ensures FFI tests get a clean environment
|
|
256
|
+
# while still validating that BackendConflict protection works.
|
|
257
|
+
#
|
|
258
|
+
# For coverage aggregation with SimpleCov merging:
|
|
259
|
+
# - Each task uses a unique K_SOUP_COV_COMMAND_NAME so SimpleCov tracks them separately
|
|
260
|
+
# - K_SOUP_COV_USE_MERGING=true must be set in .envrc for results to merge
|
|
261
|
+
# - K_SOUP_COV_MERGE_TIMEOUT should be set long enough for all tasks to complete
|
|
262
|
+
begin
|
|
263
|
+
require "rspec/core/rake_task"
|
|
264
|
+
|
|
265
|
+
# FFI specs run first in a clean environment
|
|
266
|
+
desc("Run FFI backend specs first (before MRI loads)")
|
|
267
|
+
RSpec::Core::RakeTask.new(:ffi_specs) do |t|
|
|
268
|
+
t.pattern = "./spec/**/*_spec.rb"
|
|
269
|
+
t.rspec_opts = "--tag ffi"
|
|
270
|
+
end
|
|
271
|
+
# Set unique command name at execution time for SimpleCov merging
|
|
272
|
+
desc("Set SimpleCov command name for FFI specs")
|
|
273
|
+
task(:set_ffi_command_name) do
|
|
274
|
+
ENV["K_SOUP_COV_COMMAND_NAME"] = "FFI Specs"
|
|
275
|
+
end
|
|
276
|
+
Rake::Task[:ffi_specs].enhance([:set_ffi_command_name])
|
|
277
|
+
|
|
278
|
+
# Matrix checks will run in between FFI and MRI
|
|
279
|
+
desc("Run Backend Matrix Specs")
|
|
280
|
+
RSpec::Core::RakeTask.new(:backend_matrix_specs) do |t|
|
|
281
|
+
t.pattern = "./spec_matrix/**/*_spec.rb"
|
|
282
|
+
end
|
|
283
|
+
desc("Set SimpleCov command name for backend matrix specs")
|
|
284
|
+
task(:set_matrix_command_name) do
|
|
285
|
+
ENV["K_SOUP_COV_COMMAND_NAME"] = "Backend Matrix Specs"
|
|
286
|
+
end
|
|
287
|
+
Rake::Task[:backend_matrix_specs].enhance([:set_matrix_command_name])
|
|
288
|
+
|
|
289
|
+
# All other specs run after FFI specs
|
|
290
|
+
desc("Run non-FFI specs (after FFI specs have run)")
|
|
291
|
+
RSpec::Core::RakeTask.new(:remaining_specs) do |t|
|
|
292
|
+
t.pattern = "./spec/**/*_spec.rb"
|
|
293
|
+
t.rspec_opts = "--tag ~ffi"
|
|
294
|
+
end
|
|
295
|
+
desc("Set SimpleCov command name for remaining specs")
|
|
296
|
+
task(:set_remaining_command_name) do
|
|
297
|
+
ENV["K_SOUP_COV_COMMAND_NAME"] = "Remaining Specs"
|
|
298
|
+
end
|
|
299
|
+
Rake::Task[:remaining_specs].enhance([:set_remaining_command_name])
|
|
300
|
+
|
|
301
|
+
# Final task to run all specs (for spec task, runs in single process for final coverage merge)
|
|
302
|
+
desc("Run all specs in one process (no FFI isolation)")
|
|
303
|
+
RSpec::Core::RakeTask.new(:all_specs) do |t|
|
|
304
|
+
t.pattern = "spec/**{,/*/**}/*_spec.rb"
|
|
305
|
+
end
|
|
306
|
+
desc("Set SimpleCov command name for all specs")
|
|
307
|
+
task(:set_all_command_name) do
|
|
308
|
+
ENV["K_SOUP_COV_COMMAND_NAME"] = "All Specs"
|
|
309
|
+
end
|
|
310
|
+
Rake::Task[:all_specs].enhance([:set_all_command_name])
|
|
311
|
+
|
|
312
|
+
# Override the default spec task to run in sequence
|
|
313
|
+
# NOTE: We do NOT include :all_specs here because ffi_specs + remaining_specs already
|
|
314
|
+
# cover all specs. Including all_specs would cause duplicated test runs.
|
|
315
|
+
Rake::Task[:spec].clear if Rake::Task.task_defined?(:spec)
|
|
316
|
+
desc("Run specs with FFI tests first, then backend matrix, then remaining tests")
|
|
317
|
+
task(spec: [:ffi_specs, :backend_matrix_specs, :remaining_specs]) # rubocop:disable Rake/DuplicateTask:
|
|
318
|
+
rescue LoadError
|
|
319
|
+
desc("(stub) spec is unavailable")
|
|
320
|
+
task(:spec) do # rubocop:disable Rake/DuplicateTask:
|
|
321
|
+
warn("NOTE: rspec isn't installed, or is disabled for #{RUBY_VERSION} in the current environment")
|
|
322
|
+
end
|
|
323
|
+
end
|
|
324
|
+
```
|
|
325
|
+
|
|
166
326
|
## 🔧 Basic Usage
|
|
167
327
|
|
|
168
328
|
### RSpec or MiniTest
|
|
@@ -179,6 +339,33 @@ require "simplecov" if Kettle::Soup::Cover::DO_COV # `.simplecov` is run here!
|
|
|
179
339
|
# SimpleCov.external_at_exit = true
|
|
180
340
|
```
|
|
181
341
|
|
|
342
|
+
#### Example: Rails & RSpec
|
|
343
|
+
|
|
344
|
+
In your `spec/rails_helper.rb`
|
|
345
|
+
|
|
346
|
+
```ruby
|
|
347
|
+
# External gems
|
|
348
|
+
require "kettle-soup-cover"
|
|
349
|
+
|
|
350
|
+
# This file is copied to spec/ when you run 'rails generate rspec:install'
|
|
351
|
+
# We provide a preconfigured version compatible with Rails 8
|
|
352
|
+
require "spec_helper"
|
|
353
|
+
ENV["RAILS_ENV"] ||= "test"
|
|
354
|
+
|
|
355
|
+
# Last thing before loading the app-under-test is code coverage.
|
|
356
|
+
require "simplecov" if Kettle::Soup::Cover::DO_COV # `.simplecov` is run here!
|
|
357
|
+
require File.expand_path("../config/environment", __dir__)
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
P.S. Ensure that you have `require: false` on the gem in the Gemfile,
|
|
361
|
+
and that it is in both `:development` and `:test` groups, since it ships a `coverage` rake task:
|
|
362
|
+
|
|
363
|
+
```ruby
|
|
364
|
+
group :development, :test do
|
|
365
|
+
gem "kettle-soup-cover", "~> 1.0", ">= 1.0.10", require: false
|
|
366
|
+
end
|
|
367
|
+
```
|
|
368
|
+
|
|
182
369
|
### Projects that run tests against older Ruby versions, e.g. with Appraisals
|
|
183
370
|
|
|
184
371
|
```ruby
|
|
@@ -238,6 +425,25 @@ require "kettle-soup-cover"
|
|
|
238
425
|
Kettle::Soup::Cover.install_tasks
|
|
239
426
|
```
|
|
240
427
|
|
|
428
|
+
### kettle-soup-cover (exe/kettle-soup-cover)
|
|
429
|
+
|
|
430
|
+
This gem ships a small helper binary `kettle-soup-cover` under `exe/kettle-soup-cover`. It consumes a SimpleCov JSON output (coverage/coverage.json) and prints a readable, summarized report of lines and branches. The script will, by default, look for `coverage/coverage.json` in the directory configured by `K_SOUP_COV_DIR` (defaults to `coverage`).
|
|
431
|
+
|
|
432
|
+
Usage examples:
|
|
433
|
+
|
|
434
|
+
```
|
|
435
|
+
kettle-soup-cover # Uses $K_SOUP_COV_DIR/coverage.json (default coverage/coverage.json)
|
|
436
|
+
kettle-soup-cover -p path/to/coverage.json # Read JSON from a custom path
|
|
437
|
+
kettle-soup-cover ./coverage/coverage.json # Positional path is accepted as an alternative to -p/--path
|
|
438
|
+
kettle-soup-cover -f kettle/soup # Show only files matching kettle/soup (partial substring match)
|
|
439
|
+
kettle-soup-cover -f "kettle/soup/**/*.rb" # Globbing is supported; -f will treat patterns containing *?[] as globs
|
|
440
|
+
```
|
|
441
|
+
|
|
442
|
+
Notes:
|
|
443
|
+
- The script requires the `json` formatter to be active in `K_SOUP_COV_FORMATTERS` if you don't supply an explicit JSON path via `-p` or a positional arg; otherwise it will abort with an actionable message.
|
|
444
|
+
- `-f/--file` is a *file filter* (partial path match) and cannot be used to specify the coverage JSON path.
|
|
445
|
+
- `K_SOUP_COV_DIR` controls the default path used by the script (defaults to `coverage`).
|
|
446
|
+
|
|
241
447
|
### Filters
|
|
242
448
|
|
|
243
449
|
There are two built-in SimpleCov filters which can be loaded via `Kettle::Soup::Cover.load_filters`.
|
|
@@ -258,23 +464,86 @@ Most are self explanatory.
|
|
|
258
464
|
I tried to follow POLS, the principle of least surprise, so they mostly _DWTFYT_.
|
|
259
465
|
Want to help improve this documentation? PRs are easy!
|
|
260
466
|
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
467
|
+
Below is a reference for the environment variables used by this gem. Each section documents the variable name, its default value, what it controls, and an example of usage. Variable names are prefixed with the value of `K_SOUP_COV_PREFIX` (by default `K_SOUP_COV_`).
|
|
468
|
+
|
|
469
|
+
#### K_SOUP_COV_COMMAND_NAME
|
|
470
|
+
- Default: `RSpec (COVERAGE)`
|
|
471
|
+
- What it controls: Display name for the coverage run, used in UIs or log output.
|
|
472
|
+
- Example: `export K_SOUP_COV_COMMAND_NAME="Unit Tests (Coverage)"`
|
|
473
|
+
|
|
474
|
+
#### K_SOUP_COV_DEBUG
|
|
475
|
+
- Default: `false` (string value read truthily)
|
|
476
|
+
- What it controls: Enable debug output for the configuration, prints the prefixes and selected values.
|
|
477
|
+
- Example: `export K_SOUP_COV_DEBUG=true`
|
|
478
|
+
|
|
479
|
+
#### K_SOUP_COV_DIR
|
|
480
|
+
- Default: `coverage`
|
|
481
|
+
- What it controls: Directory where SimpleCov writes coverage reports. The `exe/kettle-soup-cover` script and rake tasks will look here for artefacts like `coverage.json` or `index.html`.
|
|
482
|
+
- Example: `export K_SOUP_COV_DIR=my-coverage`
|
|
483
|
+
|
|
484
|
+
#### K_SOUP_COV_DO
|
|
485
|
+
- Default: Uses `CI` if unset (`CI=false` default). Setting to `true` or `false` enables/disables coverage collection.
|
|
486
|
+
- What it controls: Controls whether the gem enables SimpleCov at runtime (`DO_COV` behavior).
|
|
487
|
+
- Example: `export K_SOUP_COV_DO=true`
|
|
488
|
+
|
|
489
|
+
#### K_SOUP_COV_FILTER_DIRS
|
|
490
|
+
- Default: `bin,certs,checksums,config,coverage,docs,features,gemfiles,pkg,results,sig,spec,src,test,test-results,vendor`
|
|
491
|
+
- What it controls: A comma-separated list of directory names to filter out from coverage reports.
|
|
492
|
+
- Example: `export K_SOUP_COV_FILTER_DIRS=vendor,bin,docs`
|
|
493
|
+
|
|
494
|
+
#### K_SOUP_COV_FORMATTERS
|
|
495
|
+
- Default: `html,xml,rcov,lcov,json,tty` on CI; `html,tty` locally.
|
|
496
|
+
- What it controls: Comma-separated list of formatters that determine the kind of coverage reports generated. Supported values include `html`, `xml`, `rcov`, `lcov`, `json`, `tty`.
|
|
497
|
+
- Example: `export K_SOUP_COV_FORMATTERS="html,json"`
|
|
498
|
+
|
|
499
|
+
Note: the `exe/kettle-soup-cover` script requires that the `json` formatter be enabled so it can read a canonical `coverage/coverage.json` file. If you plan to use that script, ensure `json` is included in your `K_SOUP_COV_FORMATTERS` value as shown in the example above.
|
|
500
|
+
|
|
501
|
+
#### K_SOUP_COV_MERGE_TIMEOUT
|
|
502
|
+
- Default: `nil`
|
|
503
|
+
- What it controls: When using merging (`K_SOUP_COV_USE_MERGING=true`), this sets a numeric timeout in seconds for the merge operation.
|
|
504
|
+
- Example: `export K_SOUP_COV_MERGE_TIMEOUT=3600`
|
|
505
|
+
|
|
506
|
+
#### K_SOUP_COV_MIN_BRANCH
|
|
507
|
+
- Default: `80`
|
|
508
|
+
- What it controls: Minimum allowed branch coverage percentage. Used to assert that coverage thresholds are met.
|
|
509
|
+
- Example: `export K_SOUP_COV_MIN_BRANCH=85`
|
|
510
|
+
|
|
511
|
+
#### K_SOUP_COV_MIN_HARD
|
|
512
|
+
- Default: Uses `CI` if unset (`CI=false` default). When true the build will fail if thresholds are not met.
|
|
513
|
+
- What it controls: Whether failing coverage thresholds should fail the run (hard failure) or only warn.
|
|
514
|
+
- Example: `export K_SOUP_COV_MIN_HARD=true`
|
|
515
|
+
|
|
516
|
+
#### K_SOUP_COV_MIN_LINE
|
|
517
|
+
- Default: `80`
|
|
518
|
+
- What it controls: Minimum allowed line coverage percentage.
|
|
519
|
+
- Example: `export K_SOUP_COV_MIN_LINE=92`
|
|
520
|
+
|
|
521
|
+
#### K_SOUP_COV_MULTI_FORMATTERS
|
|
522
|
+
- Default: If running on CI (true) the default is `true`, otherwise the default is true if any formatters are present.
|
|
523
|
+
- What it controls: Whether to configure SimpleCov to run multiple formatters concurrently or not.
|
|
524
|
+
- Example: `export K_SOUP_COV_MULTI_FORMATTERS=false`
|
|
525
|
+
|
|
526
|
+
#### K_SOUP_COV_PREFIX
|
|
527
|
+
- Default: `K_SOUP_COV_`
|
|
528
|
+
- What it controls: Prefix used for the environment variables described in this section; useful if you want a custom-namespaced set for tests.
|
|
529
|
+
- Example: `export K_SOUP_COV_PREFIX="MY_COV_"`
|
|
530
|
+
|
|
531
|
+
#### K_SOUP_COV_OPEN_BIN
|
|
532
|
+
- Default: Uses `open` on macOS and `xdg-open` on Linux.
|
|
533
|
+
- What it controls: Command used by the Rake `coverage` task to open the HTML report. Set to an empty value to disable auto-opening and just print report locations.
|
|
534
|
+
- Example: `export K_SOUP_COV_OPEN_BIN=xdg-open` or `export K_SOUP_COV_OPEN_BIN=` (to only print the path)
|
|
535
|
+
|
|
536
|
+
#### K_SOUP_COV_USE_MERGING
|
|
537
|
+
- Default: `nil` (disabled)
|
|
538
|
+
- What it controls: When true, enables result merging semantics for multiple test runs (works with merge timeout and other behaviors).
|
|
539
|
+
- Example: `export K_SOUP_COV_USE_MERGING=true`
|
|
540
|
+
|
|
541
|
+
#### K_SOUP_COV_VERBOSE
|
|
542
|
+
- Default: `false`
|
|
543
|
+
- What it controls: Enables additional verbose logging where supported within tasks and scripts.
|
|
544
|
+
- Example: `export K_SOUP_COV_VERBOSE=true`
|
|
545
|
+
|
|
546
|
+
Note: Some third-party formatters may also read their own environment variables. For example, the simplecov-console formatter supports `MAX_ROWS` to limit the tty output. This is not prefixed with `K_SOUP_COV_` by design and is passed through to the formatter directly.
|
|
278
547
|
|
|
279
548
|
Additionally, some of the included gems, like [`simplecov-console`][simplecov-console],
|
|
280
549
|
have their own complete suite of ENV variables you can configure.
|
|
@@ -329,6 +598,63 @@ Repo: [marocchino/sticky-pull-request-comment][GHA-sprc-repo]
|
|
|
329
598
|
continue-on-error: ${{ matrix.experimental != 'false' }}
|
|
330
599
|
```
|
|
331
600
|
|
|
601
|
+
## 🦷 FLOSS Funding
|
|
602
|
+
|
|
603
|
+
While kettle-rb tools are free software and will always be, the project would benefit immensely from some funding.
|
|
604
|
+
Raising a monthly budget of... "dollars" would make the project more sustainable.
|
|
605
|
+
|
|
606
|
+
We welcome both individual and corporate sponsors! We also offer a
|
|
607
|
+
wide array of funding channels to account for your preferences
|
|
608
|
+
(although currently [Open Collective][🖇osc] is our preferred funding platform).
|
|
609
|
+
|
|
610
|
+
**If you're working in a company that's making significant use of kettle-rb tools we'd
|
|
611
|
+
appreciate it if you suggest to your company to become a kettle-rb sponsor.**
|
|
612
|
+
|
|
613
|
+
You can support the development of kettle-rb tools via
|
|
614
|
+
[GitHub Sponsors][🖇sponsor],
|
|
615
|
+
[Liberapay][⛳liberapay],
|
|
616
|
+
[PayPal][🖇paypal],
|
|
617
|
+
[Open Collective][🖇osc]
|
|
618
|
+
and [Tidelift][🏙️entsup-tidelift].
|
|
619
|
+
|
|
620
|
+
| 📍 NOTE |
|
|
621
|
+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
622
|
+
| 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. |
|
|
623
|
+
|
|
624
|
+
### Open Collective for Individuals
|
|
625
|
+
|
|
626
|
+
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/kettle-rb#backer)]
|
|
627
|
+
|
|
628
|
+
NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
|
|
629
|
+
|
|
630
|
+
<!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
|
|
631
|
+
No backers yet. Be the first!
|
|
632
|
+
<!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
|
|
633
|
+
|
|
634
|
+
### Open Collective for Organizations
|
|
635
|
+
|
|
636
|
+
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)]
|
|
637
|
+
|
|
638
|
+
NOTE: [kettle-readme-backers][kettle-readme-backers] updates this list every day, automatically.
|
|
639
|
+
|
|
640
|
+
<!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
|
|
641
|
+
No sponsors yet. Be the first!
|
|
642
|
+
<!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
|
|
643
|
+
|
|
644
|
+
[kettle-readme-backers]: https://github.com/kettle-rb/kettle-soup-cover/blob/main/exe/kettle-readme-backers
|
|
645
|
+
|
|
646
|
+
### Another way to support open-source
|
|
647
|
+
|
|
648
|
+
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).
|
|
649
|
+
|
|
650
|
+
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`.
|
|
651
|
+
|
|
652
|
+
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.
|
|
653
|
+
|
|
654
|
+
**[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
|
|
655
|
+
|
|
656
|
+
[![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]
|
|
657
|
+
|
|
332
658
|
## 🔐 Security
|
|
333
659
|
|
|
334
660
|
See [SECURITY.md][🔐security].
|
|
@@ -336,7 +662,7 @@ See [SECURITY.md][🔐security].
|
|
|
336
662
|
## 🤝 Contributing
|
|
337
663
|
|
|
338
664
|
If you need some ideas of where to help, you could work on adding more code coverage,
|
|
339
|
-
or if it is already 💯 (see [below](#code-coverage)) check [issues][🤝gh-issues], or [PRs][🤝gh-pulls],
|
|
665
|
+
or if it is already 💯 (see [below](#code-coverage)) check [reek](REEK), [issues][🤝gh-issues], or [PRs][🤝gh-pulls],
|
|
340
666
|
or use the gem and think about how it could be better.
|
|
341
667
|
|
|
342
668
|
We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
|
|
@@ -349,7 +675,11 @@ See [CONTRIBUTING.md][🤝contributing].
|
|
|
349
675
|
|
|
350
676
|
### Code Coverage
|
|
351
677
|
|
|
352
|
-
[![Coverage Graph][
|
|
678
|
+
[![Coverage Graph][🏀codecov-g]][🏀codecov]
|
|
679
|
+
|
|
680
|
+
[![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls]
|
|
681
|
+
|
|
682
|
+
[![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]
|
|
353
683
|
|
|
354
684
|
### 🪇 Code of Conduct
|
|
355
685
|
|
|
@@ -364,7 +694,8 @@ Made with [contributors-img][🖐contrib-rocks].
|
|
|
364
694
|
|
|
365
695
|
Also see GitLab Contributors: [https://gitlab.com/kettle-rb/kettle-soup-cover/-/graphs/main][🚎contributors-gl]
|
|
366
696
|
|
|
367
|
-
|
|
697
|
+
<details>
|
|
698
|
+
<summary>⭐️ Star History</summary>
|
|
368
699
|
|
|
369
700
|
<a href="https://star-history.com/#kettle-rb/kettle-soup-cover&Date">
|
|
370
701
|
<picture>
|
|
@@ -374,6 +705,8 @@ Also see GitLab Contributors: [https://gitlab.com/kettle-rb/kettle-soup-cover/-/
|
|
|
374
705
|
</picture>
|
|
375
706
|
</a>
|
|
376
707
|
|
|
708
|
+
</details>
|
|
709
|
+
|
|
377
710
|
## 📌 Versioning
|
|
378
711
|
|
|
379
712
|
This Library adheres to [![Semantic Versioning 2.0.0][📌semver-img]][📌semver].
|
|
@@ -382,32 +715,32 @@ Specifically, if a minor or patch version is released that breaks backward compa
|
|
|
382
715
|
a new version should be immediately released that restores compatibility.
|
|
383
716
|
Breaking changes to the public API will only be introduced with new major versions.
|
|
384
717
|
|
|
385
|
-
|
|
718
|
+
> dropping support for a platform is both obviously and objectively a breaking change <br/>
|
|
719
|
+
>—Jordan Harband ([@ljharb](https://github.com/ljharb), maintainer of SemVer) [in SemVer issue 716][📌semver-breaking]
|
|
720
|
+
|
|
721
|
+
I understand that policy doesn't work universally ("exceptions to every rule!"),
|
|
722
|
+
but it is the policy here.
|
|
723
|
+
As such, in many cases it is good to specify a dependency on this library using
|
|
724
|
+
the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
|
|
386
725
|
|
|
387
|
-
|
|
726
|
+
For example:
|
|
388
727
|
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
728
|
+
```ruby
|
|
729
|
+
spec.add_dependency("kettle-soup-cover", "~> 1.0")
|
|
730
|
+
```
|
|
392
731
|
|
|
393
|
-
>
|
|
732
|
+
<details markdown="1">
|
|
733
|
+
<summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
|
|
394
734
|
|
|
395
|
-
|
|
735
|
+
SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms
|
|
736
|
+
is a *breaking change* to an API, and for that reason the bike shedding is endless.
|
|
396
737
|
|
|
397
738
|
To get a better understanding of how SemVer is intended to work over a project's lifetime,
|
|
398
739
|
read this article from the creator of SemVer:
|
|
399
740
|
|
|
400
741
|
- ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
|
|
401
742
|
|
|
402
|
-
|
|
403
|
-
you can (and should) specify a dependency on these libraries using
|
|
404
|
-
the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
|
|
405
|
-
|
|
406
|
-
For example:
|
|
407
|
-
|
|
408
|
-
```ruby
|
|
409
|
-
spec.add_dependency("kettle-soup-cover", "~> 1.0")
|
|
410
|
-
```
|
|
743
|
+
</details>
|
|
411
744
|
|
|
412
745
|
See [CHANGELOG.md][📌changelog] for a list of releases.
|
|
413
746
|
|
|
@@ -421,65 +754,92 @@ See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright
|
|
|
421
754
|
|
|
422
755
|
<ul>
|
|
423
756
|
<li>
|
|
424
|
-
Copyright (c) 2023-2025 Peter H. Boling, of
|
|
757
|
+
Copyright (c) 2023 - 2025 Peter H. Boling, of
|
|
425
758
|
<a href="https://discord.gg/3qme4XHNKN">
|
|
426
759
|
Galtzo.com
|
|
427
760
|
<picture>
|
|
428
|
-
<img src="https://
|
|
761
|
+
<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">
|
|
429
762
|
</picture>
|
|
430
|
-
</a>, and kettle-soup-cover contributors
|
|
763
|
+
</a>, and kettle-soup-cover contributors.
|
|
431
764
|
</li>
|
|
432
765
|
</ul>
|
|
433
766
|
|
|
434
|
-
## 🤑
|
|
767
|
+
## 🤑 A request for help
|
|
768
|
+
|
|
769
|
+
Maintainers have teeth and need to pay their dentists.
|
|
770
|
+
After getting laid off in an RIF in March, and encountering difficulty finding a new one,
|
|
771
|
+
I began spending most of my time building open source tools.
|
|
772
|
+
I'm hoping to be able to pay for my kids' health insurance this month,
|
|
773
|
+
so if you value the work I am doing, I need your support.
|
|
774
|
+
Please consider sponsoring me or the project.
|
|
775
|
+
|
|
776
|
+
To join the community or get help 👇️ Join the Discord.
|
|
435
777
|
|
|
436
|
-
|
|
437
|
-
The primary maintainer of this gem, Peter Boling, wants
|
|
438
|
-
Ruby to be a great place for people to solve problems, big and small.
|
|
439
|
-
Please consider supporting his efforts via the giant yellow link below,
|
|
440
|
-
or one of smaller ones, depending on button size preference.
|
|
778
|
+
[![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
441
779
|
|
|
442
|
-
|
|
780
|
+
To say "thanks!" ☝️ Join the Discord or 👇️ send money.
|
|
443
781
|
|
|
444
|
-
[![
|
|
782
|
+
[![Sponsor kettle-rb/kettle-soup-cover 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]
|
|
445
783
|
|
|
446
|
-
|
|
784
|
+
### Please give the project a star ⭐ ♥.
|
|
447
785
|
|
|
448
|
-
|
|
786
|
+
Thanks for RTFM. ☺️
|
|
449
787
|
|
|
450
|
-
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay
|
|
788
|
+
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
|
|
789
|
+
[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
|
|
451
790
|
[⛳liberapay]: https://liberapay.com/pboling/donate
|
|
791
|
+
[🖇osc-all-img]: https://img.shields.io/opencollective/all/kettle-rb
|
|
792
|
+
[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/kettle-rb
|
|
793
|
+
[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/kettle-rb
|
|
794
|
+
[🖇osc-backers]: https://opencollective.com/kettle-rb#backer
|
|
795
|
+
[🖇osc-backers-i]: https://opencollective.com/kettle-rb/backers/badge.svg?style=flat
|
|
796
|
+
[🖇osc-sponsors]: https://opencollective.com/kettle-rb#sponsor
|
|
797
|
+
[🖇osc-sponsors-i]: https://opencollective.com/kettle-rb/sponsors/badge.svg?style=flat
|
|
798
|
+
[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/kettle-rb?style=for-the-badge
|
|
799
|
+
[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/kettle-rb?style=for-the-badge
|
|
800
|
+
[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/kettle-rb?style=for-the-badge
|
|
801
|
+
[🖇osc]: https://opencollective.com/kettle-rb
|
|
452
802
|
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
|
|
803
|
+
[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
|
|
453
804
|
[🖇sponsor]: https://github.com/sponsors/pboling
|
|
454
|
-
[🖇polar-img]: https://img.shields.io/badge/polar-donate-
|
|
805
|
+
[🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
|
|
455
806
|
[🖇polar]: https://polar.sh/pboling
|
|
456
|
-
[🖇kofi-img]: https://img.shields.io/badge/
|
|
807
|
+
[🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
|
|
457
808
|
[🖇kofi]: https://ko-fi.com/O5O86SNP4
|
|
458
|
-
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-
|
|
809
|
+
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
|
|
459
810
|
[🖇patreon]: https://patreon.com/galtzo
|
|
460
|
-
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee
|
|
811
|
+
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
|
|
461
812
|
[🖇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
|
|
462
813
|
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
|
814
|
+
[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
|
|
815
|
+
[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
|
|
816
|
+
[🖇paypal]: https://www.paypal.com/paypalme/peterboling
|
|
817
|
+
[🖇floss-funding.dev]: https://floss-funding.dev
|
|
818
|
+
[🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
|
|
463
819
|
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
|
464
|
-
[✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge
|
|
820
|
+
[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
|
|
821
|
+
[✉️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
|
|
822
|
+
[✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
|
|
465
823
|
|
|
466
824
|
[✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
|
|
467
825
|
[⛳️gem-namespace]: https://github.com/kettle-rb/kettle-soup-cover
|
|
468
|
-
[⛳️namespace-img]: https://img.shields.io/badge/namespace-Kettle
|
|
469
|
-
[⛳️gem-name]: https://
|
|
470
|
-
[⛳️name-img]: https://img.shields.io/badge/name-kettle--soup--cover-
|
|
471
|
-
[
|
|
472
|
-
[
|
|
473
|
-
[🚂
|
|
474
|
-
[🚂
|
|
826
|
+
[⛳️namespace-img]: https://img.shields.io/badge/namespace-Kettle::Soup::Cover-3C2D2D.svg?style=square&logo=ruby&logoColor=white
|
|
827
|
+
[⛳️gem-name]: https://bestgems.org/gems/kettle-soup-cover
|
|
828
|
+
[⛳️name-img]: https://img.shields.io/badge/name-kettle--soup--cover-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
|
|
829
|
+
[⛳️tag-img]: https://img.shields.io/github/tag/kettle-rb/kettle-soup-cover.svg
|
|
830
|
+
[⛳️tag]: http://github.com/kettle-rb/kettle-soup-cover/releases
|
|
831
|
+
[🚂maint-blog]: http://www.railsbling.com/tags/kettle-soup-cover
|
|
832
|
+
[🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
|
|
833
|
+
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
834
|
+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
|
475
835
|
[💖🖇linkedin]: http://www.linkedin.com/in/peterboling
|
|
476
836
|
[💖🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-LinkedIn-0B66C2?style=flat&logo=newjapanprowrestling
|
|
477
|
-
[💖✌️wellfound]: https://
|
|
837
|
+
[💖✌️wellfound]: https://wellfound.com/u/peter-boling
|
|
478
838
|
[💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
|
|
479
839
|
[💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
|
|
480
840
|
[💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
|
|
481
841
|
[💖🐘ruby-mast]: https://ruby.social/@galtzo
|
|
482
|
-
[💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https
|
|
842
|
+
[💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https://ruby.social&style=flat&logo=mastodon&label=Ruby%20@galtzo
|
|
483
843
|
[💖🦋bluesky]: https://bsky.app/profile/galtzo.com
|
|
484
844
|
[💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
|
|
485
845
|
[💖🌳linktree]: https://linktr.ee/galtzo
|
|
@@ -496,7 +856,7 @@ P.S. If you need help️, or want to say thanks, 👇 Join the Discord.
|
|
|
496
856
|
[👨🏼🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
|
|
497
857
|
[👨🏼🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
|
|
498
858
|
[👨🏼🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
|
|
499
|
-
[🏙️entsup-tidelift]: https://tidelift.com/subscription
|
|
859
|
+
[🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-kettle-soup-cover?utm_source=rubygems-kettle-soup-cover&utm_medium=referral&utm_campaign=readme
|
|
500
860
|
[🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
|
|
501
861
|
[🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
|
|
502
862
|
[💁🏼♂️peterboling]: http://www.peterboling.com
|
|
@@ -509,24 +869,24 @@ P.S. If you need help️, or want to say thanks, 👇 Join the Discord.
|
|
|
509
869
|
[📜src-gh]: https://github.com/kettle-rb/kettle-soup-cover
|
|
510
870
|
[📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
511
871
|
[📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
512
|
-
[📜wiki]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/wikis/home
|
|
513
|
-
[📜wiki
|
|
514
|
-
[
|
|
872
|
+
[📜gl-wiki]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/wikis/home
|
|
873
|
+
[📜gh-wiki]: https://github.com/kettle-rb/kettle-soup-cover/wiki
|
|
874
|
+
[📜gl-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=gitlab&logoColor=white
|
|
875
|
+
[📜gh-wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=github&logoColor=white
|
|
876
|
+
[👽dl-rank]: https://bestgems.org/gems/kettle-soup-cover
|
|
515
877
|
[👽dl-ranki]: https://img.shields.io/gem/rd/kettle-soup-cover.svg
|
|
516
878
|
[👽oss-help]: https://www.codetriage.com/kettle-rb/kettle-soup-cover
|
|
517
879
|
[👽oss-helpi]: https://www.codetriage.com/kettle-rb/kettle-soup-cover/badges/users.svg
|
|
518
|
-
[👽version]: https://
|
|
880
|
+
[👽version]: https://bestgems.org/gems/kettle-soup-cover
|
|
519
881
|
[👽versioni]: https://img.shields.io/gem/v/kettle-soup-cover.svg
|
|
520
|
-
[
|
|
521
|
-
[
|
|
522
|
-
[
|
|
523
|
-
[
|
|
524
|
-
[
|
|
525
|
-
[
|
|
526
|
-
[
|
|
527
|
-
[
|
|
528
|
-
[🔑depfu]: https://depfu.com/github/kettle-rb/kettle-soup-cover?project_id=60302
|
|
529
|
-
[🔑depfui♻️]: https://badges.depfu.com/badges/71e1a65eafef1b12a044bf04bbea4f90/count.svg
|
|
882
|
+
[🏀qlty-mnt]: https://qlty.sh/gh/kettle-rb/projects/kettle-soup-cover
|
|
883
|
+
[🏀qlty-mnti]: https://qlty.sh/gh/kettle-rb/projects/kettle-soup-cover/maintainability.svg
|
|
884
|
+
[🏀qlty-cov]: https://qlty.sh/gh/kettle-rb/projects/kettle-soup-cover/metrics/code?sort=coverageRating
|
|
885
|
+
[🏀qlty-covi]: https://qlty.sh/gh/kettle-rb/projects/kettle-soup-cover/coverage.svg
|
|
886
|
+
[🏀codecov]: https://codecov.io/gh/kettle-rb/kettle-soup-cover
|
|
887
|
+
[🏀codecovi]: https://codecov.io/gh/kettle-rb/kettle-soup-cover/graph/badge.svg
|
|
888
|
+
[🏀coveralls]: https://coveralls.io/github/kettle-rb/kettle-soup-cover?branch=main
|
|
889
|
+
[🏀coveralls-img]: https://coveralls.io/repos/github/kettle-rb/kettle-soup-cover/badge.svg?branch=main
|
|
530
890
|
[🖐codeQL]: https://github.com/kettle-rb/kettle-soup-cover/security/code-scanning
|
|
531
891
|
[🖐codeQL-img]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/codeql-analysis.yml/badge.svg
|
|
532
892
|
[🚎1-an-wf]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/ancient.yml
|
|
@@ -545,8 +905,20 @@ P.S. If you need help️, or want to say thanks, 👇 Join the Discord.
|
|
|
545
905
|
[🚎7-us-wfi]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/unsupported.yml/badge.svg
|
|
546
906
|
[🚎8-ho-wf]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/hoary.yml
|
|
547
907
|
[🚎8-ho-wfi]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/hoary.yml/badge.svg
|
|
908
|
+
[🚎9-t-wf]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/truffle.yml
|
|
909
|
+
[🚎9-t-wfi]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/truffle.yml/badge.svg
|
|
910
|
+
[🚎10-j-wf]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/jruby.yml
|
|
911
|
+
[🚎10-j-wfi]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/jruby.yml/badge.svg
|
|
548
912
|
[🚎11-c-wf]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/current.yml
|
|
549
913
|
[🚎11-c-wfi]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/current.yml/badge.svg
|
|
914
|
+
[🚎12-crh-wf]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/dep-heads.yml
|
|
915
|
+
[🚎12-crh-wfi]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/dep-heads.yml/badge.svg
|
|
916
|
+
[🚎13-🔒️-wf]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/locked_deps.yml
|
|
917
|
+
[🚎13-🔒️-wfi]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/locked_deps.yml/badge.svg
|
|
918
|
+
[🚎14-🔓️-wf]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/unlocked_deps.yml
|
|
919
|
+
[🚎14-🔓️-wfi]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/unlocked_deps.yml/badge.svg
|
|
920
|
+
[🚎15-🪪-wf]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/license-eye.yml
|
|
921
|
+
[🚎15-🪪-wfi]: https://github.com/kettle-rb/kettle-soup-cover/actions/workflows/license-eye.yml/badge.svg
|
|
550
922
|
[💎ruby-2.7i]: https://img.shields.io/badge/Ruby-2.7-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
|
551
923
|
[💎ruby-3.0i]: https://img.shields.io/badge/Ruby-3.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
552
924
|
[💎ruby-3.1i]: https://img.shields.io/badge/Ruby-3.1-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
@@ -554,6 +926,17 @@ P.S. If you need help️, or want to say thanks, 👇 Join the Discord.
|
|
|
554
926
|
[💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
|
555
927
|
[💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
|
|
556
928
|
[💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
|
|
929
|
+
[💎truby-22.3i]: https://img.shields.io/badge/Truffle_Ruby-22.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
|
|
930
|
+
[💎truby-23.0i]: https://img.shields.io/badge/Truffle_Ruby-23.0_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
|
|
931
|
+
[💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
|
|
932
|
+
[💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
|
|
933
|
+
[💎truby-headi]: https://img.shields.io/badge/Truffle_Ruby-HEAD-34BCB1?style=for-the-badge&logo=ruby&logoColor=blue
|
|
934
|
+
[💎jruby-9.1i]: https://img.shields.io/badge/JRuby-9.1_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
|
|
935
|
+
[💎jruby-9.2i]: https://img.shields.io/badge/JRuby-9.2_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
|
|
936
|
+
[💎jruby-9.3i]: https://img.shields.io/badge/JRuby-9.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
|
|
937
|
+
[💎jruby-9.4i]: https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red
|
|
938
|
+
[💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
|
|
939
|
+
[💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
|
|
557
940
|
[🤝gh-issues]: https://github.com/kettle-rb/kettle-soup-cover/issues
|
|
558
941
|
[🤝gh-pulls]: https://github.com/kettle-rb/kettle-soup-cover/pulls
|
|
559
942
|
[🤝gl-issues]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/issues
|
|
@@ -562,7 +945,7 @@ P.S. If you need help️, or want to say thanks, 👇 Join the Discord.
|
|
|
562
945
|
[🤝cb-pulls]: https://codeberg.org/kettle-rb/kettle-soup-cover/pulls
|
|
563
946
|
[🤝cb-donate]: https://donate.codeberg.org/
|
|
564
947
|
[🤝contributing]: CONTRIBUTING.md
|
|
565
|
-
[
|
|
948
|
+
[🏀codecov-g]: https://codecov.io/gh/kettle-rb/kettle-soup-cover/graphs/tree.svg
|
|
566
949
|
[🖐contrib-rocks]: https://contrib.rocks
|
|
567
950
|
[🖐contributors]: https://github.com/kettle-rb/kettle-soup-cover/graphs/contributors
|
|
568
951
|
[🖐contributors-img]: https://contrib.rocks/image?repo=kettle-rb/kettle-soup-cover
|
|
@@ -577,22 +960,26 @@ P.S. If you need help️, or want to say thanks, 👇 Join the Discord.
|
|
|
577
960
|
[📌changelog]: CHANGELOG.md
|
|
578
961
|
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
579
962
|
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
|
|
580
|
-
[📌gitmoji]:https://gitmoji.dev
|
|
581
|
-
[📌gitmoji-img]:https://img.shields.io/badge/gitmoji_commits-%20
|
|
963
|
+
[📌gitmoji]: https://gitmoji.dev
|
|
964
|
+
[📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
|
|
582
965
|
[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
|
|
583
|
-
[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.
|
|
966
|
+
[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.141-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
|
|
584
967
|
[🔐security]: SECURITY.md
|
|
585
968
|
[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
|
|
586
969
|
[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
|
|
587
970
|
[📄license]: LICENSE.txt
|
|
588
971
|
[📄license-ref]: https://opensource.org/licenses/MIT
|
|
589
972
|
[📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
|
|
973
|
+
[📄license-compat]: https://dev.to/galtzo/how-to-check-license-compatibility-41h0
|
|
974
|
+
[📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-%E2%9C%93-259D6C.svg?style=flat&logo=Apache
|
|
590
975
|
[📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
|
|
591
976
|
[📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
|
|
592
977
|
[🚎yard-current]: http://rubydoc.info/gems/kettle-soup-cover
|
|
593
978
|
[🚎yard-head]: https://kettle-soup-cover.galtzo.com
|
|
594
|
-
[💎stone_checksums]: https://github.com/
|
|
979
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
595
980
|
[💎SHA_checksums]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/tree/main/checksums
|
|
596
981
|
[💎rlts]: https://github.com/rubocop-lts/rubocop-lts
|
|
597
|
-
[💎rlts-img]: https://img.shields.io/badge/code_style_
|
|
982
|
+
[💎rlts-img]: https://img.shields.io/badge/code_style_&_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
983
|
+
[💎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
984
|
+
[💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
|
|
598
985
|
[💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
|