kettle-soup-cover 1.0.9 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc222614419aa8c54d068e8e03d9db52970855b23513ede5da00dbb21375430e
-  data.tar.gz: bf156744a56f15b303d9f20c7f90e3731a92ace1b2e6120e9727990cdaa56e3f
+  metadata.gz: 1458b8373718791d8c3b2651a424c4b9a69666f5b6296e4146ca544c87455ebf
+  data.tar.gz: dab53e107af0400b12ad09804ab923d75ec12b5dc708d927b56ac5fdd6bd5c47
 SHA512:
-  metadata.gz: 2562506b527763ebd861a48270d98e763f8271003c1ad3154bbd2f534180cbdd1b6654523355d6046b12e12735471d5d0b9f3fbe56851756fbc55ec64a82f16d
-  data.tar.gz: 39f2aeb51829e290f524174457a089c3a20344c692c297871f92d9fe88041b3e90ab72fe7348ab878c892805cfb382984784f16eac631643454289f66594b0c7
+  metadata.gz: 1366dcf03c85cc1c801eeb3bd91ab49e67b7275c807a8cee4a7be6b3fcb23e3a5e6320b20426e7a9913d73ad0df3dbf2f5e45ae6acdaf9bbd2ceba19724fdedc
+  data.tar.gz: 8c684b8e832428784b8246bc5bedf0b3d031667e218c2ebc97a44f0f48bae0fc800fb6b9ae30c18cfd2fedfd2476342cb05a4029be08e309ade70a53307e93fa

data/CHANGELOG.md

@@ -1,57 +1,146 @@
 # Changelog
 
+[![SemVer 2.0.0][📌semver-img]][📌semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog]
+
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog][📗keep-changelog],
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
+and [yes][📌major-versions-not-sacred], platform and engine support are part of the [public API][📌semver-breaking].
+Please file a bug if you notice a violation of semantic versioning.
+
+[📌semver]: https://semver.org/spec/v2.0.0.html
+[📌semver-img]: https://img.shields.io/badge/semver-2.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
+[📗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
 
 ## [Unreleased]
+
 ### Added
+
+- When `ENV["MAX_ROWS"] == "0"`, explicitly, skip simplecov-console TTY output.
+- Script `exe/kettle-soup-cover` generates coverage report
+  - defaults to reading `$K_SOUP_COV_DIR/coverage.json`
+  - prints a summarized report
+  - accepts `-p/--path` or a positional path to coverage.json
+  - requires the `json` formatter be configured in `$K_SOUP_COV_FORMATTERS` (or an explicit JSON path as above).
+
 ### Changed
-### Fixed
+
+- **Coverage merging is now enabled by default** - `USE_MERGING` defaults to `true`
+  - Essential for projects that split tests into multiple rake tasks
+  - Set `K_SOUP_COV_USE_MERGING=false` to disable
+  - Aggregate coverage from multiple test runs (e.g., FFI specs, integration specs, unit specs) when uniquely named:
+  - ```rake
+    # Matrix checks will run in between FFI and MRI
+    desc("Run Backend Matrix Specs")
+    RSpec::Core::RakeTask.new(:backend_matrix_specs) do |t|
+    t.pattern = "./spec_matrix/**/*_spec.rb"
+    end
+    desc("Set SimpleCov command name for backend matrix specs")
+    task(:set_matrix_command_name) do
+    ENV["K_SOUP_COV_COMMAND_NAME"] = "Backend Matrix Specs"
+    end
+    Rake::Task[:backend_matrix_specs].enhance([:set_matrix_command_name])
+    ```
+- **Merge timeout** - `MERGE_TIMEOUT` defaults to 3600 seconds (1 hour)
+  - Sufficient for most test suites to complete all split tasks
+  - Set `K_SOUP_COV_MERGE_TIMEOUT` to override
+
+### Deprecated
+
 ### Removed
 
+### Fixed
+
+### Security
+
+## [1.0.10] - 2025-07-15
+
+- COVERAGE: 93.43% -- 128/137 lines in 10 files
+- BRANCH COVERAGE: 50.00% -- 16/32 branches in 10 files
+- 11.11% documented
+
+### Added
+
+- Add GitHub Pages site to badge info table
+- YARD config, GFM compatible with relative file links
+- Documentation site on GitHub Pages
+  - [kettle-soup-cover.galtzo.com](https://kettle-soup-cover.galtzo.com)
+- Auto-assign issues in the GitHub issue tracker
+
+### Changed
+
+- Updated `spec.homepage_uri` in gemspec to GitHub Pages YARD documentation site
+- Updated contact email in gemspec to `floss@galtzo.com`
+- Upgraded runtime dependency minimums:
+  - simplecov-cobertura v3.0.0
+  - simplecov-html v0.13.1
+  - simplecov-rcov v0.3.7
+  - simplecov-console v0.9.3
+  - version_gem v1.1.8
+
 ## [1.0.9] - 2025-05-20
+
 - COVERAGE: 93.43% -- 128/137 lines in 10 files
 - BRANCH COVERAGE: 50.00% -- 16/32 branches in 10 files
 - 11.11% documented
+
 ### Added
+
 - YARD config, GFM compatible with relative file links
 - Documentation site on GitHub Pages
   - [kettle-soup-cover.galtzo.com](https://kettle-soup-cover.galtzo.com)
+
 ### Changed
+
 - Updated `spec.homepage_uri` in gemspec to GitHub Pages YARD documentation site
 
 ## [1.0.8] - 2025-05-20
+
 - COVERAGE: 93.43% -- 128/137 lines in 10 files
 - BRANCH COVERAGE: 50.00% -- 16/32 branches in 10 files
 - 11.11% documented
+
 ### Added
+
 - Link to discussions on GitHub
+
 ### Changed
+
 - Fixed `spec.homepage` and `spec.source_code_uri` in gemspec
 
 ## [1.0.7] - 2025-05-20
+
 - COVERAGE: 93.43% -- 128/137 lines in 10 files
 - BRANCH COVERAGE: 50.00% -- 16/32 branches in 10 files
 - 11.11% documented
+
 ### Added
+
 - Document usage with minitest
 - Document usage with https://github.com/irongut/CodeCoverageSummary
 - Document usage with https://github.com/marocchino/sticky-pull-request-comment
 - More documentation improvements
 - Link to Discord
+
 ### Changed
+
  - Gem build: Don't check for cert if SKIP_GEM_SIGNING is set
    - Allows linux packaging systems to build gem without signing via rubygems
  - Update homepage in gemspec
  - Improved loading of version.rb in gemspec
 
 ## [1.0.6] - 2025-05-04
+
 - COVERAGE: 93.43% -- 128/137 lines in 10 files
 - BRANCH COVERAGE: 50.00% -- 16/32 branches in 10 files
 - 11.11% documented
+
 ### Added
+
 - Support for linux, and other OSes, in `coverage` rake task
   - previously was macOS only (would raise error on other OSes)
 - ✨ `Kettle::Soup::Cover::OPEN_BIN`
@@ -60,12 +149,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Set `export K_SOUP_COV_OPEN_BIN=` to just print the path to the HTML coverage report in `coverage` task
 - Test coverage increased from 55 => 93 for lines
 - Test coverage increased from 25 => 50 for branches
+
 ### Changed
+
 - Refactored internals in ways that should not affect public APIs
   - allows much greater test coverage
   - report a bug if anything breaks!
 - Going forward all releases will be signed by my key that expires 2045-04-29
+
 ### Fixed
+
 - require hooks such that both work equally well:
   - `require "kettle/soup/cover"`
   - `require "kettle-soup-cover"`
@@ -73,46 +166,66 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - In the ENV set `SKIP_GEM_SIGNING` to any value
 
 ## [1.0.5] - 2025-04-03
+
 ### Added
+
 - Documentation
 - Support for malformed `K_SOUP_COV_FORMATTERS` (extra spaces)
 - Code coverage tools QLTY, and CodeCov.io
 - Added Ruby 3.3, 3.4 to CI
+
 ### Changed
+
 - Update to Contributor Covenant 2.1
 - Allow unsigned gem builds (for linux distros)
 - Checksums are now created by `stone_checksums` gem
+
 ### Fixed
+
 - Incorrect documentation of ENV variables that control gem behavior
 - Prefer `Kernel.load` > `load` in gemspec
   - https://github.com/simplecov-ruby/simplecov/issues/557#issuecomment-2630782358
 
 ## [1.0.4] - 2024-06-11
+
 ### Added
+
 - Documentation
+
 ### Changed
+
 - `version_gem` requirement to 1.0.4
 
 ## [1.0.3] - 2024-05-23
+
 ### Added
+
 - Documentation
 - Mirror repo on GitHub: https://github.com/kettle-rb/kettle-soup-cover
 - More tests
+
 ### Fixed
+
 - Incorrect URLs for homepage, etc
 
 ## [1.0.2] - 2023-10-19
+
 ### Fixed
+
 - Include new `coverage` rake task in the built gem
   - Goddamnit
 - Try to get checksum for SHA-256 to match what is published on Rubygems.org
 
 ## [1.0.1] - 2023-10-19
+
 ### Fixed
+
 - Include new `coverage` rake task in the built gem
 
 ## [1.0.0] - 2023-10-19
+
 ### Added
+
 - ✨ `Regexp.escape` the `FILTER_DIRS` to allow for paths to be excluded from coverage
   - paths must always start at the root of the project, but no leading or trailing slash
 - ✨ Rake task `coverage` will run spec suite, and open results in a browser.
@@ -131,17 +244,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - `Kettle::Soup::Cover::Filters::GtLineFilter`
   - `Kettle::Soup::Cover::Filters::LtLineFilter`
 - More and better documentation
+
 ### Changed
+
 - This gem no longer does `require "simplecov"`
   - Instead you can `require "simplecov" if Kettle::Soup::Cover::DO_COV` wherever you deem fit
+
 ### Fixed
+
 - All ENV vars now begin with a uniform prefix for this gem:
   - `K_SOUP_COV_*`
 
 ## [0.1.0] - 2023-10-17
 - Initial release
 
-[Unreleased]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.8...HEAD
+[Unreleased]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.10...HEAD
+[1.0.10]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.9...v1.0.10
+[1.0.9]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.8...v1.0.9
 [1.0.8]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.7...v1.0.8
 [1.0.7]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.6...v1.0.7
 [1.0.6]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.5...v1.0.6

data/CITATION.cff

@@ -0,0 +1,20 @@
+cff-version: 1.2.0
+title: Kettle::Soup::Cover
+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/kettle-rb/kettle-soup-cover/'
+    description: Kettle::Soup::Cover
+repository-code: 'https://github.com/kettle-rb/kettle-soup-cover/'
+abstract: >-
+  Kettle::Soup::Cover
+license: See license file

data/CONTRIBUTING.md

@@ -13,13 +13,15 @@ We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you m
 
 Simply follow these instructions:
 
-1. Fork the repository
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Make some fixes.
-4. Commit your 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]!
 
 ## The Reek List
 
@@ -27,7 +29,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
 ```
 
@@ -35,7 +37,7 @@ bundle exec reek > REEK
 
 To run all tests
 
-```bash
+```console
 bundle exec rake test
 ```
 
@@ -43,13 +45,13 @@ 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
 ```
 
@@ -113,3 +115,5 @@ NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some v
 [💎stone_checksums]: https://github.com/pboling/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
+[✉️discord-invite]: https://discord.gg/3qme4XHNKN
+[✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 - 2025 Peter H. Boling (railsbling.com)
+Copyright (c) 2023-2025 Peter H. Boling (Galtzo.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