turnip 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db04bddfd94b8b6e3e3c5a43fb62f45cb8322873b06ff8a0dd8636efb249b524
-  data.tar.gz: 3aaa0f8839286df02a563fa2b7903e79747dedf29d27f93f7d737dceda0dfed3
+  metadata.gz: 8b5136318e39336ec82b97637d41586f2f8eb062b3a8f0b365bf12d69234f3b9
+  data.tar.gz: 5d2519ec243ddf02f790e69adfccb3a3ce768635e6c42f70b91b9f3fd2036a77
 SHA512:
-  metadata.gz: 1e9deb546d2b5747a9ab0667e70baccb0469ac59eaa665ac97876258435d9bcfb512e74956ee3567237e8363238251d1a567749547f3e2b991a9d021bedfd733
-  data.tar.gz: c824cf5ae72f02fd6150e38ec53f9c551a1a2a20768359b1e20efae22948fecce49e07dd6afb0131dbd212b50fbfb2ffbef6082a3e64b9602f41a661b91cced2
+  metadata.gz: 07f3ddd379dc52a69950e68bebbd11df4b6727d468feb198b17642c6b84980068846f9c4f00a8a87584ccf5dfb6f42c77fa9b494de5b2d971bf8e2443585c85b
+  data.tar.gz: d0ce8fe9c90673a2f3c815cffeb23fa0d37cce0c59726570971b1a9a95e0b615d86aa1d257824829a7f5a6d25099754212d8b568c1d18c0fd2e2b123441e0144

data/.travis.yml

@@ -7,13 +7,21 @@ branches:
   only:
     - master
 
+#
+# Ignore JRuby until https://github.com/cucumber/cucumber/pull/486 is merged
+#
+matrix:
+  allow_failures:
+  - rvm: jruby
+  - rvm: 2.6.0
+
 rvm:
-  - 2.2
   - 2.3.6
   - 2.4.3
-  - 2.5.0
-  - jruby-19mode
+  - 2.5.3
+  - 2.6.0
+  - jruby
 
 gemfile:
-  - gemfiles/Gemfile-rspec-3.6.x
   - gemfiles/Gemfile-rspec-3.7.x
+  - gemfiles/Gemfile-rspec-3.8.x

data/Gemfile

@@ -1,4 +1,3 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in turnip.gemspec
 gemspec

data/examples/gherkin6_syntax.feature

@@ -0,0 +1,25 @@
+Feature: Gherkin 6 syntax
+
+  Background:
+    Given there is a monster with 2 hitpoints
+
+  Scenario: Battle
+    When I attack it
+    Then the monster should be alive
+    When I attack it
+    Then it should die
+
+  Rule: Battle with preemptive attack
+    Background:
+      Given I attack the monster and do 1 points damage
+
+    Example: battle
+      When I attack it
+      Then it should die
+
+  Rule: Battle with preemptive critical attack
+    Background:
+      Given I attack the monster and do 2 points damage
+
+    Example: battle
+      Then it should die

data/gemfiles/{Gemfile-rspec-3.6.x → Gemfile-rspec-3.8.x}

@@ -3,4 +3,4 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in turnip.gemspec
 gemspec :path => '..'
 
-gem 'rspec', '~> 3.6.0'
+gem 'rspec', '~> 3.8.0'

data/lib/turnip/builder.rb

@@ -1,13 +1,13 @@
-require "gherkin/parser"
+require "gherkin/gherkin"
 require 'turnip/node/feature'
 
 module Turnip
   class Builder
     def self.build(feature_file)
-      parser = Gherkin::Parser.new
-      result = parser.parse(File.read(feature_file))
+      messages = Gherkin::Gherkin.from_paths([feature_file], include_source: false, include_pickles: false)
+      result = messages.first&.gherkinDocument&.to_hash
 
-      return nil unless result[:feature]
+      return nil if result.nil? || result[:feature].nil?
       Node::Feature.new(result[:feature])
     end
   end

data/lib/turnip/node/example.rb

@@ -42,7 +42,7 @@ module Turnip
       # @return [Array]
       #
       def header
-        @header ||= @raw[:tableHeader][:cells].map { |c| c[:value] }
+        @header ||= @raw[:table_header][:cells].map { |c| c[:value] }
       end
 
       #
@@ -56,7 +56,7 @@ module Turnip
       # @return [Array]
       #
       def rows
-        @rows ||= @raw[:tableBody].map do |row|
+        @rows ||= @raw[:table_body].map do |row|
           row[:cells].map { |c| c[:value] }
         end
       end

data/lib/turnip/node/feature.rb

@@ -1,8 +1,7 @@
 require 'turnip/node/base'
 require 'turnip/node/tag'
-require 'turnip/node/scenario'
-require 'turnip/node/scenario_outline'
-require 'turnip/node/background'
+require 'turnip/node/scenario_group_definition'
+require 'turnip/node/rule'
 
 module Turnip
   module Node
@@ -20,55 +19,36 @@ module Turnip
     #       children: [], # Array of Background, Scenario and Scenario Outline
     #     }
     #
-    class Feature < Base
+    class Feature < ScenarioGroupDefinition
       include HasTags
 
-      def name
-        @raw[:name]
-      end
-
       def language
         @raw[:language]
       end
 
-      def keyword
-        @raw[:keyword]
-      end
+      def children
+        @children ||= @raw[:children].map do |child|
+          unless child[:background].nil?
+            next Background.new(child[:background])
+          end
 
-      def description
-        @raw[:description]
-      end
+          unless child[:scenario].nil?
+            klass = child[:scenario][:examples].empty? ? Scenario : ScenarioOutline
+            next klass.new(child[:scenario])
+          end
 
-      def children
-        @children ||= @raw[:children].map do |c|
-          case c[:type]
-          when :Background
-            Background.new(c)
-          when :Scenario
-            Scenario.new(c)
-          when :ScenarioOutline
-            ScenarioOutline.new(c)
+          unless child[:rule].nil?
+            next Rule.new(child[:rule])
           end
         end.compact
       end
 
-      def backgrounds
-        @backgrounds ||= children.select do |c|
-          c.is_a?(Background)
+      def rules
+        @rules ||= children.select do |c|
+          c.is_a?(Rule)
         end
       end
 
-      def scenarios
-        @scenarios ||= children.map do |c|
-          case c
-          when Scenario
-            c
-          when ScenarioOutline
-            c.to_scenarios
-          end
-        end.flatten.compact
-      end
-
       def metadata_hash
         super.merge(:type => Turnip.type, :turnip => true)
       end

data/lib/turnip/node/rule.rb

@@ -0,0 +1,32 @@
+require 'turnip/node/scenario_group_definition'
+
+module Turnip
+  module Node
+    #
+    # @note Rule metadata generated by Gherkin
+    #
+    #     {
+    #       type: :Rule,
+    #       location: { line: 10, column: 3 },
+    #       keyword: 'Rule',
+    #       name: 'Rule name',
+    #       description: 'Rule description',
+    #       children: [] # Array of Background, Scenario and Scenario Outline
+    #     }
+    #
+    class Rule < ScenarioGroupDefinition
+      def children
+        @children ||= @raw[:children].map do |child|
+          unless child[:background].nil?
+            next Background.new(child[:background])
+          end
+
+          unless child[:scenario].nil?
+            klass = child[:scenario][:examples].empty? ? Scenario : ScenarioOutline
+            next klass.new(child[:scenario])
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/turnip/node/scenario_group_definition.rb

@@ -0,0 +1,39 @@
+require 'turnip/node/base'
+require 'turnip/node/scenario'
+require 'turnip/node/scenario_outline'
+require 'turnip/node/background'
+
+module Turnip
+  module Node
+    class ScenarioGroupDefinition < Base
+      def name
+        @raw[:name]
+      end
+
+      def keyword
+        @raw[:keyword]
+      end
+
+      def description
+        @raw[:description]
+      end
+
+      def backgrounds
+        @backgrounds ||= children.select do |c|
+          c.is_a?(Background)
+        end
+      end
+
+      def scenarios
+        @scenarios ||= children.map do |c|
+          case c
+          when Scenario
+            c
+          when ScenarioOutline
+            c.to_scenarios
+          end
+        end.flatten.compact
+      end
+    end
+  end
+end

data/lib/turnip/node/scenario_outline.rb

@@ -65,13 +65,11 @@ module Turnip
             metadata[:steps].each do |step|
               step[:text] = substitute(step[:text], header, row)
 
-              next if step[:argument].nil?
-
-              case step[:argument][:type]
-              when :DocString
-                step[:argument][:content] = substitute(step[:argument][:content], header, row)
-              when :DataTable
-                step[:argument][:rows].map do |table_row|
+              case
+              when step[:doc_string]
+                step[:doc_string][:content] = substitute(step[:doc_string][:content], header, row)
+              when step[:data_table]
+                step[:data_table][:rows].map do |table_row|
                   table_row[:cells].map do |cell|
                     cell[:value] = substitute(cell[:value], header, row)
                   end

data/lib/turnip/node/step.rb

@@ -31,13 +31,11 @@ module Turnip
       end
 
       def argument
-        return nil if @raw[:argument].nil?
-
-        @argument ||= case @raw[:argument][:type]
-                      when :DocString
-                        doc_string(@raw[:argument])
-                      when :DataTable
-                        data_table(@raw[:argument])
+        @argument ||= case
+                      when @raw[:doc_string]
+                        doc_string(@raw[:doc_string])
+                      when @raw[:data_table]
+                        data_table(@raw[:data_table])
                       end
       end
 

data/lib/turnip/rspec.rb

@@ -70,14 +70,19 @@ module Turnip
 
         instance_eval <<-EOS, feature_file, feature.line
           context = ::RSpec.describe feature.name, feature.metadata_hash
-          run_feature(context, feature, feature_file)
+          run_scenario_group(context, feature, feature_file)
         EOS
       end
 
       private
 
-      def run_feature(context, feature, filename)
-        background_steps = feature.backgrounds.map(&:steps).flatten
+      #
+      # @param  [RSpec::ExampleGroups]  context
+      # @param  [Turnip::Node::Feature|Turnip::Node::Rule]  group
+      # @param  [String]  filename
+      #
+      def run_scenario_group(context, group, filename)
+        background_steps = group.backgrounds.map(&:steps).flatten
 
         context.before do
           background_steps.each do |step|
@@ -85,7 +90,7 @@ module Turnip
           end
         end
 
-        feature.scenarios.each do |scenario|
+        group.scenarios.each do |scenario|
           step_names = (background_steps + scenario.steps).map(&:to_s)
           description = step_names.join(' -> ')
 
@@ -99,6 +104,13 @@ module Turnip
             EOS
           end
         end
+
+        if group.is_a?(Turnip::Node::Feature)
+          group.rules.each do |rule|
+            rule_context = context.context(rule.name, { turnip: true })
+            run_scenario_group(rule_context, rule, filename)
+          end
+        end
       end
     end
   end

data/lib/turnip/version.rb

@@ -1,3 +1,3 @@
 module Turnip
-  VERSION = '3.1.0'
+  VERSION = '4.0.0'
 end

data/spec/integration_spec.rb

@@ -12,7 +12,7 @@ describe 'The CLI', :type => :integration do
   end
 
   it "prints out failures and successes" do
-    @result.should include('39 examples, 4 failures, 5 pending')
+    @result.should include('42 examples, 4 failures, 5 pending')
   end
 
   it "includes features in backtraces" do

data/turnip.gemspec

@@ -20,7 +20,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency "rspec", [">=3.0", "<4.0"]
-  s.add_runtime_dependency "gherkin", "~> 5.0"
+  s.add_runtime_dependency "gherkin", "~> 6.0"
   s.add_development_dependency "rake"
   s.add_development_dependency "pry"
+  s.add_development_dependency "pry-byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turnip
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Jonas Nicklas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-01 00:00:00.000000000 Z
+date: 2019-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides the ability to define steps and run Gherkin files from with
   RSpec
 email:
@@ -91,6 +105,7 @@ files:
 - examples/backgrounds.feature
 - examples/blank.feature
 - examples/errors.feature
+- examples/gherkin6_syntax.feature
 - examples/interpolation.feature
 - examples/multiline_string.feature
 - examples/pending.feature
@@ -114,8 +129,8 @@ files:
 - examples/tags.feature
 - examples/with_backticks.feature
 - examples/with_comments.feature
-- gemfiles/Gemfile-rspec-3.6.x
 - gemfiles/Gemfile-rspec-3.7.x
+- gemfiles/Gemfile-rspec-3.8.x
 - lib/turnip.rb
 - lib/turnip/builder.rb
 - lib/turnip/capybara.rb
@@ -127,8 +142,10 @@ files:
 - lib/turnip/node/example.rb
 - lib/turnip/node/feature.rb
 - lib/turnip/node/location.rb
+- lib/turnip/node/rule.rb
 - lib/turnip/node/scenario.rb
 - lib/turnip/node/scenario_definition.rb
+- lib/turnip/node/scenario_group_definition.rb
 - lib/turnip/node/scenario_outline.rb
 - lib/turnip/node/step.rb
 - lib/turnip/node/tag.rb
@@ -166,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: turnip
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Gherkin extension for RSpec