org.unitils.jbehave.core.parsers

Class RegexStoryParserExtended

java.lang.Object

org.jbehave.core.parsers.RegexStoryParser

org.unitils.jbehave.core.parsers.RegexStoryParserExtended

All Implemented Interfaces:

org.jbehave.core.parsers.StoryParser

public class RegexStoryParserExtended
extends org.jbehave.core.parsers.RegexStoryParser

extended RegexStoryParser: the comments shouldn't be added to the description.

Since:

1.0.1

Author:

Willemijn Wouters

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	LOGGER

Constructor Summary

Constructors

Constructor and Description
RegexStoryParserExtended()
RegexStoryParserExtended(org.jbehave.core.model.ExamplesTableFactory tableFactory)
RegexStoryParserExtended(org.jbehave.core.configuration.Keywords keywords)
RegexStoryParserExtended(org.jbehave.core.configuration.Keywords keywords, org.jbehave.core.model.ExamplesTableFactory tableFactory)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	concatenateWithOr(String... keywords) concatenate the keywords with an | in between, f.e.: keyword1|keyword2|keyword3 .
protected String	concatenateWithOr(String beforeKeyword, String afterKeyword, String[] keywords) concatenate the keywords with an | in between, f.e.: before keyword1 after|before keyword2 after|before keyword3 after.
protected org.jbehave.core.model.Narrative	createNarrative(String narrative) This method pulls the narrative out of the story text.
protected org.jbehave.core.model.ExamplesTable	findExamplesTable(String scenarioAsText) This method finds the ExamplesTable out of the story text.
protected String	findOutcome(String stepsByOutcome) This method looks for the outcome of a step.
protected org.jbehave.core.model.GivenStories	findScenarioGivenStories(String scenarioAsText) This method finds all the GivenStories out of the story text.
protected org.jbehave.core.model.Meta	findScenarioMeta(String scenarioAsText) This method looks for the Meta data in the store text.
protected String	findScenarioTitle(String scenarioAsText) This method looks for the scenario title in the story text.
protected List<String>	findSteps(String stepsAsText) This method gets all the different steps out of the story text.
protected org.jbehave.core.model.Lifecycle.Steps[]	parseAfterLifecycle(String lifecycleAsText) This method parses all the steps after the Keywords.lifecycle() in the story text.
protected org.jbehave.core.model.Lifecycle.Steps	parseBeforeLifecycle(String lifecycleAsText) parses the steps before the lifecycle.
protected org.jbehave.core.model.Description	parseDescriptionFrom(String storyAsText) Parse the entire Description out of the story text.
protected org.jbehave.core.model.GivenStories	parseGivenStories(String storyAsText) Gets all the GivenStories out of the story text.
protected org.jbehave.core.model.Lifecycle	parseLifecycle(String storyAsText) Parses the Lifecycle out of the story text.
protected org.jbehave.core.model.Narrative	parseNarrativeFrom(String storyAsText) This method pulls the Narrative out of the story text.
protected org.jbehave.core.annotations.AfterScenario.Outcome	parseOutcome(String outcomeAsText) This method parses the outcome out of the story text.
protected org.jbehave.core.model.Scenario	parseScenario(String scenarioAsText) This method pulls the entire Scenario out of the story text.
protected List<org.jbehave.core.model.Scenario>	parseScenariosFrom(String storyAsText) This method parses the story text in diffenent Scenarios.
org.jbehave.core.model.Story	parseStory(String storyAsText, String storyPath)
protected org.jbehave.core.model.Meta	parseStoryMetaFrom(String storyAsText) This method parses all the meta data from the story text.
protected Pattern	patternToPullAlternativeNarrativeElementsIntoGroups() Creates a regex pattern to get all the alternative Narratives out of the story text.
protected Pattern	patternToPullDescriptionIntoGroupOne() This method creates a regex Pattern to get the description out of Meta, Narrative, Lifecycle, Scenarios.
protected Pattern	patternToPullExamplesTableIntoGroupOne() create a regex pattern to look for the ExamplesTable.
protected Pattern	patternToPullLifecycleIntoGroupOne() This method creates the regex expression to pull the Lifecycle out of the story text.
protected Pattern	patternToPullLifecycleOutcomeIntoGroupOne() This method creates the regex pattern to get the lifecycle out of the story text.
protected Pattern	patternToPullNarrativeElementsIntoGroups() Creates a regex pattern to get all the Narratives out of the story text.
protected Pattern	patternToPullNarrativeIntoGroupOne() Creates a regex Pattern to get all the Narratives out of the first group.
protected Pattern	patternToPullScenarioGivenStoriesIntoGroupOne() Create a regex pattern to get the Keywords.givenStories() out of the story text.
protected Pattern	patternToPullScenarioMetaIntoGroupOne() Create a regex pattern to get all the Meta information out of the story text.
protected Pattern	patternToPullScenarioTitleIntoGroupOne() Creates a regex pattern to get the scenario title out of the story text.
protected Pattern	patternToPullStepsIntoGroupOne() We removed the Keywords.ignorable() keyword out of the list.
protected Pattern	patternToPullStoryGivenStoriesIntoGroupOne() This method is used to create the regex pattern to parse the GivenStories out of the story text.
protected Pattern	patternToPullStoryMetaIntoGroupOne() create a regex Pattern to get the Meta data out of the story text.
protected String	preScenarioText(String storyAsText) Get the pre-scenario text out of the story text.
protected List<String>	splitScenarios(String storyAsText) This methods looks for the word Keywords.scenario() in the story text and splits the story text up in diffent strings (the scenarios).
protected String	startingWithNL(String text) ensure that the text starts on a new line.

Methods inherited from class org.jbehave.core.parsers.RegexStoryParser

parseStory

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.apache.commons.logging.Log LOGGER

Constructor Detail

RegexStoryParserExtended

public RegexStoryParserExtended()

RegexStoryParserExtended

public RegexStoryParserExtended(org.jbehave.core.model.ExamplesTableFactory tableFactory)

Parameters:

tableFactory - : the factory that creates the ExamplesTable.

RegexStoryParserExtended

public RegexStoryParserExtended(org.jbehave.core.configuration.Keywords keywords)

Parameters:

keywords - : the Keywords used by JBehave.

RegexStoryParserExtended

public RegexStoryParserExtended(org.jbehave.core.configuration.Keywords keywords,
                        org.jbehave.core.model.ExamplesTableFactory tableFactory)

Parameters:

keywords - : the Keywords used by JBehave.

tableFactory - : the factory that creates the ExamplesTable.

Method Detail

parseStory

public org.jbehave.core.model.Story parseStory(String storyAsText,
                                      String storyPath)

Specified by:

parseStory in interface org.jbehave.core.parsers.StoryParser

Overrides:

parseStory in class org.jbehave.core.parsers.RegexStoryParser

Parameters:

storyAsText - : the entire story as text

storyPath - : the path of the story

Returns:

Story

See Also:

RegexStoryParser.parseStory(java.lang.String, java.lang.String)

parseDescriptionFrom

protected org.jbehave.core.model.Description parseDescriptionFrom(String storyAsText)

Parse the entire Description out of the story text.

Parameters:

storyAsText - : the entire story as text.

Returns:

Description

parseStoryMetaFrom

protected org.jbehave.core.model.Meta parseStoryMetaFrom(String storyAsText)

This method parses all the meta data from the story text.

Parameters:

storyAsText - : the entire story as text.

Returns:

Meta

See Also:

meta info

preScenarioText

protected String preScenarioText(String storyAsText)

Get the pre-scenario text out of the story text.

Parameters:

storyAsText - : the entire story as text.

Returns:

String

parseNarrativeFrom

protected org.jbehave.core.model.Narrative parseNarrativeFrom(String storyAsText)

This method pulls the Narrative out of the story text.

Parameters:

storyAsText - : the entire story as text.

Returns:

Narrative

createNarrative

protected org.jbehave.core.model.Narrative createNarrative(String narrative)

This method pulls the narrative out of the story text.

Parameters:

narrative - : the narrative as plain text.

Returns:

Narrative

See Also:

narrative

parseGivenStories

protected org.jbehave.core.model.GivenStories parseGivenStories(String storyAsText)

Gets all the GivenStories out of the story text.

Parameters:

storyAsText - : the entire story as text.

Returns:

GivenStories

See Also:

given stories

parseLifecycle

protected org.jbehave.core.model.Lifecycle parseLifecycle(String storyAsText)

Parses the Lifecycle out of the story text.

Parameters:

storyAsText - : the entire story as text.

Returns:

Lifecycle

parseBeforeLifecycle

protected org.jbehave.core.model.Lifecycle.Steps parseBeforeLifecycle(String lifecycleAsText)

parses the steps before the lifecycle.

Parameters:

lifecycleAsText - : the entire lifecycle as text.

Returns:

Lifecycle.Steps

parseAfterLifecycle

protected org.jbehave.core.model.Lifecycle.Steps[] parseAfterLifecycle(String lifecycleAsText)

This method parses all the steps after the Keywords.lifecycle() in the story text.

Parameters:

lifecycleAsText - : the entire lifecycle as text.

Returns:

Array

parseOutcome

protected org.jbehave.core.annotations.AfterScenario.Outcome parseOutcome(String outcomeAsText)

This method parses the outcome out of the story text.

Parameters:

outcomeAsText - : the outcome as plain text.

Returns:

AfterScenario.Outcome

See Also:

syntax story

findOutcome

protected String findOutcome(String stepsByOutcome)

This method looks for the outcome of a step.

Parameters:

stepsByOutcome - : all the steps by outcome.

Returns:

String

See Also:

syntax story

parseScenariosFrom

protected List<org.jbehave.core.model.Scenario> parseScenariosFrom(String storyAsText)

This method parses the story text in diffenent Scenarios.

Parameters:

storyAsText - : the entire story as text.

Returns:

List

splitScenarios

protected List<String> splitScenarios(String storyAsText)

This methods looks for the word Keywords.scenario() in the story text and splits the story text up in diffent strings (the scenarios).

Parameters:

storyAsText - : the entire story as text.

Returns:

List

parseScenario

protected org.jbehave.core.model.Scenario parseScenario(String scenarioAsText)

This method pulls the entire Scenario out of the story text.

Parameters:

scenarioAsText - : the entire scenario as plain text.

Returns:

Scenario

startingWithNL

protected String startingWithNL(String text)

ensure that the text starts on a new line.

Parameters:

text - : the text that needs to be checked

Returns:

String

findScenarioTitle

protected String findScenarioTitle(String scenarioAsText)

This method looks for the scenario title in the story text.

Parameters:

scenarioAsText - : the entire scenario as plain text.

Returns:

String

findScenarioMeta

protected org.jbehave.core.model.Meta findScenarioMeta(String scenarioAsText)

This method looks for the Meta data in the store text.

Parameters:

scenarioAsText - : the entire scenario as plain text.

Returns:

Meta

See Also:

meta

findExamplesTable

protected org.jbehave.core.model.ExamplesTable findExamplesTable(String scenarioAsText)

This method finds the ExamplesTable out of the story text.

Parameters:

scenarioAsText - : the entire scenario as plain text.

Returns:

ExamplesTable

See Also:

examples table

findScenarioGivenStories

protected org.jbehave.core.model.GivenStories findScenarioGivenStories(String scenarioAsText)

This method finds all the GivenStories out of the story text.

Parameters:

scenarioAsText - : the entire scenario as plain text.

Returns:

GivenStories

See Also:

given stories

findSteps

protected List<String> findSteps(String stepsAsText)

This method gets all the different steps out of the story text.

Parameters:

stepsAsText - : all the steps as one plain text.

Returns:

List

See Also:

steps

patternToPullDescriptionIntoGroupOne

protected Pattern patternToPullDescriptionIntoGroupOne()

This method creates a regex Pattern to get the description out of Meta, Narrative, Lifecycle, Scenarios.

Returns:

Pattern

patternToPullStoryMetaIntoGroupOne

protected Pattern patternToPullStoryMetaIntoGroupOne()

create a regex Pattern to get the Meta data out of the story text.

Returns:

Pattern

patternToPullNarrativeIntoGroupOne

protected Pattern patternToPullNarrativeIntoGroupOne()

Creates a regex Pattern to get all the Narratives out of the first group.

Returns:

Pattern

patternToPullNarrativeElementsIntoGroups

protected Pattern patternToPullNarrativeElementsIntoGroups()

Creates a regex pattern to get all the Narratives out of the story text.

Returns:

Pattern

See Also:

grammer

patternToPullAlternativeNarrativeElementsIntoGroups

protected Pattern patternToPullAlternativeNarrativeElementsIntoGroups()

Creates a regex pattern to get all the alternative Narratives out of the story text.

Returns:

Pattern

See Also:

grammer

patternToPullStoryGivenStoriesIntoGroupOne

protected Pattern patternToPullStoryGivenStoriesIntoGroupOne()

This method is used to create the regex pattern to parse the GivenStories out of the story text.

Returns:

Pattern

patternToPullLifecycleIntoGroupOne

protected Pattern patternToPullLifecycleIntoGroupOne()

This method creates the regex expression to pull the Lifecycle out of the story text.

Returns:

Pattern

patternToPullLifecycleOutcomeIntoGroupOne

protected Pattern patternToPullLifecycleOutcomeIntoGroupOne()

This method creates the regex pattern to get the lifecycle out of the story text.

Returns:

Pattern

See Also:

story-syntax

patternToPullScenarioTitleIntoGroupOne

protected Pattern patternToPullScenarioTitleIntoGroupOne()

Creates a regex pattern to get the scenario title out of the story text.

Returns:

Pattern

patternToPullScenarioMetaIntoGroupOne

protected Pattern patternToPullScenarioMetaIntoGroupOne()

Create a regex pattern to get all the Meta information out of the story text.

Returns:

Pattern

patternToPullScenarioGivenStoriesIntoGroupOne

protected Pattern patternToPullScenarioGivenStoriesIntoGroupOne()

Create a regex pattern to get the Keywords.givenStories() out of the story text.

Returns:

Pattern

patternToPullStepsIntoGroupOne

protected Pattern patternToPullStepsIntoGroupOne()

We removed the Keywords.ignorable() keyword out of the list. In the original code JBehave will put all the comments in the Description. And this is something that we don't want.

Returns:

Pattern

patternToPullExamplesTableIntoGroupOne

protected Pattern patternToPullExamplesTableIntoGroupOne()

create a regex pattern to look for the ExamplesTable.

Returns:

Pattern

concatenateWithOr

protected String concatenateWithOr(String... keywords)

concatenate the keywords with an | in between, f.e.: keyword1|keyword2|keyword3 .

Parameters:

keywords - : the strings that needs to be concatenated.

Returns:

String

concatenateWithOr

protected String concatenateWithOr(String beforeKeyword,
                       String afterKeyword,
                       String[] keywords)

concatenate the keywords with an | in between, f.e.: before keyword1 after|before keyword2 after|before keyword3 after.

Parameters:

beforeKeyword - : the keyword that should be appended before each element of the param keywords.

afterKeyword - : the keyword that should be appended after each element of the param keywords.

keywords - : the Keywords used by JBehave.

Returns:

String