cuke_modeler 0.2.0 → 0.3.0

data/lib/cuke_modeler/example.rb

@@ -123,7 +123,7 @@ module CukeModeler
     end
 
     def populate_example_parameters
-      @parameters = @row_elements.first.cells
+      @parameters = @row_elements.first.cells unless @row_elements.empty?
     end
 
     def populate_example_rows

data/lib/cuke_modeler/parsing.rb

@@ -6,79 +6,108 @@ rescue LoadError => e
 end
 
 # Parsing will be with an 'adapter' appropriate to the version of the 'gherkin' gem that has been activated
-if Gem.loaded_specs['gherkin'].version.version[/^3/]
+case
+  when Gem.loaded_specs['gherkin'].version.version[/^4/]
 
-  require 'gherkin/parser'
-  require 'cuke_modeler/adapters/gherkin_3_adapter'
+    require 'gherkin/parser'
+    require 'cuke_modeler/adapters/gherkin_4_adapter'
+
+
+    module CukeModeler
 
+      module Parsing
+        class << self
 
-  module CukeModeler
+          def parse_text(source_text, filename = 'cuke_modeler_fake_file.feature')
+            raise(ArgumentError, "Cannot parse #{source_text.class} objects. Strings only.") unless source_text.is_a?(String)
 
-    module Parsing
-      class << self
+            begin
+              parsed_result = Gherkin::Parser.new.parse(source_text)
+            rescue => e
+              raise(ArgumentError, "Error encountered while parsing '#{filename}'\n#{e.class} - #{e.message}")
+            end
 
-        def parse_text(source_text, filename = 'cuke_modeler_fake_file.feature')
-          raise(ArgumentError, "Cannot parse #{source_text.class} objects. Strings only.") unless source_text.is_a?(String)
+            adapted_result = CukeModeler::Gherkin4Adapter.new.adapt(parsed_result)
 
-          begin
-            parsed_result = Gherkin::Parser.new.parse(source_text)
-          rescue => e
-            raise(ArgumentError, "Error encountered while parsing '#{filename}'\n#{e.class} - #{e.message}")
+            adapted_result
           end
+        end
+      end
+    end
+
+  when Gem.loaded_specs['gherkin'].version.version[/^3/]
+
+    require 'gherkin/parser'
+    require 'cuke_modeler/adapters/gherkin_3_adapter'
+
+
+    module CukeModeler
 
-          adapted_result = CukeModeler::Gherkin3Adapter.new.adapt(parsed_result)
+      module Parsing
+        class << self
 
-          adapted_result
+          def parse_text(source_text, filename = 'cuke_modeler_fake_file.feature')
+            raise(ArgumentError, "Cannot parse #{source_text.class} objects. Strings only.") unless source_text.is_a?(String)
+
+            begin
+              parsed_result = Gherkin::Parser.new.parse(source_text)
+            rescue => e
+              raise(ArgumentError, "Error encountered while parsing '#{filename}'\n#{e.class} - #{e.message}")
+            end
+
+            adapted_result = CukeModeler::Gherkin3Adapter.new.adapt(parsed_result)
+
+            adapted_result
+          end
         end
       end
     end
-  end
 
-else
+  else
 
-  require 'stringio'
-  require 'gherkin/formatter/json_formatter'
-  require 'gherkin'
-  require 'json'
-  require 'multi_json'
-  require 'cuke_modeler/adapters/gherkin_2_adapter'
+    require 'stringio'
+    require 'gherkin/formatter/json_formatter'
+    require 'gherkin'
+    require 'json'
+    require 'multi_json'
+    require 'cuke_modeler/adapters/gherkin_2_adapter'
 
 
-  module CukeModeler
+    module CukeModeler
 
-    # A module providing source text parsing functionality.
+      # A module providing source text parsing functionality.
 
-    module Parsing
+      module Parsing
 
-      class << self
+        class << self
 
-        # Parses the Cucumber feature given in *source_text* and returns an array
-        # containing the hash representation of its logical structure.
-        def parse_text(source_text, filename = 'cuke_modeler_fake_file.feature')
-          raise(ArgumentError, "Cannot parse #{source_text.class} objects. Strings only.") unless source_text.is_a?(String)
+          # Parses the Cucumber feature given in *source_text* and returns an array
+          # containing the hash representation of its logical structure.
+          def parse_text(source_text, filename = 'cuke_modeler_fake_file.feature')
+            raise(ArgumentError, "Cannot parse #{source_text.class} objects. Strings only.") unless source_text.is_a?(String)
 
-          io = StringIO.new
-          formatter = Gherkin::Formatter::JSONFormatter.new(io)
-          parser = Gherkin::Parser::Parser.new(formatter)
+            io = StringIO.new
+            formatter = Gherkin::Formatter::JSONFormatter.new(io)
+            parser = Gherkin::Parser::Parser.new(formatter)
 
-          begin
-            parser.parse(source_text, filename, 0)
-          rescue => e
-            raise(ArgumentError, "Error encountered while parsing '#{filename}'\n#{e.class} - #{e.message}")
-          end
+            begin
+              parser.parse(source_text, filename, 0)
+            rescue => e
+              raise(ArgumentError, "Error encountered while parsing '#{filename}'\n#{e.class} - #{e.message}")
+            end
+
+            formatter.done
 
-          formatter.done
 
+            parsed_result = MultiJson.load(io.string)
+            adapted_result = CukeModeler::Gherkin2Adapter.new.adapt(parsed_result)
 
-          parsed_result = MultiJson.load(io.string)
-          adapted_result = CukeModeler::Gherkin2Adapter.new.adapt(parsed_result)
+            adapted_result
+          end
 
-          adapted_result
         end
 
       end
-
     end
-  end
 
 end

data/lib/cuke_modeler/version.rb

@@ -1,3 +1,3 @@
 module CukeModeler
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/spec_helper.rb

@@ -14,10 +14,16 @@ require "#{File.dirname(__FILE__)}/unit/sourced_element_unit_specs"
 require "#{File.dirname(__FILE__)}/unit/raw_element_unit_specs"
 
 RSpec.configure do |config|
-  if Gem.loaded_specs['gherkin'].version.version[/^3/]
-    config.filter_run_excluding :gherkin2 => true
-  else
-    config.filter_run_excluding :gherkin3 => true
+  case
+    when Gem.loaded_specs['gherkin'].version.version[/^4/]
+      config.filter_run_excluding :gherkin2 => true,
+                                  :gherkin3 => true
+    when Gem.loaded_specs['gherkin'].version.version[/^3/]
+      config.filter_run_excluding :gherkin2 => true,
+                                  :gherkin4 => true
+    else
+      config.filter_run_excluding :gherkin3 => true,
+                                  :gherkin4 => true
   end
 
   config.before(:all) do

data/spec/unit/background_unit_spec.rb

@@ -4,16 +4,16 @@ SimpleCov.command_name('Background') unless RUBY_VERSION.to_s < '1.9.0'
 
 describe 'Background, Unit' do
 
-  clazz = CukeModeler::Background
+  let(:clazz) { CukeModeler::Background }
 
-  it_should_behave_like 'a feature element', clazz
-  it_should_behave_like 'a nested element', clazz
-  it_should_behave_like 'a containing element', clazz
-  it_should_behave_like 'a bare bones element', clazz
-  it_should_behave_like 'a prepopulated element', clazz
-  it_should_behave_like 'a test element', clazz
-  it_should_behave_like 'a sourced element', clazz
-  it_should_behave_like 'a raw element', clazz
+  it_should_behave_like 'a feature element'
+  it_should_behave_like 'a nested element'
+  it_should_behave_like 'a containing element'
+  it_should_behave_like 'a bare bones element'
+  it_should_behave_like 'a prepopulated element'
+  it_should_behave_like 'a test element'
+  it_should_behave_like 'a sourced element'
+  it_should_behave_like 'a raw element'
 
   it 'can be parsed from stand alone text' do
     source = 'Background: test background'
@@ -30,6 +30,14 @@ describe 'Background, Unit' do
     expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_background\.feature'/)
   end
 
+  it 'stores the original data generated by the parsing adapter', :gherkin4 => true do
+    background = clazz.new('Background: test background')
+    raw_data = background.raw_element
+
+    expect(raw_data.keys).to match_array([:type, :location, :keyword, :name, :steps])
+    expect(raw_data[:type]).to eq(:Background)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     background = clazz.new('Background: test background')
     raw_data = background.raw_element

data/spec/unit/bare_bones_unit_specs.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
-shared_examples_for 'a bare bones element' do |clazz|
+shared_examples_for 'a bare bones element' do
+
+  # clazz must be defined by the calling file
 
   before(:each) do
     @element = clazz.new

data/spec/unit/containing_element_unit_specs.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
-shared_examples_for 'a containing element' do |clazz|
+shared_examples_for 'a containing element' do
+
+  # clazz must be defined by the calling file
 
   before(:each) do
     @element = clazz.new

data/spec/unit/directory_unit_spec.rb

@@ -4,12 +4,12 @@ SimpleCov.command_name('Directory') unless RUBY_VERSION.to_s < '1.9.0'
 
 describe 'Directory, Unit' do
 
-  clazz = CukeModeler::Directory
+  let(:clazz) { CukeModeler::Directory }
 
-  it_should_behave_like 'a nested element', clazz
-  it_should_behave_like 'a containing element', clazz
-  it_should_behave_like 'a bare bones element', clazz
-  it_should_behave_like 'a prepopulated element', clazz
+  it_should_behave_like 'a nested element'
+  it_should_behave_like 'a containing element'
+  it_should_behave_like 'a bare bones element'
+  it_should_behave_like 'a prepopulated element'
 
   before(:each) do
     @directory = clazz.new

data/spec/unit/doc_string_unit_spec.rb

@@ -4,12 +4,12 @@ SimpleCov.command_name('DocString') unless RUBY_VERSION.to_s < '1.9.0'
 
 describe 'DocString, Unit' do
 
-  clazz = CukeModeler::DocString
+  let(:clazz) { CukeModeler::DocString }
 
-  it_should_behave_like 'a nested element', clazz
-  it_should_behave_like 'a bare bones element', clazz
-  it_should_behave_like 'a prepopulated element', clazz
-  it_should_behave_like 'a raw element', clazz
+  it_should_behave_like 'a nested element'
+  it_should_behave_like 'a bare bones element'
+  it_should_behave_like 'a prepopulated element'
+  it_should_behave_like 'a raw element'
 
   it 'can be parsed from stand alone text' do
     source = "\"\"\"\nsome doc string\n\"\"\""
@@ -28,6 +28,14 @@ describe 'DocString, Unit' do
     expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_doc_string\.feature'/)
   end
 
+  it 'stores the original data generated by the parsing adapter', :gherkin4 => true do
+    doc_string = clazz.new("\"\"\"\nsome doc string\n\"\"\"")
+    raw_data = doc_string.raw_element
+
+    expect(raw_data.keys).to match_array([:type, :location, :content])
+    expect(raw_data[:type]).to eq(:DocString)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     doc_string = clazz.new("\"\"\"\nsome doc string\n\"\"\"")
     raw_data = doc_string.raw_element

data/spec/unit/example_unit_spec.rb

@@ -4,16 +4,16 @@ SimpleCov.command_name('Example') unless RUBY_VERSION.to_s < '1.9.0'
 
 describe 'Example, Unit' do
 
-  clazz = CukeModeler::Example
+  let(:clazz) { CukeModeler::Example }
 
-  it_should_behave_like 'a feature element', clazz
-  it_should_behave_like 'a nested element', clazz
-  it_should_behave_like 'a tagged element', clazz
-  it_should_behave_like 'a bare bones element', clazz
-  it_should_behave_like 'a prepopulated element', clazz
-  it_should_behave_like 'a sourced element', clazz
-  it_should_behave_like 'a containing element', clazz
-  it_should_behave_like 'a raw element', clazz
+  it_should_behave_like 'a feature element'
+  it_should_behave_like 'a nested element'
+  it_should_behave_like 'a tagged element'
+  it_should_behave_like 'a bare bones element'
+  it_should_behave_like 'a prepopulated element'
+  it_should_behave_like 'a sourced element'
+  it_should_behave_like 'a containing element'
+  it_should_behave_like 'a raw element'
 
 
   it 'can be parsed from stand alone text' do
@@ -29,12 +29,47 @@ describe 'Example, Unit' do
     @element.name.should == 'test example'
   end
 
+  # todo - add more tests like this to the 'barebones' test set
+  it 'can be instantiated with the minimum viable Gherkin', :gherkin4 => true do
+    source = ['Examples:']
+    source = source.join("\n")
+
+    expect { @element = clazz.new(source) }.to_not raise_error
+  end
+
+  # todo - add more tests like this to the 'barebones' test set
+  it 'can be instantiated with the minimum viable Gherkin', :gherkin3 => true do
+    source = ['Examples:',
+              '|param|',
+              '|value|']
+    source = source.join("\n")
+
+    expect { @element = clazz.new(source) }.to_not raise_error
+  end
+
+  # todo - add more tests like this to the 'barebones' test set
+  it 'can be instantiated with the minimum viable Gherkin', :gherkin2 => true do
+    source = ['Examples:',
+              '|param|']
+    source = source.join("\n")
+
+    expect { @element = clazz.new(source) }.to_not raise_error
+  end
+
   it 'provides a descriptive filename when being parsed from stand alone text' do
     source = 'bad example text'
 
     expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_example\.feature'/)
   end
 
+  it 'stores the original data generated by the parsing adapter', :gherkin4 => true do
+    example = clazz.new("Examples: test example\n|param|\n|value|")
+    raw_data = example.raw_element
+
+    expect(raw_data.keys).to match_array([:type, :tags, :location, :keyword, :name, :tableHeader, :tableBody])
+    expect(raw_data[:type]).to eq(:Examples)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     example = clazz.new("Examples: test example\n|param|\n|value|")
     raw_data = example.raw_element

data/spec/unit/feature_element_unit_spec.rb

@@ -4,12 +4,12 @@ SimpleCov.command_name('FeatureElement') unless RUBY_VERSION.to_s < '1.9.0'
 
 describe 'FeatureElement, Unit' do
 
-  clazz = CukeModeler::FeatureElement
+  let(:clazz) { CukeModeler::FeatureElement }
 
-  it_should_behave_like 'a feature element', clazz
-  it_should_behave_like 'a nested element', clazz
-  it_should_behave_like 'a prepopulated element', clazz
-  it_should_behave_like 'a bare bones element', clazz
+  it_should_behave_like 'a feature element'
+  it_should_behave_like 'a nested element'
+  it_should_behave_like 'a prepopulated element'
+  it_should_behave_like 'a bare bones element'
 
 
   before(:each) do

data/spec/unit/feature_element_unit_specs.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
-shared_examples_for 'a feature element' do |clazz|
+shared_examples_for 'a feature element' do
+
+  # clazz must be defined by the calling file
 
   before(:each) do
     @element = clazz.new

data/spec/unit/feature_file_unit_spec.rb

@@ -4,12 +4,12 @@ SimpleCov.command_name('FeatureFile') unless RUBY_VERSION.to_s < '1.9.0'
 
 describe 'FeatureFile, Unit' do
 
-  clazz = CukeModeler::FeatureFile
+  let(:clazz) { CukeModeler::FeatureFile }
 
-  it_should_behave_like 'a nested element', clazz
-  it_should_behave_like 'a containing element', clazz
-  it_should_behave_like 'a bare bones element', clazz
-  it_should_behave_like 'a prepopulated element', clazz
+  it_should_behave_like 'a nested element'
+  it_should_behave_like 'a containing element'
+  it_should_behave_like 'a bare bones element'
+  it_should_behave_like 'a prepopulated element'
 
 
   before(:each) do

data/spec/unit/feature_unit_spec.rb

@@ -4,16 +4,16 @@ SimpleCov.command_name('Feature') unless RUBY_VERSION.to_s < '1.9.0'
 
 describe 'Feature, Unit' do
 
-  clazz = CukeModeler::Feature
+  let(:clazz) { CukeModeler::Feature }
 
-  it_should_behave_like 'a feature element', clazz
-  it_should_behave_like 'a nested element', clazz
-  it_should_behave_like 'a containing element', clazz
-  it_should_behave_like 'a tagged element', clazz
-  it_should_behave_like 'a bare bones element', clazz
-  it_should_behave_like 'a prepopulated element', clazz
-  it_should_behave_like 'a sourced element', clazz
-  it_should_behave_like 'a raw element', clazz
+  it_should_behave_like 'a feature element'
+  it_should_behave_like 'a nested element'
+  it_should_behave_like 'a containing element'
+  it_should_behave_like 'a tagged element'
+  it_should_behave_like 'a bare bones element'
+  it_should_behave_like 'a prepopulated element'
+  it_should_behave_like 'a sourced element'
+  it_should_behave_like 'a raw element'
 
   before(:each) do
     @feature = clazz.new
@@ -34,6 +34,14 @@ describe 'Feature, Unit' do
     expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_feature\.feature'/)
   end
 
+  it 'stores the original data generated by the parsing adapter', :gherkin4 => true do
+    feature = clazz.new('Feature: test feature')
+    raw_data = feature.raw_element
+
+    expect(raw_data.keys).to match_array([:type, :tags, :location, :language, :keyword, :name, :children])
+    expect(raw_data[:type]).to eq(:Feature)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     feature = clazz.new('Feature: test feature')
     raw_data = feature.raw_element