cuke_modeler 1.3.0 → 2.1.0

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

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Table, Integration' do
@@ -21,28 +21,32 @@ describe 'Table, Integration' do
       expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_table\.feature'/)
     end
 
-    it 'stores the original data generated by the parsing adapter', :gherkin4 => true do
-      table = clazz.new("| a table |")
-      data = table.parsing_data
+    describe 'parsing data' do
 
-      expect(data.keys).to match_array([:type, :location, :rows])
-      expect(data[:type]).to eq(:DataTable)
-    end
+      it 'stores the original data generated by the parsing adapter', :if => gherkin?(6, 7, 8, 9) do
+        table = clazz.new("| a table |")
+        data = table.parsing_data
 
-    it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
-      table = clazz.new("| a table |")
-      data = table.parsing_data
+        expect(data.keys).to match_array([:location, :rows])
+        expect(data[:location][:line]).to eq(5)
+      end
 
-      expect(data.keys).to match_array([:type, :location, :rows])
-      expect(data[:type]).to eq(:DataTable)
-    end
+      it 'stores the original data generated by the parsing adapter', :if => gherkin?(3, 4, 5) do
+        table = clazz.new("| a table |")
+        data = table.parsing_data
 
-    it 'stores the original data generated by the parsing adapter', :gherkin2 => true do
-      table = clazz.new("| a table |")
-      data = table.parsing_data
+        expect(data.keys).to match_array([:type, :location, :rows])
+        expect(data[:type]).to eq(:DataTable)
+      end
+
+      it 'stores the original data generated by the parsing adapter', :if => gherkin?(2) do
+        table = clazz.new("| a table |")
+        data = table.parsing_data
+
+        # There is no parsing data for the table itself, only its rows
+        expect(data).to match_array([])
+      end
 
-      # There is no parsing data for the table itself, only its rows
-      expect(data).to match_array([])
     end
 
     it 'can be instantiated with the minimum viable Gherkin' do
@@ -74,10 +78,10 @@ describe 'Table, Integration' do
       context 'from source text' do
 
         it "models the table's source line" do
-          source_text = "#{@feature_keyword}:
+          source_text = "#{FEATURE_KEYWORD}:
 
-                           #{@scenario_keyword}:
-                             #{@step_keyword} step
+                           #{SCENARIO_KEYWORD}:
+                             #{STEP_KEYWORD} step
                                | value |"
           table = CukeModeler::Feature.new(source_text).tests.first.steps.first.block
 
@@ -125,10 +129,10 @@ describe 'Table, Integration' do
 
 
       let(:test_directory) { CukeModeler::FileHelper.create_directory }
-      let(:source_gherkin) { "#{@feature_keyword}: Test feature
+      let(:source_gherkin) { "#{FEATURE_KEYWORD}: Test feature
 
-                              #{@scenario_keyword}: Test test
-                                #{@step_keyword} a step:
+                              #{SCENARIO_KEYWORD}: Test test
+                                #{STEP_KEYWORD} a step:
                                   | a | table |"
       }
 
@@ -157,10 +161,10 @@ describe 'Table, Integration' do
       context 'a table that is part of a scenario' do
 
         let(:test_directory) { CukeModeler::FileHelper.create_directory }
-        let(:source_gherkin) { "#{@feature_keyword}: Test feature
+        let(:source_gherkin) { "#{FEATURE_KEYWORD}: Test feature
 
-                                #{@scenario_keyword}: Test test
-                                  #{@step_keyword} a step:
+                                #{SCENARIO_KEYWORD}: Test test
+                                  #{STEP_KEYWORD} a step:
                                     | a | table |"
         }
 
@@ -179,12 +183,12 @@ describe 'Table, Integration' do
       context 'a table that is part of an outline' do
 
         let(:test_directory) { CukeModeler::FileHelper.create_directory }
-        let(:source_gherkin) { "#{@feature_keyword}: Test feature
+        let(:source_gherkin) { "#{FEATURE_KEYWORD}: Test feature
 
-                                #{@outline_keyword}: Test outline
-                                  #{@step_keyword} a step:
+                                #{OUTLINE_KEYWORD}: Test outline
+                                  #{STEP_KEYWORD} a step:
                                     | a | table |
-                                #{@example_keyword}:
+                                #{EXAMPLE_KEYWORD}:
                                   | param |
                                   | value |"
         }
@@ -204,10 +208,10 @@ describe 'Table, Integration' do
       context 'a table that is part of a background' 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:
                                     | a | table |"
         }
 

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

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/../spec_helper"
+require "#{File.dirname(__FILE__)}/../../spec_helper"
 
 
 describe 'Tag, Integration' do
@@ -43,28 +43,48 @@ describe 'Tag, Integration' do
       expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_tag\.feature'/)
     end
 
-    it 'stores the original data generated by the parsing adapter', :gherkin4 => true do
-      tag = clazz.new('@a_tag')
-      data = tag.parsing_data
+    describe 'parsing data' do
 
-      expect(data.keys).to match_array([:type, :location, :name])
-      expect(data[:type]).to eq(:Tag)
-    end
+      it 'stores the original data generated by the parsing adapter', :if => gherkin?(8, 9) do
+        tag = clazz.new('@a_tag')
+        data = tag.parsing_data
 
-    it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
-      tag = clazz.new('@a_tag')
-      data = tag.parsing_data
+        expect(data.keys).to match_array([:location, :name, :id])
+        expect(data[:name]).to eq('@a_tag')
+      end
 
-      expect(data.keys).to match_array([:type, :location, :name])
-      expect(data[:type]).to eq('Tag')
-    end
+      it 'stores the original data generated by the parsing adapter', :if => gherkin?(6, 7) do
+        tag = clazz.new('@a_tag')
+        data = tag.parsing_data
 
-    it 'stores the original data generated by the parsing adapter', :gherkin2 => true do
-      tag = clazz.new('@a_tag')
-      data = tag.parsing_data
+        expect(data.keys).to match_array([:location, :name])
+        expect(data[:name]).to eq('@a_tag')
+      end
+
+      it 'stores the original data generated by the parsing adapter', :if => gherkin?(4, 5) do
+        tag = clazz.new('@a_tag')
+        data = tag.parsing_data
+
+        expect(data.keys).to match_array([:type, :location, :name])
+        expect(data[:type]).to eq(:Tag)
+      end
+
+      it 'stores the original data generated by the parsing adapter', :if => gherkin?(3) do
+        tag = clazz.new('@a_tag')
+        data = tag.parsing_data
+
+        expect(data.keys).to match_array([:type, :location, :name])
+        expect(data[:type]).to eq('Tag')
+      end
+
+      it 'stores the original data generated by the parsing adapter', :if => gherkin?(2) do
+        tag = clazz.new('@a_tag')
+        data = tag.parsing_data
+
+        expect(data.keys).to match_array(['name', 'line'])
+        expect(data['name']).to eq('@a_tag')
+      end
 
-      expect(data.keys).to match_array(['name', 'line'])
-      expect(data['name']).to eq('@a_tag')
     end
 
 
@@ -77,13 +97,13 @@ describe 'Tag, Integration' do
 
       let(:test_directory) { CukeModeler::FileHelper.create_directory }
       let(:source_gherkin) { "@feature_tag
-                              #{@feature_keyword}: Test feature
+                              #{FEATURE_KEYWORD}: Test feature
 
-                                #{@outline_keyword}: Test test
-                                  #{@step_keyword} a step
+                                #{OUTLINE_KEYWORD}: Test test
+                                  #{STEP_KEYWORD} a step
 
                                 @example_tag
-                                #{@example_keyword}: Test example
+                                #{EXAMPLE_KEYWORD}: Test example
                                   | a param |
                                   | a value |"
       }
@@ -114,11 +134,11 @@ describe 'Tag, Integration' do
       context 'a tag that is part of a scenario' do
 
         let(:test_directory) { CukeModeler::FileHelper.create_directory }
-        let(:source_gherkin) { "#{@feature_keyword}: Test feature
+        let(:source_gherkin) { "#{FEATURE_KEYWORD}: Test feature
 
                                   @a_tag
-                                  #{@scenario_keyword}: Test scenario
-                                    #{@step_keyword} a step"
+                                  #{SCENARIO_KEYWORD}: Test scenario
+                                    #{STEP_KEYWORD} a step"
         }
 
         let(:directory_model) { CukeModeler::Directory.new(test_directory) }
@@ -136,12 +156,12 @@ describe 'Tag, Integration' do
       context 'a tag that is part of an outline' do
 
         let(:test_directory) { CukeModeler::FileHelper.create_directory }
-        let(:source_gherkin) { "#{@feature_keyword}: Test feature
+        let(:source_gherkin) { "#{FEATURE_KEYWORD}: Test feature
 
                                 @a_tag
-                                #{@outline_keyword}: Test outline
-                                  #{@step_keyword} a step
-                                #{@example_keyword}:
+                                #{OUTLINE_KEYWORD}: Test outline
+                                  #{STEP_KEYWORD} a step
+                                #{EXAMPLE_KEYWORD}:
                                   | param |
                                   | value |"
         }
@@ -161,12 +181,12 @@ describe 'Tag, Integration' do
       context 'a tag that is part of an example' do
 
         let(:test_directory) { CukeModeler::FileHelper.create_directory }
-        let(:source_gherkin) { "#{@feature_keyword}: Test feature
+        let(:source_gherkin) { "#{FEATURE_KEYWORD}: Test feature
 
-                                #{@outline_keyword}: Test outline
-                                  #{@step_keyword} a step
+                                #{OUTLINE_KEYWORD}: Test outline
+                                  #{STEP_KEYWORD} a step
                                 @a_tag
-                                #{@example_keyword}:
+                                #{EXAMPLE_KEYWORD}:
                                   | param |
                                   | value |"
         }
@@ -205,11 +225,11 @@ describe 'Tag, Integration' do
         end
 
         it "models the tag's source line" do
-          source_text = "#{@feature_keyword}:
+          source_text = "#{FEATURE_KEYWORD}:
 
                            @a_tag
-                           #{@scenario_keyword}:
-                             #{@step_keyword} step"
+                           #{SCENARIO_KEYWORD}:
+                             #{STEP_KEYWORD} step"
           tag = CukeModeler::Feature.new(source_text).tests.first.tags.first
 
           expect(tag.source_line).to eq(3)

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

@@ -8,11 +8,24 @@ describe 'Parsing, Integration' do
 
   describe 'unique behavior' do
 
-    it 'loads the correct dialects based on the version of Gherkin used', :gherkin3 => true, :gherkin4 => true do
+    it 'will complain if using an unknown version of `gherkin`' do
+      original_version = Gem.loaded_specs['gherkin'].version
+      unknown_version  = Gem::Version.new('0.0.0')
+
+      begin
+        Gem.loaded_specs['gherkin'].instance_variable_set(:@version, unknown_version)
+
+        expect { load "#{File.dirname(__FILE__)}/../../../../lib/cuke_modeler/parsing.rb" }.to raise_error("Unknown Gherkin version: '0.0.0'")
+      ensure
+        Gem.loaded_specs['gherkin'].instance_variable_set(:@version, original_version)
+      end
+    end
+
+    it 'loads the correct dialects based on the version of Gherkin used', :unless => gherkin?(2) do
       expect(nodule.dialects).to equal(Gherkin::DIALECTS)
     end
 
-    it 'loads the correct dialects based on the version of Gherkin used', :gherkin2 => true do
+    it 'loads the correct dialects based on the version of Gherkin used', :if => gherkin?(2) do
       expect(nodule.dialects).to equal(Gherkin::I18n::LANGUAGES)
     end
 
@@ -39,7 +52,7 @@ describe 'Parsing, Integration' do
 
     it 'raises and error if given something to parse besides a string' do
       expect { nodule.parse_text(5) }.to raise_error(ArgumentError, /Text to parse must be a String but got/)
-      expect { nodule.parse_text("#{@feature_keyword}:") }.to_not raise_error
+      expect { nodule.parse_text("#{FEATURE_KEYWORD}:") }.to_not raise_error
     end
 
     it 'includes the type of object provided when raising an non-string exception' do
@@ -48,11 +61,11 @@ describe 'Parsing, Integration' do
 
     # todo - Stop doing this. Just return a feature file rooted AST. (Will require major version number change)
     it 'returns an Array' do
-      result = nodule.parse_text("#{@feature_keyword}:")
+      result = nodule.parse_text("#{FEATURE_KEYWORD}:")
       expect(result).to be_a(Array)
     end
 
-    it 'raises and error if an error is encountered while parsing text' do
+    it 'raises an error if an error is encountered while parsing text' do
       expect { nodule.parse_text('bad file') }.to raise_error(ArgumentError, /Error encountered while parsing '.*'/)
     end
 
@@ -60,6 +73,10 @@ describe 'Parsing, Integration' do
       expect { nodule.parse_text('bad file', 'file foo.txt') }.to raise_error(/'file foo\.txt'/)
     end
 
+    it 'has a default file name used while parsing if one is not provided' do
+      expect { nodule.parse_text('bad file') }.to raise_error(ArgumentError, /'cuke_modeler_fake_file\.feature'/)
+    end
+
     it 'includes the underlying error message in the error that it raises' do
       begin
         $old_method = CukeModeler::Parsing.method(:parsing_method)
@@ -96,8 +113,29 @@ describe 'Parsing, Integration' do
 
     end
 
-    it 'has a default file name if one is not provided' do
-      expect { nodule.parse_text('bad file') }.to raise_error(ArgumentError, /'cuke_modeler_fake_file\.feature'/)
+    describe 'parsing invalid Gherkin' do
+
+      it 'correctly bubbles up parsing errors', :if => gherkin?(6, 7, 8, 9) do
+        expect { nodule.parse_text('bad file') }.to raise_error(/RuntimeError.*#EOF/)
+      end
+
+      it 'correctly bubbles up parsing errors', :if => gherkin?(4, 5) do
+        expect { nodule.parse_text('bad file') }.to raise_error(/Gherkin::CompositeParserException.*#EOF/m)
+      end
+
+      it 'correctly bubbles up parsing errors', :if => gherkin?(3) do
+        expect { nodule.parse_text('bad file') }.to raise_error(/Gherkin::CompositeParserException.*unexpected end of file/m)
+      end
+
+      it 'correctly bubbles up parsing errors', :if => gherkin?(2) do
+        # A different error is thrown on JRuby
+        if RUBY_PLATFORM == "java"
+          expect { nodule.parse_text('bad file') }.to raise_error(/Java::GherkinLexer.*_FEATURE_END_/m)
+        else
+          expect { nodule.parse_text('bad file') }.to raise_error(/Gherkin::Lexer::LexingError.*error on line 1/)
+        end
+      end
+
     end
 
   end

data/testing/rspec/spec/spec_helper.rb

@@ -25,66 +25,102 @@ require "#{this_dir}/unit/shared/keyworded_models_unit_specs"
 
 require "#{this_dir}/../../dialect_helper"
 require "#{this_dir}/../../file_helper"
+require "#{this_dir}/../../helper_methods"
 
-# Use a fake dialect for testing in order to avoid hard coded language assumptions in the
-# implementation. Only possible with newer versions of Gherkin.
-if Gem.loaded_specs['gherkin'].version.version[/^2\./]
-  CukeModeler::DialectHelper.set_dialect(Gherkin::I18n::LANGUAGES['en'])
-  CukeModeler::Parsing.dialect = 'en'
-else
-  dialect_file_path = "#{this_dir}/../../test_languages.json"
-  test_dialects = JSON.parse File.open(dialect_file_path, 'r:UTF-8').read
+require 'rubygems/mock_gem_ui'
 
-  Gherkin::DIALECTS.merge!(test_dialects)
 
+# Use a random dialect for testing in order to avoid hard coded language assumptions in the
+# implementation and making the test dialect the default dialect so that language headers
+# aren't needed for all of the test code. Only possible with some versions of Gherkin.
 
-  # Making the test dialect the default dialect so that language headers aren't
-  # needed for all of the test code.
-  module Gherkin
-    class Parser
+gherkin_major_version = Gem.loaded_specs['gherkin'].version.version.match(/^(\d+)\./)[1].to_i
 
-      alias_method :original_parse, :parse
+case gherkin_major_version
+  when 8, 9
+    # TODO: choose randomly from Gherkin::DIALECTS once I figure out how to handle encodings...
+    test_dialect = ['en', 'en-lol', 'en-pirate', 'en-Scouse'].sample
+    puts "Testing with dialect '#{test_dialect}'..."
 
-      def parse(token_scanner, token_matcher = TokenMatcher.new('cm-test'))
-        original_parse(token_scanner, token_matcher)
+    CukeModeler::DialectHelper.set_dialect(Gherkin::DIALECTS[test_dialect])
+    CukeModeler::Parsing.dialect = test_dialect
+
+    module Gherkin
+      class << self
+        alias_method :original_from_source, :from_source
+
+        def from_source(uri, data, options = {})
+          options[:default_dialect] ||= CukeModeler::Parsing.dialect
+          original_from_source(uri, data, options)
+        end
+      end
+    end
+  when 6, 7
+    # TODO: choose randomly from Gherkin::DIALECTS once I figure out how to handle encodings...
+    test_dialect = ['en', 'en-lol', 'en-pirate', 'en-Scouse'].sample
+    puts "Testing with dialect '#{test_dialect}'..."
+
+    CukeModeler::DialectHelper.set_dialect(Gherkin::DIALECTS[test_dialect])
+    CukeModeler::Parsing.dialect = test_dialect
+
+    module Gherkin
+      class Gherkin
+        class << self
+          alias_method :original_from_source, :from_source
+
+          def from_source(uri, data, options = {})
+            options[:default_dialect] ||= CukeModeler::Parsing.dialect
+            original_from_source(uri, data, options)
+          end
+        end
       end
+    end
+  when 3, 4, 5
+# TODO: stop using test dialect and just randomize for all version of `gherkin`
+    dialect_file_path = "#{this_dir}/../../test_languages.json"
+    test_dialects = JSON.parse File.open(dialect_file_path, 'r:UTF-8').read
+
+    Gherkin::DIALECTS.merge!(test_dialects)
+
 
+    module Gherkin
+      class Parser
+
+        alias_method :original_parse, :parse
+
+        def parse(token_scanner, token_matcher = TokenMatcher.new('cm-test'))
+          original_parse(token_scanner, token_matcher)
+        end
+
+      end
     end
-  end
 
-  CukeModeler::DialectHelper.set_dialect(test_dialects['cm-test'])
-  CukeModeler::Parsing.dialect = 'cm-test'
+    CukeModeler::DialectHelper.set_dialect(test_dialects['cm-test'])
+    CukeModeler::Parsing.dialect = 'cm-test'
+  when 2
+    CukeModeler::DialectHelper.set_dialect(Gherkin::I18n::LANGUAGES['en'])
+    CukeModeler::Parsing.dialect = 'en'
+  else
+    raise("Unknown Gherkin major version: '#{gherkin_major_version}'")
 end
 
 
 RSpec.configure do |config|
-  case Gem.loaded_specs['gherkin'].version.version
-    when /^[54]\./
-      config.filter_run_excluding :gherkin2 => true,
-                                  :gherkin3 => true,
-                                  :gherkin4 => false
-    when /^3\./
-      config.filter_run_excluding :gherkin2 => true,
-                                  :gherkin3 => false,
-                                  :gherkin4 => true
-    else
-      config.filter_run_excluding :gherkin2 => false,
-                                  :gherkin3 => true,
-                                  :gherkin4 => true
-  end
 
-  config.before(:all) do
-    @feature_keyword = CukeModeler::DialectHelper.feature_keyword
-    @background_keyword = CukeModeler::DialectHelper.background_keyword
-    @scenario_keyword = CukeModeler::DialectHelper.scenario_keyword
-    @outline_keyword = CukeModeler::DialectHelper.outline_keyword
-    @example_keyword = CukeModeler::DialectHelper.example_keyword
-    @step_keyword = CukeModeler::DialectHelper.step_keyword
-    @given_keyword = CukeModeler::DialectHelper.given_keyword
-    @then_keyword = CukeModeler::DialectHelper.then_keyword
+  include CukeModeler::HelperMethods
+
+  config.before(:suite) do
+    FEATURE_KEYWORD = CukeModeler::DialectHelper.feature_keyword
+    BACKGROUND_KEYWORD = CukeModeler::DialectHelper.background_keyword
+    SCENARIO_KEYWORD = CukeModeler::DialectHelper.scenario_keyword
+    OUTLINE_KEYWORD = CukeModeler::DialectHelper.outline_keyword
+    EXAMPLE_KEYWORD = CukeModeler::DialectHelper.example_keyword
+    STEP_KEYWORD = CukeModeler::DialectHelper.step_keyword
+    GIVEN_KEYWORD = CukeModeler::DialectHelper.given_keyword
+    THEN_KEYWORD = CukeModeler::DialectHelper.then_keyword
   end
 
-  config.after(:all) do
+  config.after(:suite) do
     CukeModeler::FileHelper.created_directories.each do |dir_path|
       FileUtils.remove_entry(dir_path, true)
     end