class GeneValidator::ValidationReport

This is an abstract class extended by all validation reports

Attributes

approach[RW]
conclusion[RW]
description[RW]
errors[R]
expected[R]
explanation[RW]
header[RW]
message[R]
plot_files[R]
result[R]
run_time[RW]
short_header[RW]
validation_result[R]

Public Class Methods

new(message = 'Not enough evidence', validation_result = :no, short_header = '', header = '', description = '', approach = '', explanation = '', conclusion = '') click to toggle source

Initilizes the object Params: message: result of the validation (to be displayed in the output) validation_result: :yes for pass validation, :no for fail, :unapplicable or :error short_header: String header: String description: String by default)

# File lib/genevalidator/validation_report.rb, line 34
def initialize(message = 'Not enough evidence', validation_result = :no,
               short_header = '', header = '', description = '',
               approach = '', explanation = '', conclusion = '')
  @message           = message
  @errors            = []
  @result            = validation_result
  @expected          = :yes
  @validation_result = validation_result
  @short_header      = short_header
  @header            = header
  @description       = description
  @approach          = approach
  @explanation       = explanation
  @conclusion        = conclusion
end

Public Instance Methods

color() click to toggle source

May return “success” or “error”

# File lib/genevalidator/validation_report.rb, line 60
def color
  if validation == @expected
    'success'
  elsif validation == :error || validation == :unapplicable
    'warning'
  else
    validation == :warning ? 'warning' : 'danger'
  end
end
print() click to toggle source
validation() click to toggle source
# File lib/genevalidator/validation_report.rb, line 54
def validation
  validation_result
end