cucumber 3.1.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fef34be35b9337e5d78fe68a0b9e642e96a5bc8e
-  data.tar.gz: 5331fac4008b678c3bdc18ec18f4df77e3e67bfb
+SHA256:
+  metadata.gz: fd820c5e08e32e33bba11e646e1e98d4382028b6e071914ddcb4982bb0657278
+  data.tar.gz: 13c93ab1fa304955ac45f8ce702eeb68dbcf2e316e383c9ae0ababe04a476762
 SHA512:
-  metadata.gz: 560857486693d265017f21421942be4bc737f852d2972cd5a76c93f678ffe4ac06a0fd58e91f52b7ccb2d5c63156c2af13cb2e11e2bdaf9e194e516ddd663387
-  data.tar.gz: e3ecdbb8d5a93e5e20d0e72a46be9ccb10021b12caa7d023cd3f16e845882331231764fb772cf7d1935c4db724166dbbe3eb40bbda33a4a84760ff7bd296e54a
+  metadata.gz: ddd5940fbb47aaa12942842323cf81372051ddf0ad496d9213dd93d0538afbe80e5e35edf6a5d27ccdea2840a1091f86b6f65ec46e14e017cbbe724fd61e1269
+  data.tar.gz: 27e575d0c0730bf88574d7e42262e031ff34328b71a22af15d0a3c1dc8d3b14dacc7d62250a912de01dda4d85bdd22615d166faaa78b81dc5e24bb75a71374fd

data/CHANGELOG.md

@@ -10,6 +10,178 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ----
 
+## [4.0.0](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.5...v4.0.0)
+
+### Changed
+
+* `log` method can now be called with non-string objects and will run `.to_s` on them. [#1410](https://github.com/cucumber/cucumber-ruby/issues/1410)
+
+### Improved
+
+* Display snippet when using undefined parameter type [#1411](https://github.com/cucumber/cucumber-ruby/issues/1411)
+
+## [4.0.0.rc.6](https://github.com/cucumber/cucumber-ruby/compare/v4.0.0.rc.5...4.0.0.rc.6)
+
+### 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
+
+* 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
+
+* 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
+
+* Added support for new `Rule` keyword. [Read more here.](https://github.com/cucumber/cucumber/blob/master/gherkin/CHANGELOG.md#6013---2018-09-25)
+* Added new `dots` formatter. This is the first step of a larger strategy to move the formatters to a new architecture where they delegate to shared executables via messages.
+
+### Changed
+
+* Use Gherkin v6.
+  ([#1313](https://github.com/cucumber/cucumber-ruby/pull/1313)
+   [brasmusson](https://github.com/brasmusson))
+* Do not apply Before and After Hooks to Test Cases with no Test Steps.
+  ([#1311](https://github.com/cucumber/cucumber-ruby/pull/1311)
+   [brasmusson](https://github.com/brasmusson))
+* Pass the registry to the Wire plugin.
+  ([#1309](https://github.com/cucumber/cucumber-ruby/pull/1309)
+   [brasmusson](https://github.com/brasmusson))
+* Adapt to using the Gherkin compiler and Pickles in the core.
+  ([#1309](https://github.com/cucumber/cucumber-ruby/pull/1309)
+   [brasmusson](https://github.com/brasmusson))
+* 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
+
+* Remove the support of old style tag expressions.
+  ([#1314](https://github.com/cucumber/cucumber-ruby/pull/1314),
+   [brasmusson](https://github.com/brasmusson))
+* Remove the Legacy API for Formatters.
+  ([#1230](https://github.com/cucumber/cucumber-ruby/pull/1230),
+   [#839](https://github.com/cucumber/cucumber-ruby/issues/839)
+   [brasmusson](https://github.com/brasmusson))
+* Remove the JSON Pretty Formatter (which was the same as the JSON formatter).
+  ([brasmusson](https://github.com/brasmusson))
+* Remove the HTML Formatter.
+  ([#1306](https://github.com/cucumber/cucumber-ruby/pull/1306)
+   [brasmusson](https://github.com/brasmusson))
+
+### Fixed
+
+*  Wire protocol compatibility for docstrings.
+  ([#1183](https://github.com/cucumber/cucumber-ruby/issues/1183))
+* Let the Rerun Formatter handle flaky scenarios.
+  ([#1310](https://github.com/cucumber/cucumber-ruby/pull/1310)
+   [brasmusson](https://github.com/brasmusson))
+
+### Improved
+
+* Code style changes completed as per backlog of Rubocop TODO file. ([#1021](https://github.com/cucumber/cucumber-ruby/issues/1021) [@jaysonesmith](https://github.com/jaysonesmith))
+
 ## [3.1.2](https://github.com/cucumber/cucumber-ruby/compare/v3.1.1...v3.1.2) (2018-07-13)
 
 ### Changed
@@ -89,13 +261,6 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 * Fix the printing of newlines in the rerun formatter - a problem introduced in [#1162](https://github.com/cucumber/cucumber-ruby/issues/1162) ([#1207](https://github.com/cucumber/cucumber-ruby/issues/1207) [@brasmusson](https://github.com/brasmusson))
 * Handle the `--retry` option in profiles ([#1050](https://github.com/cucumber/cucumber-ruby/issues/1050) [@brasmusson](https://github.com/brasmusson))
 
-### Improved
-
-* Exclude the legacy_api from rubocop, regenerate Rubocop Todo ([@jaysonesmith](https://github.com/jaysonesmith), [@brasmusson](https://github.com/brasmusson))
-* Review and handle excluded/ignored cops ([#1208](https://github.com/cucumber/cucumber-ruby/pull/1208) [@jaysonesmith](https://github.com/jaysonesmith))
-* Fix SymbolProc issues ([#1212](https://github.com/cucumber/cucumber-ruby/pull/1212) [@jaysonesmith](https://github.com/jaysonesmith))
-* Fix TrailingBlankLines ([#1211](https://github.com/cucumber/cucumber-ruby/pull/1211) [@jaysonesmith](https://github.com/jaysonesmith))
-
 ## [3.0.1](https://github.com/cucumber/cucumber-ruby/compare/v3.0.0...3.0.1) (2017-09-29)
 
 ### Fixed
@@ -131,12 +296,6 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 * Refactor: Extract HTMLBuilder#string_to_embed method to DRY up code ([#1187](https://github.com/cucumber/cucumber-ruby/pulls/1187) [@danascheider](https://github.com/danascheider))
 * As per [#251](https://github.com/cucumber/cucumber/issues/251): renamed History.md to CHANGELOG.md, added contributing message at beginning, and misc formatting. ([#1185](https://github.com/cucumber/cucumber-ruby/issues/1185) [jaysonesmith](https://github.com/jaysonesmith))
 * Use past tense in event names (`xStarting` -> `xStarted`) ([#1166](https://github.com/cucumber/cucumber-ruby/issues/1166) @brasmusson).
-* Fix Lint/DeprecatedClassMethods ([#1172](https://github.com/cucumber/cucumber-ruby/issues/1172) [jaysonesmith](https://github.com/jaysonesmith))
-* Fix Lint/DuplicateMethods ([#1173](https://github.com/cucumber/cucumber-ruby/issues/1173) [jaysonesmith](https://github.com/jaysonesmith))
-* Fix Metrics/LineLength ([#1175](https://github.com/cucumber/cucumber-ruby/issues/1175), [#1175](https://github.com/cucumber/cucumber-ruby/issues/1175), [#1176](https://github.com/cucumber/cucumber-ruby/issues/1176) [jaysonesmith](https://github.com/jaysonesmith))
-* Fix Style/AlignArray ([#1177](https://github.com/cucumber/cucumber-ruby/issues/1177) [jaysonesmith](https://github.com/jaysonesmith))
-* Fix Style/AndOr ([#1178](https://github.com/cucumber/cucumber-ruby/issues/1178) [jaysonesmith](https://github.com/jaysonesmith))
-* Fix Multiple Cops ([#1179](https://github.com/cucumber/cucumber-ruby/issues/1179) [jaysonesmith](https://github.com/jaysonesmith))
 
 ## [3.0.0.pre.2](https://github.com/cucumber/cucumber-ruby/compare/v2.4.0...v3.0.0.pre.2)
 
@@ -620,7 +779,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
 
@@ -67,21 +67,5 @@ Now release it
     bundle update
     bundle exec rake
     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/bin/cucumber

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 file_name = File.dirname(__FILE__) + '/../lib'
-$:.unshift(file_name) unless $:.include?(file_name)
+$LOAD_PATH.unshift(file_name) unless $LOAD_PATH.include?(file_name)
 
 require 'simplecov_setup'
 require 'cucumber/rspec/disable_option_parser'

data/lib/autotest/cucumber_mixin.rb

@@ -7,7 +7,7 @@ require 'cucumber/cli/profile_loader'
 
 module Autotest::CucumberMixin
   def self.included(receiver)
-    receiver::ALL_HOOKS << [:run_features, :ran_features]
+    receiver::ALL_HOOKS << %i[run_features ran_features]
   end
 
   attr_accessor :features_to_run
@@ -23,12 +23,10 @@ module Autotest::CucumberMixin
     reset_features
     add_sigint_handler
 
-    self.last_mtime = Time.now if $f
-
     loop do # ^c handler
       begin
         get_to_green
-        if self.tainted then
+        if tainted
           rerun_all_tests
           rerun_all_features if all_good
         else
@@ -39,7 +37,7 @@ module Autotest::CucumberMixin
         # time a file is changed to see if anything breaks.
         reset_features
       rescue Interrupt
-        break if self.wants_to_quit
+        break if wants_to_quit
         reset
         reset_features
       end
@@ -51,12 +49,13 @@ module Autotest::CucumberMixin
     features_to_run == ''
   end
 
-  def get_to_green
-    begin
+  def get_to_green # rubocop:disable Naming/AccessorMethodName
+    loop do
       super
       run_features
       wait_for_changes unless all_features_good
-    end until all_features_good
+      break if all_features_good
+    end
   end
 
   def rerun_all_features
@@ -71,67 +70,63 @@ module Autotest::CucumberMixin
   def run_features
     hook :run_features
     Tempfile.open('autotest-cucumber') do |dirty_features_file|
-      cmd = self.make_cucumber_cmd(self.features_to_run, dirty_features_file.path)
+      cmd = make_cucumber_cmd(features_to_run, dirty_features_file.path)
       break if cmd.empty?
-      puts cmd unless $q
       old_sync = $stdout.sync
       $stdout.sync = true
       self.results = []
       line = []
       begin
-        open("| #{cmd}", 'r') do |f|
+        open("| #{cmd}", 'r') do |f| # rubocop:disable Security/Open
           until f.eof?
             c = f.getc || break
-            if RUBY_VERSION >= '1.9' then
-              print c
-            else
-              putc c
-            end
+            print(c)
             line << c
-            if c == ?\n then
-              self.results << if RUBY_VERSION >= '1.9' then
-                                line.join
-                              else
-                                line.pack 'c*'
-                              end
-              line.clear
-            end
+            next unless c == "\n"
+            results << line.join
+            line.clear
           end
         end
       ensure
         $stdout.sync = old_sync
       end
       self.features_to_run = dirty_features_file.read.strip
-      self.tainted = true unless self.features_to_run == ''
+      self.tainted = true unless features_to_run == ''
     end
     hook :ran_features
   end
 
-  def make_cucumber_cmd(features_to_run, dirty_features_filename)
-    return '' if features_to_run == ''
+  def make_cucumber_cmd(features_to_run, _dirty_features_filename)
+    return '' if features_to_run.empty?
 
     profile_loader = Cucumber::Cli::ProfileLoader.new
 
-    profile ||= 'autotest-all' if profile_loader.has_profile?('autotest-all') && features_to_run == :all
-    profile ||= 'autotest'     if profile_loader.has_profile?('autotest')
-    profile ||= nil
+    profile = profile(profile_loader)
+
+    args = created_args(features_to_run, profile)
+
+    "#{Cucumber::RUBY_BINARY} #{Cucumber::BINARY} #{args}"
+  end
 
+  def profile(profile_loader)
+    profile ||= 'autotest-all' if profile_loader.profile?('autotest-all') && features_to_run == :all
+    profile ||= 'autotest'     if profile_loader.profile?('autotest')
+    profile || nil
+  end
+
+  def created_args(features_to_run, profile)
     args = if profile
              ['--profile', profile]
            else
-             %w{--format} << (features_to_run == :all ? 'progress' : 'pretty')
+             %w[--format] << (features_to_run == :all ? 'progress' : 'pretty')
            end
     # No --color option as some IDEs (Netbeans) don't output them very well (1 failed step)
-    args += %w{--format rerun --out} << dirty_features_filename
+    args += %w[--format rerun --out] << dirty_features_filename
     args << (features_to_run == :all ? '' : features_to_run)
 
-    # Unless I do this, all the steps turn up undefined during the rerun...
-    unless features_to_run == :all
-      args << 'features/step_definitions' << 'features/support'
-    end
-
-    args = args.join(' ')
+    # All steps becom undefined during rerun unless the following is run.
+    args << 'features/step_definitions' << 'features/support' unless features_to_run == :all
 
-    return "#{Cucumber::RUBY_BINARY} #{Cucumber::BINARY} #{args}"
+    args.join(' ')
   end
 end

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