svg_conform 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f59b89abd58959b19078c28ce450f6ee102a007176d102031a04233f924465e
-  data.tar.gz: 61e68396baf1673fcd8d764a2d141cd62006d1167d2cea0b9d8695a7bb7ea6c2
+  metadata.gz: 9300ab0026e52b929e0707e14c19ce45394da831dfd5e44f4afad14e1a2237cd
+  data.tar.gz: b19b0d2dbce1397abb478105704c994a32f418972240c9c149d375d8be519e2c
 SHA512:
-  metadata.gz: ffb22ae1a52cbf687b054dbe17ccf8aa44b17bbeeaad5122b57300e9562e73e9cbf005d0c330b2ce13c28a7e6f349ddd191b3d8e8918c6e8745d663debcbec7c
-  data.tar.gz: dedcb6619d41fc142b0bb6432f15a693b38699ca52b80ba0e255d38a7feca6a86fca6a52daa15f5e694b8f4ca1da323cf67289129305b99a3f15616df336415a
+  metadata.gz: d413baac7ebb781837ff482103d751ce3222c170c613707b8411d5c6614dff71ac874802e0e5df14e276c0d56f537d32259787559359dfb954f6e3392088102d
+  data.tar.gz: ca1a62500f77534fca87d5b0e0136328ed81b9d9a7a81510e312a3760f31157e7a42af4934bacda3af2d6915b675bb9f4afdba2746332922cb23351bcc47fba2

data/.rubocop_todo.yml

@@ -1,11 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-01-23 01:37:10 UTC using RuboCop version 1.82.1.
+# on 2026-01-27 00:27:35 UTC using RuboCop version 1.82.1.
 # 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.
@@ -14,7 +22,17 @@ Layout/BlockAlignment:
   Exclude:
     - 'spec/svg_conform/profiles/svg_1_2_rfc_profile_spec.rb'
 
-# Offense count: 620
+# 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
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
@@ -22,6 +40,14 @@ Layout/LineLength:
   Enabled: false
 
 # Offense count: 2
+# 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'
+
+# Offense count: 3
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: enums
 Lint/ConstantDefinitionInBlock:
@@ -91,7 +117,7 @@ Metrics/BlockNesting:
 Metrics/CyclomaticComplexity:
   Enabled: false
 
-# Offense count: 258
+# Offense count: 259
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 154
@@ -132,20 +158,12 @@ RSpec/DescribeClass:
     - 'spec/svg_conform/references/integration_spec.rb'
     - 'spec/svgcheck_compatibility_spec.rb'
 
-# Offense count: 139
+# Offense count: 157
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 53
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: implicit, each, example
-RSpec/HookArgument:
-  Exclude:
-    - 'spec/spec_helper.rb'
-
-# Offense count: 2
+# Offense count: 3
 RSpec/LeakyConstantDeclaration:
   Exclude:
     - 'spec/svg_conform/profiles/svg_1_2_rfc_profile_spec.rb'
@@ -161,7 +179,7 @@ RSpec/MultipleDescribes:
   Exclude:
     - 'spec/svg_conform/batch_report_spec.rb'
 
-# Offense count: 111
+# Offense count: 126
 RSpec/MultipleExpectations:
   Max: 8
 

data/lib/svg_conform/classification_cache.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SvgConform
+  # Cache for requirement classification results
+  # Instance-level (per SaxValidationHandler) to avoid shared mutable state
+  # No mutexes needed - each handler has its own cache
+  class ClassificationCache
+    def initialize
+      @cache = {}
+    end
+
+    # Fetch from cache or compute the value
+    def fetch(key)
+      @cache[key] ||= yield
+    end
+
+    # Clear specific key or entire cache
+    def clear(key = nil)
+      if key
+        @cache.delete(key)
+      else
+        @cache.clear
+      end
+    end
+
+    # Return number of cached entries
+    def size
+      @cache.size
+    end
+
+    # Check if key exists in cache
+    def key?(key)
+      @cache.key?(key)
+    end
+  end
+end

data/lib/svg_conform/profile.rb

@@ -6,6 +6,9 @@ require_relative "remediations"
 
 module SvgConform
   # Base class for SVG validation profiles using lutaml-model serialization
+  #
+  # Profile acts as a factory for requirements and remediations.
+  # Each validation creates fresh instances to avoid state pollution.
   class Profile < Lutaml::Model::Serializable
     PROFILES_DIR = File.expand_path("../../config/profiles", __dir__)
 

data/lib/svg_conform/requirements/base_requirement.rb

@@ -6,6 +6,89 @@ require_relative "../interfaces/requirement_interface"
 module SvgConform
   module Requirements
     # Base class for all validation requirements
+    #
+    # == Validation modes
+    #
+    # Requirements support two validation modes:
+    #
+    # === DOM validation (remediation mode)
+    #
+    # Used when the full document is available and remediation is needed.
+    # Requirements implement +validate_document+ to traverse the document once.
+    #
+    #   requirement.validate_document(document, context)
+    #
+    # === SAX validation (streaming mode)
+    #
+    # Used for memory-efficient streaming validation without loading the full document.
+    # Requirements implement either immediate or deferred validation patterns.
+    #
+    # ==== Immediate validation (14 requirements)
+    #
+    # Validates as it encounters each node during SAX parsing.
+    # No state is needed - validation is complete after +validate_sax_element+ returns.
+    #
+    #   def validate_sax_element(element, context)
+    #     # Immediate validation logic
+    #     context.add_error(...) if invalid
+    #   end
+    #
+    # Requirements using immediate validation:
+    # - AllowedElementsRequirement
+    # - FontFamilyRequirement
+    # - ColorRestrictionsRequirement
+    # - ViewboxRequiredRequirement
+    # - NamespaceRequirement
+    # - IdCollectionRequirement
+    # - StylePromotionRequirement
+    # - NoExternalImagesRequirement
+    # - NoExternalFontsRequirement
+    # - NamespaceAttributesRequirement
+    # - ForbiddenContentRequirement
+    # - StyleRequirement
+    # - LinkValidationRequirement (registers to ReferenceManifest)
+    #
+    # ==== Deferred validation (3 requirements)
+    #
+    # Collects data during SAX parsing and validates at document end.
+    # Requires a nested State class to store collected data.
+    #
+    #   class State
+    #     attr_accessor :collected_data
+    #
+    #     def initialize
+    #       @collected_data = []
+    #     end
+    #   end
+    #
+    #   def needs_deferred_validation?
+    #     true
+    #   end
+    #
+    #   def collect_sax_data(element, context)
+    #     state = context.state_for(self)
+    #     state.collected_data << extract_data(element)
+    #   end
+    #
+    #   def validate_sax_complete(context)
+    #     state = context.state_for(self)
+    #     # Validate collected data
+    #   end
+    #
+    # Requirements using deferred validation:
+    # - IdReferenceRequirement (needs forward references to IDs)
+    # - InvalidIdReferencesRequirement (needs to collect IDs first)
+    # - NoExternalCssRequirement (needs to check style elements)
+    #
+    # == State management
+    #
+    # Requirements needing deferred validation must define a nested State class.
+    # The ValidationContext manages state instances per requirement via +state_for+:
+    #
+    #   state = context.state_for(self)  # Returns State instance for this requirement
+    #
+    # Each validation gets a fresh state instance, preventing state pollution when
+    # reusing the same profile for multiple validations.
     class BaseRequirement < Lutaml::Model::Serializable
       include SvgConform::NodeHelpers
       include SvgConform::Interfaces::RequirementInterface

data/lib/svg_conform/requirements/id_reference_requirement.rb

@@ -6,28 +6,29 @@ require "set"
 module SvgConform
   module Requirements
     class IdReferenceRequirement < BaseRequirement
-      def needs_deferred_validation?
-        true
+      # Nested State class - requirement owns its state structure
+      class State
+        attr_accessor :collected_ids, :url_refs, :href_refs, :other_refs
+
+        def initialize
+          @collected_ids = Set.new
+          @url_refs = []
+          @href_refs = []
+          @other_refs = []
+        end
       end
 
-      # Reset state before each validation run to prevent state leakage
-      def reset_state
-        @collected_ids = Set.new
-        @collected_url_refs = []
-        @collected_href_refs = []
-        @collected_other_refs = []
+      def needs_deferred_validation?
+        true
       end
 
-      def collect_sax_data(element, _context)
-        # Initialize collections on first call
-        @collected_ids ||= Set.new
-        @collected_url_refs ||= []
-        @collected_href_refs ||= []
-        @collected_other_refs ||= []
-
+      def collect_sax_data(element, context)
+        state = context.state_for(self)
         # Collect IDs
         id_value = element.raw_attributes["id"]
-        @collected_ids.add(id_value) if id_value && !id_value.empty?
+        if id_value && !id_value.empty?
+          state.collected_ids.add(id_value)
+        end
 
         # Collect url() references
         url_attributes = %w[fill stroke marker-start marker-mid marker-end
@@ -38,7 +39,7 @@ module SvgConform
 
           url_refs = extract_url_references(attr_value)
           url_refs.each do |ref_id|
-            @collected_url_refs << [element, ref_id, attr_name]
+            state.url_refs << [element, ref_id, attr_name]
           end
         end
 
@@ -47,7 +48,7 @@ module SvgConform
         if style_attr
           url_refs = extract_url_references(style_attr)
           url_refs.each do |ref_id|
-            @collected_url_refs << [element, ref_id, "style"]
+            state.url_refs << [element, ref_id, "style"]
           end
         end
 
@@ -55,7 +56,7 @@ module SvgConform
         href_value = element.raw_attributes["href"] || element.raw_attributes["xlink:href"]
         if href_value&.start_with?("#")
           ref_id = href_value[1..] # Remove #
-          @collected_href_refs << [element, ref_id]
+          state.href_refs << [element, ref_id]
         end
 
         # Collect other ID references
@@ -69,18 +70,18 @@ module SvgConform
           ref_ids.each do |ref_id|
             next if ref_id.empty?
 
-            @collected_other_refs << [element, ref_id, attr_name]
+            state.other_refs << [element, ref_id, attr_name]
           end
         end
       end
 
       def validate_sax_complete(context)
-        # Guard against nil collections (if collect_sax_data was never called)
-        return unless @collected_url_refs && @collected_href_refs && @collected_other_refs && @collected_ids
+        state = context.state_for(self)
+        return unless state.url_refs && state.href_refs && state.other_refs && state.collected_ids
 
         # Validate all collected references
-        @collected_url_refs.each do |element, ref_id, attr_name|
-          next if @collected_ids.include?(ref_id)
+        state.url_refs.each do |element, ref_id, attr_name|
+          next if state.collected_ids.include?(ref_id)
 
           message = if attr_name == "style"
                       "Reference to undefined ID '#{ref_id}' in style attribute"
@@ -95,8 +96,8 @@ module SvgConform
           )
         end
 
-        @collected_href_refs.each do |element, ref_id|
-          next if @collected_ids.include?(ref_id)
+        state.href_refs.each do |element, ref_id|
+          next if state.collected_ids.include?(ref_id)
 
           context.add_error(
             node: element,
@@ -105,8 +106,8 @@ module SvgConform
           )
         end
 
-        @collected_other_refs.each do |element, ref_id, attr_name|
-          next if @collected_ids.include?(ref_id)
+        state.other_refs.each do |element, ref_id, attr_name|
+          next if state.collected_ids.include?(ref_id)
 
           context.add_error(
             node: element,

data/lib/svg_conform/requirements/invalid_id_references_requirement.rb

@@ -23,31 +23,43 @@ module SvgConform
 
       def initialize(*args)
         super
-        @collected_ids = Set.new
-        @use_element_refs = [] # [element, ref_id, href]
-        @other_refs = [] # [element, ref_id, attr_name, value]
+        # No instance state - validation state stored in context
+      end
+
+      # State class for tracking ID references during SAX parsing
+      class State
+        attr_accessor :collected_ids, :use_element_refs, :other_refs,
+                      :existing_ids
+
+        def initialize
+          @collected_ids = Set.new
+          @use_element_refs = []
+          @other_refs = []
+          @existing_ids = nil
+        end
       end
 
       def needs_deferred_validation?
         true
       end
 
-      def collect_sax_data(element, _context)
-        # Initialize collections on first call
-        @collected_ids ||= Set.new
-        @use_element_refs ||= []
-        @other_refs ||= []
+      def collect_sax_data(element, context)
+        state = context.state_for(self)
 
         # Collect IDs
         id_attr = element.raw_attributes["id"]
-        @collected_ids.add(id_attr) if id_attr && !id_attr.empty?
+        if id_attr && !id_attr.empty?
+          state.collected_ids.add(id_attr)
+        end
 
         # Collect use element references
         if check_use_elements && element.name == "use"
           href = element.raw_attributes["xlink:href"] || element.raw_attributes["href"]
           if href&.start_with?("#")
             ref_id = href[1..]
-            @use_element_refs << [element, ref_id, href] unless ref_id.empty?
+            unless ref_id.empty?
+              state.use_element_refs << [element, ref_id, href]
+            end
           end
         end
 
@@ -61,7 +73,7 @@ module SvgConform
             next unless attr_value&.match?(/^url\(#(.+)\)$/)
 
             ref_id = Regexp.last_match(1)
-            @other_refs << [element, ref_id, attr_name, attr_value]
+            state.other_refs << [element, ref_id, attr_name, attr_value]
           end
 
           # Check style attribute
@@ -72,19 +84,23 @@ module SvgConform
               next unless value&.match?(/^url\(#(.+)\)$/)
 
               ref_id = Regexp.last_match(1)
-              @other_refs << [element, ref_id, "style:#{property}", value]
+              state.other_refs << [element, ref_id, "style:#{property}", value]
             end
           end
         end
       end
 
       def validate_sax_complete(context)
-        # Guard against nil collections
-        return unless @use_element_refs && @other_refs && @collected_ids
+        state = context.state_for(self)
+        collected_ids = state.collected_ids
+        use_element_refs = state.use_element_refs
+        other_refs = state.other_refs
+
+        return unless collected_ids && use_element_refs && other_refs
 
         # Validate use element references
-        @use_element_refs.each do |element, ref_id, href|
-          next if @collected_ids.include?(ref_id)
+        use_element_refs.each do |element, ref_id, href|
+          next if collected_ids.include?(ref_id)
 
           context.add_error(
             requirement_id: id,
@@ -96,8 +112,8 @@ module SvgConform
         end
 
         # Validate other references if enabled
-        @other_refs.each do |element, ref_id, attr_name, value|
-          next if @collected_ids.include?(ref_id)
+        other_refs.each do |element, ref_id, attr_name, value|
+          next if collected_ids.include?(ref_id)
 
           message = if attr_name.start_with?("style:")
                       property = attr_name.split(":", 2)[1]
@@ -119,7 +135,8 @@ module SvgConform
       def validate_document(document, context)
         # Collect all existing IDs in the document
         existing_ids = collect_existing_ids(document)
-        context.set_data(:existing_ids, existing_ids)
+        state = context.state_for(self)
+        state.existing_ids = existing_ids
 
         # Check for invalid references
         super(document, context)
@@ -152,13 +169,14 @@ module SvgConform
       end
 
       def check_use_element(node, context)
+        state = context.state_for(self)
         href = get_attribute(node, "xlink:href") || get_attribute(node, "href")
         return unless href&.start_with?("#")
 
         id_ref = href[1..] # Remove # prefix
         return if id_ref.empty?
 
-        existing_ids = context.get_data(:existing_ids)
+        existing_ids = state.existing_ids
         return if existing_ids.include?(id_ref)
 
         context.add_error(
@@ -170,13 +188,15 @@ module SvgConform
       end
 
       def check_other_id_references(node, context)
+        state = context.state_for(self)
+
         # Check other attributes that reference IDs
         id_reference_attributes = %w[
           clip-path mask filter marker-start marker-mid marker-end
           fill stroke
         ]
 
-        existing_ids = context.get_data(:existing_ids)
+        existing_ids = state.existing_ids
 
         id_reference_attributes.each do |attr_name|
           attr_value = get_attribute(node, attr_name)

data/lib/svg_conform/requirements/no_external_css_requirement.rb

@@ -22,9 +22,17 @@ module SvgConform
         map "allowed_protocols", to: :allowed_protocols
       end
 
+      class State
+        attr_accessor :collected_styles
+
+        def initialize
+          @collected_styles = []
+        end
+      end
+
       def initialize(*args)
         super
-        @collected_style_elements = []
+        # No instance state - validation state stored in context
       end
 
       def check(node, context)
@@ -44,24 +52,23 @@ module SvgConform
         check_style_elements # Only deferred if checking style elements
       end
 
-      def collect_sax_data(element, _context)
+      def collect_sax_data(element, context)
+        state = context.state_for(self)
         # Collect style elements for deferred validation (text content needs to be complete)
         if check_style_elements && element.name == "style"
-          @collected_style_elements << element
+          state.collected_styles << element
         end
       end
 
       def validate_sax_complete(context)
-        # Guard against nil collection
-        return unless @collected_style_elements
+        state = context.state_for(self)
+        collected_style_elements = state.collected_styles
+        return unless collected_style_elements
 
         # Validate collected style elements
-        @collected_style_elements.each do |element|
+        collected_style_elements.each do |element|
           check_style_element(element, context)
         end
-
-        # Reset for next validation
-        @collected_style_elements = []
       end
 
       def should_check_node?(node, context = nil)