Add Scenario.source_tag_names to work with Capybara. Closes #504.

aslakhellesoy · aslakhellesoy · commit 44660aae8ba2 · 2013-04-14T06:57:54.000+01:00
diff --git a/History.md b/History.md
@@ -1,5 +1,6 @@
 ## [Git master](https://github.com/cucumber/cucumber-jvm/compare/v1.1.3...master) (not released)
 
+* [Core] Added `Scenario.getSourceTagNames()`, which is needed to make Capybara work with Cucumber-JRuby ([#504](https://github.com/cucumber/cucumber-jvm/issues/504) Aslak Hellesøy)
 * [JRuby] Tagged hooks for JRuby ([#467](https://github.com/cucumber/cucumber-jvm/issues/467) Aslak Hellesøy)
 * [Spring] Implementation based on SpringJunit4ClassRunner. ([#448](https://github.com/cucumber/cucumber-jvm/issues/448), [#489](https://github.com/cucumber/cucumber-jvm/pull/489) Pedro Antonio Souza Viegas)
 * [Core] Bugfix: Generated regex for ? character is incorrect. ([#494](https://github.com/cucumber/cucumber-jvm/issues/494) Aslak Hellesøy)
diff --git a/core/src/main/java/cucumber/api/Scenario.java b/core/src/main/java/cucumber/api/Scenario.java
@@ -1,10 +1,14 @@
 package cucumber.api;
 
+import java.util.Collection;
+
 /**
  * Before or After Hooks that declare a parameter of this type will receive an instance of this class.
  * It allows writing text and embedding media into reports, as well as inspecting results (in an After block).
  */
 public interface Scenario {
+    Collection<String> getSourceTagNames();
+
     /**
      * @return the <em>most severe</em> status of the Scenario's Steps. One of "passed", "undefined", "pending", "skipped", "failed"
      */
diff --git a/core/src/main/java/cucumber/runtime/Runtime.java b/core/src/main/java/cucumber/runtime/Runtime.java
@@ -110,14 +110,14 @@ private void printSummary() {
         new SummaryPrinter(System.out).print(this);
     }
 
-    public void buildBackendWorlds(Reporter reporter) {
+    public void buildBackendWorlds(Reporter reporter, Set<Tag> tags) {
         for (Backend backend : backends) {
             backend.buildWorld();
         }
         undefinedStepsTracker.reset();
         //TODO: this is the initial state of the state machine, it should not go here, but into something else
         skipNextStep = false;
-        scenarioResult = new ScenarioImpl(reporter);
+        scenarioResult = new ScenarioImpl(reporter, tags);
     }
 
     public void disposeBackendWorlds() {
diff --git a/core/src/main/java/cucumber/runtime/ScenarioImpl.java b/core/src/main/java/cucumber/runtime/ScenarioImpl.java
@@ -3,25 +3,41 @@
 import cucumber.api.Scenario;
 import gherkin.formatter.Reporter;
 import gherkin.formatter.model.Result;
+import gherkin.formatter.model.Tag;
 
 import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashSet;
 import java.util.List;
+import java.util.Set;
 
 import static java.util.Arrays.asList;
 
 public class ScenarioImpl implements Scenario {
     private static final List<String> SEVERITY = asList("passed", "undefined", "pending", "skipped", "failed");
     private final List<Result> stepResults = new ArrayList<Result>();
     private final Reporter reporter;
+    private final Set<Tag> tags;
 
-    public ScenarioImpl(Reporter reporter) {
+    public ScenarioImpl(Reporter reporter, Set<Tag> tags) {
         this.reporter = reporter;
+        this.tags = tags;
     }
 
     void add(Result result) {
         stepResults.add(result);
     }
 
+    @Override
+    public Collection<String> getSourceTagNames() {
+        Set<String> result = new HashSet<String>();
+        for (Tag tag : tags) {
+            result.add(tag.getName());
+        }
+        // Has to be a List in order for JRuby to convert to Ruby Array.
+        return new ArrayList<String>(result);
+    }
+
     @Override
     public String getStatus() {
         int pos = 0;
diff --git a/core/src/main/java/cucumber/runtime/model/CucumberScenario.java b/core/src/main/java/cucumber/runtime/model/CucumberScenario.java
@@ -5,6 +5,9 @@
 import gherkin.formatter.Reporter;
 import gherkin.formatter.model.Row;
 import gherkin.formatter.model.Scenario;
+import gherkin.formatter.model.Tag;
+
+import java.util.Set;
 
 public class CucumberScenario extends CucumberTagStatement {
     private final CucumberBackground cucumberBackground;
@@ -28,14 +31,15 @@ public CucumberBackground getCucumberBackground() {
      */
     @Override
     public void run(Formatter formatter, Reporter reporter, Runtime runtime) {
-        runtime.buildBackendWorlds(reporter);
-        runtime.runBeforeHooks(reporter, tagsAndInheritedTags());
+        Set<Tag> tags = tagsAndInheritedTags();
+        runtime.buildBackendWorlds(reporter, tags);
+        runtime.runBeforeHooks(reporter, tags);
 
         runBackground(formatter, reporter, runtime);
         format(formatter);
         runSteps(formatter, reporter, runtime);
 
-        runtime.runAfterHooks(reporter, tagsAndInheritedTags());
+        runtime.runAfterHooks(reporter, tags);
         runtime.disposeBackendWorlds();
     }
 
diff --git a/core/src/test/java/cucumber/runtime/HookOrderTest.java b/core/src/test/java/cucumber/runtime/HookOrderTest.java
@@ -10,6 +10,7 @@
 import org.mockito.Matchers;
 
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Properties;
@@ -31,7 +32,7 @@ public void buildMockWorld() {
         ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
         RuntimeOptions runtimeOptions = new RuntimeOptions(new Properties());
         runtime = new Runtime(mock(ResourceLoader.class), classLoader, asList(mock(Backend.class)), runtimeOptions);
-        runtime.buildBackendWorlds(null);
+        runtime.buildBackendWorlds(null, Collections.<Tag>emptySet());
         glue = runtime.getGlue();
     }
 
diff --git a/core/src/test/java/cucumber/runtime/ScenarioResultTest.java b/core/src/test/java/cucumber/runtime/ScenarioResultTest.java
@@ -2,53 +2,56 @@
 
 import gherkin.formatter.Reporter;
 import gherkin.formatter.model.Result;
+import gherkin.formatter.model.Tag;
 import org.junit.Test;
 
+import java.util.Collections;
+
 import static org.junit.Assert.assertEquals;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
 
 public class ScenarioResultTest {
 
     private Reporter reporter = mock(Reporter.class);
-    private ScenarioImpl r = new ScenarioImpl(reporter);
+    private ScenarioImpl s = new ScenarioImpl(reporter, Collections.<Tag>emptySet());
 
     @Test
     public void no_steps_is_passed() throws Exception {
-        assertEquals("passed", r.getStatus());
+        assertEquals("passed", s.getStatus());
     }
 
     @Test
     public void passed_and_failed_is_passed() throws Exception {
-        r.add(new Result("passed", 0L, null, null));
-        r.add(new Result("failed", 0L, null, null));
-        assertEquals("failed", r.getStatus());
+        s.add(new Result("passed", 0L, null, null));
+        s.add(new Result("failed", 0L, null, null));
+        assertEquals("failed", s.getStatus());
     }
 
     @Test
     public void passed_and_skipped_is_skipped_although_we_cant_have_skipped_without_undefined_or_pending() throws Exception {
-        r.add(new Result("passed", 0L, null, null));
-        r.add(new Result("skipped", 0L, null, null));
-        assertEquals("skipped", r.getStatus());
+        s.add(new Result("passed", 0L, null, null));
+        s.add(new Result("skipped", 0L, null, null));
+        assertEquals("skipped", s.getStatus());
     }
 
     @Test
     public void undefined_and_pending_is_pending() throws Exception {
-        r.add(new Result("undefined", 0L, null, null));
-        r.add(new Result("pending", 0L, null, null));
-        assertEquals("pending", r.getStatus());
+        s.add(new Result("undefined", 0L, null, null));
+        s.add(new Result("pending", 0L, null, null));
+        assertEquals("pending", s.getStatus());
     }
 
     @Test
     public void embeds_data() {
         byte[] data = new byte[]{1, 2, 3};
-        r.embed(data, "bytes/foo");
+        s.embed(data, "bytes/foo");
         verify(reporter).embedding("bytes/foo", data);
     }
 
     @Test
     public void prints_output() {
-        r.write("Hi");
+        s.write("Hi");
         verify(reporter).write("Hi");
     }
 }
diff --git a/java/src/test/java/cucumber/runtime/java/JavaStepDefinitionTest.java b/java/src/test/java/cucumber/runtime/java/JavaStepDefinitionTest.java
@@ -70,7 +70,7 @@ public void throws_ambiguous_when_two_matches_are_found() throws Throwable {
         backend.addStepDefinition(THREE_BLIND_ANIMALS.getAnnotation(Given.class), THREE_BLIND_ANIMALS);
 
         Reporter reporter = mock(Reporter.class);
-        runtime.buildBackendWorlds(reporter);
+        runtime.buildBackendWorlds(reporter, Collections.<Tag>emptySet());
         Tag tag = new Tag("@foo", 0);
         runtime.runBeforeHooks(reporter, asSet(tag));
         runtime.runStep("uri", new Step(NO_COMMENTS, "Given ", "three blind mice", 1, null, null), reporter, ENGLISH);
@@ -114,7 +114,7 @@ public void embedding(String mimeType, byte[] data) {
             public void write(String text) {
             }
         };
-        runtime.buildBackendWorlds(reporter);
+        runtime.buildBackendWorlds(reporter, Collections.<Tag>emptySet());
         Tag tag = new Tag("@foo", 0);
         Set<Tag> tags = asSet(tag);
         runtime.runBeforeHooks(reporter, tags);
diff --git a/jruby/src/test/resources/cucumber/runtime/jruby/test/hooks.rb b/jruby/src/test/resources/cucumber/runtime/jruby/test/hooks.rb
@@ -1,7 +1,8 @@
 require 'cucumber/api/jruby/en'
 
-Before('@tag') do
+Before('@tag') do |scenario|
   @tagged_hook_ran = true
+  raise "Unexpected tags" unless scenario.source_tag_names == ['@tag']
 end
 
 Then /^tagged hook ran$/ do
diff --git a/scala/src/test/scala/cucumber/api/scala/ScalaDslTest.scala b/scala/src/test/scala/cucumber/api/scala/ScalaDslTest.scala
@@ -10,6 +10,8 @@ import cucumber.api.Scenario
 class ScalaDslTest {
 
   object StubScenario extends Scenario{
+    def getSourceTagNames = null
+
     def getStatus =  ""
 
     def isFailed = false
@@ -125,7 +127,7 @@ class ScalaDslTest {
 
     assertEquals(1, Dummy.stepDefinitions.size)
     val step = Dummy.stepDefinitions.head
-    assertEquals("ScalaDslTest.scala:121", step.getLocation(true)) // be careful with formatting or this test will break
+    assertEquals("ScalaDslTest.scala:123", step.getLocation(true)) // be careful with formatting or this test will break
     assertEquals("x", step.getPattern)
     step.execute(new I18n("en"), Array())
     assertTrue(called)

Original file line number	Diff line number	Diff line change
`@@ -110,14 +110,14 @@ private void printSummary() {`
`110`	`110`	`new SummaryPrinter(System.out).print(this);`
`111`	`111`	`}`
`112`	`112`
`113`		`- public void buildBackendWorlds(Reporter reporter) {`
	`113`	`+ public void buildBackendWorlds(Reporter reporter, Set<Tag> tags) {`
`114`	`114`	`for (Backend backend : backends) {`
`115`	`115`	`backend.buildWorld();`
`116`	`116`	`}`
`117`	`117`	`undefinedStepsTracker.reset();`
`118`	`118`	`//TODO: this is the initial state of the state machine, it should not go here, but into something else`
`119`	`119`	`skipNextStep = false;`
`120`		`- scenarioResult = new ScenarioImpl(reporter);`
	`120`	`+ scenarioResult = new ScenarioImpl(reporter, tags);`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`public void disposeBackendWorlds() {`