Class: Spinach::Parser::Visitor

Inherits:
Object
  • Object
show all
Defined in:
lib/spinach/parser/visitor.rb

Overview

The Spinach Visitor traverses the output AST from the GherkinRuby parser and populates its Feature with all the scenarios, tags, steps, etc.

Examples:


ast     = GherkinRuby.parse(File.read('some.feature'))
visitor = Spinach::Parser::Visitor.new
feature = visitor.visit(ast)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Visitor

Returns a new instance of Visitor.

Parameters:

  • feature (Feature) —

    The feature to populate,



19
20
21
 
# File 'lib/spinach/parser/visitor.rb', line 19

def initialize
  @feature = Feature.new
end

Instance Attribute Details

#feature ⇒ Object (readonly)

Returns the value of attribute feature.



13
14
15
 
# File 'lib/spinach/parser/visitor.rb', line 13

def feature
  @feature
end

Instance Method Details

#visit(ast) ⇒ Object

Parameters:

  • ast (GherkinRuby::AST::Feature) —

    The AST root node to visit.



27
28
29
30
31
 
# File 'lib/spinach/parser/visitor.rb', line 27

def visit(ast)
  ast.accept(self)

  @feature
end

#visit_Background(node) ⇒ Object

Iterates over the steps.

Parameters:

  • node (GherkinRuby::AST::Scenario) —

    The scenario to visit.



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/spinach/parser/visitor.rb', line 58

def visit_Background(node)
  background      = Background.new(@feature)
  background.line = node.line

  @current_step_set = background
  node.steps.each { |step| step.accept(self) }
  @current_step_set = nil

  @feature.background = background
end

#visit_Feature(node) ⇒ Object

Sets the feature name and iterates over the feature scenarios.

Parameters:

  • feature (GherkinRuby::AST::Feature) —

    The feature to visit.



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/spinach/parser/visitor.rb', line 39

def visit_Feature(node)
  @feature.name        = node.name
  @feature.description = node.description

  node.background.accept(self) if node.background

  @current_tag_set = @feature
  node.tags.each { |tag| tag.accept(self) }
  @current_tag_set = nil

  node.scenarios.each { |scenario| scenario.accept(self) }
end

#visit_Scenario(node) ⇒ Object

Sets the scenario name and iterates over the steps.

Parameters:

  • node (GherkinRuby::AST::Scenario) —

    The scenario to visit.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/spinach/parser/visitor.rb', line 75

def visit_Scenario(node)
  scenario       = Scenario.new(@feature)
  scenario.name  = node.name
  scenario.lines = [
    node.line,
    *node.steps.map(&:line)
  ].uniq.sort

  @current_tag_set = scenario
  node.tags.each { |tag| tag.accept(self) }
  @current_tag_set = nil

  @current_step_set = scenario
  node.steps.each { |step| step.accept(self) }
  @current_step_set = nil

  @feature.scenarios << scenario
end

#visit_Step(node) ⇒ Object

Adds the step to the current scenario.

Parameters:

  • step (GherkinRuby::AST::Step) —

    The step to add.



110
111
112
113
114
115
116
117
 
# File 'lib/spinach/parser/visitor.rb', line 110

def visit_Step(node)
  step         = Step.new(@current_step_set)
  step.name    = node.name
  step.line    = node.line
  step.keyword = node.keyword

  @current_step_set.steps << step
end

#visit_Tag(node) ⇒ Object

Adds the tag to the current scenario.

Parameters:

  • node (GherkinRuby::AST::Tag) —

    The tag to add.



100
101
102
 
# File 'lib/spinach/parser/visitor.rb', line 100

def visit_Tag(node)
  @current_tag_set.tags << node.name
end