Class: SvgConform::Profile

Inherits:
Lutaml::Model::Serializable
  • Object
show all
Defined in:
lib/svg_conform/profile.rb

Overview

Base class for SVG validation profiles using lutaml-model serialization

Constant Summary collapse

REQUIREMENTS_CLASS_MAP =

Build class maps dynamically from filesystem

build_class_map(
  "requirements", "Requirements", "base_requirement"
)
REMEDIATIONS_CLASS_MAP = 
build_class_map(
  "remediations", "Remediations", "base_remediation"
)

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.build_class_map(dir_name, namespace, excluded_file) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/svg_conform/profile.rb', line 18

def self.build_class_map(dir_name, namespace, excluded_file)
  target_dir = File.expand_path(dir_name, __dir__)
  class_map = {}

  Dir.glob(File.join(target_dir,
                     "*_#{dir_name.chomp('s')}.rb")).each do |file|
    filename = File.basename(file, ".rb")
    next if filename == excluded_file

    class_name = filename.split("_").map(&:capitalize).join
    class_map[class_name] = "SvgConform::#{namespace}::#{class_name}"
  end

  class_map
end

.load_from_file(file_path) ⇒ Object

Simple YAML loading methods for individual profiles



172
173
174
175
 
# File 'lib/svg_conform/profile.rb', line 172

def self.load_from_file(file_path)
  yaml_content = File.read(file_path)
  from_yaml(yaml_content)
end

.save_to_file(profile, file_path) ⇒ Object 



177
178
179
 
# File 'lib/svg_conform/profile.rb', line 177

def self.save_to_file(profile, file_path)
  File.write(file_path, profile.to_yaml)
end

Instance Method Details

#add_remediation(remediation) ⇒ Object

New remediation methods



87
88
89
90
91
 
# File 'lib/svg_conform/profile.rb', line 87

def add_remediation(remediation)
  self.remediations ||= []
  remediations << remediation
  self
end

#add_requirement(requirement) ⇒ Object

New requirement methods



57
58
59
60
61
 
# File 'lib/svg_conform/profile.rb', line 57

def add_requirement(requirement)
  self.requirements ||= []
  requirements << requirement
  self
end

#apply_remediations(document) ⇒ Object

Apply remediations to a document after validation



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/svg_conform/profile.rb', line 154

def apply_remediations(document)
  # Run validation to get failed requirements
  validation_result = validate(document)

  all_changes = []

  # Apply remediations for failed requirements
  remediations&.each do |remediation|
    if remediation.should_execute?(validation_result.failed_requirements)
      changes = remediation.apply(document, nil)
      all_changes.concat(changes) if changes
    end
  end

  all_changes
end

#get_remediation(remediation_id) ⇒ Object 



106
107
108
109
110
 
# File 'lib/svg_conform/profile.rb', line 106

def get_remediation(remediation_id)
  return nil unless remediations

  remediations.find { |rem| rem.id == remediation_id }
end

#get_requirement(requirement_id) ⇒ Object 



76
77
78
79
80
 
# File 'lib/svg_conform/profile.rb', line 76

def get_requirement(requirement_id)
  return nil unless requirements

  requirements.find { |req| req.id == requirement_id }
end

#has_remediation?(remediation_id) ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
103
104
 
# File 'lib/svg_conform/profile.rb', line 100

def has_remediation?(remediation_id)
  return false unless remediations

  remediations.any? { |rem| rem.id == remediation_id }
end

#has_requirement?(requirement_id) ⇒ Boolean

Returns:

  • (Boolean) 


70
71
72
73
74
 
# File 'lib/svg_conform/profile.rb', line 70

def has_requirement?(requirement_id)
  return false unless requirements

  requirements.any? { |req| req.id == requirement_id }
end

#remediation_count ⇒ Object 



112
113
114
 
# File 'lib/svg_conform/profile.rb', line 112

def remediation_count
  remediations&.size || 0
end

#remove_remediation(remediation_id) ⇒ Object 



93
94
95
96
97
98
 
# File 'lib/svg_conform/profile.rb', line 93

def remove_remediation(remediation_id)
  return self unless remediations

  remediations.reject! { |rem| rem.id == remediation_id }
  self
end

#remove_requirement(requirement_id) ⇒ Object 



63
64
65
66
67
68
 
# File 'lib/svg_conform/profile.rb', line 63

def remove_requirement(requirement_id)
  return self unless requirements

  requirements.reject! { |req| req.id == requirement_id }
  self
end

#requirement_count ⇒ Object 



82
83
84
 
# File 'lib/svg_conform/profile.rb', line 82

def requirement_count
  requirements&.size || 0
end

#to_s ⇒ Object 



181
182
183
 
# File 'lib/svg_conform/profile.rb', line 181

def to_s
  "#{name}: #{description} (#{requirement_count} checks, #{remediation_count} remediations)"
end

#validate(document) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/svg_conform/profile.rb', line 116

def validate(document)
  # If it's a Document object, it's already loaded into DOM
  # Use DOM validation (safe, already in memory)
  if document.is_a?(Document)
    context = ValidationContext.new(document, self)

    # Validate using requirements system
    requirements&.each do |requirement|
      requirement.validate_document(document, context)
    end

    ValidationResult.new(document, self, context)
  elsif document.respond_to?(:to_xml)
    # For other document objects, serialize and use SAX for safety
    # (This handles Nokogiri/Moxml documents that aren't wrapped in Document)
    content = document.to_xml
    sax_doc = SaxDocument.from_content(content)
    sax_doc.validate_with_profile(self)
  else
    # Fallback to DOM mode for non-serializable objects
    context = ValidationContext.new(document, self)

    # Validate using requirements system
    requirements&.each do |requirement|
      requirement.validate_document(document, context)
    end

    ValidationResult.new(document, self, context)
  end
end

#validate_file(file_path) ⇒ Object 



147
148
149
150
151
 
# File 'lib/svg_conform/profile.rb', line 147

def validate_file(file_path)
  # Use SAX mode directly
  sax_doc = SaxDocument.from_file(file_path)
  sax_doc.validate_with_profile(self)
end