canon 0.2.9 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a13457a67f3e2ab91e00cec19684c502605ab807bdd87eb1120e77d190a99c2e
-  data.tar.gz: 35c0c873340e12c63048adf2222fda2f8c2ae3972337dcc212b26d391191ac35
+  metadata.gz: 48895efa0afcaaa525d8dcb9b04c1eb5969aeacd96c2e9b1f575383109229ce8
+  data.tar.gz: 12baa3b412f857b7b6038149f8344f2aa295d8b29e96ed2a0401e64010df5478
 SHA512:
-  metadata.gz: 8db915564eebd4ca4dfadd65358f721aa70bca318c22dc1c02eff5e3527cf646ea19722b760072851f358b3fabefd12fc5f6dfc216bce146423c7091f3bf7eac
-  data.tar.gz: f92e7491d781c8762483335558ede985a1653bcfb88613858115aa87e50bb326f95b0b76b845c54154e657fb9f25b3d1f348bf8e9baa926ea1c6bfbbd77d6ca6
+  metadata.gz: 9d9e2d1bfce446d850e1c991e161991a5112bdccdcb3d57d28170ba9d3180bcd0897aba7c78c7c2e6fe3ec3f5d5ba0e295c9c80627fd0d3c9e2a8bfef1434125
+  data.tar.gz: ec91e939f8d39f21e9c93fcfea178241eb601c6e5f66e9956468bfef0bf480ba05d587b705d108f39de661e184d7aaae3e0b79cf4c907a2d0c98b062d4564ec5

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-05-24 10:34:05 UTC using RuboCop version 1.86.0.
+# on 2026-06-15 09:49:31 UTC using RuboCop version 1.87.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,14 +11,14 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'canon.gemspec'
 
-# Offense count: 1358
+# Offense count: 1272
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
 Layout/LineLength:
   Enabled: false
 
-# Offense count: 58
+# Offense count: 57
 # Configuration parameters: IgnoreLiteralBranches, IgnoreConstantBranches, IgnoreDuplicateElseBranch.
 Lint/DuplicateBranch:
   Enabled: false
@@ -62,7 +62,7 @@ Lint/UselessConstantScoping:
   Exclude:
     - 'lib/canon/diff_formatter/theme.rb'
 
-# Offense count: 313
+# Offense count: 298
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Enabled: false
@@ -78,12 +78,12 @@ Metrics/BlockLength:
 Metrics/BlockNesting:
   Max: 4
 
-# Offense count: 276
+# Offense count: 261
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Enabled: false
 
-# Offense count: 523
+# Offense count: 501
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 146
@@ -93,12 +93,12 @@ Metrics/MethodLength:
 Metrics/ParameterLists:
   Max: 10
 
-# Offense count: 214
+# Offense count: 207
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Enabled: false
 
-# Offense count: 30
+# Offense count: 28
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
 # AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
 Naming/MethodParameterName:
@@ -107,15 +107,13 @@ Naming/MethodParameterName:
     - 'lib/canon/comparison/xml_comparator/attribute_comparator.rb'
     - 'lib/canon/xml/namespace_handler.rb'
 
-# Offense count: 6
-# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
-# SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: TLS1_1, TLS1_2, capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
-Naming/VariableNumber:
+# Offense count: 1
+# Configuration parameters: Mode, AllowedMethods, AllowedPatterns, AllowBangMethods, WaywardPredicates.
+# AllowedMethods: call
+# WaywardPredicates: infinite?, nonzero?
+Naming/PredicateMethod:
   Exclude:
-    - 'lib/canon/comparison/json_comparator.rb'
-    - 'lib/canon/comparison/markup_comparator.rb'
-    - 'lib/canon/comparison/xml_comparator/diff_node_builder.rb'
+    - 'spec/canon/comparison/xml_attribute_diff_spec.rb'
 
 # Offense count: 4
 # Configuration parameters: MinSize.
@@ -126,13 +124,13 @@ Performance/CollectionLiteralInLoop:
     - 'lib/canon/xml/xml_base_handler.rb'
     - 'spec/canon/diff/diff_node_mapper_comments_spec.rb'
 
-# Offense count: 107
+# Offense count: 111
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
 RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 47
+# Offense count: 48
 # Configuration parameters: IgnoredMetadata.
 RSpec/DescribeClass:
   Enabled: false
@@ -143,7 +141,7 @@ RSpec/DescribeMethod:
     - 'spec/canon/comparison/multiple_differences_spec.rb'
     - 'spec/canon/diff_formatter/character_map_customization_spec.rb'
 
-# Offense count: 874
+# Offense count: 916
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 44
@@ -195,7 +193,7 @@ RSpec/MultipleDescribes:
   Exclude:
     - 'spec/canon/comparison/match_options_spec.rb'
 
-# Offense count: 736
+# Offense count: 783
 RSpec/MultipleExpectations:
   Max: 15
 
@@ -248,7 +246,7 @@ RSpec/SpecFilePathFormat:
     - 'spec/canon/yaml/formatter_spec.rb'
     - 'spec/xml_c14n_spec.rb'
 
-# Offense count: 72
+# Offense count: 18
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:
   Exclude:
@@ -274,12 +272,13 @@ Style/HashLikeCase:
     - 'lib/canon/diff/diff_block_builder.rb'
     - 'lib/canon/xml/character_encoder.rb'
 
-# Offense count: 4
+# Offense count: 6
 # This cop supports unsafe autocorrection (--autocorrect-all).
 Style/IdenticalConditionalBranches:
   Exclude:
     - 'lib/canon/diff_formatter/by_object/base_formatter.rb'
     - 'lib/canon/diff_formatter/legend.rb'
+    - 'lib/canon/xml/whitespace_normalizer.rb'
 
 # Offense count: 1
 # Configuration parameters: AllowedMethods.

data/Rakefile

@@ -7,6 +7,28 @@ RSpec::Core::RakeTask.new(:spec)
 
 begin
   require "opal/rspec/rake_task"
+
+  # Configure Opal load paths at load time (same pattern as moxml)
+  if defined?(Opal)
+    Opal.append_path File.expand_path("lib", __dir__)
+
+    # moxml gem
+    begin
+      moxml_spec = Gem::Specification.find_by_name("moxml")
+      moxml_lib = moxml_spec.full_require_paths.first
+      Opal.append_path moxml_lib
+      moxml_compat = File.expand_path("compat/opal", moxml_lib)
+      Opal.append_path moxml_compat if File.directory?(moxml_compat)
+    rescue Gem::MissingSpecError
+      # moxml not installed
+    end
+
+    # REXML: bundled gem since Ruby 3.4
+    rexml_lib = $LOAD_PATH.find do |p|
+      File.exist?(File.join(p, "rexml", "document.rb"))
+    end
+    Opal.append_path rexml_lib if rexml_lib
+  end
 rescue LoadError
   # Opal not available or incompatible with current Ruby version
 end
@@ -20,9 +42,10 @@ Dir.glob("lib/tasks/**/*.rake").each { |r| load r }
 namespace :spec do
   if defined?(Opal::RSpec::RakeTask)
     desc "Run Opal (JavaScript) tests"
-    Opal::RSpec::RakeTask.new(:opal) do |server, runner|
-      server.append_path "lib"
+    Opal::RSpec::RakeTask.new(:opal) do |_server, runner|
       runner.default_path = "spec"
+      runner.requires = %w[rexml_compat rexml/document rexml/xpath
+                           moxml moxml/adapter/rexml spec_helper]
       runner.pattern = "spec/canon/opal_xml_smoke_spec.rb"
     end
   end

data/lib/canon/cache.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "digest"
+require "digest" unless RUBY_ENGINE == "opal"
 
 module Canon
   # Cache for expensive operations during document comparison
@@ -73,50 +73,41 @@ module Canon
       end
 
       # Generate cache key for document parsing
-      #
-      # @param content [String] Document content
-      # @param format [Symbol] Document format
-      # @param preprocessing [Symbol] Preprocessing option
-      # @return [String] Cache key
       def key_for_document(content, format, preprocessing)
-        digest = Digest::SHA256.hexdigest(content)
-        "doc:#{format}:#{preprocessing}:#{digest[0..16]}"
+        "doc:#{format}:#{preprocessing}:#{content_hash(content)}"
       end
 
       # Generate cache key for format detection
-      #
-      # @param content [String] Document content
-      # @return [String] Cache key
       def key_for_format_detection(content)
-        # Use first 100 chars for quick key, plus length
-        # Force to binary to avoid encoding compatibility issues
         preview = content[0..100].b
-        digest = Digest::SHA256.hexdigest(preview + content.length.to_s)
-        "fmt:#{digest[0..16]}"
+        "fmt:#{content_hash(preview + content.length.to_s)}"
       end
 
       # Generate cache key for XML canonicalization
-      #
-      # @param content [String] XML content
-      # @param with_comments [Boolean] Whether to include comments
-      # @return [String] Cache key
       def key_for_c14n(content, with_comments)
-        digest = Digest::SHA256.hexdigest(content)
-        "c14n:#{with_comments}:#{digest[0..16]}"
+        "c14n:#{with_comments}:#{content_hash(content)}"
       end
 
       # Generate cache key for preprocessing
-      #
-      # @param content [String] Original content
-      # @param preprocessing [Symbol] Preprocessing type
-      # @return [String] Cache key
       def key_for_preprocessing(content, preprocessing)
-        digest = Digest::SHA256.hexdigest(content)
-        "pre:#{preprocessing}:#{digest[0..16]}"
+        "pre:#{preprocessing}:#{content_hash(content)}"
       end
 
       private
 
+      # Generate a hash string for cache keys
+      def content_hash(content)
+        if defined?(Digest::SHA256)
+          Digest::SHA256.hexdigest(content)[0..16]
+        else
+          # Opal fallback: simple string hash
+          h = content.each_char.reduce(0) do |acc, c|
+            ((acc * 31) + c.ord) & 0xFFFFFFFF
+          end
+          h.to_s(16).rjust(8, "0")
+        end
+      end
+
       # Get or create cache for a category
       #
       # @param category [Symbol] Cache category

data/lib/canon/cli.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 require "thor" unless RUBY_ENGINE == "opal"
-require_relative "commands/format_command"
-require_relative "commands/diff_command"
-require_relative "options/registry"
 
 module Canon
   # Command-line interface for Canon

data/lib/canon/commands/diff_command.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../comparison"
-require_relative "../diff_formatter"
-require_relative "../color_detector"
 require "json"
 require "yaml"
 
@@ -66,7 +63,6 @@ module Canon
 
         # Show configuration in verbose mode using shared DebugOutput
         if @options[:verbose]
-          require_relative "../diff_formatter/debug_output"
           config_output = Canon::DiffFormatter::DebugOutput.verbose_tables_only(
             result,
             {
@@ -219,12 +215,10 @@ module Canon
 
         case format
         when :xml
-          require_relative "../pretty_printer/xml"
           formatted1 = Canon::PrettyPrinter::Xml.new(indent: 2).format(content1)
           formatted2 = Canon::PrettyPrinter::Xml.new(indent: 2).format(content2)
           [formatted1, formatted2]
         when :html
-          require_relative "../pretty_printer/html"
           formatted1 = Canon::PrettyPrinter::Html.new(indent: 2).format(content1)
           formatted2 = Canon::PrettyPrinter::Html.new(indent: 2).format(content2)
           [formatted1, formatted2]

data/lib/canon/commands/format_command.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../pretty_printer/xml"
-require_relative "../pretty_printer/json"
-require_relative "../pretty_printer/html"
-
 module Canon
   module Commands
     # Command for canonicalizing files

data/lib/canon/commands.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Canon
+  # Thor command implementations invoked by {CLI}. Children are autoloaded.
+  module Commands
+    autoload :DiffCommand, "canon/commands/diff_command"
+    autoload :FormatCommand, "canon/commands/format_command"
+  end
+end

data/lib/canon/comparison/child_realignment.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "node_inspector"
-
 module Canon
   module Comparison
     # Shared two-cursor walk over child arrays with noise-aware realignment.

data/lib/canon/comparison/compare_profile.rb

@@ -3,7 +3,7 @@
 module Canon
   module Comparison
     # CompareProfile encapsulates the policy decisions about how differences
-    # in various dimensions should be handled during comparison
+    # in various dimensions should be handled during comparison.
     #
     # This class provides separation of concerns:
     # - CompareProfile: Policy decisions (what to track, what affects equivalence)
@@ -17,69 +17,46 @@ module Canon
         @match_options = match_options
       end
 
-      # Should DiffNodes be created for differences in this dimension?
-      #
-      # In verbose mode, we want to track ALL differences for reporting.
-      # In non-verbose mode, we only need to track normative differences.
-      #
-      # @param dimension [Symbol] The match dimension to check
-      # @return [Boolean] true if differences should be tracked
       def track_dimension?(_dimension)
-        # Always track dimensions that affect equivalence
-        # In verbose mode, also track informative dimensions
         true
       end
 
       # Should differences in this dimension affect equivalence?
       #
-      # This determines the return value of the comparison:
-      # - true: differences make documents non-equivalent
-      # - false: differences are informative only
-      #
       # @param dimension [Symbol] The match dimension to check
       # @return [Boolean] true if differences affect equivalence
       def affects_equivalence?(dimension)
         behavior = behavior_for(dimension)
-
-        # :strict → affects equivalence
-        # :normalize → might affect (if normalization fails)
-        # :ignore → does NOT affect equivalence
         behavior != :ignore
       end
 
       # Is a difference in this dimension normative (affects equivalence)?
       #
-      # This is used by DiffClassifier to determine the normative flag.
-      #
-      # Normative rules by dimension:
-      # - structural_whitespace: only :strict is normative (:normalize and :ignore are informative)
-      # - all other dimensions: normative unless behavior is :ignore
+      # Delegates to the Dimension object's normative? rule.  Falls back to
+      # the default rule (normative unless :ignore) for dimensions not in the
+      # format's dimension set (e.g., derived dimensions like :element_structure).
       #
       # @param dimension [Symbol] The match dimension to check
       # @return [Boolean] true if normative, false if informative
       def normative_dimension?(dimension)
-        # Structural whitespace with :normalize or :ignore behavior is INFORMATIVE
-        # Only :strict mode makes whitespace normative
-        if dimension == :structural_whitespace
-          behavior = behavior_for(dimension)
-          return behavior == :strict
+        dim = dimension_for(dimension)
+        if dim
+          dim.normative?(behavior_for(dimension))
+        else
+          behavior_for(dimension) != :ignore
         end
-
-        # For all other dimensions, normative if behavior affects equivalence
-        affects_equivalence?(dimension)
       end
 
       # Can a difference in this dimension be formatting-only?
       #
-      # This determines whether FormattingDetector should be applied.
-      # Only text/content dimensions can have formatting-only differences.
+      # Delegates to the Dimension object's supports_formatting_detection?
+      # flag.  Falls back to false for unknown dimensions.
       #
       # @param dimension [Symbol] The match dimension to check
       # @return [Boolean] true if formatting detection should apply
       def supports_formatting_detection?(dimension)
-        # Only text_content and structural_whitespace can have formatting-only diffs
-        # Comments are policy-based (strict/ignore), not formatting-based
-        %i[text_content structural_whitespace].include?(dimension)
+        dim = dimension_for(dimension)
+        dim ? dim.supports_formatting_detection? : false
       end
 
       # Get the behavior setting for a dimension
@@ -94,6 +71,23 @@ module Canon
           :strict
         end
       end
+
+      private
+
+      def dimension_for(name)
+        set = Dimensions::Registry.for(extract_format)
+        set[name]
+      end
+
+      def extract_format
+        if match_options.is_a?(ResolvedMatchOptions)
+          match_options.format
+        elsif match_options.is_a?(Hash)
+          match_options[:format]
+        else
+          :xml
+        end
+      end
     end
   end
 end

data/lib/canon/comparison/comparison_result.rb

@@ -133,8 +133,6 @@ parse_errors_expected: nil, parse_errors_received: nil)
       # @return [String] Formatted diff output
       def diff(use_color: true, context_lines: 3, diff_grouping_lines: nil,
 show_diffs: :all, diff_mode: :separate, legacy_terminal: false)
-        require_relative "../diff_formatter"
-
         formatter = Canon::DiffFormatter.new(
           use_color: use_color,
           mode: :by_line,