Changelog

This file documents all notable changes to this project.

Format: Keep a Changelog,
Versioning: Semantic Versioning.

Unreleased

Added

Changed

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
  • 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
  • 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
    • Set export K_SOUP_COV_OPEN_BIN=open to use macOS’ open command in coverage task
    • Set export K_SOUP_COV_OPEN_BIN=xdg-open to use Linux’ xdg-open command in coverage task
    • 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"
  • Allow unsigned gem builds (for linux distros)
    • 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.
  • ✨ Kettle::Soup::Cover::PREFIX allows configuration of a custom ENV variable name prefix
    • Set export K_SOUP_COV_DEBUG="K_SOUP_COV_" (default shown)
  • ✨ Kettle::Soup::Cover::USE_MERGING
    • Set export K_SOUP_COV_USE_MERGING=true
  • ✨ Kettle::Soup::Cover::MERGE_TIMEOUT
    • Set export K_SOUP_COV_MERGE_TIMEOUT=3600
  • ✨ Kettle::Soup::Cover::DEBUG - similar to VERBOSE, only moreso!
    • Set export K_SOUP_COV_DEBUG=true
    • NOTE: This gem actually has zero output statements.
      • The utility of DEBUG and VERBOSE being a part of this library is
        to normalize handling of this common logical need in other libraries.
  • ✨ Kettle::Soup::Cover.load_filters
    • 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