chutney 2.0.3 → 3.0.0.beta.1

data/lib/chutney/linter/avoid_full_stop.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for avoiding periods
   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? '.'
+        add_issue(I18n.t('linters.avoid_full_stop'), feature, child, step) if step.text.strip.end_with? '.'
         
       end
     end

data/lib/chutney/linter/avoid_outline_for_single_example.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for avoiding outline for single example
   class AvoidOutlineForSingleExample < Linter
     def lint
-      scenarios do |feature, scenario|
-        next unless scenario[:type] == :ScenarioOutline
-
-        next unless scenario.key? :examples
-        next if scenario[:examples].length > 1
-        next if scenario[:examples].first[:tableBody].length > 1
+      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

data/lib/chutney/linter/avoid_scripting.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for avoid scripting
   class AvoidScripting < Linter  
     def lint
       scenarios do |feature, scenario|
-        when_steps = filter_when_steps(scenario[:steps])
+        when_steps = filter_when_steps(scenario.steps)
         whens = when_steps.count
         add_issue(I18n.t('linters.avoid_scripting', count: whens), feature, scenario, when_steps.last) if whens > 1
       end
@@ -11,9 +13,9 @@ module Chutney
     
     def filter_when_steps(steps)
       steps
-        .drop_while { |step| !when_word?(step[:keyword]) }
-        .then { |s| s.reverse.drop_while { |step| !then_word?(step[:keyword]) }.reverse }
-        .then { |s| s.reject { |step| then_word?(step[:keyword]) } }
+        .drop_while { |step| !when_word?(step.keyword) }
+        .then { |s| s.reverse.drop_while { |step| !then_word?(step.keyword) }.reverse }
+        .then { |s| s.reject { |step| then_word?(step.keyword) } }
     end
   end
 end

data/lib/chutney/linter/avoid_typographers_quotes.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+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(feature, scenario)
+
+        example_count = scenario.is_a?(CukeModeler::Outline) ? scenario.examples.length : 0
+        next unless example_count.positive?
+
+        lint_examples(feature, scenario)
+      end
+    end
+
+    def lint_steps(feature, scenario)
+      scenario.steps.each do |step|
+        issue(feature, scenario, step) if TYPOGRAPHER_QUOTES.any? { |tq| step.text.include? tq }
+      end
+    end
+
+    def lint_examples(feature, scenario)
+      scenario.examples.each do |example|
+        example.rows.each do |row|
+          row.cells.each do |cell|
+            issue(feature, scenario, cell) if TYPOGRAPHER_QUOTES.any? { |tq| cell.value.include? tq }
+          end
+        end
+      end
+    end
+
+    def issue(feature, scenario, location)
+      add_issue(I18n.t('linters.avoid_typographers_quotes'), feature, scenario, location)
+    end
+  end
+end

data/lib/chutney/linter/background_does_more_than_setup.rb

@@ -1,16 +1,18 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for background that does more than setup
   class BackgroundDoesMoreThanSetup < Linter   
     def lint
       background do |feature, background|
-        next unless background.key? :steps
-        
-        invalid_steps = background[:steps].select do |step| 
-          when_word?(step[:keyword]) || then_word?(step[:keyword])
+      
+        invalid_steps = background&.steps&.select do |step| 
+          when_word?(step.keyword) || then_word?(step.keyword)
         end
-        next if invalid_steps.empty?
+        
+        next if invalid_steps.nil? || invalid_steps.empty?
 
-        add_issue(I18n.t('linters.background_does_more_than_setup'), feature, background)
+        add_issue(I18n.t('linters.background_does_more_than_setup'), feature, background, invalid_steps.first)
       end
     end
   end

data/lib/chutney/linter/background_requires_multiple_scenarios.rb

@@ -1,14 +1,17 @@
+# frozen_string_literal: true
+
 require 'chutney/linter'
 
 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'.freeze
+    MESSAGE = 'Avoid using Background steps for just one scenario'
   
     def lint
       background do |feature, background|
-        scenarios = feature[:children].reject { |element| element[:type] == :Background }
-        next if scenarios.length >= 2
+        next unless background
+        next unless feature&.tests
+        next if feature.tests.length >= 2
 
         add_issue(I18n.t('linters.background_requires_multiple_scenarios'), feature, background)
       end

data/lib/chutney/linter/bad_scenario_name.rb

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

data/lib/chutney/linter/empty_feature_file.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+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

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 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
         
       expected_feature_name = title_case(filename)
-      return if ignore_whitespaces(feature[:name]).casecmp(ignore_whitespaces(expected_feature_name)) == 0
+      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) 
     end

data/lib/chutney/linter/givens_after_background.rb

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

data/lib/chutney/linter/invalid_file_name.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'chutney/linter'
 
 module Chutney

data/lib/chutney/linter/invalid_step_flow.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for invalid step flow
   class InvalidStepFlow < Linter
     def lint
       filled_scenarios do |feature, scenario|
-        steps = scenario[:steps].select { |step| !and_word?(step[:keyword]) && !but_word?(step[:keyword]) }
+        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)
@@ -13,7 +15,7 @@ module Chutney
     end
 
     def last_step_is_an_action(feature, scenario, steps)
-      return unless when_word?(steps.last[:keyword])
+      return unless when_word?(steps.last.keyword)
 
       add_issue(I18n.t('linters.invalid_step_flow.action_last'), feature, scenario, steps.last)
     end
@@ -21,7 +23,7 @@ module Chutney
     def given_after_non_given(feature, scenario, steps)
       last_step = steps.first
       steps.each do |step|
-        if given_word?(step[:keyword]) && !given_word?(last_step[:keyword])
+        if given_word?(step.keyword) && !given_word?(last_step.keyword)
           add_issue(I18n.t('linters.invalid_step_flow.given_order'), feature, scenario, step)
         end
         last_step = step
@@ -30,11 +32,9 @@ module Chutney
 
     def verification_before_action(feature, scenario, steps)
       steps.each do |step|
-        break if when_word?(step[:keyword])
+        break if when_word?(step.keyword)
         
-        if then_word?(step[:keyword])
-          add_issue(I18n.t('linters.invalid_step_flow.missing_action'), feature, scenario)
-        end
+        add_issue(I18n.t('linters.invalid_step_flow.missing_action'), feature, scenario) if then_word?(step.keyword)
       end
     end
   end

data/lib/chutney/linter/missing_example_name.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for missing example names
   class MissingExampleName < Linter
   
     def lint
       scenarios do |_feature, scenario|
-        next unless scenario[:examples]
+        next unless scenario.is_a? CukeModeler::Outline
 
-        scenario[:examples].each do |example|
-          example_count = scenario[:examples]&.length || 0
+        scenario.examples.each do |example|
+          example_count = scenario.examples&.length || 0
           next unless example_count > 1
           
           check_example(scenario, example)
@@ -16,8 +18,8 @@ module Chutney
     end               
 
     def check_example(scenario, example)
-      name = example.key?(:name) ? example[:name].strip : ''
-      duplicate_name_count = scenario[:examples].filter { |e| e[:name] == name }.count
+      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
     

data/lib/chutney/linter/missing_feature_description.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for missing feature descriptions
   class MissingFeatureDescription < Linter
-    MESSAGE = 'Features should have a description so that its purpose is clear'.freeze
+    MESSAGE = 'Features should have a description so that its purpose is clear'
     def lint
-      name = feature.key?(:description) ? feature[:description].strip : ''
-      add_issue(I18n.t('linters.missing_feature_description'), feature) if name.empty?
+      return unless feature
+      
+      add_issue(I18n.t('linters.missing_feature_description'), feature) if feature.description.empty?
     end
   end
 end

data/lib/chutney/linter/missing_feature_name.rb

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

data/lib/chutney/linter/missing_scenario_name.rb

@@ -1,13 +1,12 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for missing scenario names
   class MissingScenarioName < Linter  
   
     def lint
       scenarios do |feature, scenario|
-        name = scenario.key?(:name) ? scenario[:name].strip : ''
-        next unless name.empty?
-        
-        add_issue(I18n.t('linters.missing_scenario_name'), feature, scenario) if name.empty?
+        add_issue(I18n.t('linters.missing_scenario_name'), feature, scenario) if scenario.name.empty?
       end
     end
   end

data/lib/chutney/linter/missing_test_action.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for missing test actions
   class MissingTestAction < Linter
     def lint
       filled_scenarios do |feature, scenario|
-        when_steps = scenario[:steps].select { |step| when_word?(step[:keyword]) }
+        when_steps = scenario.steps.select { |step| when_word?(step.keyword) }
         next unless when_steps.empty?
         
         add_issue(I18n.t('linters.missing_test_action'), feature, scenario)

data/lib/chutney/linter/missing_verification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'chutney/linter'
 
 module Chutney
@@ -5,7 +7,7 @@ module Chutney
   class MissingVerification < Linter
     def lint
       filled_scenarios do |feature, scenario|
-        then_steps = scenario[:steps].select { |step| then_word?(step[:keyword]) }
+        then_steps = scenario.steps.select { |step| then_word?(step.keyword) }
         next unless then_steps.empty?
         
         add_issue(I18n.t('linters.missing_test_verification'), feature, scenario)

data/lib/chutney/linter/required_tags_starts_with.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Chutney
   # service class to lint for tags used multiple times
   class RequiredTagsStartsWith < Linter

data/lib/chutney/linter/same_tag_for_all_scenarios.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 require 'chutney/linter'
 
 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&.scenarios
+      lint_examples  if feature&.scenarios
     end
 
     def lint_scenarios
       tags = scenario_tags
       return if tags.nil? || tags.empty?
-      return unless feature[:children].length > 1
+      return unless feature.tests.length > 1
             
       tags.each do |tag|
         next if tag == 'skip'
@@ -25,10 +27,11 @@ module Chutney
     end
 
     def lint_examples
-      feature[:children].each do |scenario|
+      scenarios do |_feature, scenario|
         tags = example_tags(scenario)
         next if tags.nil? || tags.empty?
-        next unless scenario[:examples].length > 1
+        next unless scenario.is_a? CukeModeler::Outline
+        next unless scenario.examples.length > 1
         
         tags.each do |tag|
           next if tag == 'skip'
@@ -42,8 +45,6 @@ module Chutney
     def scenario_tags
       result = nil
       scenarios do |_feature, scenario|
-        next if scenario[:type] == :Background
-
         tags = tags_for(scenario)
         result ||= tags
         result &= tags
@@ -53,10 +54,10 @@ module Chutney
 
     def example_tags(scenario)
       result = nil
-      return result unless scenario.include? :examples
+      return result unless scenario.is_a?(CukeModeler::Outline) && scenario.examples
       
-      scenario[:examples].each do |example|
-        return nil unless example.include? :tags
+      scenario.examples.each do |example|
+        return nil unless example.tags
         
         tags = tags_for(example)
         result = tags if result.nil?