cucumber-messages 28.1.0 → 29.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cc648c1bbc47f10e819e846a0abba287b8a2bbf17df3376c48b656130947992
-  data.tar.gz: af14b472bdeb1e66f0d8f5c3fe28871f36f7c187a85c0b2bff8bce523756d643
+  metadata.gz: e66ca9fa18e868a89da334e0c63c7f709eebc78a0c5cb58ded617a1d80197ffd
+  data.tar.gz: 76aa8a3325cb9183f153ecce7014e93b0ab265c28133d8e068b003ed5a9fa1eb
 SHA512:
-  metadata.gz: c21f00aa9a8db8d70ac4db29afbf660920ff9db1fc97f1eff2a9e81eabc92fdc1ca9603ad7dc9db2dd4cde73b2518cdc2fc9ea1e4a68cc0ee43a55f7f9aeea0f
-  data.tar.gz: 3586df87e8a29d95fac2974d098b95c40ccf7d98abfa75b89d312ecaac11e2b70453b48f3ff7d68f162f4f671de6d55690df347cd475c876b54f3228b414a5cf
+  metadata.gz: 5594499de746c826e6db6647a5076d8864d5e2daf677d138701fb8eea7c6bcd9b435a79d259efbc82c9f4389acaadfb80d9105c63cb7c95417e754bd8139c254
+  data.tar.gz: 1dfd7f54dc31dacc31fb5d9429c20fec41c2c42ec7e1fafe7200e0c05648b5670be90931023f75bd943bf66ba84ed127235fecc87b032b5ea6ddba110b636547

data/VERSION

@@ -1 +1 @@
-28.1.0
+29.0.0

data/lib/cucumber/messages/envelope.rb

@@ -22,6 +22,8 @@ module Cucumber
 
       attr_reader :pickle
 
+      attr_reader :suggestion
+
       attr_reader :source
 
       attr_reader :step_definition
@@ -54,6 +56,7 @@ module Cucumber
         parameter_type: nil,
         parse_error: nil,
         pickle: nil,
+        suggestion: nil,
         source: nil,
         step_definition: nil,
         test_case: nil,
@@ -74,6 +77,7 @@ module Cucumber
         @parameter_type = parameter_type
         @parse_error = parse_error
         @pickle = pickle
+        @suggestion = suggestion
         @source = source
         @step_definition = step_definition
         @test_case = test_case
@@ -107,6 +111,7 @@ module Cucumber
           parameter_type: ParameterType.from_h(hash[:parameterType]),
           parse_error: ParseError.from_h(hash[:parseError]),
           pickle: Pickle.from_h(hash[:pickle]),
+          suggestion: Suggestion.from_h(hash[:suggestion]),
           source: Source.from_h(hash[:source]),
           step_definition: StepDefinition.from_h(hash[:stepDefinition]),
           test_case: TestCase.from_h(hash[:testCase]),

data/lib/cucumber/messages/snippet.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the Snippet message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class Snippet < Message
+      ##
+      # The programming language of the code.
+      #
+      # This must be formatted as an all lowercase identifier such that syntax highlighters like [Prism](https://prismjs.com/#supported-languages) or [Highlight.js](https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md) can recognize it.
+      # For example: `cpp`, `cs`, `go`, `java`, `javascript`, `php`, `python`, `ruby`, `scala`.
+      ##
+      attr_reader :language
+
+      ##
+      # A snippet of code
+      ##
+      attr_reader :code
+
+      def initialize(
+        language: '',
+        code: ''
+      )
+        @language = language
+        @code = code
+        super()
+      end
+
+      ##
+      # Returns a new Snippet from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Snippet.from_h(some_hash) # => #<Cucumber::Messages::Snippet:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          language: hash[:language],
+          code: hash[:code]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/suggestion.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/codegen/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the Suggestion message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # A suggested fragment of code to implement an undefined step
+    ##
+    class Suggestion < Message
+      ##
+      # A unique id for this suggestion
+      ##
+      attr_reader :id
+
+      ##
+      # The ID of the `PickleStep` this `Suggestion` was created for.
+      ##
+      attr_reader :pickle_step_id
+
+      ##
+      # A collection of code snippets that could implement the undefined step
+      ##
+      attr_reader :snippets
+
+      def initialize(
+        id: '',
+        pickle_step_id: '',
+        snippets: []
+      )
+        @id = id
+        @pickle_step_id = pickle_step_id
+        @snippets = snippets
+        super()
+      end
+
+      ##
+      # Returns a new Suggestion from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Suggestion.from_h(some_hash) # => #<Cucumber::Messages::Suggestion:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          id: hash[:id],
+          pickle_step_id: hash[:pickleStepId],
+          snippets: hash[:snippets]&.map { |item| Snippet.from_h(item) }
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/test_run_hook_started.rb

@@ -23,17 +23,24 @@ module Cucumber
       ##
       attr_reader :hook_id
 
+      ##
+      # An identifier for the worker process running this hook, if parallel workers are in use. The identifier will be unique per worker, but no particular format is defined - it could be an index, uuid, machine name etc - and as such should be assumed that it's not human readable.
+      ##
+      attr_reader :worker_id
+
       attr_reader :timestamp
 
       def initialize(
         id: '',
         test_run_started_id: '',
         hook_id: '',
+        worker_id: nil,
         timestamp: Timestamp.new
       )
         @id = id
         @test_run_started_id = test_run_started_id
         @hook_id = hook_id
+        @worker_id = worker_id
         @timestamp = timestamp
         super()
       end
@@ -52,6 +59,7 @@ module Cucumber
           id: hash[:id],
           test_run_started_id: hash[:testRunStartedId],
           hook_id: hash[:hookId],
+          worker_id: hash[:workerId],
           timestamp: Timestamp.from_h(hash[:timestamp])
         )
       end

data/lib/cucumber/messages/test_step.rb

@@ -7,8 +7,11 @@ module Cucumber
     # Represents the TestStep message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # A `TestStep` is derived from either a `PickleStep`
-    # combined with a `StepDefinition`, or from a `Hook`.
+    # A `TestStep` is derived from either a `PickleStep` combined with a `StepDefinition`, or from a `Hook`.
+    #
+    # When derived from a PickleStep:
+    #  * For `UNDEFINED` steps `stepDefinitionIds` and `stepMatchArgumentsLists` will be empty.
+    #  * For `AMBIGUOUS` steps, there will be multiple entries in `stepDefinitionIds` and `stepMatchArgumentsLists`. The first entry in the stepMatchArgumentsLists holds the list of arguments for the first matching step definition, the second entry for the second, etc
     ##
     class TestStep < Message
       ##
@@ -24,14 +27,16 @@ module Cucumber
       attr_reader :pickle_step_id
 
       ##
-      # Pointer to all the matching `StepDefinition`s (if derived from a `PickleStep`)
-      # Each element represents a matching step definition. A size of 0 means `UNDEFINED`,
-      # and a size of 2+ means `AMBIGUOUS`
+      # Pointer to all the matching `StepDefinition`s (if derived from a `PickleStep`).
+      #
+      # Each element represents a matching step definition.
       ##
       attr_reader :step_definition_ids
 
       ##
       # A list of list of StepMatchArgument (if derived from a `PickleStep`).
+      #
+      # Each element represents the arguments for a matching step definition.
       ##
       attr_reader :step_match_arguments_lists
 

data/lib/cucumber/messages/test_step_result.rb

@@ -11,7 +11,7 @@ module Cucumber
       attr_reader :duration
 
       ##
-      # An arbitrary bit of information that explains this result. This can be a stack trace of anything else.
+      # An arbitrary bit of information that explains this result. If there was an exception, this should include a stringified representation of it including type, message and stack trace (the exact format will vary by platform).
       ##
       attr_reader :message
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-messages
 version: !ruby/object:Gem::Version
-  version: 28.1.0
+  version: 29.0.0
 platform: ruby
 authors:
 - Aslak Hellesøy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-21 00:00:00.000000000 Z
+date: 2025-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber-compatibility-kit
@@ -161,6 +161,7 @@ files:
 - lib/cucumber/messages/rule.rb
 - lib/cucumber/messages/rule_child.rb
 - lib/cucumber/messages/scenario.rb
+- lib/cucumber/messages/snippet.rb
 - lib/cucumber/messages/source.rb
 - lib/cucumber/messages/source_media_type.rb
 - lib/cucumber/messages/source_reference.rb
@@ -171,6 +172,7 @@ files:
 - lib/cucumber/messages/step_keyword_type.rb
 - lib/cucumber/messages/step_match_argument.rb
 - lib/cucumber/messages/step_match_arguments_list.rb
+- lib/cucumber/messages/suggestion.rb
 - lib/cucumber/messages/table_cell.rb
 - lib/cucumber/messages/table_row.rb
 - lib/cucumber/messages/tag.rb
@@ -216,5 +218,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: cucumber-messages-28.1.0
+summary: cucumber-messages-29.0.0
 test_files: []