chutney 2.0.3.1 → 3.0.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2638bbebf9e9f48bf42c2871d2c5c3ef4a13b06bd67d3c52096fd270135e759
-  data.tar.gz: 18c502227f4918d434dc876fd3548bd532218b2e3250f94cdd33b4860119eea2
+  metadata.gz: c99f32f7cba016b8d419d1867c5005b448e05939565afff74db238c68222f2d9
+  data.tar.gz: 9f21a905656a69d4bbfc7288b7abcec37e36e3fb5950c852aa8c6e4183e52cd9
 SHA512:
-  metadata.gz: e5ca617c4feec58478cef5f00784e52425b79489cac43244824019e1ab7e7f7136dc4a7f355175282e55e634fb924ebd52a69400dfadace0bf140c824aa8a922
-  data.tar.gz: 4effe41d2b7d6213aff06a4083d78b57461366f540508c1ad946028a6c19d3e96f77411bc134e82de337a3fcdf376faf7fde96d7475fe82ab05a6c5d36b40b66
+  metadata.gz: 3a4339e31214900e809bdbdaf968a2d21af9bc7526365cd2f00a17745b10272947114c018e6b182c6679769636ffc127d6880d69dbbbb8dc66f0d5f5762a410d
+  data.tar.gz: b755781258f1781e4586a77f639682b7ebb0a584d50aa0c001a7eca5c5e8b0c16487b2d1dd1978e97744c5f7ec163ea169ae8d9c6114e1ed22cda716e3173a34

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/.rufo

@@ -0,0 +1 @@
+quote_style :single

data/Gemfile

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

data/README.md

@@ -12,10 +12,15 @@
 <div align="center">
 
   [![Gem Version](https://badge.fury.io/rb/chutney.svg)](https://badge.fury.io/rb/chutney)
+  [![Downloads](https://img.shields.io/gem/dt/chutney)](https://rubygems.org/gems/chutney)
   ![CircleCI branch](https://img.shields.io/circleci/project/github/BillyRuffian/chutney/master.svg?style=flat-square)
   [![CodeFactor](https://www.codefactor.io/repository/github/billyruffian/chutney/badge?style=flat-square)](https://www.codefactor.io/repository/github/billyruffian/chutney)
   ![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/BillyRuffian/chutney.svg?style=flat-square)
 
 </div>
 
-Read the documentation [here](https://billyruffian.github.io/chutney/).
+Read the documentation [here](https://billyruffian.github.io/chutney/).
+
+## Notes
+
+Chutney 3+ (in beta) has replaced its direct dependency on Cucumber and instead uses the excellent [cuke_modeller](https://github.com/enkessler/cuke_modeler) to parse your feature files. 

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,13 @@ 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.description = 'A linter for your Cucumber features. '  \
-                      'It supports any spoken language Cucumber v3 supports.'
+  spec.summary     = 'A linter for multi-lingual Gherkin'
+  spec.description = 'A linter for your Cucumber features. '                    \
+                     'Making sure you have nice, expressible Gherkin is '       \
+                     'essential is making sure you have a readable test-base. ' \
+                     'Chutney is designed to sniff out smells in your feature ' \
+                     'files. '                                                  \
+                     'It supports any spoken language Cucumber supports.'
 
   spec.homepage    = 'https://billyruffian.github.io/chutney/'
   spec.license     = 'MIT'
@@ -43,18 +49,20 @@ 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 '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'
   spec.add_development_dependency 'rspec-expectations', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.82.0'
+  spec.add_development_dependency 'rubocop', '~> 0.89.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   
+  spec.required_ruby_version = '~> 2.6'
 end

data/config/chutney.yml

@@ -4,12 +4,16 @@ AvoidFullStop:
     Enabled: true
 AvoidScripting:
     Enabled: true
+AvoidTypographersQuotes:
+    Enabled: true
 BackgroundDoesMoreThanSetup:
     Enabled: true
 BackgroundRequiresMultipleScenarios:
     Enabled: true
 BadScenarioName:
     Enabled: true
+EmptyFeatureFile:
+    Enabled: true
 FileNameDiffersFeatureName:
     Enabled: true
 GivensAfterBackground:

data/config/cucumber.yml

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

data/docs/usage/rules.md

@@ -18,6 +18,9 @@ Chutney enforces its rules with the linters. These are:
 [AvoidScripting](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_scripting.feature)
 : You have a lot of steps, are you sure you're not scripting the scenario when you should be specifying the behaviour of the system?
 
+[AvoidTypographersQuotes](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_typographers_quotes.feature)
+: Cutting and pasting from Word documents? Is that pasting in curly-quotes instead of neutral ones you would type on a keyboard? Are you sure that's what you want?
+
 [BackgroundDoesMoreThanSetup](https://github.com/BillyRuffian/chutney/blob/master/features/background_does_more_than_setup.feature)
 : Background in feature files should only do setup activity and so they should only contain `Given` steps.
 
@@ -27,6 +30,9 @@ Chutney enforces its rules with the linters. These are:
 [BadScenarioName](https://github.com/BillyRuffian/chutney/blob/master/features/bad_scenario_name.feature)
 : You should avoid using words like 'test' or 'check' in your scenario names, instead you should define the behaviour of your system.
 
+[EmptyFeatureFile](https://github.com/BillyRuffian/chutney/blob/master/features/empty_feature_file.feature)
+: The feature should have content and should avoid committing empty features to repositories.
+
 [FileNameDiffersFeatureName](https://github.com/BillyRuffian/chutney/blob/master/features/file_name_differs_feature_name.feature)
 : The feature should have a name that follows the file name.
 
@@ -76,7 +82,7 @@ Chutney enforces its rules with the linters. These are:
 : This is a very long step. Consider writing it more concisely.
 
 [TooManyDifferentTags](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_different_tags.feature)
-: This feature has a lot of differnt tags.
+: This feature has a lot of different tags.
 
 [TooManySteps](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_steps.feature)
 : This feature has a lot of steps. Consider writing it more concisely.

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'
@@ -17,6 +19,24 @@ OptionParser.new do |opts|
 
     formatters << formatter
   end
+  
+  opts.on('-l',
+          '--linters',
+          'List the linter status by this configuration and exit') do
+    pastel = Pastel.new
+    chutney_config = Chutney::ChutneyLint.new.configuration
+    max_name_length = chutney_config.keys.map(&:length).max + 1
+    chutney_config.each do |linter, value|
+      print pastel.cyan(linter.ljust(max_name_length))
+      
+      if value['Enabled']
+        puts pastel.green('enabled')
+      else
+        puts pastel.red('disabled')
+      end
+    end
+    exit
+  end
 end.parse!
 
 formatters << 'RainbowFormatter' if formatters.empty?

data/lib/chutney.rb

@@ -1,12 +1,17 @@
+# frozen_string_literal: true
+
 require 'amatch'
+
 require 'chutney/configuration'
 require 'chutney/linter'
 require 'chutney/linter/avoid_full_stop'
 require 'chutney/linter/avoid_outline_for_single_example'
 require 'chutney/linter/avoid_scripting'
+require 'chutney/linter/avoid_typographers_quotes'
 require 'chutney/linter/background_does_more_than_setup'
 require 'chutney/linter/background_requires_multiple_scenarios'
 require 'chutney/linter/bad_scenario_name'
+require 'chutney/linter/empty_feature_file'
 require 'chutney/linter/file_name_differs_feature_name'
 require 'chutney/linter/givens_after_background'
 require 'chutney/linter/invalid_file_name'
@@ -31,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'
@@ -43,9 +50,8 @@ 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?
 
     def initialize(*files)
@@ -54,9 +60,9 @@ module Chutney
       i18n_paths = Dir[File.expand_path(File.join(__dir__, 'config/locales')) + '/*.yml']
       return if I18n.load_path.include?(i18n_paths)
 
-      I18n.load_path << i18n_paths
+      I18n.load_path += i18n_paths
     end
-    
+
     def configuration
       unless @config
         default_file = [File.expand_path('..', __dir__), '**/config', 'chutney.yml']
@@ -65,11 +71,11 @@ module Chutney
       end
       @config
     end
-    
+
     def configuration=(config)
       @config = config
     end
-    
+
     def analyse
       files.each do |f|
         lint(f)
@@ -79,25 +85,19 @@ module Chutney
     # alias for non-british English
     # https://dictionary.cambridge.org/dictionary/english/analyse
     alias analyze analyse
-    
+
     def linters
       @linters ||= Linter.descendants.filter { |l| configuration.dig(l.linter_name, 'Enabled') }
     end
-    
+
     def linters=(*linters)
       @linters = linters
     end
-    
+
     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,4 +1,6 @@
+# frozen_string_literal: true
 require 'delegate'
+
 module Chutney 
   # gherkin_lint configuration object
   class Configuration < SimpleDelegator
@@ -18,7 +20,11 @@ module Chutney
     end
 
     def load_user_configuration
-      config_file = Dir.glob(File.join(Dir.pwd, '**', '.chutney.yml')).first
+      config_files = ['chutney.yml', '.chutney.yml'].map do |fname|
+        Dir.glob(File.join(Dir.pwd, '**', fname))
+      end.flatten
+      
+      config_file = config_files.first
       merge_config(config_file) if !config_file.nil? && File.exist?(config_file)
     end
 

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
@@ -16,7 +18,7 @@ module Chutney
         linter.filter { |l| !l[:issues].empty? }.each do |linter_with_issues|
           
           put_linter(linter_with_issues)
-          linter_with_issues[:issues].each { |i| put_issue(i) }
+          linter_with_issues[:issues].each { |i| put_issue(file, i) }
         end
       end
       put_summary
@@ -30,8 +32,9 @@ module Chutney
       puts @pastel.red("  #{linter[:linter]}")
     end
     
-    def put_issue(issue)    
-      puts "    #{@pastel.dim(issue.dig(:location, :line))} #{issue[:message]}"
+    def put_issue(file, issue)    
+      puts "    #{issue[:message]}"
+      puts "    #{@pastel.dim file.to_s}:#{@pastel.dim(issue.dig(:location, :line))}"
     end
     
     def put_summary

data/lib/chutney/issue.rb

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

data/lib/chutney/linter.rb

@@ -1,10 +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)
 
@@ -17,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
@@ -26,63 +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, 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[:name],
-        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]
-      else
-        scenario ? scenario[:location] : feature[:location]
+        step.parsing_data[:location]
+      elsif scenario
+        scenario.parsing_data.dig(:scenario, :location) || scenario.parsing_data.dig(:background, :location)
+      else 
+        feature ? feature.parsing_data[:location] : 0
       end
     end
     
@@ -96,77 +106,71 @@ 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
     
-    def elements
+    def elements 
+      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
 
@@ -179,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