JBEHAVE-1450 Removed CrossReference.

jbehave · Jan 22, 2021 · 9546f60 · 9546f60
1 parent 32627a4
commit 9546f60
Show file tree

Hide file tree

Showing 18 changed files with 12 additions and 586 deletions.
diff --git a/distribution/src/site/content/configuration.html b/distribution/src/site/content/configuration.html
@@ -190,8 +190,6 @@ <h3>Using ConfigurableEmbedder</h3>
 <![CDATA[
 public abstract class TraderStory extends JUnitStory {
 
-    private final CrossReference xref = new CrossReference();
-
     public TraderStory() {
         configuredEmbedder().embedderControls().doGenerateViewAfterStories(true).doIgnoreFailureInStories(true)
                 .doIgnoreFailureInView(true).useThreads(2).useStoryTimeoutInSecs(60);
@@ -224,7 +222,7 @@ <h3>Using ConfigurableEmbedder</h3>
                                 .withCodeLocation(CodeLocations.codeLocationFromClass(embeddableClass))
                                 .withDefaultFormats().withPathResolver(new ResolveToPackagedName())
                                 .withViewResources(viewResources).withFormats(CONSOLE, TXT, HTML, XML)
-                                .withFailureTrace(true).withFailureTraceCompression(true).withCrossReference(xref))
+                                .withFailureTrace(true).withFailureTraceCompression(true))
                 .useParameterConverters(parameterConverters)
                 // use '%' instead of '$' to identify parameters
                 .useStepPatternParser(new RegexPrefixCapturingPatternParser("%")) 

diff --git a/distribution/src/site/content/cross-reference.html b/distribution/src/site/content/cross-reference.html
diff --git a/distribution/src/site/content/developing-stories.html b/distribution/src/site/content/developing-stories.html
@@ -148,8 +148,6 @@ <h3>JUnit-enabled Embeddables</h3>
 <![CDATA[
 public abstract class TraderStory extends JUnitStory {
 
-    private final CrossReference xref = new CrossReference();
-
     public TraderStory() {
         configuredEmbedder().embedderControls().doGenerateViewAfterStories(true).doIgnoreFailureInStories(true)
                 .doIgnoreFailureInView(true).useThreads(2).useStoryTimeoutInSecs(60);
@@ -182,7 +180,7 @@ <h3>JUnit-enabled Embeddables</h3>
                                 .withCodeLocation(CodeLocations.codeLocationFromClass(embeddableClass))
                                 .withDefaultFormats().withPathResolver(new ResolveToPackagedName())
                                 .withViewResources(viewResources).withFormats(CONSOLE, TXT, HTML, XML)
-                                .withFailureTrace(true).withFailureTraceCompression(true).withCrossReference(xref))
+                                .withFailureTrace(true).withFailureTraceCompression(true))
                 .useParameterConverters(parameterConverters)
                 // use '%' instead of '$' to identify parameters
                 .useStepPatternParser(new RegexPrefixCapturingPatternParser("%")) 
@@ -210,8 +208,6 @@ <h3>JUnit-enabled Embeddables</h3>
 <![CDATA[
 public class TraderStories extends JUnitStories {
 
-    private final CrossReference xref = new CrossReference();
-
     public TraderStories() {
         configuredEmbedder().embedderControls().doGenerateViewAfterStories(true).doIgnoreFailureInStories(false)
                 .doIgnoreFailureInView(true).doVerboseFailures(true).useThreads(2).useStoryTimeoutInSecs(60);
@@ -240,8 +236,7 @@ <h3>JUnit-enabled Embeddables</h3>
                 .withViewResources(viewResources)
                 .withFormats(CONSOLE, TXT, HTML_TEMPLATE, XML_TEMPLATE)
                 .withFailureTrace(true)
-                .withFailureTraceCompression(true)                
-                .withCrossReference(xref)) 
+                .withFailureTraceCompression(true))
             .useParameterConverters(parameterConverters)                     
             // use '%' instead of '$' to identify parameters
             .useStepPatternParser(new RegexPrefixCapturingPatternParser(

diff --git a/distribution/src/site/content/reporting-stories.html b/distribution/src/site/content/reporting-stories.html
@@ -53,8 +53,6 @@ <h2>Story Reporters</h2>
 <![CDATA[
 public abstract class TraderStory extends JUnitStory {
 
-    private final CrossReference xref = new CrossReference();
-
     public TraderStory() {
         configuredEmbedder().embedderControls().doGenerateViewAfterStories(true).doIgnoreFailureInStories(true)
                 .doIgnoreFailureInView(true).useThreads(2).useStoryTimeoutInSecs(60);
@@ -87,7 +85,7 @@ <h2>Story Reporters</h2>
                                 .withCodeLocation(CodeLocations.codeLocationFromClass(embeddableClass))
                                 .withDefaultFormats().withPathResolver(new ResolveToPackagedName())
                                 .withViewResources(viewResources).withFormats(CONSOLE, TXT, HTML, XML)
-                                .withFailureTrace(true).withFailureTraceCompression(true).withCrossReference(xref))
+                                .withFailureTrace(true).withFailureTraceCompression(true))
                 .useParameterConverters(parameterConverters)
                 // use '%' instead of '$' to identify parameters
                 .useStepPatternParser(new RegexPrefixCapturingPatternParser("%")) 

diff --git a/distribution/src/site/content/running-stories.html b/distribution/src/site/content/running-stories.html
@@ -105,8 +105,7 @@ <h2>Running Stories in a framework-neutral way</h2>
             .useStoryReporterBuilder(new StoryReporterBuilder()
                 .withCodeLocation(CodeLocations.codeLocationFromClass(embedderClass))
                 .withDefaultFormats()
-                .withFormats(CONSOLE, TXT, HTML, XML)
-                .withCrossReference(new CrossReference()))
+                .withFormats(CONSOLE, TXT, HTML, XML))
             .useParameterConverters(new ParameterConverters()
                     .addConverters(new DateConverter(new SimpleDateFormat("yyyy-MM-dd")))) // use custom date pattern
             .useStepPatternParser(new RegexPrefixCapturingPatternParser(

diff --git a/distribution/src/site/content/sitemap.xml b/distribution/src/site/content/sitemap.xml
@@ -64,7 +64,6 @@
     <page>story-mapping.html</page>
     <page>story-timeouts.html</page>
     <page>story-transformers.html</page>
-    <page>cross-reference.html</page>
     <page>surefire-reporter.html</page>
     <page>context-view.html</page>
     <page>multi-threading.html</page>    

diff --git a/examples/core/src/main/java/org/jbehave/examples/core/CoreEmbedder.java b/examples/core/src/main/java/org/jbehave/examples/core/CoreEmbedder.java
@@ -10,7 +10,6 @@
 import org.jbehave.core.io.LoadFromClasspath;
 import org.jbehave.core.model.TableTransformers;
 import org.jbehave.core.parsers.RegexPrefixCapturingPatternParser;
-import org.jbehave.core.reporters.CrossReference;
 import org.jbehave.core.reporters.StoryReporterBuilder;
 import org.jbehave.core.steps.InjectableStepsFactory;
 import org.jbehave.core.steps.InstanceStepsFactory;
@@ -47,8 +46,7 @@ public Configuration configuration() {
             .useStoryReporterBuilder(new StoryReporterBuilder()
                 .withCodeLocation(CodeLocations.codeLocationFromClass(embedderClass))
                 .withDefaultFormats()
-                .withFormats(CONSOLE, TXT, HTML, XML)
-                .withCrossReference(new CrossReference()))
+                .withFormats(CONSOLE, TXT, HTML, XML))
             .useTableTransformers(tableTransformers)
             .useParameterConverters(new ParameterConverters(resourceLoader, tableTransformers)
                     .addConverters(new DateConverter(new SimpleDateFormat("yyyy-MM-dd")))) // use custom date pattern

diff --git a/examples/core/src/main/java/org/jbehave/examples/core/CoreStories.java b/examples/core/src/main/java/org/jbehave/examples/core/CoreStories.java
@@ -42,7 +42,6 @@
  */
 public class CoreStories extends JUnitStories {
 
-    private final CrossReference xref = new CrossReference();
     private Context context = new Context();
     private Format contextFormat = new ContextOutput(context);
 
@@ -87,7 +86,7 @@ public Configuration configuration() {
                                 .withCodeLocation(codeLocationFromClass(embeddableClass))
                                 .withDefaultFormats().withViewResources(viewResources)
                                 .withFormats(contextFormat, ANSI_CONSOLE, TXT, HTML_TEMPLATE, XML_TEMPLATE).withFailureTrace(true)
-                                .withFailureTraceCompression(true).withCrossReference(xref)
+                                .withFailureTraceCompression(true)
                                 .withSurefireReporter(surefireReporter))
                 .useParameterConverters(parameterConverters)
                 .useParameterControls(parameterControls)

diff --git a/examples/core/src/main/java/org/jbehave/examples/core/CoreStory.java b/examples/core/src/main/java/org/jbehave/examples/core/CoreStory.java
@@ -21,7 +21,6 @@
 import org.jbehave.core.model.TableParsers;
 import org.jbehave.core.model.TableTransformers;
 import org.jbehave.core.parsers.RegexStoryParser;
-import org.jbehave.core.reporters.CrossReference;
 import org.jbehave.core.reporters.FilePrintStreamFactory.ResolveToPackagedName;
 import org.jbehave.core.reporters.StoryReporterBuilder;
 import org.jbehave.core.steps.InjectableStepsFactory;
@@ -51,8 +50,6 @@
  */
 public abstract class CoreStory extends JUnitStory {
 
-    private final CrossReference xref = new CrossReference();
-
     public CoreStory() {
         configuredEmbedder().embedderControls().doGenerateViewAfterStories(true).doIgnoreFailureInStories(false)
                 .doIgnoreFailureInView(true).useThreads(1).useStoryTimeouts("60");
@@ -88,7 +85,6 @@ public Configuration configuration() {
                                 .withCodeLocation(CodeLocations.codeLocationFromClass(embeddableClass))
                                 .withDefaultFormats().withPathResolver(new ResolveToPackagedName())
                                 .withViewResources(viewResources).withFormats(CONSOLE, TXT, HTML_TEMPLATE, XML)
-                                .withCrossReference(xref)
                                 .withFailureTrace(true).withFailureTraceCompression(true))
                 .useParameterConverters(parameterConverters)
                 .useParameterControls(parameterControls)

diff --git a/examples/core/src/main/java/org/jbehave/examples/core/JFrameCoreStories.java b/examples/core/src/main/java/org/jbehave/examples/core/JFrameCoreStories.java
@@ -4,10 +4,8 @@
 import org.jbehave.core.context.Context;
 import org.jbehave.core.context.ContextView;
 import org.jbehave.core.context.JFrameContextView;
-import org.jbehave.core.reporters.ContextOutput;
-import org.jbehave.core.reporters.CrossReference;
-import org.jbehave.core.reporters.Format;
 import org.jbehave.core.steps.ContextStepMonitor;
+import org.jbehave.core.steps.NullStepMonitor;
 
 /**
  * <p>
@@ -16,11 +14,9 @@
  */
 public class JFrameCoreStories extends CoreStories {
 
-    private final CrossReference xref = new CrossReference();
     private Context context = new Context();
-    private Format contextFormat = new ContextOutput(context);
     private ContextView contextView = new JFrameContextView().sized(640, 120);
-    private ContextStepMonitor contextStepMonitor = new ContextStepMonitor(context, contextView, xref.getStepMonitor());
+    private ContextStepMonitor contextStepMonitor = new ContextStepMonitor(context, contextView, new NullStepMonitor());
 
     @Override
     public Configuration configuration() {

diff --git a/jbehave-core/src/main/java/org/jbehave/core/embedder/Embedder.java b/jbehave-core/src/main/java/org/jbehave/core/embedder/Embedder.java
@@ -283,13 +283,6 @@ private void handleFailures(ReportsCount count) {
         }
     }
 
-    public void generateCrossReference() {
-        StoryReporterBuilder builder = configuration().storyReporterBuilder();
-        if (builder.hasCrossReference()) {
-            builder.crossReference().serialise(storyManager().performableRoot(), builder.outputDirectory());
-        }
-    }
-
     public void generateSurefireReport() {
         StoryReporterBuilder builder = configuration().storyReporterBuilder();
         if (builder.hasSurefireReporter()) {

diff --git a/jbehave-core/src/main/java/org/jbehave/core/junit/JUnitStories.java b/jbehave-core/src/main/java/org/jbehave/core/junit/JUnitStories.java
@@ -20,7 +20,6 @@ public void run() {
         try {
             embedder.runStoriesAsPaths(storyPaths());
         } finally {
-            embedder.generateCrossReference();
             embedder.generateSurefireReport();
         }
     }

diff --git a/jbehave-core/src/main/java/org/jbehave/core/junit/JUnitStory.java b/jbehave-core/src/main/java/org/jbehave/core/junit/JUnitStory.java
@@ -24,7 +24,6 @@ public void run() {
         try {
             embedder.runStoriesAsPaths(asList(storyPath));
         } finally {
-            embedder.generateCrossReference();
             embedder.generateSurefireReport();
         }
     }