mobiusloop 0.1.2

data/features/docs/exception_in_after_hook.feature

@@ -0,0 +1,126 @@
+Feature: Exception in After Block
+  In order to use custom assertions at the end of each scenario
+  As a developer
+  I want exceptions raised in After blocks to be handled gracefully and reported by the formatters
+
+  Background:
+    Given the standard step definitions
+    And a file named "features/step_definitions/naughty_steps.rb" with:
+      """
+      Given /^this step does something naughty$/ do x=1
+        @naughty = true
+      end
+      """
+    And a file named "features/support/env.rb" with:
+      """
+      class NaughtyScenarioException < Exception; end
+      After do
+        if @naughty
+          raise NaughtyScenarioException.new("This scenario has been very very naughty")
+        end
+      end
+      """
+
+  @spawn
+  Scenario: Handle Exception in standard scenario step and carry on
+    Given a file named "features/naughty_step_in_scenario.feature" with:
+      """
+      Feature: Sample
+
+        Scenario: Naughty Step
+          Given this step does something naughty
+
+        Scenario: Success
+          Given this step passes
+      """
+    When I run `cucumber features`
+    Then it should fail with:
+      """
+      Feature: Sample
+
+        Scenario: Naughty Step                   # features/naughty_step_in_scenario.feature:3
+          Given this step does something naughty # features/step_definitions/naughty_steps.rb:1
+            This scenario has been very very naughty (NaughtyScenarioException)
+            ./features/support/env.rb:4:in `After'
+
+        Scenario: Success        # features/naughty_step_in_scenario.feature:6
+          Given this step passes # features/step_definitions/steps.rb:1
+
+      Failing Scenarios:
+      cucumber features/naughty_step_in_scenario.feature:3 # Scenario: Naughty Step
+
+      2 scenarios (1 failed, 1 passed)
+      2 steps (2 passed)
+
+      """
+
+  @spawn
+  Scenario: Handle Exception in scenario outline table row and carry on
+    Given a file named "features/naughty_step_in_scenario_outline.feature" with:
+      """
+      Feature: Sample
+
+        Scenario Outline: Naughty Step
+          Given this step <Might Work>
+
+          Examples:
+          | Might Work             |
+          | passes                 |
+          | does something naughty |
+          | passes                 |
+
+        Scenario: Success
+          Given this step passes
+
+      """
+    When I run `cucumber features -q`
+    Then it should fail with:
+      """
+      Feature: Sample
+
+        Scenario Outline: Naughty Step
+          Given this step <Might Work>
+
+          Examples: 
+            | Might Work             |
+            | passes                 |
+            | does something naughty |
+            This scenario has been very very naughty (NaughtyScenarioException)
+            ./features/support/env.rb:4:in `After'
+            | passes                 |
+
+        Scenario: Success
+          Given this step passes
+
+      Failing Scenarios:
+      cucumber features/naughty_step_in_scenario_outline.feature:9
+
+      4 scenarios (1 failed, 3 passed)
+      4 steps (4 passed)
+
+      """
+
+  Scenario: Handle Exception using the progress format
+    Given a file named "features/naughty_step_in_scenario.feature" with:
+      """
+      Feature: Sample
+
+        Scenario: Naughty Step
+          Given this step does something naughty
+
+        Scenario: Success
+          Given this step passes
+      """
+    When I run `cucumber features --format progress`
+    Then it should fail with:
+      """
+      .F.
+
+      Failing Scenarios:
+      cucumber features/naughty_step_in_scenario.feature:3 # Scenario: Naughty Step
+
+      2 scenarios (1 failed, 1 passed)
+      2 steps (2 passed)
+
+      """
+

data/features/docs/exception_in_after_step_hook.feature

@@ -0,0 +1,102 @@
+Feature: Exception in AfterStep Block
+  In order to use custom assertions at the end of each step
+  As a developer
+  I want exceptions raised in AfterStep blocks to be handled gracefully and reported by the formatters
+
+  Background:
+    Given the standard step definitions
+    And a file named "features/step_definitions/naughty_steps.rb" with:
+      """
+      Given /^this step does something naughty$/ do x=1
+        @naughty = true
+      end
+      """
+    And a file named "features/support/env.rb" with:
+      """
+      class NaughtyStepException < Exception; end
+      AfterStep do
+        if @naughty
+          raise NaughtyStepException.new("This step has been very very naughty")
+        end
+      end
+      """
+
+  Scenario: Handle Exception in standard scenario step and carry on
+    Given a file named "features/naughty_step_in_scenario.feature" with:
+      """
+      Feature: Sample
+
+        Scenario: Naughty Step
+          Given this step does something naughty
+
+        Scenario: Success
+          Given this step passes
+      """
+    When I run `cucumber features`
+    Then it should fail with:
+      """
+      Feature: Sample
+
+        Scenario: Naughty Step                   # features/naughty_step_in_scenario.feature:3
+          Given this step does something naughty # features/step_definitions/naughty_steps.rb:1
+            This step has been very very naughty (NaughtyStepException)
+            ./features/support/env.rb:4:in `AfterStep'
+            features/naughty_step_in_scenario.feature:4:in `Given this step does something naughty'
+
+        Scenario: Success        # features/naughty_step_in_scenario.feature:6
+          Given this step passes # features/step_definitions/steps.rb:1
+
+      Failing Scenarios:
+      cucumber features/naughty_step_in_scenario.feature:3 # Scenario: Naughty Step
+
+      2 scenarios (1 failed, 1 passed)
+      2 steps (2 passed)
+
+      """
+
+  Scenario: Handle Exception in scenario outline table row and carry on
+    Given a file named "features/naughty_step_in_scenario_outline.feature" with:
+      """
+      Feature: Sample
+
+        Scenario Outline: Naughty Step
+          Given this step <Might Work>
+
+          Examples:
+          | Might Work             |
+          | passes                 |
+          | does something naughty |
+          | passes                 |
+
+        Scenario: Success
+          Given this step passes
+
+      """
+    When I run `cucumber features`
+    Then it should fail with:
+      """
+      Feature: Sample
+
+        Scenario Outline: Naughty Step # features/naughty_step_in_scenario_outline.feature:3
+          Given this step <Might Work> # features/naughty_step_in_scenario_outline.feature:4
+
+          Examples: 
+            | Might Work             |
+            | passes                 |
+            | does something naughty |
+            This step has been very very naughty (NaughtyStepException)
+            ./features/support/env.rb:4:in `AfterStep'
+            features/naughty_step_in_scenario_outline.feature:9:in `Given this step does something naughty'
+            features/naughty_step_in_scenario_outline.feature:4:in `Given this step <Might Work>'
+            | passes                 |
+
+        Scenario: Success        # features/naughty_step_in_scenario_outline.feature:12
+          Given this step passes # features/step_definitions/steps.rb:1
+
+      Failing Scenarios:
+      cucumber features/naughty_step_in_scenario_outline.feature:9 # Scenario Outline: Naughty Step, Examples (#2)
+
+      4 scenarios (1 failed, 3 passed)
+      4 steps (4 passed)
+
+      """

data/features/docs/exception_in_around_hook.feature

@@ -0,0 +1,78 @@
+Feature: Exceptions in Around Hooks
+
+  Around hooks are awkward beasts to handle internally.
+
+  Right now, if there's an error in your Around hook before you call `block.call`,
+  we won't even print the steps for the scenario.
+
+  This is because that `block.call` invokes all the logic that would tell Cucumber's
+  UI about the steps in your scenario. If we never reach that code, we'll never be
+  told about them.
+
+  There's another scenario to consider, where the exception occurs after the steps
+  have been run. How would we want to report in that case?
+
+  Scenario: Exception before the test case is run
+    Given the standard step definitions
+    And a file named "features/support/env.rb" with:
+      """
+      Around do |scenario, block|
+        fail "this should be reported"
+        block.call
+      end
+      """
+    And a file named "features/test.feature" with:
+      """
+      Feature:
+        Scenario:
+          Given this step passes
+      """
+    When I run `cucumber -q`
+    Then it should fail with exactly:
+      """
+      Feature: 
+
+        Scenario: 
+        this should be reported (RuntimeError)
+        ./features/support/env.rb:2:in `Around'
+      
+      Failing Scenarios:
+      cucumber features/test.feature:2
+      
+      1 scenario (1 failed)
+      0 steps
+      
+      """
+
+  Scenario: Exception after the test case is run
+    Given the standard step definitions
+    And a file named "features/support/env.rb" with:
+      """
+      Around do |scenario, block|
+        block.call
+        fail "this should be reported"
+      end
+      """
+    And a file named "features/test.feature" with:
+      """
+      Feature:
+        Scenario:
+          Given this step passes
+      """
+    When I run `cucumber -q`
+    Then it should fail with exactly:
+      """
+      Feature: 
+
+        Scenario: 
+          Given this step passes
+            this should be reported (RuntimeError)
+            ./features/support/env.rb:3:in `Around'
+      
+      Failing Scenarios:
+      cucumber features/test.feature:2
+      
+      1 scenario (1 failed)
+      1 step (1 passed)
+
+      """

data/features/docs/exception_in_before_hook.feature

@@ -0,0 +1,96 @@
+Feature: Exception in Before Block
+  In order to know with confidence that my before blocks have run OK
+  As a developer
+  I want exceptions raised in Before blocks to be handled gracefully and reported by the formatters
+
+  Background:
+    Given the standard step definitions
+    And a file named "features/support/env.rb" with:
+      """
+      class SomeSetupException < Exception; end
+      class BadStepException < Exception; end
+      Before do
+        raise SomeSetupException.new("I cannot even start this scenario")
+      end
+      """
+
+  @spawn
+  Scenario: Handle Exception in standard scenario step and carry on
+    Given a file named "features/naughty_step_in_scenario.feature" with:
+      """
+      Feature: Sample
+
+        Scenario: Run a good step
+          Given this step passes
+      """
+    When I run `cucumber features`
+    Then it should fail with:
+      """
+      Feature: Sample
+
+        Scenario: Run a good step # features/naughty_step_in_scenario.feature:3
+        I cannot even start this scenario (SomeSetupException)
+        ./features/support/env.rb:4:in `Before'
+          Given this step passes  # features/step_definitions/steps.rb:1
+
+      Failing Scenarios:
+      cucumber features/naughty_step_in_scenario.feature:3 # Scenario: Run a good step
+
+      1 scenario (1 failed)
+      1 step (1 skipped)
+
+      """
+
+  Scenario: Handle Exception in Before hook for Scenario with Background
+    Given a file named "features/naughty_step_in_before.feature" with:
+      """
+      Feature: Sample
+
+        Background:
+          Given this step passes
+
+        Scenario: Run a good step
+          Given this step passes
+      """
+    When I run `cucumber features`
+    Then it should fail with exactly:
+      """
+      Feature: Sample
+      
+        Background:              # features/naughty_step_in_before.feature:3
+        I cannot even start this scenario (SomeSetupException)
+        ./features/support/env.rb:4:in `Before'
+          Given this step passes # features/step_definitions/steps.rb:1
+      
+        Scenario: Run a good step # features/naughty_step_in_before.feature:6
+          Given this step passes  # features/step_definitions/steps.rb:1
+
+      Failing Scenarios:
+      cucumber features/naughty_step_in_before.feature:6 # Scenario: Run a good step
+
+      1 scenario (1 failed)
+      2 steps (2 skipped)
+      0m0.012s
+
+      """
+
+  Scenario: Handle Exception using the progress format
+    Given a file named "features/naughty_step_in_scenario.feature" with:
+      """
+      Feature: Sample
+
+        Scenario: Run a good step
+          Given this step passes
+      """
+    When I run `cucumber features --format progress`
+    Then it should fail with:
+      """
+      F-
+
+      Failing Scenarios:
+      cucumber features/naughty_step_in_scenario.feature:3 # Scenario: Run a good step
+
+      1 scenario (1 failed)
+      1 step (1 skipped)
+
+      """

data/features/docs/extending_cucumber/custom_filter.feature

@@ -0,0 +1,29 @@
+Feature: Custom filter
+
+  Scenario: Add a custom filter via AfterConfiguration hook
+    Given a file named "features/test.feature" with:
+      """
+      Feature:
+        Scenario:
+          Given my special step
+      """
+    And a file named "features/support/my_filter.rb" with:
+      """
+      require 'cucumber/core/filter'
+
+      MakeAnythingPass = Cucumber::Core::Filter.new do
+        def test_case(test_case)
+          activated_steps = test_case.test_steps.map do |test_step|
+            test_step.with_action { }
+          end
+          test_case.with_steps(activated_steps).describe_to receiver
+        end
+      end
+
+      AfterConfiguration do |config|
+        config.filters << MakeAnythingPass.new
+      end
+      """
+    When I run `cucumber --strict`
+    Then it should pass
+

data/features/docs/extending_cucumber/custom_formatter.feature

@@ -0,0 +1,130 @@
+Feature: Custom Formatter
+
+  Background:
+    Given a file named "features/f.feature" with:
+      """
+      Feature: I'll use my own
+        Scenario: Just print me
+          Given this step passes
+      """
+    And the standard step definitions
+
+  Scenario: Subscribe to result events
+
+    This is the recommended way to format output.
+
+    Given a file named "features/support/custom_formatter.rb" with:
+      """
+      module MyCustom
+        class Formatter
+          def initialize(config)
+            @io = config.out_stream
+            config.on_event Cucumber::Events::BeforeTestCase do |event|
+              print_test_case_name(event.test_case)
+            end
+          end
+
+          def print_test_case_name(test_case)
+            feature = test_case.source.first
+            scenario = test_case.source.last
+            @io.puts feature.short_name.upcase
+            @io.puts "  #{scenario.name.upcase}"
+          end
+        end
+      end
+      """
+    When I run `cucumber features/f.feature --format MyCustom::Formatter`
+    Then it should pass with exactly:
+      """
+      I'LL USE MY OWN
+        JUST PRINT ME
+
+      """
+
+  Scenario: Implement v2.0 formatter methods
+    Note that this method is likely to be deprecated in favour of events - see above.
+
+    Given a file named "features/support/custom_formatter.rb" with:
+      """
+      module MyCustom
+        class Formatter
+          def initialize(config)
+            @io = config.out_stream
+          end
+
+          def before_test_case(test_case)
+            feature = test_case.source.first
+            scenario = test_case.source.last
+            @io.puts feature.short_name.upcase
+            @io.puts "  #{scenario.name.upcase}"
+          end
+        end
+      end
+      """
+    When I run `cucumber features/f.feature --format MyCustom::Formatter`
+    Then it should pass with exactly:
+      """
+      I'LL USE MY OWN
+        JUST PRINT ME
+
+      """
+
+  Scenario: Use the legacy API
+    This is deprecated and should no longer be used.
+
+    Given a file named "features/support/custom_legacy_formatter.rb" with:
+      """
+      module MyCustom
+        class LegacyFormatter
+          def initialize(runtime, io, options)
+            @io = io
+          end
+
+          def before_feature(feature)
+            @io.puts feature.short_name.upcase
+          end
+
+          def scenario_name(keyword, name, file_colon_line, source_indent)
+            @io.puts "  #{name.upcase}"
+          end
+        end
+      end
+      """
+    When I run `cucumber features/f.feature --format MyCustom::LegacyFormatter`
+    Then it should pass with exactly:
+      """
+      I'LL USE MY OWN
+        JUST PRINT ME
+
+      """
+
+  Scenario: Use both old and new
+    You can use a specific shim to opt-in to both APIs at once.
+
+    Given a file named "features/support/custom_mixed_formatter.rb" with:
+      """
+      module MyCustom
+        class MixedFormatter
+
+          def initialize(runtime, io, options)
+            @io = io
+          end
+
+          def before_test_case(test_case)
+            feature = test_case.source.first
+            @io.puts feature.short_name.upcase
+          end
+
+          def scenario_name(keyword, name, file_colon_line, source_indent)
+            @io.puts "  #{name.upcase}"
+          end
+        end
+      end
+      """
+    When I run `cucumber features/f.feature --format MyCustom::MixedFormatter`
+    Then it should pass with exactly:
+      """
+      I'LL USE MY OWN
+        JUST PRINT ME
+
+      """