kettle-soup-cover 1.0.10 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d261f9bfba53179b6efb788d225d8856a9c84cf59d100006b725849fbcd2642
-  data.tar.gz: a45573d36a905304612b14a4d7115904d9350c86210a4da9010e70bcfba00689
+  metadata.gz: 1458b8373718791d8c3b2651a424c4b9a69666f5b6296e4146ca544c87455ebf
+  data.tar.gz: dab53e107af0400b12ad09804ab923d75ec12b5dc708d927b56ac5fdd6bd5c47
 SHA512:
-  metadata.gz: 49c8f710a0615ca7a445f2a270ec312a9b6eb7974094706a60d33e07bac4368903cc8803cad0195dd42ccb90b4bfc42d13f15eb2f80818d248be0493ffbcb03c
-  data.tar.gz: 6f1c2f65f153210551d7cab85baec9ca6faa732030df0c51bb9485c94a246b5ee7b91636ef2e25f3c5b50194d870812e26d5471ed5c6a81f15fb81350293ec19
+  metadata.gz: 1366dcf03c85cc1c801eeb3bd91ab49e67b7275c807a8cee4a7be6b3fcb23e3a5e6320b20426e7a9913d73ad0df3dbf2f5e45ae6acdaf9bbd2ceba19724fdedc
+  data.tar.gz: 8c684b8e832428784b8246bc5bedf0b3d031667e218c2ebc97a44f0f48bae0fc800fb6b9ae30c18cfd2fedfd2476342cb05a4029be08e309ade70a53307e93fa

data/CHANGELOG.md

@@ -1,29 +1,78 @@
 # Changelog
 
-This file documents all notable changes to this project.
+[![SemVer 2.0.0][📌semver-img]][📌semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog]
 
-Format: [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+All notable changes to this project will be documented in this file.
+
+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
+
+- **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:
@@ -34,46 +83,64 @@ Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   - 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`
@@ -82,12 +149,16 @@ Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   - 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"`
@@ -95,46 +166,66 @@ Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   - 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.
@@ -153,10 +244,14 @@ Versioning: [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   - `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_*`
 

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/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