Class: SvgConform::Requirements::InvalidIdReferencesRequirement

Inherits:
BaseRequirement
  • Object
show all
Defined in:
lib/svg_conform/requirements/invalid_id_references_requirement.rb

Overview

Requirement to validate that ID references point to existing elements Based on the Lucid SVG fix script that removes use elements with invalid IDREF

Defined Under Namespace

Classes: State

Instance Method Summary collapse

Methods inherited from BaseRequirement

#get_attributes, #should_check_node?, #skip_attribute_validation?, #to_s, #validate_sax_element

Methods included from Interfaces::RequirementInterface

#reset_state, #should_check_node?, #to_s, #validate_sax_element

Methods included from NodeHelpers

#element?, #get_attribute, #has_attribute?, #remove_attribute, #set_attribute, #text?

Constructor Details

#initialize(*args) ⇒ InvalidIdReferencesRequirement

Returns a new instance of InvalidIdReferencesRequirement.



24
25
26
27
 
# File 'lib/svg_conform/requirements/invalid_id_references_requirement.rb', line 24

def initialize(*args)
  super
  # No instance state - validation state stored in context
end

Instance Method Details

#check(node, context) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/svg_conform/requirements/invalid_id_references_requirement.rb', line 145

def check(node, context)
  return unless element?(node)

  if check_use_elements && node.name == "use"
    check_use_element(node,
                      context)
  end

  return unless check_other_references

  check_other_id_references(node, context)
end

#collect_sax_data(element, context) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/svg_conform/requirements/invalid_id_references_requirement.rb', line 46

def collect_sax_data(element, context)
  state = context.state_for(self)

  # Collect IDs
  id_attr = element.raw_attributes["id"]
  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..]
      unless ref_id.empty?
        state.use_element_refs << [element, ref_id, href]
      end
    end
  end

  # Collect other ID references if enabled
  if check_other_references
    id_reference_attributes = %w[clip-path mask filter marker-start
                                 marker-mid marker-end fill stroke]

    id_reference_attributes.each do |attr_name|
      attr_value = element.raw_attributes[attr_name]
      next unless attr_value&.match?(/^url\(#(.+)\)$/)

      ref_id = Regexp.last_match(1)
      state.other_refs << [element, ref_id, attr_name, attr_value]
    end

    # Check style attribute
    style_value = element.raw_attributes["style"]
    if style_value
      styles = parse_style(style_value)
      styles.each do |property, value|
        next unless value&.match?(/^url\(#(.+)\)$/)

        ref_id = Regexp.last_match(1)
        state.other_refs << [element, ref_id, "style:#{property}", value]
      end
    end
  end
end

#needs_deferred_validation? ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/svg_conform/requirements/invalid_id_references_requirement.rb', line 42

def needs_deferred_validation?
  true
end

#validate_document(document, context) ⇒ Object 



135
136
137
138
139
140
141
142
143
 
# File 'lib/svg_conform/requirements/invalid_id_references_requirement.rb', line 135

def validate_document(document, context)
  # Collect all existing IDs in the document
  existing_ids = collect_existing_ids(document)
  state = context.state_for(self)
  state.existing_ids = existing_ids

  # Check for invalid references
  super
end

#validate_sax_complete(context) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/svg_conform/requirements/invalid_id_references_requirement.rb', line 93

def validate_sax_complete(context)
  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)

    context.add_error(
      requirement_id: id,
      node: element,
      message: "use element references non-existent ID: #{ref_id}",
      severity: :error,
      data: { invalid_id: ref_id, href: href },
    )
  end

  # Validate other references if enabled
  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]
                "style property #{property} references non-existent ID: #{ref_id}"
              else
                "#{attr_name} references non-existent ID: #{ref_id}"
              end

    context.add_error(
      requirement_id: id,
      node: element,
      message: message,
      severity: :error,
      data: { invalid_id: ref_id, attribute: attr_name, value: value },
    )
  end
end