silent_stream 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9698b362b15e935877ac6cc7bf851b972ee1163411c4b25d394cce3a98d252b3
-  data.tar.gz: 7f9b68070f2c7108a71f20a0cf58a9d192e200cfd44f3d01f8be803fbe654320
+  metadata.gz: 279fb05d2943bbe8779287d63b1d35dd10dd5c8491efeceb1b5e8327d00ab5d9
+  data.tar.gz: 62e8635f1d2761ae442890d8d64f9ed4f439a286e3be9898b2f6049bfbb8ede3
 SHA512:
-  metadata.gz: ed5d4a2f3c57a573f9166bfc3fe9f58cd2cef37bd8906c665cce6bb49f6edc60ad0740f743d77f2b00f67efec0825d8a96dd757d16c3e67ca3f513e04cd28b56
-  data.tar.gz: a8620cd13c0a3a80606884b4b7bfe0530fc405166eeb031d014bf84f34259825040db6abf80f15a81b383f93b8f3af7b65f256fa7e1e26f28834fe85874d357b
+  metadata.gz: 55b666b78b83519c71466c43c849144711d5d0846daf1a8c66502d1478afdf1d0b38848221ae5f21dafec02950f3596915d7d0da4c8431b1ac9efe820487b74c
+  data.tar.gz: 0f73b08add9bb7abb7e117f1d82b246b22e97db2e268126e053da8bcf44de04ce53bcb268d74c13f730752869e9a80a4539a31007feafa4daa2f1148b4e4cf08

data/CHANGELOG.md

@@ -8,12 +8,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added
 ### Changed
-### Fixed
+### Deprecated
 ### Removed
+### Fixed
+### Security
+
+## [1.0.12] - 2025-08-21
+- TAG: [v1.0.12][1.0.12t]
+- COVERAGE: 100.00% -- 80/80 lines in 2 files
+- BRANCH COVERAGE: 100.00% -- 21/21 branches in 2 files
+- 50.00% documented
+### Added
+- RBS types
+- More YARD documentation
+- Published docs site: [silent-stream.galtzo.com](https://silent-stream.galtzo.com)
+- Complete test coverage for lines and branches at 100%
+### Fixed
+-  TypeError: can't convert Tempfile into StringIO
 
 ## [1.0.11] - 2025-05-16
-- COVERAGE:  88.06% -- 59/67 lines in 2 files
-- BRANCH COVERAGE:  30.00% -- 3/10 branches in 2 files
+- TAG: [v1.0.11][1.0.11t]
+- COVERAGE: 88.06% -- 59/67 lines in 2 files
+- BRANCH COVERAGE: 30.00% -- 3/10 branches in 2 files
 - 50.00% documented
 ### Changed
 - Reduced minimum version of logger dependency to 1.2
@@ -22,6 +38,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Code Coverage setup in CI
 
 ## [1.0.10] - 2025-05-05
+- TAG: [v1.0.10][1.0.10t]
 - COVERAGE:  47.76% -- 32/67 lines in 2 files
 - BRANCH COVERAGE:  10.00% -- 1/10 branches in 2 files
 - 50.00% documented
@@ -30,6 +47,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Allows test coverage to be tracked for version.rb
 
 ## [1.0.9] - 2025-05-05
+- TAG: [v1.0.9][1.0.9t]
 - COVERAGE:  40.62% -- 26/64 lines in 2 files
 - BRANCH COVERAGE:  10.00% -- 1/10 branches in 2 files
 - 54.55% documented
@@ -42,32 +60,56 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Expanded CI test matrix to include JRuby, TruffleRuby, and MRI 2.3+, including heads
 
 ## [1.0.8] - 2024-03-20
+- TAG: [v1.0.8][1.0.8t]
 
 ## [1.0.7] - 2024-03-20
+- TAG: [v1.0.7][1.0.7t]
 
 ## [1.0.6] - 2020-02-25
+- TAG: [v1.0.6][1.0.6t]
 
 ## [1.0.5] - 2018-10-10
+- TAG: [v1.0.5][1.0.5t]
 
 ## [1.0.4] - 2018-10-06
+- TAG: [v1.0.4][1.0.4t]
 
 ## [1.0.3] - 2018-09-25
+- TAG: [v1.0.3][1.0.3t]
 
 ## [1.0.2] - 2018-09-25
+- TAG: [v1.0.2][1.0.2t]
 
 ## [1.0.1] - 2018-09-23
+- TAG: [v1.0.1][1.0.1t]
 
 ## [1.0.0] - 2018-09-23
-
-[Unreleased]: https://gitlab.com/pboling/silent_stream/-/compare/v1.0.10...HEAD
-[1.0.10]: https://gitlab.com/pboling/silent_stream/-/compare/v1.0.9...v1.0.10
-[1.0.9]: https://gitlab.com/pboling/silent_stream/-/compare/v1.0.8...v1.0.9
-[1.0.8]: https://gitlab.com/pboling/silent_stream/-/compare/v1.0.7...v1.0.8
-[1.0.7]: https://gitlab.com/pboling/silent_stream/-/compare/v1.0.5...v1.0.7
+- TAG: [v1.0.0][1.0.0t]
+
+[Unreleased]: https://gitlab.com/galtzo-floss/silent_stream-/compare/v1.0.12...HEAD
+[1.0.12]: https://gitlab.com/galtzo-floss/silent_stream-/compare/v1.0.11...v1.0.12
+[1.0.12t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.12
+[1.0.11]: https://gitlab.com/galtzo-floss/silent_stream-/compare/v1.0.10...v1.0.11
+[1.0.11t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.11
+[1.0.10]: https://gitlab.com/galtzo-floss/silent_stream-/compare/v1.0.9...v1.0.10
+[1.0.10t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.10
+[1.0.9]: https://gitlab.com/galtzo-floss/silent_stream-/compare/v1.0.8...v1.0.9
+[1.0.9t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.9
+[1.0.8]: https://gitlab.com/galtzo-floss/silent_stream-/compare/v1.0.7...v1.0.8
+[1.0.8t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.8
+[1.0.7]: https://gitlab.com/galtzo-floss/silent_stream-/compare/v1.0.5...v1.0.7
+[1.0.7t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.7
 [1.0.6]: https://rubygems.org/gems/silent_stream/versions/1.0.6
-[1.0.5]: https://gitlab.com/pboling/silent_stream/-/tags/v1.0.5
+[1.0.6t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.6
+[1.0.5]: https://gitlab.com/galtzo-floss/silent_stream-/tags/v1.0.5
+[1.0.5t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.5
 [1.0.4]: https://rubygems.org/gems/silent_stream/versions/1.0.4
+[1.0.4t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.4
 [1.0.3]: https://rubygems.org/gems/silent_stream/versions/1.0.3
+[1.0.3t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.3
 [1.0.2]: https://rubygems.org/gems/silent_stream/versions/1.0.2
+[1.0.2t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.2
 [1.0.1]: https://rubygems.org/gems/silent_stream/versions/1.0.1
+[1.0.1t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.1
 [1.0.0]: https://rubygems.org/gems/silent_stream/versions/1.0.0
+[1.0.0t]: https://gitlab.com/galtzo-floss/timecop-rspec/-/tags/v1.0.0

data/CITATION.cff

@@ -0,0 +1,20 @@
+cff-version: 1.2.0
+title: silent_stream
+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
+    orcid: 'https://orcid.org/0009-0008-8519-441X'
+identifiers:
+  - type: url
+    value: 'https://github.com/galtzo-floss/silent_stream'
+    description: silent_stream
+repository-code: 'https://github.com/galtzo-floss/silent_stream'
+abstract: >-
+  silent_stream
+license: See license file

data/CONTRIBUTING.md

@@ -1,41 +1,34 @@
 # Contributing
 
-Bug reports and pull requests are welcome on GitLab at [https://gitlab.com/pboling/silent_stream][🚎src-main]
-. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+Bug reports and pull requests are welcome on GitHub, CodeBerg, or [GitLab][🚎src-main].
+This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
 the [code of conduct][🤝conduct].
 
-To submit a patch, please fork the project and create a patch with tests.
-Once you're happy with it send a pull request.
+To submit a patch, please fork the project, create a patch with tests, and send a pull request.
 
-We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
+Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog].
 
-## You can help!
+## Help out!
 
 Take a look at the `reek` list which is the file called `REEK` and find something to improve.
 
-Simply follow these instructions:
+Follow these instructions:
 
 1. Fork the repository
-2. Create your feature branch (`git checkout -b my-new-feature`)
+2. Create a feature branch (`git checkout -b my-new-feature`)
 3. Make some fixes.
-4. Commit your changes (`git commit -am 'Added some feature'`)
+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.
 
 ## Appraisals
 
-From time to time the appraisal gemfiles in `gemfiles/` will need to be updated.
+From time to time the Appraisal2 gemfiles in `gemfiles/` will need to be updated.
 They are created and updated with the commands:
 
-NOTE: We run on a [fork][🚎appraisal-fork] of Appraisal.
-
-Please upvote the PR for `eval_gemfile` [support][🚎appraisal-eval-gemfile-pr]
-
-```shell
-BUNDLE_GEMFILE=Appraisal.root.gemfile bundle
-BUNDLE_GEMFILE=Appraisal.root.gemfile bundle exec appraisal update
-bundle exec rake rubocop_gradual:autocorrect
+```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.
@@ -46,7 +39,7 @@ Take a look at the `reek` list which is the file called `REEK` and find somethin
 
 To refresh the `reek` list:
 
-```bash
+```console
 bundle exec reek > REEK
 ```
 
@@ -54,7 +47,7 @@ bundle exec reek > REEK
 
 To run all tests
 
-```bash
+```console
 bundle exec rake test
 ```
 
@@ -62,16 +55,29 @@ bundle exec rake test
 
 Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
 
-```bash
+```console
 bundle exec rake
 ```
 
 Or just run the linter.
 
-```bash
+```console
 bundle exec rake rubocop_gradual:autocorrect
 ```
 
+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.
+
+### Important: Do not add inline RuboCop disables
+
+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:
+
+- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
+- When a violation is temporary and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
+  - `bundle exec rake rubocop_gradual:autocorrect` (preferred)
+  - `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
+
+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.
+
 ## Contributors
 
 Your picture could be here!
@@ -80,7 +86,7 @@ Your picture could be here!
 
 Made with [contributors-img][🖐contrib-rocks].
 
-Also see GitLab Contributors: [https://gitlab.com/pboling/silent_stream/-/graphs/master][🚎contributors-gl]
+Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/silent_stream/-/graphs/main][🚎contributors-gl]
 
 ## For Maintainers
 
@@ -96,44 +102,42 @@ NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some v
 
 ### To release a new version:
 
-1. Run `bin/setup && bin/rake` as a tests, coverage, & linting sanity check
+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, & merge PRs
-    - NOTE: Remember to [check the build][🧪build]!
+5. 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 you will release the latest trunk code
+8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
 9. Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use same timestamp, and generate same checksums
     - Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
     - If the echo above has no output, then it didn't work.
-    - Note that you'll need the `zsh/datetime` module, if running `zsh`.
+    - 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])
     to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
     [gem][💎stone_checksums].
-    - Checksums will be committed automatically by the script, but not pushed
+    - The script automatically commits but does not push the checksums
 12. 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 [rubygems.org][💎rubygems]
 
-[🚎src-main]: https://gitlab.com/pboling/silent_stream
-[🧪build]: https://github.com/pboling/silent_stream/actions
-[🤝conduct]: https://gitlab.com/pboling/silent_stream/-/blob/master/CODE_OF_CONDUCT.md
+[🚎src-main]: https://gitlab.com/galtzo-floss/silent_stream
+[🧪build]: https://github.com/galtzo-floss/silent_stream/actions
+[🤝conduct]: https://gitlab.com/galtzo-floss/silent_stream/-/blob/main/CODE_OF_CONDUCT.md
 [🖐contrib-rocks]: https://contrib.rocks
-[🖐contributors]: https://github.com/pboling/silent_stream/graphs/contributors
-[🚎contributors-gl]: https://gitlab.com/pboling/silent_stream/-/graphs/master
-[🖐contributors-img]: https://contrib.rocks/image?repo=pboling/silent_stream
+[🖐contributors]: https://github.com/galtzo-floss/silent_stream/graphs/contributors
+[🚎contributors-gl]: https://gitlab.com/galtzo-floss/silent_stream/-/graphs/main
+[🖐contributors-img]: https://contrib.rocks/image?repo=galtzo-floss/silent_stream
 [💎rubygems]: https://rubygems.org
 [🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
 [🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
 [🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
-[💎stone_checksums]: https://github.com/pboling/stone_checksums
+[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
 [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
 [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
 [📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
 [📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
-[🚎appraisal-eval-gemfile-pr]: https://github.com/thoughtbot/appraisal/pull/248
-[🚎appraisal-fork]: https://github.com/pboling/appraisal/tree/galtzo
 [🏃‍♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 - 2020, 2024 - 2025 Peter H. Boling (railsbling.com)
+Copyright (c) 2018-2020, 2024-2025 Peter H. Boling (railsbling.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal