cucumber-messages 24.1.0 → 25.0.0

data/lib/cucumber/messages/pickle_tag.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the PickleTag message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # *
+    #  A tag
+    ##
+    class PickleTag < Message
+      attr_reader :name
+
+      ##
+      # Points to the AST node this was created from
+      ##
+      attr_reader :ast_node_id
+
+      def initialize(
+        name: '',
+        ast_node_id: ''
+      )
+        @name = name
+        @ast_node_id = ast_node_id
+        super()
+      end
+
+      ##
+      # Returns a new PickleTag from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::PickleTag.from_h(some_hash) # => #<Cucumber::Messages::PickleTag:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          name: hash[:name],
+          ast_node_id: hash[:astNodeId]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/product.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the Product message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # Used to describe various properties of Meta
+    ##
+    class Product < Message
+      ##
+      # The product name
+      ##
+      attr_reader :name
+
+      ##
+      # The product version
+      ##
+      attr_reader :version
+
+      def initialize(
+        name: '',
+        version: nil
+      )
+        @name = name
+        @version = version
+        super()
+      end
+
+      ##
+      # Returns a new Product from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Product.from_h(some_hash) # => #<Cucumber::Messages::Product:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          name: hash[:name],
+          version: hash[:version]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/rule.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the Rule message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class Rule < Message
+      ##
+      # The location of the `Rule` keyword
+      ##
+      attr_reader :location
+
+      ##
+      # All the tags placed above the `Rule` keyword
+      ##
+      attr_reader :tags
+
+      attr_reader :keyword
+
+      attr_reader :name
+
+      attr_reader :description
+
+      attr_reader :children
+
+      attr_reader :id
+
+      def initialize(
+        location: Location.new,
+        tags: [],
+        keyword: '',
+        name: '',
+        description: '',
+        children: [],
+        id: ''
+      )
+        @location = location
+        @tags = tags
+        @keyword = keyword
+        @name = name
+        @description = description
+        @children = children
+        @id = id
+        super()
+      end
+
+      ##
+      # Returns a new Rule from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Rule.from_h(some_hash) # => #<Cucumber::Messages::Rule: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],
+          children: hash[:children]&.map { |item| RuleChild.from_h(item) },
+          id: hash[:id]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/rule_child.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the RuleChild message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # *
+    #  A child node of a `Rule` node
+    ##
+    class RuleChild < Message
+      attr_reader :background
+
+      attr_reader :scenario
+
+      def initialize(
+        background: nil,
+        scenario: nil
+      )
+        @background = background
+        @scenario = scenario
+        super()
+      end
+
+      ##
+      # Returns a new RuleChild from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::RuleChild.from_h(some_hash) # => #<Cucumber::Messages::RuleChild:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          background: Background.from_h(hash[:background]),
+          scenario: Scenario.from_h(hash[:scenario])
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/scenario.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the Scenario message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class Scenario < Message
+      ##
+      # The location of the `Scenario` keyword
+      ##
+      attr_reader :location
+
+      attr_reader :tags
+
+      attr_reader :keyword
+
+      attr_reader :name
+
+      attr_reader :description
+
+      attr_reader :steps
+
+      attr_reader :examples
+
+      attr_reader :id
+
+      def initialize(
+        location: Location.new,
+        tags: [],
+        keyword: '',
+        name: '',
+        description: '',
+        steps: [],
+        examples: [],
+        id: ''
+      )
+        @location = location
+        @tags = tags
+        @keyword = keyword
+        @name = name
+        @description = description
+        @steps = steps
+        @examples = examples
+        @id = id
+        super()
+      end
+
+      ##
+      # Returns a new Scenario from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Scenario.from_h(some_hash) # => #<Cucumber::Messages::Scenario: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],
+          steps: hash[:steps]&.map { |item| Step.from_h(item) },
+          examples: hash[:examples]&.map { |item| Examples.from_h(item) },
+          id: hash[:id]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/source.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # 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
+    ##
+    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
+      ##
+      attr_reader :uri
+
+      ##
+      # The contents of the file
+      ##
+      attr_reader :data
+
+      ##
+      # The media type of the file. Can be used to specify custom types, such as
+      #  text/x.cucumber.gherkin+plain
+      ##
+      attr_reader :media_type
+
+      def initialize(
+        uri: '',
+        data: '',
+        media_type: SourceMediaType::TEXT_X_CUCUMBER_GHERKIN_PLAIN
+      )
+        @uri = uri
+        @data = data
+        @media_type = media_type
+        super()
+      end
+
+      ##
+      # Returns a new Source from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Source.from_h(some_hash) # => #<Cucumber::Messages::Source:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          uri: hash[:uri],
+          data: hash[:data],
+          media_type: hash[:mediaType]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/source_media_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    class SourceMediaType
+      TEXT_X_CUCUMBER_GHERKIN_PLAIN = 'text/x.cucumber.gherkin+plain'
+      TEXT_X_CUCUMBER_GHERKIN_MARKDOWN = 'text/x.cucumber.gherkin+markdown'
+    end
+  end
+end

data/lib/cucumber/messages/source_reference.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # 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.
+    ##
+    class SourceReference < Message
+      attr_reader :uri
+
+      attr_reader :java_method
+
+      attr_reader :java_stack_trace_element
+
+      attr_reader :location
+
+      def initialize(
+        uri: nil,
+        java_method: nil,
+        java_stack_trace_element: nil,
+        location: nil
+      )
+        @uri = uri
+        @java_method = java_method
+        @java_stack_trace_element = java_stack_trace_element
+        @location = location
+        super()
+      end
+
+      ##
+      # Returns a new SourceReference from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::SourceReference.from_h(some_hash) # => #<Cucumber::Messages::SourceReference:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          uri: hash[:uri],
+          java_method: JavaMethod.from_h(hash[:javaMethod]),
+          java_stack_trace_element: JavaStackTraceElement.from_h(hash[:javaStackTraceElement]),
+          location: Location.from_h(hash[:location])
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/step.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the Step message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    #
+    # A step
+    ##
+    class Step < Message
+      ##
+      # The location of the steps' `keyword`
+      ##
+      attr_reader :location
+
+      ##
+      # The actual keyword as it appeared in the source.
+      ##
+      attr_reader :keyword
+
+      ##
+      # The test phase signalled by the keyword: Context definition (Given), Action performance (When), Outcome assertion (Then). Other keywords signal Continuation (And and But) from a prior keyword. Please note that all translations which a dialect maps to multiple keywords (`*` is in this category for all dialects), map to 'Unknown'.
+      ##
+      attr_reader :keyword_type
+
+      attr_reader :text
+
+      attr_reader :doc_string
+
+      attr_reader :data_table
+
+      ##
+      # Unique ID to be able to reference the Step from PickleStep
+      ##
+      attr_reader :id
+
+      def initialize(
+        location: Location.new,
+        keyword: '',
+        keyword_type: nil,
+        text: '',
+        doc_string: nil,
+        data_table: nil,
+        id: ''
+      )
+        @location = location
+        @keyword = keyword
+        @keyword_type = keyword_type
+        @text = text
+        @doc_string = doc_string
+        @data_table = data_table
+        @id = id
+        super()
+      end
+
+      ##
+      # Returns a new Step from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::Step.from_h(some_hash) # => #<Cucumber::Messages::Step:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          location: Location.from_h(hash[:location]),
+          keyword: hash[:keyword],
+          keyword_type: hash[:keywordType],
+          text: hash[:text],
+          doc_string: DocString.from_h(hash[:docString]),
+          data_table: DataTable.from_h(hash[:dataTable]),
+          id: hash[:id]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/step_definition.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the StepDefinition message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class StepDefinition < Message
+      attr_reader :id
+
+      attr_reader :pattern
+
+      attr_reader :source_reference
+
+      def initialize(
+        id: '',
+        pattern: StepDefinitionPattern.new,
+        source_reference: SourceReference.new
+      )
+        @id = id
+        @pattern = pattern
+        @source_reference = source_reference
+        super()
+      end
+
+      ##
+      # Returns a new StepDefinition from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::StepDefinition.from_h(some_hash) # => #<Cucumber::Messages::StepDefinition:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          id: hash[:id],
+          pattern: StepDefinitionPattern.from_h(hash[:pattern]),
+          source_reference: SourceReference.from_h(hash[:sourceReference])
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/step_definition_pattern.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # Represents the StepDefinitionPattern message in Cucumber's {message protocol}[https://github.com/cucumber/messages].
+    ##
+    ##
+    class StepDefinitionPattern < Message
+      attr_reader :source
+
+      attr_reader :type
+
+      def initialize(
+        source: '',
+        type: StepDefinitionPatternType::CUCUMBER_EXPRESSION
+      )
+        @source = source
+        @type = type
+        super()
+      end
+
+      ##
+      # Returns a new StepDefinitionPattern from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::StepDefinitionPattern.from_h(some_hash) # => #<Cucumber::Messages::StepDefinitionPattern:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          source: hash[:source],
+          type: hash[:type]
+        )
+      end
+    end
+  end
+end

data/lib/cucumber/messages/step_definition_pattern_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    class StepDefinitionPatternType
+      CUCUMBER_EXPRESSION = 'CUCUMBER_EXPRESSION'
+      REGULAR_EXPRESSION = 'REGULAR_EXPRESSION'
+    end
+  end
+end

data/lib/cucumber/messages/step_keyword_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    class StepKeywordType
+      UNKNOWN = 'Unknown'
+      CONTEXT = 'Context'
+      ACTION = 'Action'
+      OUTCOME = 'Outcome'
+      CONJUNCTION = 'Conjunction'
+    end
+  end
+end

data/lib/cucumber/messages/step_match_argument.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# The code was auto-generated by {this script}[https://github.com/cucumber/messages/blob/main/jsonschema/scripts/codegen.rb]
+module Cucumber
+  module Messages
+    ##
+    # 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
+    #
+    #  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.
+      ##
+      attr_reader :group
+
+      attr_reader :parameter_type_name
+
+      def initialize(
+        group: Group.new,
+        parameter_type_name: nil
+      )
+        @group = group
+        @parameter_type_name = parameter_type_name
+        super()
+      end
+
+      ##
+      # Returns a new StepMatchArgument from the given hash.
+      # If the hash keys are camelCased, they are properly assigned to the
+      # corresponding snake_cased attributes.
+      #
+      #   Cucumber::Messages::StepMatchArgument.from_h(some_hash) # => #<Cucumber::Messages::StepMatchArgument:0x... ...>
+      ##
+      def self.from_h(hash)
+        return nil if hash.nil?
+
+        new(
+          group: Group.from_h(hash[:group]),
+          parameter_type_name: hash[:parameterTypeName]
+        )
+      end
+    end
+  end
+end