svg_conform 0.1.11 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9300ab0026e52b929e0707e14c19ce45394da831dfd5e44f4afad14e1a2237cd
-  data.tar.gz: b19b0d2dbce1397abb478105704c994a32f418972240c9c149d375d8be519e2c
+  metadata.gz: 2dd3f8b58d869e1375f4ec0e5c0c212d36dc5ae64ab91873ccc896acb9bd42b7
+  data.tar.gz: 184b07a501eb1bae6fc1691849df9f2fbb0693c340149822b35a0129b47ae2c0
 SHA512:
-  metadata.gz: d413baac7ebb781837ff482103d751ce3222c170c613707b8411d5c6614dff71ac874802e0e5df14e276c0d56f537d32259787559359dfb954f6e3392088102d
-  data.tar.gz: ca1a62500f77534fca87d5b0e0136328ed81b9d9a7a81510e312a3760f31157e7a42af4934bacda3af2d6915b675bb9f4afdba2746332922cb23351bcc47fba2
+  metadata.gz: 9db79546df082674dbfbe29bd010e7a676765bd08366e26af6da279d9b56d01a907e259178ef1b3009340aa22eb785098790b49aa1cb81525831d9b60ac8e962
+  data.tar.gz: '091d729bffcc2716bcce077e5509afbce8971329c1479e86bc8c2968ac540742c161f3a3f369c78fa0f76bdf6f5de84439b6c773349656f1466da4d3175e5ca5'

data/.github/workflows/release.yml

@@ -5,6 +5,7 @@ name: release
 permissions:
   contents: write
   packages: write
+  id-token: write
 
 on:
   workflow_dispatch:

data/.rubocop_todo.yml

@@ -1,19 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-01-27 00:27:35 UTC using RuboCop version 1.82.1.
+# on 2026-04-09 13:07:51 UTC using RuboCop version 1.86.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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: with_first_argument, with_fixed_indentation
-Layout/ArgumentAlignment:
-  Exclude:
-    - 'lib/svg_conform/requirements/invalid_id_references_requirement.rb'
-
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyleAlignWith.
@@ -22,30 +14,19 @@ Layout/BlockAlignment:
   Exclude:
     - 'spec/svg_conform/profiles/svg_1_2_rfc_profile_spec.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
-# SupportedHashRocketStyles: key, separator, table
-# SupportedColonStyles: key, separator, table
-# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/HashAlignment:
-  Exclude:
-    - 'spec/svg_conform/validation_context_spec.rb'
-
-# Offense count: 662
+# Offense count: 667
 # 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: 2
+# Offense count: 9
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowInHeredoc.
 Layout/TrailingWhitespace:
   Exclude:
-    - 'lib/svg_conform/requirements/invalid_id_references_requirement.rb'
-    - 'spec/svg_conform/validation_context_spec.rb'
+    - 'spec/svg_conform/profiles/svg_1_2_rfc_profile_spec.rb'
 
 # Offense count: 3
 # Configuration parameters: AllowedMethods.
@@ -73,12 +54,20 @@ Lint/DuplicateCaseCondition:
   Exclude:
     - 'lib/svg_conform/semantic_comparator.rb'
 
-# Offense count: 1
+# Offense count: 2
 Lint/DuplicateMethods:
   Exclude:
     - 'lib/svg_conform/sax_validation_handler.rb'
+    - 'spec/svg_conform/validation_context_spec.rb'
 
-# Offense count: 2
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowComments.
+Lint/EmptyConditionalBody:
+  Exclude:
+    - 'spec/svgcheck_compatibility_spec.rb'
+
+# Offense count: 1
 Lint/HashCompareByIdentity:
   Exclude:
     - 'lib/svg_conform/document_analyzer.rb'
@@ -91,17 +80,12 @@ Lint/MissingSuper:
     - 'lib/svg_conform/compatibility/validity_analysis.rb'
     - 'lib/svg_conform/sax_validation_handler.rb'
 
-# Offense count: 1
-Lint/UnreachableCode:
-  Exclude:
-    - 'lib/svg_conform/commands/check.rb'
-
-# Offense count: 146
+# Offense count: 160
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Enabled: false
 
-# Offense count: 24
+# Offense count: 25
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
@@ -112,26 +96,38 @@ Metrics/BlockLength:
 Metrics/BlockNesting:
   Max: 4
 
-# Offense count: 125
+# Offense count: 138
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Enabled: false
 
-# Offense count: 259
+# Offense count: 276
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 154
 
-# Offense count: 6
+# Offense count: 8
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 9
 
-# Offense count: 99
+# Offense count: 112
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Enabled: false
 
+# Offense count: 9
+# Configuration parameters: Mode, AllowedMethods, AllowedPatterns, AllowBangMethods, WaywardPredicates.
+# AllowedMethods: call
+# WaywardPredicates: infinite?, nonzero?
+Naming/PredicateMethod:
+  Exclude:
+    - 'lib/svg_conform/compatibility/file_processor.rb'
+    - 'lib/svg_conform/node_helpers.rb'
+    - 'lib/svg_conform/remediations/base_remediation.rb'
+    - 'lib/svg_conform/requirements/style_requirement.rb'
+    - 'lib/svg_conform/semantic_comparator.rb'
+
 # Offense count: 2
 # Configuration parameters: MinSize.
 Performance/CollectionLiteralInLoop:
@@ -161,13 +157,18 @@ RSpec/DescribeClass:
 # Offense count: 157
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
-  Max: 53
+  Max: 43
 
 # Offense count: 3
 RSpec/LeakyConstantDeclaration:
   Exclude:
     - 'spec/svg_conform/profiles/svg_1_2_rfc_profile_spec.rb'
 
+# Offense count: 1
+RSpec/LeakyLocalVariable:
+  Exclude:
+    - 'spec/svgcheck_compatibility_spec.rb'
+
 # Offense count: 2
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
@@ -183,11 +184,31 @@ RSpec/MultipleDescribes:
 RSpec/MultipleExpectations:
   Max: 8
 
+# Offense count: 11
+# This cop supports unsafe autocorrection (--autocorrect-all).
+RSpec/Output:
+  Exclude:
+    - 'spec/svg_conform/profiles/svg_1_2_rfc_profile_spec.rb'
+    - 'spec/svg_conform/remediations/color_remediation_spec.rb'
+    - 'spec/svg_conform/remediations/font_remediation_spec.rb'
+    - 'spec/svg_conform/remediations/invalid_id_references_remediation_spec.rb'
+    - 'spec/svg_conform/remediations/namespace_attribute_remediation_spec.rb'
+    - 'spec/svg_conform/remediations/namespace_remediation_spec.rb'
+    - 'spec/svg_conform/remediations/no_external_css_remediation_spec.rb'
+    - 'spec/svg_conform/remediations/style_promotion_remediation_spec.rb'
+    - 'spec/svg_conform/remediations/viewbox_remediation_spec.rb'
+
 # Offense count: 1
 Rake/MethodDefinitionInTask:
   Exclude:
     - 'lib/tasks/svgcheck.rake'
 
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+Style/ComparableClamp:
+  Exclude:
+    - 'lib/svg_conform/css_color.rb'
+
 # Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, AllowComments.
@@ -197,17 +218,29 @@ Style/EmptyElse:
     - 'lib/svg_conform/remediations/namespace_remediation.rb'
     - 'lib/svg_conform/requirements/style_requirement.rb'
 
-# Offense count: 23
+# Offense count: 13
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: MaxUnannotatedPlaceholdersAllowed, Mode, AllowedMethods, AllowedPatterns.
 # SupportedStyles: annotated, template, unannotated
 Style/FormatStringToken:
   EnforcedStyle: unannotated
 
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/HashSlice:
+  Exclude:
+    - 'spec/svg_conform_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedClasses.
+Style/OneClassPerFile:
+  Exclude:
+    - 'lib/svg_conform/compatibility/report_formatter.rb'
+
 # Offense count: 1
-Style/MissingRespondToMissing:
+Style/OpenStructUse:
   Exclude:
-    - 'lib/svg_conform/cli.rb'
+    - 'lib/svg_conform/validator.rb'
 
 # Offense count: 4
 # Configuration parameters: AllowedMethods.
@@ -219,7 +252,7 @@ Style/OptionalBooleanParameter:
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowedMethods.
-# AllowedMethods: nonzero?
+# AllowedMethods: infinite?, nonzero?
 Style/RedundantCondition:
   Exclude:
     - 'lib/svg_conform/external_checkers/svgcheck/parser.rb'

data/CLAUDE.md

@@ -0,0 +1,115 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Build/Test Commands
+
+```bash
+# Install dependencies
+bin/setup
+
+# Run tests
+rake spec
+
+# Run a single spec file
+bundle exec rspec spec/svg_conform/validator_spec.rb
+
+# Run tests with detailed output
+bundle exec rspec --format documentation
+
+# Run linting
+rake rubocop
+
+# Run both tests and linting
+rake
+
+# Run a specific test by line number
+bundle exec rspec spec/svg_conform/validator_spec.rb:42
+```
+
+## Architecture
+
+### Two-Mode Validation System
+
+SvgConform uses two distinct operating modes:
+
+1. **SAX Validation Mode** (always used for validation):
+   - Memory-safe streaming XML parser
+   - Constant memory regardless of file size
+   - Handles files of any size (tested with 100MB+)
+   - Read-only, cannot modify documents
+   - Implemented via `SaxDocument` and `SaxValidationHandler`
+
+2. **DOM Remediation Mode** (only when applying fixes):
+   - Full document tree loaded in memory
+   - XPath queries and tree modification
+   - Memory scales with file size
+   - Only activated when `fix: true` is specified
+
+### Core Classes
+
+- `Validator` - Main entry point; normalizes all inputs to SAX validation
+- `SaxDocument` - SAX-based document wrapper for memory-safe validation
+- `Document` - DOM-based document wrapper for modifications
+- `Profile` - Collection of requirements and remediations; loaded from YAML
+- `Profiles` - Factory for loading/retrieving profile instances
+- `ValidationContext` - Carries state during validation (errors, data collected)
+- `ValidationResult` - Holds validation outcomes after checking
+- `ConformanceReport` - Formats validation results for output
+
+### Requirements System
+
+Requirements validate SVG documents. All requirements must support SAX validation:
+
+- Requirements inherit from `BaseRequirement` in `lib/svg_conform/requirements/`
+- Must implement `validate_sax_element(element, context)` for immediate checks
+- Can optionally implement `collect_sax_data()` + `validate_sax_complete()` for deferred validation (e.g., cross-reference checks)
+- Use `context.data` hash for per-document state (not instance variables - they leak across validations)
+- Never attempt DOM operations in SAX callbacks
+
+Key requirement classes: `NamespaceRequirement`, `ViewboxRequiredRequirement`, `IdReferenceRequirement`, `ForbiddenContentRequirement`, `ColorRestrictionsRequirement`, etc.
+
+### Remediations System
+
+Remediations fix validation failures. They run in DOM mode:
+
+- Inherit from `BaseRemediation` in `lib/svg_conform/remediations/`
+- Linked to requirements via `targets` array in profile YAML
+- Only execute when `should_execute?(failed_requirements)` returns true
+
+### Profile Configuration
+
+Profiles are defined in YAML under `config/profiles/`:
+- `base.yml` - Common requirements shared by other profiles
+- `metanorma.yml`, `svg_1_2_rfc.yml`, etc. - Specific profile definitions
+- Profile class map is built dynamically from filesystem in `Profile.build_class_map`
+
+Profiles support `import` to inherit from other profiles (e.g., `metanorma` imports `base`).
+
+### CLI Structure
+
+- `lib/svg_conform/cli.rb` - Thor-based CLI entry point
+- `lib/svg_conform/commands/check.rb` - Main validation command
+- `lib/svg_conform/commands/profiles.rb` - Profile listing command
+- `lib/svg_conform/commands/svgcheck.rb` - SVGCheck compatibility subcommands
+
+### Input Handling
+
+The `Validator` accepts multiple input types and always uses SAX:
+- String (XML content) → parsed directly with SAX
+- Moxml/Nokogiri documents → serialized once, then SAX validated
+- Document/Element objects → same serialization approach
+
+This ensures memory safety for large files regardless of input type.
+
+### Key Files
+
+- `lib/svg_conform.rb` - Main require file with autoloads
+- `lib/svg_conform/element_proxy.rb` - Lightweight SAX element representation
+- `lib/svg_conform/validation_context.rb` - Validation state container
+- `lib/svg_conform/sax_document.rb` - SAX document wrapper
+- `lib/svg_conform/sax_validation_handler.rb` - SAX callback handler
+
+### Error Handling Pattern
+
+The CLI uses `exit 1` for error exits. When improving error handling, prefer raising proper Ruby exceptions (`ValidationError`, `ProfileError`, `ArgumentError`) rather than using `exit`/`abort` directly, as Thor provides mechanisms for displaying errors gracefully to users.

data/Gemfile

@@ -6,6 +6,8 @@ source "https://rubygems.org"
 gemspec
 
 gem "canon", "~>0.1.10"
+gem "lutaml-model", github: "lutaml/lutaml-model", branch: "main"
+gem "moxml", github: "lutaml/moxml", branch: "main"
 gem "openssl", "~> 3.0"
 gem "rake"
 gem "rspec"

data/README.adoc

@@ -33,6 +33,7 @@ SvgConform is distributed as a Ruby gem.
 * **100% SVGCheck compatibility**: Perfect error report matching with Python svgcheck tool
 * **Configurable RDF metadata support**: Choose strict or permissive RDF/Dublin Core handling
 * **Generic namespace handling**: Configuration-driven foreign namespace validation
+* **Text-as-path detection**: Warns when text is rendered as outlined path glyphs (quality check)
 
 
 == Concepts
@@ -360,6 +361,168 @@ SvgConform provides compatibility with existing SVG validation tools:
 See link:docs/compatibility.adoc[Compatibility Documentation] for details.
 
 
+[[image_quality]]
+== Image quality metric
+
+SvgConform provides a quality metric system for analyzing and scoring SVG files
+across multiple dimensions:
+
+* **Quality Score (0-100)**: Composite score based on error density, severity, and remediability
+* **Quality Level**: EXCELLENT, GOOD, FAIR, POOR, or CRITICAL
+* **Error Breakdown**: Counts by severity (critical, high, medium, low) and remediability
+* **Complexity Index**: 1-10 scale based on element count and advanced features
+* **Feature Detection**: Base64 images, foreign namespaces, masks, clip paths, external refs
+
+Reports are fully object-oriented: the same report object supports `to_yaml`, `to_json`,
+and colorful terminal rendering.
+
+[IMPORTANT]
+.Quality depends on validation profile
+====
+The quality score is calculated based on validation errors, which depend on the
+chosen profile. Different profiles have different rules, so the same SVG file
+may receive different quality scores under different profiles.
+
+Example: `colors.svg` scores 60 (FAIR) under `svg_1_2_rfc` but 100 (EXCELLENT)
+under `metanorma` because the profiles have different color restrictions.
+====
+
+[source,bash]
+----
+# Integrated into main CLI (svg_conform quality analyze)
+svg_conform quality analyze image.svg
+
+# Output as YAML
+svg_conform quality analyze image.svg -- --format yaml
+
+# Batch analyze a directory
+svg_conform quality batch ./svgs -- --output quality_report.csv
+
+# With different profile (affects quality score!)
+svg_conform quality analyze image.svg -- --profile metanorma
+----
+
+[source,ruby]
+----
+# Single file analysis - returns SvgQualityReport object
+analyzer = SvgConform::ImageQualityAnalyzer.new
+report = analyzer.analyze('image.svg')
+
+# Three output formats from the same object
+puts report.render      # Colorful terminal output
+puts report.to_yaml    # YAML serialization
+puts report.to_json    # JSON serialization
+
+# Access attributes directly
+puts "Quality: #{report.quality_score} (#{report.quality_level})"
+puts "Errors: #{report.error_count} (#{report.remediable_errors} remediable)"
+puts "Complexity: #{report.complexity_index}/10"
+
+# Batch analysis - returns SvgQualityBatchReport object
+batch = analyzer.analyze_batch('./svgs')
+puts batch.render        # Summary with distribution chart
+puts batch.to_yaml      # Full YAML with all reports
+
+# Filter and process reports
+poor_files = batch.reports.select { |r| r.quality_level == :poor }
+----
+
+For detailed documentation including custom configuration and CLI options, see
+link:docs/image_quality.adoc[Image Quality Metric Documentation].
+
+=== CLI output examples
+
+.Single file analysis with default profile (svg_1_2_rfc)
+[source,text]
+----
+$ svg_conform quality analyze spec/fixtures/svgcheck/inputs/colors.svg
+
+📊 SVG Quality Report: colors.svg
+
+  ⚠️ Quality: 60 (FAIR)
+  🔶 Content Health: moderate_issues
+
+  📁 File: 1.41 KB (small)
+  📐 Elements: 17
+  🔢 Complexity: 1.0/10
+
+Errors: 12
+  🔧 Remediable: 12
+  ⚠️  Non-remediable: 0
+
+  Breakdown:
+    ● Medium: 12
+----
+
+.Same file with metanorma profile (no color restrictions)
+[source,text]
+----
+$ svg_conform quality analyze spec/fixtures/svgcheck/inputs/colors.svg -- --profile metanorma
+
+📊 SVG Quality Report: colors.svg
+
+  ✨ Quality: 100 (EXCELLENT)
+  ✅ Content Health: good
+
+  📁 File: 1.41 KB (small)
+  📐 Elements: 17
+  🔢 Complexity: 1.0/10
+
+Errors: 0
+  🔧 Remediable: 0
+  ⚠️  Non-remediable: 0
+----
+
+.Single file analysis (YAML output)
+[source,yaml]
+----
+$ svg_conform quality analyze spec/fixtures/svgcheck/inputs/colors.svg -- --format yaml
+
+---
+file_path: spec/fixtures/svgcheck/inputs/colors.svg
+quality_score: 60
+quality_level: :fair
+error_count: 12
+remediable_errors: 12
+...
+----
+
+.Single file analysis (JSON output)
+[source,json]
+----
+$ svg_conform quality analyze spec/fixtures/svgcheck/inputs/colors.svg -- --format json
+
+{"file_path":"spec/fixtures/svgcheck/inputs/colors.svg","quality_score":60,...}
+----
+
+.Batch summary (terminal output with distribution chart)
+[source,text]
+----
+$ svg_conform quality batch spec/fixtures/svgcheck/inputs -- --summary-only
+
+📊 SVG Quality Batch Report
+
+  📁 Total Files: 19
+  ✅ Successful: 19
+
+Quality Distribution
+
+  ✨ EXCELLENT  ██████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░    2 (10.5%)
+  👍 GOOD       ██████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░    2 (10.5%)
+  ⚠️ FAIR       ████████████████████████████████████████   13 (68.4%)
+  😟 POOR       ██████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░    2 (10.5%)
+  💥 CRITICAL   ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░    0 (0.0%)
+
+Summary
+
+  📈 Average Quality Score: 61.6/100
+  📊 Average Errors/File: 204.3
+
+  🔧 Total Remediable: 3872
+  ⚠️  Total Non-remediable: 10
+----
+
+
 == Documentation
 
 === User documentation
@@ -371,6 +534,7 @@ See link:docs/compatibility.adoc[Compatibility Documentation] for details.
 * link:docs/remediation.adoc[Remediation Reference] - All automatic remediations
 * link:docs/reference_manifest.adoc[Reference Manifest] - ID and reference tracking
 * link:docs/rdf_metadata_support.adoc[RDF Metadata Support] - RDF/Dublin Core configuration
+* link:docs/image_quality.adoc[Image Quality Metric] - Quality scoring and analysis
 
 === Developer documentation
 

data/config/profiles/metanorma.yml

@@ -187,6 +187,13 @@ requirements:
     check_image_elements: true
     check_style_images: true
 
+  # Text-as-path detection - warns when text is rendered as outlined paths
+  - id: "text_as_path"
+    type: "TextAsPathRequirement"
+    description: "Detects text rendered as outlined paths instead of native <text> elements"
+    min_d_length: 500
+    min_bezier: 5
+
 remediations:
   # ViewBox auto-generation
   - id: "viewbox_generation"