RubyGems - canon - Versions diffs - 0.1.8 → 0.1.10 - Mend

canon 0.1.8 → 0.1.10

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 (101) hide show

checksums.yaml +4 -4
data/.rubocop_todo.yml +83 -22
data/docs/Gemfile +1 -0
data/docs/_config.yml +90 -1
data/docs/advanced/diff-classification.adoc +196 -24
data/docs/features/match-options/index.adoc +239 -1
data/lib/canon/comparison/format_detector.rb +2 -1
data/lib/canon/comparison/html_comparator.rb +19 -8
data/lib/canon/comparison/html_compare_profile.rb +8 -2
data/lib/canon/comparison/markup_comparator.rb +109 -2
data/lib/canon/comparison/match_options/base_resolver.rb +7 -0
data/lib/canon/comparison/whitespace_sensitivity.rb +208 -0
data/lib/canon/comparison/xml_comparator/child_comparison.rb +15 -7
data/lib/canon/comparison/xml_comparator/diff_node_builder.rb +108 -0
data/lib/canon/comparison/xml_comparator/node_parser.rb +10 -5
data/lib/canon/comparison/xml_comparator/node_type_comparator.rb +14 -7
data/lib/canon/comparison/xml_comparator.rb +240 -23
data/lib/canon/comparison/xml_node_comparison.rb +25 -3
data/lib/canon/diff/diff_classifier.rb +119 -5
data/lib/canon/diff/formatting_detector.rb +1 -1
data/lib/canon/diff/xml_serialization_formatter.rb +153 -0
data/lib/canon/rspec_matchers.rb +37 -8
data/lib/canon/version.rb +1 -1
data/lib/canon/xml/data_model.rb +24 -13
metadata +4 -78
data/docs/plans/2025-01-17-html-parser-selection-fix.adoc +0 -250
data/false_positive_analysis.txt +0 -0
data/file1.html +0 -1
data/file2.html +0 -1
data/old-docs/ADVANCED_TOPICS.adoc +0 -20
data/old-docs/BASIC_USAGE.adoc +0 -16
data/old-docs/CHARACTER_VISUALIZATION.adoc +0 -567
data/old-docs/CLI.adoc +0 -497
data/old-docs/CUSTOMIZING_BEHAVIOR.adoc +0 -19
data/old-docs/DIFF_ARCHITECTURE.adoc +0 -435
data/old-docs/DIFF_FORMATTING.adoc +0 -540
data/old-docs/DIFF_PARAMETERS.adoc +0 -261
data/old-docs/DOM_DIFF.adoc +0 -1017
data/old-docs/ENV_CONFIG.adoc +0 -876
data/old-docs/FORMATS.adoc +0 -867
data/old-docs/INPUT_VALIDATION.adoc +0 -477
data/old-docs/MATCHER_BEHAVIOR.adoc +0 -90
data/old-docs/MATCH_ARCHITECTURE.adoc +0 -463
data/old-docs/MATCH_OPTIONS.adoc +0 -912
data/old-docs/MODES.adoc +0 -432
data/old-docs/NORMATIVE_INFORMATIVE_DIFFS.adoc +0 -219
data/old-docs/OPTIONS.adoc +0 -1387
data/old-docs/PREPROCESSING.adoc +0 -491
data/old-docs/README.old.adoc +0 -2831
data/old-docs/RSPEC.adoc +0 -814
data/old-docs/RUBY_API.adoc +0 -485
data/old-docs/SEMANTIC_DIFF_REPORT.adoc +0 -646
data/old-docs/SEMANTIC_TREE_DIFF.adoc +0 -765
data/old-docs/STRING_COMPARE.adoc +0 -345
data/old-docs/TMP.adoc +0 -3384
data/old-docs/TREE_DIFF.adoc +0 -1080
data/old-docs/UNDERSTANDING_CANON.adoc +0 -17
data/old-docs/VERBOSE.adoc +0 -482
data/old-docs/VISUALIZATION_MAP.adoc +0 -625
data/old-docs/WHITESPACE_TREATMENT.adoc +0 -1155
data/scripts/analyze_current_state.rb +0 -85
data/scripts/analyze_false_positives.rb +0 -114
data/scripts/analyze_remaining_failures.rb +0 -105
data/scripts/compare_current_failures.rb +0 -95
data/scripts/compare_dom_tree_diff.rb +0 -158
data/scripts/compare_failures.rb +0 -151
data/scripts/debug_attribute_extraction.rb +0 -66
data/scripts/debug_blocks_839.rb +0 -115
data/scripts/debug_meta_matching.rb +0 -52
data/scripts/debug_p_matching.rb +0 -192
data/scripts/debug_signature_matching.rb +0 -118
data/scripts/debug_sourcecode_124.rb +0 -32
data/scripts/debug_whitespace_sensitive.rb +0 -192
data/scripts/extract_false_positives.rb +0 -138
data/scripts/find_actual_false_positives.rb +0 -125
data/scripts/investigate_all_false_positives.rb +0 -161
data/scripts/investigate_batch1.rb +0 -127
data/scripts/investigate_classification.rb +0 -150
data/scripts/investigate_classification_detailed.rb +0 -190
data/scripts/investigate_common_failures.rb +0 -342
data/scripts/investigate_false_negative.rb +0 -80
data/scripts/investigate_false_positive.rb +0 -83
data/scripts/investigate_false_positives.rb +0 -227
data/scripts/investigate_false_positives_batch.rb +0 -163
data/scripts/investigate_mixed_content.rb +0 -125
data/scripts/investigate_remaining_16.rb +0 -214
data/scripts/run_single_test.rb +0 -29
data/scripts/test_all_false_positives.rb +0 -95
data/scripts/test_attribute_details.rb +0 -61
data/scripts/test_both_algorithms.rb +0 -49
data/scripts/test_both_simple.rb +0 -49
data/scripts/test_enhanced_semantic_output.rb +0 -125
data/scripts/test_readme_examples.rb +0 -131
data/scripts/test_semantic_tree_diff.rb +0 -99
data/scripts/test_semantic_ux_improvements.rb +0 -135
data/scripts/test_single_false_positive.rb +0 -119
data/scripts/test_size_limits.rb +0 -99
data/test_html_1.html +0 -21
data/test_html_2.html +0 -21
data/test_nokogiri.rb +0 -33
data/test_normalize.rb +0 -45

data/old-docs/CLI.adoc DELETED Viewed

@@ -1,497 +0,0 @@
----
-layout: default
-title: Command-Line Interface
-nav_order: 11
-parent: Basic Usage
----
-= Canon command-line interface
-:toc:
-:toclevels: 3
-== Scope
-This document describes Canon's command-line interface (CLI). The `canon`
-command provides file formatting and comparison capabilities.
-For Ruby API usage, see link:RUBY_API[Ruby API documentation].
-For RSpec testing, see link:RSPEC[RSpec documentation].
-== General
-After installing the Canon gem, the `canon` command becomes available in your
-shell. It provides two main commands:
-* `canon format` - Format files in XML, HTML, JSON, or YAML
-* `canon diff` - Compare files semantically
-== Installation
-[source,bash]
-----
-$ gem install canon
-$ canon --help
-----
-== Format command
-The `format` command formats files in canonical or pretty-print mode.
-=== Syntax
-[source,bash]
-----
-canon format FILE [OPTIONS]
-----
-=== Output modes
-`pretty` (default):: Human-readable output with indentation (2 spaces)
-`c14n`:: Canonical form without indentation (compact)
-=== Options
-`-f, --format FORMAT`:: Specify format: `xml`, `html`, `json`, or `yaml`
-(auto-detected from extension if not specified)
-`-m, --mode MODE`:: Output mode: `pretty` (default) or `c14n`
-`-i, --indent N`:: Indentation spaces for pretty mode (default: 2)
-`--indent-type TYPE`:: Indentation type: `space` (default) or `tab`
-`-o, --output FILE`:: Write output to file instead of stdout
-`-c, --with-comments`:: Include comments in canonical XML output
-=== Format detection
-When `--format` is not specified, Canon detects the format from file extension:
-[cols="1,1"]
-|===
-|File Extension |Detected Format
-|`.xml`
-|XML
-|`.html`, `.htm`
-|HTML
-|`.json`
-|JSON
-|`.yaml`, `.yml`
-|YAML
-|===
-=== Examples
-.Pretty-print with default settings
-[example]
-====
-[source,bash]
-----
-$ canon format input.xml
-<?xml version="1.0" encoding="UTF-8"?>
-<root>
-  <a>1</a>
-  <b>2</b>
-</root>
-----
-====
-.Canonical mode (compact)
-[example]
-====
-[source,bash]
-----
-$ canon format input.xml --mode c14n
-<root><a>1</a><b>2</b></root>
-----
-====
-.Custom indentation
-[example]
-====
-[source,bash]
-----
-# 4-space indentation
-$ canon format input.xml --mode pretty --indent 4
-# Tab indentation
-$ canon format input.xml --indent-type tab
-# JSON with 4 spaces
-$ canon format data.json --indent 4
-----
-====
-.Specify format explicitly
-[example]
-====
-[source,bash]
-----
-# Format a .txt file as XML
-$ canon format data.txt --format xml
-----
-====
-.Save to file
-[example]
-====
-[source,bash]
-----
-$ canon format input.xml --output formatted.xml
-# Or use shell redirection
-$ canon format input.xml > formatted.xml
-----
-====
-.Include XML comments in canonical output
-[example]
-====
-[source,bash]
-----
-$ canon format doc.xml --mode c14n --with-comments
-----
-====
-.Format different file types
-[example]
-====
-[source,bash]
-----
-# HTML files
-$ canon format page.html
-$ canon format page.html --mode c14n
-# JSON files
-$ canon format config.json
-$ canon format config.json --indent 4
-# YAML files
-$ canon format data.yaml
-----
-====
-== Diff command
-The `diff` command performs semantic comparison of files.
-=== Syntax
-[source,bash]
-----
-canon diff FILE1 FILE2 [OPTIONS]
-----
-=== Diff modes
-Canon supports two diff modes optimized for different use cases:
-`by-object`:: (default for JSON/YAML) Semantic tree-based diff showing
-structural changes
-`by-line`:: (default for HTML, optional for XML) Line-by-line diff after
-canonicalization
-See link:MODES[Diff modes] for details.
-=== Format options
-`-f, --format FORMAT`:: Format for both files: `xml`, `html`, `json`, or
-`yaml` (auto-detected from extension if not specified)
-`--format1 FORMAT`:: Format of first file (when comparing different formats)
-`--format2 FORMAT`:: Format of second file (when comparing different formats)
-=== Comparison options
-`-v, --verbose`:: Show detailed differences (default: just show if files
-differ)
-`--diff-algorithm ALGORITHM`:: Diff algorithm to use: `dom` (default) or
-`semantic`. DOM uses positional matching, semantic uses tree-based matching
-with operation detection.
-`--by-line`:: Use line-by-line diff for XML (default: by-object mode)
-`--text-content BEHAVIOR`:: How to compare text content: `strict`,
-`normalize`, or `ignore`
-`--structural-whitespace BEHAVIOR`:: How to handle whitespace between
-elements: `strict`, `normalize`, or `ignore`
-`--attribute-whitespace BEHAVIOR`:: How to handle whitespace in attribute
-values: `strict`, `normalize`, or `ignore` (XML/HTML only)
-`--attribute-order BEHAVIOR`:: Whether attribute order matters: `strict` or
-`ignore` (XML/HTML only)
-`--attribute-values BEHAVIOR`:: How to compare attribute values: `strict`,
-`normalize`, or `ignore` (XML/HTML only)
-`--key-order BEHAVIOR`:: Whether key order matters: `strict` or `ignore`
-(JSON/YAML only)
-`--comments BEHAVIOR`:: How to handle comments: `strict`, `normalize`, or
-`ignore`
-`--match-profile PROFILE`:: Use predefined match profile: `strict`,
-`rendered`, `spec_friendly`, or `content_only`
-See link:MATCH_OPTIONS[Match options] for detailed dimension reference.
-=== Output options
-`--color` / `--no-color`:: Enable/disable colored output (default: enabled)
-`--context-lines N`:: Number of context lines around changes (default: 3)
-`--diff-grouping-lines N`:: Group changes within N lines into blocks
-See link:DIFF_FORMATTING[Diff formatting] for details.
-=== Exit codes
-* `0` - Files are semantically equivalent
-* `1` - Files are semantically different
-* Other - Error occurred
-=== Examples
-.Basic comparison
-[example]
-====
-[source,bash]
-----
-# Compare two JSON files
-$ canon diff config1.json config2.json
-Files are semantically different
-# Compare two XML files
-$ canon diff file1.xml file2.xml
-✅ Files are semantically equivalent
-----
-====
-.Verbose mode with detailed diff
-[example]
-====
-[source,bash]
-----
-$ canon diff config1.json config2.json --verbose
-Visual Diff:
-├── settings.debug:
-│   ├── - true
-│   └── + false
-└── version:
-    ├── - "1.0.0"
-    └── + "2.0.0"
-----
-====
-.XML comparison with by-line mode
-[example]
-====
-[source,bash]
-----
-$ canon diff document1.xml document2.xml --by-line --verbose
-Line-by-line diff:
-   4 - |     <foreword id="fwd">
-   4 + |     <foreword displayorder="2" id="fwd">
-   5   |       <p>First paragraph</p>
-  10 + |       <p>New content</p>
-  11   |     </clause>
-----
-====
-.HTML comparison
-[example]
-====
-[source,bash]
-----
-$ canon diff page1.html page2.html --verbose
-Line-by-line diff:
-   4 - |     <title>My Page</title>
-   4 + |     <title>My Updated Page</title>
-   7 - |     <div class="header">
-   7 + |     <nav class="header">
-----
-====
-.Using match profiles
-[example]
-====
-[source,bash]
-----
-# Use spec_friendly profile
-$ canon diff file1.xml file2.xml \
-  --match-profile spec_friendly \
-  --verbose
-# Use rendered profile for HTML
-$ canon diff page1.html page2.html \
-  --match-profile rendered \
-  --verbose
-# Use strict profile (exact matching)
-$ canon diff file1.xml file2.xml \
-  --match-profile strict \
-  --verbose
-----
-====
-.Customize match dimensions
-[example]
-====
-[source,bash]
-----
-# Normalize text content, ignore whitespace
-$ canon diff file1.xml file2.xml \
-  --text-content normalize \
-  --structural-whitespace ignore \
-  --verbose
-# Ignore comments and attribute order
-$ canon diff file1.xml file2.xml \
-  --comments ignore \
-  --attribute-order ignore \
-  --verbose
-# Multiple dimension overrides
-$ canon diff file1.xml file2.xml \
-  --text-content normalize \
-  --structural-whitespace ignore \
-  --attribute-whitespace normalize \
-  --comments ignore \
-  --verbose
-----
-====
-.Combine profile with dimension overrides
-[example]
-====
-[source,bash]
-----
-# Use spec_friendly but require strict comments
-$ canon diff file1.xml file2.xml \
-  --match-profile spec_friendly \
-  --comments strict \
-  --verbose
-----
-====
-.Customize diff output
-[example]
-====
-[source,bash]
-----
-# Show more context lines
-$ canon diff file1.xml file2.xml \
-  --verbose \
-  --context-lines 5
-# Group nearby changes
-$ canon diff file1.xml file2.xml \
-  --verbose \
-  --diff-grouping-lines 10
-# Disable colors for piping to files
-$ canon diff file1.xml file2.xml \
-  --verbose \
-  --no-color > diff.txt
-# Combine diff options
-$ canon diff file1.xml file2.xml \
-  --verbose \
-  --context-lines 5 \
-  --diff-grouping-lines 2 \
-  --no-color
-----
-====
-.Compare different formats
-[example]
-====
-[source,bash]
-----
-# Compare JSON with YAML (must have same structure)
-$ canon diff config.json config.yaml \
-  --format1 json \
-  --format2 yaml \
-  --verbose
-----
-====
-.JSON/YAML comparison examples
-[example]
-====
-[source,bash]
-----
-# JSON comparison (uses by-object mode by default)
-$ canon diff config1.json config2.json --verbose
-# YAML comparison with key order ignored
-$ canon diff data1.yaml data2.yaml \
-  --key-order ignore \
-  --verbose
-# Show 10 context lines for large config files
-$ canon diff large-config1.json large-config2.json \
-  --verbose \
-  --context-lines 10
-----
-====
-.Shell integration
-[example]
-====
-[source,bash]
-----
-# Use in scripts
-if canon diff expected.xml actual.xml; then
-  echo "Files match!"
-else
-  echo "Files differ"
-  canon diff expected.xml actual.xml --verbose
-fi
-# Generate diff report
-canon diff file1.xml file2.xml --verbose --no-color > diff-report.txt
-# Compare with process substitution
-canon diff <(curl https://example.com/api/v1) \
-           <(curl https://example.com/api/v2) \
-  --format json \
-  --verbose
-----
-====
-== Help command
-Get help on available commands and options:
-[source,bash]
-----
-# General help
-$ canon help
-# Command-specific help
-$ canon help format
-$ canon help diff
-# Show version
-$ canon --version
-----
-== See also
-* link:RUBY_API[Ruby API documentation]
-* link:RSPEC[RSpec matchers]
-* link:MATCH_OPTIONS[Match options reference]
-* link:MODES[Diff modes]
-* link:DIFF_FORMATTING[Diff formatting options]

data/old-docs/CUSTOMIZING_BEHAVIOR.adoc DELETED Viewed

@@ -1,19 +0,0 @@
----
-layout: default
-title: Customizing Behavior
-nav_order: 4
-has_children: true
----
-= Customizing behavior
-Configure Canon for your specific needs:
-* **link:MATCH_OPTIONS[Match options]** - Match dimensions and profiles
-* **link:PREPROCESSING[Preprocessing]** - Document normalization options
-* **link:DIFF_FORMATTING[Diff formatting]** - Customizing diff output
-* **link:INPUT_VALIDATION[Input validation]** - Error handling
-* **link:CHARACTER_VISUALIZATION[Character visualization]** - Whitespace
-visibility
-These documents cover Canon's configuration options for fine-tuning comparison
-behavior and diff output.