cuke_modeler 1.5.0 → 3.1.0

data/lib/cuke_modeler/adapters/gherkin_2_adapter.rb

@@ -1,273 +0,0 @@
-module CukeModeler
-
-  # An adapter that can convert the output of version 2.x of the *gherkin* gem into input that is consumable by this gem.
-
-  class Gherkin2Adapter
-
-    # Adapts the given AST into the shape that this gem expects
-    def adapt(parsed_ast)
-      parsed_data = {}
-
-      # The entire AST is just an array with one feature and we don't want to save any child data so...an empty array
-      parsed_data['cuke_modeler_parsing_data'] = []
-
-      # Comments are stored on child elements in gherkin 2.x
-      comments = []
-
-      # An AST is just one feature
-      adapt_feature!(parsed_ast.first, comments) if parsed_ast.first
-      parsed_data['feature'] = parsed_ast.first
-
-      # Adapt and store comments once they have all been gathered
-      comments.each do |comment|
-        adapt_comment!(comment)
-      end
-      parsed_data['comments'] = comments
-
-
-      [parsed_data]
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given feature node.
-    def adapt_feature!(parsed_feature, gathered_comments)
-      # 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']['elements'] = nil
-
-      if parsed_feature['comments']
-        parsed_feature['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_feature['comments'])
-      end
-
-      adapt_child_elements!(parsed_feature, gathered_comments)
-
-      if parsed_feature['tags']
-        parsed_feature['tags'].each do |tag|
-          adapt_tag!(tag)
-        end
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given background node.
-    def adapt_background!(parsed_background, gathered_comments)
-      # 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
-
-      if parsed_background['comments']
-        parsed_background['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_background['comments'])
-      end
-
-      if parsed_background['steps']
-        parsed_background['steps'].each do |step|
-          adapt_step!(step, gathered_comments)
-        end
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given scenario node.
-    def adapt_scenario!(parsed_scenario, gathered_comments)
-      # Saving off the original data
-      parsed_scenario['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_scenario))
-
-      # Removing parsed data for child elements in order to avoid duplicating data
-      parsed_scenario['cuke_modeler_parsing_data']['tags'] = nil
-      parsed_scenario['cuke_modeler_parsing_data']['steps'] = nil
-
-      if parsed_scenario['comments']
-        parsed_scenario['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_scenario['comments'])
-      end
-
-      if parsed_scenario['tags']
-        parsed_scenario['tags'].each do |tag|
-          adapt_tag!(tag)
-        end
-      end
-
-      if parsed_scenario['steps']
-        parsed_scenario['steps'].each do |step|
-          adapt_step!(step, gathered_comments)
-        end
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given outline node.
-    def adapt_outline!(parsed_outline, gathered_comments)
-      # Saving off the original data
-      parsed_outline['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_outline))
-
-      # Removing parsed data for child elements in order to avoid duplicating data
-      parsed_outline['cuke_modeler_parsing_data']['tags'] = nil
-      parsed_outline['cuke_modeler_parsing_data']['steps'] = nil
-      parsed_outline['cuke_modeler_parsing_data']['examples'] = nil
-
-      if parsed_outline['comments']
-        parsed_outline['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_outline['comments'])
-      end
-
-      if parsed_outline['tags']
-        parsed_outline['tags'].each do |tag|
-          adapt_tag!(tag)
-        end
-      end
-
-      if parsed_outline['steps']
-        parsed_outline['steps'].each do |step|
-          adapt_step!(step, gathered_comments)
-        end
-      end
-
-      if parsed_outline['examples']
-        parsed_outline['examples'].each do |example|
-          adapt_example!(example, gathered_comments)
-        end
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given example node.
-    def adapt_example!(parsed_example, gathered_comments)
-      # 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']['rows'] = nil
-
-      if parsed_example['comments']
-        parsed_example['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_example['comments'])
-      end
-
-      parsed_example['rows'].each do |row|
-        adapt_table_row!(row, gathered_comments)
-      end
-
-      if parsed_example['tags']
-        parsed_example['tags'].each do |tag|
-          adapt_tag!(tag)
-        end
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given tag node.
-    def adapt_tag!(parsed_tag)
-      # Saving off the original data
-      parsed_tag['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_tag))
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given comment node.
-    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('value')
-      parsed_comment['line'] = parsed_comment.delete('line')
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given step node.
-    def adapt_step!(parsed_step, gathered_comments)
-      # 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']['rows'] = nil if parsed_step['cuke_modeler_parsing_data']['rows']
-      parsed_step['cuke_modeler_parsing_data']['doc_string'] = nil if parsed_step['cuke_modeler_parsing_data']['doc_string']
-
-      if parsed_step['comments']
-        parsed_step['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_step['comments'])
-      end
-
-      adapt_doc_string!(parsed_step['doc_string']) if parsed_step['doc_string']
-
-      if parsed_step['rows']
-        parsed_step['table'] = {'rows' => parsed_step['rows']}
-        adapt_step_table!(parsed_step['table'], gathered_comments)
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given doc string node.
-    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))
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given table node.
-    def adapt_step_table!(parsed_step_table, gathered_comments)
-      # Saving off the original data
-      parsed_step_table['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_step_table['rows']))
-
-      # Removing parsed data for child elements in order to avoid duplicating data
-      parsed_step_table['cuke_modeler_parsing_data'].clear
-
-
-      parsed_step_table['line'] = parsed_step_table['rows'].first['line']
-
-      parsed_step_table['rows'].each do |row|
-        adapt_table_row!(row, gathered_comments)
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given row node.
-    def adapt_table_row!(parsed_table_row, gathered_comments)
-      # 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
-
-      if parsed_table_row['comments']
-        parsed_table_row['cuke_modeler_parsing_data']['comments'] = nil
-        gathered_comments.concat(parsed_table_row['comments'])
-      end
-
-      parsed_table_row['cells'].collect! do |cell|
-        create_cell_for(cell, parsed_table_row['line'])
-      end
-    end
-
-    # Adapts the AST sub-tree that is rooted at the given cell node.
-    def create_cell_for(parsed_cell, line_number)
-      cell = {}
-
-      # Saving off the original data
-      cell['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_cell))
-
-      cell['value'] = parsed_cell
-      cell['line'] = line_number
-
-
-      cell
-    end
-
-
-    private
-
-
-    def adapt_child_elements!(parsed_feature, gathered_comments)
-      if parsed_feature['elements']
-        parsed_feature['elements'].each do |element|
-          case element['type']
-            when 'background'
-              adapt_background!(element, gathered_comments)
-            when 'scenario'
-              adapt_scenario!(element, gathered_comments)
-            when 'scenario_outline'
-              adapt_outline!(element, gathered_comments)
-            else
-              raise(ArgumentError, "Unknown element type: #{element['type']}")
-          end
-        end
-      end
-    end
-
-  end
-end

data/lib/cuke_modeler/adapters/gherkin_3_adapter.rb

@@ -1,296 +0,0 @@
-module CukeModeler
-
-  # An adapter that can convert the output of version 3.x of the *gherkin* gem into input that is consumable by this gem.
-
-  class Gherkin3Adapter
-
-    # Adapts the given AST into the shape that this gem expects
-    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
-
-    # Adapts the AST sub-tree that is rooted at the given feature node.
-    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
-
-    # Adapts the AST sub-tree that is rooted at the given background node.
-    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
-
-    # Adapts the AST sub-tree that is rooted at the given scenario node.
-    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
-
-    # Adapts the AST sub-tree that is rooted at the given outline node.
-    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
-
-    # Adapts the AST sub-tree that is rooted at the given example node.
-    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
-
-    # Adapts the AST sub-tree that is rooted at the given tag node.
-    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
-
-    # Adapts the AST sub-tree that is rooted at the given comment node.
-    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
-
-    # Adapts the AST sub-tree that is rooted at the given step node.
-    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
-
-    # Adapts the AST sub-tree that is rooted at the given doc string node.
-    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
-
-    # Adapts the AST sub-tree that is rooted at the given table node.
-    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
-
-    # Adapts the AST sub-tree that is rooted at the given row node.
-    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
-
-    # Adapts the AST sub-tree that is rooted at the given cell node.
-    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
-
-
-    private
-
-
-    def adapt_child_elements!(parsed_feature)
-      adapt_background!(parsed_feature[:background]) if parsed_feature[:background]
-      adapt_tests!(parsed_feature)
-    end
-
-    def adapt_tests!(parsed_feature)
-      parsed_feature[:scenarioDefinitions].each do |test|
-        adapt_test!(test)
-      end
-    end
-
-    def adapt_test!(parsed_test)
-      # Saving off the original data
-      parsed_test['cuke_modeler_parsing_data'] = Marshal::load(Marshal.dump(parsed_test))
-
-      parsed_test['keyword'] = parsed_test.delete(:keyword)
-      parsed_test['type'] = parsed_test.delete(:type).to_s
-
-      case parsed_test['type']
-        when 'Scenario'
-          adapt_scenario!(parsed_test)
-        when 'ScenarioOutline'
-          adapt_outline!(parsed_test)
-        else
-          raise(ArgumentError, "Unknown test type: #{parsed_test['type']}")
-      end
-    end
-
-  end
-end