kettle-changelog 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 470b4a1221d494c5197d12fa669c5c2b554cbc71a66c2bc15d4d46a1ccaaef8a
-  data.tar.gz: 59f8f87524474affe14bb3c4a4907268af1ce1205a79679e521bd5e6a225b624
+  metadata.gz: 8737c49a9337bff6a8234bea1914fd8a054ca66a9fe1107b020cc80ef52205d2
+  data.tar.gz: e15afde1f514972d8417785a657c1a0b5c618fd3edca8a4e5be3c4f59aa7ff75
 SHA512:
-  metadata.gz: ea215da6524469a17c0ead84eb652377de8ecd31eac9382b4c8012381d60a62b254b34719a03c02d96eedb6184785c1510d5a246cc3fe3b44b4439edba396cbf
-  data.tar.gz: 17ba27fb850c28d715b553740636a3f6a4db3ea7fd5a0bfa225867d7336c5f26342b8a486f6ff23f857f6da46616f8e8f751b8d29d49d6edf54bbac0e1c78351
+  metadata.gz: 8afab816b2675e3ca97449dd50176be20d4ec15723fa4107ccb98f6a6d0c8779467b823f5f472c569d9b856ba6229217c2e5ca7b5e2d300058453a1d79182197
+  data.tar.gz: fd565677b152771afcc28db39a541c061fe58d026c3dd9f571d97cab4801dd8d7b9365678c7fc8d23f5c5340882cce55c977c69e58ff5c109e1bbb3f85f19e28

data/CHANGELOG.md

@@ -28,10 +28,23 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Fixed
 
-- Preserve family-local dependency wiring during aggregate coverage runs.
-
 ### Security
 
+## [1.0.1] - 2026-08-11
+
+- TAG: [v1.0.1][1.0.1t]
+- COVERAGE: 93.56% -- 944/1009 lines in 5 files
+- BRANCH COVERAGE: 77.39% -- 332/429 branches in 5 files
+- 42.31% documented
+
+### Added
+
+- Expose structural transfer-entry merging for consumers that replay kettle-jem template history without duplicating Markdown traversal.
+
+### Fixed
+
+- Preserve family-local dependency wiring during aggregate coverage runs.
+
 ## [1.0.0] - 2026-08-10
 
 - TAG: [v1.0.0][1.0.0t]
@@ -114,6 +127,8 @@ 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.0...HEAD
+[Unreleased]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.1...HEAD
+[1.0.1]: https://github.com/kettle-dev/kettle-changelog/compare/v1.0.0...v1.0.1
+[1.0.1t]: https://github.com/kettle-dev/kettle-changelog/releases/tag/v1.0.1
 [1.0.0]: https://github.com/kettle-dev/kettle-changelog/compare/v0.1.0...v1.0.0
 [1.0.0t]: https://github.com/kettle-dev/kettle-changelog/releases/tag/v1.0.0

data/README.md

@@ -395,7 +395,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-0.866-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-1.009-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/transfer_merger.rb

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+module Kettle
+  module Changelog
+    class TransferMerger
+      STANDARD_HEADINGS = %w[Added Changed Deprecated Removed Fixed Security].freeze
+
+      def self.apply(content:, entries:, excluded_keys: [])
+        new(content: content, entries: entries, excluded_keys: excluded_keys).run
+      end
+
+      def initialize(content:, entries:, excluded_keys: [])
+        @content = content.to_s
+        @entries = Array(entries).filter_map do |entry|
+          next unless entry.is_a?(Hash)
+
+          key = entry_value(entry, :key).to_s
+          lines = Array(entry_value(entry, :lines))
+          next if key.empty? || lines.empty?
+
+          {
+            key: key,
+            section: entry_value(entry, :section),
+            lines: lines
+          }
+        end
+        @excluded_keys = Array(excluded_keys).map(&:to_s).reject(&:empty?).to_set
+      end
+
+      def run
+        normalized = remove_excluded_entries(@content)
+        existing_keys = transfer_occurrences(normalized).map { |occurrence| occurrence.fetch(:key) }.to_set
+        missing = @entries.reject { |entry| existing_keys.include?(entry.fetch(:key).to_s) }
+        return ensure_trailing_newline(normalized) if missing.empty?
+
+        lines = source_lines(normalized)
+        unreleased = unreleased_line_index(lines)
+        return ensure_trailing_newline(normalized) unless unreleased
+
+        destination_end = unreleased_end_index(lines, unreleased)
+        destination_body = lines[(unreleased + 1)...destination_end] || []
+        items = changelog_items(destination_body)
+        missing.group_by { |entry| entry.fetch(:section, "### Changed") }.each do |section, section_entries|
+          section = STANDARD_HEADINGS.include?(section.to_s.delete_prefix("### ")) ? "### #{section.to_s.delete_prefix("### ").strip}" : "### Changed"
+          items[section] ||= []
+          items[section].pop while items[section].any? && items[section].last.to_s.strip.empty?
+          items[section] << "" if items[section].any?
+          section_entries.each do |entry|
+            items[section].concat(Array(entry.fetch(:lines)).map(&:rstrip))
+          end
+        end
+
+        merged_lines = lines[0...unreleased] +
+          build_unreleased_section(lines.fetch(unreleased), items) +
+          lines[destination_end..].to_a
+        ensure_trailing_newline(merged_lines.join("\n").gsub(/\n{3,}/, "\n\n"))
+      end
+
+      private
+
+      def remove_excluded_entries(content)
+        return content if @excluded_keys.empty?
+
+        lines = source_lines(content)
+        removals = transfer_occurrences(content).filter_map do |occurrence|
+          next unless @excluded_keys.include?(occurrence.fetch(:key).to_s)
+
+          (occurrence.fetch(:start_line)..occurrence.fetch(:end_line))
+        end
+        return content if removals.empty?
+
+        lines.each_with_index.reject do |_line, index|
+          removals.any? { |range| range.cover?(index + 1) }
+        end.map(&:first).join("\n").then { |text| ensure_trailing_newline(text.gsub(/\n{3,}/, "\n\n")) }
+      end
+
+      def transfer_occurrences(content)
+        context = markdown_context(content)
+        release_sections = context.structural_owners(owner_scope: :heading_sections)
+          .select { |owner| owner.level == 2 }
+          .sort_by { |owner| owner.location.start_line }
+        list_items = context.structural_owners(owner_scope: :list_items)
+        list_items.filter_map do |item|
+          next unless item.depth == 1
+
+          key = transfer_key(item.source)
+          next unless key
+
+          release = release_section_for(release_sections, item)
+          next unless release
+
+          {
+            key: key,
+            release_heading: "## #{release.heading_text}",
+            start_line: item.location.start_line,
+            end_line: item.location.end_line
+          }
+        end
+      end
+
+      def transfer_key(source)
+        source.to_s.lines.first.to_s.strip[/\A[-*] +((?:kettle-jem-template)-\d{8}-\d{3})\b/, 1]
+      end
+
+      def release_section_for(sections, item)
+        sections.each_with_index.find do |section, index|
+          next_section = sections[index + 1]
+          section_end_line = next_section ? next_section.location.start_line - 1 : section.location.end_line
+          item.location.start_line > section.location.start_line && item.location.end_line <= section_end_line
+        end&.first
+      end
+
+      def changelog_items(body_lines)
+        items = {}
+        heading = nil
+        index = 0
+        while index < body_lines.length
+          line = body_lines.fetch(index)
+          if line.start_with?("### ")
+            heading = line.strip
+            items[heading] ||= []
+            index += 1
+            next
+          end
+
+          if bullet_line?(line)
+            collected, index = collect_list_item(body_lines, index)
+            items[heading] ||= []
+            items[heading].concat(collected)
+            next
+          end
+
+          index += 1
+        end
+        items
+      end
+
+      def build_unreleased_section(heading, items)
+        lines = [heading]
+        STANDARD_HEADINGS.each do |standard_heading|
+          heading_line = "### #{standard_heading}"
+          lines << ""
+          lines << heading_line
+          lines << ""
+          section_items = items[heading_line].to_a.dup
+          section_items.pop while section_items.any? && section_items.last.to_s.strip.empty?
+          lines.concat(section_items) if section_items.any?
+        end
+        lines << ""
+      end
+
+      def source_lines(content)
+        content.to_s.split("\n")
+      end
+
+      def unreleased_line_index(lines)
+        lines.index { |line| line.to_s.strip == "## [Unreleased]" }
+      end
+
+      def unreleased_end_index(lines, unreleased_index)
+        index = unreleased_index + 1
+        while index < lines.length
+          line = lines.fetch(index)
+          return index if link_reference_line?(line)
+          return index if line.start_with?("# ") || (line.start_with?("## ") && line.to_s.strip != "## [Unreleased]")
+
+          index += 1
+        end
+        lines.length
+      end
+
+      def link_reference_line?(line)
+        line.to_s.lstrip.start_with?("[") && line.to_s.include?("]:")
+      end
+
+      def entry_value(entry, key)
+        entry[key] || entry[key.to_s]
+      end
+
+      def bullet_line?(line)
+        line.to_s.lstrip.start_with?("- ", "* ")
+      end
+
+      def collect_list_item(lines, start_index)
+        line = lines.fetch(start_index).to_s
+        base_indent = line.length - line.lstrip.length
+        item_lines = [line.rstrip]
+        index = start_index + 1
+        in_fence = false
+        while index < lines.length
+          current = lines.fetch(index).to_s
+          current_indent = current.length - current.lstrip.length
+          break if !in_fence && heading_line?(current)
+          break if !in_fence && bullet_line?(current) && current_indent <= base_indent
+
+          if current.lstrip.start_with?("```")
+            in_fence = !in_fence
+            item_lines << current.rstrip
+            index += 1
+            next
+          end
+
+          break unless in_fence || current.strip.empty? || current_indent > base_indent
+
+          item_lines << current.rstrip
+          index += 1
+        end
+        [item_lines, index]
+      end
+
+      def heading_line?(line)
+        line.to_s.lstrip.start_with?("#")
+      end
+
+      def markdown_context(content)
+        require "ast/crispr/markdown/markly"
+        Ast::Crispr::Markdown::Markly.document_context(content: content, source_label: "CHANGELOG.md")
+      rescue LoadError => error
+        raise Error, "kettle-changelog transfer merging requires ast-crispr-markdown-markly (#{error.message})"
+      end
+
+      def ensure_trailing_newline(content)
+        "#{content.to_s.rstrip}\n"
+      end
+    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.0"
+      VERSION = "1.0.1"
     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 :TransferMerger, "kettle/changelog/transfer_merger"
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kettle-changelog
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Peter H. Boling
@@ -295,6 +295,7 @@ files:
 - lib/kettle/changelog.rb
 - lib/kettle/changelog/cli.rb
 - lib/kettle/changelog/entry_adder.rb
+- lib/kettle/changelog/transfer_merger.rb
 - lib/kettle/changelog/version.rb
 - sig/kettle/changelog.rbs
 homepage: https://github.com/kettle-dev/kettle-changelog
@@ -302,10 +303,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.0
-  changelog_uri: https://github.com/kettle-dev/kettle-changelog/blob/v1.0.0/CHANGELOG.md
+  source_code_uri: https://github.com/kettle-dev/kettle-changelog/tree/v1.0.1
+  changelog_uri: https://github.com/kettle-dev/kettle-changelog/blob/v1.0.1/CHANGELOG.md
   bug_tracker_uri: https://github.com/kettle-dev/kettle-changelog/issues
-  documentation_uri: https://www.rubydoc.info/gems/kettle-changelog/1.0.0
+  documentation_uri: https://www.rubydoc.info/gems/kettle-changelog/1.0.1
   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