class CukeModeler::Comment

A class modeling a comment in a feature file.

Attributes

text[RW]

The text of the comment

Public Class Methods

new(source_text = nil) click to toggle source

Creates a new Comment object and, if source_text is provided, populates the object.

@example

Comment.new
Comment.new('# A comment')

@param source_text [String] The Gherkin text that will be used to populate the model @raise [ArgumentError] If source_text is not a String @return [Comment] A new Comment instance

Calls superclass method
# File lib/cuke_modeler/models/comment.rb, line 25
def initialize(source_text = nil)
  super
end

Public Instance Methods

inspect(verbose: false) click to toggle source

See ‘Object#inspect`. Returns some basic information about the object, including its class, object ID, and its most meaningful attribute. For a Comment model, this will be the text of the comment. If verbose is true, provides default Ruby inspection behavior instead.

@example

comment.inspect
comment.inspect(verbose: true)

@param verbose [Boolean] Whether or not to return the full details of

the object. Defaults to false.

@return [String] A string representation of this model

Calls superclass method
# File lib/cuke_modeler/models/comment.rb, line 52
def inspect(verbose: false)
  return super if verbose

  "#{super.chop} @text: #{text.inspect}>"
end
to_s() click to toggle source

Returns a string representation of this model. For a Comment model, this will be Gherkin text that is equivalent to the comment being modeled.

@example

comment.to_s

@return [String] A string representation of this model

# File lib/cuke_modeler/models/comment.rb, line 36
def to_s
  text || ''
end

Private Instance Methods

populate_comment_text(parsed_comment_data) click to toggle source
# File lib/cuke_modeler/models/comment.rb, line 77
def populate_comment_text(parsed_comment_data)
  @text = parsed_comment_data['text'].strip
end
populate_model(processed_comment_data) click to toggle source
# File lib/cuke_modeler/models/comment.rb, line 71
def populate_model(processed_comment_data)
  populate_comment_text(processed_comment_data)
  populate_parsing_data(processed_comment_data)
  populate_source_location(processed_comment_data)
end
process_source(source_text) click to toggle source
# File lib/cuke_modeler/models/comment.rb, line 62
def process_source(source_text)
  base_file_string = "\n#{dialect_feature_keyword}: Fake feature to parse"
  source_text = "# language: #{Parsing.dialect}\n" + source_text + base_file_string

  parsed_file = Parsing.parse_text(source_text, 'cuke_modeler_stand_alone_comment.feature')

  parsed_file['comments'].last
end