yard-yaml 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22b0ebbb95b58991cc23c940303f46f8a1cd8048d867ffb9c8c2b3ccf26e562b
-  data.tar.gz: c7dabbd1ab0ac84f58a458a8d6e9c3b7cd4575f519050eeaf4b3f65947811e56
+  metadata.gz: 17688fbe1cd0c399f12b2d81c53aed6a327711a4b456f450ab18f5f2989e909e
+  data.tar.gz: 1aacaff205bcd423920fe19c3530e26c6e9a186b424228d1bf00d64c38c3231f
 SHA512:
-  metadata.gz: a50e36c08e761144ccb6f4086ee6ce7d7fabcfb2af071487e37c2eb40f53c5a6507ca3160114af4df15f1a68c27f3ca87f3dbdc276fbabe825f7c6f7aa2c9c47
-  data.tar.gz: 708adeb7a7f54c5c07fec992c6adc94d7be12e2ddf28e9d73bc0d3bab08293170383420ab2d64fa3062ca3e8a23825f7aaf2aa8933aa316881a569141a734fbe
+  metadata.gz: e9f165ee92f04e283bb030b4764ff6cbc3dd48ce28e24cc3b7346977300e09a3385983fc1cb54e4102e7f8632cb041805fa726a6b3305d588ad31c3c35fb080c
+  data.tar.gz: b85b2b58d2bf9a33c9afaa63cbb1fc56aab62de626ae25c1789c24a70a810e7b108b0f2495cc9ad76638787b44feb1e5e9e876932b499ae83419bcb57f32c5f7

data/CHANGELOG.md

@@ -30,6 +30,51 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [0.1.2] - 2026-05-27
+
+- TAG: [v0.1.2][0.1.2t]
+- COVERAGE: 94.88% -- 519/547 lines in 12 files
+- BRANCH COVERAGE: 83.25% -- 164/197 branches in 12 files
+- 78.38% documented
+
+### Changed
+
+- Documented that `yard-yaml` discovers YAML/CFF files through its own globs
+  and that listing those files as plain YARD inputs is only needed when users
+  intentionally want YARD's raw file-page rendering too.
+
+### Fixed
+
+- Converted YAML page filenames now default to source paths instead of YAML
+  titles, keeping display titles separate from stable output paths and avoiding
+  silent overwrites when titles collide.
+- Expanded plugin, logger, registry, and tag-renderer specs so the test suite
+  again satisfies the configured line and branch coverage gates.
+- `--plugin yaml` now activates discovery and emits converted YAML pages after
+  YARD finishes generating HTML.
+- `Yard::Yaml::Converter` now adapts to `yaml-converter`'s real in-memory
+  Markdown API instead of calling an obsolete positional `convert` signature.
+
+## [0.1.1] - 2026-05-24
+
+- TAG: [v0.1.1][0.1.1t]
+- COVERAGE: 92.61% -- 451/487 lines in 12 files
+- BRANCH COVERAGE: 76.88% -- 133/173 branches in 12 files
+- 77.46% documented
+
+### Added
+
+- `documentation_local.gemfile` support for sibling-workspace documentation development under `KETTLE_RB_DEV`
+- Added generated CI coverage for `rdoc` `~> 6.11` and `>= 7.0`.
+
+### Changed
+
+- Refreshed generated project tooling, CI, and documentation support from the current `kettle-jem` template.
+
+### Fixed
+
+- `Yard::Yaml::Converter.from_file` now preserves valid UTF-8 text, scrubs malformed UTF-8 safely in non-strict mode, and rejects binary-ish inputs without raw encoding crashes
+
 ## [0.1.0] - 2025-11-10
 
 - TAG: [v0.1.0][0.1.0t]
@@ -43,6 +88,10 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
-[Unreleased]: https://github.com/galtzo-floss/yard-yaml/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/galtzo-floss/yard-yaml/compare/v0.1.2...HEAD
+[0.1.2]: https://github.com/galtzo-floss/yard-yaml/compare/v0.1.1...v0.1.2
+[0.1.2t]: https://github.com/galtzo-floss/yard-yaml/releases/tag/v0.1.2
+[0.1.1]: https://github.com/galtzo-floss/yard-yaml/compare/v0.1.0...v0.1.1
+[0.1.1t]: https://github.com/galtzo-floss/yard-yaml/releases/tag/v0.1.1
 [0.1.0]: https://github.com/galtzo-floss/yard-yaml/compare/ffbe883471d11462dc28675867d852372ea3a481...v0.1.0
 [0.1.0t]: https://github.com/galtzo-floss/yard-yaml/releases/tag/v0.1.0

data/CITATION.cff

@@ -1,19 +1,19 @@
 cff-version: 1.2.0
-title: yard-yaml
+title: "yard-yaml"
 message: >-
   If you use this work and you want to cite it,
   then you can use the metadata from this file.
 type: software
 authors:
-  - given-names: Peter Hurn
-    family-names: Boling
-    email: peter@railsbling.com
-    affiliation: railsbling.com
+  - given-names: "Peter H."
+    family-names: "Boling"
+    email: "floss@galtzo.com"
+    affiliation: "galtzo.com"
     orcid: 'https://orcid.org/0009-0008-8519-441X'
 identifiers:
   - type: url
     value: 'https://github.com/galtzo-floss/yard-yaml'
-    description: yard-yaml
+    description: "yard-yaml"
 repository-code: 'https://github.com/galtzo-floss/yard-yaml'
 abstract: >-
   yard-yaml

data/CONTRIBUTING.md

@@ -8,19 +8,27 @@ To submit a patch, please fork the project, create a patch with tests, and send
 
 Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
 
+## Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the
+[Developer Certificate of Origin](https://developercertificate.org/).
+This ensures that all contributions are properly licensed and attributed.
+
 ## Help out!
 
-Take a look at the `reek` list which is the file called `REEK` and find something to improve.
+Take a look at the open issues and pull requests, or use the gem and find something to improve.
 
 Follow these instructions:
 
-1. Fork the repository
-2. Create a feature branch (`git checkout -b my-new-feature`)
-3. Make some fixes.
-4. Commit changes (`git commit -am 'Added some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
-6. Make sure to add tests for it. This is important, so it doesn't break in a future release.
-7. Create new Pull Request.
+1. Join the Discord: [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
+2. Fork the repository
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Make some fixes.
+5. Commit your changes (`git commit -am 'Added some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Make sure to add tests for it. This is important, so it doesn't break in a future release.
+8. Create new Pull Request.
+9. Announce it in the channel for this org in the [Discord][✉️discord-invite]!
 
 ## Executables vs Rake tasks
 
@@ -42,6 +50,22 @@ There are many Rake tasks available as well. You can see them by running:
 bin/rake -T
 ```
 
+## Code quality checks
+
+Run the Reek task when you want a smell check that fails on current findings:
+
+```shell
+bin/rake reek
+```
+
+Refresh the checked-in `REEK` backlog through the rake task, not by redirecting
+the raw `reek` executable output. The rake task uses the project bundle and
+avoids stale generated binstubs shadowing the Reek gem executable:
+
+```shell
+bin/rake reek:update
+```
+
 ## Environment Variables for Local Development
 
 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.
@@ -52,7 +76,7 @@ General/runtime
 - CI: When set to true, adjusts default rake tasks toward CI behavior
 
 Coverage (kettle-soup-cover / SimpleCov)
-- K_SOUP_COV_DO: Enable coverage collection (default: true in .envrc)
+- K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
 - K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
 - K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
 - K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
@@ -78,35 +102,44 @@ Git hooks and commit message helpers (exe/kettle-commit-msg)
 - GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
 - GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
 
-For a quick starting point, this repository’s `.envrc` shows sane defaults, and `.env.local` can override them locally.
+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 -- ...`.
 
 ## Appraisals
 
 From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
+Generated appraisal and CI workflow floors are controlled by `ruby.test_minimum`
+in `.kettle-jem.yml`; this project was templated with `ruby.test_minimum: 3.2.0`.
+That value describes the lowest Ruby version expected to run the test/development
+toolchain, and it may be higher than the gemspec runtime floor.
+
 They are created and updated with the commands:
 
 ```console
 bin/rake appraisal:update
 ```
 
-When adding an appraisal to CI, check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
+If you need to reset all gemfiles/*.gemfile.lock files:
+
+```console
+bin/rake appraisal:reset
+```
 
-## The Reek List
+When adding an appraisal to CI, check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
 
-Take a look at the `reek` list which is the file called `REEK` and find something to improve.
+## Run Tests
 
-To refresh the `reek` list:
+Run tests via `kettle-test` (provided by `kettle-test`). It runs RSpec, writes the full log to
+`tmp/kettle-test/rspec-TIMESTAMP.log`, and prints a compact highlight block with timing, seed,
+pass/fail count, failing example list, and SimpleCov coverage percentages.
 
 ```console
-bundle exec reek > REEK
+bundle exec kettle-test
 ```
 
-## Run Tests
-
-To run all tests
+For targeted runs, disable the hard coverage threshold to avoid false failures:
 
 ```console
-bundle exec rake test
+K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
 ```
 
 ### Spec organization (required)
@@ -177,33 +210,34 @@ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in th
 1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
 2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
 3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
-4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
-5. Run `git push` to trigger the final CI pipeline before release, and merge PRs
+4. Run `bin/rake yard` to regenerate the docs site using the canonical docs task
+5. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
+6. Run `git push` to trigger the final CI pipeline before release, and merge PRs
     - NOTE: Remember to [check the build][🧪build].
-6. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
-7. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
-8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
-9. 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
+7. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
+8. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
+9. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
+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
     - If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
     - Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
     - If the echo above has no output, then it didn't work.
     - Note: `zsh/datetime` module is needed, if running `zsh`.
     - In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
-10. Run `bundle exec rake build`
-11. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
+11. Run `bundle exec rake build`
+12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
     to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
     [gem][💎stone_checksums].
     - The script automatically commits but does not push the checksums
-12. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
+13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
     - `sha256sum pkg/<gem name>-<version>.gem`
-13. Run `bundle exec rake release` which will create a git tag for the version,
+14. Run `bundle exec rake release` which will create a git tag for the version,
     push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
 
-[📜src-gl]: https://gitlab.com/galtzo-floss/yard-yaml/
+[📜src-gl]: https://gitlab.com/galtzo-floss/yard-yaml
 [📜src-cb]: https://codeberg.org/galtzo-floss/yard-yaml
 [📜src-gh]: https://github.com/galtzo-floss/yard-yaml
 [🧪build]: https://github.com/galtzo-floss/yard-yaml/actions
-[🤝conduct]: https://gitlab.com/galtzo-floss/yard-yaml/-/blob/main/CODE_OF_CONDUCT.md
+[🤝conduct]: https://github.com/galtzo-floss/yard-yaml/blob/main/CODE_OF_CONDUCT.md
 [🖐contrib-rocks]: https://contrib.rocks
 [🖐contributors]: https://github.com/galtzo-floss/yard-yaml/graphs/contributors
 [🚎contributors-gl]: https://gitlab.com/galtzo-floss/yard-yaml/-/graphs/main
@@ -219,3 +253,4 @@ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in th
 [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
 [🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
 [🏃‍♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
+[✉️discord-invite]: https://discord.gg/3qme4XHNKN

data/FUNDING.md

@@ -19,7 +19,7 @@ Many paths lead to being a sponsor or a backer of this project. Are you on such
 [🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg?style=flat
 [🖇polar]: https://polar.sh/pboling
 [🖇kofi-img]: https://img.shields.io/badge/ko--fi-%E2%9C%93-a51611.svg?style=flat
-[🖇kofi]: https://ko-fi.com/O5O86SNP4
+[🖇kofi]: https://ko-fi.com/pboling
 [🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg?style=flat
 [🖇patreon]: https://patreon.com/galtzo
 [🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-%E2%9C%93-a51611.svg?style=flat

data/LICENSE.md

@@ -0,0 +1,11 @@
+# License
+
+This project is made available under the following license.
+Choose the option that best fits your use case:
+
+- [MIT](MIT.md)
+
+## Copyright Notice
+
+Copyright (c) 2025 Annibelle Boling
+Copyright (c) 2025-2026 Peter H. Boling