cuke_linter 0.12.0 → 1.1.0

data/lib/cuke_linter/linters/linter.rb

@@ -4,6 +4,9 @@ module CukeLinter
 
   class Linter
 
+    # Returns the name of the linter
+    attr_reader :name
+
     # Creates a new linter object
     def initialize(name: nil, message: nil, rule: nil)
       @name    = name || self.class.name.split('::').last
@@ -11,27 +14,28 @@ module CukeLinter
       @rule    = rule
     end
 
-    # Returns the name of the linter
-    def name
-      @name
-    end
-
     # Lints the given model and returns linting data about said model
     def lint(model)
       raise 'No linting rule provided!' unless @rule || respond_to?(:rule)
 
       problem_found = respond_to?(:rule) ? rule(model) : @rule.call(model)
 
-      if problem_found
-        problem_message = respond_to?(:message) ? message : @message
+      return nil unless problem_found
+
+      build_problem(model)
+    end
+
+
+    private
+
+
+    def build_problem(model)
+      problem_message = respond_to?(:message) ? message : @message
 
-        if model.is_a?(CukeModeler::FeatureFile)
-          { problem: problem_message, location: "#{model.path}" }
-        else
-          { problem: problem_message, location: "#{model.get_ancestor(:feature_file).path}:#{model.source_line}" }
-        end
+      if model.is_a?(CukeModeler::FeatureFile)
+        { problem: problem_message, location: model.path }
       else
-        nil
+        { problem: problem_message, location: "#{model.get_ancestor(:feature_file).path}:#{model.source_line}" }
       end
     end
 

data/lib/cuke_linter/linters/step_with_too_many_characters_linter.rb

@@ -15,8 +15,8 @@ module CukeLinter
     # The rule used to determine if a model has a problem
     def rule(model)
       return false unless model.is_a?(CukeModeler::Step)
-        
-      @linted_step_length = model.text&.length || 0
+
+      @linted_step_length = model.text.nil? ? 0 : model.text.length
 
       @linted_step_length > step_length_threshold
     end

data/lib/cuke_linter/linters/test_should_use_background_linter.rb

@@ -1,5 +1,6 @@
 module CukeLinter
 
+  # TODO: Make a new class that it is from the POV of a Feature model instead
   # A linter that detects scenarios and outlines within a feature that all share common beginning steps
 
   class TestShouldUseBackgroundLinter < Linter
@@ -13,10 +14,10 @@ module CukeLinter
 
       return false unless parent_feature_model.tests.count > 1
 
-      parent_feature_model.tests.all? do |test|
-        test_steps = test.steps || []
-        test_steps.first == model_steps.first
-      end
+      matching_steps     = all_first_steps_match?(parent_feature_model, model_steps)
+      none_parameterized = no_parameterized_steps?(parent_feature_model)
+
+      matching_steps && none_parameterized
     end
 
     # The message used to describe the problem that has been found
@@ -24,5 +25,56 @@ module CukeLinter
       'Test shares steps with all other tests in feature. Use a background.'
     end
 
+
+    private
+
+
+    def all_first_steps_match?(feature_model, model_steps)
+      feature_model.tests.all? do |test|
+        test_steps = test.steps || []
+        test_steps.first == model_steps.first
+      end
+    end
+
+    def no_parameterized_steps?(feature_model)
+      feature_model.tests.none? do |test|
+        next false if test.is_a?(CukeModeler::Scenario)
+
+        test_steps          = test.steps || []
+        params_used_by_test = test.examples.map(&:parameters).flatten.uniq
+
+        next false unless test_steps.any?
+
+        parameterized_step?(test_steps.first, parameters: params_used_by_test)
+      end
+    end
+
+    def parameterized_step?(step_model, parameters:)
+      parameters.any? do |parameter|
+        parameter_string = "<#{parameter}>"
+
+        parameterized_text?(step_model, parameter_string) ||
+          parameterized_doc_string?(step_model, parameter_string) ||
+          parameterized_table?(step_model, parameter_string)
+      end
+    end
+
+    def parameterized_text?(step_model, parameter)
+      step_model.text.include?(parameter)
+    end
+
+    def parameterized_doc_string?(step_model, parameter)
+      return false unless step_model.block.is_a?(CukeModeler::DocString)
+
+      step_model.block.content.include?(parameter)
+    end
+
+    def parameterized_table?(step_model, parameter)
+      return false unless step_model.block.is_a?(CukeModeler::Table)
+
+      step_model.block.rows.map(&:cells).flatten.map(&:value).any? { |cell_text| cell_text.include?(parameter) }
+    end
+
   end
+
 end

data/lib/cuke_linter/linters/test_with_action_step_as_final_step_linter.rb

@@ -4,6 +4,11 @@ module CukeLinter
 
   class TestWithActionStepAsFinalStepLinter < Linter
 
+    # Changes the linting settings on the linter using the provided configuration
+    def configure(options)
+      @when_keywords = options['When']
+    end
+
     # The rule used to determine if a model has a problem
     def rule(model)
       return false unless model.is_a?(CukeModeler::Scenario) || model.is_a?(CukeModeler::Outline)
@@ -11,7 +16,7 @@ module CukeLinter
       model_steps = model.steps || []
       return false unless model_steps.last
 
-      model_steps.last.keyword == 'When'
+      when_keywords.include?(model_steps.last.keyword)
     end
 
     # The message used to describe the problem that has been found
@@ -19,5 +24,11 @@ module CukeLinter
       "Test has 'When' as the final step."
     end
 
+    private
+
+    def when_keywords
+      @when_keywords || [DEFAULT_WHEN_KEYWORD]
+    end
+
   end
 end

data/lib/cuke_linter/linters/test_with_bad_name_linter.rb

@@ -9,10 +9,10 @@ module CukeLinter
       return false unless model.is_a?(CukeModeler::Scenario) || model.is_a?(CukeModeler::Outline)
 
       lowercase_name = model.name.downcase
-      return true if lowercase_name.include?('test') ||
-                     lowercase_name.include?('verif') ||
-                     lowercase_name.include?('check')
-      false
+
+      lowercase_name.include?('test') ||
+        lowercase_name.include?('verif') ||
+        lowercase_name.include?('check')
     end
 
     # The message used to describe the problem that has been found

data/lib/cuke_linter/linters/test_with_no_action_step_linter.rb

@@ -4,6 +4,11 @@ module CukeLinter
 
   class TestWithNoActionStepLinter < Linter
 
+    # Changes the linting settings on the linter using the provided configuration
+    def configure(options)
+      @when_keywords = options['When']
+    end
+
     # The rule used to determine if a model has a problem
     def rule(model)
       return false unless model.is_a?(CukeModeler::Scenario) || model.is_a?(CukeModeler::Outline)
@@ -11,7 +16,7 @@ module CukeLinter
       model_steps      = model.steps || []
       background_steps = model.parent_model.has_background? ? model.parent_model.background.steps || [] : []
       all_steps        = model_steps + background_steps
-      all_steps.none? { |step| step.keyword == 'When' }
+      all_steps.none? { |step| when_keywords.include?(step.keyword) }
     end
 
     # The message used to describe the problem that has been found
@@ -19,5 +24,11 @@ module CukeLinter
       "Test does not have a 'When' step."
     end
 
+    private
+
+    def when_keywords
+      @when_keywords || [DEFAULT_WHEN_KEYWORD]
+    end
+
   end
 end

data/lib/cuke_linter/linters/test_with_no_verification_step_linter.rb

@@ -4,6 +4,11 @@ module CukeLinter
 
   class TestWithNoVerificationStepLinter < Linter
 
+    # Changes the linting settings on the linter using the provided configuration
+    def configure(options)
+      @then_keywords = options['Then']
+    end
+
     # The rule used to determine if a model has a problem
     def rule(model)
       return false unless model.is_a?(CukeModeler::Scenario) || model.is_a?(CukeModeler::Outline)
@@ -11,7 +16,7 @@ module CukeLinter
       model_steps      = model.steps || []
       background_steps = model.parent_model.has_background? ? model.parent_model.background.steps || [] : []
       all_steps        = model_steps + background_steps
-      all_steps.none? { |step| step.keyword == 'Then' }
+      all_steps.none? { |step| then_keywords.include?(step.keyword) }
     end
 
     # The message used to describe the problem that has been found
@@ -19,5 +24,11 @@ module CukeLinter
       "Test does not have a 'Then' step."
     end
 
+    private
+
+    def then_keywords
+      @then_keywords || [DEFAULT_THEN_KEYWORD]
+    end
+
   end
 end

data/lib/cuke_linter/linters/test_with_setup_step_after_action_step_linter.rb

@@ -4,6 +4,12 @@ module CukeLinter
 
   class TestWithSetupStepAfterActionStepLinter < Linter
 
+    # Changes the linting settings on the linter using the provided configuration
+    def configure(options)
+      @given_keywords = options['Given']
+      @when_keywords  = options['When']
+    end
+
     # The rule used to determine if a model has a problem
     def rule(model)
       return false unless model.is_a?(CukeModeler::Scenario) || model.is_a?(CukeModeler::Outline)
@@ -13,9 +19,9 @@ module CukeLinter
 
       model_steps.each do |step|
         if action_step_found
-          return true if step.keyword == 'Given'
+          return true if given_keywords.include?(step.keyword)
         else
-          action_step_found = step.keyword == 'When'
+          action_step_found = when_keywords.include?(step.keyword)
         end
       end
 
@@ -27,5 +33,15 @@ module CukeLinter
       "Test has 'Given' step after 'When' step."
     end
 
+    private
+
+    def given_keywords
+      @given_keywords || [DEFAULT_GIVEN_KEYWORD]
+    end
+
+    def when_keywords
+      @when_keywords || [DEFAULT_WHEN_KEYWORD]
+    end
+
   end
 end

data/lib/cuke_linter/linters/test_with_setup_step_after_verification_step_linter.rb

@@ -4,6 +4,12 @@ module CukeLinter
 
   class TestWithSetupStepAfterVerificationStepLinter < Linter
 
+    # Changes the linting settings on the linter using the provided configuration
+    def configure(options)
+      @given_keywords = options['Given']
+      @then_keywords  = options['Then']
+    end
+
     # The rule used to determine if a model has a problem
     def rule(model)
       return false unless model.is_a?(CukeModeler::Scenario) || model.is_a?(CukeModeler::Outline)
@@ -13,9 +19,9 @@ module CukeLinter
 
       model_steps.each do |step|
         if verification_step_found
-          return true if step.keyword == 'Given'
+          return true if given_keywords.include?(step.keyword)
         else
-          verification_step_found = step.keyword == 'Then'
+          verification_step_found = then_keywords.include?(step.keyword)
         end
       end
 
@@ -27,5 +33,15 @@ module CukeLinter
       "Test has 'Given' step after 'Then' step."
     end
 
+    private
+
+    def given_keywords
+      @given_keywords || [DEFAULT_GIVEN_KEYWORD]
+    end
+
+    def then_keywords
+      @then_keywords || [DEFAULT_THEN_KEYWORD]
+    end
+
   end
 end

data/lib/cuke_linter/linters/test_with_setup_step_as_final_step_linter.rb

@@ -4,6 +4,11 @@ module CukeLinter
 
   class TestWithSetupStepAsFinalStepLinter < Linter
 
+    # Changes the linting settings on the linter using the provided configuration
+    def configure(options)
+      @given_keywords = options['Given']
+    end
+
     # The rule used to determine if a model has a problem
     def rule(model)
       return false unless model.is_a?(CukeModeler::Scenario) || model.is_a?(CukeModeler::Outline)
@@ -11,7 +16,7 @@ module CukeLinter
       model_steps = model.steps || []
       return false unless model_steps.last
 
-      model_steps.last.keyword == 'Given'
+      given_keywords.include?(model_steps.last.keyword)
     end
 
     # The message used to describe the problem that has been found
@@ -19,5 +24,11 @@ module CukeLinter
       "Test has 'Given' as the final step."
     end
 
+    private
+
+    def given_keywords
+      @given_keywords || [DEFAULT_GIVEN_KEYWORD]
+    end
+
   end
 end

data/lib/cuke_linter/version.rb

@@ -1,4 +1,4 @@
 module CukeLinter
   # The release version of this gem
-  VERSION = '0.12.0'
+  VERSION = '1.1.0'.freeze
 end

data/testing/cucumber/features/linters/background_does_more_than_setup.feature

@@ -48,3 +48,37 @@ Feature: Background does more than setup linter
       """
     When it is linted
     Then no error is reported
+
+  Scenario Outline: Configuration of keywords for different dialect
+    Given a linter for backgrounds that do more than setup has been registered
+    And the following configuration file:
+      """
+      BackgroundDoesMoreThanSetupLinter:
+        Given:
+          - Dado
+        When:
+          - Quando
+        Then:
+          - Então
+          - Entao
+      """
+    And the following feature:
+      """
+      # language:pt
+      Funcionalidade: Feature name
+
+        Contexto: A Background in pt dialect
+          Dado some setup in pt dialect
+          <step>
+      """
+    When the configuration file is loaded
+    And it is linted
+    Then an error is reported:
+      | linter                            | problem                        | location         |
+      | BackgroundDoesMoreThanSetupLinter | Background has non-setup steps | <path_to_file>:4 |
+
+    Examples:
+      | step                                          |
+      | Quando this is an action in pt dialect        |
+      | Então this is a validation in pt dialect      |
+      | Entao this is also a validation in pt dialect |

data/testing/cucumber/features/linters/test_with_action_as_final_step.feature

@@ -22,7 +22,29 @@ Feature: Test with action step as final step linter
       | linter                              | problem                            | location         |
       | TestWithActionStepAsFinalStepLinter | Test has 'When' as the final step. | <path_to_file>:3 |
 
-  @wip
-  Scenario: Configuration
+  Scenario: Configuration of keywords for different dialect
+    Given a linter for tests with an action step as the final step has been registered
+    And the following configuration file:
+      """
+      TestWithActionStepAsFinalStepLinter:
+        Given:
+          - Dado
+        When:
+          - Quando
+          - '*'
+        Then:
+          - Então
+      """
+    And the following feature:
+      """
+      # language:pt
+      Funcionalidade: Feature name
 
-  Configure the keyword(s) that count as action steps?
+        Cenário: scenario name
+          Quando this is an action in pt dialect
+      """
+    When the configuration file is loaded
+    And it is linted
+    Then an error is reported:
+      | linter                              | problem                            | location         |
+      | TestWithActionStepAsFinalStepLinter | Test has 'When' as the final step. | <path_to_file>:4 |