RubyGems - canon - Versions diffs - 0.1.6 → 0.1.7 - Mend

canon 0.1.6 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (136) hide show

checksums.yaml +4 -4
data/.rubocop_todo.yml +163 -67
data/README.adoc +400 -7
data/docs/Gemfile +9 -0
data/docs/INDEX.adoc +99 -182
data/docs/_config.yml +100 -0
data/docs/advanced/diff-classification.adoc +547 -0
data/docs/advanced/diff-pipeline.adoc +358 -0
data/docs/advanced/index.adoc +214 -0
data/docs/advanced/semantic-diff-report.adoc +390 -0
data/docs/{VERBOSE.adoc → advanced/verbose-mode-architecture.adoc} +51 -53
data/docs/features/diff-formatting/algorithm-specific-output.adoc +533 -0
data/docs/{CHARACTER_VISUALIZATION.adoc → features/diff-formatting/character-visualization.adoc} +23 -62
data/docs/features/diff-formatting/colors-and-symbols.adoc +606 -0
data/docs/features/diff-formatting/context-and-grouping.adoc +490 -0
data/docs/features/diff-formatting/display-filtering.adoc +472 -0
data/docs/features/diff-formatting/index.adoc +140 -0
data/docs/features/environment-configuration/index.adoc +327 -0
data/docs/features/environment-configuration/override-system.adoc +436 -0
data/docs/features/environment-configuration/size-limits.adoc +273 -0
data/docs/features/index.adoc +173 -0
data/docs/features/input-validation/index.adoc +521 -0
data/docs/features/match-options/algorithm-specific-behavior.adoc +365 -0
data/docs/features/match-options/html-policies.adoc +312 -0
data/docs/features/match-options/index.adoc +621 -0
data/docs/getting-started/index.adoc +83 -0
data/docs/getting-started/quick-start.adoc +76 -0
data/docs/guides/choosing-configuration.adoc +689 -0
data/docs/guides/index.adoc +181 -0
data/docs/{CLI.adoc → interfaces/cli/index.adoc} +18 -13
data/docs/interfaces/index.adoc +101 -0
data/docs/{RSPEC.adoc → interfaces/rspec/index.adoc} +242 -31
data/docs/{RUBY_API.adoc → interfaces/ruby-api/index.adoc} +118 -16
data/docs/lychee.toml +65 -0
data/docs/reference/cli-options.adoc +418 -0
data/docs/reference/environment-variables.adoc +375 -0
data/docs/reference/index.adoc +204 -0
data/docs/reference/options-across-interfaces.adoc +417 -0
data/docs/understanding/algorithms/dom-diff.adoc +389 -0
data/docs/understanding/algorithms/index.adoc +314 -0
data/docs/understanding/algorithms/semantic-tree-diff.adoc +533 -0
data/docs/understanding/architecture.adoc +447 -0
data/docs/understanding/comparison-pipeline.adoc +317 -0
data/docs/understanding/formats/html.adoc +380 -0
data/docs/understanding/formats/index.adoc +261 -0
data/docs/understanding/formats/json.adoc +390 -0
data/docs/understanding/formats/xml.adoc +366 -0
data/docs/understanding/formats/yaml.adoc +504 -0
data/docs/understanding/index.adoc +130 -0
data/lib/canon/cli.rb +42 -1
data/lib/canon/commands/diff_command.rb +108 -23
data/lib/canon/comparison/compare_profile.rb +101 -0
data/lib/canon/comparison/comparison_result.rb +41 -2
data/lib/canon/comparison/html_comparator.rb +292 -71
data/lib/canon/comparison/html_compare_profile.rb +117 -0
data/lib/canon/comparison/match_options.rb +42 -4
data/lib/canon/comparison/strategies/base_match_strategy.rb +99 -0
data/lib/canon/comparison/strategies/match_strategy_factory.rb +74 -0
data/lib/canon/comparison/strategies/semantic_tree_match_strategy.rb +220 -0
data/lib/canon/comparison/xml_comparator.rb +695 -91
data/lib/canon/comparison.rb +207 -2
data/lib/canon/config/env_provider.rb +71 -0
data/lib/canon/config/env_schema.rb +58 -0
data/lib/canon/config/override_resolver.rb +55 -0
data/lib/canon/config/type_converter.rb +59 -0
data/lib/canon/config.rb +158 -29
data/lib/canon/data_model.rb +29 -0
data/lib/canon/diff/diff_classifier.rb +74 -14
data/lib/canon/diff/diff_context_builder.rb +41 -0
data/lib/canon/diff/diff_line.rb +18 -2
data/lib/canon/diff/diff_node.rb +18 -3
data/lib/canon/diff/diff_node_mapper.rb +71 -12
data/lib/canon/diff/formatting_detector.rb +53 -0
data/lib/canon/diff_formatter/by_line/base_formatter.rb +60 -5
data/lib/canon/diff_formatter/by_line/html_formatter.rb +68 -16
data/lib/canon/diff_formatter/by_line/json_formatter.rb +0 -37
data/lib/canon/diff_formatter/by_line/simple_formatter.rb +0 -42
data/lib/canon/diff_formatter/by_line/xml_formatter.rb +116 -31
data/lib/canon/diff_formatter/by_line/yaml_formatter.rb +0 -37
data/lib/canon/diff_formatter/by_object/base_formatter.rb +126 -19
data/lib/canon/diff_formatter/by_object/xml_formatter.rb +30 -1
data/lib/canon/diff_formatter/debug_output.rb +7 -1
data/lib/canon/diff_formatter/diff_detail_formatter.rb +674 -57
data/lib/canon/diff_formatter/legend.rb +42 -0
data/lib/canon/diff_formatter.rb +78 -9
data/lib/canon/errors.rb +56 -0
data/lib/canon/formatters/html_formatter_base.rb +35 -1
data/lib/canon/formatters/json_formatter.rb +3 -0
data/lib/canon/formatters/yaml_formatter.rb +3 -0
data/lib/canon/html/data_model.rb +229 -0
data/lib/canon/html.rb +9 -0
data/lib/canon/options/cli_generator.rb +70 -0
data/lib/canon/options/registry.rb +234 -0
data/lib/canon/rspec_matchers.rb +34 -13
data/lib/canon/tree_diff/adapters/html_adapter.rb +316 -0
data/lib/canon/tree_diff/adapters/json_adapter.rb +204 -0
data/lib/canon/tree_diff/adapters/xml_adapter.rb +285 -0
data/lib/canon/tree_diff/adapters/yaml_adapter.rb +213 -0
data/lib/canon/tree_diff/core/attribute_comparator.rb +84 -0
data/lib/canon/tree_diff/core/matching.rb +241 -0
data/lib/canon/tree_diff/core/node_signature.rb +164 -0
data/lib/canon/tree_diff/core/node_weight.rb +135 -0
data/lib/canon/tree_diff/core/tree_node.rb +450 -0
data/lib/canon/tree_diff/matchers/hash_matcher.rb +258 -0
data/lib/canon/tree_diff/matchers/similarity_matcher.rb +168 -0
data/lib/canon/tree_diff/matchers/structural_propagator.rb +242 -0
data/lib/canon/tree_diff/matchers/universal_matcher.rb +220 -0
data/lib/canon/tree_diff/operation_converter.rb +631 -0
data/lib/canon/tree_diff/operations/operation.rb +92 -0
data/lib/canon/tree_diff/operations/operation_detector.rb +626 -0
data/lib/canon/tree_diff/tree_diff_integrator.rb +140 -0
data/lib/canon/tree_diff.rb +33 -0
data/lib/canon/validators/json_validator.rb +3 -1
data/lib/canon/validators/yaml_validator.rb +3 -1
data/lib/canon/version.rb +1 -1
data/lib/canon/xml/data_model.rb +22 -23
data/lib/canon/xml/element_matcher.rb +128 -20
data/lib/canon/xml/namespace_helper.rb +110 -0
data/lib/canon.rb +3 -0
metadata +81 -23
data/_config.yml +0 -116
data/docs/ADVANCED_TOPICS.adoc +0 -20
data/docs/BASIC_USAGE.adoc +0 -16
data/docs/CUSTOMIZING_BEHAVIOR.adoc +0 -19
data/docs/DIFF_ARCHITECTURE.adoc +0 -435
data/docs/DIFF_FORMATTING.adoc +0 -540
data/docs/FORMATS.adoc +0 -447
data/docs/INPUT_VALIDATION.adoc +0 -477
data/docs/MATCH_ARCHITECTURE.adoc +0 -463
data/docs/MATCH_OPTIONS.adoc +0 -719
data/docs/MODES.adoc +0 -432
data/docs/NORMATIVE_INFORMATIVE_DIFFS.adoc +0 -219
data/docs/OPTIONS.adoc +0 -1387
data/docs/PREPROCESSING.adoc +0 -491
data/docs/SEMANTIC_DIFF_REPORT.adoc +0 -528
data/docs/UNDERSTANDING_CANON.adoc +0 -17

data/docs/FORMATS.adoc DELETED Viewed

@@ -1,447 +0,0 @@
----
-layout: default
-title: Format Support
-nav_order: 20
-parent: Understanding Canon
----
-= Format support
-:toc:
-:toclevels: 3
-== Scope
-This document describes Canon's support for XML, HTML, JSON, and YAML formats,
-including canonicalization rules, format detection, and format-specific
-features.
-For usage examples, see link:RUBY_API[Ruby API], link:CLI[CLI], or
-link:RSPEC[RSpec documentation].
-== General
-Canon provides unified canonicalization and comparison for four serialization
-formats. Each format has specific rules and defaults optimized for its typical
-usage.
-== XML format
-=== Canonicalization
-Canon implements the https://www.w3.org/TR/xml-c14n11/[W3C Canonical XML
-Version 1.1] specification.
-**Key features:**
-* Namespace declaration ordering (lexicographic by prefix)
-* Attribute ordering (lexicographic by namespace URI, then local name)
-* Character encoding normalization to UTF-8
-* Special character encoding in text and attributes
-* Removal of superfluous namespace declarations
-* Support for xml:base, xml:lang, xml:space, and xml:id attributes
-* Processing instruction and comment handling
-* Document subset support with attribute inheritance
-.XML canonicalization example
-[example]
-====
-[source,ruby]
-----
-xml = <<~XML
-  <root xmlns:b="http://b.com" xmlns:a="http://a.com">
-    <item b:attr="2" a:attr="1">
-      Text   content
-    </item>
-  </root>
-XML
-Canon.format(xml, :xml)
-# => Namespace prefixes sorted, attributes sorted, whitespace normalized
-----
-====
-=== Format defaults
-[cols="1,1"]
-|===
-|Dimension |Default Behavior
-|`text_content`
-|`:strict`
-|`structural_whitespace`
-|`:strict`
-|`attribute_whitespace`
-|`:strict`
-|`attribute_order`
-|`:strict`
-|`attribute_values`
-|`:strict`
-|`comments`
-|`:strict`
-|===
-Default diff mode: `:by_object` (tree-based semantic diff)
-=== XML-specific features
-**Comment handling**: XML comments are preserved in canonical form unless
-`--with-comments` is explicitly set.
-**Namespace normalization**: Namespace declarations are sorted and duplicate
-declarations are removed.
-**xml: attributes**: Special attributes like `xml:lang`, `xml:space`, `xml:id`,
-and `xml:base` are properly handled per specification.
-== HTML format
-=== Canonicalization
-Canon supports HTML 4, HTML5, and XHTML with automatic format detection.
-**Key features:**
-* Automatic HTML vs XHTML detection
-* HTML5 parser for modern HTML
-* XML parser for XHTML
-* Consistent attribute ordering
-* Whitespace normalization
-* Comment handling in `<style>` and `<script>` tags
-.HTML canonicalization example
-[example]
-====
-[source,ruby]
-----
-html = <<~HTML
-  <!DOCTYPE html>
-  <html>
-    <body>
-      <div   class="foo"   id="bar">
-        Content
-      </div>
-    </body>
-  </html>
-HTML
-Canon.format(html, :html)
-# => Normalized structure with consistent formatting
-----
-====
-=== Format defaults
-[cols="1,1"]
-|===
-|Dimension |Default Behavior
-|`text_content`
-|`:normalize`
-|`structural_whitespace`
-|`:normalize`
-|`attribute_whitespace`
-|`:normalize`
-|`attribute_order`
-|`:ignore`
-|`attribute_values`
-|`:strict`
-|`comments`
-|`:ignore`
-|===
-Default diff mode: `:by_line` (line-based diff)
-=== HTML-specific features
-**Format detection**: Automatically detects HTML5, HTML4, or XHTML based on
-DOCTYPE and structure.
-**Whitespace handling**: HTML whitespace is collapsed per CSS rendering rules.
-Empty text nodes between elements are removed.
-**Attribute order**: HTML attributes are inherently unordered per the HTML
-specification, so default is `:ignore`.
-**Special tags**: Comments in `<style>` and `<script>` tags are normalized
-specially to handle CSS/JavaScript syntax.
-== JSON format
-=== Canonicalization
-Canon provides JSON canonicalization with sorted keys at all nesting levels.
-**Key features:**
-* Alphabetically sorted object keys
-* Consistent indentation (configurable)
-* Proper escape sequences
-* No trailing commas
-* Unicode normalization
-.JSON canonicalization example
-[example]
-====
-[source,ruby]
-----
-json = '{"z":3,"a":1,"nested":{"y":2,"x":1}}'
-Canon.format(json, :json)
-# => {"a":1,"nested":{"x":1,"y":2},"z":3}
-# Keys sorted at all levels
-----
-====
-=== Format defaults
-[cols="1,1"]
-|===
-|Dimension |Default Behavior
-|`text_content`
-|`:strict`
-|`structural_whitespace`
-|`:strict`
-|`key_order`
-|`:strict`
-|===
-Default diff mode: `:by_object` (tree-based semantic diff)
-=== JSON-specific features
-**Key ordering**: Object keys are sorted alphabetically for consistent
-comparison.
-**Type preservation**: Distinguishes between numbers, strings, booleans, and
-null.
-**Nested structures**: Handles deeply nested objects and arrays.
-**No comments**: Standard JSON does not support comments.
-== YAML format
-=== Canonicalization
-Canon provides YAML canonicalization with sorted keys and standard formatting.
-**Key features:**
-* Alphabetically sorted mapping keys
-* Consistent indentation
-* Standard YAML 1.2 format
-* Comment preservation (optional)
-* Anchor and alias handling
-.YAML canonicalization example
-[example]
-====
-[source,ruby]
-----
-yaml = <<~YAML
-  z: 3
-  a: 1
-  nested:
-    y: 2
-    x: 1
-YAML
-Canon.format(yaml, :yaml)
-# => Keys sorted at all levels
-----
-====
-=== Format defaults
-[cols="1,1"]
-|===
-|Dimension |Default Behavior
-|`text_content`
-|`:strict`
-|`structural_whitespace`
-|`:strict`
-|`key_order`
-|`:strict`
-|`comments`
-|`:strict`
-|===
-Default diff mode: `:by_object` (tree-based semantic diff)
-=== YAML-specific features
-**Comment support**: YAML comments are preserved and can be compared.
-**Key ordering**: Mapping keys are sorted alphabetically for consistent output.
-**Type detection**: YAML's rich type system is preserved (strings, numbers,
-booleans, dates, etc.).
-**Anchors and aliases**: YAML anchors (`&`) and aliases (`*`) are properly
-handled.
-== Format detection
-Canon automatically detects format based on file extensions:
-[cols="1,1"]
-|===
-|Extension |Format
-|`.xml`
-|XML
-|`.html`, `.htm`
-|HTML
-|`.json`
-|JSON
-|`.yaml`, `.yml`
-|YAML
-|===
-You can override auto-detection by explicitly specifying the format:
-.Explicit format specification
-[example]
-====
-[source,ruby]
-----
-# Ruby API
-Canon.format(content, :xml)
-# CLI
-$ canon format file.txt --format xml
-# Comparison
-Canon::Comparison.equivalent?(doc1, doc2, format: :xml)
-----
-====
-== Format comparison matrix
-[cols="1,1,1,1,1"]
-|===
-|Feature |XML |HTML |JSON |YAML
-|Canonicalization standard
-|W3C C14N 1.1
-|Custom
-|Custom
-|YAML 1.2
-|Comment support
-|Yes
-|Yes
-|No
-|Yes
-|Attribute/key ordering
-|Strict default
-|Ignored default
-|Strict default
-|Strict default
-|Default diff mode
-|by-object
-|by-line
-|by-object
-|by-object
-|Whitespace handling
-|Strict default
-|Normalized default
-|Strict default
-|Strict default
-|Namespace support
-|Yes
-|Limited (XHTML)
-|No
-|No
-|===
-== Working with multiple formats
-Canon's unified API works consistently across all formats:
-.Unified API examples
-[example]
-====
-[source,ruby]
-----
-# Format any content
-Canon.format(xml_content, :xml)
-Canon.format(html_content, :html)
-Canon.format(json_content, :json)
-Canon.format(yaml_content, :yaml)
-# Compare any format
-Canon::Comparison.equivalent?(xml1, xml2)
-Canon::Comparison.equivalent?(html1, html2)
-Canon::Comparison.equivalent?(json1, json2)
-Canon::Comparison.equivalent?(yaml1, yaml2)
-# RSpec matchers
-expect(actual_xml).to be_xml_equivalent_to(expected_xml)
-expect(actual_html).to be_html_equivalent_to(expected_html)
-expect(actual_json).to be_json_equivalent_to(expected_json)
-expect(actual_yaml).to be_yaml_equivalent_to(expected_yaml)
-----
-====
-== Format-specific comparators
-You can use format-specific comparator classes directly:
-.Format-specific comparators
-[example]
-====
-[source,ruby]
-----
-# XML comparator
-Canon::Comparison::XmlComparator.equivalent?(xml1, xml2,
-  match: { attribute_order: :ignore }
-)
-# HTML comparator
-Canon::Comparison::HtmlComparator.equivalent?(html1, html2,
-  match_profile: :rendered
-)
-# JSON comparator
-Canon::Comparison::JsonComparator.equivalent?(json1, json2,
-  match: { key_order: :ignore }
-)
-# YAML comparator
-Canon::Comparison::YamlComparator.equivalent?(yaml1, yaml2,
-  match: { comments: :ignore }
-)
-----
-====
-== See also
-* link:RUBY_API[Ruby API documentation]
-* link:CLI[Command-line interface]
-* link:MATCH_OPTIONS[Match options reference]
-* link:MODES[Diff modes]
-* link:PREPROCESSING[Preprocessing options]