class

Report

Inherits Reference < Object

Class inherited by all reports parseable by the visualizer.

Each report subclass must define the following class methods:

  • def self.is_candidate?(filename : String) : Bool

    This 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.

Class methods

create_sequential_id

Creates a sequential id used for mapping each report to a unique id.

Source

Instance methods

category

The category this report is grouped in.

The string should be below ~20 characters to prevent the sidebar from overflowing.

Source
id

The unique identifier for this report.

Source
name

The name displayed for this report.

The string should be below ~20 characters to prevent the sidebar from overflowing.

Source
render(io : IO) : Nil

Abstract method to create a visualization of the current report.

Source
status

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.

Source

Macros

patterns(*filenames)
Source

Nested types