cucumber 4.0.0.rc.1 → 4.0.0.rc.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 272094a2efb99945d2d0e3e6a91bae0b855428d0
-  data.tar.gz: 400106f2e8a065a57bb9d85171b5fa7e98999d3a
+SHA256:
+  metadata.gz: cf81b80049480e75914eab234ad671608f10a474e8850ecbda9e3cdca96f9e4e
+  data.tar.gz: 4a692380408f3bd93ff079e192391bc921967ce96bf090f7cf010269c806a6a5
 SHA512:
-  metadata.gz: 7e4c314d1e1b30f1d8e5ef171a7fb5ca1120bd9cd9c2ec2f1e353f7ee38d74ddc04771a8506c62ef4e71c9b58aeb6f28dccd3d2d979f2119dcc10b30c2ca7d2e
-  data.tar.gz: 854f93e0396ebc737e6f5f525028654042b96387b90c12ae7b41f65cd76e03668cf50c9a0a9517455f080a76b5c21a4825b3fe2f51b353471a91e45f47cb5139
+  metadata.gz: 3b1a3f2fcb5db9237bef23b510cadf0286ea61b19adab4fbcc67f4df14ded7adf2c33d2e4165f45be7361dce6fb418f74deadf3e0e1a7d4e8f2ba23c0e8a6c62
+  data.tar.gz: 79d699ae305489e034fb16edf31d36304c2a0fb486bff4003f8e24abd786d81510eab5fdca6d32ca3348ce24b634cc6954d800b03494e3ef1dbba57ab7b9cc78

data/CHANGELOG.md

@@ -9,23 +9,115 @@ This document is formatted according to the principles of [Keep A CHANGELOG](htt
 Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blob/master/CONTRIBUTING.md) for more info on how to contribute to Cucumber.
 
 ----
+## [4.0.0.rc.6](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.5...4.0.0.rc.6)
 
-## [In Git](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.1...master) (Not released)
+### Changed
+
+* Code snippet for an undefined step with a Doc String will ouput `doc_string` instead of `string` in block params
+  ([#1401](https://github.com/cucumber/cucumber-ruby/issues/1401)
+   [#1402](https://github.com/cucumber/cucumber-ruby/pull/1402)
+   [karamosky](https://github.com/karamosky))
+
+* Updated monorepo libraries:
+  - cucumber-gherkin ~> 13
+  - cucumber-html-formatter ~> 6
+  - cucumber-cucumber-expressions ~> 10
+
+* Use `cucumber-ruby-core` 7.0.0
+
+* Use `cucumber-ruby-wire` 3.0.0
+
+* Use `body` field of attachments
+
+### Improved
+
+* `--out url` updates:
+  * supports redirects
+  * use `PUT` method by default
+  * use a cURL like options (for example: `cucumber --out 'http://example.com -X POST -H Content-Type: json`)
+
+## [4.0.0.rc.5](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.4...4.0.0.rc.5)
 
 ### Added
 
-### Changed
+* New html formatter enabled by option `--format html --out report.html`.
+
+* Accept `--out URL` to POST results to a web server
+  If a URL is used as output, the output will be sent with a POST request.
+  This can be overridden by specifying e.g. `http-method=PUT` as a query parameter.
+  Other `http-` prefixed query parameters will be converted to request headers
+  (with the `http-` prefix stripped off).
+
+
+## [4.0.0.rc.4](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.3...4.0.0.rc.4)
+
+### Added
+
+* Add `message`formatter which produces `Cucumber::Messages` ndjson output.
+* Comply with [`cucumber-compatibility-kit](https://github.com/cucumber/cucumber/tree/master/compatibility-kit)
+* Methods `log` and `attach` can be used in step definitions to attach text or images
 
 ### Deprecated
 
+* `--format=json` in favor of the `message` formatter and the stand-alone JSON formatter
+* `puts` in step definitions in favor of `log` ([cucumber#897](https://github.com/cucumber/cucumber/issues/897))
+* `embed` in step definitions in favor of `attach` ([cucumber#897](https://github.com/cucumber/cucumber/issues/897))
+
+
+## [4.0.0.rc.3](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.2...v4.0.0.rc.3)
+
+### Changed
+
+* Update to cucumber-wire 1.1.
+
+
+## [4.0.0.rc.2](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.1...v4.0.0.rc.2)
+
+### 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
+* 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 +142,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 +768,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
 
@@ -16,8 +15,8 @@ your team.
 
 Where to get more info:
 
- * The main website: https://cucumber.io/ 
- * Documentation: https://docs.cucumber.io
+ * The main website: https://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,11 +24,11 @@ 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
+* JRuby 9.2 (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/master/docs/jruby-limitations.md))
 
 ## 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" \
@@ -23,7 +22,9 @@ module Cucumber
         'stepdefs'    => ['Cucumber::Formatter::Stepdefs',    "Prints All step definitions with their locations. Same as\n" \
                                                               "#{INDENT}the usage formatter, except that steps are not printed."],
         'junit'       => ['Cucumber::Formatter::Junit',       'Generates a report similar to Ant+JUnit.'],
-        'json'        => ['Cucumber::Formatter::Json',        'Prints the feature as JSON'],
+        'json'        => ['Cucumber::Formatter::Json',        '[DEPRECATED] Prints the feature as JSON'],
+        'message'     => ['Cucumber::Formatter::Message',     'Outputs protobuf messages'],
+        'html'        => ['Cucumber::Formatter::HTML',        'Outputs HTML report'],
         'summary'     => ['Cucumber::Formatter::Summary',     'Summary output of feature and scenarios']
       }.freeze
       max = BUILTIN_FORMATS.keys.map(&:length).max
@@ -104,7 +105,7 @@ module Cucumber
             add_option :formats, [*parse_formats(v), @out_stream]
           end
           opts.on('--init', *init_msg) { |_v| initialize_project }
-          opts.on('-o', '--out [FILE|DIR]', *out_msg) { |v| out_stream v }
+          opts.on('-o', '--out [FILE|DIR|URL]', *out_msg) { |v| out_stream v }
           opts.on('-t TAG_EXPRESSION', '--tags TAG_EXPRESSION', *tags_msg) { |v| add_tag v }
           opts.on('-n NAME', '--name NAME', *name_msg) { |v| add_option :name_regexps, /#{v}/ }
           opts.on('-e', '--exclude PATTERN', *exclude_msg) { |v| add_option :excludes, Regexp.new(v) }
@@ -189,10 +190,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
@@ -298,10 +296,15 @@ Specify SEED to reproduce the shuffling from a previous run.
 
       def out_msg
         [
-          'Write output to a file/directory instead of STDOUT. This option',
+          'Write output to a file/directory/URL instead of STDOUT. This option',
           'applies to the previously specified --format, or the',
           'default format if no format is specified. Check the specific',
-          "formatter's docs to see whether to pass a file or a dir."
+          "formatter's docs to see whether to pass a file, dir or URL.",
+          "\n",
+          'When using a URL, the output of the formatter will be sent as the HTTP request body.',
+          'HTTP headers and request method can be set with http- prefixed query parameters,',
+          'for example ?http-content-type=application/json&http-method=PUT.',
+          'All http- prefixed query parameters will be removed from the sent query parameters.'
         ]
       end
 
@@ -309,11 +312,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

@@ -3,6 +3,7 @@
 require 'cucumber/constantize'
 require 'cucumber/cli/rerun_file'
 require 'cucumber/events'
+require 'cucumber/messages'
 require 'cucumber/core/event_bus'
 require 'cucumber/core/test/result'
 require 'forwardable'
@@ -54,7 +55,7 @@ module Cucumber
     end
 
     def seed
-      Integer(@options[:seed] || rand(0xFFFF))
+      @options[:seed]
     end
 
     def dry_run?
@@ -168,9 +169,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
@@ -238,6 +243,10 @@ module Cucumber
       @options[:event_bus]
     end
 
+    def id_generator
+      @id_generator ||= Cucumber::Messages::IdGenerator::UUID.new
+    end
+
     private
 
     def default_options

data/lib/cucumber/deprecate.rb

@@ -5,13 +5,37 @@ require 'cucumber/gherkin/formatter/ansi_escapes'
 
 module Cucumber
   module Deprecate
-    module ForUsers
-      AnsiEscapes = Cucumber::Gherkin::Formatter::AnsiEscapes
+    class AnsiString
+      include Cucumber::Gherkin::Formatter::AnsiEscapes
+
+      def self.failure_message(message)
+        AnsiString.new.failure_message(message)
+      end
+
+      def failure_message(message)
+        failed + message + reset
+      end
+    end
 
+    class CliOption
+      def self.deprecate(stream, option, message, remove_after_version)
+        return if stream.nil?
+        stream.puts(
+          AnsiString.failure_message(
+            "\nWARNING: #{option} is deprecated" \
+            " and will be removed after version #{remove_after_version}.\n#{message}.\n"
+          )
+        )
+      end
+    end
+
+    module ForUsers
       def self.call(message, method, remove_after_version)
-        STDERR.puts AnsiEscapes.failed + "\nWARNING: ##{method} is deprecated" \
-        " and will be removed after version #{remove_after_version}. #{message}.\n" \
-        "(Called from #{caller(3..3).first})" + AnsiEscapes.reset
+        STDERR.puts AnsiString.failure_message(
+          "\nWARNING: ##{method} is deprecated" \
+          " and will be removed after version #{remove_after_version}. #{message}.\n" \
+          "(Called from #{caller(3..3).first})"
+        )
       end
     end