Class: SvgConform::RemediationResult

Inherits:
Object
  • Object
show all
Defined in:
lib/svg_conform/remediation_result.rb

Overview

Result object for remediation operations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(remediation_id:, success:, failed_requirements:, message: nil, changes_made: [], error: nil) ⇒ RemediationResult

Returns a new instance of RemediationResult.



9
10
11
12
13
14
15
16
17
 
# File 'lib/svg_conform/remediation_result.rb', line 9

def initialize(remediation_id:, success:, failed_requirements:,
message: nil, changes_made: [], error: nil)
  @remediation_id = remediation_id
  @success = success
  @failed_requirements = failed_requirements
  @message = message
  @changes_made = changes_made || []
  @error = error
end

Instance Attribute Details

#changes_made ⇒ Object (readonly)

Returns the value of attribute changes_made.



6
7
8
 
# File 'lib/svg_conform/remediation_result.rb', line 6

def changes_made
  @changes_made
end

#error ⇒ Object (readonly)

Returns the value of attribute error.



6
7
8
 
# File 'lib/svg_conform/remediation_result.rb', line 6

def error
  @error
end

#failed_requirements ⇒ Object (readonly)

Returns the value of attribute failed_requirements.



6
7
8
 
# File 'lib/svg_conform/remediation_result.rb', line 6

def failed_requirements
  @failed_requirements
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



6
7
8
 
# File 'lib/svg_conform/remediation_result.rb', line 6

def message
  @message
end

#remediation_id ⇒ Object (readonly)

Returns the value of attribute remediation_id.



6
7
8
 
# File 'lib/svg_conform/remediation_result.rb', line 6

def remediation_id
  @remediation_id
end

#success ⇒ Object (readonly)

Returns the value of attribute success.



6
7
8
 
# File 'lib/svg_conform/remediation_result.rb', line 6

def success
  @success
end

Instance Method Details

#changes_count ⇒ Object 



27
28
29
 
# File 'lib/svg_conform/remediation_result.rb', line 27

def changes_count
  @changes_made.size
end

#failure? ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
 
# File 'lib/svg_conform/remediation_result.rb', line 23

def failure?
  !@success
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/svg_conform/remediation_result.rb', line 19

def success?
  @success
end

#to_s ⇒ Object 



31
32
33
34
 
# File 'lib/svg_conform/remediation_result.rb', line 31

def to_s
  status = success? ? "SUCCESS" : "FAILURE"
  "#{@remediation_id}: #{status} - #{@message}"
end