cucumber-messages 31.2.0 → 32.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a727cb08783054006813b5029b01f4fdc06039fc7f51df419744f4898846d42
-  data.tar.gz: 8261dd50fcc6d98586384eb00d494670079d2d67b6bbfcb4f37b62019f45a28e
+  metadata.gz: 22948e1804c8a58b18d627069a7059fd5159b216f5ab060566b6d64ddb8a0ef8
+  data.tar.gz: 2d835ad4322075786327c0de5fe4abcee3b6844f1c78756bfdbb65ae0b7177a8
 SHA512:
-  metadata.gz: 877738471c41bc0b33445550144e43d3f9bdb1181886bbfc20596b3621e9b3ef747e7bce6ebe99eeff64903fb8d41fda2e444728ab10cbad8cdcd9d49ac91265
-  data.tar.gz: b41c3044eee1eb0af61c82414ff83104f7171051ff4384049a8c1f0292cfb6e203690e153980f062cbeb02b366e1a3a499b41a39b72806c431579c8f2e297925
+  metadata.gz: ffde39e6ff9b7ab2c879fa50fda045747002f0eef37c99b7fff4cfa53c431792515d63c6df4a36e34b270188423aa8c5e163278039117c1516eda042782c3504
+  data.tar.gz: b3c96c1402ea842434b24b0661689e69c71b9e1e5f58e3584dd749215aee0b0d01883b35f07b6d0ff213356a947a10175e3f63702e15eb3de868540e6702ee8c

data/VERSION

@@ -1 +1 @@
-31.2.0
+32.0.0

data/lib/cucumber/messages/attachment.rb

@@ -76,6 +76,8 @@ module Cucumber
       # 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.
+      #
+      # Deprecated; use ExternalAttachment instead.
       ##
       attr_reader :url
 

data/lib/cucumber/messages/envelope.rb

@@ -10,6 +10,8 @@ module Cucumber
     class Envelope < Message
       attr_reader :attachment
 
+      attr_reader :external_attachment
+
       attr_reader :gherkin_document
 
       attr_reader :hook
@@ -50,6 +52,7 @@ module Cucumber
 
       def initialize(
         attachment: nil,
+        external_attachment: nil,
         gherkin_document: nil,
         hook: nil,
         meta: nil,
@@ -71,6 +74,7 @@ module Cucumber
         undefined_parameter_type: nil
       )
         @attachment = attachment
+        @external_attachment = external_attachment
         @gherkin_document = gherkin_document
         @hook = hook
         @meta = meta
@@ -105,6 +109,7 @@ module Cucumber
 
         new(
           attachment: Attachment.from_h(hash[:attachment]),
+          external_attachment: ExternalAttachment.from_h(hash[:externalAttachment]),
           gherkin_document: GherkinDocument.from_h(hash[:gherkinDocument]),
           hook: Hook.from_h(hash[:hook]),
           meta: Meta.from_h(hash[:meta]),

data/lib/cucumber/messages/external_attachment.rb

@@ -0,0 +1,91 @@
+# 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 ExternalAttachment message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # Represents an attachment that is stored externally rather than embedded in the message stream.
+    #
+    # This message type is used for large attachments (e.g., video files) that are already
+    # on the filesystem and should not be loaded into memory. Instead of embedding the content,
+    # only a URL reference is stored.
+    #
+    # A formatter or other consumer of messages may replace an Attachment with an ExternalAttachment if it makes sense to do so.
+    ##
+    class ExternalAttachment < Message
+      ##
+      # A URL where the attachment can be retrieved. This could be a file:// URL for
+      # local filesystem paths, or an http(s):// URL for remote resources.
+      ##
+      attr_reader :url
+
+      ##
+      # 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
+
+      ##
+      # The identifier of the test step if the attachment was created during the execution of a test step
+      ##
+      attr_reader :test_step_id
+
+      ##
+      # 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 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(
+        url: '',
+        media_type: '',
+        test_step_id: nil,
+        test_case_started_id: nil,
+        test_run_hook_started_id: nil,
+        timestamp: nil
+      )
+        @url = url
+        @media_type = media_type
+        @test_step_id = test_step_id
+        @test_case_started_id = test_case_started_id
+        @test_run_hook_started_id = test_run_hook_started_id
+        @timestamp = timestamp
+        super()
+      end
+
+      ##
+      # Returns a new ExternalAttachment from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::ExternalAttachment.from_h(some_hash) # => #<Cucumber::Messages::ExternalAttachment:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          url: hash[:url],
+          media_type: hash[:mediaType],
+          test_step_id: hash[:testStepId],
+          test_case_started_id: hash[:testCaseStartedId],
+          test_run_hook_started_id: hash[:testRunHookStartedId],
+          timestamp: Timestamp.from_h(hash[:timestamp])
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/group.rb

@@ -8,6 +8,10 @@ module Cucumber
     ##
     ##
     class Group < Message
+      ##
+      # The nested capture groups of an argument.
+      # Absent if the group has no nested capture groups.
+      ##
       attr_reader :children
 
       attr_reader :start
@@ -15,7 +19,7 @@ module Cucumber
       attr_reader :value
 
       def initialize(
-        children: [],
+        children: nil,
         start: nil,
         value: nil
       )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-messages
 version: !ruby/object:Gem::Version
-  version: 31.2.0
+  version: 32.0.0
 platform: ruby
 authors:
 - Aslak Hellesøy
@@ -114,6 +114,7 @@ files:
 - lib/cucumber/messages/envelope.rb
 - lib/cucumber/messages/examples.rb
 - lib/cucumber/messages/exception.rb
+- lib/cucumber/messages/external_attachment.rb
 - lib/cucumber/messages/feature.rb
 - lib/cucumber/messages/feature_child.rb
 - lib/cucumber/messages/gherkin_document.rb
@@ -202,5 +203,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: cucumber-messages-31.2.0
+summary: cucumber-messages-32.0.0
 test_files: []