prism-merge 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e450acf315100305aa2d3b2c0d76989d937c82a85b2b7643afa97ae198ea4b2a
-  data.tar.gz: '09e455e508c6d91722e8c73d04c7086dad434f95e8fc6a1447a5c094ecc307ef'
+  metadata.gz: edeb460ce4645e2e6a8caf390cca9b23abeb88df9b3c314f6f86b42bc4ed68f5
+  data.tar.gz: 2f2fb56d28d1d8ddb2563b8b312186f06bd96b26bdf89753e1382724faac9332
 SHA512:
-  metadata.gz: 9ee4b24c5967da3e42de67f344aa4abeeb62b7f255bf05a33fb0194c3932628e95755c2dd0cb68d74b2d8ad2a19ba7fc88dd2b6e5614088dcfd5eb93aee64d13
-  data.tar.gz: 1c7a7c6e0ba69a2435f153e3f60252b7e65a332b163406bac663f95385680be2d885814f8d7564d3fb3b60dc859f91bbcbba8f1a0108037cc892f7dd189e87cd
+  metadata.gz: 1a5fa5900b24ba063df2de14c8772fda7b4dcebacfd2529dc41b465550b2baad3f8b8597d2c9759eac69b4025218843c35a41c14273c4ce69da294469b09b166
+  data.tar.gz: ac7e0ba8364617dcc2e9c67955b7c5cf303028c54cfaee272eb86a4f26378bd7c0eeed585db714b851bdbd42aae710b24a1fe9a6d629d880d0e26482e222cd9d

data/CHANGELOG.md

@@ -30,6 +30,37 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [1.1.0] - 2025-12-04
+
+- TAG: [v1.1.0][1.1.0t]
+- COVERAGE: 95.65% -- 770/805 lines in 9 files
+- BRANCH COVERAGE: 81.13% -- 245/302 branches in 9 files
+- 100.00% documented
+
+### Added
+
+- Recursive merge support for class and module bodies - nested structures are now merged intelligently
+- Conditional signature matching for `if`/`unless` blocks based on condition expression
+- Freeze block validation for partial/incomplete nodes and freeze blocks inside non-class/module contexts
+- Freeze blocks now match by position/order when both files have multiple freeze blocks
+- `add_template_only_nodes` option now properly respected in recursive merges and boundary processing
+- `DebugLogger`, controlled by `ENV["PRISM_MERGE_DEBUG"]` set to true or false
+- more specs
+
+### Changed
+
+- Migrated to Prism v1.6.0 native comment attachment (removed custom comment association logic)
+- Simplified FileAnalysis implementation using Prism's built-in features
+- Improved node lookup to handle anchors with leading comments (e.g., magic comments)
+
+### Fixed
+
+- Template-only nodes are now correctly excluded in all contexts when `add_template_only_nodes: false`
+- Freeze blocks inside methods now properly raise InvalidStructureError (only class/module-level freeze blocks allowed)
+- Freeze block matching now works correctly with multiple consecutive freeze blocks (matches by index/order)
+- Duplicate freeze blocks from template no longer appear when destination has matching freeze blocks
+- Magic comments at file top no longer prevent node lookup in recursive merges
+
 ## [1.0.3] - 2025-12-03
 
 - TAG: [v1.0.3][1.0.3t]
@@ -85,7 +116,9 @@ Please file a bug if you notice a violation of semantic versioning.
 
 - Initial release
 
-[Unreleased]: https://github.com/kettle-rb/prism-merge/compare/v1.0.3...HEAD
+[Unreleased]: https://github.com/kettle-rb/prism-merge/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/kettle-rb/prism-merge/compare/v1.0.3...v1.1.0
+[1.1.0t]: https://github.com/kettle-rb/prism-merge/releases/tag/v1.1.0
 [1.0.3]: https://github.com/kettle-rb/prism-merge/compare/v1.0.2...v1.0.3
 [1.0.3t]: https://github.com/kettle-rb/prism-merge/releases/tag/v1.0.3
 [1.0.2]: https://github.com/kettle-rb/prism-merge/compare/v1.0.1...v1.0.2

data/README.md

@@ -60,6 +60,7 @@ Prism::Merge is a standalone Ruby module that intelligently merges two versions
 
 - **AST-Aware**: Uses Prism parser to understand Ruby structure
 - **Intelligent**: Matches nodes by structural signatures
+- **Recursive Merge**: Automatically merges class and module bodies recursively, intelligently combining nested methods and constants
 - **Comment-Preserving**: Comments are properly attached to relevant nodes and/or placement
 - **Freeze Block Support**: Respects `kettle-dev:freeze` markers for template merge control
 - **Full Provenance**: Tracks origin of every line
@@ -972,7 +973,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.642-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.805-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
 [🔐security]: 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/prism/merge/conflict_resolver.rb

@@ -91,7 +91,10 @@ module Prism
         end
 
         if dest_content[:lines].empty?
-          add_content_to_result(template_content, result, :template, MergeResult::DECISION_KEPT_TEMPLATE)
+          # Only add template-only content if the flag allows it
+          if @add_template_only_nodes
+            add_content_to_result(template_content, result, :template, MergeResult::DECISION_KEPT_TEMPLATE)
+          end
           return
         end
 
@@ -143,8 +146,8 @@ module Prism
       end
 
       def merge_boundary_content(template_content, dest_content, _boundary, result)
-        # Strategy: Process template content in order, replacing matched nodes with template version
-        # and appending dest-only nodes at the end
+        # Strategy: Process nodes in order using signature matching.
+        # FreezeNodes from destination are always preferred to preserve customizations.
 
         template_nodes = template_content[:nodes]
         dest_nodes = dest_content[:nodes]
@@ -152,25 +155,34 @@ module Prism
         # Track which dest nodes have been matched
         matched_dest_indices = Set.new
 
-        # Handle freeze blocks first
-        if dest_content[:has_freeze_block]
-          line_in_freeze = dest_content[:line_range].find { |ln| @dest_analysis.in_freeze_block?(ln) }
-          if line_in_freeze
-            freeze_block = @dest_analysis.freeze_block_at(line_in_freeze)
-            freeze_content = extract_boundary_content(@dest_analysis, freeze_block[:line_range])
-            add_content_to_result(freeze_content, result, :destination, MergeResult::DECISION_FREEZE_BLOCK)
-
-            # Mark all nodes within the freeze block as matched
-            dest_nodes.each do |d_node_info|
-              if freeze_block[:line_range].cover?(d_node_info[:line_range].begin)
-                matched_dest_indices << d_node_info[:index]
+        # Check if there are any FreezeNodes in destination - they always win
+        dest_freeze_nodes = dest_nodes.select { |n| n[:node].is_a?(FreezeNode) }
+
+        if dest_freeze_nodes.any?
+          # Add all destination freeze blocks as-is
+          dest_freeze_nodes.each do |freeze_node_info|
+            result.add_node(
+              freeze_node_info,
+              decision: MergeResult::DECISION_FREEZE_BLOCK,
+              source: :destination,
+              source_analysis: @dest_analysis,
+            )
+            matched_dest_indices << freeze_node_info[:index]
+
+            # Mark any template nodes within this freeze block range as processed
+            freeze_range = freeze_node_info[:line_range]
+            template_nodes.each do |t_node_info|
+              if freeze_range.cover?(t_node_info[:line_range].begin) &&
+                  freeze_range.cover?(t_node_info[:line_range].end)
+                # Template node is inside freeze block, skip it
+                # (we'll handle this by checking if it overlaps with a freeze block)
               end
             end
           end
         end
 
-        # Build signature map for destination nodes
-        dest_sig_map = build_signature_map(dest_nodes)
+        # Build signature map for destination nodes (excluding already-matched freeze nodes)
+        dest_sig_map = build_signature_map(dest_nodes.reject { |n| matched_dest_indices.include?(n[:index]) })
 
         # Build a set of line numbers that are covered by leading comments of nodes
         # so we don't duplicate them when processing non-node lines
@@ -188,7 +200,6 @@ module Prism
         current_line = template_line_range.begin
         # Track if we're in a sequence of template-only nodes
         in_template_only_sequence = false
-        last_added_line = nil
 
         sorted_nodes = template_nodes.sort_by { |n| n[:line_range].begin }
 
@@ -196,6 +207,18 @@ module Prism
           node_start = t_node_info[:line_range].begin
           node_end = t_node_info[:line_range].end
 
+          # Skip template nodes that overlap with destination freeze blocks
+          overlaps_freeze = dest_freeze_nodes.any? do |freeze_info|
+            freeze_range = freeze_info[:line_range]
+            node_start.between?(freeze_range.begin, freeze_range.end) ||
+              node_end.between?(freeze_range.begin, freeze_range.end)
+          end
+
+          if overlaps_freeze
+            current_line = node_end + 1
+            next
+          end
+
           # Check if this node will be matched or is template-only
           sig = t_node_info[:signature]
           is_matched = dest_sig_map[sig]&.any?
@@ -213,11 +236,9 @@ module Prism
             trailing_blank_end = line_num
           end
 
-          node_start..trailing_blank_end
-
           # Add any non-node, non-blank lines before this node (e.g., comments not attached to nodes)
-          if in_template_only_sequence && !is_matched
-            # Skip lines before template-only nodes in a sequence
+          if (in_template_only_sequence && !is_matched) || (!is_matched && !@add_template_only_nodes)
+            # Skip lines before template-only nodes in a sequence OR when add_template_only_nodes is false
             current_line = node_start
           else
             while current_line < node_start
@@ -296,7 +317,6 @@ module Prism
             end
 
             in_template_only_sequence = false
-            last_added_line = trailing_blank_end
           elsif @add_template_only_nodes
             # No match - this is a template-only node
             result.add_node(
@@ -313,7 +333,6 @@ module Prism
             end
 
             in_template_only_sequence = false
-            last_added_line = trailing_blank_end
           # Add the template-only node
           else
             # Skip template-only nodes (don't add template nodes that don't exist in destination)
@@ -422,12 +441,25 @@ module Prism
       end
 
       def handle_orphan_lines(template_content, dest_content, result)
+        # With CommentNodes integrated into statements, there should be far fewer orphan lines
+        # Orphan lines are now only truly standalone content like blank lines or
+        # inline content not attached to nodes.
+
         # Find lines that aren't part of any node (pure comments, blank lines)
         template_orphans = find_orphan_lines(@template_analysis, template_content[:line_range], template_content[:nodes])
         dest_orphans = find_orphan_lines(@dest_analysis, dest_content[:line_range], dest_content[:nodes])
 
-        # For simplicity, prefer template orphans but add unique dest orphans
-        # This could be enhanced with more sophisticated comment merging
+        # Add template orphans first
+        template_orphans.each do |line_num|
+          line = @template_analysis.line_at(line_num)
+          result.add_line(
+            line.chomp,
+            decision: MergeResult::DECISION_KEPT_TEMPLATE,
+            template_line: line_num,
+          )
+        end
+
+        # Then add unique destination orphans (ones not in template)
         template_orphan_content = Set.new(template_orphans.map { |ln| @template_analysis.normalized_line(ln) })
 
         dest_orphans.each do |line_num|

data/lib/prism/merge/debug_logger.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Prism
+  module Merge
+    # Internal debug logging utility.
+    # Only logs when PRISM_MERGE_DEBUG environment variable is set.
+    # Optionally uses Ruby's Logger if available, otherwise falls back to simple puts.
+    # rubocop:disable ThreadSafety/ClassInstanceVariable
+    module DebugLogger
+      @logger = nil
+      @enabled = ENV.fetch("PRISM_MERGE_DEBUG", "false").casecmp?("true")
+
+      class << self
+        attr_reader :enabled
+
+        # Log a debug message if debugging is enabled
+        # @param message [String] The message to log
+        # @param context [Hash] Optional context information
+        def debug(message, context = {})
+          return unless @enabled
+
+          if logger_available?
+            ensure_logger
+            context_str = context.empty? ? "" : " #{context.inspect}"
+            @logger.debug("[prism-merge] #{message}#{context_str}")
+          else
+            context_str = context.empty? ? "" : " | #{context.inspect}"
+            puts "[DEBUG][prism-merge] #{message}#{context_str}"
+          end
+        end
+
+        private
+
+        # Check if Logger is available without raising an error
+        def logger_available?
+          defined?(Logger)
+        end
+
+        # Initialize logger if not already done
+        def ensure_logger
+          return if @logger
+
+          require "logger"
+          @logger = Logger.new($stdout)
+          @logger.level = Logger::DEBUG
+        rescue LoadError
+          # Logger not available, will fall back to puts
+          nil
+        end
+      end
+    end
+    # rubocop:enable ThreadSafety/ClassInstanceVariable
+  end
+end

data/lib/prism/merge/file_aligner.rb

@@ -283,20 +283,21 @@ module Prism
 
       def add_freeze_block_anchors
         # Freeze blocks in destination should always be preserved as anchors
-        @dest_analysis.freeze_blocks.each do |block|
-          line_range = block[:line_range]
+        # Match freeze blocks by their index/order in the file
+        @dest_analysis.freeze_blocks.each_with_index do |freeze_node, index|
+          line_range = freeze_node.start_line..freeze_node.end_line
 
-          # Check if there's a corresponding freeze block in template
-          template_block = @template_analysis.freeze_blocks.find do |tb|
-            tb[:start_marker] == block[:start_marker]
-          end
+          # Check if there's a corresponding freeze block in template at the same index
+          template_freeze = @template_analysis.freeze_blocks[index]
+
+          if template_freeze
+            template_range = template_freeze.start_line..template_freeze.end_line
 
-          if template_block
             # Check if there's already an anchor covering this range
             # (from exact line matches)
             existing_anchor = @anchors.find do |a|
-              a.template_start <= template_block[:line_range].begin &&
-                a.template_end >= template_block[:line_range].end &&
+              a.template_start <= template_range.begin &&
+                a.template_end >= template_range.end &&
                 a.dest_start <= line_range.begin &&
                 a.dest_end >= line_range.end
             end
@@ -305,8 +306,8 @@ module Prism
             unless existing_anchor
               # Both files have this freeze block - create anchor
               @anchors << Anchor.new(
-                template_block[:line_range].begin,
-                template_block[:line_range].end,
+                template_range.begin,
+                template_range.end,
                 line_range.begin,
                 line_range.end,
                 :freeze_block,