cucumber 7.1.0 → 8.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f93e3cad9c408e1d22f274d24602251d1a1160e7a9438f4a8efeff9d77065978
-  data.tar.gz: 8f963ac7a227bd73cc4177024825731788d47049f3fbe383d3051831eba4b0c8
+  metadata.gz: e32ea19a07706080d0618aa312bed39896bba31c55a4200ebc59ce6fa45368b6
+  data.tar.gz: 3b9acd63b9ef900593a1ca46bba104030e3de6e5eca8f48f9eaf8c2c39b2bbfd
 SHA512:
-  metadata.gz: 2f8f88993561639861f542d90b09e46a7686d20ffadc690b6e310e8b6559f6f025647af8efed7683ccaf44932275cfcf1e68af9e2e26ecb9957d1fd32af317d1
-  data.tar.gz: e2ea746319ad640a04789974c66bc6e2d14abfbbf7d7d6f5e3412e2c1b7318a54f938a58aa140cd6d5739fd4107844c235e312daaaa29506f3fa449d81115ce7
+  metadata.gz: 6d8b54a8196149ffbc2cf87d7d150ced53ed02fdfe6228ffc407d763301d6e0c0aee97544ee49b7cb3cb990716617082b886cfea184ada2c3576e8e65c0b9af1
+  data.tar.gz: 19c14443cf48f81e4d74eb8864c92a625e912adf516394f5e5bb394d1b838fb96c04c4398aa643cfd2e12367e32354142c12a11ccb3c0d44c493e178d80b1c5f

data/CHANGELOG.md

@@ -10,7 +10,7 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ---
 
-## [Unreleased](https://github.com/cucumber/cucumber-ruby/compare/v7.1.0...main)
+## [Unreleased](https://github.com/cucumber/cucumber-ruby/compare/v8.0.0.rc.1...main)
 
 ### Added
 
@@ -24,6 +24,84 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ### Deprecated
 
+### Dependencies
+
+## [8.0.0.RC.1](https://github.com/cucumber/cucumber-ruby/compare/v7.1.0...v8.0.0.rc.1)
+
+### Fixed
+
+- Fix TestRunFinished success property in html formatter and all formatters
+  based on the messages: it now returns true if the run has passed
+  ([PR#1606](https://github.com/cucumber/cucumber-ruby/pull/1606)
+   [Issue#1604](https://github.com/cucumber/cucumber-ruby/issues/1604))
+
+- Fix usage of namespaced modules across multiple scenarios
+  ([PR#1603](https://github.com/cucumber/cucumber-ruby/pull/1603)
+   [Issue#1595](https://github.com/cucumber/cucumber-ruby/issues/1595))
+
+- Do not serialize Messages::Hook#tag_expression if it is empty.
+  ([PR#1579](https://github.com/cucumber/cucumber-ruby/pull/1579))
+
+- JSON Formatter uses "pretty" output format
+  ([PR#1580](https://github.com/cucumber/cucumber-ruby/pull/1580))
+
+- Fixed JSON Formatter "end of background" detection.
+  ([PR#1580](https://github.com/cucumber/cucumber-ruby/pull/1580))
+
+- Fixed JSON Formatter expansion of Scenario Outline templates in Doc Strings.
+  ([PR#1580](https://github.com/cucumber/cucumber-ruby/pull/1580))
+
+- Removed usage of `eval` in `Cucumber::Term::ANSIColor` and `Cucumber::Formatter::ANSIColor`.
+  ([PR#1589](https://github.com/cucumber/cucumber-ruby/pull/1589)
+   [Issue#1583](https://github.com/cucumber/cucumber-ruby/issues/1583))
+
+- Fixed `DataTable#map_headers` when headers have the same prefix.
+  ([PR#1598](https://github.com/cucumber/cucumber-ruby/pull/1598)
+   [Issue#1450](https://github.com/cucumber/cucumber-ruby/issues/1450))
+
+### Changed
+
+- Replace dependency [cucumber-create-meta](https://rubygems.org/gems/cucumber-create-meta)
+  with the new [cucumber-ci-environment](https://rubygems.org/gems/cucumber-ci-environment)
+  ([PR#1601](https://github.com/cucumber/cucumber-ruby/pull/1601))
+
+- In `DataTable#map_column`, Changed the `strict` argument into a keyword argument.
+  See [UPGRADING.md](./UPGRADING.md#upgrading-to-800).
+  ([PR#1594](https://github.com/cucumber/cucumber-ruby/pull/1594)
+   [Issue#1592](https://github.com/cucumber/cucumber-ruby/issues/1592))
+
+- Added Ruby 3.1
+  ([PR#1607](https://github.com/cucumber/cucumber-ruby/pull/1607))
+
+### Removed
+
+- `AfterConfiguration` has been removed. Please use `InstallPlugin` or `BeforeAll` instead.
+  See the [UPGRADING.md](./UPGRADING.md#upgrading-to-800) to update your code accordingly.
+  ([PR#1591](https://github.com/cucumber/cucumber-ruby/pull/1591))
+
+- The built-in Wire protocol
+  The Wire protocol is still officially supported, but as an optional plugin rather
+  than a built-in feature. See the
+  [UPGRADING.md](./UPGRADING.md#upgrading-to-800)
+  to update your code accordingly.
+
+  ([1562](https://github.com/cucumber/cucumber-ruby/pull/1562)
+  [aurelien-reeves](https://github.com/aurelien-reeves))
+
+- Removed former unused `stdin` argument from `Cli::Main`. That may impact your code
+  if you use cucumber API `Cucumber::Cli::Main`. See [UPGRADING.md](./UPGRADING.md#upgrading-to-800).
+  ([PR#1588](https://github.com/cucumber/cucumber-ruby/pull/1588)
+   [Issue#1581](https://github.com/cucumber/cucumber-ruby/issues/1581))
+
+- Removed `DataTable#map_column!` and `DataTable#map_headers!`.
+  Those methods were error-prone and planned to be removed a long time ago. You
+  can use the immutable versions instead: `DataTable#map_column` and
+  `DataTable#map_headers`.
+  ([PR#1590](https://github.com/cucumber/cucumber-ruby/pull/1590)
+   [Issue#1584](https://github.com/cucumber/cucumber-ruby/issues/1584))
+
+- Removed support for Ruby 2.5 and JRuby 9.2.
+
 ## [7.1.0](https://github.com/cucumber/cucumber-ruby/compare/v7.0.0...v7.1.0) (2021-10-12)
 
 ### Added

data/CONTRIBUTING.md

@@ -83,11 +83,8 @@ with a lot of libraries. You will find there what is related to:
   step definition
 - everyting related to the HTML formatter
 
-`cucumber-ruby` is also composed of:
-
-- [cucumber-ruby-core]: this is the engine that will execute the test cases
-  computed from a parsed Gherkin document
-- [cucumber-ruby-wire]: everything related to the Cucumber's wire protocol
+`cucumber-ruby` is also composed of [cucumber-ruby-core]: this is the engine that
+will execute the test cases computed from a parsed Gherkin document
 
 Last but not least, there is also a repository for [cucumber-rails], the gem
 that brings Cucumber to Rails 5.x and 6.x.
@@ -236,7 +233,6 @@ You can find additional documentation in the [docs](./docs) directory such as
 [cucumber-docs]: https://cucumber.io/docs/cucumber
 [cucumber/common]: https://github.com/cucumber/common
 [cucumber-ruby-core]: https://github.com/cucumber/cucumber-ruby-core
-[cucumber-ruby-wire]: https://github.com/cucumber/cucumber-ruby-wire
 [cucumber-rails]: https://github.com/cucumber/cucumber-rails
 [cucumber-ruby-issues]: https://github.com/cucumber/cucumber-ruby/search?q=is%3Aissue
 [cucumber/common-issues]: https://github.com/cucumber/common/search?q=is%3Aissue

data/README.md

@@ -50,16 +50,13 @@ Later in this document, bundler is considered being used so all commands are usi
 
 ### Supported platforms
 
+- Ruby 3.1
 - Ruby 3.0
 - Ruby 2.7
 - Ruby 2.6
-- Ruby 2.5
-- Ruby 2.4
-- Ruby 2.3
-- JRuby 9.2 (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/main/docs/jruby-limitations.md))
-
-JRuby 9.3 is not supported yet due to a known issue. More info can
-be found in the [PR#1571](https://github.com/cucumber/cucumber-ruby/pull/1571).
+- JRuby (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/main/docs/jruby-limitations.md))
+  - 9.3 >= 9.3.1 (there is a known issue with JRuby 9.3.0. More info can
+    be found in the [PR#1571](https://github.com/cucumber/cucumber-ruby/pull/1571).)
 
 ### Ruby on Rails
 

data/lib/autotest/cucumber_mixin.rb

@@ -24,7 +24,7 @@ module Autotest::CucumberMixin
     add_sigint_handler
 
     loop do # ^c handler
-      get_to_green
+      wait_for_green
       if tainted
         rerun_all_tests
         rerun_all_features if all_good
@@ -37,6 +37,7 @@ module Autotest::CucumberMixin
       reset_features
     rescue Interrupt
       break if wants_to_quit
+
       reset
       reset_features
     end
@@ -47,7 +48,7 @@ module Autotest::CucumberMixin
     features_to_run == ''
   end
 
-  def get_to_green # rubocop:disable Naming/AccessorMethodName
+  def wait_for_green
     loop do
       super
       run_features
@@ -70,6 +71,7 @@ module Autotest::CucumberMixin
     Tempfile.open('autotest-cucumber') do |dirty_features_file|
       cmd = make_cucumber_cmd(features_to_run, dirty_features_file.path)
       break if cmd.empty?
+
       old_sync = $stdout.sync
       $stdout.sync = true
       self.results = []
@@ -81,6 +83,7 @@ module Autotest::CucumberMixin
             print(c)
             line << c
             next unless c == "\n"
+
             results << line.join
             line.clear
           end

data/lib/autotest/discover.rb

@@ -2,9 +2,10 @@
 
 Autotest.add_discovery do
   if File.directory?('features')
-    if ENV['AUTOFEATURE'] =~ /true/i
+    case ENV['AUTOFEATURE']
+    when /true/i
       'cucumber'
-    elsif ENV['AUTOFEATURE'] =~ /false/i
+    when /false/i
       # noop
     else
       puts '(Not running features.  To run features in autotest, set AUTOFEATURE=true.)'

data/lib/cucumber/cli/configuration.rb

@@ -9,7 +9,9 @@ require 'cucumber'
 module Cucumber
   module Cli
     class YmlLoadError < StandardError; end
+
     class ProfilesNotDefinedError < YmlLoadError; end
+
     class ProfileNotFound < StandardError; end
 
     class Configuration
@@ -17,7 +19,7 @@ module Cucumber
 
       attr_reader :out_stream
 
-      def initialize(out_stream = STDOUT, error_stream = STDERR)
+      def initialize(out_stream = $stdout, error_stream = $stderr)
         @out_stream   = out_stream
         @error_stream = error_stream
         @options = Options.new(@out_stream, @error_stream, default_profile: 'default')
@@ -28,6 +30,7 @@ module Cucumber
         @options.parse!(args)
         arrange_formats
         raise("You can't use both --strict and --wip") if strict.strict? && wip?
+
         set_environment_variables
       end
 

data/lib/cucumber/cli/main.rb

@@ -14,7 +14,7 @@ module Cucumber
         end
       end
 
-      def initialize(args, _ = nil, out = STDOUT, err = STDERR, kernel = Kernel)
+      def initialize(args, out = $stdout, err = $stderr, kernel = Kernel)
         @args   = args
         @out    = out
         @err    = err
@@ -41,7 +41,7 @@ module Cucumber
         @err.puts("Couldn't open #{e.path}")
         exit_unable_to_finish
       rescue FeatureFolderNotFoundException => e
-        @err.puts(e.message + '. You can use `cucumber --init` to get started.')
+        @err.puts("#{e.message}. You can use `cucumber --init` to get started.")
         exit_unable_to_finish
       rescue ProfilesNotDefinedError, YmlLoadError, ProfileNotFound => e
         @err.puts(e.message)
@@ -85,13 +85,14 @@ module Cucumber
         trap('INT') do
           exit_unable_to_finish! if Cucumber.wants_to_quit
           Cucumber.wants_to_quit = true
-          STDERR.puts "\nExiting... Interrupt again to exit immediately."
+          $stderr.puts "\nExiting... Interrupt again to exit immediately."
           exit_unable_to_finish
         end
       end
 
       def runtime(existing_runtime)
         return Runtime.new(configuration) unless existing_runtime
+
         existing_runtime.configure(configuration)
         existing_runtime
       end

data/lib/cucumber/cli/options.rb

@@ -63,13 +63,13 @@ module Cucumber
         '--lines', '--port', '-I', '--snippet-type'
       ].freeze
       ORDER_TYPES = %w[defined random].freeze
-      TAG_LIMIT_MATCHER = /(?<tag_name>\@\w+):(?<limit>\d+)/x
+      TAG_LIMIT_MATCHER = /(?<tag_name>@\w+):(?<limit>\d+)/x
 
       def self.parse(args, out_stream, error_stream, options = {})
         new(out_stream, error_stream, options).parse!(args)
       end
 
-      def initialize(out_stream = STDOUT, error_stream = STDERR, options = {})
+      def initialize(out_stream = $stdout, error_stream = $stderr, options = {})
         @out_stream   = out_stream
         @error_stream = error_stream
 
@@ -180,6 +180,7 @@ Specify SEED to reproduce the shuffling from a previous run.
       def check_formatter_stream_conflicts
         streams = @options[:formats].uniq.map { |(_, _, stream)| stream }
         return if streams == streams.uniq
+
         raise 'All but one formatter must use --out, only one can print to each stream (or STDOUT)'
       end
 
@@ -203,6 +204,7 @@ Specify SEED to reproduce the shuffling from a previous run.
 
       def truthy_string?(str)
         return false if str.nil?
+
         str !~ /^(false|no|0)$/i
       end
 
@@ -367,6 +369,7 @@ Specify SEED to reproduce the shuffling from a previous run.
       def require_files(v)
         @options[:require] << v
         return unless Cucumber::JRUBY && File.directory?(v)
+
         require 'java'
         $CLASSPATH << v
       end
@@ -385,6 +388,7 @@ Specify SEED to reproduce the shuffling from a previous run.
         require 'gherkin/dialect'
 
         return indicate_invalid_language_and_exit(lang) unless ::Gherkin::DIALECTS.key?(lang)
+
         list_keywords_and_exit(lang)
       end
 
@@ -403,6 +407,7 @@ Specify SEED to reproduce the shuffling from a previous run.
       def add_tag(value)
         raise("Found tags option '#{value}'. '~@tag' is no longer supported, use 'not @tag' instead.") if value.include?('~')
         raise("Found tags option '#{value}'. '@tag1,@tag2' is no longer supported, use '@tag or @tag2' instead.") if value.include?(',')
+
         @options[:tag_expressions] << value.gsub(/(@\w+)(:\d+)?/, '\1')
         add_tag_limits(value)
       end
@@ -415,6 +420,7 @@ Specify SEED to reproduce the shuffling from a previous run.
 
       def add_tag_limit(tag_limits, tag_name, limit)
         raise "Inconsistent tag limits for #{tag_name}: #{tag_limits[tag_name]} and #{limit}" if tag_limits[tag_name] && tag_limits[tag_name] != limit
+
         tag_limits[tag_name] = limit
       end
 

data/lib/cucumber/cli/profile_loader.rb

@@ -75,11 +75,7 @@ Defined profiles in cucumber.yml:
       def process_configuration_file_with_erb
         require 'erb'
         begin
-          @cucumber_erb = if RUBY_VERSION >= '2.6'
-                            ERB.new(IO.read(cucumber_file), trim_mode: '%').result(binding)
-                          else
-                            ERB.new(IO.read(cucumber_file), nil, '%').result(binding)
-                          end
+          @cucumber_erb = ERB.new(IO.read(cucumber_file), trim_mode: '%').result(binding)
         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

data/lib/cucumber/cli/rerun_file.rb

@@ -10,7 +10,7 @@ module Cucumber
       end
 
       def self.real_path(path)
-        path[1..-1] # remove leading @
+        path[1..]
       end
 
       def initialize(path)

data/lib/cucumber/configuration.rb

@@ -176,12 +176,12 @@ module Cucumber
     end
 
     def support_to_load
-      support_files = all_files_to_load.select { |f| f =~ %r{/support/} }
+      support_files = all_files_to_load.select { |f| f =~ /\/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\..*} }
+      env_files = support_files.select { |f| f =~ /\/support\/env\..*/ }
       other_files = support_files - env_files
       env_files.reverse + other_files.reverse
     end
@@ -189,7 +189,7 @@ module Cucumber
     def all_files_to_load
       files = require_dirs.map do |path|
         path = path.tr('\\', '/') # In case we're on windows. Globs don't work with backslashes.
-        path = path.gsub(/\/$/, '') # Strip trailing slash. # rubocop:disable Style/RegexpLiteral
+        path = path.gsub(/\/$/, '') # Strip trailing slash.
         File.directory?(path) ? Dir["#{path}/**/*"] : path
       end.flatten.uniq
       remove_excluded_files_from(files)
@@ -200,7 +200,7 @@ module Cucumber
     end
 
     def step_defs_to_load
-      all_files_to_load.reject { |f| f =~ %r{/support/} }
+      all_files_to_load.reject { |f| f =~ /\/support\// }
     end
 
     def formatter_factories
@@ -283,6 +283,7 @@ module Cucumber
 
     def with_default_features_path(paths)
       return default_features_paths if paths.empty?
+
       paths
     end
 

data/lib/cucumber/constantize.rb

@@ -2,7 +2,7 @@
 
 require 'cucumber/platform'
 module Cucumber
-  module Constantize #:nodoc:
+  module Constantize # :nodoc:
     def constantize(camel_cased_word)
       try = 0
       begin

data/lib/cucumber/deprecate.rb

@@ -20,6 +20,7 @@ module Cucumber
     class CliOption
       def self.deprecate(stream, option, message, remove_after_version)
         return if stream.nil?
+
         stream.puts(
           AnsiString.failure_message(
             "\nWARNING: #{option} is deprecated" \
@@ -31,7 +32,7 @@ module Cucumber
 
     module ForUsers
       def self.call(message, method, remove_after_version)
-        STDERR.puts AnsiString.failure_message(
+        $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})"

data/lib/cucumber/errors.rb

@@ -9,7 +9,7 @@ module Cucumber
       return result.with_message(with_prefix(result.message)) if result.is_a?(self)
 
       begin
-        raise new(with_prefix(step_name)) # rubocop:disable Style/RaiseArgs
+        raise self, with_prefix(step_name)
       rescue StandardError => e
         e
       end

data/lib/cucumber/events/hook_test_step_created.rb

@@ -6,8 +6,7 @@ module Cucumber
   module Events
     # Event fired when a step is created from a hook
     class HookTestStepCreated < Core::Event.new(:test_step, :hook)
-      attr_reader :test_step
-      attr_reader :hook
+      attr_reader :test_step, :hook
     end
   end
 end

data/lib/cucumber/events/step_activated.rb

@@ -15,12 +15,6 @@ module Cucumber
       #
       # @return [Cucumber::StepMatch]
       attr_reader :step_match
-
-      # @private
-      def initialize(test_step, step_match)
-        @test_step = test_step
-        @step_match = step_match
-      end
     end
   end
 end

data/lib/cucumber/events/step_definition_registered.rb

@@ -10,11 +10,6 @@ module Cucumber
       #
       # @return [RbSupport::RbStepDefinition]
       attr_reader :step_definition
-
-      # _@private
-      def initialize(step_definition)
-        @step_definition = step_definition
-      end
     end
   end
 end

data/lib/cucumber/events/test_case_created.rb

@@ -6,8 +6,7 @@ module Cucumber
   module Events
     # Event fired when a Test::Case is created from a Pickle
     class TestCaseCreated < Core::Event.new(:test_case, :pickle)
-      attr_reader :test_case
-      attr_reader :pickle
+      attr_reader :test_case, :pickle
     end
   end
 end

data/lib/cucumber/events/test_run_finished.rb

@@ -5,7 +5,8 @@ require 'cucumber/core/events'
 module Cucumber
   module Events
     # Event fired after all test cases have finished executing
-    class TestRunFinished < Core::Event.new
+    class TestRunFinished < Core::Event.new(:success)
+      attr_reader :success
     end
   end
 end

data/lib/cucumber/events/test_step_created.rb

@@ -6,8 +6,7 @@ module Cucumber
   module Events
     # Event fired when a TestStep is created from a PickleStep
     class TestStepCreated < Core::Event.new(:test_step, :pickle_step)
-      attr_reader :test_step
-      attr_reader :pickle_step
+      attr_reader :test_step, :pickle_step
     end
   end
 end

data/lib/cucumber/events/undefined_parameter_type.rb

@@ -3,8 +3,7 @@ require 'cucumber/core/events'
 module Cucumber
   module Events
     class UndefinedParameterType < Core::Event.new(:type_name, :expression)
-      attr_reader :type_name
-      attr_reader :expression
+      attr_reader :type_name, :expression
     end
   end
 end

data/lib/cucumber/events.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Dir[File.dirname(__FILE__) + '/events/*.rb'].map(&method(:require))
+Dir["#{File.dirname(__FILE__)}/events/*.rb"].map(&method(:require))
 
 module Cucumber
   # Events tell you what's happening while Cucumber runs your features.

data/lib/cucumber/file_specs.rb

@@ -5,7 +5,7 @@ require 'cucumber/core/test/location'
 
 module Cucumber
   class FileSpecs
-    FILE_COLON_LINE_PATTERN = /^([\w\W]*?)(?::([\d:]+))?$/ #:nodoc:
+    FILE_COLON_LINE_PATTERN = /^([\w\W]*?)(?::([\d:]+))?$/ # :nodoc:
 
     def initialize(file_specs)
       Cucumber.logger.debug("Features:\n")
@@ -32,6 +32,7 @@ module Cucumber
 
       def locations
         return [Core::Test::Location.new(@file)] if @lines.empty?
+
         @lines.map { |line| Core::Test::Location.new(@file, line) }
       end
     end

data/lib/cucumber/filters/activate_steps.rb

@@ -52,6 +52,7 @@ module Cucumber
             end
             configuration.notify :step_activated, test_step, match
             return SkippingStepMatch.new if configuration.dry_run?
+
             match
           end
 

data/lib/cucumber/filters/tag_limits/verifier.rb

@@ -47,9 +47,7 @@ module Cucumber
             locations.count
           end
 
-          attr_reader :tag_name
-          attr_reader :limit
-          attr_reader :locations
+          attr_reader :tag_name, :limit, :locations
         end
       end
     end

data/lib/cucumber/filters/tag_limits.rb

@@ -38,9 +38,7 @@ module Cucumber
 
       private
 
-      attr_reader :gated_receiver
-      attr_reader :test_case_index
-      attr_reader :verifier
+      attr_reader :gated_receiver, :test_case_index, :verifier
     end
   end
 end