kettle-changelog 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42ae636c33d71f79fe63d7f59eaffc962a3bab7bd2fb1df78ccffaa5814806a5
-  data.tar.gz: 698fab6d1d3a7755322fd41757f094e9f43442f3c3f87634d623c5bee703eabd
+  metadata.gz: 91116b5db1a2ec7a70b8bb798aae0e19222ee9eded29fc26b8bdf80e0efd0d0d
+  data.tar.gz: f1dd9b8ff5dc27c2393a87f4fa74c2323910248fe8765755a2a47ca74aabe105
 SHA512:
-  metadata.gz: b85f5235a110584809417c49ca301d9e1e13997297c13cf269caccaeaf5471b58a60b32588be6be6e482a0f8d84ce856225189082915dec3802cd6b121bf9c1b
-  data.tar.gz: 9b84ef165516207a14726dae25b8754ab9bcfb017ef458e3b0b2e60f2c90bae55c712ea02c867ee2959a25f657be8f0bd767ffd115659b31bc3fa934e1725945
+  metadata.gz: 383cbcaed4483a26f407bb7f9b433cddb77799f8f6c91b7f241e07c893f8ef41c2982ba071694d5197017bac689eb7c2b7afd82d6feb0d0384cdc565be37c9bf
+  data.tar.gz: 2b3233ceb38ae67fd12e82d03fa56590f028b5738aa5ebaaf731e6e6a071f5cc849c3ad1843535305184122cfa3478a7ca5d398312e02d726a890b78a740d9a1

data/CHANGELOG.md

@@ -30,6 +30,30 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [1.0.6] - 2026-08-29
+
+- TAG: [v1.0.6][1.0.6t]
+- COVERAGE: 94.27% -- 1119/1187 lines in 6 files
+- BRANCH COVERAGE: 77.31% -- 385/498 branches in 6 files
+- 38.89% documented
+
+### Fixed
+
+- Consolidate repeated keyed project-file summaries when updating a prepared release section.
+
+- Consolidate repeated keyed project-file summaries within each published release during changelog reformatting.
+
+## [1.0.5] - 2026-08-28
+
+- TAG: [v1.0.5][1.0.5t]
+- COVERAGE: 94.05% -- 1075/1143 lines in 6 files
+- BRANCH COVERAGE: 76.95% -- 374/486 branches in 6 files
+- 39.39% documented
+
+### Fixed
+
+- Backfill missing release-tag Markdown references only when the matching local Git tag exists.
+
 ## [1.0.4] - 2026-08-28
 
 - TAG: [v1.0.4][1.0.4t]
@@ -168,7 +192,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.4...HEAD
+[Unreleased]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.6...HEAD
+[1.0.6]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.5...v1.0.6
+[1.0.6t]: https://github.com/kettle-dev/kettle-changelog/releases/tag/v1.0.6
+[1.0.5]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.4...v1.0.5
+[1.0.5t]: https://github.com/kettle-dev/kettle-changelog/releases/tag/v1.0.5
 [1.0.4]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.3...v1.0.4
 [1.0.4t]: https://github.com/kettle-dev/kettle-changelog/releases/tag/v1.0.4
 [1.0.3]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.2...v1.0.3

data/README.md

@@ -397,7 +397,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.126-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-1.187-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/lib/kettle/changelog/cli.rb

@@ -23,6 +23,8 @@ module Kettle
       LINK_REF_DEF_RE = /^\s*\[[^\]]+\]:\s+\S+/
       # Matches an ATX heading at H4 or deeper (####, #####, ...)
       DEEP_HEADING_RE = /^\#{4,}\s/
+      # Matches the canonical release-tag row emitted for each release section.
+      TAG_REFERENCE_USAGE_RE = /^ {0,3}- TAG: \[v(#{CHANGELOG_VERSION_PATTERN_SOURCE})\]\[\1t\]\s*$/o
 
       # Initialize the changelog CLI
       # Sets up paths for CHANGELOG.md and coverage.json
@@ -146,7 +148,7 @@ module Kettle
             # Keep all content prior to the link-ref (older releases and interspersed refs)
             preserved_body = after_lines[0...unreleased_ref_idx].join
             # Then append the tail starting from the Unreleased link-ref line to preserve the footer refs
-            preserved_footer = after_lines[unreleased_ref_idx..-1].join
+            preserved_footer = after_lines[unreleased_ref_idx..].join
             updated << preserved_body << preserved_footer
           else
             # No Unreleased ref found; just append the remainder as-is
@@ -423,6 +425,7 @@ module Kettle
         updated = convert_heading_tag_suffix_to_list(changelog)
         updated = normalize_legacy_release_headings(updated)
         updated = remove_redundant_historical_placeholders(updated)
+        updated = collapse_keyed_project_file_updates_by_release(updated)
         updated = normalize_heading_spacing(updated)
         updated = ensure_footer_spacing(updated)
         updated = updated.rstrip + "\n"
@@ -458,6 +461,15 @@ module Kettle
         lines.each_with_index.reject { |_line, index| removals.any? { |range| range.cover?(index) } }.map(&:first).join
       end
 
+      def collapse_keyed_project_file_updates_by_release(changelog)
+        lines = changelog.to_s.lines
+        changelog_release_sections(lines).sort_by { |section| section.fetch(:start) }.reverse_each do |section|
+          range = section.fetch(:start)...section.fetch(:finish)
+          lines[range] = KeyedEntryUpserter.collapse_project_file_updates(lines[range].join).lines
+        end
+        lines.join
+      end
+
       def changelog_release_sections(lines)
         headings = lines.each_index.filter_map do |index|
           match = lines[index].match(/^## \[(#{CHANGELOG_VERSION_PATTERN_SOURCE})\]/o)
@@ -594,7 +606,7 @@ module Kettle
         # Now next_i points to the next section heading or EOF
         before = lines[0..(start_i - 1)].join
         unreleased_body = lines[(start_i + 1)..(next_i - 1)] || []
-        after_lines = lines[next_i..-1] || []
+        after_lines = lines[next_i..] || []
 
         # When this is the very first release there is no `## [X.Y.Z]` heading to act
         # as a boundary, so the footer link-ref block ([Unreleased]: ...) sits at the
@@ -603,7 +615,7 @@ module Kettle
         if next_i == lines.length
           footer_i = unreleased_body.index { |l| l.start_with?(UNRELEASED_SECTION_HEADING) }
           if footer_i
-            after_lines = unreleased_body[footer_i..-1] + after_lines
+            after_lines = unreleased_body[footer_i..] + after_lines
             unreleased_body = unreleased_body[0...footer_i]
           end
         end
@@ -630,12 +642,12 @@ module Kettle
 
         prepared_version = release_heading[1]
         release_and_tail = after.lines
-        next_release_index = release_and_tail[1..-1].to_a.index { |line| line.start_with?("## [") }
+        next_release_index = release_and_tail[1..].to_a.index { |line| line.start_with?("## [") }
         release_line_count = next_release_index ? next_release_index + 1 : release_and_tail.length
         release_lines = release_and_tail[0...release_line_count]
-        tail = release_and_tail[release_line_count..-1].to_a.join
+        tail = release_and_tail[release_line_count..].to_a.join
 
-        release_body = release_lines[1..-1].to_a.join
+        release_body = release_lines[1..].to_a.join
         merged_body = merge_release_body_with_unreleased(release_body, unreleased_block)
 
         release_section = +""
@@ -708,7 +720,8 @@ module Kettle
           end
         end
 
-        ([leading] + sections.map { |section| section.fetch(:heading) + trim_blank_lines(section.fetch(:lines)).join }).join.rstrip + "\n"
+        merged = ([leading] + sections.map { |section| section.fetch(:heading) + trim_blank_lines(section.fetch(:lines)).join }).join.rstrip + "\n"
+        KeyedEntryUpserter.collapse_project_file_updates(merged)
       end
 
       def strip_release_metadata(release_body)
@@ -1103,7 +1116,7 @@ module Kettle
         scan_start = lines.index { |l| l.start_with?(UNRELEASED_SECTION_HEADING) } || lines.length
         t_versions = {}
         non_t_tag_refs = {}
-        lines[scan_start..-1].to_a.each do |l|
+        lines[scan_start..].to_a.each do |l|
           # Case A: explicit tag ref key like [1.2.3t]: ...
           if (m = l.match(/^\[(#{CHANGELOG_VERSION_PATTERN_SOURCE})t\]:\s+(\S+)/o))
             t_versions[m[1]] = true
@@ -1237,6 +1250,8 @@ module Kettle
         end
 
         if owner && repo
+          add_missing_tag_link_refs!(lines, owner, repo, except: new_version)
+
           # Add compare link for the new version
           from = prev_version ? "v#{prev_version}" : detect_initial_compare_base(lines)
           new_compare = "[#{new_version}]: https://github.com/#{owner}/#{repo}/compare/#{from}...v#{new_version}\n"
@@ -1251,7 +1266,7 @@ module Kettle
         end
 
         # Rebuild and sort the reference block so Unreleased is first, then newest to oldest versions, preserving everything above first_ref
-        ref_lines = lines[first_ref..-1].select { |l| /^\[[^\]]+\]:\s+http/.match?(l) }
+        ref_lines = lines[first_ref..].select { |l| /^\[[^\]]+\]:\s+http/.match?(l) }
         # Deduplicate by key (text inside the square brackets)
         by_key = {}
         ref_lines.each do |l|
@@ -1291,6 +1306,35 @@ module Kettle
         rebuilt.join
       end
 
+      # Historical sections can contain the canonical TAG row while lacking the
+      # matching Markdown reference definition. Reconcile those records rather
+      # than limiting reference generation to the release currently being
+      # prepared.
+      def add_missing_tag_link_refs!(lines, owner, repo, except: nil)
+        tag_versions = lines.filter_map do |line|
+          line.match(TAG_REFERENCE_USAGE_RE)&.[](1)
+        end.uniq
+
+        tag_versions.each do |version|
+          next if version == except
+          next if lines.any? { |line| line.start_with?("[#{version}t]:") }
+          unless local_release_tag?(version)
+            warn("kettle-changelog: local git tag v#{version} is absent; leaving its TAG reference unresolved")
+            next
+          end
+
+          lines << "[#{version}t]: https://github.com/#{owner}/#{repo}/releases/tag/v#{version}\n"
+        end
+      end
+
+      def local_release_tag?(version)
+        @local_release_tags ||= begin
+          output, status = Open3.capture2e("git", "tag", "--list", "v*", chdir: @root)
+          status.success? ? output.lines.map(&:strip) : []
+        end
+        @local_release_tags.include?("v#{version}")
+      end
+
       # Ensure every Markdown atx-style heading line (e.g., "# ", "## ") has exactly one blank line
       # before and after it, skipping content inside fenced code blocks.
       def normalize_heading_spacing(text)
@@ -1335,7 +1379,7 @@ module Kettle
         idx = lines.index { |l| l.start_with?(UNRELEASED_SECTION_HEADING) }
         return text unless idx
         head = lines[0...idx]
-        tail = lines[idx..-1]
+        tail = lines[idx..]
         # Ensure exactly one blank line between body and refs
         if head.any? && head.last.to_s.strip != ""
           head << ""

data/lib/kettle/changelog/keyed_entry_upserter.rb

@@ -5,6 +5,67 @@ module Kettle
     class KeyedEntryUpserter
       SECTIONS = %w[Added Changed Deprecated Removed Fixed Security].freeze
       KEY_PREFIX = "[kc]"
+      PROJECT_FILE_UPDATE_FIRST_LINE = /\A[-*]\s+\[kc\]\s+([^\s:]+):\s+updated\s+\d+\s+project\s+files?:\s*\z/
+      PROJECT_FILE_UPDATE_CATEGORY_LINE = /\A\s{2,}[-*]\s+(.+?)\s+\((\d+)\)\s*\z/
+
+      class << self
+        # Consolidates repeated maintenance summaries after a prepared release
+        # is updated in place. The AST supplies list-item boundaries; the two
+        # regular expressions only parse the stable text payload inside those
+        # already-classified Markdown items.
+        def collapse_project_file_updates(source)
+          require "ast/crispr/markdown/markly"
+          context = Ast::Crispr::Markdown::Markly.document_context(content: source.to_s, source_label: "CHANGELOG.md")
+          updates = context.structural_owners(owner_scope: :list_items)
+            .select { |item| item.depth == 1 }
+            .filter_map { |item| project_file_update_record(item) }
+          duplicate_groups = updates.group_by { |update| update.fetch(:key) }.values.select { |group| group.length > 1 }
+          return source.to_s if duplicate_groups.empty?
+
+          lines = source.to_s.lines
+          duplicate_groups.flatten.sort_by { |update| update.fetch(:start_line) }.reverse_each do |update|
+            group = duplicate_groups.find { |candidate| candidate.include?(update) }
+            first = group.min_by { |candidate| candidate.fetch(:start_line) }
+            replacement = (update == first) ? project_file_update_entry(group).lines : []
+            lines[(update.fetch(:start_line) - 1)...update.fetch(:end_line)] = replacement
+          end
+          lines.join
+        end
+
+        private
+
+        def project_file_update_record(item)
+          lines = item.source.to_s.lines
+          key_match = PROJECT_FILE_UPDATE_FIRST_LINE.match(lines.shift.to_s.strip)
+          return unless key_match
+
+          counts = lines.filter_map do |line|
+            match = PROJECT_FILE_UPDATE_CATEGORY_LINE.match(line)
+            next unless match
+
+            [match[1].tr(" ", "_").to_sym, match[2].to_i]
+          end.to_h
+          return if counts.empty?
+
+          {
+            key: key_match[1],
+            counts: counts,
+            start_line: item.location.start_line,
+            end_line: item.location.end_line
+          }
+        end
+
+        def project_file_update_entry(entries)
+          counts = entries.each_with_object(Hash.new(0)) do |entry, totals|
+            entry.fetch(:counts).each { |category, count| totals[category] += count }
+          end
+          total = counts.values.sum
+          details = counts.sort_by { |category, _count| category.to_s }.map do |category, count|
+            "  - #{category.to_s.tr("_", " ")} (#{count})"
+          end
+          ["- #{KEY_PREFIX} #{entries.first.fetch(:key)}: updated #{total} project file#{"s" unless total == 1}:", *details, ""].join("\n")
+        end
+      end
 
       def initialize(section:, key:, entry:, legacy_prefixes: [], root: Kettle::Dev::CIHelpers.project_root)
         @root = root

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.4"
+      VERSION = "1.0.6"
     end
     # Current gem version exposed at the traditional constant location.
     VERSION = Version::VERSION # Traditional Constant Location

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kettle-changelog
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Peter H. Boling
@@ -63,7 +63,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.14
+        version: 3.0.17
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
@@ -73,7 +73,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.14
+        version: 3.0.17
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
@@ -304,10 +304,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.4
-  changelog_uri: https://github.com/kettle-dev/kettle-changelog/blob/v1.0.4/CHANGELOG.md
+  source_code_uri: https://github.com/kettle-dev/kettle-changelog/tree/v1.0.6
+  changelog_uri: https://github.com/kettle-dev/kettle-changelog/blob/v1.0.6/CHANGELOG.md
   bug_tracker_uri: https://github.com/kettle-dev/kettle-changelog/issues
-  documentation_uri: https://www.rubydoc.info/gems/kettle-changelog/1.0.4
+  documentation_uri: https://www.rubydoc.info/gems/kettle-changelog/1.0.6
   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