class StatModule::Finding
Public Class Methods
new(failure, rule, description, hash = nil)
click to toggle source
Calls superclass method
StatModule::JSONable::new
# File lib/finding.rb, line 6 def initialize(failure, rule, description, hash = nil) if hash.is_a? Hash super(hash) return end raise TypeException unless rule.is_a?(String) && description.is_a?(String) @failure = failure @rule = rule @description = description end
Public Instance Methods
categories()
click to toggle source
# File lib/finding.rb, line 62 def categories @categories end
categories=(categories)
click to toggle source
# File lib/finding.rb, line 53 def categories=(categories) raise TypeException unless categories.is_a?(Array) categories.each { |item| raise TypeException unless Category.all.include?(item) raise DuplicateElementException if @categories.include?(item) @categories.push(item) } end
description()
click to toggle source
# File lib/finding.rb, line 40 def description @description end
description=(description)
click to toggle source
# File lib/finding.rb, line 35 def description=(description) raise TypeException unless description.is_a?(String) @description = description end
detail()
click to toggle source
# File lib/finding.rb, line 49 def detail @detail end
detail=(detail)
click to toggle source
# File lib/finding.rb, line 44 def detail=(detail) raise TypeException unless detail.is_a?(StatModule::Detail) @detail = detail end
failure()
click to toggle source
# File lib/finding.rb, line 22 def failure @failure end
failure=(failure)
click to toggle source
# File lib/finding.rb, line 18 def failure=(failure) @failure = failure end
fixes()
click to toggle source
# File lib/finding.rb, line 102 def fixes @fixes end
fixes=(fixes)
click to toggle source
# File lib/finding.rb, line 93 def fixes=(fixes) raise TypeException unless fixes.is_a?(Array) fixes.each { |item| raise TypeException unless item.is_a?(StatModule::Fix) raise DuplicateElementException if @fixes.include?(item) @fixes.push(item) } end
location()
click to toggle source
# File lib/finding.rb, line 71 def location @location end
location=(location)
click to toggle source
# File lib/finding.rb, line 66 def location=(location) raise TypeException unless location.is_a?(Location) @location = location end
print(formatted = false)
click to toggle source
# File lib/finding.rb, line 106 def print(formatted = false) result = "#{rule}, #{description}" if formatted if failure result = "#{FORMATTING_BALL} #{result}".colorize(:red) else result = "#{FORMATTING_WARNING} #{result}".colorize(:yellow) end end result += "\n#{location.print}" unless location.nil? result += "\nRECOMMENDATION: #{recommendation}" unless recommendation.nil? result end
recommendation()
click to toggle source
# File lib/finding.rb, line 89 def recommendation @recommendation end
recommendation=(recommendation)
click to toggle source
# File lib/finding.rb, line 84 def recommendation=(recommendation) raise TypeException unless recommendation.is_a?(String) @recommendation = recommendation end
rule()
click to toggle source
# File lib/finding.rb, line 31 def rule @rule end
rule=(rule)
click to toggle source
# File lib/finding.rb, line 26 def rule=(rule) raise TypeException unless rule.is_a?(String) @rule = rule end
time_to_fix()
click to toggle source
# File lib/finding.rb, line 80 def time_to_fix @timeToFix end
time_to_fix=(time_to_fix)
click to toggle source
# File lib/finding.rb, line 75 def time_to_fix=(time_to_fix) raise TypeException unless time_to_fix.is_a?(Integer) @timeToFix = time_to_fix end