chutney 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b678f90aea391f8707bda58ec5e2f6caf9b5d1f1bf5b1503c6862d4023d5f18
-  data.tar.gz: ecb2e762fa06c882869ff007e80261137816f431a78c07257d2f140e8f8f6f78
+  metadata.gz: a489eb526fae6a79ff386986463cf473aa4f5bc353448e99338781556f7fd194
+  data.tar.gz: 5cd7a3264aba055c8fe738147edfa661f57e2c0e258d5991b42adbfb2af45f05
 SHA512:
-  metadata.gz: 5f1f5c793a5d0080320606d56471f8ebcb7b0c3ceedca3e5e492eb877d1f0582aef997cd686c9e4782afeff407fb0346a0acbee288bca7306b39f2d8dc951540
-  data.tar.gz: 362d6bf5c6a1cb8c14a005534259e0ad5592df046a6dc3f747562b0b1875ee22e19b2076ff60873ca54967e2bd2188513566c36d0433ccd1c886fbc73b5c71ab
+  metadata.gz: 9fb8325c116764fadd900b0b98961eca7cf95f49ac171ef64e77e29f1806d6ff78bcca90ea9e2119320d33d81b13e67749fb3bf8e916df13e154871b54602b35
+  data.tar.gz: 8290dd430b9b55c900179717c3b3fcd83ea805e9142751dec8c69ae4c1e2233a3d5392d8951705a3fed0678b3a9fd768941889b5e9086465fa54ced8c43b1811

data/.rubocop.yml

@@ -8,7 +8,7 @@
 
 # Offense count: 1
 Metrics/AbcSize:
-  Max: 16
+  Enabled: false
 
 # Offense count: 1
 # Configuration parameters: CountComments.
@@ -52,7 +52,13 @@ Layout/HeredocIndentation:
     - "**/*_spec.rb"
 
 Layout/TrailingWhitespace:
-  Enabled: false
+  Enabled: true
 
 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/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/) or try [Chutney Online](https://chutney.billy-ruffian.co.uk).
+
+## 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,19 +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.85.1'
+  spec.add_development_dependency 'rubocop', '~> 0.90.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   
+  spec.required_ruby_version = '~> 2.6'
 end

data/config/{chutney.yml → chutney_defaults.yml}

@@ -12,6 +12,8 @@ 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'
@@ -10,19 +12,37 @@ formatters = Set.new
 
 OptionParser.new do |opts|
   opts.banner = 'Usage: chutney [files]'
-  opts.on('-f', 
-          '--format [formatter]', 
+  opts.on('-f',
+          '--format [formatter]',
           'One of JSONFormatter, PieFormatter or RainbowFormatter (default).') do |formatter|
     raise 'No Such Formatter' unless %w[JSONFormatter PieFormatter RainbowFormatter].include? formatter
 
     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?
 
 files = ARGV.map { |pattern| Dir.glob(pattern) }.flatten
-files = Dir.glob('features/**/*.feature') if ARGV.empty? 
+files = Dir.glob('features/**/*.feature') if ARGV.empty?
 
 linter = Chutney::ChutneyLint.new(*files)
 report = linter.analyse

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'
@@ -8,6 +11,7 @@ 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'
@@ -32,9 +36,12 @@ require 'chutney/linter/unknown_variable'
 require 'chutney/linter/unused_variable'
 require 'chutney/linter/use_background'
 require 'chutney/linter/use_outline'
+require 'chutney/version'
+
+require 'cuke_modeler'
 require 'forwardable'
-require 'gherkin/dialect'
-require 'gherkin/parser'
+# require 'gherkin/dialect'
+# require 'gherkin/parser'
 require 'i18n'
 require 'set'
 require 'yaml'
@@ -44,33 +51,36 @@ 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)
       @files = files
       @results = Hash.new { |h, k| h[k] = [] }
       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_paths.each do |path|
+        next if I18n.load_path.include?(path)
+
+        I18n.load_path << path
+        I18n.backend.reload!
+      end
     end
-    
+
     def configuration
       unless @config
-        default_file = [File.expand_path('..', __dir__), '**/config', 'chutney.yml']
+        default_file = [File.expand_path('..', __dir__), '**/config', 'chutney_defaults.yml']
         config_file = Dir.glob(File.join(default_file)).first.freeze
         @config = Configuration.new(config_file)
       end
       @config
     end
-    
+
     def configuration=(config)
       @config = config
     end
-    
+
     def analyse
       files.each do |f|
         lint(f)
@@ -80,25 +90,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,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'delegate'
-module Chutney 
+
+module Chutney
   # gherkin_lint configuration object
   class Configuration < SimpleDelegator
     def initialize(path)
@@ -18,7 +21,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,19 +1,20 @@
+# frozen_string_literal: true
+
 module Chutney
   # base class for all formatters
   class Formatter
     attr_accessor :results
-    
+
     def initialize
       @results = {}
-    end  
-        
+    end
+
     def files
       results.map { |k, _v| k }
     end
-    
+
     def files_with_issues
       results.filter { |_k, v| v.any? { |r| r[:issues].count.positive? } }
     end
-    
   end
 end

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'
 
@@ -7,7 +9,7 @@ module Chutney
     def initialize
       super
     end
-    
+
     def format
       data = top_offences.map do |offence|
         {
@@ -19,14 +21,14 @@ module Chutney
       end
       print_report(data)
     end
-    
+
     def print_report(data)
       return if data.empty?
 
       print TTY::Pie.new(data: data, radius: 8, legend: { format: '%<label>s %<name>s %<value>i' })
       puts
     end
-    
+
     def top_offences
       offence = Hash.new(0)
       files_with_issues.each do |_file, linter|
@@ -36,9 +38,9 @@ module Chutney
       end
       offence.reject { |_k, v| v.zero? }.sort_by { |_linter, count| -count }
     end
-    
+
     def char_loop
-      @char_looper ||= Fiber.new do 
+      @char_looper ||= Fiber.new do
         chars = %w[• x + @ * / -]
         current = 0
         loop do
@@ -49,10 +51,10 @@ module Chutney
       end
       @char_looper.resume
     end
-    
+
     def colour_loop
-      @colour_looper ||= Fiber.new do 
-        colours = %i[bright_cyan bright_magenta bright_yellow bright_green] 
+      @colour_looper ||= Fiber.new do
+        colours = %i[bright_cyan bright_magenta bright_yellow bright_green]
         current = 0
         loop do
           current = 0 if current >= colours.count
@@ -62,7 +64,7 @@ module Chutney
       end
       @colour_looper.resume
     end
-    
+
     def put_summary
       pastel = Pastel.new
       print "#{files.count} features inspected, "
@@ -72,6 +74,5 @@ module Chutney
         puts pastel.red("#{files_with_issues.count} taste nasty")
       end
     end
-    
   end
 end

data/lib/chutney/formatter/rainbow_formatter.rb

@@ -1,39 +1,40 @@
+# frozen_string_literal: true
+
 require 'pastel'
 
 module Chutney
   # pretty formatter
   class RainbowFormatter < Formatter
-  
     def initialize
       super
-      
+
       @pastel = Pastel.new
     end
-  
-    def format      
+
+    def format
       files_with_issues.each do |file, linter|
         put_file(file)
         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
     end
-    
+
     def put_file(file)
       puts @pastel.cyan(file.to_s)
     end
-    
+
     def put_linter(linter)
       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
       print "#{files.count} features inspected, "
       if files_with_issues.count.zero?
@@ -42,6 +43,5 @@ module Chutney
         puts @pastel.red("#{files_with_issues.count} taste nasty")
       end
     end
-    
   end
 end