cucumber 3.0.0.pre.2 → 3.0.1

data/examples/tcl/features/support/env.rb

@@ -2,5 +2,6 @@ require 'rubygems'
 require 'tcl'
 
 Before do
-  @fib = Tcl::Interp.load_from_file(File.dirname(__FILE__) + '/../../src/fib.tcl')
+  file_name = File.dirname(__FILE__) + '/../../src/fib.tcl'
+  @fib = Tcl::Interp.load_from_file(file_name)
 end

data/examples/watir/features/step_definitions/search_steps.rb

@@ -18,9 +18,10 @@ end
 # consider creating classes for your pages - such as this:
 # http://github.com/cucumber/cucumber/tree/v0.1.15/examples/watir/features/step_definitons/search_steps.rb
 #
-# You may keep the page classes along your steps, or even better, put them in separate files, e.g.
-# support/pages/google_search.rb
+# You may keep the page classes along your steps, or even better, put them in
+# separate files, e.g. support/pages/google_search.rb
 #
 # This technique is called "Page Objects", and you can read more about it here:
 # http://github.com/marekj/watirloo/tree/master
-# We're not using this technique here, since we want to illustrate the basics only.
+# We're not using this technique here, since we want to illustrate the
+# basics only.

data/examples/watir/features/support/env.rb

@@ -1,4 +1,8 @@
-begin require 'rspec/expectations'; rescue LoadError; require 'spec/expectations'; end
+begin
+  require 'rspec/expectations'
+rescue LoadError
+  require 'spec/expectations'
+end
 
 browser = nil
 

data/features/docs/api/listen_for_events.feature

@@ -21,7 +21,7 @@ Feature: Listen for events
         io = config.out_stream
         config.on_event :step_activated do |event|
           io.puts "Success!"
-          io.puts "Step name:       #{event.test_step.name}"
+          io.puts "Step text:       #{event.test_step}"
           io.puts "Source location: #{event.step_match.location}"
         end
       end
@@ -30,7 +30,7 @@ Feature: Listen for events
     Then it should pass with:
       """
       Success!
-      Step name:       matching
+      Step text:       matching
       Source location: features/step_definitions/steps.rb:1
       """
 

data/features/docs/cli/execute_with_tag_filter.feature

@@ -23,6 +23,7 @@ Feature: Tag logic
 
         @ignore
         Scenario: And yet another Example
+          Given passing
       """
 
   Scenario: ANDing tags
@@ -78,9 +79,10 @@ Feature: Tag logic
 
         @ignore
         Scenario: And yet another Example
+          Given passing
 
-      2 scenarios (1 undefined, 1 passed)
-      1 step (1 undefined)
+      2 scenarios (2 undefined)
+      2 steps (2 undefined)
       """
 
   Scenario: Run with limited tag count, blowing it on scenario

data/features/docs/defining_steps/ambiguous_steps.feature

@@ -0,0 +1,89 @@
+Feature: Ambiguous Steps
+
+  When Cucumber searches for a step definition for a step, it might find multiple step
+  definitions that could match. In that case, it will give you an error that the step
+  definitions are ambiguous.
+
+  You can also use a `--guess` mode, where it uses magic powers to try and figure
+  out which of those two step definitions is most likely to be the one you meant it
+  to use. Use it with caution!
+
+
+  Scenario: Ambiguous steps
+
+    Given a file named "features/ambiguous.feature" with:
+    """
+    Feature:
+
+      Scenario:
+      When a step
+      Then an ambiguous step
+
+    """
+    And a file named "features/step_definitions.rb" with:
+    """
+      When(/^a.*step$/) do
+        'foo'
+      end
+
+      Then(/^an ambiguous step$/) do
+        'bar'
+      end
+
+    """
+    When I run `cucumber`
+    Then it should fail with:
+    """
+          Ambiguous match of "an ambiguous step":
+          
+          features/step_definitions.rb:1:in `/^a.*step$/'
+          features/step_definitions.rb:5:in `/^an ambiguous step$/'
+          
+          You can run again with --guess to make Cucumber be more smart about it
+           (Cucumber::Ambiguous)
+          features/ambiguous.feature:5:in `Then an ambiguous step'
+
+    Failing Scenarios:
+    cucumber features/ambiguous.feature:3 # Scenario: 
+
+    1 scenario (1 failed)
+    2 steps (1 failed, 1 passed)
+    0m0.012s
+
+    """
+
+
+  Scenario: Ambiguous steps with guess mode
+
+    Given a file named "features/ambiguous.feature" with:
+    """
+    Feature:
+
+      Scenario:
+      When a step
+      Then an ambiguous step
+    """
+    And a file named "features/step_definitions.rb" with:
+    """
+      When(/^a.*step$/) do
+        'foo'
+      end
+
+      Then(/^an ambiguous step$/) do
+        'bar'
+      end
+    """
+    When I run `cucumber -g`
+    Then it should pass with exactly:
+    """
+    Feature: 
+
+      Scenario:                # features/ambiguous.feature:3
+        When a step            # features/step_definitions.rb:1
+        Then an ambiguous step # features/step_definitions.rb:5
+
+    1 scenario (1 passed)
+    2 steps (2 passed)
+    0m0.012s
+
+    """

data/features/docs/events/{test_case_starting_event.feature → test_case_started_event.feature}

@@ -1,10 +1,10 @@
 @wip
-Feature: Test Case Starting Event
+Feature: Test Case Started Event
 
   This event is fired just before each scenario or scenario outline example row
   (generally named a Test Case) starts to be executed. This event is read-only.
 
-  See [the API documentation](http://www.rubydoc.info/github/cucumber/cucumber-ruby/Cucumber/Events/TestCaseStarting) for more information about the data available on this event and the result object.
+  See [the API documentation](http://www.rubydoc.info/github/cucumber/cucumber-ruby/Cucumber/Events/TestCaseStarted) for more information about the data available on this event and the result object.
 
   Background:
     Given the standard step definitions
@@ -22,7 +22,7 @@ Feature: Test Case Starting Event
       stdout = nil
       AfterConfiguration do |config|
         stdout = config.out_stream # make sure all the `puts` calls can write to the same output
-        config.on_event :test_case_starting do |event|
+        config.on_event :test_case_started do |event|
           stdout.puts "before"
           stdout.puts event.test_case.tags.map(&:name)
         end

data/features/docs/events/{test_run_starting_event.feature → test_run_started_event.feature}

@@ -1,9 +1,9 @@
-Feature: Test Run Starting Event
+Feature: Test Run Started Event
 
   This event is fired once all test cases have been filtered, just before
   the first one is executed.
 
-  See [the API documentation](http://www.rubydoc.info/github/cucumber/cucumber-ruby/Cucumber/Events/TestRunStarting) for more information about the data available on this event.
+  See [the API documentation](http://www.rubydoc.info/github/cucumber/cucumber-ruby/Cucumber/Events/TestRunStarted) for more information about the data available on this event.
 
   Background:
     Given the standard step definitions
@@ -22,8 +22,8 @@ Feature: Test Run Starting Event
     And a file named "features/support/events.rb" with:
       """
       AfterConfiguration do |config|
-        config.on_event :test_run_starting do |event|
-          config.out_stream.puts "test run starting"
+        config.on_event :test_run_started do |event|
+          config.out_stream.puts "test run started"
           config.out_stream.puts event.test_cases.map(&:location)
         end
       end
@@ -34,7 +34,7 @@ Feature: Test Run Starting Event
     When I run `cucumber -q`
     Then it should pass with:
       """
-      test run starting
+      test run started
       features/bar.feature:2
       features/foo.feature:2
       """

data/features/docs/events/test_step_finished_event.feature

@@ -24,7 +24,7 @@ Feature: Test Step Finished Event
       """
       AfterConfiguration do |config|
         config.on_event :test_step_finished do |event|
-          config.out_stream.puts "Test step: #{event.test_step.name}"
+          config.out_stream.puts "Test step: #{event.test_step}"
           config.out_stream.puts "The result is: #{event.result}"
         end
       end

data/features/docs/events/{test_step_starting_event.feature → test_step_started_event.feature}

@@ -1,11 +1,11 @@
-Feature: Test Step Starting Event
+Feature: Test Step Started Event
 
   This event is fired just before each step in a scenario or scenario outline example 
   (generally named a Test Step) starts to be executed. This event is read-only, so there
   is no way to prevent the test step from running, but you can use it for logging or user
   notification.
 
-  See [the API documentation](http://www.rubydoc.info/github/cucumber/cucumber-ruby/Cucumber/Events/TestStepStarting) for more information about the data available on this event and the result object.
+  See [the API documentation](http://www.rubydoc.info/github/cucumber/cucumber-ruby/Cucumber/Events/TestStepStarted) for more information about the data available on this event and the result object.
 
   Background:
     Given the standard step definitions
@@ -21,7 +21,7 @@ Feature: Test Step Starting Event
       stdout = nil
       AfterConfiguration do |config|
         stdout = config.out_stream # make sure all the `puts` calls can write to the same output
-        config.on_event :test_step_starting do |event|
+        config.on_event :test_step_started do |event|
           stdout.puts "before"
         end
         config.on_event :test_step_finished do |event|

data/features/docs/extending_cucumber/custom_formatter.feature

@@ -19,7 +19,7 @@ Feature: Custom Formatter
         class Formatter
           def initialize(config)
             @io = config.out_stream
-            config.on_event :test_case_starting do |event|
+            config.on_event :test_case_started do |event|
               print_test_case_name(event.test_case)
             end
           end
@@ -41,7 +41,7 @@ Feature: Custom Formatter
 
       """
 
-  Scenario: Custom config
+  Scenario: Pass custom config to your formatter from the CLI
     Given a file named "features/support/custom_formatter.rb" with:
       """
       module MyCustom
@@ -61,7 +61,7 @@ Feature: Custom Formatter
     {"foo"=>"bar", "one"=>"two"}
     """
 
- Scenario: Use the legacy API
+  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:
@@ -85,38 +85,10 @@ Feature: Custom Formatter
     When I run `cucumber features/f.feature --format MyCustom::LegacyFormatter`
     Then it should pass with exactly:
       """
-      I'LL USE MY OWN
-        JUST PRINT ME
-
-      """
+      WARNING: The formatter MyCustom::LegacyFormatter is using the deprecated formatter API which will be removed in v4.0 of Cucumber.
 
-  Scenario: Use both old and new
-    You can both APIs at once, for now
-
-    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
 
       """
+

data/features/docs/gherkin/outlines.feature

@@ -50,8 +50,6 @@ Feature: Scenario outlines
       """
       Feature: Outline Sample
 
-        Scenario: I have no steps
-
         Scenario Outline: Test state
           Given <state> without a table
           Given <other_state> without a table
@@ -73,7 +71,7 @@ Feature: Scenario outlines
       Failing Scenarios:
       cucumber features/outline_sample.feature:12
 
-      5 scenarios (1 failed, 1 undefined, 3 passed)
+      4 scenarios (1 failed, 1 undefined, 2 passed)
       8 steps (1 failed, 2 skipped, 1 undefined, 4 passed)
       """
 
@@ -154,7 +152,7 @@ Feature: Scenario outlines
       Failing Scenarios:
       cucumber features/outline_sample.feature:12
 
-      5 scenarios (1 failed, 1 undefined, 3 passed)
+      4 scenarios (1 failed, 1 undefined, 2 passed)
       8 steps (1 failed, 2 skipped, 1 undefined, 4 passed)
 
       """

data/features/docs/writing_support_code/parameter_types.feature

@@ -46,30 +46,24 @@ Feature: Parameter Types
       ParameterType(
         name: 'person',
         regexp: /[A-Z]\w+/,
-        type: Person,
-        transformer: lambda do |name|
-          Person.new(name)
-        end,
-        use_for_snippets: true,
-        prefer_for_regexp_match: false
+        transformer: -> (name) { Person.new(name) }
       )
       """
     When I run `cucumber features/foo.feature`
     Then it should pass
 
-  Scenario: Parameter type defined with legacy Transform method
-    This is for backwards compatibility - works with regular expressions,
-    but not with Cucumber Expressions, because no name is specified for the
-    parameter type.
+    Scenario: Parameter type defined with ParameterType method
+      If your parameter type's `regexp` is very general, you can tell
+      Cucumber not to suggest its use in snippets:
 
-    Given a file named "features/support/transforms.rb" with:
+    Given a file named "features/support/parameter_types.rb" with:
       """
-      Transform(/[A-Z]\w+/) do |name|
-        Person.new(name)
-      end
+      ParameterType(
+        name: 'person',
+        regexp: /[A-Z]\w+/,
+        transformer: -> (name) { Person.new(name) },
+        use_for_snippets: false
+      )
       """
     When I run `cucumber features/foo.feature`
-    Then it should fail with:
-      """
-      Undefined parameter type {person}
-      """
+    Then it should pass

data/features/lib/step_definitions/iso-8859-1_steps.rb

@@ -1,9 +1,12 @@
 # encoding: iso-8859-1
 # frozen_string_literal: true
-# Ideally we would use Norwegian keywords here, but that won't work unless this file is UTF-8 encoded.
-# Alternatively it would be possible to use Norwegian keywords and encode the file as UTF-8.
+# Ideally we would use Norwegian keywords here, but that won't work unless this
+# file is UTF-8 encoded.
+# Alternatively, it would be possible to use Norwegian keywords and encode the
+# file as UTF-8.
 #
-# In both cases, stepdef arguments will be sent in as UTF-8, regardless of what encoding is used.
+# In both cases, stepdef arguments will be sent in as UTF-8, regardless of what
+# encoding is used.
 Given(/^jeg drikker en "([^"]*)"$/) do |drink|
   expect(drink).to eq '�l'.encode('UTF-8')
 end

data/features/lib/support/fake_wire_server.rb

@@ -65,7 +65,15 @@ class FakeWireServer
         send_response(['fail', serialized_exception ].to_json)
       end
     rescue => e
-      send_response(['fail', { :message => e.message, :backtrace => e.backtrace, :exception => e.class } ].to_json)
+      response = [
+                    'fail',
+                    {
+                      :message => e.message,
+                      :backtrace => e.backtrace,
+                      :exception => e.class
+                    }
+                  ].to_json
+      send_response(response)
     end
 
     def response_to(data)

data/features/lib/support/parameter_types.rb

@@ -1,8 +1,5 @@
 ParameterType(
   name: 'list',
   regexp: /.*/,
-  type: Array,
-  transformer: ->(s) { s.split(/,\s+/)},
-  use_for_snippets: false,
-  prefer_for_regexp_match: false
+  transformer: ->(s) { s.split(/,\s+/)}
 )

data/gem_tasks/fix_cr_lf.rake

@@ -1,11 +1,22 @@
 # frozen_string_literal: true
+
+require 'pathname'
+
 desc 'Make all files use UNIX (\n) line endings'
 task :fix_cr_lf do
-  files = FileList['**/*']
-  files.each do |f|
-    next if File.directory?(f) || f =~ /dos/
-    s = IO.read(f)
-    s.gsub!(/\r?\n/, "\n")
-    File.open(f, 'w') { |io| io.write(s) }
+  iso_8859_1_files = FileList.new(
+    'features/docs/iso-8859-1.feature',
+    'features/lib/step_definitions/iso-8859-1_steps.rb'
+  )
+
+  utf8_files = FileList.new('**/*') do |fl|
+    fl.exclude { |f| File.directory?(f) }
+  end
+
+  paths = (utf8_files - iso_8859_1_files).map { |f| Pathname(f) }
+
+  paths.each do |path|
+    content = path.read.gsub(/\r?\n/, "\n")
+    path.write(content)
   end
 end