chutney 3.0.0.beta.1 → 3.1.1

data/lib/chutney/formatter/rainbow_formatter.rb

@@ -5,37 +5,36 @@ 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?
@@ -44,6 +43,5 @@ module Chutney
         puts @pastel.red("#{files_with_issues.count} taste nasty")
       end
     end
-    
   end
 end

data/lib/chutney/linter.rb

@@ -7,7 +7,7 @@ module Chutney
   class Linter
     attr_accessor :issues
     attr_reader :filename, :configuration
-  
+
     Lint = Struct.new(:message, :gherkin_type, :location, :feature, :scenario, :step, keyword_init: true)
 
     def self.descendants
@@ -19,63 +19,61 @@ module Chutney
       @filename = filename
       @issues = []
       @configuration = configuration
-      #       language = @content.dig(:feature, :language) || 'en'
-      #       @dialect = Gherkin::Dialect.for(language)
     end
 
     def lint
       raise 'not implemented'
     end
-    
+
     def and_word?(word)
       dialect_word(:and).include?(word)
     end
-    
+
     def background_word?(word)
       dialect_word(:background).include?(word)
     end
-    
+
     def but_word?(word)
       dialect_word(:but).include?(word)
     end
-    
+
     def examples_word?(word)
       dialect_word(:examples).include?(word)
     end
-    
+
     def feature_word?(word)
       dialect_word(:feature).include?(word)
     end
-    
+
     def given_word?(word)
       dialect_word(:given).include?(word)
     end
-    
+
     def scenario_outline_word?(word)
       dialect_word(:scenarioOutline).include?(word)
     end
-    
+
     def then_word?(word)
       dialect_word(:then).include?(word)
     end
-    
+
     def when_word?(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)
-      element.tags.map { |tag| tag.name[1..-1] }
+      element.tags.map { |tag| tag.name[1..] }
     end
-    
-    def add_issue(message, feature = nil, scenario = nil, item = nil)      
+
+    def add_issue(message, feature = nil, scenario = nil, item = nil)
       issues << Lint.new(
         message: message,
         gherkin_type: type(feature, scenario, item),
@@ -85,17 +83,17 @@ module Chutney
         step: item&.parsing_data&.dig(:name)
       ).to_h
     end
-    
+
     def location(feature, scenario, step)
       if step
         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
+      else
+        feature ? feature.parsing_data[:location] : { line: 0, column: 0 }
       end
     end
-    
+
     def type(_feature, scenario, step)
       if step
         :step
@@ -111,14 +109,14 @@ module Chutney
         @content.feature
       end
     end
-    
-    def elements 
+
+    def elements
       return [] unless feature
-      
-      if block_given? 
+
+      if block_given?
         feature.children.each do |child|
           next if off_switch?(child)
-        
+
           yield(feature, child)
         end
       else
@@ -128,56 +126,65 @@ module Chutney
 
     def off_switch?(element = feature)
       off_switch = element.tags
+                          .map(&:name)
                           .then { |tags| tags || [] }
-                          .filter { |tag| tag[:type] == :Tag }
-                          .filter { |tag| tag[:name] == "@disable#{linter_name}" }
+                          .filter { |tag_name| tag_name == "@disable#{linter_name}" }
                           .count
                           .positive?
       off_switch ||= off_switch?(feature) unless element == feature
       off_switch
     end
-    
+
     def background
-      if block_given?          
-        yield(feature, feature&.background)
+      return unless feature&.background
+      return if off_switch?(feature)
+
+      if block_given?
+        yield(feature, feature.background)
       else
-        feature&.background
+        feature.background
       end
     end
-    
+
     def scenarios
       if block_given?
         feature&.tests&.each do |test|
+          next if off_switch?(test)
+
           yield(feature, test)
         end
-        
+
       else
         feature&.tests
       end
     end
-    
+
     def filled_scenarios
       if block_given?
         scenarios do |feature, scenario|
           next if scenario.steps.empty?
-        
+
           yield(feature, scenario)
         end
       else
         scenarios ? scenarios.filter { |s| !s.steps.empty? } : []
       end
     end
-    
+
     def steps
-      feature&.tests&.each do |t|
-        t.steps.each { |s| yield(feature, t, s) }
+      feature&.tests&.each do |test|
+        next if off_switch?(test)
+
+        test.steps.each do |step|
+          yield(feature, test, step)
+        end
       end
     end
 
     def self.linter_name
       name.split('::').last
     end
-    
+
     def linter_name
       self.class.linter_name
     end
@@ -187,10 +194,10 @@ module Chutney
       value += render_step_argument(step.block) if step.block
       value
     end
-    
+
     def render_step_argument(argument)
       return "\n#{argument.content}" if argument.is_a?(CukeModeler::DocString)
-      
+
       result = argument.rows.map do |row|
         "|#{row.cells.map(&:value).join '|'}|"
       end.join "\n"

data/lib/chutney/linter/avoid_full_stop.rb

@@ -2,12 +2,10 @@
 
 module Chutney
   # service class to lint for avoiding periods
-  class AvoidFullStop < Linter    
+  class AvoidFullStop < Linter
     def lint
       steps do |feature, child, step|
-        
         add_issue(I18n.t('linters.avoid_full_stop'), feature, child, step) if step.text.strip.end_with? '.'
-        
       end
     end
   end

data/lib/chutney/linter/avoid_outline_for_single_example.rb

@@ -4,13 +4,13 @@ module Chutney
   # service class to lint for avoiding outline for single example
   class AvoidOutlineForSingleExample < Linter
     def lint
-      scenarios do |feature, scenario|      
+      scenarios do |feature, scenario|
         next unless scenario.is_a? CukeModeler::Outline
         next unless scenario.examples
-        
+
         next if scenario.examples.length > 1
         next if scenario.examples.first.rows.length > 2 # first row is the header
-        
+
         add_issue(I18n.t('linters.avoid_outline_for_single_example'), feature, scenario)
       end
     end

data/lib/chutney/linter/avoid_scripting.rb

@@ -2,7 +2,7 @@
 
 module Chutney
   # service class to lint for avoid scripting
-  class AvoidScripting < Linter  
+  class AvoidScripting < Linter
     def lint
       scenarios do |feature, scenario|
         when_steps = filter_when_steps(scenario.steps)
@@ -10,7 +10,7 @@ module Chutney
         add_issue(I18n.t('linters.avoid_scripting', count: whens), feature, scenario, when_steps.last) if whens > 1
       end
     end
-    
+
     def filter_when_steps(steps)
       steps
         .drop_while { |step| !when_word?(step.keyword) }

data/lib/chutney/linter/background_does_more_than_setup.rb

@@ -2,14 +2,13 @@
 
 module Chutney
   # service class to lint for background that does more than setup
-  class BackgroundDoesMoreThanSetup < Linter   
+  class BackgroundDoesMoreThanSetup < Linter
     def lint
       background do |feature, background|
-      
-        invalid_steps = background&.steps&.select do |step| 
+        invalid_steps = background&.steps&.select do |step|
           when_word?(step.keyword) || then_word?(step.keyword)
         end
-        
+
         next if invalid_steps.nil? || invalid_steps.empty?
 
         add_issue(I18n.t('linters.background_does_more_than_setup'), feature, background, invalid_steps.first)

data/lib/chutney/linter/background_requires_multiple_scenarios.rb

@@ -6,7 +6,7 @@ module Chutney
   # service class for check that there are multiple scenarios once a background is used
   class BackgroundRequiresMultipleScenarios < Linter
     MESSAGE = 'Avoid using Background steps for just one scenario'
-  
+
     def lint
       background do |feature, background|
         next unless background

data/lib/chutney/linter/bad_scenario_name.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module Chutney
-  # service class to lint for bad scenario names  
+  # service class to lint for bad scenario names
   class BadScenarioName < Linter
     def lint
       scenarios do |feature, scenario|
         next if scenario.name.empty?
-        
+
         bad = /\w*(test|verif|check)\w*/i
         match = scenario.name.match(bad).to_a.first
         add_issue(I18n.t('linters.bad_scenario_name', word: match), feature, scenario) if match

data/lib/chutney/linter/file_name_differs_feature_name.rb

@@ -5,11 +5,11 @@ module Chutney
   class FileNameDiffersFeatureName < Linter
     def lint
       return unless feature
-        
+
       expected_feature_name = title_case(filename)
       return if ignore_whitespaces(feature.name).casecmp(ignore_whitespaces(expected_feature_name)) == 0
-        
-      add_issue(I18n.t('linters.file_name_differs_feature_name', expected: expected_feature_name), feature) 
+
+      add_issue(I18n.t('linters.file_name_differs_feature_name', expected: expected_feature_name), feature)
     end
 
     def title_case(value)

data/lib/chutney/linter/givens_after_background.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module Chutney
-  # service class to lint for bad scenario names  
+  # service class to lint for bad scenario names
   class GivensAfterBackground < Linter
     def lint
       return unless background
-      
+
       filled_scenarios do |feature, scenario|
         scenario.steps.each do |step|
           add_issue(I18n.t('linters.givens_after_background'), feature, scenario, step) if given_word?(step.keyword)

data/lib/chutney/linter/invalid_file_name.rb

@@ -13,7 +13,7 @@ module Chutney
         end
       end
     end
-    
+
     def recommend(filename)
       File.basename(filename, '.*').gsub(/::/, '/')
           .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')

data/lib/chutney/linter/invalid_step_flow.rb

@@ -7,7 +7,7 @@ module Chutney
       filled_scenarios do |feature, scenario|
         steps = scenario.steps.select { |step| !and_word?(step.keyword) && !but_word?(step.keyword) }
         next if steps.empty?
-        
+
         last_step_is_an_action(feature, scenario, steps)
         given_after_non_given(feature, scenario, steps)
         verification_before_action(feature, scenario, steps)
@@ -33,7 +33,7 @@ module Chutney
     def verification_before_action(feature, scenario, steps)
       steps.each do |step|
         break if when_word?(step.keyword)
-        
+
         add_issue(I18n.t('linters.invalid_step_flow.missing_action'), feature, scenario) if then_word?(step.keyword)
       end
     end

data/lib/chutney/linter/missing_example_name.rb

@@ -3,7 +3,6 @@
 module Chutney
   # service class to lint for missing example names
   class MissingExampleName < Linter
-  
     def lint
       scenarios do |_feature, scenario|
         next unless scenario.is_a? CukeModeler::Outline
@@ -11,17 +10,16 @@ module Chutney
         scenario.examples.each do |example|
           example_count = scenario.examples&.length || 0
           next unless example_count > 1
-          
+
           check_example(scenario, example)
         end
       end
-    end               
+    end
 
     def check_example(scenario, example)
       name = example.name.strip
       duplicate_name_count = scenario.examples.filter { |e| e.name == name }.count
       add_issue(I18n.t('linters.missing_example_name'), feature, scenario, example) if duplicate_name_count >= 2
     end
-    
   end
 end