cucumber-messages 22.0.0 → 27.2.0

data/lib/cucumber/messages/examples.rb

@@ -0,0 +1,74 @@
+# 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 Examples message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class Examples < Message
+      ##
+      # The location of the `Examples` keyword
+      ##
+      attr_reader :location
+
+      attr_reader :tags
+
+      attr_reader :keyword
+
+      attr_reader :name
+
+      attr_reader :description
+
+      attr_reader :table_header
+
+      attr_reader :table_body
+
+      attr_reader :id
+
+      def initialize(
+        location: Location.new,
+        tags: [],
+        keyword: '',
+        name: '',
+        description: '',
+        table_header: nil,
+        table_body: [],
+        id: ''
+      )
+        @location = location
+        @tags = tags
+        @keyword = keyword
+        @name = name
+        @description = description
+        @table_header = table_header
+        @table_body = table_body
+        @id = id
+        super()
+      end
+
+      ##
+      # Returns a new Examples from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Examples.from_h(some_hash) # => #<Cucumber::Messages::Examples:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          location: Location.from_h(hash[:location]),
+          tags: hash[:tags]&.map { |item| Tag.from_h(item) },
+          keyword: hash[:keyword],
+          name: hash[:name],
+          description: hash[:description],
+          table_header: TableRow.from_h(hash[:tableHeader]),
+          table_body: hash[:tableBody]&.map { |item| TableRow.from_h(item) },
+          id: hash[:id]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/exception.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 Exception message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # A simplified representation of an exception
+    ##
+    class Exception < Message
+      ##
+      # The type of the exception that caused this result. E.g. "Error" or "org.opentest4j.AssertionFailedError"
+      ##
+      attr_reader :type
+
+      ##
+      # The message of exception that caused this result. E.g. expected: "a" but was: "b"
+      ##
+      attr_reader :message
+
+      ##
+      # The stringified stack trace of the exception that caused this result
+      ##
+      attr_reader :stack_trace
+
+      def initialize(
+        type: '',
+        message: nil,
+        stack_trace: nil
+      )
+        @type = type
+        @message = message
+        @stack_trace = stack_trace
+        super()
+      end
+
+      ##
+      # Returns a new Exception from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Exception.from_h(some_hash) # => #<Cucumber::Messages::Exception:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          type: hash[:type],
+          message: hash[:message],
+          stack_trace: hash[:stackTrace]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/feature.rb

@@ -0,0 +1,87 @@
+# 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 Feature message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class Feature < Message
+      ##
+      # The location of the `Feature` keyword
+      ##
+      attr_reader :location
+
+      ##
+      # All the tags placed above the `Feature` keyword
+      ##
+      attr_reader :tags
+
+      ##
+      # The [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code of the Gherkin document
+      ##
+      attr_reader :language
+
+      ##
+      # The text of the `Feature` keyword (in the language specified by `language`)
+      ##
+      attr_reader :keyword
+
+      ##
+      # The name of the feature (the text following the `keyword`)
+      ##
+      attr_reader :name
+
+      ##
+      # The line(s) underneath the line with the `keyword` that are used as description
+      ##
+      attr_reader :description
+
+      ##
+      # Zero or more children
+      ##
+      attr_reader :children
+
+      def initialize(
+        location: Location.new,
+        tags: [],
+        language: '',
+        keyword: '',
+        name: '',
+        description: '',
+        children: []
+      )
+        @location = location
+        @tags = tags
+        @language = language
+        @keyword = keyword
+        @name = name
+        @description = description
+        @children = children
+        super()
+      end
+
+      ##
+      # Returns a new Feature from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Feature.from_h(some_hash) # => #<Cucumber::Messages::Feature:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          location: Location.from_h(hash[:location]),
+          tags: hash[:tags]&.map { |item| Tag.from_h(item) },
+          language: hash[:language],
+          keyword: hash[:keyword],
+          name: hash[:name],
+          description: hash[:description],
+          children: hash[:children]&.map { |item| FeatureChild.from_h(item) }
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/feature_child.rb

@@ -0,0 +1,49 @@
+# 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 FeatureChild message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # *
+    #  A child node of a `Feature` node
+    ##
+    class FeatureChild < Message
+      attr_reader :rule
+
+      attr_reader :background
+
+      attr_reader :scenario
+
+      def initialize(
+        rule: nil,
+        background: nil,
+        scenario: nil
+      )
+        @rule = rule
+        @background = background
+        @scenario = scenario
+        super()
+      end
+
+      ##
+      # Returns a new FeatureChild from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::FeatureChild.from_h(some_hash) # => #<Cucumber::Messages::FeatureChild:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          rule: Rule.from_h(hash[:rule]),
+          background: Background.from_h(hash[:background]),
+          scenario: Scenario.from_h(hash[:scenario])
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/gherkin_document.rb

@@ -0,0 +1,62 @@
+# 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 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 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
+      ##
+      attr_reader :uri
+
+      attr_reader :feature
+
+      ##
+      # All the comments in the Gherkin document
+      ##
+      attr_reader :comments
+
+      def initialize(
+        uri: nil,
+        feature: nil,
+        comments: []
+      )
+        @uri = uri
+        @feature = feature
+        @comments = comments
+        super()
+      end
+
+      ##
+      # Returns a new GherkinDocument from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::GherkinDocument.from_h(some_hash) # => #<Cucumber::Messages::GherkinDocument:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          uri: hash[:uri],
+          feature: Feature.from_h(hash[:feature]),
+          comments: hash[:comments]&.map { |item| Comment.from_h(item) }
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/git.rb

@@ -0,0 +1,54 @@
+# 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 Git message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # Information about Git, provided by the Build/CI server as environment
+    #  variables.
+    ##
+    class Git < Message
+      attr_reader :remote
+
+      attr_reader :revision
+
+      attr_reader :branch
+
+      attr_reader :tag
+
+      def initialize(
+        remote: '',
+        revision: '',
+        branch: nil,
+        tag: nil
+      )
+        @remote = remote
+        @revision = revision
+        @branch = branch
+        @tag = tag
+        super()
+      end
+
+      ##
+      # Returns a new Git from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Git.from_h(some_hash) # => #<Cucumber::Messages::Git:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          remote: hash[:remote],
+          revision: hash[:revision],
+          branch: hash[:branch],
+          tag: hash[:tag]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/group.rb

@@ -0,0 +1,46 @@
+# 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 Group message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class Group < Message
+      attr_reader :children
+
+      attr_reader :start
+
+      attr_reader :value
+
+      def initialize(
+        children: [],
+        start: nil,
+        value: nil
+      )
+        @children = children
+        @start = start
+        @value = value
+        super()
+      end
+
+      ##
+      # Returns a new Group from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Group.from_h(some_hash) # => #<Cucumber::Messages::Group:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          children: hash[:children]&.map { |item| Group.from_h(item) },
+          start: hash[:start],
+          value: hash[:value]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/helpers/id_generator/incrementing.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Messages
+    module Helpers
+      module IdGenerator
+        class Incrementing
+          def initialize
+            @index = -1
+          end
+
+          def new_id
+            @index += 1
+            @index.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/messages/helpers/id_generator/uuid.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Cucumber
+  module Messages
+    module Helpers
+      module IdGenerator
+        class UUID
+          def new_id
+            SecureRandom.uuid
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'id_generator/uuid'
+require_relative 'id_generator/incrementing'

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'cucumber/messages'
+
+module Cucumber
+  module Messages
+    module Helpers
+      class NdjsonToMessageEnumerator < Enumerator
+        def initialize(io)
+          super() do |yielder|
+            io.each_line do |line|
+              next if line.strip.empty?
+
+              message = extract_message(line)
+              yielder.yield(message)
+            end
+          end
+        end
+
+        private
+
+        def extract_message(json_line)
+          Envelope.from_json(json_line)
+        rescue StandardError
+          raise "Not JSON: #{json_line.strip}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Cucumber
+  module Messages
+    module Helpers
+      module TimeConversion
+        NANOSECONDS_PER_SECOND = 1_000_000_000
+
+        def time_to_timestamp(time)
+          { '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
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/messages/hook.rb

@@ -0,0 +1,56 @@
+# 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 Hook message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class Hook < Message
+      attr_reader :id
+
+      attr_reader :name
+
+      attr_reader :source_reference
+
+      attr_reader :tag_expression
+
+      attr_reader :type
+
+      def initialize(
+        id: '',
+        name: nil,
+        source_reference: SourceReference.new,
+        tag_expression: nil,
+        type: nil
+      )
+        @id = id
+        @name = name
+        @source_reference = source_reference
+        @tag_expression = tag_expression
+        @type = type
+        super()
+      end
+
+      ##
+      # Returns a new Hook from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Hook.from_h(some_hash) # => #<Cucumber::Messages::Hook:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          id: hash[:id],
+          name: hash[:name],
+          source_reference: SourceReference.from_h(hash[:sourceReference]),
+          tag_expression: hash[:tagExpression],
+          type: hash[:type]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/hook_type.rb

@@ -0,0 +1,15 @@
+# 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
+    class HookType
+      BEFORE_TEST_RUN = 'BEFORE_TEST_RUN'
+      AFTER_TEST_RUN = 'AFTER_TEST_RUN'
+      BEFORE_TEST_CASE = 'BEFORE_TEST_CASE'
+      AFTER_TEST_CASE = 'AFTER_TEST_CASE'
+      BEFORE_TEST_STEP = 'BEFORE_TEST_STEP'
+      AFTER_TEST_STEP = 'AFTER_TEST_STEP'
+    end
+  end
+end

data/lib/cucumber/messages/java_method.rb

@@ -0,0 +1,46 @@
+# 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 JavaMethod message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class JavaMethod < Message
+      attr_reader :class_name
+
+      attr_reader :method_name
+
+      attr_reader :method_parameter_types
+
+      def initialize(
+        class_name: '',
+        method_name: '',
+        method_parameter_types: []
+      )
+        @class_name = class_name
+        @method_name = method_name
+        @method_parameter_types = method_parameter_types
+        super()
+      end
+
+      ##
+      # Returns a new JavaMethod from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::JavaMethod.from_h(some_hash) # => #<Cucumber::Messages::JavaMethod:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          class_name: hash[:className],
+          method_name: hash[:methodName],
+          method_parameter_types: hash[:methodParameterTypes]
+        )
+      end
+    end
+  end
+end