Class: Gherkin::AstBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/gherkin/ast_builder.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AstBuilder

Returns a new instance of AstBuilder.



5
6
7
 
# File 'lib/gherkin/ast_builder.rb', line 5

def initialize
  reset
end

Instance Method Details

#build(token) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/gherkin/ast_builder.rb', line 23

def build(token)
  if token.matched_type == :Comment
    @comments.push({
      type: :Comment,
      location: get_location(token),
      text: token.matched_text
    })
  else
    current_node.add(token.matched_type, token)
  end
end

#current_node ⇒ Object 



39
40
41
 
# File 'lib/gherkin/ast_builder.rb', line 39

def current_node
  @stack.last
end

#end_rule(rule_type) ⇒ Object 



18
19
20
21
 
# File 'lib/gherkin/ast_builder.rb', line 18

def end_rule(rule_type)
  node = @stack.pop
  current_node.add(node.rule_type, transform_node(node))
end

#ensure_cell_count(rows) ⇒ Object 



78
79
80
81
82
83
84
85
86
 
# File 'lib/gherkin/ast_builder.rb', line 78

def ensure_cell_count(rows)
  return if rows.empty?
  cell_count = rows[0][:cells].length
  rows.each do |row|
      if (row[:cells].length != cell_count)
        raise AstBuilderException.new("inconsistent cell count within the table", row[:location]);
      end
  end
end

#get_cells(table_row_token) ⇒ Object 



88
89
90
91
92
93
94
95
96
 
# File 'lib/gherkin/ast_builder.rb', line 88

def get_cells(table_row_token)
  table_row_token.matched_items.map do |cell_item|
    {
      type: :TableCell,
      location: get_location(table_row_token, cell_item.column),
      value: cell_item.text
    }
  end
end

#get_description(node) ⇒ Object 



98
99
100
 
# File 'lib/gherkin/ast_builder.rb', line 98

def get_description(node)
  node.get_single(:Description)
end

#get_location(token, column = nil) ⇒ Object 



43
44
45
46
 
# File 'lib/gherkin/ast_builder.rb', line 43

def get_location(token, column=nil)
  # TODO: translated from JS... is it right?
  (column.nil? || column.zero?) ? token.location : {line: token.location[:line], column: column}
end

#get_result ⇒ Object 



35
36
37
 
# File 'lib/gherkin/ast_builder.rb', line 35

def get_result
  current_node.get_single(:GherkinDocument)
end

#get_steps(node) ⇒ Object 



102
103
104
 
# File 'lib/gherkin/ast_builder.rb', line 102

def get_steps(node)
  node.get_items(:Step)
end

#get_table_rows(node) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/gherkin/ast_builder.rb', line 66

def get_table_rows(node)
  rows = node.get_tokens(:TableRow).map do |token|
    {
      type: :TableRow,
      location: get_location(token),
      cells: get_cells(token)
    }
  end
  ensure_cell_count(rows);
  rows
end

#get_tags(node) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/gherkin/ast_builder.rb', line 48

def get_tags(node)
  tags = []
  tags_node = node.get_single(:Tags)
  return tags unless tags_node

  tags_node.get_tokens(:TagLine).each do |token|
    token.matched_items.each do |tag_item|
      tags.push({
        type: :Tag,
        location: get_location(token, tag_item.column),
        name: tag_item.text
      })
    end
  end

  tags
end

#reject_nils(values) ⇒ Object 



253
254
255
 
# File 'lib/gherkin/ast_builder.rb', line 253

def reject_nils(values)
  values.reject { |k,v| v.nil? }
end

#reset ⇒ Object 



9
10
11
12
 
# File 'lib/gherkin/ast_builder.rb', line 9

def reset
  @stack = [AstNode.new(:None)]
  @comments = []
end

#start_rule(rule_type) ⇒ Object 



14
15
16
 
# File 'lib/gherkin/ast_builder.rb', line 14

def start_rule(rule_type)
  @stack.push AstNode.new(rule_type)
end

#transform_node(node) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/gherkin/ast_builder.rb', line 106

def transform_node(node)
  case node.rule_type
  when :Step
    step_line = node.get_token(:StepLine)
    step_argument = node.get_single(:DataTable) || node.get_single(:DocString) || nil

    reject_nils(
      type: node.rule_type,
      location: get_location(step_line),
      keyword: step_line.matched_keyword,
      text: step_line.matched_text,
      argument: step_argument
    )
  when :DocString
    separator_token = node.get_tokens(:DocStringSeparator)[0]
    content_type = separator_token.matched_text == '' ? nil : separator_token.matched_text
    line_tokens = node.get_tokens(:Other)
    content = line_tokens.map { |t| t.matched_text }.join("\n")

    reject_nils(
      type: node.rule_type,
      location: get_location(separator_token),
      contentType: content_type,
      content: content
    )
  when :DataTable
    rows = get_table_rows(node)
    reject_nils(
      type: node.rule_type,
      location: rows[0][:location],
      rows: rows,
    )
  when :Background
    background_line = node.get_token(:BackgroundLine)
    description = get_description(node)
    steps = get_steps(node)

    reject_nils(
      type: node.rule_type,
      location: get_location(background_line),
      keyword: background_line.matched_keyword,
      name: background_line.matched_text,
      description: description,
      steps: steps
    )
  when :Scenario_Definition
    tags = get_tags(node)
    scenario_node = node.get_single(:Scenario)
    if(scenario_node)
      scenario_line = scenario_node.get_token(:ScenarioLine)
      description = get_description(scenario_node)
      steps = get_steps(scenario_node)

      reject_nils(
        type: scenario_node.rule_type,
        tags: tags,
        location: get_location(scenario_line),
        keyword: scenario_line.matched_keyword,
        name: scenario_line.matched_text,
        description: description,
        steps: steps
      )
    else
      scenario_outline_node = node.get_single(:ScenarioOutline)
      raise 'Internal grammar error' unless scenario_outline_node

      scenario_outline_line = scenario_outline_node.get_token(:ScenarioOutlineLine)
      description = get_description(scenario_outline_node)
      steps = get_steps(scenario_outline_node)
      examples = scenario_outline_node.get_items(:Examples_Definition)

      reject_nils(
        type: scenario_outline_node.rule_type,
        tags: tags,
        location: get_location(scenario_outline_line),
        keyword: scenario_outline_line.matched_keyword,
        name: scenario_outline_line.matched_text,
        description: description,
        steps: steps,
        examples: examples
      )
    end
  when :Examples_Definition
    tags = get_tags(node)
    examples_node = node.get_single(:Examples)
    examples_line = examples_node.get_token(:ExamplesLine)
    description = get_description(examples_node)
    examples_table = examples_node.get_single(:Examples_Table)

    reject_nils(
      type: examples_node.rule_type,
      tags: tags,
      location: get_location(examples_line),
      keyword: examples_line.matched_keyword,
      name: examples_line.matched_text,
      description: description,
      tableHeader: !examples_table.nil? ? examples_table[:tableHeader] : nil,
      tableBody: !examples_table.nil? ? examples_table[:tableBody] : nil
    )
  when :Examples_Table
    rows = get_table_rows(node)

    reject_nils(
      tableHeader: rows.first,
      tableBody: rows[1..-1]
    )
  when :Description
    line_tokens = node.get_tokens(:Other)
    # Trim trailing empty lines
    last_non_empty = line_tokens.rindex { |token| !token.line.trimmed_line_text.empty? }
    description = line_tokens[0..last_non_empty].map { |token| token.matched_text }.join("\n")
    return description
  when :Feature
    header = node.get_single(:Feature_Header)
    return unless header
    tags = get_tags(header)
    feature_line = header.get_token(:FeatureLine)
    return unless feature_line
    children = []
    background = node.get_single(:Background)
    children.push(background) if background
    children.concat(node.get_items(:Scenario_Definition))
    description = get_description(header)
    language = feature_line.matched_gherkin_dialect

    reject_nils(
      type: node.rule_type,
      tags: tags,
      location: get_location(feature_line),
      language: language,
      keyword: feature_line.matched_keyword,
      name: feature_line.matched_text,
      description: description,
      children: children,
    )
  when :GherkinDocument
    feature = node.get_single(:Feature)
    reject_nils(
      type: node.rule_type,
      feature: feature,
      comments: @comments
    )
  else
    return node
  end
end