Class: CukeModeler::Gherkin3Adapter

Inherits:
Object
  • Object
show all
Defined in:
lib/cuke_modeler/adapters/gherkin_3_adapter.rb

Overview

NOT A PART OF THE PUBLIC API An adapter that can convert the output of version 3.x of the gherkin gem into input that is consumable by this gem.

Instance Method Summary collapse

Instance Method Details

#adapt(parsed_ast) ⇒ Object

Adapts the given AST into the shape that this gem expects



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 9

def adapt(parsed_ast)
  parsed_data = {}

  # No data exists stored above feature level
  parsed_data['cuke_modeler_parsing_data'] = nil

  # Comments are stored on the feature in gherkin 3.x
  parsed_data['comments'] = []
  parsed_ast[:comments].each do |comment|
    adapt_comment!(comment)
  end
  parsed_data['comments'].concat(parsed_ast.delete(:comments))

  # An AST is just one feature
  adapt_feature!(parsed_ast)

  parsed_data['feature'] = parsed_ast

  [parsed_data]
end

#adapt_background!(parsed_background) ⇒ Object

Adapts the AST sub-tree that is rooted at the given background node.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 59

def adapt_background!(parsed_background)
  # Saving off the original data
  parsed_background['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_background))

  # Removing parsed data for child elements in order to avoid duplicating data
  parsed_background['cuke_modeler_parsing_data'][:steps] = nil

  parsed_background['type'] = parsed_background.delete(:type).to_s
  parsed_background['keyword'] = parsed_background.delete(:keyword).to_s
  parsed_background['name'] = parsed_background.delete(:name)
  parsed_background['description'] = parsed_background.delete(:description) || ''
  parsed_background['line'] = parsed_background.delete(:location)[:line]

  parsed_background['steps'] = []
  parsed_background[:steps].each do |step|
    adapt_step!(step)
  end
  parsed_background['steps'].concat(parsed_background.delete(:steps))
end

#adapt_comment!(parsed_comment) ⇒ Object

Adapts the AST sub-tree that is rooted at the given comment node.



174
175
176
177
178
179
180
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 174

def adapt_comment!(parsed_comment)
  # Saving off the original data
  parsed_comment['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_comment))

  parsed_comment['text'] = parsed_comment.delete(:text)
  parsed_comment['line'] = parsed_comment.delete(:location)[:line]
end

#adapt_doc_string!(parsed_doc_string) ⇒ Object

Adapts the AST sub-tree that is rooted at the given doc string node.



212
213
214
215
216
217
218
219
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 212

def adapt_doc_string!(parsed_doc_string)
  # Saving off the original data
  parsed_doc_string['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_doc_string))

  parsed_doc_string['value'] = parsed_doc_string.delete(:content)
  parsed_doc_string['content_type'] = parsed_doc_string.delete(:contentType)
  parsed_doc_string['line'] = parsed_doc_string.delete(:location)[:line]
end

#adapt_example!(parsed_example) ⇒ Object

Adapts the AST sub-tree that is rooted at the given example node.



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
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 134

def adapt_example!(parsed_example)
  # Saving off the original data
  parsed_example['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_example))

  # Removing parsed data for child elements in order to avoid duplicating data
  parsed_example['cuke_modeler_parsing_data'][:tags] = nil
  parsed_example['cuke_modeler_parsing_data'][:tableHeader] = nil
  parsed_example['cuke_modeler_parsing_data'][:tableBody] = nil

  parsed_example['keyword'] = parsed_example.delete(:keyword)
  parsed_example['name'] = parsed_example.delete(:name)
  parsed_example['line'] = parsed_example.delete(:location)[:line]
  parsed_example['description'] = parsed_example.delete(:description) || ''

  parsed_example['rows'] = []
  adapt_table_row!(parsed_example[:tableHeader])
  parsed_example['rows'] << parsed_example.delete(:tableHeader)

  parsed_example[:tableBody].each do |row|
    adapt_table_row!(row)
  end
  parsed_example['rows'].concat(parsed_example.delete(:tableBody))

  parsed_example['tags'] = []
  parsed_example[:tags].each do |tag|
    adapt_tag!(tag)
  end
  parsed_example['tags'].concat(parsed_example.delete(:tags))
end

#adapt_feature!(parsed_feature) ⇒ Object

Adapts the AST sub-tree that is rooted at the given feature node.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 31

def adapt_feature!(parsed_feature)
  # Saving off the original data
  parsed_feature['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_feature))

  # Removing parsed data for child elements in order to avoid duplicating data
  parsed_feature['cuke_modeler_parsing_data'][:tags] = nil
  parsed_feature['cuke_modeler_parsing_data'][:scenarioDefinitions] = nil
  parsed_feature['cuke_modeler_parsing_data'][:background] = nil
  parsed_feature['cuke_modeler_parsing_data'][:comments] = nil

  parsed_feature['keyword'] = parsed_feature.delete(:keyword)
  parsed_feature['name'] = parsed_feature.delete(:name)
  parsed_feature['description'] = parsed_feature.delete(:description) || ''
  parsed_feature['line'] = parsed_feature.delete(:location)[:line]

  parsed_feature['elements'] = []
  adapt_child_elements!(parsed_feature)
  parsed_feature['elements'].concat(parsed_feature.delete(:scenarioDefinitions))
  parsed_feature['elements'] << parsed_feature.delete(:background) if parsed_feature[:background]

  parsed_feature['tags'] = []
  parsed_feature[:tags].each do |tag|
    adapt_tag!(tag)
  end
  parsed_feature['tags'].concat(parsed_feature.delete(:tags))
end

#adapt_outline!(parsed_test) ⇒ Object

Adapts the AST sub-tree that is rooted at the given outline node.



104
105
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
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 104

def adapt_outline!(parsed_test)
  # Removing parsed data for child elements in order to avoid duplicating data
  parsed_test['cuke_modeler_parsing_data'][:tags] = nil
  parsed_test['cuke_modeler_parsing_data'][:steps] = nil
  parsed_test['cuke_modeler_parsing_data'][:examples] = nil

  parsed_test['name'] = parsed_test.delete(:name)
  parsed_test['description'] = parsed_test.delete(:description) || ''
  parsed_test['line'] = parsed_test.delete(:location)[:line]

  parsed_test['tags'] = []
  parsed_test[:tags].each do |tag|
    adapt_tag!(tag)
  end
  parsed_test['tags'].concat(parsed_test.delete(:tags))

  parsed_test['steps'] = []
  parsed_test[:steps].each do |step|
    adapt_step!(step)
  end
  parsed_test['steps'].concat(parsed_test.delete(:steps))

  parsed_test['examples'] = []
  parsed_test[:examples].each do |step|
    adapt_example!(step)
  end
  parsed_test['examples'].concat(parsed_test.delete(:examples))
end

#adapt_scenario!(parsed_test) ⇒ Object

Adapts the AST sub-tree that is rooted at the given scenario node.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 80

def adapt_scenario!(parsed_test)
  # Removing parsed data for child elements in order to avoid duplicating data
  parsed_test['cuke_modeler_parsing_data'][:tags] = nil
  parsed_test['cuke_modeler_parsing_data'][:steps] = nil


  parsed_test['name'] = parsed_test.delete(:name)
  parsed_test['description'] = parsed_test.delete(:description) || ''
  parsed_test['line'] = parsed_test.delete(:location)[:line]

  parsed_test['tags'] = []
  parsed_test[:tags].each do |tag|
    adapt_tag!(tag)
  end
  parsed_test['tags'].concat(parsed_test.delete(:tags))

  parsed_test['steps'] = []
  parsed_test[:steps].each do |step|
    adapt_step!(step)
  end
  parsed_test['steps'].concat(parsed_test.delete(:steps))
end

#adapt_step!(parsed_step) ⇒ Object

Adapts the AST sub-tree that is rooted at the given step node.



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
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 183

def adapt_step!(parsed_step)
  # Saving off the original data
  parsed_step['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_step))

  # Removing parsed data for child elements in order to avoid duplicating data
  parsed_step['cuke_modeler_parsing_data'][:argument] = nil

  parsed_step['keyword'] = parsed_step.delete(:keyword)
  parsed_step['name'] = parsed_step.delete(:text)
  parsed_step['line'] = parsed_step.delete(:location)[:line]


  step_argument = parsed_step[:argument]

  if step_argument
    case step_argument[:type]
      when :DocString
        adapt_doc_string!(step_argument)
        parsed_step['doc_string'] = parsed_step.delete(:argument)
      when :DataTable
        adapt_step_table!(step_argument)
        parsed_step['table'] = parsed_step.delete(:argument)
      else
        raise(ArgumentError, "Unknown step argument type: #{step_argument[:type]}")
    end
  end
end

#adapt_step_table!(parsed_step_table) ⇒ Object

Adapts the AST sub-tree that is rooted at the given table node.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 222

def adapt_step_table!(parsed_step_table)
  # Saving off the original data
  parsed_step_table['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_step_table))

  # Removing parsed data for child elements in order to avoid duplicating data
  parsed_step_table['cuke_modeler_parsing_data'][:rows] = nil

  parsed_step_table['rows'] = []
  parsed_step_table[:rows].each do |row|
    adapt_table_row!(row)
  end
  parsed_step_table['rows'].concat(parsed_step_table.delete(:rows))
  parsed_step_table['line'] = parsed_step_table.delete(:location)[:line]
end

#adapt_table_cell!(parsed_cell) ⇒ Object

Adapts the AST sub-tree that is rooted at the given cell node.



256
257
258
259
260
261
262
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 256

def adapt_table_cell!(parsed_cell)
  # Saving off the original data
  parsed_cell['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_cell))

  parsed_cell['value'] = parsed_cell.delete(:value)
  parsed_cell['line'] = parsed_cell.delete(:location)[:line]
end

#adapt_table_row!(parsed_table_row) ⇒ Object

Adapts the AST sub-tree that is rooted at the given row node.



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 238

def adapt_table_row!(parsed_table_row)
  # Saving off the original data
  parsed_table_row['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_table_row))

  # Removing parsed data for child elements in order to avoid duplicating data which the child elements will themselves include
  parsed_table_row['cuke_modeler_parsing_data'][:cells] = nil


  parsed_table_row['line'] = parsed_table_row.delete(:location)[:line]

  parsed_table_row['cells'] = []
  parsed_table_row[:cells].each do |row|
    adapt_table_cell!(row)
  end
  parsed_table_row['cells'].concat(parsed_table_row.delete(:cells))
end

#adapt_tag!(parsed_tag) ⇒ Object

Adapts the AST sub-tree that is rooted at the given tag node.



165
166
167
168
169
170
171
 
# File 'lib/cuke_modeler/adapters/gherkin_3_adapter.rb', line 165

def adapt_tag!(parsed_tag)
  # Saving off the original data
  parsed_tag['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_tag))

  parsed_tag['name'] = parsed_tag.delete(:name)
  parsed_tag['line'] = parsed_tag.delete(:location)[:line]
end