Index (gherkin-to-asciidoc 2.1.0 API)

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

ALL - Enum constant in enum class com.arc_e_tect.gradle.gherkin.indexing.IndexingMode: Both features and scenarios are numbered.
apply(Project) - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocPlugin

B

blurb() - Method in record class com.arc_e_tect.gradle.gherkin.progress.StatusSummary: Returns the value of the blurb record component.
byFeatureTitle(List<ScenarioInfo>) - Static method in class com.arc_e_tect.gradle.gherkin.parser.ScenarioGrouping: Groups scenarios by ScenarioInfo.featureTitle(), preserving the order in which each feature title was first encountered.

C

CI - Enum constant in enum class com.arc_e_tect.gradle.gherkin.indexing.IndexingMode: Indexing is skipped entirely: the source .feature files are left completely untouched, not even to strip numbering left over from a previous run - unlike IndexingMode.OFF, which does strip it.
classify(ScenarioInfo, List<Expression>) - Method in class com.arc_e_tect.gradle.gherkin.progress.ScenarioClassifier: Classifies the given scenario.
com.arc_e_tect.gradle.gherkin - package com.arc_e_tect.gradle.gherkin
com.arc_e_tect.gradle.gherkin.glue - package com.arc_e_tect.gradle.gherkin.glue
com.arc_e_tect.gradle.gherkin.indexing - package com.arc_e_tect.gradle.gherkin.indexing
com.arc_e_tect.gradle.gherkin.parser - package com.arc_e_tect.gradle.gherkin.parser
com.arc_e_tect.gradle.gherkin.progress - package com.arc_e_tect.gradle.gherkin.progress
com.arc_e_tect.gradle.gherkin.snippet - package com.arc_e_tect.gradle.gherkin.snippet
count() - Method in record class com.arc_e_tect.gradle.gherkin.progress.StatusSummary: Returns the value of the count record component.

D

DEFAULT_OUTPUT_FILE_NAME - Static variable in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Default name of the generated AsciiDoc output file.
DEFAULT_SNIPPET_DIR - Static variable in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Default relative path of the directory report snippets are written to.
DEFAULT_SOURCE_DIR - Static variable in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Default relative path of the source directory containing .feature files.
Defaults - Search tag in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocPlugin: Section
DEFINED - Enum constant in enum class com.arc_e_tect.gradle.gherkin.progress.ScenarioStatus: The scenario has steps, but at least one step has no matching glue code.
DEFINED_BLURB - Static variable in class com.arc_e_tect.gradle.gherkin.progress.ReportText: Explanation of the defined status.

E

equals(Object) - Method in record class com.arc_e_tect.gradle.gherkin.parser.ScenarioInfo: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.arc_e_tect.gradle.gherkin.progress.ProgressReportOptions: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.arc_e_tect.gradle.gherkin.progress.StatusSummary: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.arc_e_tect.gradle.gherkin.snippet.FeatureSnippet: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.arc_e_tect.gradle.gherkin.snippet.StatusSnippets: Indicates whether some other object is "equal to" this one.

F

FEATURE - Enum constant in enum class com.arc_e_tect.gradle.gherkin.indexing.IndexingMode: Every feature is numbered, in the order its feature file is processed in - see GherkinToAsciidocExtension#getIndexing() for exactly what that order is - e.g.
FeatureIndexer - Class in com.arc_e_tect.gradle.gherkin.indexing: Numbers Feature/Scenario titles directly in the source .feature files according to a configured IndexingMode.
FeatureIndexer() - Constructor for class com.arc_e_tect.gradle.gherkin.indexing.FeatureIndexer: Creates a new FeatureIndexer.
FeatureNameFormatter - Class in com.arc_e_tect.gradle.gherkin.snippet: Converts a Feature title into a directory-safe camelCase name.
FeatureParser - Class in com.arc_e_tect.gradle.gherkin.parser: Parses a single Gherkin .feature file and extracts all scenarios.
FeatureParser() - Constructor for class com.arc_e_tect.gradle.gherkin.parser.FeatureParser: Creates a new FeatureParser with a pre-configured GherkinParser.
features() - Method in record class com.arc_e_tect.gradle.gherkin.snippet.StatusSnippets: Returns the value of the features record component.
FeatureSnippet - Record Class in com.arc_e_tect.gradle.gherkin.snippet: A single snippet file written for one Feature, within one status.
FeatureSnippet(String, File) - Constructor for record class com.arc_e_tect.gradle.gherkin.snippet.FeatureSnippet: Creates an instance of a FeatureSnippet record class.
featureTitle() - Method in record class com.arc_e_tect.gradle.gherkin.parser.ScenarioInfo: Returns the value of the featureTitle record component.
featureTitle() - Method in record class com.arc_e_tect.gradle.gherkin.snippet.FeatureSnippet: Returns the value of the featureTitle record component.
file() - Method in record class com.arc_e_tect.gradle.gherkin.snippet.FeatureSnippet: Returns the value of the file record component.
flatFile() - Method in record class com.arc_e_tect.gradle.gherkin.snippet.StatusSnippets: Returns the value of the flatFile record component.

G

generate() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Task action: collects .feature files, parses scenarios, and writes them to the configured AsciiDoc output file.
GenerateFeatureDocsTask - Class in com.arc_e_tect.gradle.gherkin: Gradle task that scans .feature files and writes all scenario titles to a single AsciiDoc file.
GenerateFeatureDocsTask() - Constructor for class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Creates a new task instance.
getGlueCodeDirs() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Directories containing the Cucumber-JVM glue code (step definitions).
getGlueCodeDirs() - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Directories containing the Cucumber-JVM glue code (step definitions) used to determine whether a scenario's steps are implemented.
getGroupByFeature() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Whether to group scenarios by their enclosing Feature instead of a flat list.
getGroupByFeature() - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Whether to group scenarios by their enclosing Feature in the generated AsciiDoc, instead of a flat list.
getIncludeSubDirs() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Whether to recursively scan sub-directories of every directory in GenerateFeatureDocsTask.getSourceDirs().
getIncludeSubDirs() - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Whether to recursively scan sub-directories of every configured directory in GherkinToAsciidocExtension.getSourceDirs().
getIndexing() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Whether - and how - to number Feature/Scenario titles directly in the source .feature files.
getIndexing() - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Whether - and how - to number Feature/Scenario titles directly in the source .feature files.
getOutputDir() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Directory where the generated AsciiDoc file will be written.
getOutputDir() - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Directory where the generated AsciiDoc file will be written.
getOutputFileName() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Name of the generated AsciiDoc file (without path).
getOutputFileName() - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Name of the generated AsciiDoc file (without path).
getProjectDirectory() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Root directory of the project, used to resolve the default source directory when neither GenerateFeatureDocsTask.getSourceDirs() nor GenerateFeatureDocsTask.getSourceFile() is set.
getSnippetDir() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Directory that report snippets (listed.adoc/defined.adoc/implemented.adoc) are written to when GenerateFeatureDocsTask.getTrackProgress() is true.
getSnippetDir() - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Directory that the listed.adoc/defined.adoc/implemented.adoc report snippets are written to when GherkinToAsciidocExtension.getTrackProgress() is true.
getSourceDirs() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Source directories containing the .feature files to process.
getSourceDirs() - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Source directories that contain the .feature files to process.
getSourceFile() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Optional single .feature file to process.
getSourceFile() - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: A single .feature file to process.
getSystemUnderTestVersion() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Version of the system under test that the reported Gherkin scenarios exercise, printed in the generated document as e.g.
getSystemUnderTestVersion() - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Version of the system under test that the reported Gherkin scenarios exercise, printed in the generated document as e.g.
getTemplate() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Optional Mustache template used to render the report so that it references the snippets via include:: directives instead of embedding their content verbatim.
getTemplate() - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Optional Mustache template used to render the generated AsciiDoc file so that it references the report snippets via include:: directives, instead of embedding their content verbatim.
getTrackProgress() - Method in class com.arc_e_tect.gradle.gherkin.GenerateFeatureDocsTask: Whether to classify scenarios as listed, defined, or implemented and include a progress summary in the generated AsciiDoc.
getTrackProgress() - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Whether to classify every scenario as listed, defined, or implemented and include a progress summary in the generated AsciiDoc.
GherkinToAsciidocExtension - Class in com.arc_e_tect.gradle.gherkin: DSL extension for the Gherkin-to-AsciiDoc Gradle plugin.
GherkinToAsciidocExtension() - Constructor for class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: For use by the Gradle-generated concrete subclass.
GherkinToAsciidocPlugin - Class in com.arc_e_tect.gradle.gherkin: Gradle plugin that registers the generateFeatureDocs task and wires the gherkinToAsciidoc DSL extension into the project.
GherkinToAsciidocPlugin() - Constructor for class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocPlugin: Creates a new plugin instance.
GlueCodeScanner - Class in com.arc_e_tect.gradle.gherkin.glue: Scans a directory of Cucumber-JVM glue code (step definition source files) and extracts every @Given/@When/@Then step definition pattern as a compiled Expression.
GlueCodeScanner() - Constructor for class com.arc_e_tect.gradle.gherkin.glue.GlueCodeScanner: Creates a new GlueCodeScanner.
groupByFeature() - Method in record class com.arc_e_tect.gradle.gherkin.progress.ProgressReportOptions: Returns the value of the groupByFeature record component.

H

hashCode() - Method in record class com.arc_e_tect.gradle.gherkin.parser.ScenarioInfo: Returns a hash code value for this object.
hashCode() - Method in record class com.arc_e_tect.gradle.gherkin.progress.ProgressReportOptions: Returns a hash code value for this object.
hashCode() - Method in record class com.arc_e_tect.gradle.gherkin.progress.StatusSummary: Returns a hash code value for this object.
hashCode() - Method in record class com.arc_e_tect.gradle.gherkin.snippet.FeatureSnippet: Returns a hash code value for this object.
hashCode() - Method in record class com.arc_e_tect.gradle.gherkin.snippet.StatusSnippets: Returns a hash code value for this object.

I

IMPLEMENTED - Enum constant in enum class com.arc_e_tect.gradle.gherkin.progress.ScenarioStatus: The scenario has steps and every step has matching glue code.
IMPLEMENTED_BLURB - Static variable in class com.arc_e_tect.gradle.gherkin.progress.ReportText: Explanation of the implemented status.
INDEXING_OVERRIDE_PROPERTY - Static variable in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Name of the Gradle project property that overrides GherkinToAsciidocExtension.getIndexing() from the command line for every project in the build, e.g.
IndexingMode - Enum Class in com.arc_e_tect.gradle.gherkin.indexing: Controls whether Feature/Scenario titles are numbered directly in the source .feature files, as configured via the indexing DSL property.
INTRO - Static variable in class com.arc_e_tect.gradle.gherkin.progress.ReportText: One-sentence description of what the generated document contains.

L

label() - Method in record class com.arc_e_tect.gradle.gherkin.progress.StatusSummary: Returns the value of the label record component.
LISTED - Enum constant in enum class com.arc_e_tect.gradle.gherkin.progress.ScenarioStatus: The scenario has a title only; it has no Given/When/Then steps yet.
LISTED_BLURB - Static variable in class com.arc_e_tect.gradle.gherkin.progress.ReportText: Explanation of the listed status.

M

Multi-project builds - Search tag in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocPlugin: Section

N

NAME - Static variable in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocExtension: Extension DSL block name, i.e.

O

OFF - Enum constant in enum class com.arc_e_tect.gradle.gherkin.indexing.IndexingMode: Nothing is numbered.
Overriding indexing from the command line - Search tag in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocPlugin: Section

P

parse(File) - Method in class com.arc_e_tect.gradle.gherkin.parser.FeatureParser: Parses the given .feature file and returns all scenarios.
percentage() - Method in record class com.arc_e_tect.gradle.gherkin.progress.StatusSummary: Returns the value of the percentage record component.
ProgressReportOptions - Record Class in com.arc_e_tect.gradle.gherkin.progress: Configuration for ProgressReportWriter.
ProgressReportOptions(boolean, File, File, String) - Constructor for record class com.arc_e_tect.gradle.gherkin.progress.ProgressReportOptions: Creates an instance of a ProgressReportOptions record class.
ProgressReportWriter - Class in com.arc_e_tect.gradle.gherkin.progress: Writes an AsciiDoc progress report that breaks scenarios down by ScenarioStatus and summarises the breakdown as a table of counts and percentages.
ProgressReportWriter() - Constructor for class com.arc_e_tect.gradle.gherkin.progress.ProgressReportWriter: Creates a new ProgressReportWriter.

R

reindex(List<File>, IndexingMode) - Method in class com.arc_e_tect.gradle.gherkin.indexing.FeatureIndexer: Rewrites every file in featureFiles in place: strips any Feature/ Scenario numbering added by a previous run, then applies numbering per mode.
render(File, File, String, List<StatusSummary>, Map<ScenarioStatus, StatusSnippets>) - Method in class com.arc_e_tect.gradle.gherkin.progress.ReportTemplateRenderer: Renders template to outputFile, using summaries and snippets to build the Mustache context.
ReportTemplateRenderer - Class in com.arc_e_tect.gradle.gherkin.progress: Renders a progress report from a user-supplied Mustache template, so that the generated AsciiDoc file references the snippets written by SnippetWriter via include:: directives instead of embedding their content verbatim.
ReportTemplateRenderer() - Constructor for class com.arc_e_tect.gradle.gherkin.progress.ReportTemplateRenderer: Creates a new ReportTemplateRenderer.
ReportText - Class in com.arc_e_tect.gradle.gherkin.progress: Shared explanatory text used by both ProgressReportWriter and ReportTemplateRenderer.

S

scan(File) - Method in class com.arc_e_tect.gradle.gherkin.glue.GlueCodeScanner: Recursively scans glueCodeDir for step definition source files and returns every step pattern found as a compiled Expression.
SCENARIO - Enum constant in enum class com.arc_e_tect.gradle.gherkin.indexing.IndexingMode: Every scenario is numbered, continuously across all feature files, in the same file processing order as IndexingMode.FEATURE, e.g.
ScenarioClassifier - Class in com.arc_e_tect.gradle.gherkin.progress: Classifies a ScenarioInfo as ScenarioStatus.LISTED, ScenarioStatus.DEFINED, or ScenarioStatus.IMPLEMENTED based on whether it has steps, and whether every step has matching glue code.
ScenarioClassifier() - Constructor for class com.arc_e_tect.gradle.gherkin.progress.ScenarioClassifier: Creates a new ScenarioClassifier.
ScenarioGrouping - Class in com.arc_e_tect.gradle.gherkin.parser: Groups ScenarioInfo instances by the Feature they belong to.
ScenarioInfo - Record Class in com.arc_e_tect.gradle.gherkin.parser: Immutable description of a single scenario parsed from a .feature file.
ScenarioInfo(String, String, List<String>) - Constructor for record class com.arc_e_tect.gradle.gherkin.parser.ScenarioInfo: Defensively copies steps into an immutable list.
scenarios() - Method in record class com.arc_e_tect.gradle.gherkin.progress.StatusSummary: Returns the value of the scenarios record component.
ScenarioStatus - Enum Class in com.arc_e_tect.gradle.gherkin.progress: Implementation progress of a single scenario, as tracked when trackProgress is enabled.
snippetDir() - Method in record class com.arc_e_tect.gradle.gherkin.progress.ProgressReportOptions: Returns the value of the snippetDir record component.
SnippetWriter - Class in com.arc_e_tect.gradle.gherkin.snippet: Writes the listed.adoc/defined.adoc/implemented.adoc snippet files that back a progress report's include:: directives.
SnippetWriter() - Constructor for class com.arc_e_tect.gradle.gherkin.snippet.SnippetWriter: Creates a new SnippetWriter.
status() - Method in record class com.arc_e_tect.gradle.gherkin.progress.StatusSummary: Returns the value of the status record component.
StatusSnippets - Record Class in com.arc_e_tect.gradle.gherkin.snippet: The snippet file(s) written for one ScenarioStatus.
StatusSnippets(List<FeatureSnippet>, File) - Constructor for record class com.arc_e_tect.gradle.gherkin.snippet.StatusSnippets: Creates an instance of a StatusSnippets record class.
StatusSummary - Record Class in com.arc_e_tect.gradle.gherkin.progress: The scenarios classified under one ScenarioStatus, along with the display text and summary figures used to render that status's heading, blurb, and summary table row.
StatusSummary(ScenarioStatus, String, String, List<ScenarioInfo>, int, String) - Constructor for record class com.arc_e_tect.gradle.gherkin.progress.StatusSummary: Creates an instance of a StatusSummary record class.
steps() - Method in record class com.arc_e_tect.gradle.gherkin.parser.ScenarioInfo: Returns the value of the steps record component.
systemUnderTestVersion() - Method in record class com.arc_e_tect.gradle.gherkin.progress.ProgressReportOptions: Returns the value of the systemUnderTestVersion record component.

T

TASK_NAME - Static variable in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocPlugin: Name of the Gradle task registered by this plugin.
template() - Method in record class com.arc_e_tect.gradle.gherkin.progress.ProgressReportOptions: Returns the value of the template record component.
title() - Method in record class com.arc_e_tect.gradle.gherkin.parser.ScenarioInfo: Returns the value of the title record component.
toDirectoryName(String) - Static method in class com.arc_e_tect.gradle.gherkin.snippet.FeatureNameFormatter: Converts featureTitle into camelCase with no spaces, e.g.
toString() - Method in record class com.arc_e_tect.gradle.gherkin.parser.ScenarioInfo: Returns a string representation of this record class.
toString() - Method in record class com.arc_e_tect.gradle.gherkin.progress.ProgressReportOptions: Returns a string representation of this record class.
toString() - Method in record class com.arc_e_tect.gradle.gherkin.progress.StatusSummary: Returns a string representation of this record class.
toString() - Method in record class com.arc_e_tect.gradle.gherkin.snippet.FeatureSnippet: Returns a string representation of this record class.
toString() - Method in record class com.arc_e_tect.gradle.gherkin.snippet.StatusSnippets: Returns a string representation of this record class.

U

Usage - Search tag in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocPlugin: Section

V

valueOf(String) - Static method in enum class com.arc_e_tect.gradle.gherkin.indexing.IndexingMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.arc_e_tect.gradle.gherkin.progress.ScenarioStatus: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.arc_e_tect.gradle.gherkin.indexing.IndexingMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.arc_e_tect.gradle.gherkin.progress.ScenarioStatus: Returns an array containing the constants of this enum class, in the order they are declared.

W

write(File, List<ScenarioInfo>, List<Expression>, ProgressReportOptions) - Method in class com.arc_e_tect.gradle.gherkin.progress.ProgressReportWriter: Classifies every scenario, writes the snippet files, and writes the progress report to outputFile.
writeStatus(File, ScenarioStatus, List<ScenarioInfo>, boolean) - Method in class com.arc_e_tect.gradle.gherkin.snippet.SnippetWriter: Writes the snippet file(s) for a single status.

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values