class Cucumber::Messages::Message
def self.camelize(term)
def self.camelize(term) camelized = term.to_s camelized.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" } end
def self.from_json(json_string)
# => #
Cucumber::Messages::GherkinDocument.from_json(json_string)
json_string = { uri: 'file:///...', comments: [{text: 'text comment'}, {text: 'another comment'}]}.to_json
# => #
Cucumber::Messages::Comment.from_json(json_string)
json_string = { location: { line: 2 }, text: "comment" }.to_json
It is recursive so embedded messages are also processed.
# => #
Cucumber::Messages::PickleTag.from_json('{"name":"foo","astNodeId":"abc-def"}')
# => #
Cucumber::Messages::Duration.from_json('{"seconds":1,"nanos":42}')
CamelCased keys are properly converted to snake_cased attributes in the process
Returns a new Message - or messages into an array - deserialized from the given json document.
#
def self.from_json(json_string) from_h(JSON.parse(json_string, { symbolize_names: true })) end
def prepare_value(value, camelize:, reject_nil_values:)
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
def to_h(camelize: false, reject_nil_values: false)
# => { location: { line: 2, :column: nil }, text: "comment" }
Cucumber::Messages::Comment.new(location: location, text: 'comment').to_h
location = Cucumber::Messages::Location.new(line: 2)
It is recursive so embedded messages are also processed
# => { name: 'foo' }
Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: nil).to_h(reject_nil_values: true)
# => { name: 'foo', astNodeId: 'abc-def' }
Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: 'abc-def').to_h(camelize: true)
# => { seconds: 1, nanos: 42 }
Cucumber::Messages::Duration.new(seconds: 1, nanos: 42).to_h
If +reject_nil_values:+ keyword parameter is set to true, resulting hash won't include nil values
If +camelize:+ keyword parameter is set to true, then keys will be camelized
Returns a new Hash formed from the message attributes
#
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
def to_json(*_args)
# => '{"location":{"line":2,"column":null},"text":"comment"}'
Cucumber::Messages::Comment.new(location: location, text: 'comment').to_json
location = Cucumber::Messages::Location.new(line: 2)
As with #to_h, the method is recursive
# => '{"name":"foo"}'
Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: nil).to_json
# => '{"name":"foo","astNodeId":"abc-def"}'
Cucumber::Messages::PickleTag.new(name: 'foo', ast_node_id: 'abc-def').to_json
# => '{"seconds":1,"nanos":42}'
Cucumber::Messages::Duration.new(seconds: 1, nanos: 42).to_json
Keys are camelized during the process. Null values are not part of the json document.
Generates a JSON document from the message.
#
def to_json(*_args) to_h(camelize: true, reject_nil_values: true).to_json end