canon 0.2.11 → 0.2.12

data/lib/canon/diff/diff_node_mapper.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "diff_line"
 require "set"
 
 module Canon
@@ -159,8 +158,6 @@ module Canon
       # @param diff_lines [Array<DiffLine>] The diff lines to update
       # @param lcs_diffs [Array<Diff::LCS::Change>] The LCS changes
       def apply_block_formatting!(diff_lines, lcs_diffs)
-        require_relative "formatting_detector"
-
         blocks = group_change_blocks(lcs_diffs)
 
         blocks.each do |block|
@@ -265,7 +262,6 @@ module Canon
       # @param line2 [String] Second line
       # @return [Boolean] true if formatting-only difference
       def formatting_only_line?(line1, line2)
-        require_relative "formatting_detector"
         FormattingDetector.formatting_only?(line1, line2)
       end
 

data/lib/canon/diff/diff_report_builder.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "diff_report"
-require_relative "diff_block_builder"
-require_relative "diff_context_builder"
-
 module Canon
   module Diff
     # Builds a complete DiffReport from DiffLines

data/lib/canon/diff/formatting_detector.rb

@@ -99,7 +99,6 @@ module Canon
       def self.decode_xml_entities(text)
         return text unless text.include?("&")
 
-        require_relative "../tree_diff/core/xml_entity_decoder"
         Canon::TreeDiff::Core::XmlEntityDecoder.decode_xml_entities(text)
       end
 

data/lib/canon/diff/node_serializer.rb

@@ -1,12 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../xml/data_model"
-require_relative "../xml/nodes/text_node"
-require_relative "../xml/nodes/comment_node"
-require_relative "../xml/nodes/element_node"
-require_relative "../xml/nodes/processing_instruction_node"
-require_relative "../xml/nodes/root_node"
-
 module Canon
   module Diff
     # Serializes nodes from different parsing libraries into canonical strings

data/lib/canon/diff.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Canon
+  # Diff representation and pipeline construction.
+  #
+  # This namespace holds the structural artifacts produced by the diff
+  # pipeline — DiffNode, DiffLine, DiffBlock, DiffContext, DiffReport —
+  # plus the builders that assemble them (DiffNodeMapper, DiffLineBuilder,
+  # DiffBlockBuilder, DiffContextBuilder, DiffReportBuilder) and the
+  # supporting services (PathBuilder, NodeSerializer, DiffClassifier,
+  # FormattingDetector, SourceLocator, TextDecomposer, DiffCharRange,
+  # DiffNodeEnricher, XmlSerializationFormatter).
+  #
+  # All children are autoloaded from this file — never `require_relative`
+  # them from sibling files. Reference the constant and let autoload
+  # resolve it on first use.
+  module Diff
+    autoload :DiffBlock, "canon/diff/diff_block"
+    autoload :DiffBlockBuilder, "canon/diff/diff_block_builder"
+    autoload :DiffCharRange, "canon/diff/diff_char_range"
+    autoload :DiffClassifier, "canon/diff/diff_classifier"
+    autoload :DiffContext, "canon/diff/diff_context"
+    autoload :DiffContextBuilder, "canon/diff/diff_context_builder"
+    autoload :DiffLine, "canon/diff/diff_line"
+    autoload :DiffLineBuilder, "canon/diff/diff_line_builder"
+    autoload :DiffNode, "canon/diff/diff_node"
+    autoload :DiffNodeEnricher, "canon/diff/diff_node_enricher"
+    autoload :DiffNodeMapper, "canon/diff/diff_node_mapper"
+    autoload :DiffReport, "canon/diff/diff_report"
+    autoload :DiffReportBuilder, "canon/diff/diff_report_builder"
+    autoload :FormattingDetector, "canon/diff/formatting_detector"
+    autoload :NodeSerializer, "canon/diff/node_serializer"
+    autoload :PathBuilder, "canon/diff/path_builder"
+    autoload :SourceLocator, "canon/diff/source_locator"
+    autoload :TextDecomposer, "canon/diff/text_decomposer"
+    autoload :XmlSerializationFormatter,
+             "canon/diff/xml_serialization_formatter"
+  end
+end

data/lib/canon/diff_formatter/by_line/base_formatter.rb

@@ -2,8 +2,6 @@
 
 require "diff/lcs" unless RUBY_ENGINE == "opal"
 require "diff/lcs/hunk" unless RUBY_ENGINE == "opal"
-require_relative "../debug_output"
-require_relative "../theme"
 
 module Canon
   class DiffFormatter
@@ -22,10 +20,8 @@ module Canon
         def self.for_format(format, **options)
           case format
           when :xml
-            require_relative "xml_formatter"
             XmlFormatter.new(**options)
           when :html, :html4, :html5
-            require_relative "html_formatter"
             # Determine HTML version from format
             version = case format
                       when :html5 then :html5
@@ -34,13 +30,10 @@ module Canon
                       end
             HtmlFormatter.new(html_version: version, **options)
           when :json
-            require_relative "json_formatter"
             JsonFormatter.new(**options)
           when :yaml
-            require_relative "yaml_formatter"
             YamlFormatter.new(**options)
           else
-            require_relative "simple_formatter"
             SimpleFormatter.new(**options)
           end
         end
@@ -279,7 +272,7 @@ module Canon
 
           differences.select do |diff|
             # Handle both DiffNode objects and legacy Hash format
-            is_normative = if diff.respond_to?(:normative?)
+            is_normative = if diff.is_a?(Canon::Diff::DiffNode)
                              diff.normative?
                            elsif diff.is_a?(Hash) && diff.key?(:normative)
                              diff[:normative]
@@ -394,8 +387,6 @@ module Canon
         # @param diffs [Array] LCS diff array
         # @return [Array<Canon::Diff::DiffBlock>] Array of diff blocks
         def identify_diff_blocks(diffs)
-          require_relative "../../diff/diff_block"
-
           blocks = []
           current_start = nil
           current_types = []
@@ -467,8 +458,6 @@ module Canon
         # @return [Array<Canon::Diff::DiffContext>] Array of diff contexts
         def expand_contexts_with_context_lines(contexts, context_lines,
                                                 total_lines)
-          require_relative "../../diff/diff_context"
-
           contexts.map do |context|
             first_block = context.first
             last_block = context.last
@@ -736,10 +725,8 @@ module Canon
             next unless match.status == :matched
 
             [match.elem1, match.elem2].compact.each do |elem|
-              next unless elem.respond_to?(:children)
-
               elem.children.each do |child|
-                children.add(child) if child.respond_to?(:name)
+                children.add(child) if Canon::Comparison::NodeInspector.element_node?(child)
               end
             end
           end
@@ -778,8 +765,8 @@ module Canon
           return true if elements_with_semantic_diffs.include?(element)
 
           # Check all descendants
-          if element.respond_to?(:children)
-            element.children.any? do |child|
+          if Canon::Comparison::NodeInspector.element_node?(element)
+            Canon::Comparison::NodeInspector.children(element).any? do |child|
               has_semantic_diff_in_subtree?(child, elements_with_semantic_diffs)
             end
           else

data/lib/canon/diff_formatter/by_line/html_formatter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_formatter"
-require_relative "../legend"
 require "set"
 
 module Canon
@@ -53,11 +51,6 @@ module Canon
             return ""
           end
 
-          require_relative "../../html/data_model"
-          require_relative "../../xml/element_matcher"
-          require_relative "../../xml/line_range_mapper"
-          require_relative "../../pretty_printer/html"
-
           output = []
 
           begin
@@ -107,7 +100,6 @@ module Canon
             end
 
             output << ""
-            require_relative "simple_formatter"
             simple = SimpleFormatter.new(
               use_color: @use_color,
               context_lines: @context_lines,
@@ -122,9 +114,6 @@ module Canon
 
         # Format using new DiffReportBuilder pipeline
         def format_with_pipeline(doc1, doc2)
-          require_relative "../../diff/diff_node_mapper"
-          require_relative "../../diff/diff_report_builder"
-
           # Layer 2: Map DiffNodes to DiffLines
           diff_lines = Canon::Diff::DiffNodeMapper.map(@differences, doc1, doc2)
 
@@ -350,15 +339,14 @@ module Canon
 
           # Second pass: skip children of elements with diffs
           elements_with_diffs.each do |elem|
-            if elem.respond_to?(:parent)
-              current = elem.parent
-              while current
-                if current.respond_to?(:name) && elements_with_diffs.include?(current)
-                  elements_to_skip.add(elem)
-                  break
-                end
-                current = current.respond_to?(:parent) ? current.parent : nil
+            current = Canon::Comparison::NodeInspector.parent(elem)
+            while current
+              if Canon::Comparison::NodeInspector.element_node?(current) &&
+                  elements_with_diffs.include?(current)
+                elements_to_skip.add(elem)
+                break
               end
+              current = Canon::Comparison::NodeInspector.parent(current)
             end
           end
 

data/lib/canon/diff_formatter/by_line/json_formatter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_formatter"
-require_relative "../legend"
 require "strscan"
 
 module Canon
@@ -38,7 +36,6 @@ module Canon
             output << colorize(
               "Warning: JSON parsing failed (#{e.message}), using simple diff", :yellow
             )
-            require_relative "simple_formatter"
             simple = SimpleFormatter.new(
               use_color: @use_color,
               context_lines: @context_lines,

data/lib/canon/diff_formatter/by_line/simple_formatter.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_formatter"
-require_relative "../legend"
-
 module Canon
   class DiffFormatter
     module ByLine

data/lib/canon/diff_formatter/by_line/xml_formatter.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_formatter"
-require_relative "../legend"
-require_relative "../../tree_diff/core/xml_entity_decoder"
 require "set"
 require "strscan"
 
@@ -44,10 +41,6 @@ module Canon
             return ""
           end
 
-          require_relative "../../diff/diff_node_enricher"
-          require_relative "../../diff/diff_line_builder"
-          require_relative "../../diff/diff_report_builder"
-
           # Compute line number width BEFORE formatting
           compute_line_num_width(doc1, doc2)
 
@@ -201,10 +194,6 @@ module Canon
             return ""
           end
 
-          require_relative "../../xml/data_model"
-          require_relative "../../xml/element_matcher"
-          require_relative "../../xml/line_range_mapper"
-
           output = []
 
           begin
@@ -247,7 +236,6 @@ module Canon
             end
 
             output << ""
-            require_relative "simple_formatter"
             simple = SimpleFormatter.new(
               use_color: @use_color,
               context_lines: @context_lines,
@@ -622,15 +610,14 @@ module Canon
 
           # Second pass: skip children of elements with diffs
           elements_with_diffs.each do |elem|
-            if elem.respond_to?(:parent)
-              current = elem.parent
-              while current
-                if current.respond_to?(:name) && elements_with_diffs.include?(current)
-                  elements_to_skip.add(elem)
-                  break
-                end
-                current = current.respond_to?(:parent) ? current.parent : nil
+            current = Canon::Comparison::NodeInspector.parent(elem)
+            while current
+              if Canon::Comparison::NodeInspector.element_node?(current) &&
+                  elements_with_diffs.include?(current)
+                elements_to_skip.add(elem)
+                break
               end
+              current = Canon::Comparison::NodeInspector.parent(current)
             end
           end
 
@@ -721,8 +708,6 @@ module Canon
 
         # Identify contiguous diff blocks
         def identify_diff_blocks(diffs)
-          require_relative "../../diff/diff_block"
-
           blocks = []
           current_start = nil
           current_types = []
@@ -784,8 +769,6 @@ module Canon
         # Expand contexts with context lines
         def expand_contexts_with_context_lines(contexts, context_lines,
                                                 total_lines)
-          require_relative "../../diff/diff_context"
-
           contexts.map do |context|
             first_block = context.first
             last_block = context.last
@@ -803,8 +786,6 @@ module Canon
 
         # Format a context
         def format_context(context, diffs, base_line1, base_line2)
-          require_relative "../../diff/formatting_detector"
-
           # Pre-compute block-level formatting for multi-line changes
           formatting_indices = detect_block_formatting(context, diffs)
 

data/lib/canon/diff_formatter/by_line/yaml_formatter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_formatter"
-require_relative "../legend"
 require "strscan"
 
 module Canon
@@ -37,7 +35,6 @@ module Canon
             output << colorize(
               "Warning: YAML parsing failed (#{e.message}), using simple diff", :yellow
             )
-            require_relative "simple_formatter"
             simple = SimpleFormatter.new(
               use_color: @use_color,
               context_lines: @context_lines,

data/lib/canon/diff_formatter/by_object/base_formatter.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "set"
-require_relative "../theme"
 
 module Canon
   class DiffFormatter
@@ -76,19 +75,16 @@ show_diffs: :all, theme: nil)
 show_diffs: :all, theme: nil)
           case format
           when :xml, :html
-            require_relative "xml_formatter"
             XmlFormatter.new(use_color: use_color,
                              visualization_map: visualization_map,
                              show_diffs: show_diffs,
                              theme: theme)
           when :json
-            require_relative "json_formatter"
             JsonFormatter.new(use_color: use_color,
                               visualization_map: visualization_map,
                               show_diffs: show_diffs,
                               theme: theme)
           when :yaml
-            require_relative "yaml_formatter"
             YamlFormatter.new(use_color: use_color,
                               visualization_map: visualization_map,
                               show_diffs: show_diffs,
@@ -221,23 +217,20 @@ show_diffs: :all, theme: nil)
           current = node
           visited = Set.new
 
-          while current.respond_to?(:name)
-            # Prevent infinite loops by tracking visited nodes
+          while current
             break if visited.include?(current.object_id)
 
             visited << current.object_id
 
-            parts.unshift(current.name) if current.name
+            break if Canon::Comparison::NodeInspector.document?(current) ||
+              Canon::Comparison::NodeInspector.document_fragment?(current)
+
+            name = Canon::Comparison::NodeInspector.name(current)
+            break if name.nil?
 
-            # Stop at document or fragment roots
-            break if current.is_a?(Nokogiri::XML::Document) ||
-              current.is_a?(Nokogiri::HTML4::Document) ||
-              current.is_a?(Nokogiri::HTML5::Document) ||
-              current.is_a?(Nokogiri::XML::DocumentFragment) ||
-              current.is_a?(Nokogiri::HTML4::DocumentFragment) ||
-              current.is_a?(Nokogiri::HTML5::DocumentFragment)
+            parts.unshift(name) unless name.empty?
 
-            current = current.parent if current.respond_to?(:parent)
+            current = Canon::Comparison::NodeInspector.parent(current)
           end
 
           parts.empty? ? diff_node.dimension.to_s : parts.join(".")

data/lib/canon/diff_formatter/by_object/json_formatter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_formatter"
-
 module Canon
   class DiffFormatter
     module ByObject

data/lib/canon/diff_formatter/by_object/xml_formatter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "base_formatter"
-
 module Canon
   class DiffFormatter
     module ByObject

data/lib/canon/diff_formatter/by_object/yaml_formatter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "json_formatter"
-
 module Canon
   class DiffFormatter
     module ByObject

data/lib/canon/diff_formatter/debug_output.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "diff_detail_formatter"
-
 module Canon
   class DiffFormatter
     # Verbose diff output helper for CANON_VERBOSE mode

data/lib/canon/diff_formatter/diff_detail_formatter/dimension_formatter.rb

@@ -53,9 +53,6 @@ expand_difference: false)
         # @param use_color [Boolean] Whether to use colors
         # @return [Array] Tuple of [detail1, detail2, changes]
         def self.format_namespace_uri_details(diff, use_color)
-          require_relative "color_helper"
-          require_relative "node_utils"
-
           node1 = extract_node1(diff)
           node2 = extract_node2(diff)
 
@@ -87,10 +84,6 @@ expand_difference: false)
         # @param use_color [Boolean] Whether to use colors
         # @return [Array] Tuple of [detail1, detail2, changes]
         def self.format_namespace_declarations_details(diff, use_color)
-          require_relative "color_helper"
-          require_relative "node_utils"
-          require_relative "text_utils"
-
           node1 = extract_node1(diff)
           node2 = extract_node2(diff)
 
@@ -174,9 +167,6 @@ expand_difference: false)
         # @param use_color [Boolean] Whether to use colors
         # @return [Array] Tuple of [detail1, detail2, changes]
         def self.format_element_structure_details(diff, use_color)
-          require_relative "color_helper"
-          require_relative "node_utils"
-
           node1 = extract_node1(diff)
           node2 = extract_node2(diff)
 
@@ -236,9 +226,6 @@ expand_difference: false)
         # @param use_color [Boolean] Whether to use colors
         # @return [Array] Tuple of [detail1, detail2, changes]
         def self.format_attribute_presence_details(diff, use_color)
-          require_relative "color_helper"
-          require_relative "node_utils"
-
           node1 = extract_node1(diff)
           node2 = extract_node2(diff)
 
@@ -291,9 +278,6 @@ expand_difference: false)
         # @param use_color [Boolean] Whether to use colors
         # @return [Array] Tuple of [detail1, detail2, changes]
         def self.format_attribute_values_details(diff, use_color)
-          require_relative "color_helper"
-          require_relative "node_utils"
-
           node1 = extract_node1(diff)
           node2 = extract_node2(diff)
 
@@ -330,9 +314,6 @@ expand_difference: false)
         # @param use_color [Boolean] Whether to use colors
         # @return [Array] Tuple of [detail1, detail2, changes]
         def self.format_attribute_order_details(diff, use_color)
-          require_relative "color_helper"
-          require_relative "node_utils"
-
           node1 = extract_node1(diff)
           node2 = extract_node2(diff)
 
@@ -361,10 +342,6 @@ expand_difference: false)
         # @param compact [Boolean] Whether to serialize element nodes as compact XML
         # @return [Array] Tuple of [detail1, detail2, changes]
         def self.format_text_content_details(diff, use_color, compact: false)
-          require_relative "color_helper"
-          require_relative "node_utils"
-          require_relative "text_utils"
-
           node1 = extract_node1(diff)
           node2 = extract_node2(diff)
 
@@ -465,10 +442,6 @@ expand_difference: false)
         # @param use_color [Boolean] Whether to apply ANSI colours
         # @return [Array<String>] Tuple of [detail1, detail2, changes]
         def self.format_text_content_one_sided(node1, node2, use_color)
-          require_relative "color_helper"
-          require_relative "node_utils"
-          require_relative "text_utils"
-
           present = node1 || node2
 
           # Defensive: if a one-sided text-content diff carries an
@@ -515,10 +488,6 @@ expand_difference: false)
         # @param use_color [Boolean] Whether to use colors
         # @return [Array] Tuple of [detail1, detail2, changes]
         def self.format_whitespace_adjacency_details(diff, use_color)
-          require_relative "color_helper"
-          require_relative "node_utils"
-          require_relative "text_utils"
-
           node1 = extract_node1(diff)
           node2 = extract_node2(diff)
 
@@ -568,10 +537,6 @@ expand_difference: false)
         # @param use_color [Boolean] Whether to use colors
         # @return [Array] Tuple of [detail1, detail2, changes]
         def self.format_structural_whitespace_details(diff, use_color)
-          require_relative "color_helper"
-          require_relative "node_utils"
-          require_relative "text_utils"
-
           node1 = extract_node1(diff)
           node2 = extract_node2(diff)
 
@@ -594,9 +559,6 @@ expand_difference: false)
         # @param use_color [Boolean] Whether to use colors
         # @return [Array] Tuple of [detail1, detail2, changes]
         def self.format_comments_details(diff, use_color)
-          require_relative "color_helper"
-          require_relative "node_utils"
-
           node1 = extract_node1(diff)
           node2 = extract_node2(diff)
 
@@ -619,8 +581,6 @@ expand_difference: false)
         # @param use_color [Boolean] Whether to use colors
         # @return [Array] Tuple of [detail1, detail2, changes]
         def self.format_hash_diff_details(diff, use_color)
-          require_relative "color_helper"
-
           detail1 = if diff.is_a?(Hash) && diff[:value1]
                       ColorHelper.colorize(format_json_value(diff[:value1]),
                                            :red, use_color)
@@ -653,9 +613,6 @@ expand_difference: false)
         # @param compact [Boolean] Whether to serialize element nodes as compact XML
         # @return [Array] Tuple of [detail1, detail2, changes]
         def self.format_fallback_details(diff, use_color, compact: false)
-          require_relative "color_helper"
-          require_relative "node_utils"
-
           node1 = extract_node1(diff)
           node2 = extract_node2(diff)
 
@@ -749,8 +706,7 @@ expand_difference: false)
 
           declarations = {}
 
-          # Handle Canon::Xml::Node (uses namespace_nodes)
-          if node.respond_to?(:namespace_nodes)
+          if node.is_a?(Canon::Xml::Node)
             node.namespace_nodes.each do |ns|
               next if ns.prefix == "xml" && ns.uri == "http://www.w3.org/XML/1998/namespace"
 
@@ -760,30 +716,28 @@ expand_difference: false)
             return declarations
           end
 
-          # Handle Nokogiri/Moxml nodes (use attributes)
-          raw_attrs = node.respond_to?(:attribute_nodes) ? node.attribute_nodes : node.attributes
+          # Handle Nokogiri/Moxml nodes (use attribute_nodes or attributes).
+          raw_attrs = if node.is_a?(Nokogiri::XML::Node)
+                        node.attribute_nodes
+                      else
+                        node.attributes
+                      end
 
           if raw_attrs.is_a?(Array)
             raw_attrs.each do |attr|
-              name = attr.respond_to?(:name) ? attr.name : attr.to_s
-              value = attr.respond_to?(:value) ? attr.value : attr.to_s
+              name = attr.is_a?(Nokogiri::XML::Attr) ? attr.name : attr.to_s
+              value = attr.is_a?(Nokogiri::XML::Attr) ? attr.value : attr.to_s
 
               if namespace_declaration?(name)
                 prefix = name == "xmlns" ? "" : name.split(":", 2)[1]
                 declarations[prefix] = value
               end
             end
-          elsif raw_attrs.respond_to?(:each)
+          elsif raw_attrs.is_a?(Hash)
             raw_attrs.each do |key, val|
-              name = if key.is_a?(String)
-                       key
-                     else
-                       (key.respond_to?(:name) ? key.name : key.to_s)
-                     end
-              value = if val.respond_to?(:value)
+              name = hash_key_to_name(key)
+              value = if val.is_a?(Nokogiri::XML::Attr)
                         val.value
-                      elsif val.respond_to?(:content)
-                        val.content
                       else
                         val.to_s
                       end
@@ -805,6 +759,18 @@ expand_difference: false)
         def self.namespace_declaration?(name)
           name == "xmlns" || name.to_s.start_with?("xmlns:")
         end
+
+        # Coerce a hash key (from a backend-supplied attribute hash) into a
+        # plain String attribute name.
+        #
+        # @param key [String, Nokogiri::XML::Attr, Object]
+        # @return [String]
+        def self.hash_key_to_name(key)
+          return key if key.is_a?(String)
+          return key.name if key.is_a?(Nokogiri::XML::Attr)
+
+          key.to_s
+        end
       end
     end
   end

data/lib/canon/diff_formatter/diff_detail_formatter/location_extractor.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../../xml/namespace_helper"
-
 module Canon
   class DiffFormatter
     module DiffDetailFormatterHelpers