class Report::Custom

• Report::Custom
• Report
• Reference
• Object

Overview

A custom report format allowing to insert arbitrary content for a test.

The reports must be an array of objects with the keys #name, #category, #status and #content. #status may only have the values failure or success.

Example:

[
  {
    "name": "meinTest",
    "category": "Kategorie",
    "status": "failure",
    "content": "<b>text</b>"
  },
  {
    "name": "meinTest2",
    "category": "Kategorie",
    "status": "success",
    "content": "<b>text</b>"
  }
]

WARNING Using custom reports is discouraged outside of development phases as they are hard to translate or re-theme.

Included Modules

• CLI::Macros
• JSON::Serializable

Extended Modules

• CLI::Context
• Report::ReportClass

Defined in:

Constructors

• .new(category : String, name : String, status : Status, content : String)
• .new(pull : JSON::PullParser)

Class Method Summary

• .from_path(path : Path) : Enumerable(Report)
• .is_candidate?(filename : String) : Bool

Instance Method Summary

• #category : String

  The category this report is grouped in.

• #content : String
• #name : String

  The name displayed for this report.

• #render(io : IO) : Nil

  A custom report format allowing to insert arbitrary content for a test.

• #status : Status

  The status of this report.

Constructor Detail

Class Method Detail

Instance Method Detail

[
  {
    "name": "meinTest",
    "category": "Kategorie",
    "status": "failure",
    "content": "<b>text</b>"
  },
  {
    "name": "meinTest2",
    "category": "Kategorie",
    "status": "success",
    "content": "<b>text</b>"
  }
]