Class: CleoQualityReview::Checks::CheckOutput

Inherits:

Struct

• Object
• Struct
• CleoQualityReview::Checks::CheckOutput

Defined in:

lib/cleo_quality_review/checks/quality_check.rb

Overview

Value object containing check output and parsed results

Instance Attribute Summary

• #check_name ⇒ String readonly

  Identifier for the check.

• #extension ⇒ String readonly

  File extension for the raw output.

• #raw_output ⇒ String readonly

  Raw tool output.

• #results ⇒ Array<Result> readonly

  Parsed findings.

• #tool_name ⇒ String readonly

  Name of the concrete tool.

• #tool_type ⇒ String readonly

  Category for this tool’s findings.

Instance Attribute Details

#check_name ⇒ String (readonly)

Returns identifier for the check.

Returns:

• (String) —

  identifier for the check

# File 'lib/cleo_quality_review/checks/quality_check.rb', line 141

CheckOutput = Struct.new(:check_name, :tool_name, :tool_type, :extension, :raw_output, :results, keyword_init: true)

#extension ⇒ String (readonly)

Returns file extension for the raw output.

Returns:

• (String) —

  file extension for the raw output

# File 'lib/cleo_quality_review/checks/quality_check.rb', line 141

CheckOutput = Struct.new(:check_name, :tool_name, :tool_type, :extension, :raw_output, :results, keyword_init: true)

#raw_output ⇒ String (readonly)

Returns raw tool output.

Returns:

• (String) —

  raw tool output

# File 'lib/cleo_quality_review/checks/quality_check.rb', line 141

CheckOutput = Struct.new(:check_name, :tool_name, :tool_type, :extension, :raw_output, :results, keyword_init: true)

#results ⇒ Array<Result> (readonly)

Returns parsed findings.

Returns:

• (Array<Result>) —

  parsed findings

# File 'lib/cleo_quality_review/checks/quality_check.rb', line 141

CheckOutput = Struct.new(:check_name, :tool_name, :tool_type, :extension, :raw_output, :results, keyword_init: true)

#tool_name ⇒ String (readonly)

Returns name of the concrete tool.

Returns:

• (String) —

  name of the concrete tool

# File 'lib/cleo_quality_review/checks/quality_check.rb', line 141

CheckOutput = Struct.new(:check_name, :tool_name, :tool_type, :extension, :raw_output, :results, keyword_init: true)

#tool_type ⇒ String (readonly)

Returns category for this tool’s findings.

Returns:

• (String) —

  category for this tool’s findings

# File 'lib/cleo_quality_review/checks/quality_check.rb', line 141

CheckOutput = Struct.new(:check_name, :tool_name, :tool_type, :extension, :raw_output, :results, keyword_init: true)