kettle-rb 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +0 -0
  3. data/CHANGELOG.md +30 -10
  4. data/README.md +4 -4
  5. data/lib/kettle/rb/compat_matrix.rb +1 -1
  6. data/lib/kettle/rb/version.rb +1 -1
  7. data/sig/kettle/rb.rbs +35 -0
  8. data.tar.gz.sig +0 -0
  9. metadata +11 -29
  10. metadata.gz.sig +0 -0
  11. data/CITATION.cff +0 -20
  12. data/CODE_OF_CONDUCT.md +0 -134
  13. data/CONTRIBUTING.md +0 -275
  14. data/FUNDING.md +0 -70
  15. data/MIT.md +0 -21
  16. data/RUBOCOP.md +0 -71
  17. data/SECURITY.md +0 -21
  18. data/certs/pboling.pem +0 -27
  19. data/sig/kettle/rb/version.rbs +0 -8
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9f638ae29a23088ae553db29f15cdc09837ed6f85cf64718c1322dc16b014a13
4
- data.tar.gz: cfb129a81dd80034de4569931948a22819c0a88bbb808f4c3ad60756576a3252
3
+ metadata.gz: ede265e098371f83183b2c56c0c7f071177b6af5140f9c1b9157c58f01dc56be
4
+ data.tar.gz: d02c9f75569af48a418fc18e11adefa01863ba9f97d1ff5fbf34072869a53b6e
5
5
  SHA512:
6
- metadata.gz: 85c2ff775f89b2d2d21e7f952004391ba25838eb0fea6d653c34f2082e5677c9d594952bdf83aeed2ffa48f3544dbc323fad04c5eb28f707d101ca9886c161a2
7
- data.tar.gz: c2430d5eecd35c40a7c9ad08530dc2caf2ee86e532801c8f655d49708c78f9d1d41d00ffcb259871bd75b7bdb917e5c47e5136d55bd4a899e7008aaf23d4979b
6
+ metadata.gz: a401bb3646e51965d684922e1ff29d9c66c7840c969bfbc2d27afff4d84a17c65c7e56d853c9e445c6e62301aa91c56c607e86329ec8a8ef172de1dab882e9d0
7
+ data.tar.gz: 20eee38ea0642a6001a67fafdf0bc55a61ecddf4fd0235f8b9865a0565ed2e800b220100c53039067a2917c65b72502978fb4e58413b0c19633698f66477c36b
checksums.yaml.gz.sig CHANGED
Binary file
data/CHANGELOG.md CHANGED
@@ -30,6 +30,24 @@ Please file a bug if you notice a violation of semantic versioning.
30
30
 
31
31
  ### Security
32
32
 
33
+ ## [0.1.3] - 2026-07-17
34
+
35
+ - TAG: [v0.1.3][0.1.3t]
36
+ - COVERAGE: 100.00% -- 76/76 lines in 3 files
37
+ - BRANCH COVERAGE: 100.00% -- 16/16 branches in 3 files
38
+ - 43.90% documented
39
+
40
+ ### Changed
41
+
42
+ - kettle-jem-template-20260716-001 - Shim gemspec manifests now include
43
+ `LICENSE.md` instead of nonexistent `LICENSE.txt`.
44
+ - kettle-jem-template-20260716-002 - Generated gemspec manifests now ship fewer
45
+ repository-only files by default to reduce downstream distro packaging churn.
46
+
47
+ ### Fixed
48
+
49
+ - Recognize the JRuby 10.0 workflow as a JRuby engine workflow in the compatibility matrix.
50
+
33
51
  ## [0.1.2] - 2026-07-15
34
52
 
35
53
  - TAG: [v0.1.2][0.1.2t]
@@ -56,7 +74,7 @@ Please file a bug if you notice a violation of semantic versioning.
56
74
  so released RuboCop-LTS gems are selected by absence of local-mode override.
57
75
 
58
76
  - Replaced scaffold gemspec summary and description placeholders with
59
- kettle-rb-specific package metadata.
77
+ kettle-dev-specific package metadata.
60
78
 
61
79
  ### Added
62
80
 
@@ -79,12 +97,14 @@ Please file a bug if you notice a violation of semantic versioning.
79
97
  ### Added
80
98
 
81
99
  - Add `Kettle::Rb::CompatMatrix` as the shared Ruby, engine, Rails, RuboCop,
82
- and RuboCop LTS compatibility source of truth for kettle-rb tooling.
83
-
84
- [Unreleased]: https://github.com/kettle-dev/kettle-rb/compare/v0.1.2...HEAD
85
- [0.1.2]: https://github.com/kettle-dev/kettle-rb/compare/v0.1.1...v0.1.2
86
- [0.1.2t]: https://github.com/kettle-dev/kettle-rb/releases/tag/v0.1.2
87
- [0.1.1]: https://github.com/kettle-dev/kettle-rb/compare/v0.1.0...v0.1.1
88
- [0.1.1t]: https://github.com/kettle-dev/kettle-rb/releases/tag/v0.1.1
89
- [0.1.0]: https://github.com/kettle-dev/kettle-rb/compare/7d715a6109f43ab78253e31ea49b280b659a060d...v0.1.0
90
- [0.1.0t]: https://github.com/kettle-dev/kettle-rb/releases/tag/v0.1.0
100
+ and RuboCop LTS compatibility source of truth for kettle-dev tooling.
101
+
102
+ [Unreleased]: https://github.com/kettle-dev/kettle-rb/compare/v0.1.3...HEAD
103
+ [0.1.3]: https://github.com/kettle-dev/kettle-rb/compare/v0.1.2...v0.1.3
104
+ [0.1.3t]: https://github.com/kettle-dev/kettle-rb/releases/tag/v0.1.3
105
+ [0.1.2]: https://github.com/kettle-dev/kettle-dev/compare/v0.1.1...v0.1.2
106
+ [0.1.2t]: https://github.com/kettle-dev/kettle-dev/releases/tag/v0.1.2
107
+ [0.1.1]: https://github.com/kettle-dev/kettle-dev/compare/v0.1.0...v0.1.1
108
+ [0.1.1t]: https://github.com/kettle-dev/kettle-dev/releases/tag/v0.1.1
109
+ [0.1.0]: https://github.com/kettle-dev/kettle-dev/compare/7d715a6109f43ab78253e31ea49b280b659a060d...v0.1.0
110
+ [0.1.0t]: https://github.com/kettle-dev/kettle-dev/releases/tag/v0.1.0
data/README.md CHANGED
@@ -21,7 +21,7 @@ I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-ta
21
21
 
22
22
  ## 🌻 Synopsis <a href="https://discord.gg/3qme4XHNKN"><img alt="Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px.svg" width="8%" align="right"/></a> <a href="https://ruby-toolbox.com"><img alt="ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5" src="https://logos.galtzo.com/assets/images/ruby-lang/avatar-128px.svg" width="8%" align="right"/></a>
23
23
 
24
- `kettle-rb` is the small shared Ruby library for the kettle-dev toolchain.
24
+ `kettle-dev` is the small shared Ruby library for the kettle-dev toolchain.
25
25
 
26
26
  Its first public responsibility is `Kettle::Rb::CompatMatrix`: a single source
27
27
  of truth for Ruby engine compatibility data used by `kettle-jem`,
@@ -137,15 +137,15 @@ gem install kettle-rb
137
137
 
138
138
  ## ⚙️ Configuration
139
139
 
140
- `kettle-rb` has no runtime configuration. The compatibility matrix is packaged
140
+ `kettle-dev` has no runtime configuration. The compatibility matrix is packaged
141
141
  with the gem and exposed as immutable data.
142
142
 
143
143
  Tooling that needs local, unreleased kettle-dev siblings should use normal
144
- Bundler/Gemfile wiring through `KETTLE_RB_DEV`; do not alter `$LOAD_PATH`.
144
+ Bundler/Gemfile wiring through `KETTLE_DEV_DEV`; do not alter `$LOAD_PATH`.
145
145
  For example, downstream kettle gems can resolve a local checkout with:
146
146
 
147
147
  ```console
148
- KETTLE_RB_DEV=/home/pboling/src/my/kettle-dev bundle install
148
+ KETTLE_DEV_DEV=/home/pboling/src/my/kettle-dev bundle install
149
149
  ```
150
150
 
151
151
  After changing matrix data, update this gem first, release it, then bump the
data/lib/kettle/rb/compat_matrix.rb CHANGED
@@ -54,7 +54,7 @@ module Kettle
54
54
  ["truffleruby-25.0", "truffleruby-25.0.0", "truffleruby", "3.3", "3.3", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, TRUFFLERUBY_NOTES],
55
55
  ["truffleruby-33.0", "truffleruby-33.0.1", "truffleruby", "3.3", "3.3", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, TRUFFLERUBY_NOTES],
56
56
  ["ruby-3.4", "3.4.7", "ruby", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil],
57
- ["jruby-10.1", "jruby-10.1.0.0", "jruby", "3.4", "3.4", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil],
57
+ ["jruby-10.0", "jruby-10.0.0.0", "jruby", "3.4", "3.4", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil],
58
58
  ["truffleruby-34.0", "truffleruby-34.0.1", "truffleruby", "3.4", "3.4", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, TRUFFLERUBY_NOTES]
59
59
  ].freeze
60
60
 
data/lib/kettle/rb/version.rb CHANGED
@@ -3,7 +3,7 @@
3
3
  module Kettle
4
4
  module Rb
5
5
  module Version
6
- VERSION = "0.1.2"
6
+ VERSION = "0.1.3"
7
7
  end
8
8
  VERSION = Version::VERSION # Traditional Constant Location
9
9
  end
data/sig/kettle/rb.rbs CHANGED
@@ -1,5 +1,40 @@
1
1
  module Kettle
2
2
  module Rb
3
3
  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
5
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
6
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
7
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
8
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
9
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
10
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
11
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
12
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
13
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
14
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
15
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
16
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
17
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
18
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
19
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
20
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
21
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
22
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
23
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
24
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
25
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
26
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
27
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
28
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
29
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
30
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
31
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
32
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
33
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
34
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
35
+ module Version
36
+ VERSION: String
37
+ end
38
+ VERSION: String
4
39
  end
5
40
  end
data.tar.gz.sig CHANGED
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: kettle-rb
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.2
4
+ version: 0.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Peter H. Boling
@@ -46,7 +46,7 @@ dependencies:
46
46
  version: '2.3'
47
47
  - - ">="
48
48
  - !ruby/object:Gem::Version
49
- version: 2.3.4
49
+ version: 2.3.5
50
50
  type: :development
51
51
  prerelease: false
52
52
  version_requirements: !ruby/object:Gem::Requirement
@@ -56,7 +56,7 @@ dependencies:
56
56
  version: '2.3'
57
57
  - - ">="
58
58
  - !ruby/object:Gem::Version
59
- version: 2.3.4
59
+ version: 2.3.5
60
60
  - !ruby/object:Gem::Dependency
61
61
  name: bundler-audit
62
62
  requirement: !ruby/object:Gem::Requirement
@@ -134,7 +134,7 @@ dependencies:
134
134
  version: '2.0'
135
135
  - - ">="
136
136
  - !ruby/object:Gem::Version
137
- version: 2.0.10
137
+ version: 2.0.11
138
138
  type: :development
139
139
  prerelease: false
140
140
  version_requirements: !ruby/object:Gem::Requirement
@@ -144,7 +144,7 @@ dependencies:
144
144
  version: '2.0'
145
145
  - - ">="
146
146
  - !ruby/object:Gem::Version
147
- version: 2.0.10
147
+ version: 2.0.11
148
148
  - !ruby/object:Gem::Dependency
149
149
  name: turbo_tests2
150
150
  requirement: !ruby/object:Gem::Requirement
@@ -154,7 +154,7 @@ dependencies:
154
154
  version: '3.1'
155
155
  - - ">="
156
156
  - !ruby/object:Gem::Version
157
- version: 3.1.9
157
+ version: 3.1.14
158
158
  type: :development
159
159
  prerelease: false
160
160
  version_requirements: !ruby/object:Gem::Requirement
@@ -164,7 +164,7 @@ dependencies:
164
164
  version: '3.1'
165
165
  - - ">="
166
166
  - !ruby/object:Gem::Version
167
- version: 3.1.9
167
+ version: 3.1.14
168
168
  - !ruby/object:Gem::Dependency
169
169
  name: ruby-progressbar
170
170
  requirement: !ruby/object:Gem::Requirement
@@ -225,42 +225,24 @@ email:
225
225
  - floss@galtzo.com
226
226
  executables: []
227
227
  extensions: []
228
- extra_rdoc_files:
229
- - CHANGELOG.md
230
- - CITATION.cff
231
- - CODE_OF_CONDUCT.md
232
- - CONTRIBUTING.md
233
- - FUNDING.md
234
- - LICENSE.md
235
- - README.md
236
- - RUBOCOP.md
237
- - SECURITY.md
228
+ extra_rdoc_files: []
238
229
  files:
239
230
  - CHANGELOG.md
240
- - CITATION.cff
241
- - CODE_OF_CONDUCT.md
242
- - CONTRIBUTING.md
243
- - FUNDING.md
244
231
  - LICENSE.md
245
- - MIT.md
246
232
  - README.md
247
- - RUBOCOP.md
248
- - SECURITY.md
249
- - certs/pboling.pem
250
233
  - lib/kettle/rb.rb
251
234
  - lib/kettle/rb/compat_matrix.rb
252
235
  - lib/kettle/rb/version.rb
253
236
  - sig/kettle/rb.rbs
254
- - sig/kettle/rb/version.rbs
255
237
  homepage: https://github.com/kettle-dev/kettle-rb
256
238
  licenses:
257
239
  - MIT
258
240
  metadata:
259
241
  homepage_uri: https://kettle-rb.galtzo.com
260
- source_code_uri: https://github.com/kettle-dev/kettle-rb/tree/v0.1.2
261
- changelog_uri: https://github.com/kettle-dev/kettle-rb/blob/v0.1.2/CHANGELOG.md
242
+ source_code_uri: https://github.com/kettle-dev/kettle-rb/tree/v0.1.3
243
+ changelog_uri: https://github.com/kettle-dev/kettle-rb/blob/v0.1.3/CHANGELOG.md
262
244
  bug_tracker_uri: https://github.com/kettle-dev/kettle-rb/issues
263
- documentation_uri: https://www.rubydoc.info/gems/kettle-rb/0.1.2
245
+ documentation_uri: https://www.rubydoc.info/gems/kettle-rb/0.1.3
264
246
  funding_uri: https://github.com/sponsors/pboling
265
247
  wiki_uri: https://github.com/kettle-dev/kettle-rb/wiki
266
248
  news_uri: https://www.railsbling.com/tags/kettle-rb
metadata.gz.sig CHANGED
Binary file
data/CITATION.cff DELETED
@@ -1,20 +0,0 @@
1
- cff-version: 1.2.0
2
- title: "kettle-rb"
3
- message: >-
4
- If you use this work and you want to cite it,
5
- then you can use the metadata from this file.
6
- type: software
7
- authors:
8
- - given-names: "Peter H."
9
- family-names: "Boling"
10
- email: "floss@galtzo.com"
11
- affiliation: "galtzo.com"
12
- orcid: 'https://orcid.org/0009-0008-8519-441X'
13
- identifiers:
14
- - type: url
15
- value: 'https://github.com/kettle-dev/kettle-rb'
16
- description: "kettle-rb"
17
- repository-code: 'https://github.com/kettle-dev/kettle-rb'
18
- abstract: >-
19
- kettle-rb
20
- license: See license file
data/CODE_OF_CONDUCT.md DELETED
@@ -1,134 +0,0 @@
1
- # Contributor Covenant Code of Conduct
2
-
3
- ## Our Pledge
4
-
5
- We as members, contributors, and leaders pledge to make participation in our
6
- community a harassment-free experience for everyone, regardless of age, body
7
- size, visible or invisible disability, ethnicity, sex characteristics, gender
8
- identity and expression, level of experience, education, socio-economic status,
9
- nationality, personal appearance, race, caste, color, religion, or sexual
10
- identity and orientation.
11
-
12
- We pledge to act and interact in ways that contribute to an open, welcoming,
13
- diverse, inclusive, and healthy community.
14
-
15
- ## Our Standards
16
-
17
- Examples of behavior that contributes to a positive environment for our
18
- community include:
19
-
20
- * Demonstrating empathy and kindness toward other people
21
- * Being respectful of differing opinions, viewpoints, and experiences
22
- * Giving and gracefully accepting constructive feedback
23
- * Accepting responsibility and apologizing to those affected by our mistakes,
24
- and learning from the experience
25
- * Focusing on what is best not just for us as individuals, but for the overall
26
- community
27
-
28
- Examples of unacceptable behavior include:
29
-
30
- * The use of sexualized language or imagery, and sexual attention or advances of
31
- any kind
32
- * Trolling, insulting or derogatory comments, and personal or political attacks
33
- * Public or private harassment
34
- * Publishing others' private information, such as a physical or email address,
35
- without their explicit permission
36
- * Other conduct which could reasonably be considered inappropriate in a
37
- professional setting
38
-
39
- ## Enforcement Responsibilities
40
-
41
- Community leaders are responsible for clarifying and enforcing our standards of
42
- acceptable behavior and will take appropriate and fair corrective action in
43
- response to any behavior that they deem inappropriate, threatening, offensive,
44
- or harmful.
45
-
46
- Community leaders have the right and responsibility to remove, edit, or reject
47
- comments, commits, code, wiki edits, issues, and other contributions that are
48
- not aligned to this Code of Conduct, and will communicate reasons for moderation
49
- decisions when appropriate.
50
-
51
- ## Scope
52
-
53
- This Code of Conduct applies within all community spaces, and also applies when
54
- an individual is officially representing the community in public spaces.
55
- Examples of representing our community include using an official email address,
56
- posting via an official social media account, or acting as an appointed
57
- representative at an online or offline event.
58
-
59
- ## Enforcement
60
-
61
- Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
- reported to the community leaders responsible for enforcement at
63
- [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
64
- All complaints will be reviewed and investigated promptly and fairly.
65
-
66
- All community leaders are obligated to respect the privacy and security of the
67
- reporter of any incident.
68
-
69
- ## Enforcement Guidelines
70
-
71
- Community leaders will follow these Community Impact Guidelines in determining
72
- the consequences for any action they deem in violation of this Code of Conduct:
73
-
74
- ### 1. Correction
75
-
76
- **Community Impact**: Use of inappropriate language or other behavior deemed
77
- unprofessional or unwelcome in the community.
78
-
79
- **Consequence**: A private, written warning from community leaders, providing
80
- clarity around the nature of the violation and an explanation of why the
81
- behavior was inappropriate. A public apology may be requested.
82
-
83
- ### 2. Warning
84
-
85
- **Community Impact**: A violation through a single incident or series of
86
- actions.
87
-
88
- **Consequence**: A warning with consequences for continued behavior. No
89
- interaction with the people involved, including unsolicited interaction with
90
- those enforcing the Code of Conduct, for a specified period of time. This
91
- includes avoiding interactions in community spaces as well as external channels
92
- like social media. Violating these terms may lead to a temporary or permanent
93
- ban.
94
-
95
- ### 3. Temporary Ban
96
-
97
- **Community Impact**: A serious violation of community standards, including
98
- sustained inappropriate behavior.
99
-
100
- **Consequence**: A temporary ban from any sort of interaction or public
101
- communication with the community for a specified period of time. No public or
102
- private interaction with the people involved, including unsolicited interaction
103
- with those enforcing the Code of Conduct, is allowed during this period.
104
- Violating these terms may lead to a permanent ban.
105
-
106
- ### 4. Permanent Ban
107
-
108
- **Community Impact**: Demonstrating a pattern of violation of community
109
- standards, including sustained inappropriate behavior, harassment of an
110
- individual, or aggression toward or disparagement of classes of individuals.
111
-
112
- **Consequence**: A permanent ban from any sort of public interaction within the
113
- community.
114
-
115
- ## Attribution
116
-
117
- This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
- version 2.1, available at
119
- [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120
-
121
- Community Impact Guidelines were inspired by
122
- [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123
-
124
- For answers to common questions about this code of conduct, see the FAQ at
125
- [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126
- [https://www.contributor-covenant.org/translations][translations].
127
-
128
- [homepage]: https://www.contributor-covenant.org
129
- [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130
- [Mozilla CoC]: https://github.com/mozilla/diversity
131
- [FAQ]: https://www.contributor-covenant.org/faq
132
- [translations]: https://www.contributor-covenant.org/translations
133
- [🚂maint-contact]: http://www.railsbling.com/contact
134
- [🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
data/CONTRIBUTING.md DELETED
@@ -1,275 +0,0 @@
1
- # Contributing
2
-
3
- Bug reports and pull requests are welcome on [CodeBerg][📜src-cb], [GitLab][📜src-gl], or [GitHub][📜src-gh].
4
- This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
5
- the [code of conduct][🤝conduct].
6
-
7
- To submit a patch, please fork the project, create a patch with tests, and send a pull request.
8
-
9
- Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
10
-
11
- ## Developer Certificate of Origin
12
-
13
- In order to protect users of this project, we require all contributors to comply with the
14
- [Developer Certificate of Origin](https://developercertificate.org/).
15
- This ensures that all contributions are properly licensed and attributed.
16
-
17
- ## Help out!
18
-
19
- Take a look at the open issues and pull requests, or use the gem and find something to improve.
20
-
21
- Follow these instructions:
22
-
23
- 1. Join the Discord: [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
24
- 2. Fork the repository
25
- 3. Create your feature branch (`git checkout -b my-new-feature`)
26
- 4. Make some fixes.
27
- 5. Commit your changes (`git commit -am 'Added some feature'`)
28
- 6. Push to the branch (`git push origin my-new-feature`)
29
- 7. Make sure to add tests for it. This is important, so it doesn't break in a future release.
30
- 8. Create new Pull Request.
31
- 9. Announce it in the channel for this org in the [Discord][✉️discord-invite]!
32
-
33
- ## Executables vs Rake tasks
34
-
35
- Executables shipped by dependencies, such as kettle-dev, and stone_checksums, are available
36
- after running `bin/setup`. These include:
37
-
38
- - gem_checksums
39
- - kettle-changelog
40
- - kettle-commit-msg
41
- - kettle-dev-setup
42
- - kettle-dvcs
43
- - kettle-pre-release
44
- - kettle-readme-backers
45
- - kettle-release
46
-
47
- There are many Rake tasks available as well. You can see them by running:
48
-
49
- ```shell
50
- bin/rake -T
51
- ```
52
-
53
- ## Code quality checks
54
-
55
- Run the Reek task when you want a smell check that fails on current findings:
56
-
57
- ```shell
58
- bin/rake reek
59
- ```
60
-
61
- Refresh the checked-in `REEK` backlog through the rake task, not by redirecting
62
- the raw `reek` executable output. The rake task uses the project bundle and
63
- avoids stale generated binstubs shadowing the Reek gem executable:
64
-
65
- ```shell
66
- bin/rake reek:update
67
- ```
68
-
69
- ## Environment Variables for Local Development
70
-
71
- Below are the primary environment variables recognized by stone_checksums (and its integrated tools). Unless otherwise noted, set boolean values to the string "true" to enable.
72
-
73
- General/runtime
74
- - DEBUG: Enable extra internal logging for this library (default: false)
75
- - REQUIRE_BENCH: Enable `require_bench` to profile requires (default: false)
76
- - CI: When set to true, adjusts default rake tasks toward CI behavior
77
-
78
- Coverage (kettle-soup-cover / SimpleCov)
79
- - K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
80
- - K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
81
- - K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
82
- - K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
83
- - K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
84
- - K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
85
- - K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
86
- - MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
87
- Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
88
-
89
- GitHub API and CI helpers
90
- - GITHUB_TOKEN or GH_TOKEN: Token used by `ci:act` and release workflow checks to query GitHub Actions status at higher rate limits
91
-
92
- Releasing and signing
93
- - SKIP_GEM_SIGNING: If set, skip gem signing during build/release
94
- - GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
95
- - SOURCE_DATE_EPOCH: Reproducible build timestamp.
96
- - `kettle-release` will set this automatically for the session.
97
- - Not needed on bundler >= 2.7.0, as reproducible builds have become the default.
98
-
99
- Git hooks and commit message helpers (exe/kettle-commit-msg)
100
- - GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
101
- - GIT_HOOK_FOOTER_APPEND: Append a footer to commit messages when goalie allows (true/false)
102
- - GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
103
- - GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
104
-
105
- Git diff driver setup
106
- - Local setup writes repository `.gitattributes` entries and local Git `diff.smorg-*` command config so this checkout uses StructuredMerge semantic diffs.
107
- - Global setup registers `diff.smorg-*` commands once in the user Git config; use it when you work across several StructuredMerge-enabled repositories.
108
- - Include-file setup writes `.git/smorg/config` and includes it from local Git config, keeping command registrations out of the repository files.
109
- - Git hosting forges generally ignore external diff drivers, so pull request views may still show raw textual diffs even when local `git diff` uses semantic drivers.
110
-
111
- ```console
112
- K_JEM_TEMPLATING=true kettle-jem install
113
- ```
114
-
115
- Troubleshooting Git diffs
116
- - Use `git diff --no-ext-diff` to compare against Git's built-in diff output.
117
- - Use `git diff --no-textconv` when a textconv projection obscures the raw file bytes you need to inspect.
118
- - If Git reports a missing `smorg-*` executable, rerun `bundle install` and the setup command above, then check `git config --local --get-regexp '^diff\.smorg-'`.
119
- - To remove managed local entries, run `K_JEM_TEMPLATING=true kettle-jem install --undo`; remove global command registrations with `git config --global --unset-all diff.smorg-ruby.command`.
120
-
121
- For a quick starting point, this repository’s `mise.toml` defines the shared defaults, and `.env.local` can override them locally. Copy `.env.local.example` to `.env.local`, use `KEY=value` lines, and either activate `mise` in your shell or run commands through `mise exec -C /path/to/project -- ...`.
122
-
123
- ## Appraisals
124
-
125
- From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
126
- Generated appraisal and CI workflow floors are controlled by `ruby.test_minimum`
127
- in `.structuredmerge/kettle-jem.yml`; this project was templated with `ruby.test_minimum: 2.4.0`.
128
- That value describes the lowest Ruby version expected to run the test/development
129
- toolchain, and it may be higher than the gemspec runtime floor.
130
-
131
- They are created and updated with the commands:
132
-
133
- ```console
134
- bin/rake appraisal:generate
135
- ```
136
-
137
- Use `bin/rake appraisal:update` when you intentionally need to resolve fresh
138
- appraisal locks.
139
-
140
- If you need to reset all gemfiles/*.gemfile.lock files:
141
-
142
- ```console
143
- bin/rake appraisal:reset
144
- ```
145
-
146
- When adding an appraisal to CI, check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
147
-
148
- ## Run Tests
149
-
150
- Run tests via `kettle-test` (provided by `kettle-test`). It runs RSpec, writes the full log to
151
- `tmp/kettle-test/rspec-TIMESTAMP.log`, and prints a compact highlight block with timing, seed,
152
- pass/fail count, failing example list, and SimpleCov coverage percentages.
153
-
154
- ```console
155
- bundle exec kettle-test
156
- ```
157
-
158
- For targeted runs, disable the hard coverage threshold to avoid false failures:
159
-
160
- ```console
161
- K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
162
- ```
163
-
164
- ### Spec organization (required)
165
-
166
- - One spec file per class/module. For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name exactly: `lib/kettle/rb/my_class.rb` -> `spec/kettle/rb/my_class_spec.rb`.
167
- - Exception: Integration specs that intentionally span multiple classes. Place these under `spec/integration/` (or a clearly named integration folder), and do not directly mirror a single class. Name them after the scenario, not a class.
168
-
169
- ## Lint It
170
-
171
- Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
172
-
173
- ```console
174
- bundle exec rake
175
- ```
176
-
177
- Or just run the linter.
178
-
179
- ```console
180
- bundle exec rake rubocop_gradual:autocorrect
181
- ```
182
-
183
- For more detailed information about using RuboCop in this project, please see the [RUBOCOP.md](RUBOCOP.md) guide. This project uses `rubocop_gradual` instead of vanilla RuboCop, which requires specific commands for checking violations.
184
-
185
- ### Important: Do not add inline RuboCop disables
186
-
187
- Never add `# rubocop:disable ...` / `# rubocop:enable ...` comments to code or specs (except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). Instead:
188
-
189
- - Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
190
- - When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
191
- - `bundle exec rake rubocop_gradual:autocorrect` (preferred)
192
- - `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
193
-
194
- As a general rule, fix style issues rather than ignoring them. For example, our specs should follow RSpec conventions like using `described_class` for the class under test.
195
-
196
- ## Contributors
197
-
198
- Your picture could be here!
199
-
200
- [![Contributors][🖐contributors-img]][🖐contributors]
201
-
202
- Made with [contributors-img][🖐contrib-rocks].
203
-
204
- Also see GitLab Contributors: [https://gitlab.com/kettle-dev/kettle-rb/-/graphs/main][🚎contributors-gl]
205
-
206
- ## For Maintainers
207
-
208
- ### One-time, Per-maintainer, Setup
209
-
210
- **IMPORTANT**: To sign a build,
211
- a public key for signing gems will need to be picked up by the line in the
212
- `gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
213
- All releases are signed releases.
214
- See: [RubyGems Security Guide][🔒️rubygems-security-guide]
215
-
216
- NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
217
-
218
- ### To release a new version:
219
-
220
- #### Automated process
221
-
222
- 1. Update version.rb to contain the correct version-to-be-released.
223
- 2. Run `bundle exec kettle-changelog`.
224
- 3. Run `bundle exec kettle-release`.
225
- 4. Stay awake and monitor the release process for any errors, and answer any prompts.
226
-
227
- #### Manual process
228
-
229
- 1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
230
- 2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
231
- 3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
232
- 4. Run `bin/rake yard` to regenerate the docs site using the canonical docs task
233
- 5. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
234
- 6. Run `git push` to trigger the final CI pipeline before release, and merge PRs
235
- - NOTE: Remember to [check the build][🧪build].
236
- 7. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
237
- 8. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
238
- 9. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
239
- 10. Optional for older Bundler (< 2.7.0): Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use the same timestamp and generate the same checksums
240
- - If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
241
- - Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
242
- - If the echo above has no output, then it didn't work.
243
- - Note: `zsh/datetime` module is needed, if running `zsh`.
244
- - In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
245
- 11. Run `bundle exec rake build`
246
- 12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
247
- to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
248
- [gem][💎stone_checksums].
249
- - The script automatically commits but does not push the checksums
250
- 13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
251
- - `sha256sum pkg/<gem name>-<version>.gem`
252
- 14. Run `bundle exec rake release` which will create a git tag for the version,
253
- push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
254
-
255
- [📜src-gl]: https://gitlab.com/kettle-dev/kettle-rb
256
- [📜src-cb]: https://codeberg.org/kettle-dev/kettle-rb
257
- [📜src-gh]: https://github.com/kettle-dev/kettle-rb
258
- [🧪build]: https://github.com/kettle-dev/kettle-rb/actions
259
- [🤝conduct]: https://github.com/kettle-dev/kettle-rb/blob/main/CODE_OF_CONDUCT.md
260
- [🖐contrib-rocks]: https://contrib.rocks
261
- [🖐contributors]: https://github.com/kettle-dev/kettle-rb/graphs/contributors
262
- [🚎contributors-gl]: https://gitlab.com/kettle-dev/kettle-rb/-/graphs/main
263
- [🖐contributors-img]: https://contrib.rocks/image?repo=kettle-dev/kettle-rb
264
- [💎gem-coop]: https://gem.coop
265
- [🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
266
- [🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
267
- [🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
268
- [💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
269
- [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
270
- [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
271
- [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
272
- [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
273
- [🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
274
- [🏃‍♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
275
- [✉️discord-invite]: https://discord.gg/3qme4XHNKN
data/FUNDING.md DELETED
@@ -1,70 +0,0 @@
1
- <!-- RELEASE-NOTES-FOOTER-START -->
2
-
3
- Official Discord 👉️ [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
4
-
5
- Many paths lead to being a sponsor or a backer of this project. Are you on such a path?
6
-
7
- [![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]
8
-
9
- [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate to my FLOSS efforts at ko-fi.com][🖇kofi-img]][🖇kofi]
10
-
11
- [⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611&style=flat
12
- [⛳liberapay]: https://liberapay.com/pboling/donate
13
- [🖇osc-backers]: https://opencollective.com/kettle-dev#backer
14
- [🖇osc-backers-i]: https://opencollective.com/kettle-dev/backers/badge.svg?style=flat
15
- [🖇osc-sponsors]: https://opencollective.com/kettle-dev#sponsor
16
- [🖇osc-sponsors-i]: https://opencollective.com/kettle-dev/sponsors/badge.svg?style=flat
17
- [🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
18
- [🖇sponsor]: https://github.com/sponsors/pboling
19
- [🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
20
- [🖇kofi]: https://ko-fi.com/pboling
21
- [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat
22
- [🖇buyme]: https://www.buymeacoffee.com/pboling
23
- [🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
24
- [🖇paypal]: https://www.paypal.com/paypalme/peterboling
25
- [✉️discord-invite]: https://discord.gg/3qme4XHNKN
26
- [✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=flat
27
-
28
- <!-- RELEASE-NOTES-FOOTER-END -->
29
-
30
- # 🤑 A request for help
31
-
32
- Maintainers have teeth and need to pay their dentists.
33
- After getting laid off in an RIF in March, and encountering difficulty finding a new one,
34
- I began spending most of my time building open source tools.
35
- I'm hoping to be able to pay for my kids' health insurance this month,
36
- so if you value the work I am doing, I need your support.
37
- Please consider sponsoring me or the project.
38
-
39
- To join the community or get help 👇️ Join the Discord.
40
-
41
- [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
42
-
43
- To say "thanks!" ☝️ Join the Discord or 👇️ send money.
44
-
45
- [![Sponsor kettle-dev/kettle-rb 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]
46
-
47
- # Another Way to Support Open Source Software
48
-
49
- 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).
50
-
51
- 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`.
52
-
53
- 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.
54
-
55
- **[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
56
-
57
- [⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
58
- [🖇osc-all-img]: https://img.shields.io/opencollective/all/kettle-dev
59
- [🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/kettle-dev
60
- [🖇osc-backers-img]: https://img.shields.io/opencollective/backers/kettle-dev
61
- [🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/kettle-dev?style=for-the-badge
62
- [🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/kettle-dev?style=for-the-badge
63
- [🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/kettle-dev?style=for-the-badge
64
- [🖇osc]: https://opencollective.com/kettle-dev
65
- [🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
66
- [🖇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
67
- [🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
68
- [🖇floss-funding.dev]: https://floss-funding.dev
69
- [🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
70
- [✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge
data/MIT.md DELETED
@@ -1,21 +0,0 @@
1
- The MIT License (MIT)
2
-
3
- See [LICENSE.md](LICENSE.md) for the copyright notice.
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.
data/RUBOCOP.md DELETED
@@ -1,71 +0,0 @@
1
- # RuboCop Usage Guide
2
-
3
- ## Overview
4
-
5
- A tale of two RuboCop plugin gems.
6
-
7
- ### RuboCop Gradual
8
-
9
- This project uses `rubocop_gradual` instead of vanilla RuboCop for code style checking. The `rubocop_gradual` tool allows for gradual adoption of RuboCop rules by tracking violations in a lock file.
10
-
11
- ### RuboCop LTS
12
-
13
- This project uses `rubocop-lts` to ensure, on a best-effort basis, compatibility with Ruby >= 1.9.2.
14
- RuboCop rules are meticulously configured by the `rubocop-lts` family of gems to ensure that a project is compatible with a specific version of Ruby. See: https://rubocop-lts.gitlab.io for more.
15
-
16
- ## Checking RuboCop Violations
17
-
18
- To check for RuboCop violations in this project, always use:
19
-
20
- ```bash
21
- bundle exec rake rubocop_gradual:check
22
- ```
23
-
24
- **Do not use** the standard RuboCop commands like:
25
- - `bundle exec rubocop`
26
- - `rubocop`
27
-
28
- ## Understanding the Lock File
29
-
30
- The `.rubocop_gradual.lock` file tracks all current RuboCop violations in the project. This allows the team to:
31
-
32
- 1. Prevent new violations while gradually fixing existing ones
33
- 2. Track progress on code style improvements
34
- 3. Ensure CI builds don't fail due to pre-existing violations
35
-
36
- ## Common Commands
37
-
38
- - **Check violations**
39
- - `bundle exec rake rubocop_gradual`
40
- - `bundle exec rake rubocop_gradual:check`
41
- - **(Safe) Autocorrect violations, and update lockfile if no new violations**
42
- - `bundle exec rake rubocop_gradual:autocorrect`
43
- - **Force update the lock file (w/o autocorrect) to match violations present in code**
44
- - `bundle exec rake rubocop_gradual:force_update`
45
-
46
- ## Workflow
47
-
48
- 1. Before submitting a PR, run `bundle exec rake rubocop_gradual:autocorrect`
49
- a. or just the default `bundle exec rake`, as autocorrection is a pre-requisite of the default task.
50
- 2. If there are new violations, either:
51
- - Fix them in your code
52
- - Run `bundle exec rake rubocop_gradual:force_update` to update the lock file (only for violations you can't fix immediately)
53
- 3. Commit the updated `.rubocop_gradual.lock` file along with your changes
54
-
55
- ## Never add inline RuboCop disables
56
-
57
- Do not add inline `rubocop:disable` / `rubocop:enable` comments anywhere in the codebase (including specs, except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). We handle exceptions in two supported ways:
58
-
59
- - Permanent/structural exceptions: prefer adjusting the RuboCop configuration (e.g., in `.rubocop.yml`) to exclude a rule for a path or file pattern when it makes sense project-wide.
60
- - Temporary exceptions while improving code: record the current violations in `.rubocop_gradual.lock` via the gradual workflow:
61
- - `bundle exec rake rubocop_gradual:autocorrect` (preferred; will autocorrect what it can and update the lock only if no new violations were introduced)
62
- - If needed, `bundle exec rake rubocop_gradual:force_update` (as a last resort when you cannot fix the newly reported violations immediately)
63
-
64
- In general, treat the rules as guidance to follow; fix violations rather than ignore them. For example, RSpec conventions in this project expect `described_class` to be used in specs that target a specific class under test.
65
-
66
- ## Benefits of rubocop_gradual
67
-
68
- - Allows incremental adoption of code style rules
69
- - Prevents CI failures due to pre-existing violations
70
- - Provides a clear record of code style debt
71
- - Enables focused efforts on improving code quality over time
data/SECURITY.md DELETED
@@ -1,21 +0,0 @@
1
- # Security Policy
2
-
3
- ## Supported Versions
4
-
5
- | Version | Supported |
6
- |----------|-----------|
7
- | 0.latest | ✅ |
8
-
9
- ## Security contact information
10
-
11
- To report a security vulnerability, please use the
12
- [Tidelift security contact](https://tidelift.com/security).
13
- Tidelift will coordinate the fix and disclosure.
14
-
15
- ## Additional Support
16
-
17
- If you are interested in support for versions older than the latest release,
18
- please consider sponsoring the project / maintainer @ https://liberapay.com/pboling/donate,
19
- or find other sponsorship links in the [README].
20
-
21
- [README]: README.md
data/certs/pboling.pem DELETED
@@ -1,27 +0,0 @@
1
- -----BEGIN CERTIFICATE-----
2
- MIIEgDCCAuigAwIBAgIBATANBgkqhkiG9w0BAQsFADBDMRUwEwYDVQQDDAxwZXRl
3
- ci5ib2xpbmcxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
4
- A2NvbTAeFw0yNTA1MDQxNTMzMDlaFw00NTA0MjkxNTMzMDlaMEMxFTATBgNVBAMM
5
- DHBldGVyLmJvbGluZzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
6
- LGQBGRYDY29tMIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAruUoo0WA
7
- uoNuq6puKWYeRYiZekz/nsDeK5x/0IEirzcCEvaHr3Bmz7rjo1I6On3gGKmiZs61
8
- LRmQ3oxy77ydmkGTXBjruJB+pQEn7UfLSgQ0xa1/X3kdBZt6RmabFlBxnHkoaGY5
9
- mZuZ5+Z7walmv6sFD9ajhzj+oIgwWfnEHkXYTR8I6VLN7MRRKGMPoZ/yvOmxb2DN
10
- coEEHWKO9CvgYpW7asIihl/9GMpKiRkcYPm9dGQzZc6uTwom1COfW0+ZOFrDVBuV
11
- FMQRPswZcY4Wlq0uEBLPU7hxnCL9nKK6Y9IhdDcz1mY6HZ91WImNslOSI0S8hRpj
12
- yGOWxQIhBT3fqCBlRIqFQBudrnD9jSNpSGsFvbEijd5ns7Z9ZMehXkXDycpGAUj1
13
- to/5cuTWWw1JqUWrKJYoifnVhtE1o1DZ+LkPtWxHtz5kjDG/zR3MG0Ula0UOavlD
14
- qbnbcXPBnwXtTFeZ3C+yrWpE4pGnl3yGkZj9SMTlo9qnTMiPmuWKQDatAgMBAAGj
15
- fzB9MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQE8uWvNbPVNRXZ
16
- HlgPbc2PCzC4bjAhBgNVHREEGjAYgRZwZXRlci5ib2xpbmdAZ21haWwuY29tMCEG
17
- A1UdEgQaMBiBFnBldGVyLmJvbGluZ0BnbWFpbC5jb20wDQYJKoZIhvcNAQELBQAD
18
- ggGBAJbnUwfJQFPkBgH9cL7hoBfRtmWiCvdqdjeTmi04u8zVNCUox0A4gT982DE9
19
- wmuN12LpdajxZONqbXuzZvc+nb0StFwmFYZG6iDwaf4BPywm2e/Vmq0YG45vZXGR
20
- L8yMDSK1cQXjmA+ZBKOHKWavxP6Vp7lWvjAhz8RFwqF9GuNIdhv9NpnCAWcMZtpm
21
- GUPyIWw/Cw/2wZp74QzZj6Npx+LdXoLTF1HMSJXZ7/pkxLCsB8m4EFVdb/IrW/0k
22
- kNSfjtAfBHO8nLGuqQZVH9IBD1i9K6aSs7pT6TW8itXUIlkIUI2tg5YzW6OFfPzq
23
- QekSkX3lZfY+HTSp/o+YvKkqWLUV7PQ7xh1ZYDtocpaHwgxe/j3bBqHE+CUPH2vA
24
- 0V/FwdTRWcwsjVoOJTrYcff8pBZ8r2MvtAc54xfnnhGFzeRHfcltobgFxkAXdE6p
25
- DVjBtqT23eugOqQ73umLcYDZkc36vnqGxUBSsXrzY9pzV5gGr2I8YUxMqf6ATrZt
26
- L9nRqA==
27
- -----END CERTIFICATE-----
data/sig/kettle/rb/version.rbs DELETED
@@ -1,8 +0,0 @@
1
- module Kettle
2
- module Rb
3
- module Version
4
- VERSION: String
5
- end
6
- VERSION: String
7
- end
8
- end