yard-yaml 0.2.2 → 0.2.4
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 +112 -2
- data/LICENSE.md +1 -1
- data/README.md +19 -17
- data/lib/yard/yaml/tag_renderer.rb +0 -2
- data/lib/yard/yaml/version.rb +4 -1
- data/sig/yard/yaml.rbs +5 -0
- data.tar.gz.sig +0 -0
- metadata +47 -43
- metadata.gz.sig +0 -0
- data/CITATION.cff +0 -20
- data/CODE_OF_CONDUCT.md +0 -134
- data/CONTRIBUTING.md +0 -272
- data/FUNDING.md +0 -70
- data/RUBOCOP.md +0 -71
- data/SECURITY.md +0 -21
- data/certs/pboling.pem +0 -27
- data/sig/yard/yaml/version.rbs +0 -8
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1b2db3271271b80d87941f034d98b5d5c277d40eaddaa533c8e8bca81bd290ae
|
|
4
|
+
data.tar.gz: ebe3870147cd08e144bbded2ed9698cb63ffb6bcd4a478b7b969c68a9efd8a79
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d979357c27dbf22bcfe8a52848e22612d8ee91b8618eda91769700de9a09c7758f47e81d654a2a1eb95d180768f0ad2b13400cb4f4c9500a2047a9f8812fae9d
|
|
7
|
+
data.tar.gz: 57172f39e6ec174ba3340a117374af02193c2ca9416aa7de13652ea3cbb8fddceb78d1a6265d112c5ce53968502a7d04b1db776d5b725c15a7ecd07744aecb9a
|
checksums.yaml.gz.sig
CHANGED
|
Binary file
|
data/CHANGELOG.md
CHANGED
|
@@ -30,6 +30,112 @@ Please file a bug if you notice a violation of semantic versioning.
|
|
|
30
30
|
|
|
31
31
|
### Security
|
|
32
32
|
|
|
33
|
+
## [0.2.4] - 2026-07-31
|
|
34
|
+
|
|
35
|
+
- TAG: [v0.2.4][0.2.4t]
|
|
36
|
+
- COVERAGE: 94.36% -- 519/550 lines in 13 files
|
|
37
|
+
- BRANCH COVERAGE: 83.25% -- 164/197 branches in 13 files
|
|
38
|
+
- 79.73% documented
|
|
39
|
+
|
|
40
|
+
### Added
|
|
41
|
+
|
|
42
|
+
- Documentation linting now has its generated `yard-lint` dependency and severity config available in the local bundle.
|
|
43
|
+
|
|
44
|
+
- kettle-jem-template-20260726-001 - Projects now include YARD lint
|
|
45
|
+
configuration and documentation dependencies so documentation issues fail
|
|
46
|
+
before generated docs are refreshed.
|
|
47
|
+
|
|
48
|
+
- kettle-jem-template-20260727-001 - Spec harness documentation now lists the
|
|
49
|
+
RSpec helpers provided by `kettle-test`.
|
|
50
|
+
|
|
51
|
+
- kettle-jem-template-20260729-005 - Gemspec metadata now publishes this
|
|
52
|
+
project's RubyForum tag as `mailing_list_uri`, and support docs link to the
|
|
53
|
+
tagged RubyForum community alongside Discord.
|
|
54
|
+
|
|
55
|
+
### Changed
|
|
56
|
+
|
|
57
|
+
- kettle-jem-template-20260716-001 - Shim gemspec manifests now include
|
|
58
|
+
`LICENSE.md` instead of nonexistent `LICENSE.txt`.
|
|
59
|
+
- kettle-jem-template-20260716-002 - Generated gemspec manifests now ship fewer
|
|
60
|
+
repository-only files by default to reduce downstream distro packaging churn.
|
|
61
|
+
- kettle-jem-template-20260720-001 - Generated READMEs can now render
|
|
62
|
+
template-managed corporate sponsor logos from project or family config.
|
|
63
|
+
- kettle-jem-template-20260720-002 - Generated development Gemfiles now use the
|
|
64
|
+
released `tree_sitter_language_pack` gem 1.13.3 or newer by default.
|
|
65
|
+
- kettle-jem-template-20260720-003 - Generated StructuredMerge Git diff driver
|
|
66
|
+
config now uses the installed `smorg-rb` Ruby driver name.
|
|
67
|
+
- kettle-jem-template-20260720-004 - Generated multi-engine workflow files now
|
|
68
|
+
omit JRuby and TruffleRuby jobs when project config declares MRI-only engines.
|
|
69
|
+
- kettle-jem-template-20260720-005 - Generated README Support & Community rows
|
|
70
|
+
now include a RubyForum help badge.
|
|
71
|
+
- kettle-jem-template-20260725-001 - Generated JRuby and TruffleRuby workflow
|
|
72
|
+
files now run when pull request head branches start with `feature/release`,
|
|
73
|
+
so release CI monitoring does not report intentionally skipped engine
|
|
74
|
+
workflows as failures.
|
|
75
|
+
|
|
76
|
+
- kettle-jem-template-20260725-002 - Generated gemspec templates now include
|
|
77
|
+
`anonymous_loader` as a development dependency, and version specs use it to
|
|
78
|
+
execute generated `version.rb` files for coverage without redefining package
|
|
79
|
+
constants. Managed version specs are removed when `version_gem` is disabled
|
|
80
|
+
or incompatible with the project's runtime Ruby floor.
|
|
81
|
+
|
|
82
|
+
- kettle-jem-template-20260728-001 - Generated Ruby workflows now use clearer
|
|
83
|
+
setup-ruby-flash planning and can prepare appraisal-only jobs without
|
|
84
|
+
installing the main Gemfile bundle.
|
|
85
|
+
|
|
86
|
+
### Fixed
|
|
87
|
+
|
|
88
|
+
- kettle-jem-template-20260726-002 - Generated version files now document their
|
|
89
|
+
version namespace and constants, reducing warning-only YARD lint output.
|
|
90
|
+
|
|
91
|
+
- kettle-jem-template-20260726-003 - Coverage upload steps now treat Coveralls,
|
|
92
|
+
QLTY, and Codecov as optional, so provider outages do not fail CI when local
|
|
93
|
+
coverage thresholds still pass.
|
|
94
|
+
- kettle-jem-template-20260728-002 - Generated RuboCop configs now ignore the
|
|
95
|
+
same `gemfiles/vendor/bundle` tree as `.gitignore`, so vendored dependency
|
|
96
|
+
installs are not reported as project lint debt.
|
|
97
|
+
- kettle-jem-template-20260728-003 - Generated dep-heads workflows now run
|
|
98
|
+
TruffleRuby jobs with current RubyGems and Bundler, avoiding setup failures
|
|
99
|
+
before the test suite starts.
|
|
100
|
+
|
|
101
|
+
- kettle-jem-template-20260728-004 - Generated dep-heads workflows now use the
|
|
102
|
+
setup-ruby Bundler install path for direct appraisal Gemfiles, avoiding rv
|
|
103
|
+
lockfile parser failures on Git and path dependencies.
|
|
104
|
+
|
|
105
|
+
- kettle-jem-template-20260728-005 - VersionGem bootstrap now creates the
|
|
106
|
+
missing canonical version spec when a project only has shim namespace version
|
|
107
|
+
specs.
|
|
108
|
+
|
|
109
|
+
- kettle-jem-template-20260729-001 - Generated JRuby 9.4 workflows now use the
|
|
110
|
+
legacy manual bundle install path, avoiding setup-time Bundler full-index
|
|
111
|
+
failures against `gem.coop`.
|
|
112
|
+
|
|
113
|
+
- kettle-jem-template-20260729-002 - VersionGem bootstrap now preserves
|
|
114
|
+
and templates dedicated `version_gem.rb` entrypoints even when the gemspec
|
|
115
|
+
dependency is intentionally omitted, and generated anonymous-loader specs
|
|
116
|
+
cover both `version.rb` and `version_gem.rb`.
|
|
117
|
+
|
|
118
|
+
- kettle-jem-template-20260729-003 - Old-Ruby gems below the VersionGem runtime
|
|
119
|
+
floor now get managed minimal `version.rb` files and anonymous-loader version
|
|
120
|
+
specs without adding `version_gem`.
|
|
121
|
+
- kettle-jem-template-20260730-001 - Gemspec package file enumeration now runs
|
|
122
|
+
relative to the gemspec directory, so packaged template assets are included
|
|
123
|
+
even when the gemspec is loaded from another working directory.
|
|
124
|
+
|
|
125
|
+
- RDoc framework appraisals no longer install current-Ruby documentation tools,
|
|
126
|
+
keeping their dependency set scoped to the RDoc compatibility axis.
|
|
127
|
+
|
|
128
|
+
## [0.2.3] - 2026-07-02
|
|
129
|
+
|
|
130
|
+
- TAG: [v0.2.3][0.2.3t]
|
|
131
|
+
- COVERAGE: 94.36% -- 519/550 lines in 13 files
|
|
132
|
+
- BRANCH COVERAGE: 83.25% -- 164/197 branches in 13 files
|
|
133
|
+
- 78.38% documented
|
|
134
|
+
|
|
135
|
+
### Fixed
|
|
136
|
+
|
|
137
|
+
- Package configured license files in gem release file lists.
|
|
138
|
+
|
|
33
139
|
## [0.2.2] - 2026-06-22
|
|
34
140
|
|
|
35
141
|
- TAG: [v0.2.2][0.2.2t]
|
|
@@ -118,7 +224,7 @@ Please file a bug if you notice a violation of semantic versioning.
|
|
|
118
224
|
|
|
119
225
|
### Added
|
|
120
226
|
|
|
121
|
-
- `documentation_local.gemfile` support for sibling-workspace documentation development under `
|
|
227
|
+
- `documentation_local.gemfile` support for sibling-workspace documentation development under `KETTLE_DEV_DEV`
|
|
122
228
|
- Added generated CI coverage for `rdoc` `~> 6.11` and `>= 7.0`.
|
|
123
229
|
|
|
124
230
|
### Changed
|
|
@@ -142,7 +248,11 @@ Please file a bug if you notice a violation of semantic versioning.
|
|
|
142
248
|
|
|
143
249
|
### Security
|
|
144
250
|
|
|
145
|
-
[Unreleased]: https://github.com/galtzo-floss/yard-yaml/compare/v0.2.
|
|
251
|
+
[Unreleased]: https://github.com/galtzo-floss/yard-yaml/compare/v0.2.4...HEAD
|
|
252
|
+
[0.2.4]: https://github.com/galtzo-floss/yard-yaml/compare/v0.2.3...v0.2.4
|
|
253
|
+
[0.2.4t]: https://github.com/galtzo-floss/yard-yaml/releases/tag/v0.2.4
|
|
254
|
+
[0.2.3]: https://github.com/galtzo-floss/yard-yaml/compare/v0.2.2...v0.2.3
|
|
255
|
+
[0.2.3t]: https://github.com/galtzo-floss/yard-yaml/releases/tag/v0.2.3
|
|
146
256
|
[0.2.2]: https://github.com/galtzo-floss/yard-yaml/compare/v0.2.1...v0.2.2
|
|
147
257
|
[0.2.2t]: https://github.com/galtzo-floss/yard-yaml/releases/tag/v0.2.2
|
|
148
258
|
[0.2.1]: https://github.com/galtzo-floss/yard-yaml/compare/v0.2.0...v0.2.1
|
data/LICENSE.md
CHANGED
data/README.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
# 🦗 Yard::Yaml
|
|
4
4
|
|
|
5
|
-
[![Version][👽versioni]][👽version] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
|
|
5
|
+
[![Version][👽versioni]][👽version] [![Ruby Users Forum][✉️ruby-forum-top-img]][✉️ruby-forum] [![GitHub tag (latest SemVer)][⛳️tag-img]][⛳️tag] [![License: MIT][📄license-img]][📄license] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![CodeCov Test Coverage][🏀codecovi]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov] [![QLTY Maintainability][🏀qlty-mnti]][🏀qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Runtime Dependencies @ HEAD][🚎12-crh-wfi]][🚎12-crh-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf] [![Apache SkyWalking Eyes License Compatibility Check][🚎15-🪪-wfi]][🚎15-🪪-wf]
|
|
6
6
|
|
|
7
|
-
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know][✉️discord-invite], as I may have missed the
|
|
7
|
+
`if ci_badges.map(&:color).detect { it != "green"}` ☝️ [let me know on Discord][✉️discord-invite] or [RubyForum][✉️ruby-forum], as I may have missed the notification.
|
|
8
8
|
|
|
9
9
|
---
|
|
10
10
|
|
|
@@ -40,8 +40,8 @@ with `title: my-gem` becomes a converted page like `docs/yaml/my-gem.html`.
|
|
|
40
40
|
| Works with Truffle Ruby | [![Truffle Ruby 24.2 Compat][💎truby-24.2i]][🚎truby-24.2-wf] [![Truffle Ruby 25.0 Compat][💎truby-25.0i]][🚎truby-25.0-wf] [![Truffle Ruby 33.0 Compat][💎truby-33.0i]][🚎truby-33.0-wf] [![Truffle Ruby current Compat][💎truby-c-i]][🚎9-t-wf] [![Truffle Ruby HEAD Compat][💎truby-headi]][🚎3-hd-wf]|
|
|
41
41
|
| Works with MRI Ruby 4 | [![Ruby current Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf]|
|
|
42
42
|
| Works with MRI Ruby 3 | [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎ruby-3.2-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎ruby-3.3-wf] [![Ruby 3.4 Compat][💎ruby-3.4i]][🚎ruby-3.4-wf]|
|
|
43
|
-
| 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] |
|
|
44
|
-
| Source | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on
|
|
43
|
+
| Support & Community | [![Join Me on Daily.dev's RubyFriends][✉️ruby-friends-img]][✉️ruby-friends] [![Get help from RubyForum][✉️ruby-forum-img]][✉️ruby-forum] [![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] |
|
|
44
|
+
| 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] |
|
|
45
45
|
| 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] |
|
|
46
46
|
| Compliance | [![License: MIT][📄license-img]][📄license] [![Apache license compatibility: Category A][📄license-compat-img]][📄license-compat] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
|
|
47
47
|
| 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] |
|
|
@@ -81,17 +81,14 @@ The _amazing_ test matrix is powered by the kettle-dev stack.
|
|
|
81
81
|
<details markdown="1">
|
|
82
82
|
<summary>Find this repo on federated forges (Coming soon!)</summary>
|
|
83
83
|
|
|
84
|
-
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI |
|
|
85
|
-
|
|
86
|
-
| 🧪 [galtzo-floss/yard-yaml on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix |
|
|
87
|
-
| 🧊 [galtzo-floss/yard-yaml on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix |
|
|
88
|
-
| 🐙 [galtzo-floss/yard-yaml on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix |
|
|
89
|
-
| 🎮️ [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] |
|
|
84
|
+
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI |
|
|
85
|
+
|-------------------------------------------------|-------------------------------------------|-------------------|------------------|-----------------|----------------|
|
|
86
|
+
| 🧪 [galtzo-floss/yard-yaml on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix |
|
|
87
|
+
| 🧊 [galtzo-floss/yard-yaml on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix |
|
|
88
|
+
| 🐙 [galtzo-floss/yard-yaml on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix |
|
|
90
89
|
|
|
91
90
|
</details>
|
|
92
91
|
|
|
93
|
-
[gh-discussions]: https://github.com/galtzo-floss/yard-yaml/discussions
|
|
94
|
-
|
|
95
92
|
### Enterprise Support [](https://tidelift.com/subscription/pkg/rubygems-yard-yaml?utm_source=rubygems-yard-yaml&utm_medium=referral&utm_campaign=readme)
|
|
96
93
|
|
|
97
94
|
Available as part of the Tidelift Subscription.
|
|
@@ -109,6 +106,7 @@ The maintainers of this and thousands of other packages are working with Tidelif
|
|
|
109
106
|
|
|
110
107
|
Alternatively:
|
|
111
108
|
|
|
109
|
+
- [![Ruby Users Forum][✉️ruby-forum-img]][✉️ruby-forum]
|
|
112
110
|
- [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
113
111
|
- [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork]
|
|
114
112
|
- [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor]
|
|
@@ -352,7 +350,7 @@ See [CHANGELOG.md][📌changelog] for a list of releases.
|
|
|
352
350
|
## 📄 License
|
|
353
351
|
|
|
354
352
|
The gem is available as open source under the terms of
|
|
355
|
-
the [MIT](MIT.md) [![License: MIT][📄license-img]][📄license-ref].
|
|
353
|
+
the [MIT](https://github.com/galtzo-floss/yard-yaml/blob/main/MIT.md) [![License: MIT][📄license-img]][📄license-ref].
|
|
356
354
|
|
|
357
355
|
### © Copyright
|
|
358
356
|
|
|
@@ -375,11 +373,12 @@ I'm hoping to be able to pay for my kids' health insurance this month,
|
|
|
375
373
|
so if you value the work I am doing, I need your support.
|
|
376
374
|
Please consider sponsoring me or the project.
|
|
377
375
|
|
|
378
|
-
To join the community or get help
|
|
376
|
+
To join the community or get help, use the RubyForum or Discord.
|
|
379
377
|
|
|
378
|
+
[![Ruby Users Forum][✉️ruby-forum-img]][✉️ruby-forum]
|
|
380
379
|
[![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite]
|
|
381
380
|
|
|
382
|
-
To say "thanks!" ☝️ Join the
|
|
381
|
+
To say "thanks!" ☝️ Join the community or 👇️ send money.
|
|
383
382
|
|
|
384
383
|
[![Sponsor galtzo-floss/yard-yaml 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]
|
|
385
384
|
|
|
@@ -420,6 +419,9 @@ Thanks for RTFM. ☺️
|
|
|
420
419
|
[✉️discord-invite-img-ftb]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge&logo=discord
|
|
421
420
|
[✉️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
|
|
422
421
|
[✉️ruby-friends]: https://app.daily.dev/squads/rubyfriends
|
|
422
|
+
[✉️ruby-forum-top-img]: https://img.shields.io/discourse/topics?server=https%3A%2F%2Fwww.rubyforum.org&style=flat&logo=discourse&label=Ruby%20Users%20Forum
|
|
423
|
+
[✉️ruby-forum-img]: https://img.shields.io/discourse/topics?server=https%3A%2F%2Fwww.rubyforum.org&style=for-the-badge&logo=discourse&label=Ruby%20Users%20Forum
|
|
424
|
+
[✉️ruby-forum]: https://www.rubyforum.org/tag/galtzo-floss
|
|
423
425
|
|
|
424
426
|
[✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
|
|
425
427
|
[⛳️gem-namespace]: https://github.com/galtzo-floss/yard-yaml
|
|
@@ -465,7 +467,7 @@ Thanks for RTFM. ☺️
|
|
|
465
467
|
[📜src-gl]: https://gitlab.com/galtzo-floss/yard-yaml
|
|
466
468
|
[📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
|
|
467
469
|
[📜src-cb]: https://codeberg.org/galtzo-floss/yard-yaml
|
|
468
|
-
[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=
|
|
470
|
+
[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=GitHub&logoColor=green
|
|
469
471
|
[📜src-gh]: https://github.com/galtzo-floss/yard-yaml
|
|
470
472
|
[📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
471
473
|
[📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
|
@@ -556,7 +558,7 @@ Thanks for RTFM. ☺️
|
|
|
556
558
|
[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
|
|
557
559
|
[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
|
|
558
560
|
[📄license]: LICENSE.md
|
|
559
|
-
[📄license-ref]: MIT.md
|
|
561
|
+
[📄license-ref]: https://github.com/galtzo-floss/yard-yaml/blob/main/MIT.md
|
|
560
562
|
[📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
|
|
561
563
|
[📄license-compat]: https://www.apache.org/legal/resolved.html#category-a
|
|
562
564
|
[📄license-compat-img]: https://img.shields.io/badge/Apache_Compatible:_Category_A-%E2%9C%93-259D6C.svg?style=flat&logo=Apache
|
data/lib/yard/yaml/version.rb
CHANGED
|
@@ -2,9 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
module Yard
|
|
4
4
|
module Yaml
|
|
5
|
+
# Version namespace for this gem.
|
|
5
6
|
module Version
|
|
6
|
-
|
|
7
|
+
# Current gem version.
|
|
8
|
+
VERSION = "0.2.4"
|
|
7
9
|
end
|
|
10
|
+
# Current gem version exposed at the traditional constant location.
|
|
8
11
|
VERSION = Version::VERSION # Traditional Constant Location
|
|
9
12
|
end
|
|
10
13
|
end
|
data/sig/yard/yaml.rbs
CHANGED
data.tar.gz.sig
CHANGED
|
Binary file
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: yard-yaml
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.2.
|
|
4
|
+
version: 0.2.4
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Annibelle Boling
|
|
@@ -47,7 +47,7 @@ dependencies:
|
|
|
47
47
|
version: '1.1'
|
|
48
48
|
- - ">="
|
|
49
49
|
- !ruby/object:Gem::Version
|
|
50
|
-
version: 1.1.
|
|
50
|
+
version: 1.1.14
|
|
51
51
|
type: :runtime
|
|
52
52
|
prerelease: false
|
|
53
53
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -57,7 +57,7 @@ dependencies:
|
|
|
57
57
|
version: '1.1'
|
|
58
58
|
- - ">="
|
|
59
59
|
- !ruby/object:Gem::Version
|
|
60
|
-
version: 1.1.
|
|
60
|
+
version: 1.1.14
|
|
61
61
|
- !ruby/object:Gem::Dependency
|
|
62
62
|
name: yaml-converter
|
|
63
63
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -78,20 +78,20 @@ dependencies:
|
|
|
78
78
|
requirements:
|
|
79
79
|
- - "~>"
|
|
80
80
|
- !ruby/object:Gem::Version
|
|
81
|
-
version: '2.
|
|
81
|
+
version: '2.5'
|
|
82
82
|
- - ">="
|
|
83
83
|
- !ruby/object:Gem::Version
|
|
84
|
-
version: 2.
|
|
84
|
+
version: 2.5.14
|
|
85
85
|
type: :development
|
|
86
86
|
prerelease: false
|
|
87
87
|
version_requirements: !ruby/object:Gem::Requirement
|
|
88
88
|
requirements:
|
|
89
89
|
- - "~>"
|
|
90
90
|
- !ruby/object:Gem::Version
|
|
91
|
-
version: '2.
|
|
91
|
+
version: '2.5'
|
|
92
92
|
- - ">="
|
|
93
93
|
- !ruby/object:Gem::Version
|
|
94
|
-
version: 2.
|
|
94
|
+
version: 2.5.14
|
|
95
95
|
- !ruby/object:Gem::Dependency
|
|
96
96
|
name: bundler-audit
|
|
97
97
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -140,26 +140,46 @@ dependencies:
|
|
|
140
140
|
- - ">="
|
|
141
141
|
- !ruby/object:Gem::Version
|
|
142
142
|
version: 1.0.4
|
|
143
|
+
- !ruby/object:Gem::Dependency
|
|
144
|
+
name: anonymous_loader
|
|
145
|
+
requirement: !ruby/object:Gem::Requirement
|
|
146
|
+
requirements:
|
|
147
|
+
- - "~>"
|
|
148
|
+
- !ruby/object:Gem::Version
|
|
149
|
+
version: '0.1'
|
|
150
|
+
- - ">="
|
|
151
|
+
- !ruby/object:Gem::Version
|
|
152
|
+
version: 0.1.3
|
|
153
|
+
type: :development
|
|
154
|
+
prerelease: false
|
|
155
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
156
|
+
requirements:
|
|
157
|
+
- - "~>"
|
|
158
|
+
- !ruby/object:Gem::Version
|
|
159
|
+
version: '0.1'
|
|
160
|
+
- - ">="
|
|
161
|
+
- !ruby/object:Gem::Version
|
|
162
|
+
version: 0.1.3
|
|
143
163
|
- !ruby/object:Gem::Dependency
|
|
144
164
|
name: appraisal2
|
|
145
165
|
requirement: !ruby/object:Gem::Requirement
|
|
146
166
|
requirements:
|
|
147
167
|
- - "~>"
|
|
148
168
|
- !ruby/object:Gem::Version
|
|
149
|
-
version: '3.
|
|
169
|
+
version: '3.2'
|
|
150
170
|
- - ">="
|
|
151
171
|
- !ruby/object:Gem::Version
|
|
152
|
-
version: 3.
|
|
172
|
+
version: 3.2.0
|
|
153
173
|
type: :development
|
|
154
174
|
prerelease: false
|
|
155
175
|
version_requirements: !ruby/object:Gem::Requirement
|
|
156
176
|
requirements:
|
|
157
177
|
- - "~>"
|
|
158
178
|
- !ruby/object:Gem::Version
|
|
159
|
-
version: '3.
|
|
179
|
+
version: '3.2'
|
|
160
180
|
- - ">="
|
|
161
181
|
- !ruby/object:Gem::Version
|
|
162
|
-
version: 3.
|
|
182
|
+
version: 3.2.0
|
|
163
183
|
- !ruby/object:Gem::Dependency
|
|
164
184
|
name: kettle-test
|
|
165
185
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -169,7 +189,7 @@ dependencies:
|
|
|
169
189
|
version: '2.0'
|
|
170
190
|
- - ">="
|
|
171
191
|
- !ruby/object:Gem::Version
|
|
172
|
-
version: 2.0.
|
|
192
|
+
version: 2.0.17
|
|
173
193
|
type: :development
|
|
174
194
|
prerelease: false
|
|
175
195
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -179,27 +199,27 @@ dependencies:
|
|
|
179
199
|
version: '2.0'
|
|
180
200
|
- - ">="
|
|
181
201
|
- !ruby/object:Gem::Version
|
|
182
|
-
version: 2.0.
|
|
202
|
+
version: 2.0.17
|
|
183
203
|
- !ruby/object:Gem::Dependency
|
|
184
204
|
name: turbo_tests2
|
|
185
205
|
requirement: !ruby/object:Gem::Requirement
|
|
186
206
|
requirements:
|
|
187
207
|
- - "~>"
|
|
188
208
|
- !ruby/object:Gem::Version
|
|
189
|
-
version: '3.
|
|
209
|
+
version: '3.2'
|
|
190
210
|
- - ">="
|
|
191
211
|
- !ruby/object:Gem::Version
|
|
192
|
-
version: 3.
|
|
212
|
+
version: 3.2.4
|
|
193
213
|
type: :development
|
|
194
214
|
prerelease: false
|
|
195
215
|
version_requirements: !ruby/object:Gem::Requirement
|
|
196
216
|
requirements:
|
|
197
217
|
- - "~>"
|
|
198
218
|
- !ruby/object:Gem::Version
|
|
199
|
-
version: '3.
|
|
219
|
+
version: '3.2'
|
|
200
220
|
- - ">="
|
|
201
221
|
- !ruby/object:Gem::Version
|
|
202
|
-
version: 3.
|
|
222
|
+
version: 3.2.4
|
|
203
223
|
- !ruby/object:Gem::Dependency
|
|
204
224
|
name: ruby-progressbar
|
|
205
225
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -223,7 +243,7 @@ dependencies:
|
|
|
223
243
|
version: '1.0'
|
|
224
244
|
- - ">="
|
|
225
245
|
- !ruby/object:Gem::Version
|
|
226
|
-
version: 1.0.
|
|
246
|
+
version: 1.0.8
|
|
227
247
|
type: :development
|
|
228
248
|
prerelease: false
|
|
229
249
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -233,7 +253,7 @@ dependencies:
|
|
|
233
253
|
version: '1.0'
|
|
234
254
|
- - ">="
|
|
235
255
|
- !ruby/object:Gem::Version
|
|
236
|
-
version: 1.0.
|
|
256
|
+
version: 1.0.8
|
|
237
257
|
- !ruby/object:Gem::Dependency
|
|
238
258
|
name: gitmoji-regex
|
|
239
259
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -243,7 +263,7 @@ dependencies:
|
|
|
243
263
|
version: '2.0'
|
|
244
264
|
- - ">="
|
|
245
265
|
- !ruby/object:Gem::Version
|
|
246
|
-
version: 2.0.
|
|
266
|
+
version: 2.0.11
|
|
247
267
|
type: :development
|
|
248
268
|
prerelease: false
|
|
249
269
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -253,33 +273,17 @@ dependencies:
|
|
|
253
273
|
version: '2.0'
|
|
254
274
|
- - ">="
|
|
255
275
|
- !ruby/object:Gem::Version
|
|
256
|
-
version: 2.0.
|
|
276
|
+
version: 2.0.11
|
|
257
277
|
description: "\U0001F997 A YARD plugin for YAML documents"
|
|
258
278
|
email:
|
|
259
279
|
- floss@galtzo.com
|
|
260
280
|
executables: []
|
|
261
281
|
extensions: []
|
|
262
|
-
extra_rdoc_files:
|
|
263
|
-
- CHANGELOG.md
|
|
264
|
-
- CITATION.cff
|
|
265
|
-
- CODE_OF_CONDUCT.md
|
|
266
|
-
- CONTRIBUTING.md
|
|
267
|
-
- FUNDING.md
|
|
268
|
-
- LICENSE.md
|
|
269
|
-
- README.md
|
|
270
|
-
- RUBOCOP.md
|
|
271
|
-
- SECURITY.md
|
|
282
|
+
extra_rdoc_files: []
|
|
272
283
|
files:
|
|
273
284
|
- CHANGELOG.md
|
|
274
|
-
- CITATION.cff
|
|
275
|
-
- CODE_OF_CONDUCT.md
|
|
276
|
-
- CONTRIBUTING.md
|
|
277
|
-
- FUNDING.md
|
|
278
285
|
- LICENSE.md
|
|
279
286
|
- README.md
|
|
280
|
-
- RUBOCOP.md
|
|
281
|
-
- SECURITY.md
|
|
282
|
-
- certs/pboling.pem
|
|
283
287
|
- lib/yard-yaml.rb
|
|
284
288
|
- lib/yard/yaml.rb
|
|
285
289
|
- lib/yard/yaml/cli.rb
|
|
@@ -294,20 +298,20 @@ files:
|
|
|
294
298
|
- lib/yard/yaml/templates.rb
|
|
295
299
|
- lib/yard/yaml/version.rb
|
|
296
300
|
- sig/yard/yaml.rbs
|
|
297
|
-
- sig/yard/yaml/version.rbs
|
|
298
301
|
homepage: https://github.com/galtzo-floss/yard-yaml
|
|
299
302
|
licenses:
|
|
300
303
|
- MIT
|
|
301
304
|
metadata:
|
|
302
305
|
homepage_uri: https://yard-yaml.galtzo.com
|
|
303
|
-
source_code_uri: https://github.com/galtzo-floss/yard-yaml/tree/v0.2.
|
|
304
|
-
changelog_uri: https://github.com/galtzo-floss/yard-yaml/blob/v0.2.
|
|
306
|
+
source_code_uri: https://github.com/galtzo-floss/yard-yaml/tree/v0.2.4
|
|
307
|
+
changelog_uri: https://github.com/galtzo-floss/yard-yaml/blob/v0.2.4/CHANGELOG.md
|
|
305
308
|
bug_tracker_uri: https://github.com/galtzo-floss/yard-yaml/issues
|
|
306
|
-
documentation_uri: https://www.rubydoc.info/gems/yard-yaml/0.2.
|
|
309
|
+
documentation_uri: https://www.rubydoc.info/gems/yard-yaml/0.2.4
|
|
307
310
|
funding_uri: https://github.com/sponsors/pboling
|
|
308
311
|
wiki_uri: https://github.com/galtzo-floss/yard-yaml/wiki
|
|
309
312
|
news_uri: https://www.railsbling.com/tags/yard-yaml
|
|
310
313
|
discord_uri: https://discord.gg/3qme4XHNKN
|
|
314
|
+
mailing_list_uri: https://www.rubyforum.org/tag/galtzo-floss
|
|
311
315
|
rubygems_mfa_required: 'true'
|
|
312
316
|
rdoc_options:
|
|
313
317
|
- "--title"
|
|
@@ -332,7 +336,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
332
336
|
- !ruby/object:Gem::Version
|
|
333
337
|
version: '0'
|
|
334
338
|
requirements: []
|
|
335
|
-
rubygems_version: 4.0.
|
|
339
|
+
rubygems_version: 4.0.17
|
|
336
340
|
specification_version: 4
|
|
337
341
|
summary: "\U0001F997 A YARD plugin for YAML documents"
|
|
338
342
|
test_files: []
|
metadata.gz.sig
CHANGED
|
Binary file
|
data/CITATION.cff
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
cff-version: 1.2.0
|
|
2
|
-
title: "yard-yaml"
|
|
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/galtzo-floss/yard-yaml'
|
|
16
|
-
description: "yard-yaml"
|
|
17
|
-
repository-code: 'https://github.com/galtzo-floss/yard-yaml'
|
|
18
|
-
abstract: >-
|
|
19
|
-
yard-yaml
|
|
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,272 +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: 3.2.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:update
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
If you need to reset all gemfiles/*.gemfile.lock files:
|
|
138
|
-
|
|
139
|
-
```console
|
|
140
|
-
bin/rake appraisal:reset
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
When adding an appraisal to CI, check the [runner tool cache][🏃♂️runner-tool-cache] to see which runner to use.
|
|
144
|
-
|
|
145
|
-
## Run Tests
|
|
146
|
-
|
|
147
|
-
Run tests via `kettle-test` (provided by `kettle-test`). It runs RSpec, writes the full log to
|
|
148
|
-
`tmp/kettle-test/rspec-TIMESTAMP.log`, and prints a compact highlight block with timing, seed,
|
|
149
|
-
pass/fail count, failing example list, and SimpleCov coverage percentages.
|
|
150
|
-
|
|
151
|
-
```console
|
|
152
|
-
bundle exec kettle-test
|
|
153
|
-
```
|
|
154
|
-
|
|
155
|
-
For targeted runs, disable the hard coverage threshold to avoid false failures:
|
|
156
|
-
|
|
157
|
-
```console
|
|
158
|
-
K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
### Spec organization (required)
|
|
162
|
-
|
|
163
|
-
- 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/yard/yaml/my_class.rb` -> `spec/yard/yaml/my_class_spec.rb`.
|
|
164
|
-
- 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.
|
|
165
|
-
|
|
166
|
-
## Lint It
|
|
167
|
-
|
|
168
|
-
Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
|
|
169
|
-
|
|
170
|
-
```console
|
|
171
|
-
bundle exec rake
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
Or just run the linter.
|
|
175
|
-
|
|
176
|
-
```console
|
|
177
|
-
bundle exec rake rubocop_gradual:autocorrect
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
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.
|
|
181
|
-
|
|
182
|
-
### Important: Do not add inline RuboCop disables
|
|
183
|
-
|
|
184
|
-
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:
|
|
185
|
-
|
|
186
|
-
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
|
|
187
|
-
- When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
|
|
188
|
-
- `bundle exec rake rubocop_gradual:autocorrect` (preferred)
|
|
189
|
-
- `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
|
|
190
|
-
|
|
191
|
-
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.
|
|
192
|
-
|
|
193
|
-
## Contributors
|
|
194
|
-
|
|
195
|
-
Your picture could be here!
|
|
196
|
-
|
|
197
|
-
[![Contributors][🖐contributors-img]][🖐contributors]
|
|
198
|
-
|
|
199
|
-
Made with [contributors-img][🖐contrib-rocks].
|
|
200
|
-
|
|
201
|
-
Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/yard-yaml/-/graphs/main][🚎contributors-gl]
|
|
202
|
-
|
|
203
|
-
## For Maintainers
|
|
204
|
-
|
|
205
|
-
### One-time, Per-maintainer, Setup
|
|
206
|
-
|
|
207
|
-
**IMPORTANT**: To sign a build,
|
|
208
|
-
a public key for signing gems will need to be picked up by the line in the
|
|
209
|
-
`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
|
|
210
|
-
All releases are signed releases.
|
|
211
|
-
See: [RubyGems Security Guide][🔒️rubygems-security-guide]
|
|
212
|
-
|
|
213
|
-
NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
|
|
214
|
-
|
|
215
|
-
### To release a new version:
|
|
216
|
-
|
|
217
|
-
#### Automated process
|
|
218
|
-
|
|
219
|
-
1. Update version.rb to contain the correct version-to-be-released.
|
|
220
|
-
2. Run `bundle exec kettle-changelog`.
|
|
221
|
-
3. Run `bundle exec kettle-release`.
|
|
222
|
-
4. Stay awake and monitor the release process for any errors, and answer any prompts.
|
|
223
|
-
|
|
224
|
-
#### Manual process
|
|
225
|
-
|
|
226
|
-
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
|
|
227
|
-
2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
|
|
228
|
-
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
|
|
229
|
-
4. Run `bin/rake yard` to regenerate the docs site using the canonical docs task
|
|
230
|
-
5. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
|
|
231
|
-
6. Run `git push` to trigger the final CI pipeline before release, and merge PRs
|
|
232
|
-
- NOTE: Remember to [check the build][🧪build].
|
|
233
|
-
7. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
|
|
234
|
-
8. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
|
|
235
|
-
9. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
|
|
236
|
-
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
|
|
237
|
-
- If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
|
|
238
|
-
- Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
|
|
239
|
-
- If the echo above has no output, then it didn't work.
|
|
240
|
-
- Note: `zsh/datetime` module is needed, if running `zsh`.
|
|
241
|
-
- In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
|
|
242
|
-
11. Run `bundle exec rake build`
|
|
243
|
-
12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
|
|
244
|
-
to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
|
|
245
|
-
[gem][💎stone_checksums].
|
|
246
|
-
- The script automatically commits but does not push the checksums
|
|
247
|
-
13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
|
|
248
|
-
- `sha256sum pkg/<gem name>-<version>.gem`
|
|
249
|
-
14. Run `bundle exec rake release` which will create a git tag for the version,
|
|
250
|
-
push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
|
|
251
|
-
|
|
252
|
-
[📜src-gl]: https://gitlab.com/galtzo-floss/yard-yaml
|
|
253
|
-
[📜src-cb]: https://codeberg.org/galtzo-floss/yard-yaml
|
|
254
|
-
[📜src-gh]: https://github.com/galtzo-floss/yard-yaml
|
|
255
|
-
[🧪build]: https://github.com/galtzo-floss/yard-yaml/actions
|
|
256
|
-
[🤝conduct]: https://github.com/galtzo-floss/yard-yaml/blob/main/CODE_OF_CONDUCT.md
|
|
257
|
-
[🖐contrib-rocks]: https://contrib.rocks
|
|
258
|
-
[🖐contributors]: https://github.com/galtzo-floss/yard-yaml/graphs/contributors
|
|
259
|
-
[🚎contributors-gl]: https://gitlab.com/galtzo-floss/yard-yaml/-/graphs/main
|
|
260
|
-
[🖐contributors-img]: https://contrib.rocks/image?repo=galtzo-floss/yard-yaml
|
|
261
|
-
[💎gem-coop]: https://gem.coop
|
|
262
|
-
[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
|
|
263
|
-
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
|
|
264
|
-
[🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
|
|
265
|
-
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
266
|
-
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
267
|
-
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
268
|
-
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
269
|
-
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
270
|
-
[🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
271
|
-
[🏃♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
|
|
272
|
-
[✉️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/galtzo-floss#backer
|
|
14
|
-
[🖇osc-backers-i]: https://opencollective.com/galtzo-floss/backers/badge.svg?style=flat
|
|
15
|
-
[🖇osc-sponsors]: https://opencollective.com/galtzo-floss#sponsor
|
|
16
|
-
[🖇osc-sponsors-i]: https://opencollective.com/galtzo-floss/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 galtzo-floss/yard-yaml 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/galtzo-floss
|
|
59
|
-
[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/galtzo-floss
|
|
60
|
-
[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/galtzo-floss
|
|
61
|
-
[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/galtzo-floss?style=for-the-badge
|
|
62
|
-
[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/galtzo-floss?style=for-the-badge
|
|
63
|
-
[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/galtzo-floss?style=for-the-badge
|
|
64
|
-
[🖇osc]: https://opencollective.com/galtzo-floss
|
|
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/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-----
|