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

Profile acts as a factory for requirements and remediations. Each validation creates fresh instances to avoid state pollution.

Constant Summary collapse

PROFILES_DIR = 
File.expand_path("../../config/profiles", __dir__)
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 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/svg_conform/profile.rb', line 23

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



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

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 



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

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



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

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

#add_requirement(requirement) ⇒ Object

New requirement methods



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

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

#apply_remediations(document) ⇒ Object

Apply remediations to a document after validation



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/svg_conform/profile.rb', line 159

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 



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

def get_remediation(remediation_id)
  return nil unless remediations

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

#get_requirement(requirement_id) ⇒ Object 



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

def get_requirement(requirement_id)
  return nil unless requirements

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

#has_remediation?(remediation_id) ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_remediation?(remediation_id)
  return false unless remediations

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

#has_requirement?(requirement_id) ⇒ Boolean

Returns:

  • (Boolean) 


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

def has_requirement?(requirement_id)
  return false unless requirements

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

#remediation_count ⇒ Object 



117
118
119
 
# File 'lib/svg_conform/profile.rb', line 117

def remediation_count
  remediations&.size || 0
end

#remove_remediation(remediation_id) ⇒ Object 



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

def remove_remediation(remediation_id)
  return self unless remediations

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

#remove_requirement(requirement_id) ⇒ Object 



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

def remove_requirement(requirement_id)
  return self unless requirements

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

#requirement_count ⇒ Object 



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

def requirement_count
  requirements&.size || 0
end

#to_s ⇒ Object 



186
187
188
 
# File 'lib/svg_conform/profile.rb', line 186

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

#validate(document) ⇒ Object 



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
146
147
148
149
150
 
# File 'lib/svg_conform/profile.rb', line 121

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 



152
153
154
155
156
 
# File 'lib/svg_conform/profile.rb', line 152

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