chutney 2.0.2 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86f59ed64df7e0c44f84a0e7ce86819414dff47db091d9f9312f326696b5f188
-  data.tar.gz: 2a4f6af6cf6d2042da8fd516cef4684306a404355c95349e66ff2e91a4d07da7
+  metadata.gz: ad43c930f710e8cac21960ff14f31da2fb4fe373ed2153fa3ad238b317ebaedd
+  data.tar.gz: 84e96dd0222e18b3ba9f5235e81598accc0e254f1997211c69d7b6fb19532957
 SHA512:
-  metadata.gz: e0e516f5c5cb171c03c2516bcd90952559c6e0a19e36596855188b57ae1fee2bc20756bc9721f261f3c1eee0c64afa2b31f59abeac759aa78aa704c528988be4
-  data.tar.gz: bdde11865fb6f7f18a2e9911b2851fb9cb4cb8244ed1935d3debf77de6d166686304606499326334bcfa2107743b8972a3af60654459b56fc4da36b4c150c8cb
+  metadata.gz: 7d26227a05a2087610a64557529f85b2b26afca8b3c273a63203710a65b8640497f7bf5f1aeb19c7572af2b2d4f2487b3e1eb6cf372c7f53bf00a526acd35260
+  data.tar.gz: a1f32beace478affe4d3ce7a270f9bd411567b9adb421aef0279b495824cdb35236915f7ea8f388b91d826a62a4cb0040041847694679653d4ebc9e0cb7bb665

data/.rufo

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

data/README.md

@@ -12,10 +12,11 @@
 <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/).

data/chutney.gemspec

@@ -51,10 +51,11 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'coveralls', '~> 0.8'
   spec.add_development_dependency 'cucumber', '~> 3.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.79.0'
+  spec.add_development_dependency 'rubocop', '~> 0.89.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   
 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/docs/index.md

@@ -5,7 +5,7 @@ nav_order: 1
 permalink: /
 ---
 
-# Best practice for your Cucumber feature files
+# Best practice for Cucumber
 {: .fs-9 }
 
 
@@ -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 3.

data/docs/installation.md

@@ -9,7 +9,7 @@ nav_order: 2
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'faker_maker', require: false
+gem 'chutney', require: false
 ```
 
 And then execute:
@@ -18,4 +18,4 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install chutney
+    $ gem install chutney

data/docs/usage/configuration.md

@@ -7,6 +7,6 @@ nav_order: 3
 
 # Configuration
 
-Chutney looks for a configuration file in the current directory called `config/chutney.yml`. This configuration mostly switches on individual linters globally, but a few have addition parameters which can be configured (e.g. the maximum characters in a step).
+Chutney looks for a configuration file in the current directory called `config/.chutney.yml`. This configuration mostly switches on individual linters globally, but a few have addition parameters which can be configured (e.g. the maximum characters in a step).
 
-A default configuration can be found [here](https://github.com/BillyRuffian/chutney/blob/master/config/default.yml).
+A default configuration can be found [here](https://github.com/BillyRuffian/chutney/blob/master/config/chutney.yml).

data/docs/usage/rules.md

@@ -9,92 +9,98 @@ nav_order: 2
 
 Chutney enforces its rules with the linters. These are:
 
-AvoidFullStop
+[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
+[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
+[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?
 
-BackgroundDoesMoreThanSetup
+[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.
 
-BackgroundRequiresMultipleScenarios
+[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
+[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.
 
-FileNameDiffersFeatureName
+[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.
 
-GivensAfterBackground
+[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
+[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
+[InvalidStepFlow](https://github.com/BillyRuffian/chutney/blob/master/features/invalid_step_flow.feature)
 : Your scenarios should follow Given → When → Then, in that order.
 
-MissingExampleName
+[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
+[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
+[MissingFeatureName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_feature_name.feature)
 : You should give your features a descriptive name.
 
-MissingScenarioName
+[MissingScenarioName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_scenario_name.feature)
 : You should name your scenarios and scenario outlines.
 
-MissingTestAction
+[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
+[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
+[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
+[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.
 
-ScenarioNamesMatch
+[ScenarioNamesMatch](https://github.com/BillyRuffian/chutney/blob/master/features/scenario_names_match.feature)
 : Chutney can enforce a naming convention for your scenario names.
 
-TagUsedMultipleTimes
+[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.
 
-TooClumsy
+[TooClumsy](https://github.com/BillyRuffian/chutney/blob/master/features/too_clumsy.feature)
 : This is a very long scenario. Consider writing it more concisely.
 
-TooLongStep
+[TooLongStep](https://github.com/BillyRuffian/chutney/blob/master/features/too_long_step.feature)
 : This is a very long step. Consider writing it more concisely.
 
-TooManyDifferentTags
-: This feature has a lot of differnt tags.
+[TooManyDifferentTags](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_different_tags.feature)
+: This feature has a lot of different tags.
 
-TooManySteps
+[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.
 
-TooManyTags
+[TooManyTags](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_tags.feature)
 : There are a lot of tags in this feature.
 
-UniqueScenarioNames
+[UniqueScenarioNames](https://github.com/BillyRuffian/chutney/blob/master/features/unique_scenario_names.feature)
 : You have duplicated a scenario name when they should be unique.
 
-UnknownVariable
+[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.
 
-UnusedVariable
+[UnusedVariable](https://github.com/BillyRuffian/chutney/blob/master/features/unused_variable.feature)
 : You have a variable which you are not using.
 
-UseBackground
+[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
+[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/lib/chutney.rb

@@ -4,9 +4,11 @@ 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'
@@ -45,7 +47,7 @@ module Chutney
     attr_accessor :verbose
     attr_reader :files
     attr_reader :results
-    
+
     def_delegators :@files, :<<, :clear, :delete, :include?
 
     def initialize(*files)
@@ -56,7 +58,7 @@ module Chutney
 
       I18n.load_path << i18n_paths
     end
-    
+
     def configuration
       unless @config
         default_file = [File.expand_path('..', __dir__), '**/config', 'chutney.yml']
@@ -65,11 +67,11 @@ module Chutney
       end
       @config
     end
-    
+
     def configuration=(config)
       @config = config
     end
-    
+
     def analyse
       files.each do |f|
         lint(f)
@@ -79,23 +81,23 @@ 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))
       linters.each do |linter_class|

data/lib/chutney/linter.rb

@@ -1,4 +1,5 @@
 # gherkin utilities
+
 module Chutney
   # base class for all linters
   class Linter
@@ -67,12 +68,12 @@ module Chutney
       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, step = nil)
       issues << Lint.new(
         message: message,
         gherkin_type: type(feature, scenario, step),
         location: location(feature, scenario, step),
-        feature: feature[:name],
+        feature: feature ? feature[:name] : nil,
         scenario: scenario ? scenario[:name] : nil,
         step: step ? step[:text] : nil
       ).to_h
@@ -81,8 +82,10 @@ module Chutney
     def location(feature, scenario, step)
       if step
         step[:location]
-      else
-        scenario ? scenario[:location] : feature[:location]
+      elsif scenario
+        scenario[:location]
+      else 
+        feature ? feature[:location] : 0
       end
     end
     
@@ -102,7 +105,9 @@ module Chutney
       end
     end
     
-    def elements
+    def elements 
+      return [] unless feature
+      
       if block_given? 
         feature[:children].each do |child|
           next if off_switch?(child)
@@ -113,7 +118,7 @@ module Chutney
         feature[:children]
       end
     end
-    
+
     def off_switch?(element = feature)
       off_switch = element[:tags]
                    .then { |tags| tags || [] }

data/lib/chutney/linter/avoid_typographers_quotes.rb

@@ -0,0 +1,37 @@
+module Chutney
+  # service class to lint for avoid scripting
+  class AvoidTypographersQuotes < Linter
+    TYPOGRAPHER_QUOTES = ["\u201c", "\u201d", "\u2018", "\u2019"].map(&:encode)
+
+    def lint
+      scenarios do |_feature, scenario|
+        lint_steps(scenario[:steps])
+
+        example_count = scenario[:examples]&.length || 0
+        next unless example_count.positive?
+
+        lint_examples(scenario[:examples])
+      end
+    end
+
+    def lint_steps(steps)
+      steps.each do |step|
+        issue(step) if TYPOGRAPHER_QUOTES.any? { |tq| step[:text].include? tq }
+      end
+    end
+
+    def lint_examples(examples)
+      examples.each do |example|
+        example[:tableBody].each do |body|
+          body[:cells].each do |cell|
+            issue(cell) if TYPOGRAPHER_QUOTES.any? { |tq| cell[:value].include? tq }
+          end
+        end
+      end
+    end
+
+    def issue(location)
+      add_issue(I18n.t('linters.avoid_typographers_quotes'), location)
+    end
+  end
+end

data/lib/chutney/linter/empty_feature_file.rb

@@ -0,0 +1,8 @@
+module Chutney
+  # service class to lint for Features that have no content
+  class EmptyFeatureFile < Linter
+    def lint
+      add_issue(I18n.t('linters.empty_feature_file')) if feature.nil?
+    end
+  end
+end

data/lib/chutney/linter/file_name_differs_feature_name.rb

@@ -2,7 +2,7 @@ module Chutney
   # service class to lint for file name differs feature name
   class FileNameDiffersFeatureName < Linter
     def lint
-      return unless feature.include? :name
+      return unless feature&.include?(:name)
         
       expected_feature_name = title_case(filename)
       return if ignore_whitespaces(feature[:name]).casecmp(ignore_whitespaces(expected_feature_name)) == 0

data/lib/chutney/linter/missing_feature_description.rb

@@ -3,6 +3,8 @@ module Chutney
   class MissingFeatureDescription < Linter
     MESSAGE = 'Features should have a description so that its purpose is clear'.freeze
     def lint
+      return unless feature
+      
       name = feature.key?(:description) ? feature[:description].strip : ''
       add_issue(I18n.t('linters.missing_feature_description'), feature) if name.empty?
     end

data/lib/chutney/linter/missing_feature_name.rb

@@ -2,6 +2,8 @@ module Chutney
   # service class to lint for missing feature names
   class MissingFeatureName < Linter    
     def lint
+      return unless feature
+      
       name = feature.key?(:name) ? feature[:name].strip : ''
       add_issue(I18n.t('linters.missing_feature_name'), feature) if name.empty?
     end

data/lib/chutney/linter/same_tag_for_all_scenarios.rb

@@ -4,8 +4,8 @@ module Chutney
   # service class to lint for using same tag on all scenarios
   class SameTagForAllScenarios < Linter
     def lint
-      lint_scenarios if feature.include? :children
-      lint_examples  if feature.include? :children
+      lint_scenarios if feature&.include?(:children)
+      lint_examples  if feature&.include?(:children)
     end
 
     def lint_scenarios

data/lib/chutney/linter/too_many_different_tags.rb

@@ -16,7 +16,7 @@ module Chutney
     end
     
     def all_tags
-      return [] unless feature.include?(:children)
+      return [] unless feature&.include?(:children)
       
       tags_for(feature) + feature[:children].map { |scenario| tags_for(scenario) }.flatten
     end

data/lib/chutney/linter/use_outline.rb

@@ -36,7 +36,7 @@ module Chutney
 
     def gather_scenarios(feature)
       scenarios = []
-      return scenarios unless feature.include? :children
+      return scenarios if feature.nil? || !feature.include?(:children)
       
       feature[:children].each do |scenario|
         next unless scenario[:type] == :Scenario

data/lib/chutney/version.rb

@@ -1,3 +1,3 @@
 module Chutney
-  VERSION = '2.0.2'.freeze
+  VERSION = '2.2.1'.freeze
 end

data/lib/config/locales/en.yml

@@ -11,12 +11,18 @@ en:
     avoid_scripting: >-
       You have %{count} When steps when you should only have one.
       Be careful not to add And steps following a When.
+    avoid_typographers_quotes: >-
+      You are using typographers quotation marks (curly quotes).
+      Make sure you intend to use this character and not a neutral quote
+      (straight quote) instead.
     background_does_more_than_setup: >-
       The Background does more than setup. It should only contain Given steps.
     background_requires_multiple_scenarios: >-
       Avoid using Background if you only have a single scenario.
     bad_scenario_name: >-
       You should avoid using words like '%{word}' in your scenario names.
+    empty_feature_file: >-
+      The feature file is empty
     file_name_differs_feature_name: >-
       The name of the feature should reflect the file name. Consider renaming this feature
       to '%{expected}'.

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.1
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 - Stefan Rohe
 - Nishtha Argawal
 - John Gluck
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -111,6 +111,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -159,14 +173,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.89.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.89.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +209,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rufo"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -228,9 +243,11 @@ files:
 - lib/chutney/linter/avoid_full_stop.rb
 - lib/chutney/linter/avoid_outline_for_single_example.rb
 - lib/chutney/linter/avoid_scripting.rb
+- lib/chutney/linter/avoid_typographers_quotes.rb
 - lib/chutney/linter/background_does_more_than_setup.rb
 - lib/chutney/linter/background_requires_multiple_scenarios.rb
 - lib/chutney/linter/bad_scenario_name.rb
+- lib/chutney/linter/empty_feature_file.rb
 - lib/chutney/linter/file_name_differs_feature_name.rb
 - lib/chutney/linter/givens_after_background.rb
 - lib/chutney/linter/invalid_file_name.rb
@@ -266,7 +283,7 @@ metadata:
   homepage_uri: https://billyruffian.github.io/chutney/
   source_code_uri: https://github.com/BillyRuffian/chutney
   changelog_uri: https://github.com/BillyRuffian/chutney/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -282,7 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A linter for English language Gherkin
 test_files: []