kettle-dev 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: d64f3a7f29e3470e85bfa3ad0ba278f7f591c618ced02911e6bdf00f804ee128
4
+ data.tar.gz: 90e9d7630f0115f908efff5e5ad359ff787cb80660a44fd5b6ba63a01839fb6b
5
+ SHA512:
6
+ metadata.gz: b9323a16c2cc9236888a268907031508b9b74b99feb5d149233604809e855bda0e34a03543d7cd683affe0e9139b993a31f7f746b226a9a9cec06987045d99b3
7
+ data.tar.gz: 48f6ef3c7424930a5840f71b2f9dcf86df2e6bb1a9b341bc29dfc15941ef6576bc2fad093b34e6d210792b70b6f5f4fbe180d86eaee21e7bd7f82f0e29396b8a
checksums.yaml.gz.sig ADDED
@@ -0,0 +1,2 @@
1
+ `!��c�fzQ��}z�ڲBF� ��ʧ]Z��)���jn;4�PO��Rӗ�Χ��7Z%"t?�V���s����iބ�/<�
2
+ �����"B<���q� 2E�$��w��W��z+�h�;K�b4g2H2��1%���iґ2��B�D�9�bY�n�PM� t��Ϲ��·4�Q�2�(Ws����\-'�D�6�:L���U 3�e��;LF���8��3� D�:������r�\�^#�I$E��Ā���R�.e�"�]ž����^ѹ�W���NJp����e7��4�H]��笯�Xs�Gxr�݊&���W%�ɝ�;�u
data/CHANGELOG.md ADDED
@@ -0,0 +1,47 @@
1
+ # Changelog
2
+ All notable changes to this project will be documented in this file.
3
+
4
+ The format is based on [Keep a Changelog v1](https://keepachangelog.com/en/1.0.0/),
5
+ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.0.0.html).
6
+
7
+ ## [Unreleased]
8
+ ### Added
9
+ ### Changed
10
+ ### Deprecated
11
+ ### Removed
12
+ ### Fixed
13
+ ### Security
14
+
15
+ ## [1.0.0] - 2025-08-24
16
+ - TAG: [v1.0.0][1.0.0t]
17
+ - COVERAGE: 100.00% -- 98/98 lines in 7 files
18
+ - BRANCH COVERAGE: 100.00% -- 30/30 branches in 7 files
19
+ - 94.59% documented
20
+ ### Added
21
+ - initial release, with auto-config support for:
22
+ - bundler-audit
23
+ - rake
24
+ - require_bench
25
+ - appraisal2
26
+ - gitmoji-regex (& git-hooks to enforce gitmoji commit-style)
27
+ - via kettle-test
28
+ - Note: rake tasks for kettle-test are added in *this gem* (kettle-dev) because test rake tasks are a development concern
29
+ - rspec
30
+ - although rspec is the focus, most tools work with minitest as well
31
+ - rspec-block_is_expected
32
+ - rspec-stubbed_env
33
+ - silent_stream
34
+ - timecop-rspec
35
+ - `kettle:dev:install` rake task for installing githooks, and various instructions for optimal configuration
36
+ - `kettle:dev:template` rake task for copying most of this gem's files (excepting bin/, docs/, exe/, sig/, lib/, specs/) to another gem, as a template.
37
+ - `ci:act` rake task CLI menu / scoreboard for a project's GHA workflows
38
+ - Selecting will run the selected workflow via `act`
39
+ - This may move to its own gem in the future.
40
+ - `kettle-release` ruby script for safely, securely, releasing a gem.
41
+ - This may move to its own gem in the future.
42
+ - `kettle-readme-backers` ruby script for integrating Open Source Collective backers into a README.md file.
43
+ - This may move to its own gem in the future.
44
+
45
+ [Unreleased]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.0...HEAD
46
+ [1.0.0]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/a427c302df09cfe4253a7c8d400333f9a4c1a208...v1.0.0
47
+ [1.0.0t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.0
data/CITATION.cff ADDED
@@ -0,0 +1,20 @@
1
+ cff-version: 1.2.0
2
+ title: kettle-dev
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 Hurn
9
+ family-names: Boling
10
+ email: peter@railsbling.com
11
+ affiliation: railsbling.com
12
+ orcid: 'https://orcid.org/0009-0008-8519-441X'
13
+ identifiers:
14
+ - type: url
15
+ value: 'https://github.com/kettle-rb/kettle-dev/'
16
+ description: kettle-dev
17
+ repository-code: 'https://github.com/kettle-rb/kettle-dev/'
18
+ abstract: >-
19
+ kettle-dev
20
+ license: See license file
@@ -0,0 +1,134 @@
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 ADDED
@@ -0,0 +1,149 @@
1
+ # Contributing
2
+
3
+ Bug reports and pull requests are welcome on GitHub, CodeBerg, or [GitLab][🚎src-main].
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].
10
+
11
+ ## Help out!
12
+
13
+ Take a look at the `reek` list which is the file called `REEK` and find something to improve.
14
+
15
+ Follow these instructions:
16
+
17
+ 1. Fork the repository
18
+ 2. Create a feature branch (`git checkout -b my-new-feature`)
19
+ 3. Make some fixes.
20
+ 4. Commit changes (`git commit -am 'Added some feature'`)
21
+ 5. Push to the branch (`git push origin my-new-feature`)
22
+ 6. Make sure to add tests for it. This is important, so it doesn't break in a future release.
23
+ 7. Create new Pull Request.
24
+
25
+ ## Appraisals
26
+
27
+ From time to time the Appraisal2 gemfiles in `gemfiles/` will need to be updated.
28
+ They are created and updated with the commands:
29
+
30
+ ```console
31
+ bin/rake appraisal:update
32
+ ```
33
+
34
+ When adding an appraisal to CI check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
35
+
36
+ ## The Reek List
37
+
38
+ Take a look at the `reek` list which is the file called `REEK` and find something to improve.
39
+
40
+ To refresh the `reek` list:
41
+
42
+ ```console
43
+ bundle exec reek > REEK
44
+ ```
45
+
46
+ ## Run Tests
47
+
48
+ To run all tests
49
+
50
+ ```console
51
+ bundle exec rake test
52
+ ```
53
+
54
+ ## Lint It
55
+
56
+ Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
57
+
58
+ ```console
59
+ bundle exec rake
60
+ ```
61
+
62
+ Or just run the linter.
63
+
64
+ ```console
65
+ bundle exec rake rubocop_gradual:autocorrect
66
+ ```
67
+
68
+ 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.
69
+
70
+ ### Important: Do not add inline RuboCop disables
71
+
72
+ 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:
73
+
74
+ - Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
75
+ - When a violation is temporary and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
76
+ - `bundle exec rake rubocop_gradual:autocorrect` (preferred)
77
+ - `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
78
+
79
+ 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.
80
+
81
+ ## Contributors
82
+
83
+ Your picture could be here!
84
+
85
+ [![Contributors][🖐contributors-img]][🖐contributors]
86
+
87
+ Made with [contributors-img][🖐contrib-rocks].
88
+
89
+ Also see GitLab Contributors: [https://gitlab.com/kettle-rb/kettle-dev/-/graphs/main][🚎contributors-gl]
90
+
91
+ ## For Maintainers
92
+
93
+ ### One-time, Per-maintainer, Setup
94
+
95
+ **IMPORTANT**: If you want to sign the build you create,
96
+ your public key for signing gems will need to be picked up by the line in the
97
+ `gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
98
+ All releases to RubyGems.org will be signed.
99
+ See: [RubyGems Security Guide][🔒️rubygems-security-guide]
100
+
101
+ NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some value in your environment.
102
+
103
+ ### To release a new version:
104
+
105
+ #### Automated process
106
+
107
+ Run `kettle-release`.
108
+
109
+ #### Manual process
110
+
111
+ 1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
112
+ 2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
113
+ 3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
114
+ 4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
115
+ 5. Run `git push` to trigger the final CI pipeline before release, and merge PRs
116
+ - NOTE: Remember to [check the build][🧪build].
117
+ 6. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
118
+ 7. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
119
+ 8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
120
+ 9. Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use same timestamp, and generate same checksums
121
+ - Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
122
+ - If the echo above has no output, then it didn't work.
123
+ - Note: `zsh/datetime` module is needed, if running `zsh`.
124
+ - In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
125
+ 10. Run `bundle exec rake build`
126
+ 11. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
127
+ to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
128
+ [gem][💎stone_checksums].
129
+ - The script automatically commits but does not push the checksums
130
+ 12. Run `bundle exec rake release` which will create a git tag for the version,
131
+ push git commits and tags, and push the `.gem` file to [rubygems.org][💎rubygems]
132
+
133
+ [🚎src-main]: https://gitlab.com/kettle-rb/kettle-dev
134
+ [🧪build]: https://github.com/kettle-rb/kettle-dev/actions
135
+ [🤝conduct]: https://gitlab.com/kettle-rb/kettle-dev/-/blob/main/CODE_OF_CONDUCT.md
136
+ [🖐contrib-rocks]: https://contrib.rocks
137
+ [🖐contributors]: https://github.com/kettle-rb/kettle-dev/graphs/contributors
138
+ [🚎contributors-gl]: https://gitlab.com/kettle-rb/kettle-dev/-/graphs/main
139
+ [🖐contributors-img]: https://contrib.rocks/image?repo=kettle-rb/kettle-dev
140
+ [💎rubygems]: https://rubygems.org
141
+ [🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
142
+ [🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
143
+ [🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
144
+ [💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
145
+ [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
146
+ [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
147
+ [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
148
+ [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
149
+ [🏃‍♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2023, 2025 Peter Boling
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.