Index (gherkin-to-asciidoc 1.0.0 API)

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

A

apply(Project) - Method in class com.arc_e_tect.gradle.gherkin.GherkinToAsciidocPlugin

C

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.parser - package com.arc_e_tect.gradle.gherkin.parser
com.arc_e_tect.gradle.gherkin.progress - package com.arc_e_tect.gradle.gherkin.progress

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

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.

F

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.

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.
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().
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.
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.
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.

H

hashCode() - Method in record class com.arc_e_tect.gradle.gherkin.parser.ScenarioInfo: 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.

L

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.

N

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

P

parse(File) - Method in class com.arc_e_tect.gradle.gherkin.parser.FeatureParser: Parses the given .feature file and returns all scenarios.
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.

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.
ScenarioClassifier - Class in com.arc_e_tect.gradle.gherkin.progress: Classifies a ScenarioInfo as LISTED, DEFINED, or 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.
ScenarioInfo - Record Class in com.arc_e_tect.gradle.gherkin.parser: Immutable description of a single scenario parsed from a .feature file.
ScenarioInfo(String, List<String>) - Constructor for record class com.arc_e_tect.gradle.gherkin.parser.ScenarioInfo: Defensively copies steps into an immutable list.
ScenarioStatus - Enum Class in com.arc_e_tect.gradle.gherkin.progress: Implementation progress of a single scenario, as tracked when trackProgress is enabled.
steps() - Method in record class com.arc_e_tect.gradle.gherkin.parser.ScenarioInfo: Returns the value of the steps 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.
title() - Method in record class com.arc_e_tect.gradle.gherkin.parser.ScenarioInfo: Returns the value of the title record component.
toString() - Method in record class com.arc_e_tect.gradle.gherkin.parser.ScenarioInfo: 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.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.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>) - Method in class com.arc_e_tect.gradle.gherkin.progress.ProgressReportWriter: Classifies every scenario and writes the progress report to outputFile.

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