cucumber-core 16.2.0 → 17.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5192b979fbfa5fa71497c22b8b00f5b5b8ce8ab6cb19336cd30fbb1ba4b0d5c0
-  data.tar.gz: b7f2369ab7d140b6f994a4449da3aeaafc40b778ff13bbdfd39cc667dd364348
+  metadata.gz: 88faed296b96d11e574838451644e6ab5e784bb2e4bdf9238f24b4488dc4a902
+  data.tar.gz: 020fe0f4bbc9072752a0748465157991e9c65765ce47c33061c89bedd7e37db0
 SHA512:
-  metadata.gz: 07370ea41e4c119482539c14e9ddb72892978d099fdf28954e8530b3ff5e012f95843f933ec3d21b7021886f78ae4c63f4dbf900ea7384b90b79515e68af2bb6
-  data.tar.gz: 7c16479e598b3217b7bbaef0712c06b75212b66bc9b2b9d2f887a10914cb590f8a288affdc59dc487ee00e7542982e9069147293809f4b2191d620f598df9b21
+  metadata.gz: 9f1900994b1560af95ba5871cd9ee8f9647d1e93e4148e6ed1d56406c4fffaa85afdccebfc9d05a11d795bebf473e2450589656d193e7d42d6412d4c1a861fa4
+  data.tar.gz: 7490537caa92180e2887080e8bd7fa169bc9994dd2d01262ffb57b3d3b3d5df1a34c7ae6503d5433847409b44586e221bdd2dd00ec7f28a094c00878751e480e

data/CHANGELOG.md

@@ -10,6 +10,23 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ## [Unreleased]
 
+## [17.0.0] - 2026-06-01
+### Added
+- Added `#to_envelope` for `Cucumber::Core::Gherkin::Document` ([#329](https://github.com/cucumber/cucumber-ruby-core/pull/329))
+
+### Changed
+- Refactored the internal base `Event` class to reduce complexity and make it more flexible for future use (No user facing changes)
+- Refactored the `Result` classes to be more simplified and one class per file
+- Changed the base event inheritance to a new base class structure
+- Refactored some internals of the library to be slightly more performant (Including removing redundant nil checks)
+- Permit `cucumber-tag-expressions` up to v10
+- Change to use worst Test Step result as the Test Case result
+([#317](https://github.com/cucumber/cucumber-ruby-core/pull/317))
+
+### Removed
+- Strict configuration has been removed from all `Result` classes
+- Removed the ability to list event attributes (Only the `#to_h` method now remains for this purpose)
+
 ## [16.2.0] - 2026-02-06
 ### Changed
 - Added the test result type 'ambiguous'
@@ -132,7 +149,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/v16.2.0...HEAD
+[Unreleased]: https://github.com/cucumber/cucumber-ruby-core/compare/v17.0.0...HEAD
+[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
 [16.1.1]: https://github.com/cucumber/cucumber-ruby-core/compare/v16.1.0...v16.1.1
 [16.1.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v16.0.0...v16.1.0

data/LICENSE

@@ -1,20 +1,21 @@
-Copyright (c) Cucumber Ltd. and Contributors
+MIT License
 
-MIT License (Expat)
+Copyright (c) Cucumber Ltd. and Contributors
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/cucumber/core/compiler.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/test/case'
-require 'cucumber/core/test/data_table'
-require 'cucumber/core/test/doc_string'
-require 'cucumber/core/test/empty_multiline_argument'
-require 'cucumber/core/test/hook_step'
-require 'cucumber/core/test/step'
-require 'cucumber/core/test/tag'
+require_relative 'test/case'
+require_relative 'test/data_table'
+require_relative 'test/doc_string'
+require_relative 'test/empty_multiline_argument'
+require_relative 'test/hook_step'
+require_relative 'test/step'
+require_relative 'test/tag'
+
 require 'cucumber/messages'
 
 module Cucumber
@@ -16,7 +17,7 @@ module Cucumber
       attr_reader :receiver, :gherkin_query, :id_generator
       private     :receiver, :gherkin_query, :id_generator
 
-      def initialize(receiver, gherkin_query, event_bus = nil)
+      def initialize(receiver, gherkin_query, event_bus)
         @receiver = receiver
         @id_generator = Cucumber::Messages::Helpers::IdGenerator::UUID.new
         @gherkin_query = gherkin_query
@@ -42,7 +43,7 @@ module Cucumber
         parent_locations = parent_locations_from_pickle(pickle)
         tags = tags_from_pickle(pickle, uri)
         Test::Case.new(id_generator.new_id, pickle.name, test_steps, location, parent_locations, tags, pickle.language).tap do |test_case|
-          @event_bus&.test_case_created(test_case, pickle)
+          @event_bus.test_case_created(test_case, pickle)
         end
       end
 
@@ -50,7 +51,7 @@ module Cucumber
         location = location_from_pickle_step(pickle_step, uri)
         multiline_arg = create_multiline_arg(pickle_step, uri)
         Test::Step.new(id_generator.new_id, pickle_step.text, location, multiline_arg).tap do |test_step|
-          @event_bus&.test_step_created(test_step, pickle_step)
+          @event_bus.test_step_created(test_step, pickle_step)
         end
       end
 

data/lib/cucumber/core/event.rb

@@ -21,19 +21,21 @@ module Cucumber
               instance_variable_set(:"@#{name}", value)
             end
           end
+        end
+      end
 
-          define_method(:attributes) do
-            events.map { |var| instance_variable_get(:"@#{var}") }
-          end
+      def to_h
+        instance_variables.to_h do |variable_name|
+          [variable_name[1..].to_sym, instance_variable_get(variable_name)]
+        end
+      end
 
-          define_method(:to_h) do
-            events.zip(attributes).to_h
-          end
+      def attributes
+        instance_variables.map { |var| instance_variable_get(var) }
+      end
 
-          def event_id
-            self.class.event_id
-          end
-        end
+      def event_id
+        self.class.event_id
       end
 
       class << self

data/lib/cucumber/core/event_bus.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/events'
+require_relative 'events'
 
 module Cucumber
   module Core

data/lib/cucumber/core/events/base.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Core
+    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
+end

data/lib/cucumber/core/events/envelope.rb

@@ -1,12 +1,23 @@
 # frozen_string_literal: true
 
-require_relative '../event'
+require_relative 'base'
 
 module Cucumber
   module Core
     module Events
-      class Envelope < Event.new(:envelope)
+      class Envelope < Base
         attr_reader :envelope
+
+        # The underscored name of the class to be used as the key in an event registry
+        #   @return [Symbol]
+        def self.event_id
+          :envelope
+        end
+
+        def initialize(envelope)
+          @envelope = envelope
+          super()
+        end
       end
     end
   end

data/lib/cucumber/core/events/gherkin_source_parsed.rb

@@ -1,14 +1,23 @@
 # frozen_string_literal: true
 
-require_relative '../event'
+require_relative 'base'
 
 module Cucumber
   module Core
     module Events
       # Signals that a gherkin source has been parsed
-      class GherkinSourceParsed < Event.new(:gherkin_document)
-        # @return [GherkinDocument] the GherkinDocument Ast Node
+      class GherkinSourceParsed < Base
+        # @return [GherkinDocument] the GherkinDocument Ast Node that was parsed
         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/core/events/test_case_created.rb

@@ -1,17 +1,23 @@
 # frozen_string_literal: true
 
-require_relative '../event'
+require_relative 'base'
 
 module Cucumber
   module Core
     module Events
       # Signals that a Test::Case was created from a Pickle
-      class TestCaseCreated < Event.new(:test_case, :pickle)
-        # The created test step
-        attr_reader :test_case
+      class TestCaseCreated < Base
+        attr_reader :test_case, :pickle
 
-        # The source pickle step
-        attr_reader :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/core/events/test_case_finished.rb

@@ -6,12 +6,22 @@ module Cucumber
   module Core
     module Events
       # Signals that a {Test::Case} has finished executing
-      class TestCaseFinished < Event.new(:test_case, :result)
+      class TestCaseFinished < Base
         # @return [Test::Case] that was executed
         attr_reader :test_case
 
         # @return [Test::Result] the result of running the {Test::Step}
         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/core/events/test_case_started.rb

@@ -1,14 +1,23 @@
 # frozen_string_literal: true
 
-require_relative '../event'
+require_relative 'base'
 
 module Cucumber
   module Core
     module Events
       # Signals that a {Test::Case} is about to be executed
-      class TestCaseStarted < Event.new(:test_case)
-        # @return [Test::Case] the test case to be executed
+      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/core/events/test_step_created.rb

@@ -1,17 +1,23 @@
 # frozen_string_literal: true
 
-require_relative '../event'
+require_relative 'base'
 
 module Cucumber
   module Core
     module Events
       # Signals that a Test::Step was created from a PickleStep
-      class TestStepCreated < Event.new(:test_step, :pickle_step)
-        # The created test step
-        attr_reader :test_step
+      class TestStepCreated < Base
+        attr_reader :test_step, :pickle_step
 
-        # The source pickle step
-        attr_reader :pickle_step
+        def self.event_id
+          :test_step_created
+        end
+
+        def initialize(test_step, pickle_step)
+          @test_step = test_step
+          @pickle_step = pickle_step
+          super()
+        end
       end
     end
   end

data/lib/cucumber/core/events/test_step_finished.rb

@@ -1,17 +1,27 @@
 # frozen_string_literal: true
 
-require_relative '../event'
+require_relative 'base'
 
 module Cucumber
   module Core
     module Events
       # Signals that a {Test::Step} has finished executing
-      class TestStepFinished < Event.new(:test_step, :result)
-        # @return [Test::Step] the test step that was executed
+      class TestStepFinished < Base
+        # @return [Cucumber::Core::Test::Step] the test step that was executed
         attr_reader :test_step
 
-        # @return [Test::Result] the result of running the {Test::Step}
+        # @return [Cucumber::Core::Test::Result] the result of running the {Cucumber::Core::Test::Step}
         attr_reader :result
+
+        def self.event_id
+          :test_step_finished
+        end
+
+        def initialize(test_step, result)
+          @test_step = test_step
+          @result = result
+          super()
+        end
       end
     end
   end

data/lib/cucumber/core/events/test_step_started.rb

@@ -1,14 +1,23 @@
 # frozen_string_literal: true
 
-require_relative '../event'
+require_relative 'base'
 
 module Cucumber
   module Core
     module Events
       # Signals that a {Test::Step} is about to be executed
-      class TestStepStarted < Event.new(:test_step)
-        # @return [Test::Step] the test step to be executed
+      class TestStepStarted < Base
+        # @return [Cucumber::Core::Test::Step] the test step to be executed
         attr_reader :test_step
+
+        def self.event_id
+          :test_step_started
+        end
+
+        def initialize(test_step)
+          @test_step = test_step
+          super()
+        end
       end
     end
   end

data/lib/cucumber/core/gherkin/document.rb

@@ -6,18 +6,28 @@ module Cucumber
       class Document
         attr_reader :uri, :body, :language
 
-        def initialize(uri, body, language = nil)
-          @uri      = uri
-          @body     = body
-          @language = language || 'en'
+        def initialize(uri, body, language = 'en')
+          @uri = uri
+          @body = body
+          @language = language
+        end
+
+        def ==(other)
+          to_s == other.to_s
         end
 
         def to_s
           body
         end
 
-        def ==(other)
-          to_s == other.to_s
+        def to_envelope
+          Cucumber::Messages::Envelope.new(
+            source: Cucumber::Messages::Source.new(
+              uri: uri,
+              data: body,
+              media_type: 'text/x.cucumber.gherkin+plain'
+            )
+          )
         end
       end
     end

data/lib/cucumber/core/gherkin/parser.rb

@@ -64,15 +64,11 @@ module Cucumber
         end
 
         def type(message)
-          if !message.gherkin_document.nil?
-            :gherkin_document
-          elsif !message.pickle.nil?
-            :pickle
-          elsif message.parse_error
-            :parse_error
-          else
-            :unknown
-          end
+          return :gherkin_document if message.gherkin_document
+          return :pickle if message.pickle
+          return :parse_error if message.parse_error
+
+          :unknown
         end
       end
     end

data/lib/cucumber/core/report/summary.rb

@@ -13,8 +13,8 @@ module Cucumber
           subscribe_to(event_bus)
         end
 
-        def ok?(strict: Test::Result::StrictConfiguration.new)
-          test_cases.ok?(strict: strict)
+        def ok?
+          test_cases.ok?
         end
 
         private

data/lib/cucumber/core/test/action/defined.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/test/location'
-require 'cucumber/core/test/result'
-require 'cucumber/core/test/timer'
+require_relative '../location'
+require_relative '../result'
+require_relative '../timer'
 
 module Cucumber
   module Core

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/test/location'
-require 'cucumber/core/test/result'
-require 'cucumber/core/test/timer'
+require_relative 'location'
+require_relative 'result'
+require_relative 'timer'
 
-require 'cucumber/core/test/action/defined'
-require 'cucumber/core/test/action/undefined'
-require 'cucumber/core/test/action/unskippable'
+require_relative 'action/defined'
+require_relative 'action/undefined'
+require_relative 'action/unskippable'

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

@@ -13,10 +13,6 @@ module Cucumber
           visitor.around_hook(self, *, &)
         end
 
-        def hook?
-          true
-        end
-
         def execute(*_args, &continue)
           @timer.start
           @block.call(continue)
@@ -27,6 +23,10 @@ module Cucumber
           failed(e)
         end
 
+        def hook?
+          true
+        end
+
         private
 
         def failed(exception)

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

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/test/result'
 require 'cucumber/tag_expressions'
 
+require_relative 'result'
+
 module Cucumber
   module Core
     module Test
@@ -22,8 +23,8 @@ module Cucumber
           @around_hooks = around_hooks
         end
 
-        def step_count
-          test_steps.count
+        def ==(other)
+          eql?(other)
         end
 
         def describe_to(visitor, *args)
@@ -37,20 +38,25 @@ module Cucumber
           self
         end
 
-        def with_steps(test_steps)
-          self.class.new(id, name, test_steps, location, parent_locations, tags, language, around_hooks)
+        def eql?(other)
+          other.hash == hash
         end
 
-        def with_around_hooks(around_hooks)
-          self.class.new(id, name, test_steps, location, parent_locations, tags, language, around_hooks)
+        def hash
+          location.hash
         end
 
-        def match_tags?(*expressions)
-          expressions.flatten.all? { |expression| match_single_tag_expression?(expression) }
+        def inspect
+          "#<#{self.class}: #{location}>"
         end
 
-        def match_name?(name_regexp)
-          name =~ name_regexp
+        def matching_locations
+          [
+            parent_locations,
+            location,
+            tags.map(&:location),
+            test_steps.map(&:matching_locations)
+          ].flatten
         end
 
         def match_locations?(queried_locations)
@@ -61,29 +67,24 @@ module Cucumber
           end
         end
 
-        def matching_locations
-          [
-            parent_locations,
-            location,
-            tags.map(&:location),
-            test_steps.map(&:matching_locations)
-          ].flatten
+        def match_name?(name_regexp)
+          name =~ name_regexp
         end
 
-        def inspect
-          "#<#{self.class}: #{location}>"
+        def match_tags?(*expressions)
+          expressions.flatten.all? { |expression| match_single_tag_expression?(expression) }
         end
 
-        def hash
-          location.hash
+        def step_count
+          test_steps.count
         end
 
-        def eql?(other)
-          other.hash == hash
+        def with_around_hooks(around_hooks)
+          self.class.new(id, name, test_steps, location, parent_locations, tags, language, around_hooks)
         end
 
-        def ==(other)
-          eql?(other)
+        def with_steps(test_steps)
+          self.class.new(id, name, test_steps, location, parent_locations, tags, language, around_hooks)
         end
 
         private