chutney 2.2.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad43c930f710e8cac21960ff14f31da2fb4fe373ed2153fa3ad238b317ebaedd
-  data.tar.gz: 84e96dd0222e18b3ba9f5235e81598accc0e254f1997211c69d7b6fb19532957
+  metadata.gz: ad89ad439835c7acb1f2d3d0b4ee44895f714c7b6fc4f1a07f68e23594384979
+  data.tar.gz: c8eb1551cd49f668882ccbf047f65403e6f5724d8193c483d5fd16c14e456747
 SHA512:
-  metadata.gz: 7d26227a05a2087610a64557529f85b2b26afca8b3c273a63203710a65b8640497f7bf5f1aeb19c7572af2b2d4f2487b3e1eb6cf372c7f53bf00a526acd35260
-  data.tar.gz: a1f32beace478affe4d3ce7a270f9bd411567b9adb421aef0279b495824cdb35236915f7ea8f388b91d826a62a4cb0040041847694679653d4ebc9e0cb7bb665
+  metadata.gz: 4a1a21294785d98f9e1997eb02547ddc6556200d0d3261d0e57ee2586725808aa2221452b341a7f9badb9ed3fdf9784b185a552ef15fa7f9c30e4c50cee99190
+  data.tar.gz: ffc03086fba54bdd0747593170f33e696d009241778d6794392517d3541aa45fe20d20bd64aab41fbbdbb4382d47c47832f3d17762f316a8f6e11d245558fbb9

data/.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: rubocop
+    versions:
+    - 1.10.0
+    - 1.11.0
+    - 1.12.0
+    - 1.12.1
+    - 1.9.0
+    - 1.9.1

data/.rubocop.yml

@@ -8,7 +8,7 @@
 
 # Offense count: 1
 Metrics/AbcSize:
-  Max: 16
+  Enabled: false
 
 # Offense count: 1
 # Configuration parameters: CountComments.
@@ -25,7 +25,8 @@ Layout/LineLength:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 11
+  Max: 20
+
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -52,7 +53,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/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Funkwerk AG
+Copyright (c) 2020, 2021 Nigel Brookes-Thomas
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -19,4 +19,10 @@
 
 </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).
+
+See [this page](https://billyruffian.github.io/chutney/usage/rules.html) for a full list of the rules chutney encourages.
+
+## Notes
+
+Chutney 3+ 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
@@ -16,14 +18,12 @@ end
 
 desc 'Checks ruby style'
 task :rubocop do
-  begin
-    sh 'rubocop -a'
-  rescue RuntimeError => e
-    # Rubocop failing due to style violations is fine. Other errors should bubble up to our attention.
-    raise e unless e.message =~ /status \(1\).*rubocop/
-
-    puts 'Rubocop failed'
-  end
+  sh 'rubocop -a'
+rescue RuntimeError => e
+  # Rubocop failing due to style violations is fine. Other errors should bubble up to our attention.
+  raise e unless e.message =~ /status \(1\).*rubocop/
+
+  puts 'Rubocop failed'
 end
 
 task :spec do

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', '~> 6.0'
   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.89.0'
+  spec.add_development_dependency 'rubocop', '~> 1.14.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   
+  spec.required_ruby_version = '~> 2.6'
 end

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

@@ -36,6 +36,8 @@ InvalidStepFlow:
     Enabled: true
 RequiredTagsStartsWith:
     Enabled: false
+SameTagDifferentCase:
+    Enabled: true
 SameTagForAllScenarios:
     Enabled: true
 ScenarioNamesMatch:

data/config/cucumber.yml

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

data/docs/index.md

@@ -18,4 +18,4 @@ You're trying to follow TDD or ATDD principles, you're writing executable specif
 
 Cucumber itself is an awesome tool which bridges with gap between business language, software development language and the language of testers. With all these folks interested, it's easy to write problematic and hard to maintain features. Chutney tries to help with that by having a common set of quality rules for your feature files.
 
-Chutney is able to lint feature files in any spoken language supported by Cucumber 3.
+Chutney is able to lint feature files in any spoken language supported by Cucumber.

data/docs/usage/rules.md

@@ -9,98 +9,68 @@ nav_order: 2
 
 Chutney enforces its rules with the linters. These are:
 
-[AvoidFullStop](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_full_stop.feature)
-: Don't have a full stop (period) at the end of step because it makes step reuse really hard.
+[AvoidFullStop](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_full_stop.feature): Don't have a full stop (period) at the end of step because it makes step reuse really hard.
 
-[AvoidOutlineForSingleExample](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_outline_for_single_example.feature)
-: If you only have a single example in your example table, use a plain-old scenario instead.
+[AvoidOutlineForSingleExample](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_outline_for_single_example.feature): If you only have a single example in your example table, use a plain-old scenario instead.
 
-[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?
+[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?
+[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.
+[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.
 
-[BackgroundRequiresMultipleScenarios](https://github.com/BillyRuffian/chutney/blob/master/features/background_requires_multiple_scenarios.feature)
-: If you only have one scenario, don't bother having a Background section.
+[BackgroundRequiresMultipleScenarios](https://github.com/BillyRuffian/chutney/blob/master/features/background_requires_multiple_scenarios.feature): If you only have one scenario, don't bother having a Background section.
 
-[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.
+[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.
+[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.
+[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.
 
-[GivensAfterBackground](https://github.com/BillyRuffian/chutney/blob/master/features/givens_after_background.feature)
-: If you have a Background section and your scenario needs more preconditions then it should start immediately with an `And` step and not another `Given`.
+[GivensAfterBackground](https://github.com/BillyRuffian/chutney/blob/master/features/givens_after_background.feature): If you have a Background section and your scenario needs more preconditions then it should start immediately with an `And` step and not another `Given`.
 
-[InvalidFileName](https://github.com/BillyRuffian/chutney/blob/master/features/invalid_file_name.feature)
-: Make sure your file name is in snake case, not mixed case or with spaces.
+[InvalidFileName](https://github.com/BillyRuffian/chutney/blob/master/features/invalid_file_name.feature): Make sure your file name is in snake case, not mixed case or with spaces.
 
-[InvalidStepFlow](https://github.com/BillyRuffian/chutney/blob/master/features/invalid_step_flow.feature)
-: Your scenarios should follow Given → When → Then, in that order.
+[InvalidStepFlow](https://github.com/BillyRuffian/chutney/blob/master/features/invalid_step_flow.feature): Your scenarios should follow Given → When → Then, in that order.
 
-[MissingExampleName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_example_name.feature)
-: If you have more than one example table in your scenario, they should each be given unique names.
+[MissingExampleName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_example_name.feature): If you have more than one example table in your scenario, they should each be given unique names.
 
-[MissingFeatureDescription](https://github.com/BillyRuffian/chutney/blob/master/features/missing_feature_description.feature)
-: Your feature should have a value statement. These are usually in the form 'As a... I want.. So that...'.
+[MissingFeatureDescription](https://github.com/BillyRuffian/chutney/blob/master/features/missing_feature_description.feature): Your feature should have a value statement. These are usually in the form 'As a... I want.. So that...'.
 
-[MissingFeatureName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_feature_name.feature)
-: You should give your features a descriptive name.
+[MissingFeatureName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_feature_name.feature): You should give your features a descriptive name.
 
-[MissingScenarioName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_scenario_name.feature)
-: You should name your scenarios and scenario outlines.
+[MissingScenarioName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_scenario_name.feature): You should name your scenarios and scenario outlines.
 
-[MissingTestAction](https://github.com/BillyRuffian/chutney/blob/master/features/missing_test_action.feature)
-: You don't have an action (a `When` step) in your scenario.
+[MissingTestAction](https://github.com/BillyRuffian/chutney/blob/master/features/missing_test_action.feature): You don't have an action (a `When` step) in your scenario.
 
-[MissingVerification](https://github.com/BillyRuffian/chutney/blob/master/features/missing_verification.feature)
-: You don't have a verification step (a `Then` step) in your scenario.
+[MissingVerification](https://github.com/BillyRuffian/chutney/blob/master/features/missing_verification.feature): You don't have a verification step (a `Then` step) in your scenario.
 
-[RequiredTagsStartWith](https://github.com/BillyRuffian/chutney/blob/master/features/required_tags_starts_with.feature)
-: Chutney can enforce a configurable naming prefix for your tags.
+[RequiredTagsStartWith](https://github.com/BillyRuffian/chutney/blob/master/features/required_tags_starts_with.feature): Chutney can enforce a configurable naming prefix for your tags.
 
-[SameTagForAllScenarios](https://github.com/BillyRuffian/chutney/blob/master/features/same_tag_for_all_scenarios.feature)
-: You have the same tag for all you scenarios; move the tag to the feature level instead.
+[SameTagForDifferentCase](https://github.com/BillyRuffian/chutney/blob/master/features/same_tag_different_case.feature): Don't mix the case of tags which have already appeared. Cucumber tags are case sensitive. *Since 3.1.0*
 
-[ScenarioNamesMatch](https://github.com/BillyRuffian/chutney/blob/master/features/scenario_names_match.feature)
-: Chutney can enforce a naming convention for your scenario names.
+[SameTagForAllScenarios](https://github.com/BillyRuffian/chutney/blob/master/features/same_tag_for_all_scenarios.feature): You have the same tag for all you scenarios; move the tag to the feature level instead.
 
-[TagUsedMultipleTimes](https://github.com/BillyRuffian/chutney/blob/master/features/tag_used_multiple_times.feature)
-: Chutney can warn if you have used a tag a lot with a feature.
+[ScenarioNamesMatch](https://github.com/BillyRuffian/chutney/blob/master/features/scenario_names_match.feature): Chutney can enforce a naming convention for your scenario names.
 
-[TooClumsy](https://github.com/BillyRuffian/chutney/blob/master/features/too_clumsy.feature)
-: This is a very long scenario. Consider writing it more concisely.
+[TagUsedMultipleTimes](https://github.com/BillyRuffian/chutney/blob/master/features/tag_used_multiple_times.feature): Chutney can warn if you have used a tag a lot with a feature.
 
-[TooLongStep](https://github.com/BillyRuffian/chutney/blob/master/features/too_long_step.feature)
-: This is a very long step. Consider writing it more concisely.
+[TooClumsy](https://github.com/BillyRuffian/chutney/blob/master/features/too_clumsy.feature): This is a very long scenario. 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 different tags.
+[TooLongStep](https://github.com/BillyRuffian/chutney/blob/master/features/too_long_step.feature): This is a very long step. Consider writing it more concisely.
 
-[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.
+[TooManyDifferentTags](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_different_tags.feature): This feature has a lot of different tags.
 
-[TooManyTags](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_tags.feature)
-: There are a lot of tags in this feature.
+[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.
 
-[UniqueScenarioNames](https://github.com/BillyRuffian/chutney/blob/master/features/unique_scenario_names.feature)
-: You have duplicated a scenario name when they should be unique.
+[TooManyTags](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_tags.feature): There are a lot of tags in this feature.
 
-[UnknownVariable](https://github.com/BillyRuffian/chutney/blob/master/features/unknown_variable.feature)
-: You are referencing a variable which doesn't appear to be defined. This is a source of subtle errors.
+[UniqueScenarioNames](https://github.com/BillyRuffian/chutney/blob/master/features/unique_scenario_names.feature): You have duplicated a scenario name when they should be unique.
 
-[UnusedVariable](https://github.com/BillyRuffian/chutney/blob/master/features/unused_variable.feature)
-: You have a variable which you are not using.
+[UnknownVariable](https://github.com/BillyRuffian/chutney/blob/master/features/unknown_variable.feature): You are referencing a variable which doesn't appear to be defined. This is a source of subtle errors.
 
-[UseBackground](https://github.com/BillyRuffian/chutney/blob/master/features/use_background.feature)
-: You have a setup setup used in all of your scenarios. Move it to a Background section.
+[UnusedVariable](https://github.com/BillyRuffian/chutney/blob/master/features/unused_variable.feature): You have a variable which you are not using.
 
-[UseOutline](https://github.com/BillyRuffian/chutney/blob/master/features/use_outline.feature)
-: You have very similar scenarios. You should consider if they should be combined into a Scenario Outline.
+[UseBackground](https://github.com/BillyRuffian/chutney/blob/master/features/use_background.feature): You have a setup setup used in all of your scenarios. Move it to a Background section.
+
+[UseOutline](https://github.com/BillyRuffian/chutney/blob/master/features/use_outline.feature): You have very similar scenarios. You should consider if they should be combined into a Scenario Outline.

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'
@@ -20,6 +23,7 @@ require 'chutney/linter/missing_scenario_name'
 require 'chutney/linter/missing_test_action'
 require 'chutney/linter/missing_verification'
 require 'chutney/linter/required_tags_starts_with'
+require 'chutney/linter/same_tag_different_case'
 require 'chutney/linter/same_tag_for_all_scenarios'
 require 'chutney/linter/scenario_names_match'
 require 'chutney/linter/tag_used_multiple_times'
@@ -33,9 +37,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'
@@ -45,8 +52,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?
 
@@ -54,14 +60,18 @@ module Chutney
       @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
@@ -92,14 +102,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