chutney 2.2.1 → 3.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad43c930f710e8cac21960ff14f31da2fb4fe373ed2153fa3ad238b317ebaedd
-  data.tar.gz: 84e96dd0222e18b3ba9f5235e81598accc0e254f1997211c69d7b6fb19532957
+  metadata.gz: 3eb2bbfa506f0fde529c0365064ffe21e6f102e37d3790e138e09c972c07319d
+  data.tar.gz: 8951672afdbf61863d949ebce24862f203395a931228bd98a0fe1d401ad1544f
 SHA512:
-  metadata.gz: 7d26227a05a2087610a64557529f85b2b26afca8b3c273a63203710a65b8640497f7bf5f1aeb19c7572af2b2d4f2487b3e1eb6cf372c7f53bf00a526acd35260
-  data.tar.gz: a1f32beace478affe4d3ce7a270f9bd411567b9adb421aef0279b495824cdb35236915f7ea8f388b91d826a62a4cb0040041847694679653d4ebc9e0cb7bb665
+  metadata.gz: d41e8f3694940cb023fd03192b973a3778366e2745b544e8003f8d2f02c65285de6c7e9b8e254e89ce714732474c0837db8487da0eefbaba77ed405a02cf4f57
+  data.tar.gz: 1a3f433eb45190171bad88ca533e65f533f59ff5d2c2654a3da41b4f585b3abab3a6814824b0925ea0973ba76e331ce2bb9ab9345cd2f73ae1d242f64641eaff

data/.rubocop.yml

@@ -8,7 +8,7 @@
 
 # Offense count: 1
 Metrics/AbcSize:
-  Max: 16
+  Enabled: false
 
 # Offense count: 1
 # Configuration parameters: CountComments.
@@ -55,4 +55,10 @@ Layout/TrailingWhitespace:
   Enabled: false
 
 Style/FrozenStringLiteralComment:
+  Enabled: true
+  
+Style/StringConcatenation:
   Enabled: false
+
+AllCops:
+  NewCops: enable

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 
 task default: :build

data/chutney.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Disable rubocop checks for the .gemspec
 # I'll take the output from 'bundle gem new' to be authoritative
 # rubocop:disable all
@@ -12,9 +14,9 @@ Gem::Specification.new do |spec|
   spec.authors     = ['Nigel Brookes-Thomas', 'Stefan Rohe', 'Nishtha Argawal', 'John Gluck']
   spec.email       = ['nigel@brookes-thomas.co.uk']
 
-  spec.summary     = 'A linter for English language Gherkin'
+  spec.summary     = 'A linter for multi-lingual Gherkin'
   spec.description = 'A linter for your Cucumber features. '  \
-                      'It supports any spoken language Cucumber v3 supports.'
+                      'It supports any spoken language Cucumber supports.'
 
   spec.homepage    = 'https://billyruffian.github.io/chutney/'
   spec.license     = 'MIT'
@@ -43,14 +45,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   
   spec.add_runtime_dependency 'amatch', '~> 0.4.0'
-  spec.add_runtime_dependency 'gherkin', '~> 5.1.0'
+  spec.add_runtime_dependency 'cuke_modeler', '~> 3.3'
+  spec.add_runtime_dependency 'gherkin', '>= 5.1.0', '< 9.1'
   spec.add_runtime_dependency 'i18n', '~> 1.8.2'
   spec.add_runtime_dependency 'pastel', '~> 0.7'
   spec.add_runtime_dependency 'tty-pie', '~> 0.3'
 
 
   spec.add_development_dependency 'coveralls', '~> 0.8'
-  spec.add_development_dependency 'cucumber', '~> 3.0'
+  spec.add_development_dependency 'cucumber', '~> 5.1'
   spec.add_development_dependency 'pry-byebug', '~> 3.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rerun', '~> 0.13'
@@ -58,4 +61,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.89.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   
+  spec.required_ruby_version = '~> 2.6'
 end

data/config/cucumber.yml

@@ -0,0 +1 @@
+default: --publish-quiet

data/exe/chutney

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'chutney'
 require 'chutney/formatter'
 require 'chutney/formatter/json_formatter'

data/lib/chutney.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'amatch'
+
 require 'chutney/configuration'
 require 'chutney/linter'
 require 'chutney/linter/avoid_full_stop'
@@ -33,9 +36,11 @@ require 'chutney/linter/unknown_variable'
 require 'chutney/linter/unused_variable'
 require 'chutney/linter/use_background'
 require 'chutney/linter/use_outline'
+
+require 'cuke_modeler'
 require 'forwardable'
-require 'gherkin/dialect'
-require 'gherkin/parser'
+# require 'gherkin/dialect'
+# require 'gherkin/parser'
 require 'i18n'
 require 'set'
 require 'yaml'
@@ -45,8 +50,7 @@ module Chutney
   class ChutneyLint
     extend Forwardable
     attr_accessor :verbose
-    attr_reader :files
-    attr_reader :results
+    attr_reader :files, :results
 
     def_delegators :@files, :<<, :clear, :delete, :include?
 
@@ -92,14 +96,8 @@ module Chutney
 
     private
 
-    def parse(text)
-      @parser ||= Gherkin::Parser.new
-      scanner = Gherkin::TokenScanner.new(text)
-      @parser.parse(scanner)
-    end
-
     def lint(file)
-      parsed = parse(File.read(file))
+      parsed = CukeModeler::FeatureFile.new(file)
       linters.each do |linter_class|
         linter = linter_class.new(file, parsed, configuration[linter_class.linter_name])
         linter.lint

data/lib/chutney/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'delegate'
 module Chutney 
   # gherkin_lint configuration object

data/lib/chutney/formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Chutney
   # base class for all formatters
   class Formatter

data/lib/chutney/formatter/json_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Chutney
   # Plain old JSON formatter
   class JSONFormatter < Formatter

data/lib/chutney/formatter/pie_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pastel'
 require 'tty/pie'
 

data/lib/chutney/formatter/rainbow_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pastel'
 
 module Chutney

data/lib/chutney/issue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'term/ansicolor'
 
 module Chutney

data/lib/chutney/linter.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 # gherkin utilities
 
 module Chutney
   # base class for all linters
   class Linter
     attr_accessor :issues
-    attr_reader :filename
-    attr_reader :configuration
+    attr_reader :filename, :configuration
   
     Lint = Struct.new(:message, :gherkin_type, :location, :feature, :scenario, :step, keyword_init: true)
 
@@ -18,8 +19,8 @@ module Chutney
       @filename = filename
       @issues = []
       @configuration = configuration
-      language = @content.dig(:feature, :language) || 'en'
-      @dialect = Gherkin::Dialect.for(language)
+      #       language = @content.dig(:feature, :language) || 'en'
+      #       @dialect = Gherkin::Dialect.for(language)
     end
 
     def lint
@@ -27,65 +28,71 @@ module Chutney
     end
     
     def and_word?(word)
-      @dialect.and_keywords.include?(word)
+      dialect_word(:and).include?(word)
     end
     
     def background_word?(word)
-      @dialect.background_keywords.include?(word)
+      dialect_word(:background).include?(word)
     end
     
     def but_word?(word)
-      @dialect.but_keywords.include?(word)
+      dialect_word(:but).include?(word)
     end
     
     def examples_word?(word)
-      @dialect.example_keywords.include?(word)
+      dialect_word(:examples).include?(word)
     end
     
     def feature_word?(word)
-      @dialect.feature_keywords.include?(word)
+      dialect_word(:feature).include?(word)
     end
     
     def given_word?(word)
-      @dialect.given_keywords.include?(word)
+      dialect_word(:given).include?(word)
     end
     
     def scenario_outline_word?(word)
-      @dialect.scenario_outline_keywords.include?(word)
+      dialect_word(:scenarioOutline).include?(word)
     end
     
     def then_word?(word)
-      @dialect.then_keywords.include?(word)
+      dialect_word(:then).include?(word)
     end
     
     def when_word?(word)
-      @dialect.when_keywords.include?(word)
+      dialect_word(:when).include?(word)
+    end
+    
+    def dialect_word(word)
+      CukeModeler::Parsing.dialects[dialect][word.to_s].map(&:strip)
+    end
+    
+    def dialect
+      @content.feature&.parsing_data&.dig(:language) || 'en'
     end
   
     def tags_for(element)
-      return [] unless element.include? :tags
-
-      element[:tags].map { |tag| tag[:name][1..-1] }
+      element.tags.map { |tag| tag.name[1..-1] }
     end
     
-    def add_issue(message, feature = nil, scenario = nil, step = nil)
+    def add_issue(message, feature = nil, scenario = nil, item = nil)      
       issues << Lint.new(
         message: message,
-        gherkin_type: type(feature, scenario, step),
-        location: location(feature, scenario, step),
-        feature: feature ? feature[:name] : nil,
-        scenario: scenario ? scenario[:name] : nil,
-        step: step ? step[:text] : nil
+        gherkin_type: type(feature, scenario, item),
+        location: location(feature, scenario, item),
+        feature: feature&.name,
+        scenario: scenario&.name,
+        step: item&.parsing_data&.dig(:name)
       ).to_h
     end
     
     def location(feature, scenario, step)
       if step
-        step[:location]
+        step.parsing_data[:location]
       elsif scenario
-        scenario[:location]
+        scenario.parsing_data.dig(:scenario, :location) || scenario.parsing_data.dig(:background, :location)
       else 
-        feature ? feature[:location] : 0
+        feature ? feature.parsing_data[:location] : 0
       end
     end
     
@@ -99,9 +106,9 @@ module Chutney
 
     def feature
       if block_given?
-        yield(@content[:feature]) if @content[:feature]
+        yield(@content.feature) if @content.feature
       else
-        @content[:feature]
+        @content.feature
       end
     end
     
@@ -109,69 +116,61 @@ module Chutney
       return [] unless feature
       
       if block_given? 
-        feature[:children].each do |child|
+        feature.children.each do |child|
           next if off_switch?(child)
         
           yield(feature, child)
         end
       else
-        feature[:children]
+        feature.children
       end
     end
 
     def off_switch?(element = feature)
-      off_switch = element[:tags]
-                   .then { |tags| tags || [] }
-                   .filter { |tag| tag[:type] == :Tag }
-                   .filter { |tag| tag[:name] == "@disable#{linter_name}" }
-                   .count
-                   .positive?
+      off_switch = element.tags
+                          .then { |tags| tags || [] }
+                          .filter { |tag| tag[:type] == :Tag }
+                          .filter { |tag| tag[:name] == "@disable#{linter_name}" }
+                          .count
+                          .positive?
       off_switch ||= off_switch?(feature) unless element == feature
       off_switch
     end
     
     def background
-      if block_given?
-        elements do |feature, child|
-          next unless child[:type] == :Background
-          
-          yield(feature, child)
-        end
+      if block_given?          
+        yield(feature, feature&.background)
       else
-        elements.filter { |child| child[:type] == :Background }
+        feature&.background
       end
     end
     
     def scenarios
       if block_given?
-        elements do |feature, child|
-          next unless %i[ScenarioOutline Scenario].include? child[:type]
-        
-          yield(feature, child)
+        feature&.tests&.each do |test|
+          yield(feature, test)
         end
+        
       else
-        elements.filter { |child| %i[ScenarioOutline Scenario].include? child[:type] }
+        feature&.tests
       end
     end
     
     def filled_scenarios
       if block_given?
         scenarios do |feature, scenario|
-          next unless scenario.include? :steps
-          next if scenario[:steps].empty?
+          next if scenario.steps.empty?
         
           yield(feature, scenario)
         end
       else
-        scenarios.filter { |s| !s[:steps].empty? }
+        scenarios ? scenarios.filter { |s| !s.steps.empty? } : []
       end
     end
     
     def steps
-      elements do |feature, child|
-        next unless child.include? :steps
-        
-        child[:steps].each { |step| yield(feature, child, step) }
+      feature&.tests&.each do |t|
+        t.steps.each { |s| yield(feature, t, s) }
       end
     end
 
@@ -184,16 +183,16 @@ module Chutney
     end
 
     def render_step(step)
-      value = "#{step[:keyword]}#{step[:text]}"
-      value += render_step_argument step[:argument] if step.include? :argument
+      value = "#{step.keyword} #{step.text}"
+      value += render_step_argument(step.block) if step.block
       value
     end
     
     def render_step_argument(argument)
-      return "\n#{argument[:content]}" if argument[:type] == :DocString
+      return "\n#{argument.content}" if argument.is_a?(CukeModeler::DocString)
       
-      result = argument[:rows].map do |row|
-        "|#{row[:cells].map { |cell| cell[:value] }.join '|'}|"
+      result = argument.rows.map do |row|
+        "|#{row.cells.map(&:value).join '|'}|"
       end.join "\n"
       "\n#{result}"
     end

data/lib/chutney/linter/avoid_full_stop.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for avoiding periods
   class AvoidFullStop < Linter    
     def lint
       steps do |feature, child, step|
         
-        add_issue(I18n.t('linters.avoid_full_stop'), feature, child, step) if step[:text].strip.end_with? '.'
+        add_issue(I18n.t('linters.avoid_full_stop'), feature, child, step) if step.text.strip.end_with? '.'
         
       end
     end

data/lib/chutney/linter/avoid_outline_for_single_example.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for avoiding outline for single example
   class AvoidOutlineForSingleExample < Linter
     def lint
-      scenarios do |feature, scenario|
-        next unless scenario[:type] == :ScenarioOutline
-
-        next unless scenario.key? :examples
-        next if scenario[:examples].length > 1
-        next if scenario[:examples].first[:tableBody].length > 1
+      scenarios do |feature, scenario|      
+        next unless scenario.is_a? CukeModeler::Outline
+        next unless scenario.examples
+        
+        next if scenario.examples.length > 1
+        next if scenario.examples.first.rows.length > 2 # first row is the header
         
         add_issue(I18n.t('linters.avoid_outline_for_single_example'), feature, scenario)
       end