cucumber-messages 27.2.0 → 31.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7df1a72a47d98cbc019ee52d52f81d32f6af01171359de6cdfbc70493ac9ea69
-  data.tar.gz: af04b94178bbb35139f79d8ea9cd5ced4fe9e791b8c4d282988c5a14f7bed20c
+  metadata.gz: c823c6a44a707a4f904397895606f4a62b511fe5ea4580a1d71f8960e9f99911
+  data.tar.gz: 9db59188fb60f2a4a4599e8f130190e917f223d8d66e88617ef7ed3dfad794e7
 SHA512:
-  metadata.gz: d7a247adaa729f4405dc675d304beed0cf9002a9b0437f0ef19946524169bccd5931ac4df1cdfd14f041bf15b59ecf0753d3fe304c0a17d71ad8a74af4eb4759
-  data.tar.gz: 81918251fa112bfc2819b709bb6905dc108a1af42249cf147e4cef211ff44037febbb3a9238ce04ae1bed1ef7a0adc6aa5b039fe9a48422ccfccaa0bb0076604
+  metadata.gz: 62f152ab3b73cc83acdae8552b91dc0035002bd02359d9271fcb56edbeabf18233d1a12d33f97103bb8d5b39afce9bb3d7ef835007cab96848f30c9e749e286c
+  data.tar.gz: 138a0f93f315fc45c7c6460d0317526f99416f0f44eee01365ef119e772bdff84329a43f020f28eadc312f58b2dc18a0e15fc5e61863618ad1aba598de52e8c6

data/VERSION

@@ -1 +1 @@
-27.2.0
+31.1.0

data/lib/cucumber/messages/attachment.rb

@@ -7,80 +7,93 @@ module Cucumber
     # Represents the Attachment message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # //// Attachments (parse errors, execution errors, screenshots, links...)
+    # Attachments (parse errors, execution errors, screenshots, links...)
     #
-    # *
-    #  An attachment represents any kind of data associated with a line in a
-    #  [Source](#io.cucumber.messages.Source) file. It can be used for:
+    # An attachment represents any kind of data associated with a line in a
+    # [Source](#io.cucumber.messages.Source) file. It can be used for:
     #
-    #  * Syntax errors during parse time
-    #  * Screenshots captured and attached during execution
-    #  * Logs captured and attached during execution
+    # * Syntax errors during parse time
+    # * Screenshots captured and attached during execution
+    # * Logs captured and attached during execution
     #
-    #  It is not to be used for runtime errors raised/thrown during execution. This
-    #  is captured in `TestResult`.
+    # It is not to be used for runtime errors raised/thrown during execution. This
+    # is captured in `TestResult`.
     ##
     class Attachment < Message
       ##
-      # *
-      #  The body of the attachment. If `contentEncoding` is `IDENTITY`, the attachment
-      #  is simply the string. If it's `BASE64`, the string should be Base64 decoded to
-      #  obtain the attachment.
+      # The body of the attachment. If `contentEncoding` is `IDENTITY`, the attachment
+      # is simply the string. If it's `BASE64`, the string should be Base64 decoded to
+      # obtain the attachment.
       ##
       attr_reader :body
 
       ##
-      # *
-      #  Whether to interpret `body` "as-is" (IDENTITY) or if it needs to be Base64-decoded (BASE64).
+      # Whether to interpret `body` "as-is" (IDENTITY) or if it needs to be Base64-decoded (BASE64).
       #
-      #  Content encoding is *not* determined by the media type, but rather by the type
-      #  of the object being attached:
+      # Content encoding is *not* determined by the media type, but rather by the type
+      # of the object being attached:
       #
-      #  - string: IDENTITY
-      #  - byte array: BASE64
-      #  - stream: BASE64
+      # - string: IDENTITY
+      # - byte array: BASE64
+      # - stream: BASE64
       ##
       attr_reader :content_encoding
 
       ##
-      # *
-      #  Suggested file name of the attachment. (Provided by the user as an argument to `attach`)
+      # Suggested file name of the attachment. (Provided by the user as an argument to `attach`)
       ##
       attr_reader :file_name
 
       ##
-      # *
-      #  The media type of the data. This can be any valid
-      #  [IANA Media Type](https://www.iana.org/assignments/media-types/media-types.xhtml)
-      #  as well as Cucumber-specific media types such as `text/x.cucumber.gherkin+plain`
-      #  and `text/x.cucumber.stacktrace+plain`
+      # The media type of the data. This can be any valid
+      # [IANA Media Type](https://www.iana.org/assignments/media-types/media-types.xhtml)
+      # as well as Cucumber-specific media types such as `text/x.cucumber.gherkin+plain`
+      # and `text/x.cucumber.stacktrace+plain`
       ##
       attr_reader :media_type
 
       attr_reader :source
 
+      ##
+      # The identifier of the test case attempt if the attachment was created during the execution of a test step
+      ##
       attr_reader :test_case_started_id
 
+      ##
+      # The identifier of the test step if the attachment was created during the execution of a test step
+      ##
       attr_reader :test_step_id
 
       ##
-      # *
-      #  A URL where the attachment can be retrieved. This field should not be set by Cucumber.
-      #  It should be set by a program that reads a message stream and does the following for
-      #  each Attachment message:
+      # A URL where the attachment can be retrieved. This field should not be set by Cucumber.
+      # It should be set by a program that reads a message stream and does the following for
+      # each Attachment message:
       #
-      #  - Writes the body (after base64 decoding if necessary) to a new file.
-      #  - Sets `body` and `contentEncoding` to `null`
-      #  - Writes out the new attachment message
+      # - Writes the body (after base64 decoding if necessary) to a new file.
+      # - Sets `body` and `contentEncoding` to `null`
+      # - Writes out the new attachment message
       #
-      #  This will result in a smaller message stream, which can improve performance and
-      #  reduce bandwidth of message consumers. It also makes it easier to process and download attachments
-      #  separately from reports.
+      # This will result in a smaller message stream, which can improve performance and
+      # reduce bandwidth of message consumers. It also makes it easier to process and download attachments
+      # separately from reports.
       ##
       attr_reader :url
 
+      ##
+      # Not used; implementers should instead populate `testRunHookStartedId` if an attachment was created during the execution of a test run hook
+      ##
       attr_reader :test_run_started_id
 
+      ##
+      # The identifier of the test run hook execution if the attachment was created during the execution of a test run hook
+      ##
+      attr_reader :test_run_hook_started_id
+
+      ##
+      # When the attachment was created
+      ##
+      attr_reader :timestamp
+
       def initialize(
         body: '',
         content_encoding: AttachmentContentEncoding::IDENTITY,
@@ -90,7 +103,9 @@ module Cucumber
         test_case_started_id: nil,
         test_step_id: nil,
         url: nil,
-        test_run_started_id: nil
+        test_run_started_id: nil,
+        test_run_hook_started_id: nil,
+        timestamp: nil
       )
         @body = body
         @content_encoding = content_encoding
@@ -101,6 +116,8 @@ module Cucumber
         @test_step_id = test_step_id
         @url = url
         @test_run_started_id = test_run_started_id
+        @test_run_hook_started_id = test_run_hook_started_id
+        @timestamp = timestamp
         super()
       end
 
@@ -123,7 +140,9 @@ module Cucumber
           test_case_started_id: hash[:testCaseStartedId],
           test_step_id: hash[:testStepId],
           url: hash[:url],
-          test_run_started_id: hash[:testRunStartedId]
+          test_run_started_id: hash[:testRunStartedId],
+          test_run_hook_started_id: hash[:testRunHookStartedId],
+          timestamp: Timestamp.from_h(hash[:timestamp])
         )
       end
     end

data/lib/cucumber/messages/comment.rb

@@ -7,8 +7,7 @@ module Cucumber
     # Represents the Comment message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # *
-    #  A comment in a Gherkin document
+    # A comment in a Gherkin document
     ##
     class Comment < Message
       ##

data/lib/cucumber/messages/duration.rb

@@ -8,16 +8,16 @@ module Cucumber
     ##
     #
     # The structure is pretty close of the Timestamp one. For clarity, a second type
-    #  of message is used.
+    # of message is used.
     ##
     class Duration < Message
       attr_reader :seconds
 
       ##
       # Non-negative fractions of a second at nanosecond resolution. Negative
-      #  second values with fractions must still have non-negative nanos values
-      #  that count forward in time. Must be from 0 to 999,999,999
-      #  inclusive.
+      # second values with fractions must still have non-negative nanos values
+      # that count forward in time. Must be from 0 to 999,999,999
+      # inclusive.
       ##
       attr_reader :nanos
 

data/lib/cucumber/messages/envelope.rb

@@ -6,14 +6,6 @@ module Cucumber
     ##
     # Represents the Envelope message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
-    #
-    # When removing a field, replace it with reserved, rather than deleting the line.
-    #  When adding a field, add it to the end and increment the number by one.
-    #  See https://developers.google.com/protocol-buffers/docs/proto#updating for details
-    #
-    # *
-    #  All the messages that are passed between different components/processes are Envelope
-    #  messages.
     ##
     class Envelope < Message
       attr_reader :attachment
@@ -30,6 +22,8 @@ module Cucumber
 
       attr_reader :pickle
 
+      attr_reader :suggestion
+
       attr_reader :source
 
       attr_reader :step_definition
@@ -62,6 +56,7 @@ module Cucumber
         parameter_type: nil,
         parse_error: nil,
         pickle: nil,
+        suggestion: nil,
         source: nil,
         step_definition: nil,
         test_case: nil,
@@ -82,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
@@ -115,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/feature_child.rb

@@ -7,8 +7,7 @@ module Cucumber
     # Represents the FeatureChild message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # *
-    #  A child node of a `Feature` node
+    # A child node of a `Feature` node
     ##
     class FeatureChild < Message
       attr_reader :rule

data/lib/cucumber/messages/gherkin_document.rb

@@ -7,19 +7,17 @@ module Cucumber
     # Represents the GherkinDocument message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # *
-    #  The [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) of a Gherkin document.
-    #  Cucumber implementations should *not* depend on `GherkinDocument` or any of its
-    #  children for execution - use [Pickle](#io.cucumber.messages.Pickle) instead.
+    # The [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) of a Gherkin document.
+    # Cucumber implementations should *not* depend on `GherkinDocument` or any of its
+    # children for execution - use [Pickle](#io.cucumber.messages.Pickle) instead.
     #
-    #  The only consumers of `GherkinDocument` should only be formatters that produce
-    #  "rich" output, resembling the original Gherkin document.
+    # The only consumers of `GherkinDocument` should only be formatters that produce
+    # "rich" output, resembling the original Gherkin document.
     ##
     class GherkinDocument < Message
       ##
-      # *
-      #  The [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier)
-      #  of the source, typically a file path relative to the root directory
+      # The [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier)
+      # of the source, typically a file path relative to the root directory
       ##
       attr_reader :uri
 

data/lib/cucumber/messages/git.rb

@@ -8,7 +8,7 @@ module Cucumber
     ##
     #
     # Information about Git, provided by the Build/CI server as environment
-    #  variables.
+    # variables.
     ##
     class Git < Message
       attr_reader :remote

data/lib/cucumber/messages/helpers/test_step_result_comparator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Messages
+    module Helpers
+      module TestStepResultComparator
+        def test_step_result_rankings
+          {
+            TestStepResultStatus::UNKNOWN => 0,
+            TestStepResultStatus::PASSED => 1,
+            TestStepResultStatus::SKIPPED => 2,
+            TestStepResultStatus::PENDING => 3,
+            TestStepResultStatus::UNDEFINED => 4,
+            TestStepResultStatus::AMBIGUOUS => 5,
+            TestStepResultStatus::FAILED => 6
+          }
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/messages/helpers/time_conversion.rb

@@ -7,23 +7,11 @@ module Cucumber
         NANOSECONDS_PER_SECOND = 1_000_000_000
 
         def time_to_timestamp(time)
-          { 'seconds' => time.to_i, 'nanos' => time.nsec }
+          Cucumber::Messages::Timestamp.new(seconds: time.to_i, nanos: time.nsec)
         end
 
         def timestamp_to_time(timestamp)
-          Time.at(timestamp['seconds'] + (timestamp['nanos'].to_f / NANOSECONDS_PER_SECOND))
-        end
-
-        def seconds_to_duration(seconds_float)
-          seconds, second_modulus = seconds_float.divmod(1)
-          nanos = second_modulus * NANOSECONDS_PER_SECOND
-          { 'seconds' => seconds, 'nanos' => nanos.to_i }
-        end
-
-        def duration_to_seconds(duration)
-          seconds_part = duration['seconds']
-          nanos_part = duration['nanos'].to_f / NANOSECONDS_PER_SECOND
-          seconds_part + nanos_part
+          Time.at(timestamp.seconds, timestamp.nanos, :nanosecond)
         end
       end
     end

data/lib/cucumber/messages/location.rb

@@ -7,8 +7,7 @@ module Cucumber
     # Represents the Location message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # *
-    #  Points to a line and a column in a text file
+    # Points to a line and a column in a text file
     ##
     class Location < Message
       attr_reader :line

data/lib/cucumber/messages/meta.rb

@@ -7,14 +7,12 @@ module Cucumber
     # Represents the Meta message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # *
-    #  This message contains meta information about the environment. Consumers can use
-    #  this for various purposes.
+    # This message contains meta information about the environment. Consumers can use
+    # this for various purposes.
     ##
     class Meta < Message
       ##
-      # *
-      #  The [SEMVER](https://semver.org/) version number of the protocol
+      # The [SEMVER](https://semver.org/) version number of the protocol
       ##
       attr_reader :protocol_version
 

data/lib/cucumber/messages/pickle.rb

@@ -7,24 +7,20 @@ module Cucumber
     # Represents the Pickle message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # //// Pickles
+    # A `Pickle` represents a template for a `TestCase`. It is typically derived
+    # from another format, such as [GherkinDocument](#io.cucumber.messages.GherkinDocument).
+    # In the future a `Pickle` may be derived from other formats such as Markdown or
+    # Excel files.
     #
-    # *
-    #  A `Pickle` represents a template for a `TestCase`. It is typically derived
-    #  from another format, such as [GherkinDocument](#io.cucumber.messages.GherkinDocument).
-    #  In the future a `Pickle` may be derived from other formats such as Markdown or
-    #  Excel files.
+    # By making `Pickle` the main data structure Cucumber uses for execution, the
+    # implementation of Cucumber itself becomes simpler, as it doesn't have to deal
+    # with the complex structure of a [GherkinDocument](#io.cucumber.messages.GherkinDocument).
     #
-    #  By making `Pickle` the main data structure Cucumber uses for execution, the
-    #  implementation of Cucumber itself becomes simpler, as it doesn't have to deal
-    #  with the complex structure of a [GherkinDocument](#io.cucumber.messages.GherkinDocument).
-    #
-    #  Each `PickleStep` of a `Pickle` is matched with a `StepDefinition` to create a `TestCase`
+    # Each `PickleStep` of a `Pickle` is matched with a `StepDefinition` to create a `TestCase`
     ##
     class Pickle < Message
       ##
-      # *
-      #  A unique id for the pickle
+      # A unique id for the pickle
       ##
       attr_reader :id
 
@@ -33,6 +29,11 @@ module Cucumber
       ##
       attr_reader :uri
 
+      ##
+      # The location of this pickle in source file. A pickle constructed from `Examples` will point to the example row.
+      ##
+      attr_reader :location
+
       ##
       # The name of the pickle
       ##
@@ -49,23 +50,22 @@ module Cucumber
       attr_reader :steps
 
       ##
-      # *
-      #  One or more tags. If this pickle is constructed from a Gherkin document,
-      #  It includes inherited tags from the `Feature` as well.
+      # One or more tags. If this pickle is constructed from a Gherkin document,
+      # It includes inherited tags from the `Feature` as well.
       ##
       attr_reader :tags
 
       ##
-      # *
-      #  Points to the AST node locations of the pickle. The last one represents the unique
-      #  id of the pickle. A pickle constructed from `Examples` will have the first
-      #  id originating from the `Scenario` AST node, and the second from the `TableRow` AST node.
+      # Points to the AST node locations of the pickle. The last one represents the unique
+      # id of the pickle. A pickle constructed from `Examples` will have the first
+      # id originating from the `Scenario` AST node, and the second from the `TableRow` AST node.
       ##
       attr_reader :ast_node_ids
 
       def initialize(
         id: '',
         uri: '',
+        location: nil,
         name: '',
         language: '',
         steps: [],
@@ -74,6 +74,7 @@ module Cucumber
       )
         @id = id
         @uri = uri
+        @location = location
         @name = name
         @language = language
         @steps = steps
@@ -95,6 +96,7 @@ module Cucumber
         new(
           id: hash[:id],
           uri: hash[:uri],
+          location: Location.from_h(hash[:location]),
           name: hash[:name],
           language: hash[:language],
           steps: hash[:steps]&.map { |item| PickleStep.from_h(item) },

data/lib/cucumber/messages/pickle_step.rb

@@ -7,15 +7,14 @@ module Cucumber
     # Represents the PickleStep message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # *
-    #  An executable step
+    # An executable step
     ##
     class PickleStep < Message
       attr_reader :argument
 
       ##
       # References the IDs of the source of the step. For Gherkin, this can be
-      #  the ID of a Step, and possibly also the ID of a TableRow
+      # the ID of a Step, and possibly also the ID of a TableRow
       ##
       attr_reader :ast_node_ids
 

data/lib/cucumber/messages/pickle_tag.rb

@@ -7,8 +7,7 @@ module Cucumber
     # Represents the PickleTag message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # *
-    #  A tag
+    # A tag
     ##
     class PickleTag < Message
       attr_reader :name

data/lib/cucumber/messages/rule_child.rb

@@ -7,8 +7,7 @@ module Cucumber
     # Represents the RuleChild message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # *
-    #  A child node of a `Rule` node
+    # A child node of a `Rule` node
     ##
     class RuleChild < Message
       attr_reader :background

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/source.rb

@@ -7,16 +7,12 @@ module Cucumber
     # Represents the Source message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # //// Source
-    #
-    # *
-    #  A source file, typically a Gherkin document or Java/Ruby/JavaScript source code
+    # A source file, typically a Gherkin document or Java/Ruby/JavaScript source code
     ##
     class Source < Message
       ##
-      # *
-      #  The [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier)
-      #  of the source, typically a file path relative to the root directory
+      # The [URI](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier)
+      # of the source, typically a file path relative to the root directory
       ##
       attr_reader :uri
 
@@ -27,7 +23,7 @@ module Cucumber
 
       ##
       # The media type of the file. Can be used to specify custom types, such as
-      #  text/x.cucumber.gherkin+plain
+      # text/x.cucumber.gherkin+plain
       ##
       attr_reader :media_type
 

data/lib/cucumber/messages/source_reference.rb

@@ -7,9 +7,8 @@ module Cucumber
     # Represents the SourceReference message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # *
-    #  Points to a [Source](#io.cucumber.messages.Source) identified by `uri` and a
-    #  [Location](#io.cucumber.messages.Location) within that file.
+    # Points to a [Source](#io.cucumber.messages.Source) identified by `uri` and a
+    # [Location](#io.cucumber.messages.Location) within that file.
     ##
     class SourceReference < Message
       attr_reader :uri

data/lib/cucumber/messages/step_match_argument.rb

@@ -7,19 +7,17 @@ module Cucumber
     # Represents the StepMatchArgument message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # *
-    #  Represents a single argument extracted from a step match and passed to a step definition.
-    #  This is used for the following purposes:
-    #  - Construct an argument to pass to a step definition (possibly through a parameter type transform)
-    #  - Highlight the matched parameter in rich formatters such as the HTML formatter
+    # Represents a single argument extracted from a step match and passed to a step definition.
+    # This is used for the following purposes:
+    # - Construct an argument to pass to a step definition (possibly through a parameter type transform)
+    # - Highlight the matched parameter in rich formatters such as the HTML formatter
     #
-    #  This message closely matches the `Argument` class in the `cucumber-expressions` library.
+    # This message closely matches the `Argument` class in the `cucumber-expressions` library.
     ##
     class StepMatchArgument < Message
       ##
-      # *
-      #  Represents the outermost capture group of an argument. This message closely matches the
-      #  `Group` class in the `cucumber-expressions` library.
+      # Represents the outermost capture group of an argument. This message closely matches the
+      # `Group` class in the `cucumber-expressions` library.
       ##
       attr_reader :group
 

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/tag.rb

@@ -7,8 +7,7 @@ module Cucumber
     # Represents the Tag message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # *
-    #  A tag
+    # A tag
     ##
     class Tag < Message
       ##

data/lib/cucumber/messages/test_case.rb

@@ -7,10 +7,7 @@ module Cucumber
     # Represents the TestCase message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
     ##
     #
-    # //// TestCases
-    #
-    # *
-    #  A `TestCase` contains a sequence of `TestStep`s.
+    # A `TestCase` contains a sequence of `TestStep`s.
     ##
     class TestCase < Message
       attr_reader :id

data/lib/cucumber/messages/test_case_started.rb

@@ -9,16 +9,14 @@ module Cucumber
     ##
     class TestCaseStarted < Message
       ##
-      # *
-      #  The first attempt should have value 0, and for each retry the value
-      #  should increase by 1.
+      # The first attempt should have value 0, and for each retry the value
+      # should increase by 1.
       ##
       attr_reader :attempt
 
       ##
-      # *
-      #  Because a `TestCase` can be run multiple times (in case of a retry),
-      #  we use this field to group messages relating to the same attempt.
+      # Because a `TestCase` can be run multiple times (in case of a retry),
+      # we use this field to group messages relating to the same attempt.
       ##
       attr_reader :id
 

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,9 +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
       ##
@@ -25,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
 

data/lib/cucumber/messages/timestamp.rb

@@ -10,16 +10,16 @@ module Cucumber
     class Timestamp < Message
       ##
       # Represents seconds of UTC time since Unix epoch
-      #  1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
-      #  9999-12-31T23:59:59Z inclusive.
+      # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+      # 9999-12-31T23:59:59Z inclusive.
       ##
       attr_reader :seconds
 
       ##
       # Non-negative fractions of a second at nanosecond resolution. Negative
-      #  second values with fractions must still have non-negative nanos values
-      #  that count forward in time. Must be from 0 to 999,999,999
-      #  inclusive.
+      # second values with fractions must still have non-negative nanos values
+      # that count forward in time. Must be from 0 to 999,999,999
+      # inclusive.
       ##
       attr_reader :nanos
 

data/lib/cucumber/messages.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require 'cucumber/messages/helpers/id_generator'
 require 'cucumber/messages/helpers/ndjson_to_message_enumerator'
+require 'cucumber/messages/helpers/test_step_result_comparator'
 require 'cucumber/messages/helpers/time_conversion'
-require 'cucumber/messages/helpers/id_generator'
+
 require 'cucumber/messages/message'
 
 Dir["#{File.dirname(__FILE__)}/messages/*.rb"].each { |file| require file }

metadata

@@ -1,29 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-messages
 version: !ruby/object:Gem::Version
-  version: 27.2.0
+  version: 31.1.0
 platform: ruby
 authors:
 - Aslak Hellesøy
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: cucumber-compatibility-kit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '15.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '15.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +43,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.71.0
+        version: 1.80.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.71.0
+        version: 1.80.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: 1.24.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: 1.24.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +85,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.7.0
 description: JSON schema-based messages for Cucumber's inter-process communication
 email: cukes@googlegroups.com
 executables: []
@@ -138,6 +123,7 @@ files:
 - lib/cucumber/messages/helpers/id_generator/incrementing.rb
 - lib/cucumber/messages/helpers/id_generator/uuid.rb
 - lib/cucumber/messages/helpers/ndjson_to_message_enumerator.rb
+- lib/cucumber/messages/helpers/test_step_result_comparator.rb
 - lib/cucumber/messages/helpers/time_conversion.rb
 - lib/cucumber/messages/hook.rb
 - lib/cucumber/messages/hook_type.rb
@@ -161,6 +147,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 +158,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
@@ -197,7 +185,6 @@ metadata:
   documentation_uri: https://www.rubydoc.info/github/cucumber/messages
   mailing_list_uri: https://groups.google.com/forum/#!forum/cukes
   source_code_uri: https://github.com/cucumber/messages
-post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -206,15 +193,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.3
+      version: 3.2.8
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: cucumber-messages-27.2.0
+summary: cucumber-messages-31.1.0
 test_files: []