cuke_modeler 1.1.1 → 1.2.0

data/testing/rspec/spec/integration/feature_file_integration_spec.rb

@@ -14,6 +14,39 @@ describe 'FeatureFile, Integration' do
 
   describe 'unique behavior' do
 
+    it 'stores the original data generated by the parsing adapter', :gherkin4 => true do
+      path = "#{@default_file_directory}/#{@default_feature_file_name}"
+      File.open(path, "w") { |file| file.puts "#{@feature_keyword}: test feature" }
+
+      feature_file = clazz.new(path)
+      data = feature_file.parsing_data
+
+      expect(data.keys).to match_array([:type, :feature, :comments])
+      expect(data[:type]).to eq(:GherkinDocument)
+    end
+
+    it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
+      path = "#{@default_file_directory}/#{@default_feature_file_name}"
+      File.open(path, "w") { |file| file.puts "#{@feature_keyword}: test feature" }
+
+      feature_file = clazz.new(path)
+      data = feature_file.parsing_data
+
+      # There is no parsing data stored above the feature level for gherkin 3.x
+      expect(data).to be_nil
+    end
+
+    it 'stores the original data generated by the parsing adapter', :gherkin2 => true do
+      path = "#{@default_file_directory}/#{@default_feature_file_name}"
+      File.open(path, "w") { |file| file.puts "#{@feature_keyword}: test feature" }
+
+      feature_file = clazz.new(path)
+      data = feature_file.parsing_data
+
+      # There is no parsing data stored above the feature level for gherkin 2.x
+      expect(data).to eq([])
+    end
+
     it 'provides its own filename when being parsed' do
       path = "#{@default_file_directory}/#{@default_feature_file_name}"
       File.open(path, "w") { |file| file.puts 'bad feature text' }
@@ -52,6 +85,97 @@ describe 'FeatureFile, Integration' do
         expect(feature_name).to eq('Test feature')
       end
 
+      it "models the feature file's comments" do
+        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"
+
+        File.open(feature_file_path, "w") { |file| file.puts source_text }
+
+        feature_file = clazz.new(feature_file_path)
+        comments = feature_file.comments.collect { |comment| comment.text }
+
+
+        expected_comments = ['# feature comment',
+                             '# background comment',
+                             '# table comment',
+                             '# table row comment',
+                             '# scenario comment',
+                             '# outline comment',
+                             '# step comment',
+                             '# table comment',
+                             '# step comment',
+                             '# doc string comment',
+                             '# example comment',
+                             '# row comment']
+
+        # gherkin 2.x 'loses' comments that are not followed by some element
+        expected_comments << '# final comment' unless Gem.loaded_specs['gherkin'].version.version[/^2/]
+
+
+        expect(comments).to match_array(expected_comments)
+      end
+
+
       # gherkin 3.x does not accept empty feature files
       context 'an empty feature file', :gherkin3 => false do
 

data/testing/rspec/spec/integration/gherkin_2_adapter_spec.rb

@@ -3,21 +3,27 @@ require "#{File.dirname(__FILE__)}/../spec_helper"
 
 describe 'Gherkin2Adapter, Integration', :gherkin2 => true do
 
-  let(:source_text) { "@tag1 @tag2 @tag3
+  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}:
 
@@ -30,33 +36,52 @@ describe 'Gherkin2Adapter, Integration', :gherkin2 => true do
                              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 |" }
-  let(:feature) { CukeModeler::Feature.new(source_text) }
+                           | value |
+                       # final comment" }
+  let(:feature_file) { path = "#{@default_file_directory}/#{@default_feature_file_name}"
+  File.open(path, "w") { |file| file.puts source_text }
+
+  CukeModeler::FeatureFile.new(path) }
+  let(:feature) { feature_file.feature }
+
 
+  it "does not store parsing data for a feature file's children" do
+    model = feature_file
+
+    expect(model.parsing_data).to eq([])
+  end
 
   it "does not store parsing data for a feature's children" do
     model = feature
 
+    expect(model.parsing_data['comments']).to be_nil
     expect(model.parsing_data['tags']).to be_nil
     expect(model.parsing_data['elements']).to be_nil
   end
@@ -64,12 +89,14 @@ describe 'Gherkin2Adapter, Integration', :gherkin2 => true do
   it "does not store parsing data for a background's children" do
     model = feature.background
 
+    expect(model.parsing_data['comments']).to be_nil
     expect(model.parsing_data['steps']).to be_nil
   end
 
   it "does not store parsing data for a scenario's children" do
     model = feature.scenarios.first
 
+    expect(model.parsing_data['comments']).to be_nil
     expect(model.parsing_data['tags']).to be_nil
     expect(model.parsing_data['steps']).to be_nil
   end
@@ -77,6 +104,7 @@ describe 'Gherkin2Adapter, Integration', :gherkin2 => true do
   it "does not store parsing data for an outline's children" do
     model = feature.outlines.first
 
+    expect(model.parsing_data['comments']).to be_nil
     expect(model.parsing_data['tags']).to be_nil
     expect(model.parsing_data['steps']).to be_nil
     expect(model.parsing_data['examples']).to be_nil
@@ -85,6 +113,7 @@ describe 'Gherkin2Adapter, Integration', :gherkin2 => true do
   it "does not store parsing data for an example's children" do
     model = feature.outlines.first.examples.first
 
+    expect(model.parsing_data['comments']).to be_nil
     expect(model.parsing_data['tags']).to be_nil
     expect(model.parsing_data['rows']).to be_nil
   end
@@ -92,18 +121,21 @@ describe 'Gherkin2Adapter, Integration', :gherkin2 => true do
   it "does not store parsing data for an example row's children" do
     model = feature.outlines.first.examples.first.rows.first
 
+    expect(model.parsing_data['comments']).to be_nil
     expect(model.parsing_data['cells']).to be_nil
   end
 
   it "does not store parsing data for a step's children, table" do
     model = feature.outlines.first.steps.first
 
+    expect(model.parsing_data['comments']).to be_nil
     expect(model.parsing_data['rows']).to be_nil
   end
 
   it "does not store parsing data for a step's children, doc string" do
     model = feature.outlines.first.steps.last
 
+    expect(model.parsing_data['comments']).to be_nil
     expect(model.parsing_data['doc_string']).to be_nil
   end
 
@@ -116,6 +148,7 @@ describe 'Gherkin2Adapter, Integration', :gherkin2 => true do
   it "does not store parsing data for a table row's children" do
     model = feature.outlines.first.steps.first.block.rows.first
 
+    expect(model.parsing_data['comments']).to be_nil
     expect(model.parsing_data['cells']).to be_nil
   end
 

data/testing/rspec/spec/integration/gherkin_3_adapter_spec.rb

@@ -3,21 +3,27 @@ require "#{File.dirname(__FILE__)}/../spec_helper"
 
 describe 'Gherkin3Adapter, Integration', :gherkin3 => true do
 
-  let(:source_text) { "@tag1 @tag2 @tag3
+  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}:
 
@@ -30,33 +36,52 @@ describe 'Gherkin3Adapter, Integration', :gherkin3 => true do
                              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 |" }
-  let(:feature) { CukeModeler::Feature.new(source_text) }
+                           | value |
+                       # final comment" }
+  let(:feature_file) { path = "#{@default_file_directory}/#{@default_feature_file_name}"
+  File.open(path, "w") { |file| file.puts source_text }
+
+  CukeModeler::FeatureFile.new(path) }
+  let(:feature) { feature_file.feature }
+
 
+  it "does not store parsing data for a feature file's children" do
+    model = feature_file
+
+    expect(model.parsing_data).to be_nil
+  end
 
   it "does not store parsing data for a feature's children" do
     model = feature
 
+    expect(model.parsing_data[:comments]).to be_nil
     expect(model.parsing_data[:tags]).to be_nil
     expect(model.parsing_data[:scenarioDefinitions]).to be_nil
     expect(model.parsing_data[:background]).to be_nil
@@ -121,5 +146,4 @@ describe 'Gherkin3Adapter, Integration', :gherkin3 => true do
     expect(model.parsing_data[:cells]).to be_nil
   end
 
-
 end

data/testing/rspec/spec/integration/gherkin_4_adapter_spec.rb

@@ -3,21 +3,27 @@ require "#{File.dirname(__FILE__)}/../spec_helper"
 
 describe 'Gherkin4Adapter, Integration', :gherkin4 => true do
 
-  let(:source_text) { "@tag1 @tag2 @tag3
+  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}:
 
@@ -30,29 +36,48 @@ describe 'Gherkin4Adapter, Integration', :gherkin4 => true do
                              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 |" }
-  let(:feature) { CukeModeler::Feature.new(source_text) }
+                           | value |
+                       # final comment" }
+  let(:feature_file) { path = "#{@default_file_directory}/#{@default_feature_file_name}"
+  File.open(path, "w") { |file| file.puts source_text }
+
+  CukeModeler::FeatureFile.new(path) }
+  let(:feature) { feature_file.feature }
+
 
+  it "does not store parsing data for a feature file's children" do
+    model = feature_file
+
+    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

data/testing/rspec/spec/integration/parsing_integration_spec.rb

@@ -46,6 +46,7 @@ describe 'Parsing, Integration' do
       expect { nodule.parse_text(5) }.to raise_error(ArgumentError, /Fixnum/)
     end
 
+    # todo - Stop doing this. Just return a feature file rooted AST.
     it 'returns an Array' do
       result = nodule.parse_text("#{@feature_keyword}:")
       expect(result).to be_a(Array)