Package com.arc_e_tect.gradle.gherkin.progress

Class ReportText

java.lang.Object

com.arc_e_tect.gradle.gherkin.progress.ReportText

public final class ReportText
extends Object

Shared explanatory text used by both ProgressReportWriter and ReportTemplateRenderer.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFINED_BLURB	Explanation of the defined status.
static final String	IMPLEMENTED_BLURB	Explanation of the implemented status.
static final String	INTRO	One-sentence description of what the generated document contains.
static final String	LISTED_BLURB	Explanation of the listed status.
static final String	REMOVED_BLURB	Explanation of why a scenario becomes removed - i.e.

Method Summary

Modifier and Type	Method	Description
static String	reinterpretedOutlinesNotice(List<ReinterpretedOutlines.Outline> outlines)	Renders the notice that this run has started reporting one scenario per Examples row for the given outlines - see ReinterpretedOutlines for when that happens, and why it happens at most once per outline.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INTRO

public static final String INTRO

One-sentence description of what the generated document contains.

See Also:

• Constant Field Values

LISTED_BLURB

public static final String LISTED_BLURB

Explanation of the listed status.

See Also:

• Constant Field Values

DEFINED_BLURB

public static final String DEFINED_BLURB

Explanation of the defined status.

See Also:

• Constant Field Values

IMPLEMENTED_BLURB

public static final String IMPLEMENTED_BLURB

Explanation of the implemented status.

See Also:

• Constant Field Values

REMOVED_BLURB

public static final String REMOVED_BLURB

Explanation of why a scenario becomes removed - i.e. its removedAt is set - written right before the Progress Over Time table's own Removed (no longer seen) row, since a bare count invites the question of what it actually means.

See Also:

• Constant Field Values

Method Details

reinterpretedOutlinesNotice

public static String reinterpretedOutlinesNotice(List<ReinterpretedOutlines.Outline> outlines)

Renders the notice that this run has started reporting one scenario per Examples row for the given outlines - see ReinterpretedOutlines for when that happens, and why it happens at most once per outline.

Parameters:

outlines - the outlines re-interpreted on this run

Returns:

the AsciiDoc admonition block to place in the report, ending in a newline; the empty string when outlines is empty, so a caller can emit it unconditionally