silent_stream 1.0.12 → 1.0.13
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 +162 -24
- data/LICENSE.md +10 -0
- data/README.md +252 -221
- data/lib/silent_stream/version.rb +5 -1
- data/lib/silent_stream.rb +5 -5
- data/sig/silent_stream.rbs +5 -1
- data.tar.gz.sig +0 -0
- metadata +123 -91
- metadata.gz.sig +0 -0
- data/CITATION.cff +0 -20
- data/CODE_OF_CONDUCT.md +0 -135
- data/CONTRIBUTING.md +0 -143
- data/LICENSE.txt +0 -21
- data/REEK +0 -0
- data/RUBOCOP.md +0 -71
- data/SECURITY.md +0 -21
- data/checksums/silent_stream-1.0.10.gem.sha256 +0 -1
- data/checksums/silent_stream-1.0.10.gem.sha512 +0 -1
- data/checksums/silent_stream-1.0.11.gem.sha256 +0 -1
- data/checksums/silent_stream-1.0.11.gem.sha512 +0 -1
- data/checksums/silent_stream-1.0.12.gem.sha256 +0 -1
- data/checksums/silent_stream-1.0.12.gem.sha512 +0 -1
- data/checksums/silent_stream-1.0.9.gem.sha256 +0 -1
- data/checksums/silent_stream-1.0.9.gem.sha512 +0 -1
data/CONTRIBUTING.md
DELETED
|
@@ -1,143 +0,0 @@
|
|
|
1
|
-
# Contributing
|
|
2
|
-
|
|
3
|
-
Bug reports and pull requests are welcome on GitHub, CodeBerg, or [GitLab][🚎src-main].
|
|
4
|
-
This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
|
|
5
|
-
the [code of conduct][🤝conduct].
|
|
6
|
-
|
|
7
|
-
To submit a patch, please fork the project, create a patch with tests, and send a pull request.
|
|
8
|
-
|
|
9
|
-
Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog].
|
|
10
|
-
|
|
11
|
-
## Help out!
|
|
12
|
-
|
|
13
|
-
Take a look at the `reek` list which is the file called `REEK` and find something to improve.
|
|
14
|
-
|
|
15
|
-
Follow these instructions:
|
|
16
|
-
|
|
17
|
-
1. Fork the repository
|
|
18
|
-
2. Create a feature branch (`git checkout -b my-new-feature`)
|
|
19
|
-
3. Make some fixes.
|
|
20
|
-
4. Commit changes (`git commit -am 'Added some feature'`)
|
|
21
|
-
5. Push to the branch (`git push origin my-new-feature`)
|
|
22
|
-
6. Make sure to add tests for it. This is important, so it doesn't break in a future release.
|
|
23
|
-
7. Create new Pull Request.
|
|
24
|
-
|
|
25
|
-
## Appraisals
|
|
26
|
-
|
|
27
|
-
From time to time the Appraisal2 gemfiles in `gemfiles/` will need to be updated.
|
|
28
|
-
They are created and updated with the commands:
|
|
29
|
-
|
|
30
|
-
```console
|
|
31
|
-
bin/rake appraisal:update
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
When adding an appraisal to CI check the [runner tool cache][🏃♂️runner-tool-cache] to see which runner to use.
|
|
35
|
-
|
|
36
|
-
## The Reek List
|
|
37
|
-
|
|
38
|
-
Take a look at the `reek` list which is the file called `REEK` and find something to improve.
|
|
39
|
-
|
|
40
|
-
To refresh the `reek` list:
|
|
41
|
-
|
|
42
|
-
```console
|
|
43
|
-
bundle exec reek > REEK
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## Run Tests
|
|
47
|
-
|
|
48
|
-
To run all tests
|
|
49
|
-
|
|
50
|
-
```console
|
|
51
|
-
bundle exec rake test
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
## Lint It
|
|
55
|
-
|
|
56
|
-
Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
|
|
57
|
-
|
|
58
|
-
```console
|
|
59
|
-
bundle exec rake
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
Or just run the linter.
|
|
63
|
-
|
|
64
|
-
```console
|
|
65
|
-
bundle exec rake rubocop_gradual:autocorrect
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
For more detailed information about using RuboCop in this project, please see the [RUBOCOP.md](RUBOCOP.md) guide. This project uses `rubocop_gradual` instead of vanilla RuboCop, which requires specific commands for checking violations.
|
|
69
|
-
|
|
70
|
-
### Important: Do not add inline RuboCop disables
|
|
71
|
-
|
|
72
|
-
Never add `# rubocop:disable ...` / `# rubocop:enable ...` comments to code or specs (except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). Instead:
|
|
73
|
-
|
|
74
|
-
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
|
|
75
|
-
- When a violation is temporary and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
|
|
76
|
-
- `bundle exec rake rubocop_gradual:autocorrect` (preferred)
|
|
77
|
-
- `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
|
|
78
|
-
|
|
79
|
-
As a general rule, fix style issues rather than ignoring them. For example, our specs should follow RSpec conventions like using `described_class` for the class under test.
|
|
80
|
-
|
|
81
|
-
## Contributors
|
|
82
|
-
|
|
83
|
-
Your picture could be here!
|
|
84
|
-
|
|
85
|
-
[![Contributors][🖐contributors-img]][🖐contributors]
|
|
86
|
-
|
|
87
|
-
Made with [contributors-img][🖐contrib-rocks].
|
|
88
|
-
|
|
89
|
-
Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/silent_stream/-/graphs/main][🚎contributors-gl]
|
|
90
|
-
|
|
91
|
-
## For Maintainers
|
|
92
|
-
|
|
93
|
-
### One-time, Per-maintainer, Setup
|
|
94
|
-
|
|
95
|
-
**IMPORTANT**: If you want to sign the build you create,
|
|
96
|
-
your public key for signing gems will need to be picked up by the line in the
|
|
97
|
-
`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
|
|
98
|
-
All releases to RubyGems.org will be signed.
|
|
99
|
-
See: [RubyGems Security Guide][🔒️rubygems-security-guide]
|
|
100
|
-
|
|
101
|
-
NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some value in your environment.
|
|
102
|
-
|
|
103
|
-
### To release a new version:
|
|
104
|
-
|
|
105
|
-
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
|
|
106
|
-
2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
|
|
107
|
-
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
|
|
108
|
-
4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
|
|
109
|
-
5. Run `git push` to trigger the final CI pipeline before release, and merge PRs
|
|
110
|
-
- NOTE: Remember to [check the build][🧪build].
|
|
111
|
-
6. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
|
|
112
|
-
7. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
|
|
113
|
-
8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
|
|
114
|
-
9. Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use same timestamp, and generate same checksums
|
|
115
|
-
- Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
|
|
116
|
-
- If the echo above has no output, then it didn't work.
|
|
117
|
-
- Note: `zsh/datetime` module is needed, if running `zsh`.
|
|
118
|
-
- In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
|
|
119
|
-
10. Run `bundle exec rake build`
|
|
120
|
-
11. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
|
|
121
|
-
to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
|
|
122
|
-
[gem][💎stone_checksums].
|
|
123
|
-
- The script automatically commits but does not push the checksums
|
|
124
|
-
12. Run `bundle exec rake release` which will create a git tag for the version,
|
|
125
|
-
push git commits and tags, and push the `.gem` file to [rubygems.org][💎rubygems]
|
|
126
|
-
|
|
127
|
-
[🚎src-main]: https://gitlab.com/galtzo-floss/silent_stream
|
|
128
|
-
[🧪build]: https://github.com/galtzo-floss/silent_stream/actions
|
|
129
|
-
[🤝conduct]: https://gitlab.com/galtzo-floss/silent_stream/-/blob/main/CODE_OF_CONDUCT.md
|
|
130
|
-
[🖐contrib-rocks]: https://contrib.rocks
|
|
131
|
-
[🖐contributors]: https://github.com/galtzo-floss/silent_stream/graphs/contributors
|
|
132
|
-
[🚎contributors-gl]: https://gitlab.com/galtzo-floss/silent_stream/-/graphs/main
|
|
133
|
-
[🖐contributors-img]: https://contrib.rocks/image?repo=galtzo-floss/silent_stream
|
|
134
|
-
[💎rubygems]: https://rubygems.org
|
|
135
|
-
[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
|
|
136
|
-
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
|
|
137
|
-
[🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
|
|
138
|
-
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
139
|
-
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
140
|
-
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
141
|
-
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
142
|
-
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
143
|
-
[🏃♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
|
data/LICENSE.txt
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
The MIT License (MIT)
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2018-2020, 2024-2025 Peter H. Boling (railsbling.com)
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in
|
|
13
|
-
all copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
-
THE SOFTWARE.
|
data/REEK
DELETED
|
File without changes
|
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
|
-
| 1.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
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
b67962588acdddcb8b1972e35b4b0606bfcc23dd966841b7fec26cd282dc8a47
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
062b86979e8ba71e8ad2d5861e62a6624afc00758cfd5752be7cf8209e87fabe1b9d51cc2e35c4be7c8f25a7f46011d485605b4d40c4f1fcfd8d813f5d1ab218
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
62f30ff2c1352f675eb2bff9170168d4e2524d71caf3e86be36a1ea741eedcd7
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
9a3bd81805f4514e499baf2de8994e3782239f09251304e17fdd5fa822bdc68938ad7a7c00cd92c633ed851e003b720b4230082f17a7095150e9305ac9dab0cb
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
f3cdf0e2ef000d28ea28cd324a4e74fcf3ec49a0fee6f156b862aedd1ae7d19c
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
677edc4416117621d892c13e119be6335b2a29c4efc0c09ce1a71d7ad33792572a7922d5b16f14c409ea6743518621d053eaf182a880aad492be49e6bb77d366
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
45e15ce4ba2d8d2ccbc07b165e795be4bff64715565fb102eb8be8a7c4a0b36c
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
196f3d50a68953899daeafa4e6ef1da6ecf073a1e4f9dbc56ff2e606b50be717297de84309c81d4d32c66a1a85545e721d662233affc512add1616f0ad6fc2f4
|