class Cucumber::Ast::TreeWalker

Walks the AST, executing steps and notifying listeners

Public Class Methods

new(runtime, listeners = [], configuration = Cucumber::Configuration.default) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 8
def initialize(runtime, listeners = [], configuration = Cucumber::Configuration.default)
  @runtime, @listeners, @configuration = runtime, listeners, configuration
end

Public Instance Methods

embed(file, mime_type, label) click to toggle source

Embed file of mime_type in the formatter. This method can be called from within StepDefinitions. For most formatters this is a no-op.

# File lib/cucumber/ast/tree_walker.rb, line 159
def embed(file, mime_type, label)
  broadcast(file, mime_type, label)
end
execute(scenario, skip_hooks) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 12
def execute(scenario, skip_hooks)
  runtime.with_hooks(scenario, skip_hooks) do
    scenario.skip_invoke! if scenario.failed?
    visit_steps(scenario.steps)
  end
end
puts(*messages) click to toggle source

Print messages. This method can be called from within StepDefinitions.

# File lib/cucumber/ast/tree_walker.rb, line 153
def puts(*messages)
  broadcast(*messages)
end
visit_background(background) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 62
def visit_background(background)
  broadcast(background) do
    background.accept(self)
  end
end
visit_background_name(keyword, name, file_colon_line, source_indent) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 68
def visit_background_name(keyword, name, file_colon_line, source_indent)
  broadcast(keyword, name, file_colon_line, source_indent)
end
visit_comment(comment) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 31
def visit_comment(comment)
  broadcast(comment) do
    comment.accept(self)
  end
end
visit_comment_line(comment_line) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 37
def visit_comment_line(comment_line)
  broadcast(comment_line)
end
visit_doc_string(string) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 132
def visit_doc_string(string)
  broadcast(string)
end
visit_examples(examples) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 78
def visit_examples(examples)
  broadcast(examples) do
    examples.accept(self)
  end
end
visit_examples_array(examples_array) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 72
def visit_examples_array(examples_array)
  broadcast(examples_array) do
    examples_array.accept(self)
  end
end
visit_examples_name(keyword, name) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 84
def visit_examples_name(keyword, name)
  broadcast(keyword, name)
end
visit_feature(feature) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 25
def visit_feature(feature)
  broadcast(feature) do
    feature.accept(self)
  end
end
visit_feature_element(feature_element) click to toggle source

feature_element is either Scenario or ScenarioOutline

# File lib/cucumber/ast/tree_walker.rb, line 56
def visit_feature_element(feature_element)
  broadcast(feature_element) do
    feature_element.accept(self)
  end
end
visit_feature_name(keyword, name) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 51
def visit_feature_name(keyword, name)
  broadcast(keyword, name)
end
visit_features(features) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 19
def visit_features(features)
  broadcast(features) do
    features.accept(self)
  end
end
visit_outline_table(outline_table) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 88
def visit_outline_table(outline_table)
  broadcast(outline_table) do
    outline_table.accept(self)
  end
end
visit_scenario_name(keyword, name, file_colon_line, source_indent) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 94
def visit_scenario_name(keyword, name, file_colon_line, source_indent)
  broadcast(keyword, name, file_colon_line, source_indent)
end
visit_step(step) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 104
def visit_step(step)
  broadcast(step) do
    step.accept(self)
  end
end
visit_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 110
def visit_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line)
  broadcast(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line) do
    visit_step_name(keyword, step_match, status, source_indent, background, file_colon_line)
    visit_multiline_arg(multiline_arg) if multiline_arg
    visit_exception(exception, status) if exception
  end
end
visit_steps(steps) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 98
def visit_steps(steps)
  broadcast(steps) do
    steps.accept(self)
  end
end
visit_table_cell(table_cell) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 142
def visit_table_cell(table_cell)
  broadcast(table_cell) do
    table_cell.accept(self)
  end
end
visit_table_cell_value(value, status) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 148
def visit_table_cell_value(value, status)
  broadcast(value, status)
end
visit_table_row(table_row) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 136
def visit_table_row(table_row)
  broadcast(table_row) do
    table_row.accept(self)
  end
end
visit_tag_name(tag_name) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 47
def visit_tag_name(tag_name)
  broadcast(tag_name)
end
visit_tags(tags) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 41
def visit_tags(tags)
  broadcast(tags) do
    tags.accept(self)
  end
end

Private Instance Methods

broadcast(*args) { || ... } click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 165
def broadcast(*args, &block)
  message = extract_method_name_from(caller)
  message.gsub!('visit_', '')
  if block_given?
    send_to_all("before_#{message}", *args)
    yield if block_given?
    send_to_all("after_#{message}", *args)
  else
    send_to_all(message, *args)
  end
  self
end
extract_method_name_from(call_stack) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 185
def extract_method_name_from(call_stack)
  call_stack[0].match(/in `(.*)'/).captures[0]
end
send_to_all(message, *args) click to toggle source
# File lib/cucumber/ast/tree_walker.rb, line 178
def send_to_all(message, *args)
  @listeners.each do |listener|
    if listener.respond_to?(message)
      listener.__send__(message, *args)
    end
  end
end