rspec-pending_for 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0982af839d9c0438fa761f61588888967ed704b0df0a68c8946e78f05b475c6d'
-  data.tar.gz: f997eaf5f97a6f3148bcf8ed4da565ca48ed41f4e5182fbaff842416bc890c6d
+  metadata.gz: b1d0659caeb69f7783bdd1d6ec26e5c544a1ebc772cb762d4970ae7cc8d73d9d
+  data.tar.gz: 95a592a753377b39d012763451386160023e578f80ebbc487bdd3a5daac64254
 SHA512:
-  metadata.gz: 4206663d48651c7351de5ec24ed59c96af25cc55f9d39496bd97c0253107a8b141d6b764b0d6a7744a5788b84c597331d230865cbfe0f50c0c6a043716f73a36
-  data.tar.gz: fcb82059fa14d4f11eaf6872bee45aac02e76745345e5188a9e6b7d287f38b555edb8259a4dcabf34a8572f037e4c1e3237d8789c8ad8b31a1e430a95daa9d15
+  metadata.gz: 2907b74df94884a8652a12452b47deea8216000a79ef99218d25ecd8773dd22bcc23d18d89d789953effc2615c92490aeecd51f68f0b239749cbf366584a665e
+  data.tar.gz: ed7d7ba8a563245cb32da15235dd6c2cec31e79ea6762e0d2a9738c51f631f9ea4bc4983dbccc44c3327d23ccdef9fcae7c266cc3b6fd378e54c1b668a9ccaec

data/CHANGELOG.md

@@ -19,10 +19,21 @@ Please file a bug if you notice a violation of semantic versioning.
 ## [Unreleased]
 ### Added
 ### Changed
-### Fixed
+### Deprecated
 ### Removed
+### Fixed
+### Security
+
+## [0.1.18] - 2025-02-24 ([tag][0.1.18t])
+- TAG: [v0.1.8][0.1.18t]
+- COVERAGE: 100.00% -- 86/86 lines in 6 files
+- BRANCH COVERAGE: 100.00% -- 33/33 branches in 6 files
+- 63.64% documented
+### Added
+- Versions can now be ranges!
 
-## [0.1.7] - 2025-02-24 ([tag][1.0.0t])
+## [0.1.17] - 2025-02-24 ([tag][0.1.17t])
+- TAG: [v0.1.7][0.1.17t]
 - COVERAGE:  98.44% -- 63/64 lines in 6 files
 - BRANCH COVERAGE:  94.44% -- 17/18 branches in 6 files
 - 63.64% documented
@@ -32,6 +43,8 @@ Please file a bug if you notice a violation of semantic versioning.
 - Compatibility with truffleruby (maybe? not able to run it in CI yet)
 - Fixed compatibility with Ruby < 2
 
-[Unreleased]: https://github.com/pboling/rspec-pending_for/compare/v0.1.7...HEAD
-[0.1.7]: https://github.com/pboling/rspec-pending_for/compare/v0.1.16...v0.1.7
-[0.1.7t]: https://github.com/pboling/rspec-pending_for/tags/v0.1.6
+[Unreleased]: https://github.com/pboling/rspec-pending_for/compare/v0.1.18...HEAD
+[0.1.18]: https://github.com/pboling/rspec-pending_for/compare/v0.1.17...v0.1.18
+[0.1.18t]: https://github.com/pboling/rspec-pending_for/tags/v0.1.18
+[0.1.17]: https://github.com/pboling/rspec-pending_for/compare/v0.1.16...v0.1.17
+[0.1.17t]: https://github.com/pboling/rspec-pending_for/tags/v0.1.17

data/CITATION.cff

@@ -0,0 +1,20 @@
+cff-version: 1.2.0
+title: rspec-pending_for
+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/rspec-pending_for/'
+    description: rspec-pending_for
+repository-code: 'https://github.com/galtzo-floss/rspec-pending_for/'
+abstract: >-
+  rspec-pending_for
+license: See license file

data/CODE_OF_CONDUCT.md

@@ -1,4 +1,3 @@
-
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
@@ -61,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[![Contact BDFL][🚂bdfl-contact-img]][🚂bdfl-contact].
+[![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -131,5 +130,5 @@ For answers to common questions about this code of conduct, see the FAQ at
 [Mozilla CoC]: https://github.com/mozilla/diversity
 [FAQ]: https://www.contributor-covenant.org/faq
 [translations]: https://www.contributor-covenant.org/translations
-[🚂bdfl-contact]: http://www.railsbling.com/contact
-[🚂bdfl-contact-img]: https://img.shields.io/badge/Contact-BDFL-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
+[🚂maint-contact]: http://www.railsbling.com/contact
+[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red

data/CONTRIBUTING.md

@@ -1,38 +1,34 @@
 # Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://gitlab.com/pboling/rspec-pending_for][🚎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!
 
-Simply follow these instructions:
+Take a look at the `reek` list which is the file called `REEK` and find something to improve.
+
+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
+```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.
@@ -43,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
 ```
 
@@ -51,7 +47,7 @@ bundle exec reek > REEK
 
 To run all tests
 
-```bash
+```console
 bundle exec rake test
 ```
 
@@ -59,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!
@@ -77,55 +86,67 @@ Your picture could be here!
 
 Made with [contributors-img][🖐contrib-rocks].
 
-Also see GitLab Contributors: [https://gitlab.com/pboling/rspec-pending_for/-/graphs/main][🚎contributors-gl]
+Also see GitLab Contributors: [https://gitlab.com/galtzo-floss/rspec-pending_for/-/graphs/main][🚎contributors-gl]
 
 ## For Maintainers
 
 ### One-time, Per-maintainer, Setup
 
-**IMPORTANT**: Your public key for signing gems will need to be picked up by the line in the
-`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there),
-in order to sign the new release.
+**IMPORTANT**: If you want to sign the build you create,
+your public key for signing gems will need to be picked up by the line in the
+`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
+All releases to RubyGems.org will be signed.
 See: [RubyGems Security Guide][🔒️rubygems-security-guide]
 
+NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some value in your environment.
+
 ### To release a new version:
 
-1. Run `bin/setup && bin/rake` as a tests, coverage, & linting sanity check
+#### Automated process
+
+Run `kettle-release`.
+
+#### Manual process
+
+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
-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`.
-   - In `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
+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
+    - 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] and [2][🔒️rubygems-guides-pr])
-   to create SHA-256 and SHA-512 checksums
-    - Checksums will be committed automatically by the script, but not pushed
-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/rspec-pending_for
-[🧪build]: https://github.com/pboling/rspec-pending_for/actions
-[🤝conduct]: https://gitlab.com/pboling/rspec-pending_for/-/blob/main/CODE_OF_CONDUCT.md
+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].
+    - 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:
+    - `sha256sum pkg/<gem name>-<version>.gem`
+13. 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/galtzo-floss/rspec-pending_for
+[🧪build]: https://github.com/galtzo-floss/rspec-pending_for/actions
+[🤝conduct]: https://gitlab.com/galtzo-floss/rspec-pending_for/-/blob/main/CODE_OF_CONDUCT.md
 [🖐contrib-rocks]: https://contrib.rocks
-[🖐contributors]: https://github.com/pboling/rspec-pending_for/graphs/contributors
-[🚎contributors-gl]: https://gitlab.com/pboling/rspec-pending_for/-/graphs/main
-[🖐contributors-img]: https://contrib.rocks/image?repo=pboling/rspec-pending_for
+[🖐contributors]: https://github.com/galtzo-floss/rspec-pending_for/graphs/contributors
+[🚎contributors-gl]: https://gitlab.com/galtzo-floss/rspec-pending_for/-/graphs/main
+[🖐contributors-img]: https://contrib.rocks/image?repo=galtzo-floss/rspec-pending_for
 [💎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/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