chutney 2.1.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2da8d4d9f8b99fbedf8ed3b2407e5ec9024496258f86cd69fb76d35699b4ffa4
-  data.tar.gz: 1821ce09b96bc45203e1a65abac9d5c042bca5036933feda9c066c0ff852ede6
+  metadata.gz: ad43c930f710e8cac21960ff14f31da2fb4fe373ed2153fa3ad238b317ebaedd
+  data.tar.gz: 84e96dd0222e18b3ba9f5235e81598accc0e254f1997211c69d7b6fb19532957
 SHA512:
-  metadata.gz: 3adad450052c2008c3a1db8f82e65893c39605592b72ce676e9b3973fd19f6f2812a949ac5fa375909277298c12115e94771b7dcee06b34dc09362f415af16da
-  data.tar.gz: ebb9e4d1ea6842131863666ea4362dfc3e94c50525b1444c75e5f8b662c3bd340481d4a8bb00b265991dec0546aab0017e3f86d3a76a850738fbf4407cc68d32
+  metadata.gz: 7d26227a05a2087610a64557529f85b2b26afca8b3c273a63203710a65b8640497f7bf5f1aeb19c7572af2b2d4f2487b3e1eb6cf372c7f53bf00a526acd35260
+  data.tar.gz: a1f32beace478affe4d3ce7a270f9bd411567b9adb421aef0279b495824cdb35236915f7ea8f388b91d826a62a4cb0040041847694679653d4ebc9e0cb7bb665

data/config/chutney.yml

@@ -12,6 +12,8 @@ BackgroundRequiresMultipleScenarios:
     Enabled: true
 BadScenarioName:
     Enabled: true
+EmptyFeatureFile:
+    Enabled: true
 FileNameDiffersFeatureName:
     Enabled: true
 GivensAfterBackground:

data/docs/usage/rules.md

@@ -30,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.
 

data/lib/chutney.rb

@@ -8,6 +8,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'
@@ -46,7 +47,7 @@ module Chutney
     attr_accessor :verbose
     attr_reader :files
     attr_reader :results
-    
+
     def_delegators :@files, :<<, :clear, :delete, :include?
 
     def initialize(*files)
@@ -57,7 +58,7 @@ module Chutney
 
       I18n.load_path << i18n_paths
     end
-    
+
     def configuration
       unless @config
         default_file = [File.expand_path('..', __dir__), '**/config', 'chutney.yml']
@@ -66,11 +67,11 @@ module Chutney
       end
       @config
     end
-    
+
     def configuration=(config)
       @config = config
     end
-    
+
     def analyse
       files.each do |f|
         lint(f)
@@ -80,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

@@ -68,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
@@ -82,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
     

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/version.rb

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

data/lib/config/locales/en.yml

@@ -21,6 +21,8 @@ en:
       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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.1
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -247,6 +247,7 @@ files:
 - 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