cuke_linter 1.3.0 → 1.4.0

data/lib/cuke_linter/linters/test_with_bad_name_linter.rb

@@ -1,23 +1,23 @@
-module CukeLinter
-
-  # A linter that detects scenarios and outlines that have a bad name
-  class TestWithBadNameLinter < Linter
-
-    # 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)
-
-      lowercase_name = model.name.downcase
-
-      lowercase_name.include?('test') ||
-        lowercase_name.include?('verif') ||
-        lowercase_name.include?('check')
-    end
-
-    # The message used to describe the problem that has been found
-    def message
-      '"Test", "Verify" and "Check" should not be used in scenario names.'
-    end
-
-  end
-end
+module CukeLinter
+
+  # A linter that detects scenarios and outlines that have a bad name
+  class TestWithBadNameLinter < Linter
+
+    # 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)
+
+      lowercase_name = model.name.downcase
+
+      lowercase_name.include?('test') ||
+        lowercase_name.include?('verif') ||
+        lowercase_name.include?('check')
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      '"Test", "Verify" and "Check" should not be used in scenario names.'
+    end
+
+  end
+end

data/lib/cuke_linter/linters/test_with_no_action_step_linter.rb

@@ -1,33 +1,33 @@
-module CukeLinter
-
-  # A linter that detects scenarios and outlines that do not have an action (i.e. 'When') step
-  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)
-
-      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| when_keywords.include?(step.keyword) }
-    end
-
-    # The message used to describe the problem that has been found
-    def message
-      "Test does not have a 'When' step."
-    end
-
-    private
-
-    def when_keywords
-      @when_keywords || [DEFAULT_WHEN_KEYWORD]
-    end
-
-  end
-end
+module CukeLinter
+
+  # A linter that detects scenarios and outlines that do not have an action (i.e. 'When') step
+  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)
+
+      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| when_keywords.include?(step.keyword) }
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      "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_name_linter.rb

@@ -1,19 +1,19 @@
-module CukeLinter
-
-  # A linter that detects scenarios and outlines that do not have a name
-  class TestWithNoNameLinter < Linter
-
-    # 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)
-
-      model.name.nil? || model.name.empty?
-    end
-
-    # The message used to describe the problem that has been found
-    def message
-      'Test does not have a name.'
-    end
-
-  end
-end
+module CukeLinter
+
+  # A linter that detects scenarios and outlines that do not have a name
+  class TestWithNoNameLinter < Linter
+
+    # 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)
+
+      model.name.nil? || model.name.empty?
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      'Test does not have a name.'
+    end
+
+  end
+end

data/lib/cuke_linter/linters/test_with_no_verification_step_linter.rb

@@ -1,33 +1,33 @@
-module CukeLinter
-
-  # A linter that detects scenarios and outlines that do not have a verification (i.e. 'Then') step
-  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)
-
-      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| then_keywords.include?(step.keyword) }
-    end
-
-    # The message used to describe the problem that has been found
-    def message
-      "Test does not have a 'Then' step."
-    end
-
-    private
-
-    def then_keywords
-      @then_keywords || [DEFAULT_THEN_KEYWORD]
-    end
-
-  end
-end
+module CukeLinter
+
+  # A linter that detects scenarios and outlines that do not have a verification (i.e. 'Then') step
+  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)
+
+      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| then_keywords.include?(step.keyword) }
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      "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

@@ -1,46 +1,46 @@
-module CukeLinter
-
-  # A linter that detects scenarios and outlines that have a setup step that comes after an action step
-  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)
-
-      model_steps       = model.steps || []
-      action_step_found = false
-
-      model_steps.each do |step|
-        if action_step_found
-          return true if given_keywords.include?(step.keyword)
-        else
-          action_step_found = when_keywords.include?(step.keyword)
-        end
-      end
-
-      false
-    end
-
-    # The message used to describe the problem that has been found
-    def message
-      "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
+module CukeLinter
+
+  # A linter that detects scenarios and outlines that have a setup step that comes after an action step
+  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)
+
+      model_steps       = model.steps || []
+      action_step_found = false
+
+      model_steps.each do |step|
+        if action_step_found
+          return true if given_keywords.include?(step.keyword)
+        else
+          action_step_found = when_keywords.include?(step.keyword)
+        end
+      end
+
+      false
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      "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

@@ -1,46 +1,46 @@
-module CukeLinter
-
-  # A linter that detects scenarios and outlines that have a setup step that comes after a verification step
-  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)
-
-      model_steps             = model.steps || []
-      verification_step_found = false
-
-      model_steps.each do |step|
-        if verification_step_found
-          return true if given_keywords.include?(step.keyword)
-        else
-          verification_step_found = then_keywords.include?(step.keyword)
-        end
-      end
-
-      false
-    end
-
-    # The message used to describe the problem that has been found
-    def message
-      "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
+module CukeLinter
+
+  # A linter that detects scenarios and outlines that have a setup step that comes after a verification step
+  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)
+
+      model_steps             = model.steps || []
+      verification_step_found = false
+
+      model_steps.each do |step|
+        if verification_step_found
+          return true if given_keywords.include?(step.keyword)
+        else
+          verification_step_found = then_keywords.include?(step.keyword)
+        end
+      end
+
+      false
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      "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

@@ -1,33 +1,33 @@
-module CukeLinter
-
-  # A linter that detects scenarios and outlines that have a setup step as their final step
-  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)
-
-      model_steps = model.steps || []
-      return false unless model_steps.last
-
-      given_keywords.include?(model_steps.last.keyword)
-    end
-
-    # The message used to describe the problem that has been found
-    def message
-      "Test has 'Given' as the final step."
-    end
-
-    private
-
-    def given_keywords
-      @given_keywords || [DEFAULT_GIVEN_KEYWORD]
-    end
-
-  end
-end
+module CukeLinter
+
+  # A linter that detects scenarios and outlines that have a setup step as their final step
+  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)
+
+      model_steps = model.steps || []
+      return false unless model_steps.last
+
+      given_keywords.include?(model_steps.last.keyword)
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      "Test has 'Given' as the final step."
+    end
+
+    private
+
+    def given_keywords
+      @given_keywords || [DEFAULT_GIVEN_KEYWORD]
+    end
+
+  end
+end

data/lib/cuke_linter/linters/test_with_too_many_steps_linter.rb

@@ -1,27 +1,27 @@
-module CukeLinter
-
-  # A linter that detects scenarios and outlines that have too many steps
-  class TestWithTooManyStepsLinter < Linter
-
-    # Changes the linting settings on the linter using the provided configuration
-    def configure(options)
-      @step_threshold = options['StepThreshold'] if options['StepThreshold']
-    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)
-
-      @linted_step_count     = model.steps.nil? ? 0 : model.steps.count
-      @linted_step_threshold = @step_threshold || 10
-
-      @linted_step_count > @linted_step_threshold
-    end
-
-    # The message used to describe the problem that has been found
-    def message
-      "Test has too many steps. #{@linted_step_count} steps found (max #{@linted_step_threshold})."
-    end
-
-  end
-end
+module CukeLinter
+
+  # A linter that detects scenarios and outlines that have too many steps
+  class TestWithTooManyStepsLinter < Linter
+
+    # Changes the linting settings on the linter using the provided configuration
+    def configure(options)
+      @step_threshold = options['StepThreshold'] if options['StepThreshold']
+    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)
+
+      @linted_step_count     = model.steps.nil? ? 0 : model.steps.count
+      @linted_step_threshold = @step_threshold || 10
+
+      @linted_step_count > @linted_step_threshold
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      "Test has too many steps. #{@linted_step_count} steps found (max #{@linted_step_threshold})."
+    end
+
+  end
+end

data/lib/cuke_linter/version.rb

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