Class: SvgConform::Remediations::BaseRemediation

Inherits:
Lutaml::Model::Serializable
  • Object
show all
Includes:
NodeHelpers
Defined in:
lib/svg_conform/remediations/base_remediation.rb

Overview

Base class for all remediations using lutaml-model serialization

Instance Method Summary collapse

Methods included from NodeHelpers

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

Instance Method Details

#apply(document, context) ⇒ Object

Raises:

  • (NotImplementedError) 


29
30
31
 
# File 'lib/svg_conform/remediations/base_remediation.rb', line 29

def apply(document, context)
  raise NotImplementedError, "Subclasses must implement apply"
end

#execute(document, failed_requirements) ⇒ Object

Execute the remediation and return a result



40
41
42
43
44
45
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
 
# File 'lib/svg_conform/remediations/base_remediation.rb', line 40

def execute(document, failed_requirements)
  unless should_execute?(failed_requirements)
    return RemediationResult.new(
      remediation_id: @id,
      success: false,
      failed_requirements: [],
      message: "Remediation not applicable",
    )
  end

  begin
    context = { failed_requirements: failed_requirements }
    changes_made = apply(document, context)

    RemediationResult.new(
      remediation_id: @id,
      success: true,
      failed_requirements: failed_requirements,
      message: "Remediation applied successfully",
      changes_made: changes_made,
    )
  rescue StandardError => e
    RemediationResult.new(
      remediation_id: @id,
      success: false,
      failed_requirements: failed_requirements,
      message: "Remediation failed: #{e.message}",
      error: e,
    )
  end
end

#should_execute?(failed_requirements) ⇒ Boolean

Check if this remediation should execute based on failed requirements

Returns:

  • (Boolean) 


34
35
36
37
 
# File 'lib/svg_conform/remediations/base_remediation.rb', line 34

def should_execute?(failed_requirements)
  failed_requirement_ids = failed_requirements.map(&:requirement_id)
  targets.any? { |req_id| failed_requirement_ids.include?(req_id) }
end

#to_s ⇒ Object 



72
73
74
 
# File 'lib/svg_conform/remediations/base_remediation.rb', line 72

def to_s
  "#{id}: #{description} (targets: #{targets.join(', ')})"
end