class Cucumber::Messages::Message - cucumber-messages-33.0.3 Documentation

Public Class Methods

Source

# File lib/cucumber/messages/message.rb, line 8
def self.camelize(term)
  camelized = term.to_s
  camelized.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
end

from_json (json_string)

Source

# File lib/cucumber/messages/message.rb, line 32
def self.from_json(json_string)
  from_h(JSON.parse(json_string, { symbolize_names: true }))
end

Returns a new Message - or messages into an array - deserialized from the given json document. CamelCased keys are properly converted to snake_cased attributes in the process

Cucumber::Messages::Duration.from_json('{"seconds":1,"nanos":42}')
  # => #<Cucumber::Messages::Duration:0x00007efda134c290 @seconds=1, @nanos=42>
Cucumber::Messages::PickleTag.from_json('{"name":"foo","astNodeId":"abc-def"}')
  # => #<Cucumber::Messages::PickleTag:0x00007efda138cdb8 @name="foo", @ast_node_id="abc-def">

It is recursive so embedded messages are also processed.

json_string = { location: { line: 2 }, text: "comment" }.to_json
Cucumber::Messages::Comment.from_json(json_string)
  # => #<Cucumber::Messages::Comment:0x00007efda6abf888 @location=#<Cucumber::Messages::Location:0x00007efda6abf978 @line=2, @column=nil>, @text="comment">

json_string = { uri: 'file:///...', comments: [{text: 'text comment'}, {text: 'another comment'}]}.to_json
Cucumber::Messages::GherkinDocument.from_json(json_string)
  # => #<Cucumber::Messages::GherkinDocument:0x00007efda11e6a90 ... @comments=[#<Cucumber::Messages::Comment:0x00007efda11e6e50 ...]>

Public Instance Methods

to_h (camelize: false, reject_nil_values: false)

Source

# File lib/cucumber/messages/message.rb, line 54
def to_h(camelize: false, reject_nil_values: false)
  resulting_hash = instance_variables.to_h do |variable_name|
    h_key = variable_name[1..]
    h_key = Cucumber::Messages::Message.camelize(h_key) if camelize
    h_value = prepare_value(instance_variable_get(variable_name), camelize: camelize, reject_nil_values: reject_nil_values)
    [h_key.to_sym, h_value]
  end

  resulting_hash.tap { |hash| hash.compact! if reject_nil_values }
end

Returns a new Hash formed from the message attributes If camelize: keyword parameter is set to true, then keys will be camelized If reject_nil_values: keyword parameter is set to true, resulting hash won’t include nil values

Cucumber::Messages::Duration.new(seconds: 1, nanos: 42).to_h
  # => { seconds: 1, nanos: 42 }
Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: 'abc-def').to_h(camelize: true)
  # => { name: 'foo', astNodeId: 'abc-def' }
Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: nil).to_h(reject_nil_values: true)
  # => { name: 'foo' }

It is recursive so embedded messages are also processed

location = Cucumber::Messages::Location.new(line: 2)
Cucumber::Messages::Comment.new(location: location, text: 'comment').to_h
  # => { location: { line: 2, :column: nil }, text: "comment" }

to_json (*_args)

Source

# File lib/cucumber/messages/message.rb, line 82
def to_json(*_args)
  to_h(camelize: true, reject_nil_values: true).to_json
end

Generates a JSON document from the message. Keys are camelized during the process. Null values are not part of the json document.

Cucumber::Messages::Duration.new(seconds: 1, nanos: 42).to_json
  # => {"seconds":1,"nanos":42}
Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: 'abc-def').to_json
  # => {"name":"foo","astNodeId":"abc-def"}
Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: nil).to_json
  # => {"name":"foo"}

As with to_h, the method is recursive

location = Cucumber::Messages::Location.new(line: 2)
Cucumber::Messages::Comment.new(location: location, text: 'comment').to_json
  # => {"location":{"line":2,"column":null},"text":"comment"}

type ()

Source

# File lib/cucumber/messages/message.rb, line 101
def type
  if is_a?(Cucumber::Messages::Envelope)
    {
      type: :envelope,
      contained_message: unwrapped_envelope_type
    }
  else
    { type: underscore(self.class.to_s.split('::').last).to_sym }
  end
end

Returns the type of the message as a hash with snake_cased symbols.

For example, the type of a `Cucumber::Messages::Duration` will be `:duration`.

Cucumber::Messages::Duration.new(seconds: 1, nanos: 42).type
  # => { type: :duration }
Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: 'abc-def').type
  # => { type: :pickle_tag }

For Envelopes, the hash will return the type as ‘:envelope` but it will also indicate the nested envelope message

location = Cucumber::Messages::Location.new(line: 2)
Cucumber::Messages::Envelope.new(location: location).type
  # => { type: :envelope, contained_message: :location }

Private Instance Methods

prepare_value (value, camelize:, reject_nil_values:)

Source

# File lib/cucumber/messages/message.rb, line 114
def prepare_value(value, camelize:, reject_nil_values:)
  if value.is_a?(Cucumber::Messages::Message)
    value.to_h(camelize: camelize, reject_nil_values: reject_nil_values)
  elsif value.is_a?(Array)
    value.map { |element| prepare_value(element, camelize: camelize, reject_nil_values: reject_nil_values) }
  else
    value
  end
end

underscore (klazz_name)

Source

# File lib/cucumber/messages/message.rb, line 125
def underscore(klazz_name)
  klazz_name.gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
            .downcase
end

Simplified form of ‘TextHelpers` generator module

unwrapped_envelope_type ()

Source

# File lib/cucumber/messages/message.rb, line 132
def unwrapped_envelope_type
  instance_variables.detect { |name| !instance_variable_get(name).nil? }
                    .to_s
                    .delete_prefix('@')
                    .to_sym
end

This will scan each iVar and return the first one (Should only ever be one), that is not nil