Package com.arc_e_tect.gradle.gherkin.snippet

Class SnippetWriter

java.lang.Object

com.arc_e_tect.gradle.gherkin.snippet.SnippetWriter

public class SnippetWriter
extends Object

Writes the listed.adoc/defined.adoc/implemented.adoc snippet files that back a progress report's include:: directives.

Constructor Summary

Constructors

Constructor	Description
SnippetWriter()	Creates a new SnippetWriter.

Method Summary

Modifier and Type	Method	Description
StatusSnippets	writeStatus(File snippetDir, ScenarioStatus status, List<ScenarioInfo> scenarios, boolean groupByFeature)	Writes the snippet file(s) for a single status.

Methods inherited from class java.lang.Object

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

Constructor Details

SnippetWriter

public SnippetWriter()

Creates a new SnippetWriter.

Method Details

writeStatus

public StatusSnippets writeStatus(File snippetDir,
 ScenarioStatus status,
 List<ScenarioInfo> scenarios,
 boolean groupByFeature)

Writes the snippet file(s) for a single status.

When groupByFeature is true and scenarios is non-empty, one file is written per feature, under <snippetDir>/<camelCaseFeatureTitle>/<status>.adoc. Otherwise a single flat file is written at <snippetDir>/<status>.adoc, containing a bullet per scenario, or _None._ when scenarios is empty.

Parameters:

snippetDir - the configured snippet output directory

status - the status these scenarios were classified as

scenarios - the scenarios classified as status

groupByFeature - whether to split the snippet by feature

Returns:

a description of the snippet file(s) written