cucumber-core 18.0.0 → 19.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40198f152a14c95e0b6bc0edd0191ea57223037d6452849926f20691114cfb4f
-  data.tar.gz: 81b94a76c6113fbd26be6aba465294d61185d48202ef153196b95465f094f7c3
+  metadata.gz: 25b931cc726aa46d40c838941a4a033fd70a34ef4899884750e86e9ad2a0f1b3
+  data.tar.gz: d4f808dfc9dc0106e96b1fb6754df766f18a1248914323e89fe32c9a5eee6202
 SHA512:
-  metadata.gz: e20c7fad6648efad8b47f55c79259c7c35106b0778c714e31f387dbcfae17699a5283841894f5ec94ab8dd7f3792c4fd6958186ebf5a3845404c26318e9d3fa1
-  data.tar.gz: 5c2477e304ae210c4c0efde9b2445c576d209cc116fd78e25b95afe7965c6cbba4161ae1e8e2235c3aa3d1bd92668a001f163f5dabd848206758a7a2700484c9
+  metadata.gz: 8a0428cdbc69794d04b068fc6b72a83026cb8b08959c91153fc4c3b71b44062e442e5842dcef7b3dc8af424daa6c7dbebcce9fe13258ee4cc51a1aa6b9b798b6
+  data.tar.gz: ae12323897fe7bb9b0f1bad297dadf5a2be335f5eb187a1093317350e5bd6211dac5cb93c1bafcca50610a5366571e9b85cb512363567471973ddbbf55bbcdd0

data/CHANGELOG.md

@@ -10,8 +10,20 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ## [Unreleased]
 
+## [19.0.0] - 2026-08-19
+### Added
+- Emit test_case_started/finished and test_step_started/test_step_finished envelopes from the Runner. ([#331](https://github.com/cucumber/cucumber-ruby-core/pull/331))
+
+### Changed
+- Increased upper bounds of `cucumber-messages` to v34 and `cucumber-gherkin` to v42
+- **BREAKING CHANGE:** Event base class has been internally refactored. See upgrading notes for [19.0.0.md](upgrading_notes/19.0.0.md#upgrading-to-cucumber-core-1900), for full changes
+- Permit usage of `cucumber-tag-expressions` up to v11
+
 ## [18.0.0] - 2026-07-13
 ### Changed
+- **BREAKING CHANGE:** Structure of Gherkin writer helpers have been changed. Now one helper per file, and all helpers are still available by requiring `gherkin/writer/helpers`.
+See upgrading notes for [18.0.0.md](upgrading_notes/18.0.0.md#upgrading-to-cucumber-core-1800), for full changes
+- **BREAKING CHANGE:** Flaky results are now treated as a passing state. See upgrading notes for [18.0.0.md](upgrading_notes/18.0.0.md#upgrading-to-cucumber-core-1800), for full changes
 - Tidied up a bunch of mostly internal test code to be more rubocop compliant
 
 ## [17.0.0] - 2026-06-01
@@ -91,6 +103,8 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ## [14.0.0] - 2024-08-08
 ### Changed
+- **BREAKING CHANGE:** Structure of `Action` classes have changed. See upgrading notes for [14.0.0.md](upgrading_notes/14.0.0.md#upgrading-to-cucumber-core-1400)
+([#282](https://github.com/cucumber/cucumber-ruby-core/pull/282))
 - Permit usage of gherkin up to v29 and messages up to v26
 
 ### Removed
@@ -150,7 +164,8 @@ See upgrading notes for [13.0.0.md](upgrading_notes/13.0.0.md#upgrading-to-cucum
 ### Changed
 - Updated `cucumber-gherkin` and `cucumber-messages`
 
-[Unreleased]: https://github.com/cucumber/cucumber-ruby-core/compare/v18.0.0...HEAD
+[Unreleased]: https://github.com/cucumber/cucumber-ruby-core/compare/v19.0.0...HEAD
+[19.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v18.0.0...v19.0.0
 [18.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v17.0.0...v18.0.0
 [17.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v16.2.0...v17.0.0
 [16.2.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v16.1.1...v16.2.0
@@ -171,10 +186,3 @@ See upgrading notes for [13.0.0.md](upgrading_notes/13.0.0.md#upgrading-to-cucum
 [12.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v11.1.0...v12.0.0
 [11.1.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v11.0.0...v11.1.0
 [11.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v10.1.1...v11.0.0
-.3]: https://github.com/cucumber/cucumber-ruby-core/compare/v13.0.2...v13.0.3
-[13.0.2]: https://github.com/cucumber/cucumber-ruby-core/compare/v13.0.1...v13.0.2
-[13.0.1]: https://github.com/cucumber/cucumber-ruby-core/compare/v13.0.0...v13.0.1
-[13.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v12.0.0...v13.0.0
-[12.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v11.1.0...v12.0.0
-[11.1.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v11.0.0...v11.1.0
-[11.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v10.1.1...v11.0.0

data/README.md

@@ -45,11 +45,7 @@ or install the gem directly:
 
 ### Supported platforms
 
-- Ruby 3.3
-- Ruby 3.2
-- Ruby 3.1
-- Ruby 3.0
-- JRuby 9.4 (with [some limitations](https://github.com/cucumber/cucumber-ruby/blob/main/docs/jruby-limitations.md))
+Supported Platforms are detailed in the [cucumber-ruby repository](https://github.com/cucumber/cucumber-ruby#supported-platforms).
 
 ## Usage
 

data/lib/cucumber/core/{events → event}/base.rb

@@ -2,7 +2,7 @@
 
 module Cucumber
   module Core
-    module Events
+    module Event
       # 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)

data/lib/cucumber/core/{events → event}/envelope.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 
 module Cucumber
   module Core
-    module Events
+    module Event
       class Envelope < Base
         attr_reader :envelope
 

data/lib/cucumber/core/{events → event}/gherkin_source_parsed.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 
 module Cucumber
   module Core
-    module Events
+    module Event
       # Signals that a gherkin source has been parsed
       class GherkinSourceParsed < Base
         # @return [GherkinDocument] the GherkinDocument Ast Node that was parsed

data/lib/cucumber/core/{events → event}/test_case_created.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 
 module Cucumber
   module Core
-    module Events
+    module Event
       # Signals that a Test::Case was created from a Pickle
       class TestCaseCreated < Base
         attr_reader :test_case, :pickle

data/lib/cucumber/core/{events → event}/test_case_finished.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative '../event'
+require_relative 'base'
 
 module Cucumber
   module Core
-    module Events
+    module Event
       # Signals that a {Test::Case} has finished executing
       class TestCaseFinished < Base
         # @return [Test::Case] that was executed

data/lib/cucumber/core/{events → event}/test_case_started.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 
 module Cucumber
   module Core
-    module Events
+    module Event
       # Signals that a {Test::Case} is about to be executed
       class TestCaseStarted < Base
         # @return [Cucumber::Core::Test::Case] the test case to be executed

data/lib/cucumber/core/{events → event}/test_step_created.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 
 module Cucumber
   module Core
-    module Events
+    module Event
       # Signals that a Test::Step was created from a PickleStep
       class TestStepCreated < Base
         attr_reader :test_step, :pickle_step

data/lib/cucumber/core/{events → event}/test_step_finished.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 
 module Cucumber
   module Core
-    module Events
+    module Event
       # Signals that a {Test::Step} has finished executing
       class TestStepFinished < Base
         # @return [Cucumber::Core::Test::Step] the test step that was executed

data/lib/cucumber/core/{events → event}/test_step_started.rb

@@ -4,7 +4,7 @@ require_relative 'base'
 
 module Cucumber
   module Core
-    module Events
+    module Event
       # Signals that a {Test::Step} is about to be executed
       class TestStepStarted < Base
         # @return [Cucumber::Core::Test::Step] the test step to be executed

data/lib/cucumber/core/event.rb

@@ -1,61 +1,10 @@
 # frozen_string_literal: true
 
-module Cucumber
-  module Core
-    class Event
-      # Macro to generate new subclasses of {Event} with attribute readers.
-      def self.new(*events)
-        # Use normal constructor for subclasses of Event
-        return super if ancestors.index(Event).positive?
-
-        Class.new(Event) do
-          # NB: We need to use metaprogramming here instead of direct variable obtainment
-          # because JRuby does not guarantee the order in which variables are defined is equivalent
-          # to the order in which they are obtainable
-          #
-          # See https://github.com/jruby/jruby/issues/7988 for more info
-          attr_reader(*events)
-
-          define_method(:initialize) do |*attributes|
-            events.zip(attributes) do |name, value|
-              instance_variable_set(:"@#{name}", value)
-            end
-          end
-        end
-      end
-
-      def to_h
-        instance_variables.to_h do |variable_name|
-          [variable_name[1..].to_sym, instance_variable_get(variable_name)]
-        end
-      end
-
-      def attributes
-        instance_variables.map { |var| instance_variable_get(var) }
-      end
-
-      def event_id
-        self.class.event_id
-      end
-
-      class << self
-        # @return [Symbol] the underscored name of the class to be used as the key in an event registry
-        def event_id
-          underscore(name.split('::').last).to_sym
-        end
-
-        private
-
-        def underscore(string)
-          string
-            .to_s
-            .gsub('::', '/')
-            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-            .tr('-', '_')
-            .downcase
-        end
-      end
-    end
-  end
-end
+require_relative 'event/envelope'
+require_relative 'event/gherkin_source_parsed'
+require_relative 'event/test_case_created'
+require_relative 'event/test_case_started'
+require_relative 'event/test_case_finished'
+require_relative 'event/test_step_created'
+require_relative 'event/test_step_started'
+require_relative 'event/test_step_finished'

data/lib/cucumber/core/event_bus.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'events'
+require_relative 'event'
 
 module Cucumber
   module Core
@@ -11,8 +11,30 @@ module Cucumber
     class EventBus
       attr_reader :event_types
 
+      # The registry contains all the event registered in the core, that will be used by the {EventBus} by default.
+      def self.registry
+        build_registry(
+          Event::Envelope,
+          Event::GherkinSourceParsed,
+          Event::TestCaseCreated,
+          Event::TestCaseStarted,
+          Event::TestCaseFinished,
+          Event::TestStepCreated,
+          Event::TestStepStarted,
+          Event::TestStepFinished
+        )
+      end
+
+      # Build an event registry to be passed to the {EventBus} constructor from a list of types.
+      # Each type must respond to `event_id` so that it can be added to the registry hash
+      #
+      # @return [Hash{Symbol => Class}]
+      def self.build_registry(*types)
+        types.to_h { |type| [type.event_id, type] }
+      end
+
       # @param registry [Hash{Symbol => Class}] a hash of event types to use on the bus
-      def initialize(registry = Events.registry)
+      def initialize(registry = self.class.registry)
         @event_types = registry.freeze
         @handlers = {}
         @event_queue = []

data/lib/cucumber/core/test/runner.rb

@@ -3,34 +3,51 @@
 require 'cucumber/messages/helpers/test_step_result_comparator'
 
 require_relative 'timer'
+require 'cucumber/messages'
 
 module Cucumber
   module Core
     module Test
       class Runner
-        attr_reader :event_bus, :running_test_case, :running_test_step
-        private :event_bus, :running_test_case, :running_test_step
+        include Cucumber::Messages::Helpers::TimeConversion
 
-        def initialize(event_bus)
+        attr_reader :event_bus, :running_test_case, :running_test_step, :id_generator
+        private :event_bus, :running_test_case, :running_test_step, :id_generator
+
+        def initialize(event_bus, id_generator = Cucumber::Messages::Helpers::IdGenerator::UUID.new, backtrace_filter = nil, max_attempts = 1)
           @event_bus = event_bus
+          @id_generator = id_generator
+          @backtrace_filter = backtrace_filter
+          @max_attempts = max_attempts
+          @current_test_case = nil
         end
 
         def test_case(test_case, &descend)
+          @attempt = @current_test_case == test_case ? @attempt + 1 : 1
+          @current_test_case = test_case
+          @current_test_case_started_id = id_generator.new_id
           @running_test_case = RunningTestCase.new
           @running_test_step = nil
           event_bus.test_case_started(test_case)
+          event_bus.envelope(to_test_case_started_envelope(test_case))
+
           descend.call(self)
-          result = running_test_case.result
-          result = Result::Undefined.new('The test case has no steps', Result::UnknownDuration.new, ["#{test_case.location}:in `#{test_case.name}'"]) if result.unknown?
+
+          result = calculate_test_case_result(test_case)
           event_bus.test_case_finished(test_case, result)
+          event_bus.envelope(to_test_case_finished_envelope(result))
           self
         end
 
         def test_step(test_step)
           @running_test_step = test_step
           event_bus.test_step_started test_step
+          event_bus.envelope(to_test_step_started_envelope(test_step))
+
           step_result = running_test_case.execute(test_step)
+
           event_bus.test_step_finished test_step, step_result
+          event_bus.envelope(to_test_step_finished_envelope(test_step, step_result))
           @running_test_step = nil
           self
         end
@@ -46,6 +63,85 @@ module Cucumber
           self
         end
 
+        def calculate_test_case_result(test_case)
+          if running_test_case.result.unknown?
+            Result::Undefined.new('The test case has no steps', Result::UnknownDuration.new, ["#{test_case.location}:in `#{test_case.name}'"])
+          else
+            running_test_case.result
+          end
+        end
+
+        def to_test_case_started_envelope(test_case)
+          Cucumber::Messages::Envelope.new(
+            test_case_started: Cucumber::Messages::TestCaseStarted.new(
+              id: @current_test_case_started_id,
+              test_case_id: test_case.id,
+              timestamp: time_to_timestamp(Time.now),
+              attempt: @attempt
+            )
+          )
+        end
+
+        def to_test_case_finished_envelope(result)
+          Cucumber::Messages::Envelope.new(
+            test_case_finished: Cucumber::Messages::TestCaseFinished.new(
+              test_case_started_id: @current_test_case_started_id,
+              timestamp: time_to_timestamp(Time.now),
+              will_be_retried: result.failed? && (@attempt < @max_attempts)
+            )
+          )
+        end
+
+        def to_test_step_started_envelope(test_step)
+          Cucumber::Messages::Envelope.new(
+            test_step_started: Cucumber::Messages::TestStepStarted.new(
+              test_step_id: test_step.id,
+              test_case_started_id: @current_test_case_started_id,
+              timestamp: time_to_timestamp(Time.now)
+            )
+          )
+        end
+
+        def to_test_step_finished_envelope(test_step, step_result)
+          result = @backtrace_filter.nil? ? step_result : step_result.with_filtered_backtrace(@backtrace_filter)
+          result_message = result.to_message
+          if result.failed? || result.pending?
+            message_element = result.failed? ? result.exception : result
+
+            result_message = Cucumber::Messages::TestStepResult.new(
+              status: result_message.status,
+              duration: result_message.duration,
+              message: to_error_message(message_element),
+              exception: to_exception_object(result, message_element)
+            )
+          end
+          Cucumber::Messages::Envelope.new(
+            test_step_finished: Cucumber::Messages::TestStepFinished.new(
+              test_step_id: test_step.id,
+              test_case_started_id: @current_test_case_started_id,
+              test_step_result: result_message,
+              timestamp: time_to_timestamp(Time.now)
+            )
+          )
+        end
+
+        def to_error_message(message_element)
+          <<~ERROR_MESSAGE
+            #{message_element.message} (#{message_element.class})
+            #{message_element.backtrace}
+          ERROR_MESSAGE
+        end
+
+        def to_exception_object(result, message_element)
+          return unless result.failed?
+
+          Cucumber::Messages::Exception.new(
+            type: message_element.class,
+            message: message_element.message,
+            stack_trace: message_element.backtrace.join("\n")
+          )
+        end
+
         class RunningTestCase
           include Cucumber::Messages::Helpers::TestStepResultComparator
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-core
 version: !ruby/object:Gem::Version
-  version: 18.0.0
+  version: 19.0.0
 platform: ruby
 authors:
 - Aslak Hellesøy
@@ -22,7 +22,7 @@ dependencies:
         version: '36'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '40'
+        version: '43'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -32,7 +32,7 @@ dependencies:
         version: '36'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '40'
+        version: '43'
 - !ruby/object:Gem::Dependency
   name: cucumber-messages
   requirement: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
         version: '31'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '33'
+        version: '35'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,7 +52,7 @@ dependencies:
         version: '31'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '33'
+        version: '35'
 - !ruby/object:Gem::Dependency
   name: cucumber-tag-expressions
   requirement: !ruby/object:Gem::Requirement
@@ -62,7 +62,7 @@ dependencies:
         version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -72,7 +72,7 @@ dependencies:
         version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -107,14 +107,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.87.0
+        version: 1.89.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.87.0
+        version: 1.89.0
 - !ruby/object:Gem::Dependency
   name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
@@ -149,14 +149,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.10.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.10.2
 description: Core library for the Cucumber BDD app
 email: cukes@googlegroups.com
 executables: []
@@ -169,17 +169,16 @@ files:
 - lib/cucumber/core.rb
 - lib/cucumber/core/compiler.rb
 - lib/cucumber/core/event.rb
+- lib/cucumber/core/event/base.rb
+- lib/cucumber/core/event/envelope.rb
+- lib/cucumber/core/event/gherkin_source_parsed.rb
+- lib/cucumber/core/event/test_case_created.rb
+- lib/cucumber/core/event/test_case_finished.rb
+- lib/cucumber/core/event/test_case_started.rb
+- lib/cucumber/core/event/test_step_created.rb
+- lib/cucumber/core/event/test_step_finished.rb
+- lib/cucumber/core/event/test_step_started.rb
 - lib/cucumber/core/event_bus.rb
-- lib/cucumber/core/events.rb
-- lib/cucumber/core/events/base.rb
-- lib/cucumber/core/events/envelope.rb
-- lib/cucumber/core/events/gherkin_source_parsed.rb
-- lib/cucumber/core/events/test_case_created.rb
-- lib/cucumber/core/events/test_case_finished.rb
-- lib/cucumber/core/events/test_case_started.rb
-- lib/cucumber/core/events/test_step_created.rb
-- lib/cucumber/core/events/test_step_finished.rb
-- lib/cucumber/core/events/test_step_started.rb
 - lib/cucumber/core/filter.rb
 - lib/cucumber/core/gherkin/document.rb
 - lib/cucumber/core/gherkin/parser.rb
@@ -261,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.2.8
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
-summary: cucumber-core-18.0.0
+summary: cucumber-core-19.0.0
 test_files: []

data/lib/cucumber/core/events.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'events/envelope'
-require_relative 'events/gherkin_source_parsed'
-require_relative 'events/test_case_created'
-require_relative 'events/test_case_started'
-require_relative 'events/test_case_finished'
-require_relative 'events/test_step_created'
-require_relative 'events/test_step_started'
-require_relative 'events/test_step_finished'
-
-module Cucumber
-  module Core
-    module Events
-      # The registry contains all the events registered in the core, that will be used by the {EventBus} by default.
-      def self.registry
-        build_registry(
-          Envelope,
-          GherkinSourceParsed,
-          TestCaseCreated,
-          TestCaseStarted,
-          TestCaseFinished,
-          TestStepCreated,
-          TestStepStarted,
-          TestStepFinished
-        )
-      end
-
-      # Build an event registry to be passed to the {EventBus} constructor from a list of types.
-      # Each type must respond to `event_id` so that it can be added to the registry hash
-      #
-      # @return [Hash{Symbol => Class}]
-      def self.build_registry(*types)
-        types.to_h { |type| [type.event_id, type] }
-      end
-    end
-  end
-end