abstract class Report
- Report
- Reference
- Object
Overview
Class inherited by all reports parseable by the visualizer.
Each report subclass must define the following class methods:
-
def self.is_candidate?(filename : String) : BoolThis method checks if the file could be of this report type using the filename. This tool only uses the filenames to check which report subclass to use, and any ambiguous filenames cause the tool to immediately stop.
-
def self.from_path(path : Path) : Enumerable(Report)This method should actually parse the report and return any amount of reports.
Direct Known Subclasses
Defined in:
report/report.crClass Method Summary
-
.create_sequential_id : Int32
Creates a sequential id used for mapping each report to a unique id.
Macro Summary
Instance Method Summary
-
#category : String
The category this report is grouped in.
-
#id : Int32
The unique identifier for this report.
-
#name : String
The name displayed for this report.
-
#render(io : IO) : Nil
Abstract method to create a visualization of the current report.
-
#status : Status
The status of this report.
Class Method Detail
Creates a sequential id used for mapping each report to a unique id.
Macro Detail
Instance Method Detail
The category this report is grouped in.
The string should be below ~20 characters to prevent the sidebar from overflowing.
The name displayed for this report.
The string should be below ~20 characters to prevent the sidebar from overflowing.
Abstract method to create a visualization of the current report.
The status of this report.
This will control the successful-test-count in the report header, filtering options and an indicator next to the test in the sidebar.