turnip 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a5b2f61d3782f307c76f247b14f6a814c9b23e756ed5a1ebdb2d5f1261454af
-  data.tar.gz: d4d5876e9b484995c2883448e4b302d68ec14094e52dde6d78c5b99232d801a1
+  metadata.gz: 32d3aecd977c3e3d73df64781c8c929c6375ca79e86e94ba3339f18541db5450
+  data.tar.gz: 89d504ed60b272b9d31f90756c6f4f0e7fd28a136ab7444a7b11fbc88298d452
 SHA512:
-  metadata.gz: 8b433ce756fb3c6430c1544e9b94acf5a36ad5de1607ad71824961be0fa313907f2d05f1cb55102d424935a8f311cd99045c0d6bec039edb997f51418fab6b9d
-  data.tar.gz: c30109444ccc7b315b98db85a4f24bbd31082289d35a4a6930d8c657adcc278e6bd8d1420082d6061a8f61fe10cae461a8d6e56a6ea0347eb9917d9e110ab1ce
+  metadata.gz: c7473753934fb4d5deaa5b3c3856be1206aceea11bbdd8c1692e11cef24f340d96c95c78065b887772402fbe724c75581ee9788717193fa577e1c9044530b86e
+  data.tar.gz: ad6e2fc48ab21319383eaa81fb51fdb943bd716f4350912c3336b8a574d386d75f27f684ad96005d114623f69aefd5cfc902630973fe1f8d1f377aed44476774

data/.github/workflows/test.yml

@@ -6,13 +6,13 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - '2.5'
-          - '2.6'
           - '2.7'
+          - '3.0'
+          - '3.1'
           - jruby
         gemfiles:
-          - gemfiles/Gemfile-rspec-3.9.x
-          - gemfiles/Gemfile-rspec-3.10.x
+          - gemfiles/Gemfile-rspec-3.11.x
+          - gemfiles/Gemfile-rspec-3.12.x
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.2

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## [Unreleased]
 
+## [4.4.0] - 2022-11-04
+
+### Added
+
+- Add CukeModeler as Gherkin abstraction layer [[GH-244](https://github.com/jnicklas/turnip/pull/244)]
+- Send step notifications and add metadata for RSpec reporter [[GH-249](https://github.com/jnicklas/turnip/pull/249)]
+
+### Fixed
+
+- Add "missing step" context when raising error for unimplemented steps [[GH-240](https://github.com/jnicklas/turnip/pull/240)]
+- Support rspec 3.11 and 3.12 and deprecate EOL rubies [[GH-250](https://github.com/jnicklas/turnip/pull/250)]
+
 ## [4.3.0] - 2021-05-16
 
 ### Added

data/README.md

@@ -440,7 +440,7 @@ end
 Turnip mark a scenario as pending when steps in the scenario is not implemented.
 If you sets `raise_error_for_unimplemented_steps` as `true`, turnip will mark a scenario as fail.
 
-It defaults to `false`, you can change it by following configuration:
+It defaults to `false`, you can change it by adding following configuration to `spec/turnip_helper.rb`:
 
 ```ruby
 RSpec.configure do |config|
@@ -476,6 +476,24 @@ tags you'd use in Cucumber to switch between drivers e.g.  `@javascript` or
 metadata, so that Capybara is included and also any other extensions you might
 want to add.
 
+## RSpec custom formatters
+
+Turnip sends notifications to the RSpec reporter about step progress. You can
+listen for these by registering your formatter class with the following
+notifications:
+
+``` ruby
+class MyFormatter
+  RSpec::Core::Formatters.register self, :step_started, :step_passed, :step_failed, :step_pending
+  
+  def step_passed(step)
+    puts "Starting step: #{step.text}"
+  end
+
+  # …
+end
+```
+
 ## License
 
 (The MIT License)

data/examples/specific_language.feature

@@ -0,0 +1,5 @@
+# language: en-au
+
+Pretty much: A feature that specifies a language
+  Awww, look mate: This is a language specific feature
+    * a step

data/gemfiles/{Gemfile-rspec-3.10.x → Gemfile-rspec-3.11.x}

@@ -3,5 +3,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in turnip.gemspec
 gemspec :path => '..'
 
-gem 'rspec', '~> 3.10.0'
+gem 'rspec', '~> 3.11.0'
 gem 'pry-byebug', platforms: :mri

data/gemfiles/{Gemfile-rspec-3.9.x → Gemfile-rspec-3.12.x}

@@ -3,5 +3,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in turnip.gemspec
 gemspec :path => '..'
 
-gem 'rspec', '~> 3.9.0'
+gem 'rspec', '~> 3.12.0'
 gem 'pry-byebug', platforms: :mri

data/lib/turnip/builder.rb

@@ -1,19 +1,13 @@
-require "gherkin"
+require "cuke_modeler"
 require 'turnip/node/feature'
 
 module Turnip
   class Builder
     def self.build(feature_file)
-      messages = Gherkin.from_paths(
-        [feature_file],
-        include_source: false,
-        include_gherkin_document: true,
-        include_pickles: false
-      )
-      result = messages.first&.gherkin_document&.to_hash
+      feature_file = CukeModeler::FeatureFile.new(feature_file)
 
-      return nil if result.nil? || result[:feature].nil?
-      Node::Feature.new(result[:feature])
+      return nil unless feature_file.feature
+      Node::Feature.new(feature_file.feature)
     end
   end
 end

data/lib/turnip/node/example.rb

@@ -20,15 +20,15 @@ module Turnip
       include HasTags
 
       def keyword
-        @raw[:keyword]
+        @raw.keyword
       end
 
       def name
-        @raw[:name]
+        @raw.name
       end
 
       def description
-        @raw[:description]
+        @raw.description
       end
 
       #
@@ -42,7 +42,7 @@ module Turnip
       # @return [Array]
       #
       def header
-        @header ||= @raw[:table_header][:cells].map { |c| c[:value] }
+        @header ||= @raw.parameter_row.cells.map { |c| c.value }
       end
 
       #
@@ -56,8 +56,8 @@ module Turnip
       # @return [Array]
       #
       def rows
-        @rows ||= @raw[:table_body].map do |row|
-          row[:cells].map { |c| c[:value] }
+        @rows ||= @raw.argument_rows.map do |row|
+          row.cells.map { |c| c.value }
         end
       end
     end

data/lib/turnip/node/feature.rb

@@ -23,22 +23,25 @@ module Turnip
       include HasTags
 
       def language
-        @raw[:language]
+        @raw.language
       end
 
       def children
-        @children ||= @raw[:children].map do |child|
-          unless child[:background].nil?
-            next Background.new(child[:background])
+        @children ||= @raw.children.map do |child|
+          if child.is_a?(CukeModeler::Background)
+            next Background.new(child)
           end
 
-          unless child[:scenario].nil?
-            klass = child.dig(:scenario, :examples).nil? ? Scenario : ScenarioOutline
-            next klass.new(child[:scenario])
+          if child.is_a?(CukeModeler::Scenario)
+            next Scenario.new(child)
           end
 
-          unless child[:rule].nil?
-            next Rule.new(child[:rule])
+          if child.is_a?(CukeModeler::Outline)
+            next ScenarioOutline.new(child)
+          end
+
+          if child.is_a?(CukeModeler::Rule)
+            next Rule.new(child)
           end
         end.compact
       end

data/lib/turnip/node/location.rb

@@ -23,7 +23,7 @@ module Turnip
       # @return [Location]
       #
       def location
-        @location ||= Location.new(@raw[:location][:line], @raw[:location][:column])
+        @location ||= Location.new(@raw.source_line, @raw.source_column)
       end
 
       def line

data/lib/turnip/node/rule.rb

@@ -16,14 +16,17 @@ module Turnip
     #
     class Rule < ScenarioGroupDefinition
       def children
-        @children ||= @raw[:children].map do |child|
-          unless child[:background].nil?
-            next Background.new(child[:background])
+        @children ||= @raw.children.map do |child|
+          if child.is_a?(CukeModeler::Background)
+            next Background.new(child)
           end
 
-          unless child[:scenario].nil?
-            klass = child.dig(:scenario, :examples).nil? ? Scenario : ScenarioOutline
-            next klass.new(child[:scenario])
+          if child.is_a?(CukeModeler::Scenario)
+            next Scenario.new(child)
+          end
+
+          if child.is_a?(CukeModeler::Outline)
+            next ScenarioOutline.new(child)
           end
         end.compact
       end

data/lib/turnip/node/scenario_definition.rb

@@ -5,19 +5,19 @@ module Turnip
   module Node
     class ScenarioDefinition < Base
       def name
-        @raw[:name]
+        @raw.name
       end
 
       def keyword
-        @raw[:keyword]
+        @raw.keyword
       end
 
       def description
-        @raw[:description]
+        @raw.description
       end
 
       def steps
-        @steps ||= @raw[:steps].map do |step|
+        @steps ||= @raw.steps.map do |step|
           Step.new(step)
         end
       end

data/lib/turnip/node/scenario_group_definition.rb

@@ -7,15 +7,15 @@ module Turnip
   module Node
     class ScenarioGroupDefinition < Base
       def name
-        @raw[:name]
+        @raw.name
       end
 
       def keyword
-        @raw[:keyword]
+        @raw.keyword
       end
 
       def description
-        @raw[:description]
+        @raw.description
       end
 
       def backgrounds

data/lib/turnip/node/scenario_outline.rb

@@ -20,7 +20,7 @@ module Turnip
       include HasTags
 
       def examples
-        @examples ||= @raw[:examples].map do |raw|
+        @examples ||= @raw.examples.map do |raw|
           Example.new(raw)
         end
       end
@@ -57,27 +57,27 @@ module Turnip
           header = example.header
 
           example.rows.map do |row|
-            metadata = convert_metadata_to_scenario(header, row)
+            scenario = convert_metadata_to_scenario(header, row)
 
             #
             # Replace <placeholder> using Example values
             #
-            metadata[:steps].each do |step|
-              step[:text] = substitute(step[:text], header, row)
+            scenario.steps.each do |step|
+              step.text = substitute(step.text, header, 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)
+              when step.block&.is_a?(CukeModeler::DocString)
+                step.block.content = substitute(step.block.content, header, row)
+              when step.block&.is_a?(CukeModeler::Table)
+                step.block.rows.map do |table_row|
+                  table_row.cells.map do |cell|
+                    cell.value = substitute(cell.value, header, row)
                   end
                 end
               end
             end
 
-            Scenario.new(metadata)
+            Scenario.new(scenario)
           end
         end.flatten.compact
       end
@@ -117,11 +117,14 @@ module Turnip
       #
       def convert_metadata_to_scenario(header, row)
         # deep copy
-        Marshal.load(Marshal.dump(raw)).tap do |new_raw|
-          new_raw.delete(:examples)
-          new_raw[:name] = substitute(new_raw[:name], header, row)
-          new_raw[:type] = :Scenario
-          new_raw[:keyword] = 'Scenario'
+        original = Marshal.load(Marshal.dump(raw))
+
+        CukeModeler::Scenario.new.tap do |scenario|
+          scenario.name = substitute(original.name, header, row)
+          scenario.keyword = 'Scenario' # TODO: Do we need to worry about dialects other than English?
+          scenario.steps = original.steps
+          scenario.source_line = original.source_line
+          scenario.source_column = original.source_column
         end
       end
 

data/lib/turnip/node/step.rb

@@ -16,11 +16,12 @@ module Turnip
     #
     class Step < Base
       def keyword
-        @raw[:keyword]
+        # TODO: Do we want to keep the whitespace?
+        @raw.keyword + ' '
       end
 
       def text
-        @raw[:text]
+        @raw.text
       end
 
       #
@@ -32,10 +33,10 @@ module Turnip
 
       def argument
         @argument ||= case
-                      when @raw[:doc_string]
-                        doc_string(@raw[:doc_string])
-                      when @raw[:data_table]
-                        data_table(@raw[:data_table])
+                      when @raw.block&.is_a?(CukeModeler::DocString)
+                        doc_string(@raw.block)
+                      when @raw.block&.is_a?(CukeModeler::Table)
+                        data_table(@raw.block)
                       end
       end
 
@@ -46,13 +47,13 @@ module Turnip
       private
 
       def doc_string(doc)
-        doc[:content]
+        doc.content
       end
 
       def data_table(table)
-        rows = table[:rows].map do |row|
-          row[:cells].map do |cell|
-            cell[:value]
+        rows = table.rows.map do |row|
+          row.cells.map do |cell|
+            cell.value
           end
         end
         Turnip::Table.new(rows)

data/lib/turnip/node/tag.rb

@@ -13,7 +13,7 @@ module Turnip
     #
     class Tag < Base
       def name
-        @name ||= @raw[:name].gsub(/^@/, '')
+        @name ||= @raw.name.gsub(/^@/, '')
       end
     end
 
@@ -22,7 +22,7 @@ module Turnip
       # @return [Array] Array of Tag
       #
       def tags
-        @tags ||= @raw.fetch(:tags, []).map do |tag|
+        @tags ||= @raw.tags.map do |tag|
           Tag.new(tag)
         end
       end

data/lib/turnip/rspec.rb

@@ -40,25 +40,35 @@ module Turnip
       include Turnip::Execute
 
       def run_step(feature_file, step)
+        reporter = ::RSpec.current_example.reporter
+        reporter.publish(:step_started, { step: step })
+
         begin
           instance_eval <<-EOS, feature_file, step.line
             step(step)
           EOS
         rescue Turnip::Pending => e
+          reporter.publish(:step_pending, { step: step })
+
           example = ::RSpec.current_example
           example.metadata[:line_number] = step.line
           example.metadata[:location] = "#{example.metadata[:file_path]}:#{step.line}"
 
+          missing_step_message = "No such step: '#{e}' #{feature_file}:#{step.line}"
           if ::RSpec.configuration.raise_error_for_unimplemented_steps
             e.backtrace.push "#{feature_file}:#{step.line}:in `#{step.description}'"
-            raise
+            raise e, missing_step_message
           end
 
-          skip("No such step: '#{e}'")
+          skip(missing_step_message)
         rescue StandardError, ::RSpec::Expectations::ExpectationNotMetError => e
+          reporter.publish(:step_failed, { step: step })
+
           e.backtrace.push "#{feature_file}:#{step.line}:in `#{step.description}'"
           raise e
         end
+
+        reporter.publish(:step_passed, { step: step })
       end
     end
 
@@ -91,10 +101,11 @@ module Turnip
         end
 
         group.scenarios.each do |scenario|
-          step_names = (background_steps + scenario.steps).map(&:to_s)
-          description = step_names.join(' -> ')
+          all_steps = background_steps + scenario.steps
+          description = all_steps.map(&:to_s).join(' -> ')
+          metadata = scenario.metadata_hash.merge(turnip_steps: all_steps)
 
-          context.describe scenario.name, scenario.metadata_hash do
+          context.describe scenario.name, metadata do
             instance_eval <<-EOS, filename, scenario.line
               it description do
                 scenario.steps.each do |step|

data/lib/turnip/version.rb

@@ -1,3 +1,3 @@
 module Turnip
-  VERSION = '4.3.0'
+  VERSION = '4.4.0'
 end

data/spec/integration_spec.rb

@@ -12,12 +12,13 @@ describe 'The CLI', :type => :integration do
   end
 
   it "prints out failures and successes" do
-    @result.should include('45 examples, 4 failures, 5 pending')
+    @result.should include('46 examples, 4 failures, 6 pending')
   end
 
   it "includes features in backtraces" do
     @result.should include('examples/errors.feature:5:in `raise error')
     @result.should include('examples/errors.feature:11:in `a step just does not exist')
+    @result.should include("No such step: 'a step just does not exist'")
   end
 
   it "includes the right step name when steps call steps" do

data/spec/nodes/feature_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Turnip::Node::Feature do
+  let(:feature) { Turnip::Builder.build(feature_file) }
+
+  context 'a file that specifies a language' do
+    let(:feature_file) { File.expand_path('../../examples/specific_language.feature', __dir__) }
+
+    it 'extracts the language' do
+      feature.language.should eq 'en-au'
+    end
+
+  end
+end

data/spec/reporter_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+describe Turnip::RSpec::Execute do
+  let(:mod) { Module.new }
+  let(:obj) { Object.new.tap { |o| o.extend Turnip::RSpec::Execute; o.extend mod; def o.skip(*args); end } }
+  let(:reporter) { RSpec.current_example.reporter }
+
+  before { allow(reporter).to receive(:publish).and_call_original }
+
+  def create_step_node(text)
+    Turnip::Node::Step.new OpenStruct.new(source_line: 1, source_column: 0, text: text)
+  end
+
+  context '#run_step' do
+    it "publishes :step_started event when step is starting" do
+      step = create_step_node "a test step"
+
+      obj.run_step 'test.feature', step
+
+      expect(reporter).to have_received(:publish).with(:step_started, step: step)
+    end
+
+    it "publishes :step_passed event when step has passed" do
+      mod.step("a test step") { true }
+      step = create_step_node "a test step"
+
+      obj.run_step 'test.feature', step
+
+      expect(reporter).to have_received(:publish).with(:step_passed, step: step)
+    end
+
+    it "publishes :step_failed event when step has failed" do
+      mod.step("a failing step") { raise ::RSpec::Expectations::ExpectationNotMetError }
+      step = create_step_node "a failing step"
+
+      begin
+        obj.run_step 'test.feature', step
+      rescue ::RSpec::Expectations::ExpectationNotMetError => e
+      end
+
+      expect(reporter).to have_received(:publish).with(:step_failed, step: step)
+    end
+
+    it "publishes :step_pending event when step is pending" do
+      step = create_step_node "a pending step"
+
+      obj.run_step 'test.feature', step
+
+      expect(reporter).to have_received(:publish).with(:step_pending, step: step)
+    end
+  end
+end

data/turnip.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency "rspec", [">=3.0", "<4.0"]
-  s.add_runtime_dependency "cucumber-gherkin", "~> 14.0"
+  s.add_runtime_dependency "cuke_modeler", "~> 3.15"
   s.add_development_dependency "rake"
   s.add_development_dependency "pry"
   s.add_development_dependency "pry-byebug"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turnip
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Jonas Nicklas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-16 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,19 +31,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: cucumber-gherkin
+  name: cuke_modeler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '14.0'
+        version: '3.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '14.0'
+        version: '3.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +97,7 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -115,6 +116,7 @@ files:
 - examples/scenario_outline_scenario_name_substitution.feature
 - examples/scenario_outline_table_substitution.feature
 - examples/simple_feature.feature
+- examples/specific_language.feature
 - examples/step_calling.feature
 - examples/steps/alignment_steps.rb
 - examples/steps/autoload_steps.rb
@@ -131,8 +133,8 @@ files:
 - examples/tags.feature
 - examples/with_backticks.feature
 - examples/with_comments.feature
-- gemfiles/Gemfile-rspec-3.10.x
-- gemfiles/Gemfile-rspec-3.9.x
+- gemfiles/Gemfile-rspec-3.11.x
+- gemfiles/Gemfile-rspec-3.12.x
 - lib/turnip.rb
 - lib/turnip/builder.rb
 - lib/turnip/capybara.rb
@@ -160,7 +162,9 @@ files:
 - spec/define_and_execute_spec.rb
 - spec/dsl_spec.rb
 - spec/integration_spec.rb
+- spec/nodes/feature_spec.rb
 - spec/placeholder_spec.rb
+- spec/reporter_spec.rb
 - spec/spec_helper.rb
 - spec/step_definition_spec.rb
 - spec/table_spec.rb
@@ -169,7 +173,7 @@ homepage: https://github.com/jnicklas/turnip/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -184,8 +188,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Gherkin extension for RSpec
 test_files:
@@ -193,7 +197,9 @@ test_files:
 - spec/define_and_execute_spec.rb
 - spec/dsl_spec.rb
 - spec/integration_spec.rb
+- spec/nodes/feature_spec.rb
 - spec/placeholder_spec.rb
+- spec/reporter_spec.rb
 - spec/spec_helper.rb
 - spec/step_definition_spec.rb
 - spec/table_spec.rb