cuke_modeler 1.3.0 → 1.4.0

data/lib/cuke_modeler/parsing.rb

@@ -11,19 +11,40 @@ module CukeModeler
     begin
       require 'gherkin'
     rescue LoadError
-      require 'gherkin/parser'
+      begin
+        require 'gherkin/parser'
+      rescue LoadError
+        # Gherkin 6.x
+        require 'gherkin/gherkin'
+      end
     end
 
 
     # The *gherkin* gem loads differently and has different grammar rules across major versions. Parsing
     # will be done with an 'adapter' appropriate to the version of the *gherkin* gem that has been activated.
 
-    case Gem.loaded_specs['gherkin'].version.version
+    gherkin_version = Gem.loaded_specs['gherkin'].version.version
+
+    case gherkin_version
+      when /^6\./
+        require 'gherkin/gherkin'
+        require 'cuke_modeler/adapters/gherkin_6_adapter'
+
+        def self.parsing_method(source_text, filename)
+          messages = Gherkin::Gherkin.from_source(filename, source_text, {:default_dialect => CukeModeler::Parsing.dialect}).to_a
+
+          messages.map(&:to_hash).find { |message| message[:gherkinDocument] }[:gherkinDocument]
+        end
+
+        def self.adapter_class
+          CukeModeler::Gherkin6Adapter
+        end
+
       when /^[54]\./
         require 'gherkin/parser'
         require 'cuke_modeler/adapters/gherkin_4_adapter'
 
-
+        # TODO: shouldn't the filename be used?
         # todo - make these methods private?
         def self.parsing_method(source_text, _filename)
           Gherkin::Parser.new.parse(source_text)
@@ -45,8 +66,7 @@ module CukeModeler
         def self.adapter_class
           CukeModeler::Gherkin3Adapter
         end
-
-      else # Assume version 2.x
+      when /^2\./
         require 'stringio'
         require 'gherkin/formatter/json_formatter'
         require 'gherkin'
@@ -68,6 +88,9 @@ module CukeModeler
           CukeModeler::Gherkin2Adapter
         end
 
+      else
+        # TODO: test this
+        raise("Unknown Gherkin version: '#{gherkin_version}'")
     end
 
 

data/lib/cuke_modeler/version.rb

@@ -1,4 +1,4 @@
 module CukeModeler
   # The gem version
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/testing/cucumber/step_definitions/feature_file_steps.rb

@@ -6,7 +6,7 @@ Given(/^a feature file model based on "([^"]*)"$/) do |file_name|
 end
 
 And(/^a feature file model based on that file$/) do |code_text|
-  code_text.gsub!('<file_path>', "'#{@file_path}'")
+  code_text = code_text.gsub('<file_path>', "'#{@file_path}'")
 
   eval(code_text)
 end

data/testing/cucumber/step_definitions/modeling_steps.rb

@@ -13,13 +13,13 @@ When(/^the model is output as a string$/) do |code_text|
 end
 
 And(/^a(?:n)? \w+(?: \w+)? model based on that gherkin$/) do |code_text|
-  code_text.gsub!('<source_text>', "'#{@source_text}'")
+  code_text = code_text.gsub('<source_text>', "'#{@source_text}'")
 
   eval(code_text)
 end
 
 Given(/^(?:a|the) (?:directory|feature file) is modeled$/) do |code_text|
-  code_text.gsub!('<path_to>', @root_test_directory)
+  code_text = code_text.gsub('<path_to>', @root_test_directory)
 
   eval(code_text)
 end

data/testing/cucumber/step_definitions/verification_steps.rb

@@ -12,7 +12,7 @@ Then(/^all of them can be output as text appropriate to the model type$/) do |co
 end
 
 Then(/^the following text is provided:$/) do |expected_text|
-  expected_text.sub!('<path_to>', @root_test_directory)
+  expected_text = expected_text.sub('<path_to>', @root_test_directory)
 
   expect(@output).to eq(expected_text)
 end
@@ -58,12 +58,13 @@ end
 
 Then(/^the model returns "([^"]*)"$/) do |value|
   value.gsub!('path_to', @root_test_directory) if value.is_a?(String)
+  value = value.to_i if value =~ /^\d+$/
 
   expect(@result).to eq(value)
 end
 
 Then(/^the model returns$/) do |value|
-  value.gsub!('path_to', @root_test_directory) if value.is_a?(String)
+  value = value.gsub('path_to', @root_test_directory) if value.is_a?(String)
 
   expect(@result).to eq(value)
 end

data/testing/file_helper.rb

@@ -1,3 +1,6 @@
+require 'tmpdir'
+
+
 module CukeModeler
   module FileHelper
 

data/testing/gemfiles/gherkin2.gemfile

@@ -7,6 +7,11 @@ gem "gherkin", "~> 2.0"
 
 if RUBY_VERSION =~ /^1\./
 
+  if RbConfig::CONFIG['host_os'].downcase =~ /mswin|msys|mingw32/
+    gem 'ffi', '< 1.9.15' # The 'ffi' gem, for Windows, requires Ruby 2.x on/after this version
+  end
+
+  gem 'unf_ext', '< 0.0.7.3' # Requires Ruby 2.x on/after this version
   gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
   gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
   gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
@@ -14,6 +19,8 @@ if RUBY_VERSION =~ /^1\./
   if RUBY_VERSION =~ /^1\.8/
     gem 'cucumber', '~> 1.0' # Ruby 1.8.x support dropped after this version
     gem 'rake', '< 11.0' # Ruby 1.8.x support dropped after this version
+  else
+    gem 'rake', '< 12.3.0' # Ruby 1.9.x support dropped after this version
   end
 
 elsif RUBY_VERSION =~ /^2\./

data/testing/gemfiles/gherkin3.gemfile

@@ -7,9 +7,15 @@ gem "gherkin", "~> 3.0"
 
 if RUBY_VERSION =~ /^1\./
 
+  if RbConfig::CONFIG['host_os'].downcase =~ /mswin|msys|mingw32/
+    gem 'ffi', '< 1.9.15' # The 'ffi' gem, for Windows, requires Ruby 2.x on/after this version
+  end
+
+  gem 'unf_ext', '< 0.0.7.3' # Requires Ruby 2.x on/after this version
   gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
   gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
   gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+  gem 'rake', '< 12.3.0' # Ruby 1.9.x support dropped after this version
 
 elsif RUBY_VERSION =~ /^2\./
 

data/testing/gemfiles/gherkin4.gemfile

@@ -7,9 +7,16 @@ gem "gherkin", "~> 4.0"
 
 if RUBY_VERSION =~ /^1\./
 
+  if RbConfig::CONFIG['host_os'].downcase =~ /mswin|msys|mingw32/
+    gem 'ffi', '< 1.9.15' # The 'ffi' gem, for Windows, requires Ruby 2.x on/after this version
+  end
+
+  gem 'unf_ext', '< 0.0.7.3' # Requires Ruby 2.x on/after this version
   gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
   gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
   gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+  gem 'rake', '< 12.3.0' # Ruby 1.9.x support dropped after this version
+  gem 'cucumber', '< 3.0.0' # Ruby 1.9.x support dropped after this version
 
 elsif RUBY_VERSION =~ /^2\./
 

data/testing/gemfiles/gherkin5.gemfile

@@ -7,9 +7,15 @@ gem "gherkin", "~> 5.0"
 
 if RUBY_VERSION =~ /^1\./
 
+  if RbConfig::CONFIG['host_os'].downcase =~ /mswin|msys|mingw32/
+    gem 'ffi', '< 1.9.15' # The 'ffi' gem, for Windows, requires Ruby 2.x on/after this version
+  end
+
+  gem 'unf_ext', '< 0.0.7.3' # Requires Ruby 2.x on/after this version
   gem 'tins', '< 1.7' # The 'tins' gem requires Ruby 2.x on/after this version
   gem 'json', '< 2.0' # The 'json' gem drops pre-Ruby 2.x support on/after this version
   gem 'term-ansicolor', '< 1.4' # The 'term-ansicolor' gem requires Ruby 2.x on/after this version
+  gem 'rake', '< 12.3.0' # Ruby 1.9.x support dropped after this version
 
 elsif RUBY_VERSION =~ /^2\./
 

data/testing/gemfiles/gherkin6.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec :path => "../../"
+
+gem "gherkin", "~> 6.0"
+gem 'cucumber', '~>4.0.rc' # TODO: Upgrade to Cucumber 4.0 when it is finally released
+
+if RUBY_VERSION =~ /^2\.[23456789]/
+  gem 'test-unit'
+end

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

@@ -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,8 +37,16 @@ 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")
+    it 'stores the original data generated by the parsing adapter', :gherkin6 => 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
+
+    it 'stores the original data generated by the parsing adapter', :gherkin4_5 => 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])
@@ -46,7 +54,7 @@ describe 'Background, Integration' do
     end
 
     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")
+      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])
@@ -54,7 +62,7 @@ describe 'Background, Integration' do
     end
 
     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")
+      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'])
@@ -62,14 +70,14 @@ describe 'Background, Integration' do
     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 +86,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 +95,7 @@ describe 'Background, Integration' do
                 '',
                 '',
                 '',
-                "  #{@step_keyword} a step"]
+                "  #{STEP_KEYWORD} a step"]
       source = source.join("\n")
 
       background = clazz.new(source)
@@ -108,10 +116,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 +157,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 +177,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 +212,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 +238,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 +259,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 +280,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 +312,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 +335,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 +363,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 +382,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 +406,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',
                                            '    """'])