cuke_modeler 1.3.0 → 2.1.0

data/testing/rspec/spec/integration/adapters/gherkin_8_adapter_spec.rb

@@ -0,0 +1,162 @@
+require "#{File.dirname(__FILE__)}/../../spec_helper"
+
+
+describe 'Gherkin8Adapter, Integration', :if => gherkin?(8) do
+
+  let(:clazz) { CukeModeler::Gherkin8Adapter }
+  let(:adapter) { clazz.new }
+  let(:source_text) { "# feature comment
+                       @tag1 @tag2 @tag3
+                       #{FEATURE_KEYWORD}: A feature with everything it could have
+
+                       Including a description
+                       and then some.
+
+                         # background comment
+                         #{BACKGROUND_KEYWORD}:
+
+                         Background
+                         description
+
+                           #{STEP_KEYWORD} a step
+                           # table comment
+                             | value1 |
+                           # table row comment
+                             | value2 |
+                           #{STEP_KEYWORD} another step
+
+                         # scenario comment
+                         @scenario_tag
+                         #{SCENARIO_KEYWORD}:
+
+                         Scenario
+                         description
+
+                           #{STEP_KEYWORD} a step
+                           #{STEP_KEYWORD} another step
+                             \"\"\"
+                             some text
+                             \"\"\"
+
+                         # outline comment
+                         @outline_tag
+                         #{OUTLINE_KEYWORD}:
+
+                         Outline
+                         description
+
+                           # step comment
+                           #{STEP_KEYWORD} a step
+                           # table comment
+                             | value2 |
+                           # step comment
+                           #{STEP_KEYWORD} another step
+                           # doc string comment
+                             \"\"\"
+                             some text
+                             \"\"\"
+
+                         # example comment
+                         @example_tag
+                         #{EXAMPLE_KEYWORD}:
+
+                         Example
+                         description
+
+                           # row comment
+                           | param |
+                           | value |
+                       # final comment" }
+  let(:feature_file_model) do
+    test_file_path = CukeModeler::FileHelper.create_feature_file(:text => source_text, :name => 'adapter_test_file')
+
+    CukeModeler::FeatureFile.new(test_file_path)
+  end
+  let(:feature_model) { feature_file_model.feature }
+
+
+  it "does not store parsing data for a feature file's children" do
+    model = feature_file_model
+
+    expect(model.parsing_data[:comments]).to be_nil
+    expect(model.parsing_data[:feature]).to be_nil
+  end
+
+  it "does not store parsing data for a feature's children" do
+    model = feature_model
+
+    expect(model.parsing_data[:tags]).to be_nil
+    expect(model.parsing_data[:children]).to be_nil
+  end
+
+  it "does not store parsing data for a background's children" do
+    model = feature_model.background
+
+    expect(model.parsing_data[:background][:steps]).to be_nil
+  end
+
+  it "does not store parsing data for a scenario's children" do
+    model = feature_model.scenarios.first
+
+    expect(model.parsing_data[:scenario][:tags]).to be_nil
+    expect(model.parsing_data[:scenario][:steps]).to be_nil
+  end
+
+  it "does not store parsing data for an outline's children" do
+    model = feature_model.outlines.first
+
+    expect(model.parsing_data[:scenario][:tags]).to be_nil
+    expect(model.parsing_data[:scenario][:steps]).to be_nil
+    expect(model.parsing_data[:scenario][:examples]).to be_nil
+  end
+
+  it "does not store parsing data for an example's children" do
+    model = feature_model.outlines.first.examples.first
+
+    expect(model.parsing_data[:tags]).to be_nil
+    expect(model.parsing_data[:table_header]).to be_nil
+    expect(model.parsing_data[:table_body]).to be_nil
+  end
+
+  it "does not store parsing data for an example row's children" do
+    model = feature_model.outlines.first.examples.first.rows.first
+
+    expect(model.parsing_data[:cells]).to be_nil
+  end
+
+  it "does not store parsing data for a step's children, table" do
+    model = feature_model.outlines.first.steps.first
+
+    expect(model.parsing_data[:data_table]).to be_nil
+  end
+
+  it "does not store parsing data for a step's children, doc string" do
+    model = feature_model.outlines.first.steps.last
+
+    expect(model.parsing_data[:doc_string]).to be_nil
+  end
+
+  it "does not store parsing data for a table's children" do
+    model = feature_model.outlines.first.steps.first.block
+
+    expect(model.parsing_data[:rows]).to be_nil
+  end
+
+  it "does not store parsing data for a table row's children" do
+    model = feature_model.outlines.first.steps.first.block.rows.first
+
+    expect(model.parsing_data[:cells]).to be_nil
+  end
+
+
+  describe 'stuff that is in no way part of the public API and entirely subject to change' do
+
+    it 'provides a useful explosion message if it encounters an entirely new type of test' do
+      partial_feature_ast = { :type => :Feature, :location => { :line => 1, :column => 1 }, :children => [{ :some_unknown_type => {} }] }
+
+      expect { adapter.adapt_feature!(partial_feature_ast) }.to raise_error(ArgumentError, /Unknown.*some_unknown_type/)
+    end
+
+  end
+
+end

data/testing/rspec/spec/integration/adapters/gherkin_9_adapter_spec.rb

@@ -0,0 +1,162 @@
+require "#{File.dirname(__FILE__)}/../../spec_helper"
+
+
+describe 'Gherkin9Adapter, Integration', :if => gherkin?(9) do
+
+  let(:clazz) { CukeModeler::Gherkin9Adapter }
+  let(:adapter) { clazz.new }
+  let(:source_text) { "# feature comment
+                       @tag1 @tag2 @tag3
+                       #{FEATURE_KEYWORD}: A feature with everything it could have
+
+                       Including a description
+                       and then some.
+
+                         # background comment
+                         #{BACKGROUND_KEYWORD}:
+
+                         Background
+                         description
+
+                           #{STEP_KEYWORD} a step
+                           # table comment
+                             | value1 |
+                           # table row comment
+                             | value2 |
+                           #{STEP_KEYWORD} another step
+
+                         # scenario comment
+                         @scenario_tag
+                         #{SCENARIO_KEYWORD}:
+
+                         Scenario
+                         description
+
+                           #{STEP_KEYWORD} a step
+                           #{STEP_KEYWORD} another step
+                             \"\"\"
+                             some text
+                             \"\"\"
+
+                         # outline comment
+                         @outline_tag
+                         #{OUTLINE_KEYWORD}:
+
+                         Outline
+                         description
+
+                           # step comment
+                           #{STEP_KEYWORD} a step
+                           # table comment
+                             | value2 |
+                           # step comment
+                           #{STEP_KEYWORD} another step
+                           # doc string comment
+                             \"\"\"
+                             some text
+                             \"\"\"
+
+                         # example comment
+                         @example_tag
+                         #{EXAMPLE_KEYWORD}:
+
+                         Example
+                         description
+
+                           # row comment
+                           | param |
+                           | value |
+                       # final comment" }
+  let(:feature_file_model) do
+    test_file_path = CukeModeler::FileHelper.create_feature_file(:text => source_text, :name => 'adapter_test_file')
+
+    CukeModeler::FeatureFile.new(test_file_path)
+  end
+  let(:feature_model) { feature_file_model.feature }
+
+
+  it "does not store parsing data for a feature file's children" do
+    model = feature_file_model
+
+    expect(model.parsing_data[:comments]).to be_nil
+    expect(model.parsing_data[:feature]).to be_nil
+  end
+
+  it "does not store parsing data for a feature's children" do
+    model = feature_model
+
+    expect(model.parsing_data[:tags]).to be_nil
+    expect(model.parsing_data[:children]).to be_nil
+  end
+
+  it "does not store parsing data for a background's children" do
+    model = feature_model.background
+
+    expect(model.parsing_data[:background][:steps]).to be_nil
+  end
+
+  it "does not store parsing data for a scenario's children" do
+    model = feature_model.scenarios.first
+
+    expect(model.parsing_data[:scenario][:tags]).to be_nil
+    expect(model.parsing_data[:scenario][:steps]).to be_nil
+  end
+
+  it "does not store parsing data for an outline's children" do
+    model = feature_model.outlines.first
+
+    expect(model.parsing_data[:scenario][:tags]).to be_nil
+    expect(model.parsing_data[:scenario][:steps]).to be_nil
+    expect(model.parsing_data[:scenario][:examples]).to be_nil
+  end
+
+  it "does not store parsing data for an example's children" do
+    model = feature_model.outlines.first.examples.first
+
+    expect(model.parsing_data[:tags]).to be_nil
+    expect(model.parsing_data[:table_header]).to be_nil
+    expect(model.parsing_data[:table_body]).to be_nil
+  end
+
+  it "does not store parsing data for an example row's children" do
+    model = feature_model.outlines.first.examples.first.rows.first
+
+    expect(model.parsing_data[:cells]).to be_nil
+  end
+
+  it "does not store parsing data for a step's children, table" do
+    model = feature_model.outlines.first.steps.first
+
+    expect(model.parsing_data[:data_table]).to be_nil
+  end
+
+  it "does not store parsing data for a step's children, doc string" do
+    model = feature_model.outlines.first.steps.last
+
+    expect(model.parsing_data[:doc_string]).to be_nil
+  end
+
+  it "does not store parsing data for a table's children" do
+    model = feature_model.outlines.first.steps.first.block
+
+    expect(model.parsing_data[:rows]).to be_nil
+  end
+
+  it "does not store parsing data for a table row's children" do
+    model = feature_model.outlines.first.steps.first.block.rows.first
+
+    expect(model.parsing_data[:cells]).to be_nil
+  end
+
+
+  describe 'stuff that is in no way part of the public API and entirely subject to change' do
+
+    it 'provides a useful explosion message if it encounters an entirely new type of test' do
+      partial_feature_ast = { :type => :Feature, :location => { :line => 1, :column => 1 }, :children => [{ :some_unknown_type => {} }] }
+
+      expect { adapter.adapt_feature!(partial_feature_ast) }.to raise_error(ArgumentError, /Unknown.*some_unknown_type/)
+    end
+
+  end
+
+end

data/testing/rspec/spec/integration/{background_integration_spec.rb → models/background_integration_spec.rb}

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Background, Integration' do
@@ -15,7 +15,7 @@ describe 'Background, Integration' do
   describe 'unique behavior' do
 
     it 'can be instantiated with the minimum viable Gherkin' do
-      source = "#{@background_keyword}:"
+      source = "#{BACKGROUND_KEYWORD}:"
 
       expect { clazz.new(source) }.to_not raise_error
     end
@@ -37,39 +37,43 @@ describe 'Background, Integration' do
       end
     end
 
-    it 'stores the original data generated by the parsing adapter', :gherkin4 => true do
-      background = clazz.new("#{@background_keyword}: test background\ndescription\n#{@step_keyword} a step")
-      data = background.parsing_data
+    describe 'parsing data' do
 
-      expect(data.keys).to match_array([:type, :location, :keyword, :name, :steps, :description])
-      expect(data[:type]).to eq(:Background)
-    end
+      it 'stores the original data generated by the parsing adapter', :if => gherkin?(6, 7, 8, 9) do
+        background = clazz.new("#{BACKGROUND_KEYWORD}: test background\ndescription\n#{STEP_KEYWORD} a step")
+        data = background.parsing_data
 
-    it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
-      background = clazz.new("#{@background_keyword}: test background\ndescription\n#{@step_keyword} a step")
-      data = background.parsing_data
+        expect(data.keys).to match_array([:background, :rule, :scenario])
+        expect(data[:background][:name]).to eq('test background')
+      end
 
-      expect(data.keys).to match_array([:type, :location, :keyword, :name, :steps, :description])
-      expect(data[:type]).to eq(:Background)
-    end
+      it 'stores the original data generated by the parsing adapter', :if => gherkin?(3, 4, 5) do
+        background = clazz.new("#{BACKGROUND_KEYWORD}: test background\ndescription\n#{STEP_KEYWORD} a step")
+        data = background.parsing_data
 
-    it 'stores the original data generated by the parsing adapter', :gherkin2 => true do
-      background = clazz.new("#{@background_keyword}: test background\ndescription\n#{@step_keyword} a step")
-      data = background.parsing_data
+        expect(data.keys).to match_array([:type, :location, :keyword, :name, :steps, :description])
+        expect(data[:type]).to eq(:Background)
+      end
+
+      it 'stores the original data generated by the parsing adapter', :if => gherkin?(2) do
+        background = clazz.new("#{BACKGROUND_KEYWORD}: test background\ndescription\n#{STEP_KEYWORD} a step")
+        data = background.parsing_data
+
+        expect(data.keys).to match_array(['keyword', 'name', 'line', 'description', 'steps', 'type'])
+        expect(data['keyword']).to eq('Background')
+      end
 
-      expect(data.keys).to match_array(['keyword', 'name', 'line', 'description', 'steps', 'type'])
-      expect(data['keyword']).to eq('Background')
     end
 
     it 'provides a descriptive filename when being parsed from stand alone text' do
-      source = "bad background text \n #{@background_keyword}:\n #{@step_keyword} a step\n @foo "
+      source = "bad background text \n #{BACKGROUND_KEYWORD}:\n #{STEP_KEYWORD} a step\n @foo "
 
       expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_background\.feature'/)
     end
 
     it 'properly sets its child models' do
-      source = "#{@background_keyword}: Test background
-                  #{@step_keyword} a step"
+      source = "#{BACKGROUND_KEYWORD}: Test background
+                  #{STEP_KEYWORD} a step"
 
       background = clazz.new(source)
       step = background.steps.first
@@ -78,7 +82,7 @@ describe 'Background, Integration' do
     end
 
     it 'trims whitespace from its source description' do
-      source = ["#{@background_keyword}:",
+      source = ["#{BACKGROUND_KEYWORD}:",
                 '  ',
                 '        description line 1',
                 '',
@@ -87,7 +91,7 @@ describe 'Background, Integration' do
                 '',
                 '',
                 '',
-                "  #{@step_keyword} a step"]
+                "  #{STEP_KEYWORD} a step"]
       source = source.join("\n")
 
       background = clazz.new(source)
@@ -108,10 +112,10 @@ describe 'Background, Integration' do
 
 
       let(:test_directory) { CukeModeler::FileHelper.create_directory }
-      let(:source_gherkin) { "#{@feature_keyword}: Test feature
+      let(:source_gherkin) { "#{FEATURE_KEYWORD}: Test feature
 
-                                #{@background_keyword}: Test background
-                                  #{@step_keyword} a step"
+                                #{BACKGROUND_KEYWORD}: Test background
+                                  #{STEP_KEYWORD} a step"
       }
 
       let(:directory_model) { CukeModeler::Directory.new(test_directory) }
@@ -149,19 +153,19 @@ describe 'Background, Integration' do
 
       context 'from source text' do
 
-        let(:source_text) { "#{@background_keyword}:" }
+        let(:source_text) { "#{BACKGROUND_KEYWORD}:" }
         let(:background) { clazz.new(source_text) }
 
 
         it "models the background's keyword" do
-          expect(background.keyword).to eq("#{@background_keyword}")
+          expect(background.keyword).to eq("#{BACKGROUND_KEYWORD}")
         end
 
         it "models the background's source line" do
-          source_text = "#{@feature_keyword}:
+          source_text = "#{FEATURE_KEYWORD}:
 
-                           #{@background_keyword}: foo
-                             #{@step_keyword} step"
+                           #{BACKGROUND_KEYWORD}: foo
+                             #{STEP_KEYWORD} step"
           background = CukeModeler::Feature.new(source_text).background
 
           expect(background.source_line).to eq(3)
@@ -169,15 +173,15 @@ describe 'Background, Integration' do
 
         context 'a filled background' do
 
-          let(:source_text) { "#{@background_keyword}: Background name
+          let(:source_text) { "#{BACKGROUND_KEYWORD}: Background name
 
                                Background description.
 
                              Some more.
                                  Even more.
 
-                                 #{@step_keyword} a step
-                                 #{@step_keyword} another step" }
+                                 #{STEP_KEYWORD} a step
+                                 #{STEP_KEYWORD} another step" }
           let(:background) { clazz.new(source_text) }
 
 
@@ -204,7 +208,7 @@ describe 'Background, Integration' do
 
         context 'an empty background' do
 
-          let(:source_text) { "#{@background_keyword}:" }
+          let(:source_text) { "#{BACKGROUND_KEYWORD}:" }
           let(:background) { clazz.new(source_text) }
 
 
@@ -230,19 +234,19 @@ describe 'Background, Integration' do
     describe 'comparison' do
 
       it 'is equal to a background with the same steps' do
-        source = "#{@background_keyword}:
-                    #{@step_keyword} step 1
-                    #{@step_keyword} step 2"
+        source = "#{BACKGROUND_KEYWORD}:
+                    #{STEP_KEYWORD} step 1
+                    #{STEP_KEYWORD} step 2"
         background_1 = clazz.new(source)
 
-        source = "#{@background_keyword}:
-                    #{@step_keyword} step 1
-                    #{@step_keyword} step 2"
+        source = "#{BACKGROUND_KEYWORD}:
+                    #{STEP_KEYWORD} step 1
+                    #{STEP_KEYWORD} step 2"
         background_2 = clazz.new(source)
 
-        source = "#{@background_keyword}:
-                    #{@step_keyword} step 2
-                    #{@step_keyword} step 1"
+        source = "#{BACKGROUND_KEYWORD}:
+                    #{STEP_KEYWORD} step 2
+                    #{STEP_KEYWORD} step 1"
         background_3 = clazz.new(source)
 
 
@@ -251,19 +255,19 @@ describe 'Background, Integration' do
       end
 
       it 'is equal to a scenario with the same steps' do
-        source = "#{@background_keyword}:
-                    #{@step_keyword} step 1
-                    #{@step_keyword} step 2"
+        source = "#{BACKGROUND_KEYWORD}:
+                    #{STEP_KEYWORD} step 1
+                    #{STEP_KEYWORD} step 2"
         background = clazz.new(source)
 
-        source = "#{@scenario_keyword}:
-                    #{@step_keyword} step 1
-                    #{@step_keyword} step 2"
+        source = "#{SCENARIO_KEYWORD}:
+                    #{STEP_KEYWORD} step 1
+                    #{STEP_KEYWORD} step 2"
         scenario_1 = CukeModeler::Scenario.new(source)
 
-        source = "#{@scenario_keyword}:
-                    #{@step_keyword} step 2
-                    #{@step_keyword} step 1"
+        source = "#{SCENARIO_KEYWORD}:
+                    #{STEP_KEYWORD} step 2
+                    #{STEP_KEYWORD} step 1"
         scenario_2 = CukeModeler::Scenario.new(source)
 
 
@@ -272,23 +276,23 @@ describe 'Background, Integration' do
       end
 
       it 'is equal to an outline with the same steps' do
-        source = "#{@background_keyword}:
-                    #{@step_keyword} step 1
-                    #{@step_keyword} step 2"
+        source = "#{BACKGROUND_KEYWORD}:
+                    #{STEP_KEYWORD} step 1
+                    #{STEP_KEYWORD} step 2"
         background = clazz.new(source)
 
-        source = "#{@outline_keyword}:
-                    #{@step_keyword} step 1
-                    #{@step_keyword} step 2
-                  #{@example_keyword}:
+        source = "#{OUTLINE_KEYWORD}:
+                    #{STEP_KEYWORD} step 1
+                    #{STEP_KEYWORD} step 2
+                  #{EXAMPLE_KEYWORD}:
                     | param |
                     | value |"
         outline_1 = CukeModeler::Outline.new(source)
 
-        source = "#{@outline_keyword}:
-                    #{@step_keyword} step 2
-                    #{@step_keyword} step 1
-                  #{@example_keyword}:
+        source = "#{OUTLINE_KEYWORD}:
+                    #{STEP_KEYWORD} step 2
+                    #{STEP_KEYWORD} step 1
+                  #{EXAMPLE_KEYWORD}:
                     | param |
                     | value |"
         outline_2 = CukeModeler::Outline.new(source)
@@ -304,14 +308,14 @@ describe 'Background, Integration' do
     describe 'background output' do
 
       it 'can be remade from its own output' do
-        source = "#{@background_keyword}: A background with everything it could have
+        source = "#{BACKGROUND_KEYWORD}: A background with everything it could have
 
                   Including a description
                   and then some.
 
-                    #{@step_keyword} a step
+                    #{STEP_KEYWORD} a step
                       | value |
-                    #{@step_keyword} another step
+                    #{STEP_KEYWORD} another step
                       \"\"\"
                       some string
                       \"\"\""
@@ -327,27 +331,27 @@ describe 'Background, Integration' do
       context 'from source text' do
 
         it 'can output an empty background' do
-          source = ["#{@background_keyword}:"]
+          source = ["#{BACKGROUND_KEYWORD}:"]
           source = source.join("\n")
           background = clazz.new(source)
 
           background_output = background.to_s.split("\n", -1)
 
-          expect(background_output).to eq(["#{@background_keyword}:"])
+          expect(background_output).to eq(["#{BACKGROUND_KEYWORD}:"])
         end
 
         it 'can output a background that has a name' do
-          source = ["#{@background_keyword}: test background"]
+          source = ["#{BACKGROUND_KEYWORD}: test background"]
           source = source.join("\n")
           background = clazz.new(source)
 
           background_output = background.to_s.split("\n", -1)
 
-          expect(background_output).to eq(["#{@background_keyword}: test background"])
+          expect(background_output).to eq(["#{BACKGROUND_KEYWORD}: test background"])
         end
 
         it 'can output a background that has a description' do
-          source = ["#{@background_keyword}:",
+          source = ["#{BACKGROUND_KEYWORD}:",
                     'Some description.',
                     'Some more description.']
           source = source.join("\n")
@@ -355,17 +359,17 @@ describe 'Background, Integration' do
 
           background_output = background.to_s.split("\n", -1)
 
-          expect(background_output).to eq(["#{@background_keyword}:",
+          expect(background_output).to eq(["#{BACKGROUND_KEYWORD}:",
                                            '',
                                            'Some description.',
                                            'Some more description.'])
         end
 
         it 'can output a background that has steps' do
-          source = ["#{@background_keyword}:",
-                    "#{@step_keyword} a step",
+          source = ["#{BACKGROUND_KEYWORD}:",
+                    "#{STEP_KEYWORD} a step",
                     '|value|',
-                    "#{@step_keyword} another step",
+                    "#{STEP_KEYWORD} another step",
                     '"""',
                     'some string',
                     '"""']
@@ -374,22 +378,22 @@ describe 'Background, Integration' do
 
           background_output = background.to_s.split("\n", -1)
 
-          expect(background_output).to eq(["#{@background_keyword}:",
-                                           "  #{@step_keyword} a step",
+          expect(background_output).to eq(["#{BACKGROUND_KEYWORD}:",
+                                           "  #{STEP_KEYWORD} a step",
                                            '    | value |',
-                                           "  #{@step_keyword} another step",
+                                           "  #{STEP_KEYWORD} another step",
                                            '    """',
                                            '    some string',
                                            '    """'])
         end
 
         it 'can output a background that has everything' do
-          source = ["#{@background_keyword}: A background with everything it could have",
+          source = ["#{BACKGROUND_KEYWORD}: A background with everything it could have",
                     'Including a description',
                     'and then some.',
-                    "#{@step_keyword} a step",
+                    "#{STEP_KEYWORD} a step",
                     '|value|',
-                    "#{@step_keyword} another step",
+                    "#{STEP_KEYWORD} another step",
                     '"""',
                     'some string',
                     '"""']
@@ -398,14 +402,14 @@ describe 'Background, Integration' do
 
           background_output = background.to_s.split("\n", -1)
 
-          expect(background_output).to eq(["#{@background_keyword}: A background with everything it could have",
+          expect(background_output).to eq(["#{BACKGROUND_KEYWORD}: A background with everything it could have",
                                            '',
                                            'Including a description',
                                            'and then some.',
                                            '',
-                                           "  #{@step_keyword} a step",
+                                           "  #{STEP_KEYWORD} a step",
                                            '    | value |',
-                                           "  #{@step_keyword} another step",
+                                           "  #{STEP_KEYWORD} another step",
                                            '    """',
                                            '    some string',
                                            '    """'])