kettle-changelog 1.0.14 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 785464a88ed0968be6078d022d8889d93ab6cde81c1be55b2c2fb8a45e8ab89e
-  data.tar.gz: 361bf50949158e794157f32c579f0e81ebd745f52024b567a7ead733c4786c8a
+  metadata.gz: e6072cef22f9c1a91d39f3b7b03279f0abe772c4777944e220a84b4f7e961432
+  data.tar.gz: 747cbf50f0af54da01b65e619dd3dc629e3f4f7d05dc0ec8fc7655214965ce61
 SHA512:
-  metadata.gz: 1dfb1bf117ae7537fbb1adb03c6071ecaa1a09bb7fb249dba2723e9aeb1e87c8e496f53c20a740f902f03284f8df8cf86ef1da7c14e92df7c9be166b2853269c
-  data.tar.gz: 2626a7d405397e9103ad44273ee88a3fa4d70668ad4a28c06313b1ec156a552f0b4c1da650c5ab22d7caa4d28210ff18716116601fce478708282fe14a94c706
+  metadata.gz: 6e86be3891856e5c3a4cff045df5cf149e3527a360baa483d96617e3786a0a570e86cc2674f60882a37a191e6fd2528b2a77fd1b9a0cb9ec015d017af4051819
+  data.tar.gz: f735f88af50d17d5ddd519ea1d5768103bce821454ace82d29eec83a3f1943aa09562b896aaa2d6f68cab4b9df55f475dfbe97c9eb00e9d856b9c72e5487a8f4

data/CHANGELOG.md

@@ -30,6 +30,36 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [1.0.16] - 2026-11-03
+
+- TAG: [v1.0.16][1.0.16t]
+- COVERAGE: 93.68% -- 1185/1265 lines in 7 files
+- BRANCH COVERAGE: 77.96% -- 421/540 branches in 7 files
+- 36.36% documented
+
+### Added
+
+- `kettle-changelog --release-stats [--file PATH] [--json]` reads the latest released section's coverage, branch coverage and documentation stats back out of a changelog (read-only: no project root, git or network; reads stdin when `--file` is omitted). Only the exact generated line shapes count, `[Unreleased]` and older releases are ignored, and it exits 1 when line coverage is not recorded. Backed by `Kettle::Changelog::ReleaseStats.parse`.
+
+## [1.0.15] - 2026-10-28
+
+- TAG: [v1.0.15][1.0.15t]
+- COVERAGE: 93.53% -- 1157/1237 lines in 6 files
+- BRANCH COVERAGE: 77.55% -- 411/530 branches in 6 files
+- 37.84% documented
+
+### Changed
+
+- [kc] kettle-jem/prepare: updated 10 project files:
+  - configuration (1)
+  - dependencies (9)
+
+- [kc] kettle-jem/template: updated 7 project files:
+  - dependencies (3)
+  - documentation (1)
+  - other (2)
+  - workflows (1)
+
 ## [1.0.14] - 2026-10-25
 
 - TAG: [v1.0.14][1.0.14t]
@@ -338,7 +368,11 @@ Please file a bug if you notice a violation of semantic versioning.
 
 - Initial release
 
-[Unreleased]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.14...HEAD
+[Unreleased]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.16...HEAD
+[1.0.16]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.15...v1.0.16
+[1.0.16t]: https://github.com/kettle-dev/kettle-changelog/releases/tag/v1.0.16
+[1.0.15]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.14...v1.0.15
+[1.0.15t]: https://github.com/kettle-dev/kettle-changelog/releases/tag/v1.0.15
 [1.0.14]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.13...v1.0.14
 [1.0.14t]: https://github.com/kettle-dev/kettle-changelog/releases/tag/v1.0.14
 [1.0.13]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.12...v1.0.13

data/README.md

@@ -38,12 +38,12 @@ I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-ta
 
 ### Compatibility
 
-Compatible with MRI Ruby 4.0.0+.
+The gem's declared runtime compatibility floor is MRI Ruby 4.0.0+, with concordant releases of JRuby and TruffleRuby.
 CI workflows and Appraisals are generated for MRI Ruby 4.0.0+.
 The current MRI CI lane runs on Linux and macOS.
-This test floor is configured by `ruby.test_minimum` in `.kettle-jem.yml` and
-may be higher than the gem's runtime compatibility floor when legacy Rubies are
-not practical for the current toolchain.
+The test floor is configured by `ruby.test_minimum` in `.kettle-jem.yml`.
+When it is higher than the runtime floor, older runtime-compatible Rubies are
+not covered by the generated CI or Appraisal matrix.
 
 <a href="https://github.com/kettle-dev"><img alt="kettle-dev Logo by Aboling0, CC BY-SA 4.0" src="https://logos.galtzo.com/assets/images/kettle-dev/avatar-128px.svg" width="14%" align="right"/></a>
 
@@ -132,7 +132,7 @@ Use `--yes` for non-interactive release automation. Add a note without preparing
 bundle exec kettle-changelog --add-unreleased-entry --section Fixed --entry "Describe the fix."
 ```
 
-Useful queries and maintenance commands include `--pending-release`, `--release-state`, `--reformat`, `--update-prep`, `--json`, and `--events=changelog`. Run `bundle exec kettle-changelog --help` for the complete option list.
+Useful queries and maintenance commands include `--pending-release`, `--release-state`, `--release-stats`, `--reformat`, `--update-prep`, `--json`, and `--events=changelog`. Run `bundle exec kettle-changelog --help` for the complete option list.
 
 ## 🔐 Security
 
@@ -383,7 +383,7 @@ Thanks for RTFM. ☺️
 [📌gitmoji]: https://gitmoji.dev
 [📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
 [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
-[🧮kloc-img]: https://img.shields.io/badge/KLOC-1.237-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-1.265-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
 [🔐security]: https://github.com/kettle-dev/kettle-changelog/blob/main/SECURITY.md
 [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
 [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year

data/exe/kettle-changelog

@@ -63,7 +63,7 @@ end
 
 if ARGV.include?("-h") || ARGV.include?("--help")
   puts <<~USAGE
-    Usage: kettle-changelog [--version VERSION] [--yes] [--coverage-gemfile PATH] [--update-prep|--reformat|--backfill-released-version VERSION] [--pending-release] [--release-state] [--refresh-cache] [--add-unreleased-entry --section SECTION --entry TEXT] [--upsert-unreleased-entry --section SECTION --key KEY --entry TEXT] [--json|--events[=TYPES]] [--no-strict] [--no-coverage-threshold]
+    Usage: kettle-changelog [--version VERSION] [--yes] [--coverage-gemfile PATH] [--update-prep|--reformat|--backfill-released-version VERSION] [--pending-release] [--release-state] [--release-stats [--file PATH]] [--refresh-cache] [--add-unreleased-entry --section SECTION --entry TEXT] [--upsert-unreleased-entry --section SECTION --key KEY --entry TEXT] [--json|--events[=TYPES]] [--no-strict] [--no-coverage-threshold]
 
     Detects the current version from lib/**/version.rb, the latest live release, and
     the most recent CHANGELOG.md release section, then prompts to confirm the selected plan:
@@ -82,6 +82,8 @@ if ARGV.include?("-h") || ARGV.include?("--help")
       --pending-release         Query whether the changelog has release work pending; exits 0 for yes, 1 for no
       --release-state,
       --release-status          Print changelog release state, including latest published release and pending sources
+      --release-stats           Print the latest released section's coverage/doc stats from a changelog (read-only;
+                                --file PATH or stdin; add --json; exits 1 when line coverage is not recorded)
       --refresh-cache           Bypass cached gem.coop version data for this invocation
       --add-unreleased-entry    Add one entry to an existing section under ## [Unreleased]
       --upsert-unreleased-entry Insert or replace one [kc]-keyed entry under ## [Unreleased]
@@ -209,6 +211,24 @@ begin
 
   historical_backfill_version = extract_option_arg!(ARGV, "--backfill-released-version")
   coverage_gemfile = extract_option_arg!(ARGV, "--coverage-gemfile")
+  release_stats_query = ARGV.delete("--release-stats")
+  release_stats_file = extract_option_arg!(ARGV, "--file")
+
+  if release_stats_query
+    # Read-only: no project root, git, network or version detection. Reads --file PATH, or stdin when absent/"-".
+    text = (release_stats_file.nil? || release_stats_file == "-") ? $stdin.read : File.read(release_stats_file)
+    stats = Kettle::Changelog::ReleaseStats.parse(text)
+    if json_output
+      puts(JSON.pretty_generate(stats))
+    elsif stats
+      cov = stats[:coverage]
+      released = [stats[:version], stats[:date] && "(#{stats[:date]})"].compact.join(" ")
+      puts("#{released}: " + (cov ? "#{format("%.2f", cov[:percent])}% line coverage (#{cov[:covered]}/#{cov[:total]} lines in #{cov[:files]} files)" : "no line coverage recorded"))
+    else
+      puts("No released section found.")
+    end
+    exit((stats && stats[:coverage]) ? 0 : 1)
+  end
 
   if upsert_unreleased_entry
     section = extract_option_arg!(ARGV, "--section")

data/lib/kettle/changelog/release_stats.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Kettle
+  module Changelog
+    # Reads the generated stats back out of a changelog's latest released section.
+    #
+    # The writer (CLI) puts these lines directly under each release heading:
+    #
+    #   ## [2.1.0] - 2026-10-25
+    #   - TAG: [v2.1.0][2.1.0t]
+    #   - COVERAGE: 98.48% -- 649/659 lines in 16 files
+    #   - BRANCH COVERAGE: 93.53% -- 217/232 branches in 16 files
+    #   - 90.83% documented
+    #
+    # Only these exact shapes count. `[Unreleased]` is ignored, and so are older releases: a gem whose
+    # latest release lacks the lines reports nothing rather than a stale number from an earlier one.
+    module ReleaseStats
+      NUMBER = '(\d+(?:\.\d+)?)'
+      RELEASE_HEADING = /\A## \[(\d+\.\d+\.\d+[0-9A-Za-z.+-]*)\](?: - (\d{4}-\d{2}-\d{2}))?/
+      LINE_COVERAGE = /\A- COVERAGE: #{NUMBER}% -- (\d+)\/(\d+) lines in (\d+) files\s*\z/
+      BRANCH_COVERAGE = /\A- BRANCH COVERAGE: #{NUMBER}% -- (\d+)\/(\d+) branches in (\d+) files\s*\z/
+      DOCUMENTED = /\A- #{NUMBER}%\s+documented\s*\z/
+
+      module_function
+
+      # @param text [String] full CHANGELOG.md contents
+      # @return [Hash, nil] nil when the changelog has no released section; otherwise
+      #   {version:, date:, coverage:, branch_coverage:, documented:} with nil for anything not found
+      def parse(text)
+        lines = text.to_s.lines
+        start = lines.index { |l| l.match?(RELEASE_HEADING) }
+        return unless start
+
+        heading = lines[start].match(RELEASE_HEADING)
+        stats = {version: heading[1], date: heading[2], coverage: nil, branch_coverage: nil, documented: nil}
+        lines[(start + 1)..].each do |line|
+          break if line.start_with?("#") # next heading, or the first ### subsection: the stats lines come before both
+
+          if (m = line.match(LINE_COVERAGE))
+            stats[:coverage] ||= counts(m)
+          elsif (m = line.match(BRANCH_COVERAGE))
+            stats[:branch_coverage] ||= counts(m)
+          elsif (m = line.match(DOCUMENTED))
+            stats[:documented] ||= m[1].to_f
+          end
+        end
+        stats
+      end
+
+      def counts(match)
+        {percent: match[1].to_f, covered: match[2].to_i, total: match[3].to_i, files: match[4].to_i}
+      end
+      private_class_method :counts
+    end
+  end
+end

data/lib/kettle/changelog/version.rb

@@ -5,7 +5,7 @@ module Kettle
     # Version namespace for this gem.
     module Version
       # Current gem version.
-      VERSION = "1.0.14"
+      VERSION = "1.0.16"
     end
     # Current gem version exposed at the traditional constant location.
     VERSION = Version::VERSION # Traditional Constant Location

data/lib/kettle/changelog.rb

@@ -10,6 +10,7 @@ module Kettle
 
     autoload :CLI, "kettle/changelog/cli"
     autoload :EntryAdder, "kettle/changelog/entry_adder"
+    autoload :ReleaseStats, "kettle/changelog/release_stats"
     autoload :KeyedEntryUpserter, "kettle/changelog/keyed_entry_upserter"
     autoload :TransferMerger, "kettle/changelog/transfer_merger"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kettle-changelog
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 1.0.16
 platform: ruby
 authors:
 - Peter H. Boling
@@ -66,7 +66,7 @@ dependencies:
         version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.25
+        version: 3.1.26
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -76,7 +76,7 @@ dependencies:
         version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.25
+        version: 3.1.26
 - !ruby/object:Gem::Dependency
   name: version_gem
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +86,7 @@ dependencies:
         version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.16
+        version: 1.1.17
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -96,7 +96,7 @@ dependencies:
         version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.16
+        version: 1.1.17
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -154,7 +154,7 @@ dependencies:
         version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -164,7 +164,7 @@ dependencies:
         version: '0.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: appraisal2
   requirement: !ruby/object:Gem::Requirement
@@ -194,7 +194,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.27
+        version: 2.0.29
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -204,7 +204,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.27
+        version: 2.0.29
 - !ruby/object:Gem::Dependency
   name: turbo_tests2
   requirement: !ruby/object:Gem::Requirement
@@ -296,6 +296,7 @@ files:
 - lib/kettle/changelog/cli.rb
 - lib/kettle/changelog/entry_adder.rb
 - lib/kettle/changelog/keyed_entry_upserter.rb
+- lib/kettle/changelog/release_stats.rb
 - lib/kettle/changelog/transfer_merger.rb
 - lib/kettle/changelog/version.rb
 - sig/kettle/changelog.rbs
@@ -304,10 +305,10 @@ licenses:
 - AGPL-3.0-only
 metadata:
   homepage_uri: https://kettle-changelog.galtzo.com
-  source_code_uri: https://github.com/kettle-dev/kettle-changelog/tree/v1.0.14
-  changelog_uri: https://github.com/kettle-dev/kettle-changelog/blob/v1.0.14/CHANGELOG.md
+  source_code_uri: https://github.com/kettle-dev/kettle-changelog/tree/v1.0.16
+  changelog_uri: https://github.com/kettle-dev/kettle-changelog/blob/v1.0.16/CHANGELOG.md
   bug_tracker_uri: https://github.com/kettle-dev/kettle-changelog/issues
-  documentation_uri: https://www.rubydoc.info/gems/kettle-changelog/1.0.14
+  documentation_uri: https://www.rubydoc.info/gems/kettle-changelog/1.0.16
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/kettle-dev/kettle-changelog/wiki
   news_uri: https://www.railsbling.com/tags/kettle-changelog