cucumber 10.2.0 → 11.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd6eb560b45052579319bf0fdf3052c8ef17e122a51342271e87917ae5ed6c28
-  data.tar.gz: 81d39f9f1a7c285e206645d1289347875b45bc5a56d4ce9b95137933055b0609
+  metadata.gz: 41a92bddb6a0e5cdf8a69b28abfc455f4d77516e3f4abd8283cd6a222d1f5bd9
+  data.tar.gz: 743067172c8d6e732e86a2417dfa43b809ecff66ad772477460af2b1e217c234
 SHA512:
-  metadata.gz: 99ab364fa46cadbee42cdc23114e17e27030a5d8868e85367884b01eef9a165b3bf27ea786708ea3cbdfe5a1ef132652e703bebfb9e41453a11fc68345a4f94d
-  data.tar.gz: c7fef1179a2b86ff74daa07b1ffd0336333716ab1469b84a6d909eeab0466812f0a1a37718582ec6bd2633d53e49b9f811fd20ae48d27c3b99b72233e41edce5
+  metadata.gz: b26e638126d5f0d7846390ed1ddbf2b38c76d92c19e43aa859ba8432b04a017e509a018e55abb590ad523e31f295daeec9e210506b862a310e996b138cb113ab
+  data.tar.gz: 5360ce612562f89839f87cf568f8a0adc3d732e224f99900653e8c58a0b4c51892932c9568b10e58365f2652fe867023d7bd32f05df7a95860583167b52cfd55

data/README.md

@@ -1,13 +1,22 @@
-<img src="docs/img/logo.svg" alt="" width="75" />
+<h1 align="center">
+  <img src="docs/img/logo.svg" alt="Cucumber logo" width="75">
+  <br>
+  Cucumber
+</h1>
 
-# Cucumber
+<div align="center">
 
-[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)
+[![Gem Version](https://badge.fury.io/rb/cucumber.svg)](https://badge.fury.io/rb/cucumber)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/cucumber/cucumber-ruby/badge)](https://scorecard.dev/viewer/?uri=github.com/cucumber/cucumber-ruby)
 [![OpenCollective](https://opencollective.com/cucumber/backers/badge.svg)](https://opencollective.com/cucumber)
 [![OpenCollective](https://opencollective.com/cucumber/sponsors/badge.svg)](https://opencollective.com/cucumber)
-[![Test cucumber](https://github.com/cucumber/cucumber-ruby/actions/workflows/test.yaml/badge.svg)](https://github.com/cucumber/cucumber-ruby/actions/workflows/test.yaml)
-[![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=main)](https://coveralls.io/r/cucumber/cucumber-ruby?branch=main)
+[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://vshymanskyy.github.io/StandWithUkraine)
+
+[![Build Status](https://github.com/cucumber/cucumber-ruby/actions/workflows/test-ruby.yaml/badge.svg)](https://github.com/cucumber/cucumber-ruby/actions)
+[![Build Status](https://github.com/cucumber/cucumber-ruby/actions/workflows/release-ruby.yaml/badge.svg)](https://github.com/cucumber/cucumber-ruby/actions)
+
+</div>
+
 
 Cucumber is a tool for running automated tests written in plain language. Because they're
 written in plain language, they can be read by anyone on your team. Because they can be
@@ -45,12 +54,12 @@ Later in this document, bundler is considered being used so all commands are usi
 
 ### Supported platforms
 
+- Ruby 4.0
 - Ruby 3.4
 - Ruby 3.3
 - Ruby 3.2
-- Ruby 3.1
 - TruffleRuby 24.0.0+
-- JRuby 9.4+ (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/main/docs/jruby-limitations.md))
+- JRuby 10.0+ (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/main/docs/jruby-limitations.md))
 
 ### Ruby on Rails
 

data/VERSION

@@ -1 +1 @@
-10.2.0
+11.1.0

data/lib/cucumber/cli/configuration.rb

@@ -15,7 +15,7 @@ module Cucumber
     class Configuration
       include Constantize
 
-      attr_reader :out_stream
+      attr_reader :out_stream, :options
 
       def initialize(out_stream = $stdout, error_stream = $stderr)
         @out_stream   = out_stream

data/lib/cucumber/cli/main.rb

@@ -23,6 +23,7 @@ module Cucumber
 
       def execute!(existing_runtime = nil)
         trap_interrupt
+        trap_thread_dump_signal
 
         runtime = runtime(existing_runtime)
 
@@ -90,6 +91,27 @@ module Cucumber
         end
       end
 
+      def trap_thread_dump_signal
+        signal = %w[INFO PWR].find { |s| Signal.list.key?(s) }
+
+        return if signal.nil?
+
+        trap(signal) do
+          Thread.list.each do |thread|
+            prefix = "Thread TID-#{(thread.object_id ^ Process.pid).to_s(36)} #{thread.name || '<no name>'}"
+            backtrace = thread.backtrace
+
+            if backtrace&.any?
+              backtrace.each do |line|
+                @err.puts("#{prefix} #{line}")
+              end
+            else
+              @err.puts("#{prefix} <no backtrace available>")
+            end
+          end
+        end
+      end
+
       def runtime(existing_runtime)
         return Runtime.new(configuration) unless existing_runtime
 

data/lib/cucumber/cli/options.rb

@@ -63,7 +63,7 @@ module Cucumber
         PROFILE_SHORT_FLAG, PROFILE_LONG_FLAG, RETRY_FLAG, RETRY_TOTAL_FLAG,
         '-l', '--lines', '--port', '-I', '--snippet-type'
       ].freeze
-      ORDER_TYPES = %w[defined random].freeze
+      ORDER_TYPES = %w[defined random reverse].freeze
       TAG_LIMIT_MATCHER = /(?<tag_name>@\w+):(?<limit>\d+)/x.freeze
 
       def self.parse(args, out_stream, error_stream, options = {})
@@ -146,6 +146,7 @@ module Cucumber
                   *<<~TEXT.split("\n")) do |order|
                       [defined]     Run scenarios in the order they were defined (default).
                       [random]      Shuffle scenarios before running.
+                      [reverse]     Run scenarios in the opposite order to which they were defined.
                     Specify SEED to reproduce the shuffling from a previous run.
                       e.g. --order random:5738
                   TEXT
@@ -601,23 +602,7 @@ module Cucumber
       end
 
       def default_options
-        {
-          strict: Cucumber::Core::Test::Result::StrictConfiguration.new,
-          require: [],
-          dry_run: false,
-          formats: [],
-          excludes: [],
-          tag_expressions: [],
-          tag_limits: {},
-          name_regexps: [],
-          env_vars: {},
-          diff_enabled: true,
-          snippets: true,
-          source: true,
-          duration: true,
-          retry: 0,
-          retry_total: Float::INFINITY
-        }
+        Cucumber::Configuration.default_options
       end
     end
   end

data/lib/cucumber/cli/profile_loader.rb

@@ -80,9 +80,9 @@ module Cucumber
       end
 
       def process_configuration_file_with_erb
-        @cucumber_erb = ERB.new(IO.read(cucumber_file), trim_mode: '%').result(binding)
+        @cucumber_erb = ERB.new(File.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}")
+        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
 
       def load_configuration

data/lib/cucumber/cli/rerun_file.rb

@@ -24,7 +24,7 @@ module Cucumber
       private
 
       def lines
-        IO.read(@path).split("\n")
+        File.read(path).split("\n")
       end
     end
   end

data/lib/cucumber/cli.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/cli/*.rb"].map(&method(:require))

data/lib/cucumber/configuration.rb

@@ -19,6 +19,30 @@ module Cucumber
       new
     end
 
+    def self.default_options
+      {
+        autoload_code_paths: %w[features/support features/step_definitions],
+        filters: [],
+        strict: Cucumber::Core::Test::Result::StrictConfiguration.new,
+        require: [],
+        dry_run: false,
+        fail_fast: false,
+        formats: [],
+        excludes: [],
+        tag_expressions: [],
+        name_regexps: [],
+        env_vars: {},
+        diff_enabled: true,
+        snippets: true,
+        source: true,
+        duration: true,
+        event_bus: Cucumber::Events.make_event_bus,
+        retry_total: Float::INFINITY,
+        tag_limits: {},
+        retry: 0
+      }
+    end
+
     # Subscribe to an event.
     #
     # See {Cucumber::Events} for the list of possible events.
@@ -35,7 +59,7 @@ module Cucumber
     end
 
     def initialize(user_options = {})
-      @options = default_options.merge(Hash(user_options))
+      @options = self.class.default_options.merge(Hash(user_options))
     end
 
     def with_options(new_options)
@@ -54,6 +78,10 @@ module Cucumber
       @options[:order] == 'random'
     end
 
+    def reverse_order?
+      @options[:order] == 'reverse'
+    end
+
     def seed
       @options[:seed]
     end
@@ -257,31 +285,12 @@ module Cucumber
       @id_generator ||= Cucumber::Messages::Helpers::IdGenerator::UUID.new
     end
 
-    private
-
-    def default_options
-      {
-        autoload_code_paths: ['features/support', 'features/step_definitions'],
-        filters: [],
-        strict: Cucumber::Core::Test::Result::StrictConfiguration.new,
-        require: [],
-        dry_run: false,
-        publish_quiet: false,
-        fail_fast: false,
-        formats: [],
-        excludes: [],
-        tag_expressions: [],
-        name_regexps: [],
-        env_vars: {},
-        diff_enabled: true,
-        snippets: true,
-        source: true,
-        duration: true,
-        event_bus: Cucumber::Events.make_event_bus,
-        retry_total: Float::INFINITY
-      }
+    def test_run_started_id
+      @test_run_started_id ||= id_generator.new_id
     end
 
+    private
+
     def default_features_paths
       ['features']
     end

data/lib/cucumber/events/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# TODO: Remove this class and use Cucumber::Core::Event::Base once v17 of core is minimum
+module Cucumber
+  module Events
+    # An archetype of what each Cucumber Event defined in cucumber-ruby must adhere to
+    class Base
+      # The "key" name of the class to be used as the key in the event registry (Underscored name symbolized)
+      #   @return [Symbol]
+      def self.event_id
+        raise 'Must be implemented in subclass'
+      end
+
+      # The properties of each event. Stored in iVar named format - where the key is the name of the iVar
+      #   @return [Hash<Symbol>]
+      def to_h
+        instance_variables.to_h { |variable_name| [variable_name[1..].to_sym, instance_variable_get(variable_name)] }
+      end
+
+      def event_id
+        self.class.event_id
+      end
+    end
+  end
+end

data/lib/cucumber/events/envelope.rb

@@ -1,11 +1,38 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
-    class Envelope < Core::Event.new(:envelope)
+    class Envelope < Base
       attr_reader :envelope
+
+      def self.event_id
+        :envelope
+      end
+
+      def initialize(envelope)
+        @envelope = envelope
+        super()
+      end
+
+      def inspect
+        "Envelope Event -> Message Type: #{type}}"
+      end
+
+      def to_s
+        inspect
+      end
+
+      private
+
+      def type
+        envelope.instance_variables.detect { |message| !envelope.send(name_of(message)).nil? }
+      end
+
+      def name_of(message)
+        message.to_s.delete('@')
+      end
     end
   end
 end

data/lib/cucumber/events/gherkin_source_parsed.rb

@@ -1,13 +1,22 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Fired after we've parsed the contents of a feature file
-    class GherkinSourceParsed < Core::Event.new(:gherkin_document)
-      # The Gherkin Ast
+    class GherkinSourceParsed < Base
+      # # The Gherkin Ast
       attr_reader :gherkin_document
+
+      def self.event_id
+        :gherkin_source_parsed
+      end
+
+      def initialize(gherkin_document)
+        @gherkin_document = gherkin_document
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/gherkin_source_read.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
     # Fired after we've read in the contents of a feature file
-    class GherkinSourceRead < Core::Event.new(:path, :body)
+    class GherkinSourceRead < Base
       # The path to the file
       attr_reader :path
 
       # The raw Gherkin source
       attr_reader :body
+
+      def self.event_id
+        :gherkin_source_read
+      end
+
+      def initialize(path, body)
+        @path = path
+        @body = body
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/hook_test_step_created.rb

@@ -1,12 +1,22 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Event fired when a step is created from a hook
-    class HookTestStepCreated < Core::Event.new(:test_step, :hook)
+    class HookTestStepCreated < Base
       attr_reader :test_step, :hook
+
+      def self.event_id
+        :hook_test_step_created
+      end
+
+      def initialize(test_step, hook)
+        @test_step = test_step
+        @hook = hook
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/step_activated.rb

@@ -1,20 +1,26 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
     # Event fired when a step is activated
-    class StepActivated < Core::Event.new(:test_step, :step_match)
+    class StepActivated < Base
       # The test step that was matched.
-      #
-      # @return [Cucumber::Core::Test::Step]
+      #   @return [Cucumber::Core::Test::Step]
       attr_reader :test_step
 
       # Information about the matching definition.
-      #
-      # @return [Cucumber::StepMatch]
+      #   @return [Cucumber::StepMatch]
       attr_reader :step_match
+
+      def self.event_id
+        :step_activated
+      end
+
+      def initialize(test_step, step_match)
+        @test_step = test_step
+        @step_match = step_match
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/step_definition_registered.rb

@@ -1,15 +1,23 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Event fired after each step definition has been registered
-    class StepDefinitionRegistered < Core::Event.new(:step_definition)
+    class StepDefinitionRegistered < Base
       # The step definition that was just registered.
-      #
-      # @return [RbSupport::RbStepDefinition]
+      #   @return [RbSupport::RbStepDefinition]
       attr_reader :step_definition
+
+      def self.event_id
+        :step_definition_registered
+      end
+
+      def initialize(step_definition)
+        @step_definition = step_definition
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_case_created.rb

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
     # Event fired when a Test::Case is created from a Pickle
-    class TestCaseCreated < Core::Event.new(:test_case, :pickle)
+    class TestCaseCreated < Base
       attr_reader :test_case, :pickle
+
+      def self.event_id
+        :test_case_created
+      end
+
+      def initialize(test_case, pickle)
+        @test_case = test_case
+        @pickle = pickle
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_case_finished.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
-    # Signals that a {Cucumber::Core::Test::Case} has finished executing
-    class TestCaseFinished < Core::Events::TestCaseFinished
+    # Event fired when a Test::Case is created from a Pickle
+    class TestCaseFinished < Base
       # @return [Cucumber::Core::Test::Case] that was executed
       attr_reader :test_case
 
       # @return [Cucumber::Core::Test::Result] the result of running the {Cucumber::Core::Test::Case}
       attr_reader :result
+
+      def self.event_id
+        :test_case_finished
+      end
+
+      def initialize(test_case, result)
+        @test_case = test_case
+        @result = result
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_case_ready.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
-    # Event fired when a Test::Case is ready to be ran (matching has been done, hooks added etc)
-    class TestCaseReady < Core::Event.new(:test_case)
+    class TestCaseReady < Base
       attr_reader :test_case
+
+      def self.event_id
+        :test_case_ready
+      end
+
+      def initialize(test_case)
+        @test_case = test_case
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_case_started.rb

@@ -1,13 +1,22 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Signals that a {Cucumber::Core::Test::Case} is about to be executed
-    class TestCaseStarted < Core::Events::TestCaseStarted
+    class TestCaseStarted < Base
       # @return [Cucumber::Core::Test::Case] the test case to be executed
       attr_reader :test_case
+
+      def self.event_id
+        :test_case_started
+      end
+
+      def initialize(test_case)
+        @test_case = test_case
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_run_finished.rb

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
-
 module Cucumber
   module Events
     # Event fired after all test cases have finished executing
-    class TestRunFinished < Core::Event.new(:success)
+    class TestRunFinished < Base
       attr_reader :success
+
+      def self.event_id
+        :test_run_finished
+      end
+
+      def initialize(success = nil)
+        @success = success
+        super()
+      end
     end
   end
 end

data/lib/cucumber/events/test_run_hook_finished.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Events
+    class TestRunHookFinished < Base
+      attr_reader :hook, :test_result
+
+      def self.event_id
+        :test_run_hook_finished
+      end
+
+      def initialize(hook, test_result)
+        @hook = hook
+        @test_result = test_result
+        super()
+      end
+    end
+  end
+end

data/lib/cucumber/events/test_run_hook_started.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'cucumber/core/events'
+
+module Cucumber
+  module Events
+    class TestRunHookStarted < Base
+      attr_reader :hook
+
+      def self.event_id
+        :test_run_hook_started
+      end
+
+      def initialize(hook)
+        @hook = hook
+        super()
+      end
+    end
+  end
+end

data/lib/cucumber/events/test_run_started.rb

@@ -1,14 +1,23 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'base'
 
 module Cucumber
   module Events
     # Event fired once all test cases have been filtered before
     # the first one is executed.
-    class TestRunStarted < Core::Event.new(:test_cases)
+    class TestRunStarted < Base
       # @return [Array<Cucumber::Core::Test::Case>] the test cases to be executed
       attr_reader :test_cases
+
+      def self.event_id
+        :test_run_started
+      end
+
+      def initialize(test_cases)
+        @test_cases = test_cases
+        super()
+      end
     end
   end
 end