cucumber 2.99.0 → 3.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b563aacb88f892ac6bf48bb659f08a7f87f2675c
-  data.tar.gz: 7ac2888d7273d03b14f95f95c4f986d59b628db0
+  metadata.gz: 7f5e472b2944bf6dadc1f272709c796c93dcceb5
+  data.tar.gz: c1a1751dbb2b0cd1d530304ae0e30bb229350374
 SHA512:
-  metadata.gz: 1509f258488fbedd76f50dc308bba8c2877dc11a2373b4d4a9e00d31534723352c2c03bfd6d8ae5f7a5c19ba1732d53e1feadab46264c11381ce07d9ceafc91b
-  data.tar.gz: ea511d05ced95a863349788293f738b9efb0fb8d1084b07d66d0c4f8bd023d3e93ab36eb55830fc2c9e75f0444b40ac7fdb57522aec01b7e4c09a9285288946e
+  metadata.gz: 2e6adc11f7c868ba3eff12b7774b1c2260de26bfd02df48644b577bbe0f76cd9946431376f4536b2f0ea5a1c1a1b86c61de7b5a4351f2467b55f0e43abe8cf29
+  data.tar.gz: 3e3be3a63d780965aa357ab93e3a34a6b95ff65c283ee6ad9af997c7c550ac4901a867d77e4cf84ff27f89e4a09f6859e95a939f75642faaf90607edf016830c

data/.travis.yml

@@ -1,23 +1,35 @@
 sudo: false
 
-rvm:
-  - 2.3.0
-  - 2.2
-  - 2.1
-  - 2.0
-  - 1.9.3
-  - jruby-1.7.12
+matrix:
+  include:
+    - rvm: 2.3.1
+    - rvm: 2.2
+    - rvm: 2.1
+    - rvm: 2.0
+    - rvm: jruby-9.1.2.0
+      env: 
+        # Travis by default also have "-Dcext.enabled=false" set in
+        # JRUBY_OPTS, but JRuby 9 does not support C extensions at all
+        # so it issues warning that will mess up the sterr checks. 
+        - JRUBY_OPTS="--server -Xcompile.invokedynamic=false"
+        # Somehow a "ASCII-8BIT to UTF-8 conversion error" appears for 
+        # JRuby 9
+        - LC_ALL=en_US.UTF-8
+        - LANG=en_US.UTF-8
+        - LANGUAGE=en_US.UTF-8
 
 # whitelist
 branches:
   only:
     - master
-    - resolve-issue-882
     - v1.3.x-bugfix
-    - v2.x-bugfix
 
 before_install:
   - gem update bundler
 
 notifications:
-  email: false
+  email:
+    - cukes-devs@googlegroups.com
+  webhooks:
+    urls: # gitter
+      - https://webhooks.gitter.im/e/dc010332f9d40fcc21c4

data/CONTRIBUTING.md

@@ -19,6 +19,19 @@ The rest of this document is a guide for those maintaining Cucumber, and others
 
 You can chat with the core team on https://gitter.im/cucumber/cucumber. We try to have office hours on Fridays.
 
+## Installing your own gems
+
+A `Gemfile.local`-file can be used to have your own gems installed to support
+your normal development workflow.
+
+Example:
+
+~~~ruby
+gem 'pry'
+gem 'pry-byebug'
+gem 'byebug'
+~~~
+
 ## Note on Patches/Pull Requests
 
 * Fork the project. Make a branch for your change.

data/Gemfile

@@ -1,14 +1,21 @@
 gem "cucumber-pro", "0.0.13", :group => :test
 source "https://rubygems.org"
 gemspec
+load File.expand_path('../Gemfile.local', __FILE__) if File.file? File.expand_path('../Gemfile.local', __FILE__)
+
 unless ENV['CUCUMBER_USE_RELEASED_CORE']
   core_path = File.expand_path("../../cucumber-ruby-core", __FILE__)
   wire_path = File.expand_path("../../cucumber-ruby-wire", __FILE__)
-  if File.exist?(core_path) && !ENV['CUCUMBER_USE_GIT_CORE']
-    gem 'cucumber-core', :path => core_path
-    gem 'cucumber-wire', :path => wire_path
+  if File.exist?(core_path) && !ENV["cucumber_use_git_core"]
+    gem "cucumber-core", :path => core_path
+  else
+    gem "cucumber-core", :git => "https://github.com/cucumber/cucumber-ruby-core.git"
+  end
+
+  if File.exist?(wire_path) && !ENV["CUCUMBER_USE_GIT_CORE"]
+    gem "cucumber-wire", :path => wire_path
   else
-    gem 'cucumber-core', :git => "https://github.com/cucumber/cucumber-ruby-core.git", :branch => 'v1.x-bugfix'
+    gem "cucumber-wire", :git => "https://github.com/cucumber/cucumber-ruby-wire.git"
   end
 end
 

data/History.md

@@ -1,9 +1,27 @@
-## [In Git](https://github.com/cucumber/cucumber-ruby/compare/v2.4.0...v2.x-bugfix)
+## [In Git](https://github.com/cucumber/cucumber-ruby/compare/v2.4.0...master)
+
+### Breaking changes
+
+* Remove support for Ruby 1.9.3 ([#993](https://github.com/cucumber/cucumber-ruby/pull/993) @brasmusson)
 
 ### New Features
 
+* Use the event bus in Cucumber-Ruby-Core ([#973](https://github.com/cucumber/cucumber-ruby/pull/973) @mattwynne)
+* Add --retry option to retry failed tests as part of the same run ([#920](https://github.com/cucumber/cucumber-ruby/pull/920) @DanaScheider)
+* Add a summary formatter ([#999](https://github.com/cucumber/cucumber-ruby/pull/999) @mattwynne)
+* Namespaced World modules ([#1007](https://github.com/cucumber/cucumber-ruby/pull/1007) @nodo)
+
 ### Bugfixes
 
+* Configure Gemfile to fetch cucumber-ruby-wire from git if the repo is not found locally ([#983](https://github.com/cucumber/cucumber-ruby/pulls/983), resolves [#961](https://github.com/cucumber/cucumber-ruby/issues/961))
+* Fix regression displaying CLI help ([#991](https://github.com/cucumber/cucumber-ruby/pull/991) @mattwynne)
+* with_filtered_backtrace called on Test::Result::Unknown with strange feature file ([#967](https://github.com/cucumber/cucumber-ruby/issues/967) @danascheider)
+* fix HTML formatter backtrace duplicate line bug ([#965](https://gthub.com/cucumber/cucumber-ruby/pull/965) @josephks)
+
+### Refactoring
+
+* Add frozen string literal magic comment to files and fix issues it causes ([#996](https://github.com/cucumber/cucumber-ruby/pull/996 @twalpole)
+
 ## [v2.4.0](https://github.com/cucumber/cucumber-ruby/compare/v2.3.3...v2.4.0)
 
 ### New Features

data/README.md

@@ -1,5 +1,5 @@
 [![Join the chat at https://gitter.im/cucumber/cucumber-ruby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cucumber/cucumber-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Build Status](https://secure.travis-ci.org/cucumber/cucumber-ruby.svg)](http://travis-ci.org/cucumber/cucumber-ruby)
+[![Build Status](https://travis-ci.org/cucumber/cucumber-ruby.svg?branch=master)](https://travis-ci.org/cucumber/cucumber-ruby)
 [![Code Climate](https://codeclimate.com/github/cucumber/cucumber-ruby.svg)](https://codeclimate.com/github/cucumber/cucumber-ruby)
 [![Coverage Status](https://coveralls.io/repos/cucumber/cucumber-ruby/badge.svg?branch=master)](https://coveralls.io/r/cucumber/cucumber-ruby?branch=master)
 [![Dependency Status](https://gemnasium.com/cucumber/cucumber-ruby.svg)](https://gemnasium.com/cucumber/cucumber-ruby)

data/cucumber.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |s|
   s.summary     = "cucumber-#{s.version}"
   s.email       = 'cukes@googlegroups.com'
   s.license     = 'MIT'
-  s.homepage    = "http://cukes.info"
+  s.homepage    = "https://cucumber.io/"
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = ">= 1.9.3"
-  s.add_dependency 'cucumber-core', '~> 1.5.0'
+  s.add_dependency 'cucumber-core', '~> 2.0'
   s.add_dependency 'builder', '>= 2.1.2'
   s.add_dependency 'diff-lcs', '>= 1.1.3'
   s.add_dependency 'gherkin', '~> 4.0'

data/cucumber.yml

@@ -2,10 +2,10 @@
 cucumber_pro_opts = ENV['ENABLE_CUCUMBER_PRO'] ? "--format Cucumber::Pro --out /dev/null" : ""
 rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
 rerun_opts = rerun.to_s.strip.empty? ? "--format progress features" : "--format pretty #{rerun}"
-std_opts = "--format progress features --tags ~@wip --tags ~@wip-new-core -r features --strict #{cucumber_pro_opts}"
+std_opts = "--format progress features -r features --strict #{cucumber_pro_opts}"
 std_opts << " --tags ~@wip-jruby" if defined?(JRUBY_VERSION)
 
-wip_opts = "--color -r features --tags @wip,@wip-new-core"
+wip_opts = "--color -r features --tags @wip"
 wip_opts << ",@wip-jruby" if defined?(JRUBY_VERSION)
 %>
 default:     <%= std_opts %> --tags ~@jruby

data/features/docs/api/listen_for_events.feature

@@ -1,5 +1,8 @@
 Feature: Listen for events
 
+  Cucumber's `config` object has an event bus that you can use to listen for
+  various events that happen during your test run.
+
   Scenario: Step Matched Event
     Given a file named "features/test.feature" with:
       """
@@ -16,9 +19,8 @@ Feature: Listen for events
       """
       AfterConfiguration do |config|
         io = config.out_stream
-        config.on_event Cucumber::Events::StepMatch do |event|
+        config.on_event :step_match do |event|
           io.puts "Success!"
-          io.puts "Event type:      #{event.class}"
           io.puts "Step name:       #{event.test_step.name}"
           io.puts "Source location: #{event.step_match.location}"
         end
@@ -28,7 +30,6 @@ Feature: Listen for events
     Then it should pass with:
       """
       Success!
-      Event type:      Cucumber::Events::StepMatch
       Step name:       matching
       Source location: features/step_definitions/steps.rb:1
       """
@@ -45,14 +46,14 @@ Feature: Listen for events
       """
       AfterConfiguration do |config|
         io = config.out_stream
-        config.on_event Cucumber::Events::AfterTestStep do |event|
-          io.puts "YO"
+        config.on_event :test_step_finished do |event|
+          io.puts event.result.passed?
         end
       end
       """
     When I run `cucumber`
     Then it should pass with:
       """
-      YO
+      true
       """
 

data/features/docs/cli/help.feature

@@ -0,0 +1,8 @@
+Feature: Help
+
+  Running `cucumber --help` shows you command-line options.
+
+  Scenario: Show help
+    When I run `cucumber --help`
+    Then it should pass
+    And I should see the CLI help

data/features/docs/cli/retry_failing_tests.feature

@@ -1,32 +1,67 @@
-@wip
 Feature: Retry failing tests
 
   Retry gives you a way to get through flaky tests that usually pass after a few runs.
   This gives a development team a way forward other than disabling a valuable test.
-  
+
   - Specify max retry count in option
   - Output information to the screen
   - Output retry information in test report
-  
+
   Questions:
   use a tag for flaky tests?  Global option to retry any test that fails?
-  
+
   Background:
-    Given a scenario "Flakey" that fails once, then passes
-    And a scenario "Shakey" that fails twice, then passes
+    Given a scenario "Fails-once" that fails once, then passes
+    And a scenario "Fails-twice" that fails twice, then passes
     And a scenario "Solid" that passes
-    And a scenario "No Dice" that fails
-  
-  Scenario:
-    When I run `cucumber -q --retry 1`
+    And a scenario "Fails-forever" that fails
+
+  Scenario: Retry once, so Fails-once starts to pass
+    When I run `cucumber -q --retry 1 --format summary`
+    Then it should fail with:
+      """
+      7 scenarios (5 failed, 2 passed)
+      """
+    And it should fail with:
+      """
+      Fails-forever
+        Fails-forever ✗
+        Fails-forever ✗
+
+      Solid
+        Solid ✓
+
+      Fails-once feature
+        Fails-once ✗
+        Fails-once ✓
+
+      Fails-twice feature
+        Fails-twice ✗
+        Fails-twice ✗
+      """
+
+  Scenario: Retry twice, so Fails-twice starts to pass too
+    When I run `cucumber -q --retry 2 --format summary`
     Then it should fail with:
       """
-      4 scenarios (2 passed, 2 failed)
+      9 scenarios (6 failed, 3 passed)
+      """
+    And it should fail with:
       """
+      Fails-forever
+        Fails-forever ✗
+        Fails-forever ✗
+        Fails-forever ✗
+
+      Solid
+        Solid ✓
+
+      Fails-once feature
+        Fails-once ✗
+        Fails-once ✓
 
-  Scenario:
-    When I run `cucumber -q --retry 2`
-    Then it should pass with:
+      Fails-twice feature
+        Fails-twice ✗
+        Fails-twice ✗
+        Fails-twice ✓
       """
-      4 scenarios (3 passed, 1 failed)
-      """

data/features/docs/defining_steps/nested_steps_i18n.feature

@@ -8,6 +8,7 @@ Feature: Nested Steps in I18n
     And a step definition that looks like this:
       """ruby
       # -*- coding: utf-8 -*-
+      # frozen_string_literal: true
       前提 /a turtle/ do
         puts "turtle!"
       end
@@ -17,6 +18,7 @@ Feature: Nested Steps in I18n
     Given a step definition that looks like this:
       """ruby
       # -*- coding: utf-8 -*-
+      # frozen_string_literal: true
       前提 /two turtles/ do
         steps %{
           前提 a turtle

data/features/docs/defining_steps/printing_messages.feature

@@ -135,7 +135,6 @@ Feature: Pretty formatter - Printing messages
         Multiple
         
         Announce
-        
         Me
         ..UUU
         Announce with fail

data/features/docs/defining_steps/skip_scenario.feature

@@ -28,37 +28,3 @@ Feature: Skip Scenario
       2 steps (2 skipped)
 
       """
-
-  @spawn
-  Scenario: Use (deprecated) legacy API
-    Given a file named "features/test.feature" with:
-      """
-      Feature: test
-        Scenario: test
-          Given this step passes
-          And this step passes
-      """
-    And the standard step definitions
-    And a file named "features/support/hook.rb" with:
-      """
-      Before do |scenario|
-        scenario.skip_invoke!
-      end
-      """
-    When I run `cucumber -q`
-    Then it should pass with:
-      """
-      Feature: test
-
-        Scenario: test
-          Given this step passes
-          And this step passes
-
-      1 scenario (1 skipped)
-      2 steps (2 skipped)
-
-      """
-    And the stderr should contain:
-      """
-      deprecated
-      """

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 Cucumber::Events::BeforeTestCase do |event|
+            config.on_event :test_case_starting do |event|
               print_test_case_name(event.test_case)
             end
           end
@@ -41,34 +41,6 @@ Feature: Custom Formatter
 
       """
 
-  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.
 
@@ -99,7 +71,7 @@ Feature: Custom Formatter
       """
 
   Scenario: Use both old and new
-    You can use a specific shim to opt-in to both APIs at once.
+    You can both APIs at once, for now
 
     Given a file named "features/support/custom_mixed_formatter.rb" with:
       """

data/features/docs/formatters/summary_formatter.feature

@@ -0,0 +1,34 @@
+Feature: Spec formatter
+
+  This formatter mimics the output from tools like RSpec or Mocha, giving an 
+  overview of each feature and scenario but omitting the steps.
+
+  Background:
+    Given the standard step definitions
+
+  Scenario: A couple of scenarios
+    Given a file named "features/test.feature" with:
+    """
+    Feature: Test
+      Scenario: Passing
+        Given this step passes
+
+      Scenario: Failing
+        Given this step fails
+    """
+    When I run `cucumber --format summary`
+    Then it should fail with exactly:
+    """
+    Test
+      Passing ✓
+      Failing ✗
+
+    Failing Scenarios:
+    cucumber features/test.feature:5 # Scenario: Failing
+
+    2 scenarios (1 failed, 1 passed)
+    2 steps (1 failed, 1 passed)
+    0m0.012s
+
+    """
+