class CukeModeler::Scenario
A class modeling an individual scenario of a Cucumber suite.
Attributes
The scenario’s keyword
Public Class Methods
Creates a new Scenario
object and, if source_text is provided, populates the object.
@example
Scenario.new Scenario.new("Scenario:\n * a step")
@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 [Scenario] A new Scenario
instance
CukeModeler::Model::new
# File lib/cuke_modeler/models/scenario.rb, line 29 def initialize(source_text = nil) @steps = [] @tags = [] super end
Public Instance Methods
Compares this model with another object. Returns true if the two objects have equivalent steps and false otherwise.
@example
scenario_1 == scenario_2
@param other [Object] The object to compare this model with @return [Boolean] Whether the two objects are equivalent
# File lib/cuke_modeler/models/scenario.rb, line 44 def ==(other) return false unless other.respond_to?(:steps) steps == other.steps end
See ‘Object#inspect`. Returns some basic information about the object, including its class, object ID, and its most meaningful attribute. For a Scenario
model, this will be the name of the scenario. If verbose is true, provides default Ruby inspection behavior instead.
@example
scenario.inspect scenario.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
CukeModeler::Model#inspect
# File lib/cuke_modeler/models/scenario.rb, line 98 def inspect(verbose: false) return super if verbose "#{super.chop} @name: #{name.inspect}>" end
Returns a string representation of this model. For a Scenario
model, this will be Gherkin text that is equivalent to the scenario being modeled.
@example
scenario.to_s
@return [String] A string representation of this model
# File lib/cuke_modeler/models/scenario.rb, line 71 def to_s text = '' text << "#{tag_output_string}\n" unless tags.empty? text << "#{@keyword}:#{name_output_string}" text << "\n#{description_output_string}" unless no_description_to_output? text << "\n" unless steps.empty? || no_description_to_output? text << "\n#{steps_output_string}" unless steps.empty? text end
Private Instance Methods
# File lib/cuke_modeler/models/scenario.rb, line 117 def populate_model(parsed_scenario_data) populate_parsing_data(parsed_scenario_data) populate_source_location(parsed_scenario_data) populate_keyword(parsed_scenario_data) populate_name(parsed_scenario_data) populate_description(parsed_scenario_data) populate_steps(parsed_scenario_data) populate_tags(parsed_scenario_data) end
# File lib/cuke_modeler/models/scenario.rb, line 108 def process_source(source_text) base_file_string = "# language: #{Parsing.dialect}\n#{dialect_feature_keyword}: Fake feature to parse\n" source_text = base_file_string + source_text parsed_file = Parsing.parse_text(source_text, 'cuke_modeler_stand_alone_scenario.feature') parsed_file['feature']['elements'].first end