cucumber-core 15.4.0 → 16.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d6c44db30c6049a00aaa02f36c1a5bd85471d617703ba794808a8073afb5266
-  data.tar.gz: 0ed650cf7aca55c6716f1977e9bdfec144d59d6a0634de0e0616fe1ca58f8cd5
+  metadata.gz: 1710a14ed278897b31a075938c655efc6614d353ec7ca37102f43460bc454934
+  data.tar.gz: bd2fd69c1ddef3e4d41bcc3145495a3eb43b3e19645a3daf6f134debcc5e73e0
 SHA512:
-  metadata.gz: 3967dc02fdb31308428fefd9acb4014795bcdb102c675a40b5a7498592c674faee4ee77f178aaf5c78241f73c8c62828b3348e09b9b7d39ada08758cfd6c1361
-  data.tar.gz: 91d51f70480b132d549b8bc8229a29e24b169052461422f4198b4a79ce3652ef6ce2f4226822c2d5ce6a8a85d46cf2ca8b63dcd0cc965ecff084a8fcd5235c49
+  metadata.gz: 6c59caed7891d014027f2d83511961cf768066a66f7f033a05dd1f868cb88fc843c276c3645ecf5af5ac020e048a62c3966277672bc3a356ba1f3ea94d0e76c9
+  data.tar.gz: 13a00c9ea789204fb36f2a45a71df9073e53f36953e1ef3640cd30c45baae405da85ff583f1d8d77edca34ffd97895bbd1b845cd7a345b7582cc817e2b85c7d6

data/CHANGELOG.md

@@ -10,6 +10,22 @@ Please visit [cucumber/CONTRIBUTING.md](https://github.com/cucumber/cucumber/blo
 
 ## [Unreleased]
 
+## [16.1.1] - 2025-12-24
+### Fixed
+- Added a fix that prevented the `Duration` class from not being able to calculate duration correctly
+
+## [16.1.0] - 2025-12-22
+### Changed
+- Code re-organised into more sub-files. No user facing changes
+- Further bumped the lower bounds of messages and gherkin several more versions
+
+## [16.0.0] - 2025-12-16
+### Changed
+- Bumped the lower bounds of messages to v28, gherkin to v33 and tag-expressions to v6
+
+### Removed
+- Remove support for ruby 3.1 and below. 3.2 or higher is required now
+
 ## [15.4.0] - 2025-12-10
 ### Changed
 - Permit usage of gherkin up to v39, messages up to v32
@@ -111,7 +127,10 @@ 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/v15.4.0...HEAD
+[Unreleased]: https://github.com/cucumber/cucumber-ruby-core/compare/v16.1.1...HEAD
+[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
+[16.0.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v15.4.0...v16.0.0
 [15.4.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v15.3.0...v15.4.0
 [15.3.0]: https://github.com/cucumber/cucumber-ruby-core/compare/v15.2.1...v15.3.0
 [15.2.1]: https://github.com/cucumber/cucumber-ruby-core/compare/v15.2.0...v15.2.1

data/lib/cucumber/core/event.rb

@@ -3,11 +3,10 @@
 module Cucumber
   module Core
     class Event
-      # Macro to generate new sub-classes of {Event} with
-      # attribute readers.
+      # 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) > 0
+        return super if ancestors.index(Event).positive?
 
         Class.new(Event) do
           # NB: We need to use metaprogramming here instead of direct variable obtainment

data/lib/cucumber/core/event_bus.rb

@@ -34,9 +34,9 @@ module Cucumber
         @event_queue << event
       end
 
-      def method_missing(event_id, *args)
+      def method_missing(event_id, *)
         event_class = event_types.fetch(event_id) { super }
-        broadcast event_class.new(*args)
+        broadcast event_class.new(*)
       end
 
       def respond_to_missing?(event_id, *args)

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../event'
+
+module Cucumber
+  module Core
+    module Events
+      class Envelope < Event.new(:envelope)
+        attr_reader :envelope
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../event'
+
+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
+        attr_reader :gherkin_document
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../event'
+
+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
+
+        # The source pickle step
+        attr_reader :pickle
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../event'
+
+module Cucumber
+  module Core
+    module Events
+      # Signals that a {Test::Case} has finished executing
+      class TestCaseFinished < Event.new(:test_case, :result)
+        # @return [Test::Case] that was executed
+        attr_reader :test_case
+
+        # @return [Test::Result] the result of running the {Test::Step}
+        attr_reader :result
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../event'
+
+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
+        attr_reader :test_case
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../event'
+
+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
+
+        # The source pickle step
+        attr_reader :pickle_step
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative '../event'
+
+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
+        attr_reader :test_step
+
+        # @return [Test::Result] the result of running the {Test::Step}
+        attr_reader :result
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../event'
+
+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
+        attr_reader :test_step
+      end
+    end
+  end
+end

data/lib/cucumber/core/events.rb

@@ -1,88 +1,33 @@
 # frozen_string_literal: true
 
-require 'cucumber/core/event'
+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
-      class Envelope < Event.new(:envelope)
-        attr_reader :envelope
-      end
-
-      # Signals that a gherkin source has been parsed
-      class GherkinSourceParsed < Event.new(:gherkin_document)
-        # @return [GherkinDocument] the GherkinDocument Ast Node
-        attr_reader :gherkin_document
-      end
-
-      # 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
-
-        # The source pickle step
-        attr_reader :pickle_step
-      end
-
-      # 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
-
-        # The source pickle step
-        attr_reader :pickle
-      end
-
-      # 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
-        attr_reader :test_case
-      end
-
-      # 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
-        attr_reader :test_step
-      end
-
-      # Signals that a {Test::Step} has finished executing
-      class TestStepFinished < Event.new(:test_step, :result)
-        # @return [Test::Step] the test step that was executed
-        attr_reader :test_step
-
-        # @return [Test::Result] the result of running the {Test::Step}
-        attr_reader :result
-      end
-
-      # Signals that a {Test::Case} has finished executing
-      class TestCaseFinished < Event.new(:test_case, :result)
-        # @return [Test::Case] that was executed
-        attr_reader :test_case
-
-        # @return [Test::Result] the result of running the {Test::Step}
-        attr_reader :result
-      end
-
-      # The registry contains all the events registered in the core,
-      # that will be used by the {EventBus} by default.
+      # 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,
-          TestStepCreated,
           TestCaseCreated,
           TestCaseStarted,
+          TestCaseFinished,
+          TestStepCreated,
           TestStepStarted,
-          TestStepFinished,
-          TestCaseFinished
+          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.
+      # 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)

data/lib/cucumber/core/gherkin/writer/background.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module Cucumber
+  module Core
+    module Gherkin
+      module Writer
+        class Background
+          include HasElements
+          include HasOptionsInitializer
+          include HasDescription
+          include Indentation.level 2
+
+          default_keyword 'Background'
+
+          elements :step
+
+          private
+
+          def statements
+            prepare_statements(
+              comments_statement,
+              tag_statement,
+              name_statement,
+              description_statement
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/core/gherkin/writer/doc_string.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module Cucumber
+  module Core
+    module Gherkin
+      module Writer
+        class DocString
+          include Indentation.level(6)
+
+          attr_reader :strings, :content_type
+          private :strings, :content_type
+
+          def initialize(string, content_type)
+            @strings = string.split("\n").map(&:strip)
+            @content_type = content_type
+          end
+
+          def build(source)
+            source + statements
+          end
+
+          private
+
+          def statements
+            prepare_statements doc_string_statement
+          end
+
+          def doc_string_statement
+            [
+              %("""#{content_type}),
+              strings,
+              '"""'
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/core/gherkin/writer/example.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+require_relative 'scenario'
+
+module Cucumber
+  module Core
+    module Gherkin
+      module Writer
+        class Example < Scenario
+          include Indentation.level 4
+
+          default_keyword 'Example'
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/core/gherkin/writer/examples.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module Cucumber
+  module Core
+    module Gherkin
+      module Writer
+        class Examples
+          NEW_LINE = ''
+
+          include HasOptionsInitializer
+          include HasRows
+          include HasDescription
+          include Indentation.level(4)
+
+          default_keyword 'Examples'
+
+          def build(source)
+            source + statements
+          end
+
+          private
+
+          def statements
+            prepare_statements(
+              NEW_LINE,
+              comments_statement,
+              tag_statement,
+              name_statement,
+              description_statement,
+              row_statements(2)
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/core/gherkin/writer/feature.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module Cucumber
+  module Core
+    module Gherkin
+      module Writer
+        class Feature
+          NEW_LINE = ''
+
+          include HasElements
+          include HasOptionsInitializer
+          include HasDescription
+          include Indentation.level(0)
+
+          default_keyword 'Feature'
+
+          elements :background, :rule, :scenario, :scenario_outline
+
+          def build(source = [])
+            elements.inject(source + statements) { |acc, el| el.build(acc) + [NEW_LINE] }
+          end
+
+          private
+
+          def language
+            options[:language]
+          end
+
+          def statements
+            prepare_statements(
+              language_statement,
+              comments_statement,
+              tag_statement,
+              name_statement,
+              description_statement,
+              NEW_LINE
+            )
+          end
+
+          def language_statement
+            "# language: #{language}" if language
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../document'
+require_relative 'feature'
+
+module Cucumber
+  module Core
+    module Gherkin
+      module Writer
+        class Gherkin
+          def initialize(uri, &source)
+            @uri = uri
+            @source = source
+          end
+
+          def comment(line)
+            comment_lines << "# #{line}"
+          end
+
+          def comment_lines
+            @comment_lines ||= []
+          end
+
+          def feature(*args, &source)
+            @feature = Feature.new(comment_lines, *args).tap do |builder|
+              builder.instance_exec(&source) if source
+            end
+            self
+          end
+
+          def build
+            instance_exec(&@source)
+            Document.new(@uri, @feature.build.join("\n"))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/core/gherkin/writer/rule.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module Cucumber
+  module Core
+    module Gherkin
+      module Writer
+        class Rule
+          NEW_LINE = ''
+
+          include HasElements
+          include HasOptionsInitializer
+          include HasDescription
+          include Indentation.level 2
+
+          default_keyword 'Rule'
+
+          elements :example, :scenario
+
+          private
+
+          def statements
+            prepare_statements(
+              comments_statement,
+              name_statement,
+              description_statement,
+              NEW_LINE
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/core/gherkin/writer/scenario.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module Cucumber
+  module Core
+    module Gherkin
+      module Writer
+        class Scenario
+          include HasElements
+          include HasOptionsInitializer
+          include HasDescription
+          include Indentation.level 2
+
+          default_keyword 'Scenario'
+
+          elements :step
+
+          private
+
+          def statements
+            prepare_statements(
+              comments_statement,
+              tag_statement,
+              name_statement,
+              description_statement
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/core/gherkin/writer/scenario_outline.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module Cucumber
+  module Core
+    module Gherkin
+      module Writer
+        class ScenarioOutline
+          include HasElements
+          include HasOptionsInitializer
+          include HasDescription
+          include Indentation.level 2
+
+          default_keyword 'Scenario Outline'
+
+          elements :step, :examples
+
+          private
+
+          def statements
+            prepare_statements comments_statement, tag_statement, name_statement, description_statement
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/core/gherkin/writer/step.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+require_relative 'doc_string'
+
+module Cucumber
+  module Core
+    module Gherkin
+      module Writer
+        class Step
+          include HasElements
+          include HasOptionsInitializer
+          include Indentation.level 4
+
+          default_keyword 'Given'
+
+          elements :table
+
+          def doc_string(string, content_type = '')
+            elements << DocString.new(string, content_type)
+          end
+
+          private
+
+          def statements
+            prepare_statements comments_statement, name_statement
+          end
+
+          def name_statement
+            "#{keyword} #{name}"
+          end
+        end
+      end
+    end
+  end
+end