cucumber 4.0.0.rc.1 → 4.0.0.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 272094a2efb99945d2d0e3e6a91bae0b855428d0
-  data.tar.gz: 400106f2e8a065a57bb9d85171b5fa7e98999d3a
+SHA256:
+  metadata.gz: 63fada72f4a011868619082a74f21360edd8751372c468509d2c56db437c29e1
+  data.tar.gz: 5a0454b1251822723b3f5d6f777907e7c49751201f292357730350816a09123a
 SHA512:
-  metadata.gz: 7e4c314d1e1b30f1d8e5ef171a7fb5ca1120bd9cd9c2ec2f1e353f7ee38d74ddc04771a8506c62ef4e71c9b58aeb6f28dccd3d2d979f2119dcc10b30c2ca7d2e
-  data.tar.gz: 854f93e0396ebc737e6f5f525028654042b96387b90c12ae7b41f65cd76e03668cf50c9a0a9517455f080a76b5c21a4825b3fe2f51b353471a91e45f47cb5139
+  metadata.gz: 6947dbe7784aa7068e892762c1f96faced5842feb16e1b756a2a5c181a46f021f1c0df56229a266003137ef0009d97c9e5489e971ceeed24bf0b432c3fd16769
+  data.tar.gz: fa930e37ce5a05ee31e270d1f20642defb0b771142969d8945550543e60dd8546afdd272e5707319a7b00ce9bfa9d28e01e6da8f2585a8e97a25b08072a31b75

data/CHANGELOG.md

@@ -10,22 +10,53 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ----
 
-## [In Git](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.1...master) (Not released)
+## [4.0.0.rc.2](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.1...v4.0.0.rc.2) (Not released)
 
 ### Added
+* There is a new methodology in Cucumber for how the auto-loader works
+   * The old `load` behaviour is now replaced with a newer `require` behaviour
+   * Cucumber will (From version 4), now auto-load files using the `require` method
+   * If you wish to alter this, then you can set a top level config option: `Cucumber.use_legacy_autoloader`
+   * Like most config options, setting this inside a `spec_helper.rb` or `env.rb` file is advised
+   * For more information on this change, including why it was made. Please read this
+   [Blog Post](www.google.com)
+   ([#1349](https://github.com/cucumber/cucumber-ruby/pull/1349),
+    [#1043](https://github.com/cucumber/cucumber-ruby/issues/1043)
+    [luke-hill](https://github.com/luke-hill))
 
 ### Changed
-
-### Deprecated
+* Going forward the minimum ruby version for all cucumber based gems is 2.3
+([luke-hill](https://github.com/luke-hill))
 
 ### Removed
+* Removed Travis publish job for cucumber-pro(a.k.a. jam)
+  ([#1350](https://github.com/cucumber/cucumber-ruby/pull/1350)
+   [luke-hill](https://github.com/luke-hill))
+
+* Drop support for JRuby. We may add this back if new versions of protobuf for JRuby
+  start working, or if someone can make the build pass with an older version.
+  All this means is we're ok to make releases while the jruby CI job is failing.
+
+  ([aslakhellesoy](https://github.com/aslakhellesoy))
+
+* Remove `dots-formatter introduced in `4.0.0rc1`
 
 ### Fixed
 
-### Added
+* Fix the placeholder expansions in the json formatter
+  ([#1361](https://github.com/cucumber/cucumber-ruby/pull/1361)
+   [brasmusson](https://github.com/brasmusson))
+* Fix seed printed in cucumber UI to match the seed that was actually used.
+  ([#1329](https://github.com/cucumber/cucumber-ruby/pull/1329)
+   [deivid-rodriguez](https://github.com/deivid-rodriguez))
+* Make SIGINT/`Ctrl+c` behavior consistent with SIGTERM/`kill` behavior - now first invocation causes existing scenario to stop running and jump to `at_exit`, second invocation causes immediate exit. Before that first invocation only instructed Cucumber to exit after scenario and second invocation caused immediate exit skipping `at_exit`.
+  ([#1353](https://github.com/cucumber/cucumber-ruby/pull/1353)
+   [akostadinov](https://github.com/akostadinov))
 
 ### Improved
 
+* Filter out any lines containing `site_ruby` from stacktrace
+
 ## [4.0.0.rc.1](https://github.com/cucumber/cucumber-ruby/compare/v3.1.2...v4.0.0.rc.1) (2018-09-29)
 
 ### Added
@@ -50,6 +81,7 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 * Let the Pretty Formatter use events.
   ([#1305](https://github.com/cucumber/cucumber-ruby/pull/1305)
    [brasmusson](https://github.com/brasmusson))
+* Use single quotes in generated template steps ([#1323](https://github.com/cucumber/cucumber-ruby/pull/1323) [acant](https://github.com/acant))
 
 ### Removed
 
@@ -675,7 +707,7 @@ all.
 * Upgrade Gherkin version to remove warnings when running on JRuby. ([#393](https://github.com/cucumber/cucumber-ruby/issues/393) Oleg Sukhodolsky)
 * Do not use TagExpression.eval() which is deprecated in Gherkin 2.11.7 ([#420](https://github.com/cucumber/cucumber-ruby/issues/420) Oleg Sukhodolsky)
 
-## 1.2.4
+## 1.2.4
 
 Yanked. See ([#428](https://github.com/cucumber/cucumber-ruby/issues/428)).
 

data/CONTRIBUTING.md

@@ -55,7 +55,7 @@ gem 'byebug'
 If you are new to the project or to OSS, check the label
 [Easy](https://github.com/cucumber/cucumber-ruby/labels/Easy). Also, you can
 help us to correct style violations reported here:
-[.rubocop_todo.yaml](https://github.com/cucumber/cucumber-ruby/blob/master/.rubocop_todo.yml).
+[.rubocop_todo.yml](https://github.com/cucumber/cucumber-ruby/blob/master/.rubocop_todo.yml).
 
 ## Release Process
 
@@ -69,20 +69,3 @@ Now release it
     git commit -m "Release X.Y.Z"
     # Make sure you run gem signin as the cukebot@cucumber.io user before running the following step. Credentials can be found in 1Password
     rake release
-
-## Gaining Release Karma
-
-To become a release manager, create a pull request adding your name to the list below, and include your Rubygems email address in the ticket. One of the existing Release managers will then add you.
-
-Current release managers:
-  * [Matt Wynne](https://rubygems.org/profiles/mattwynne)
-  * [Aslak Hellesøy](https://rubygems.org/profiles/aslakhellesoy)
-  * [Oleg Sukhodolsky](https://rubygems.org/profiles/os97673)
-  * [Steve Tooke](https://rubygems.org/profiles/tooky)
-  * [Björn Rasmusson](https://rubygems.org/profiles/brasmusson)
-  * [Andrew Walter](https://rubygems.org/profiles/xtrasimplicity)
-
-To grant release karma, issue the following commands:
-
-    gem owner cucumber --add <NEW OWNER RUBYGEMS EMAIL>
-    gem owner cucumber-core --add <NEW OWNER RUBYGEMS EMAIL>

data/README.md

@@ -5,7 +5,6 @@
 
 [![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)
 
 # Cucumber
 
@@ -17,7 +16,7 @@ your team.
 Where to get more info:
 
  * The main website: https://cucumber.io/ 
- * Documentation: https://docs.cucumber.io
+ * Documentation: https://cucumber.io/docs
  * Ruby API Documentation: http://www.rubydoc.info/github/cucumber/cucumber-ruby/
  * Support forum: https://groups.google.com/group/cukes
  * Chat: ([Slack](https://cucumber.io/support#slack) and [Gitter](https://cucumber.io/support#gitter))
@@ -25,10 +24,10 @@ Where to get more info:
 See [CONTRIBUTING.md](CONTRIBUTING.md) for info on contributing to Cucumber.
 
 ## Supported platforms
+* Ruby 2.6
 * Ruby 2.5
 * Ruby 2.4
 * Ruby 2.3
-* Ruby 2.2
 * JRuby 9.1
 
 ## Code of Conduct

data/lib/autotest/cucumber_mixin.rb

@@ -80,10 +80,10 @@ module Autotest::CucumberMixin
         open("| #{cmd}", 'r') do |f| # rubocop:disable Security/Open
           until f.eof?
             c = f.getc || break
-            put_command(c)
+            print(c)
             line << c
             next unless c == "\n"
-            results << join_line
+            results << line.join
             line.clear
           end
         end
@@ -96,14 +96,6 @@ module Autotest::CucumberMixin
     hook :ran_features
   end
 
-  def put_command(cmd)
-    RUBY_VERSION >= '1.9' ? print(cmd) : putcmd(c)
-  end
-
-  def join_line
-    RUBY_VERSION >= '1.9' ? line.join : line.pack('c*')
-  end
-
   def make_cucumber_cmd(features_to_run, _dirty_features_filename)
     return '' if features_to_run.empty?
 

data/lib/cucumber.rb

@@ -10,7 +10,7 @@ require 'cucumber/term/ansicolor'
 
 module Cucumber
   class << self
-    attr_accessor :wants_to_quit
+    attr_accessor :wants_to_quit, :use_legacy_autoloader
 
     def logger
       return @log if @log

data/lib/cucumber/cli/configuration.rb

@@ -108,7 +108,7 @@ module Cucumber
       end
 
       def to_hash
-        Hash(@options).merge(out_stream: @out_stream, error_stream: @error_stream)
+        Hash(@options).merge(out_stream: @out_stream, error_stream: @error_stream, seed: seed)
       end
 
       private

data/lib/cucumber/cli/main.rb

@@ -86,6 +86,7 @@ module Cucumber
           exit_unable_to_finish! if Cucumber.wants_to_quit
           Cucumber.wants_to_quit = true
           STDERR.puts "\nExiting... Interrupt again to exit immediately."
+          exit_unable_to_finish
         end
       end
 

data/lib/cucumber/cli/options.rb

@@ -13,7 +13,6 @@ module Cucumber
       BUILTIN_FORMATS = {
         'pretty'      => ['Cucumber::Formatter::Pretty',      'Prints the feature as is - in colours.'],
         'progress'    => ['Cucumber::Formatter::Progress',    'Prints one character per scenario.'],
-        'dots'        => ['Cucumber::Formatter::Dots',        'Simple progress output to console'],
         'rerun'       => ['Cucumber::Formatter::Rerun',       'Prints failing files with line numbers.'],
         'usage'       => ['Cucumber::Formatter::Usage',       "Prints where step definitions are used.\n" \
                                                               "#{INDENT}The slowest step definitions (with duration) are\n" \
@@ -189,10 +188,7 @@ Specify SEED to reproduce the shuffling from a previous run.
       end
 
       def dry_run_msg
-        [
-          'Invokes formatters without executing the steps.',
-          'This also omits the loading of your support/env.rb file if it exists.'
-        ]
+        ['Invokes formatters without executing the steps.']
       end
 
       def exclude_msg
@@ -309,11 +305,13 @@ Specify SEED to reproduce the shuffling from a previous run.
         [
           'Require files before executing the features. If this',
           'option is not specified, all *.rb files that are',
-          'siblings or below the features will be loaded auto-',
+          'siblings of or below the features will be loaded auto-',
           'matically. Automatic loading is disabled when this',
-          'option is specified, and all loading becomes explicit.',
-          'Files under directories named "support" are always',
-          'loaded first.',
+          'option is specified; all loading becomes explicit.',
+          'Files in directories named "support" are still always',
+          'loaded first when their parent directories are',
+          'required or if the "support" directoires themselves are',
+          'explicitly required.',
           'This option can be specified multiple times.'
         ]
       end

data/lib/cucumber/cli/profile_loader.rb

@@ -51,14 +51,29 @@ Defined profiles in cucumber.yml:
       # Loads the profile, processing it through ERB and YAML, and returns it as a hash.
       def cucumber_yml
         return @cucumber_yml if @cucumber_yml
-        unless cucumber_yml_defined?
-          raise(ProfilesNotDefinedError, "cucumber.yml was not found.  Current directory is #{Dir.pwd}." \
-          "Please refer to cucumber's documentation on defining profiles in cucumber.yml.  You must define" \
-          "a 'default' profile to use the cucumber command without any arguments.\nType 'cucumber --help' for usage.\n")
+
+        ensure_configuration_file_exists
+        process_configuration_file_with_erb
+        load_configuration
+
+        if @cucumber_yml.nil? || !@cucumber_yml.is_a?(Hash)
+          raise(YmlLoadError, 'cucumber.yml was found, but was blank or malformed. ' \
+          "Please refer to cucumber's documentation on correct profile usage.\n")
         end
 
+        @cucumber_yml
+      end
+
+      def ensure_configuration_file_exists
+        return if cucumber_yml_defined?
+
+        raise(ProfilesNotDefinedError, "cucumber.yml was not found.  Current directory is #{Dir.pwd}." \
+                                       "Please refer to cucumber's documentation on defining profiles in cucumber.yml.  You must define" \
+                                       "a 'default' profile to use the cucumber command without any arguments.\nType 'cucumber --help' for usage.\n")
+      end
+
+      def process_configuration_file_with_erb
         require 'erb'
-        require 'yaml'
         begin
           @cucumber_erb = if RUBY_VERSION >= '2.6'
                             ERB.new(IO.read(cucumber_file), trim_mode: '%').result(binding)
@@ -68,19 +83,15 @@ Defined profiles in cucumber.yml:
         rescue StandardError
           raise(YmlLoadError, "cucumber.yml was found, but could not be parsed with ERB.  Please refer to cucumber's documentation on correct profile usage.\n#{$ERROR_INFO.inspect}")
         end
+      end
 
+      def load_configuration
+        require 'yaml'
         begin
           @cucumber_yml = YAML.load(@cucumber_erb) # rubocop:disable Security/YAMLLoad
         rescue StandardError
           raise(YmlLoadError, "cucumber.yml was found, but could not be parsed. Please refer to cucumber's documentation on correct profile usage.\n")
         end
-
-        if @cucumber_yml.nil? || !@cucumber_yml.is_a?(Hash)
-          raise(YmlLoadError, 'cucumber.yml was found, but was blank or malformed. ' \
-          "Please refer to cucumber's documentation on correct profile usage.\n")
-        end
-
-        @cucumber_yml
       end
 
       # Locates cucumber.yml file. The file can end in .yml or .yaml,

data/lib/cucumber/configuration.rb

@@ -54,7 +54,7 @@ module Cucumber
     end
 
     def seed
-      Integer(@options[:seed] || rand(0xFFFF))
+      @options[:seed]
     end
 
     def dry_run?
@@ -168,9 +168,13 @@ module Cucumber
 
     def support_to_load
       support_files = all_files_to_load.select { |f| f =~ %r{/support/} }
+
+      # env_files are separated from other_files so we can ensure env files
+      # load first.
+      #
       env_files = support_files.select { |f| f =~ %r{/support/env\..*} }
       other_files = support_files - env_files
-      @options[:dry_run] ? other_files : env_files + other_files
+      env_files.reverse + other_files.reverse
     end
 
     def all_files_to_load

data/lib/cucumber/errors.rb

@@ -10,8 +10,8 @@ module Cucumber
 
       begin
         raise new(with_prefix(step_name)) # rubocop:disable Style/RaiseArgs
-      rescue StandardError => exception
-        return exception
+      rescue StandardError => e
+        return e
       end
     end
 

data/lib/cucumber/formatter/ast_lookup.rb

@@ -12,7 +12,7 @@ module Cucumber
       end
 
       def on_gherkin_source_parsed(event)
-        @gherkin_documents[event.gherkin_document[:uri]] = event.gherkin_document
+        @gherkin_documents[event.gherkin_document.uri] = event.gherkin_document
       end
 
       def gherkin_document(uri)
@@ -34,7 +34,7 @@ module Cucumber
       def snippet_step_keyword(test_step)
         uri = test_step.location.file
         document = gherkin_document(uri)
-        dialect = ::Gherkin::Dialect.for(document[:feature][:language])
+        dialect = ::Gherkin::Dialect.for(document.feature.language)
         given_when_then_keywords = [dialect.given_keywords, dialect.when_keywords, dialect.then_keywords].flatten.uniq.reject { |kw| kw == '* ' }
         keyword_lookup = step_keyword_lookup(uri)
         keyword = nil
@@ -69,25 +69,28 @@ module Cucumber
 
         def initialize(gherkin_document)
           @lookup_hash = {}
-          process_scenario_container(gherkin_document[:feature])
+          process_scenario_container(gherkin_document.feature)
         end
 
         private
 
         def process_scenario_container(container)
-          container[:children].each do |child|
-            if !child[:rule].nil?
-              process_scenario_container(child[:rule])
-            elsif !child[:scenario].nil?
-              if child[:scenario][:examples].empty?
-                @lookup_hash[child[:scenario][:location][:line]] = ScenarioSource.new(:Scenario, child[:scenario])
-
-              else
-                child[:scenario][:examples].each do |examples|
-                  examples[:table_body].each do |row|
-                    @lookup_hash[row[:location][:line]] = ScenarioOutlineSource.new(:ScenarioOutline, child[:scenario], examples, row)
-                  end
-                end
+          container.children.each do |child|
+            if child.respond_to?(:rule) && child.rule
+              process_scenario_container(child.rule)
+            elsif child.respond_to?(:scenario) && child.scenario
+              process_scenario(child)
+            end
+          end
+        end
+
+        def process_scenario(child)
+          if child.scenario.examples.empty?
+            @lookup_hash[child.scenario.location.line] = ScenarioSource.new(:Scenario, child.scenario)
+          else
+            child.scenario.examples.each do |examples|
+              examples.table_body.each do |row|
+                @lookup_hash[row.location.line] = ScenarioOutlineSource.new(:ScenarioOutline, child.scenario, examples, row)
               end
             end
           end
@@ -99,22 +102,22 @@ module Cucumber
 
         def initialize(gherkin_document)
           @lookup_hash = {}
-          process_scenario_container(gherkin_document[:feature])
+          process_scenario_container(gherkin_document.feature)
         end
 
         private
 
         def process_scenario_container(container)
-          container[:children].each do |child|
-            if !child[:rule].nil?
-              process_scenario_container(child[:rule])
-            elsif !child[:scenario].nil?
-              child[:scenario][:steps].each do |step|
-                @lookup_hash[step[:location][:line]] = StepSource.new(:Step, step)
+          container.children.each do |child|
+            if child.respond_to?(:rule) && child.rule
+              process_scenario_container(child.rule)
+            elsif child.respond_to?(:scenario) && child.scenario
+              child.scenario.steps.each do |step|
+                @lookup_hash[step.location.line] = StepSource.new(:Step, step)
               end
-            elsif !child[:background].nil?
-              child[:background][:steps].each do |step|
-                @lookup_hash[step[:location][:line]] = StepSource.new(:Step, step)
+            elsif !child.background.nil?
+              child.background.steps.each do |step|
+                @lookup_hash[step.location.line] = StepSource.new(:Step, step)
               end
             end
           end
@@ -128,32 +131,34 @@ module Cucumber
 
         def initialize(gherkin_document)
           @lookup_hash = {}
-          process_scenario_container(gherkin_document[:feature], nil)
+          process_scenario_container(gherkin_document.feature, nil)
         end
 
         private
 
+        # rubocop:disable Metrics/PerceivedComplexity
         def process_scenario_container(container, original_previous_node)
-          container[:children].each do |child|
+          container.children.each do |child|
             previous_node = original_previous_node
-            if !child[:rule].nil?
-              process_scenario_container(child[:rule], original_previous_node)
-            elsif !child[:scenario].nil?
-              child[:scenario][:steps].each do |step|
-                node = KeywordSearchNode.new(step[:keyword], previous_node)
-                @lookup_hash[step[:location][:line]] = node
+            if child.respond_to?(:rule) && child.rule
+              process_scenario_container(child.rule, original_previous_node)
+            elsif child.respond_to?(:scenario) && child.scenario
+              child.scenario.steps.each do |step|
+                node = KeywordSearchNode.new(step.keyword, previous_node)
+                @lookup_hash[step.location.line] = node
                 previous_node = node
               end
-            elsif !child[:background].nil?
-              child[:background][:steps].each do |step|
-                node = KeywordSearchNode.new(step[:keyword], previous_node)
-                @lookup_hash[step[:location][:line]] = node
+            elsif child.respond_to?(:background) && child.background
+              child.background.steps.each do |step|
+                node = KeywordSearchNode.new(step.keyword, previous_node)
+                @lookup_hash[step.location.line] = node
                 previous_node = node
                 original_previous_node = previous_node
               end
             end
           end
         end
+        # rubocop:enable Metrics/PerceivedComplexity
       end
     end
   end