cuke_linter 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b5619ded0f8f0a4db213f7c2505b8868865ea4f5a40991515bf8324c474d5b4
-  data.tar.gz: 93c3214e99988dcfd03d6ce2eb15d291b8a1bbbc04a9af0f5c6f280a6fdccd6d
+  metadata.gz: 58a53b185027cee980dfa4801a9e2cb3ca7efdbd2cc0db2119a04636e494ef87
+  data.tar.gz: f71c950b3132a8141e401f2ec385c0f3ed895385ca8309be636960a34d51c2ec
 SHA512:
-  metadata.gz: 325b5aadbcf822a5e00ffd1ca7db7c26c4e7c6d63673c509247c49364cd09a365b6c5bcb9e42d4a01ebfe12f8bd85378bc639bb41356bca5766c96334a934046
-  data.tar.gz: 6ba5e64086bc5f79716408d6383b281ef468e63dc405423f216c05d6b3a342c0fedf3d2fee9bc4ba8b896a6db8004a40852fb0ed245c8b89328ba4df52bf7402
+  metadata.gz: 16060efd013a6f783514efedd830db6a9ce431f786a630ed5a521c99863202ad500a72aaae8c08870d38ef22cc4b7edcba21a2f36e01512e79b7d6f6bad8b597
+  data.tar.gz: cdb8c1250a9e5bf5b6406ed05c74c4cdf97b46d3927e6bb0b4640ef966961afab29eb712667e8110aa92c610336c3a0edb9c134805c0e2beb2eb5c60a7c600b7

data/CHANGELOG.md

@@ -8,6 +8,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Nothing yet...
 
+
+## [0.7.0] - 2019-07-12
+
+### Added
+ - Linters can now be configured en masse instead of having to configure the same property for all of them individually.
+
+ - New linters
+   - ElementWithTooManyTagsLinter
+   - FeatureWithoutNameLinter
+   - TestWithNoActionStepLinter
+   - TestWithNoNameLinter
+   - TestWithNoVerificationStepLinter
+
 ## [0.6.0] - 2019-06-25
 
 ### Added
@@ -65,7 +78,8 @@ Nothing yet...
 - Custom linters, formatters, and command line usability
 
 
-[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v0.6.0...HEAD
+[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v0.7.0...HEAD
+[0.6.0]: https://github.com/enkessler/cuke_linter/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/enkessler/cuke_linter/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/enkessler/cuke_linter/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/enkessler/cuke_linter/compare/v0.3.1...v0.4.0

data/cuke_linter.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
 
+  # TODO: don't just include everything in the gem
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do

data/lib/cuke_linter.rb

@@ -5,13 +5,18 @@ require "cuke_linter/version"
 require 'cuke_linter/formatters/pretty_formatter'
 require 'cuke_linter/linters/linter'
 require 'cuke_linter/linters/background_does_more_than_setup_linter'
+require 'cuke_linter/linters/element_with_too_many_tags_linter'
 require 'cuke_linter/linters/example_without_name_linter'
+require 'cuke_linter/linters/feature_without_name_linter'
 require 'cuke_linter/linters/feature_without_description_linter'
 require 'cuke_linter/linters/feature_without_scenarios_linter'
 require 'cuke_linter/linters/outline_with_single_example_row_linter'
 require 'cuke_linter/linters/single_test_background_linter'
 require 'cuke_linter/linters/step_with_end_period_linter'
 require 'cuke_linter/linters/step_with_too_many_characters_linter'
+require 'cuke_linter/linters/test_with_no_action_step_linter'
+require 'cuke_linter/linters/test_with_no_name_linter'
+require 'cuke_linter/linters/test_with_no_verification_step_linter'
 require 'cuke_linter/linters/test_with_too_many_steps_linter'
 
 
@@ -20,12 +25,17 @@ require 'cuke_linter/linters/test_with_too_many_steps_linter'
 module CukeLinter
 
   @original_linters = { 'BackgroundDoesMoreThanSetupLinter' => BackgroundDoesMoreThanSetupLinter.new,
+                        'ElementWithTooManyTagsLinter'      => ElementWithTooManyTagsLinter.new,
                         'ExampleWithoutNameLinter'          => ExampleWithoutNameLinter.new,
                         'FeatureWithoutDescriptionLinter'   => FeatureWithoutDescriptionLinter.new,
+                        'FeatureWithoutNameLinter'          => FeatureWithoutNameLinter.new,
                         'FeatureWithoutScenariosLinter'     => FeatureWithoutScenariosLinter.new,
                         'OutlineWithSingleExampleRowLinter' => OutlineWithSingleExampleRowLinter.new,
                         'SingleTestBackgroundLinter'        => SingleTestBackgroundLinter.new,
                         'StepWithEndPeriodLinter'           => StepWithEndPeriodLinter.new,
+                        'TestWithNoActionStepLinter'        => TestWithNoActionStepLinter.new,
+                        'TestWithNoNameLinter'              => TestWithNoNameLinter.new,
+                        'TestWithNoVerificationStepLinter'  => TestWithNoVerificationStepLinter.new,
                         'StepWithTooManyCharactersLinter'   => StepWithTooManyCharactersLinter.new,
                         'TestWithTooManyStepsLinter'        => TestWithTooManyStepsLinter.new }
 
@@ -41,11 +51,22 @@ module CukeLinter
 
     config = config || YAML.load_file(config_file_path)
 
-    config.each_pair do |linter_name, options|
-      unregister_linter(linter_name) if options.key?('Enabled') && !options['Enabled']
+    common_config = config['AllLinters'] || {}
+    to_delete     = []
 
-      registered_linters[linter_name].configure(options) if registered_linters[linter_name] && registered_linters[linter_name].respond_to?(:configure)
+    registered_linters.each_pair do |name, linter|
+      linter_config = config[name] || {}
+      final_config  = common_config.merge(linter_config)
+
+      disabled = (final_config.key?('Enabled') && !final_config['Enabled'])
+
+      # Just save it for afterwards because modifying a collection while iterating through it is not a good idea
+      to_delete << name if disabled
+
+      linter.configure(final_config) if linter.respond_to?(:configure)
     end
+
+    to_delete.each { |linter_name| unregister_linter(linter_name) }
   end
 
   # Returns the registered linters to their default state

data/lib/cuke_linter/linters/element_with_too_many_tags_linter.rb

@@ -0,0 +1,41 @@
+module CukeLinter
+
+  # A linter that detects taggable Gherkin elements that have too many tags
+
+  class ElementWithTooManyTagsLinter < Linter
+
+    # Changes the linting settings on the linter using the provided configuration
+    def configure(options)
+      @tag_threshold   = options['TagCountThreshold']
+      @tag_inheritance = options['CountInheritedTags']
+    end
+
+    # The rule used to determine if a model has a problem
+    def rule(model)
+      return false unless model.is_a?(CukeModeler::Feature) ||
+          model.is_a?(CukeModeler::Scenario) ||
+          model.is_a?(CukeModeler::Outline) ||
+          model.is_a?(CukeModeler::Example)
+
+
+      @linted_model_class   = model.class
+      @linted_tag_threshold = @tag_threshold || 5
+
+      if @tag_inheritance
+        @linted_tag_count = model.all_tags.count
+      else
+        @linted_tag_count = model.tags.nil? ? 0 : model.tags.count
+      end
+
+      @linted_tag_count > @linted_tag_threshold
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      class_name = @linted_model_class.name.split('::').last
+
+      "#{class_name} has too many tags. #{@linted_tag_count} tags found (max #{@linted_tag_threshold})."
+    end
+
+  end
+end

data/lib/cuke_linter/linters/feature_without_name_linter.rb

@@ -0,0 +1,20 @@
+module CukeLinter
+
+  # A linter that detects features that don't have a name
+
+  class FeatureWithoutNameLinter < Linter
+
+    # The rule used to determine if a model has a problem
+    def rule(model)
+      return false unless model.is_a?(CukeModeler::Feature)
+
+      model.name.nil? || model.name.empty?
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      'Feature does not have a name.'
+    end
+
+  end
+end

data/lib/cuke_linter/linters/test_with_no_action_step_linter.rb

@@ -0,0 +1,23 @@
+module CukeLinter
+
+  # A linter that detects scenarios and outlines that do not have an action (i.e. 'When') step
+
+  class TestWithNoActionStepLinter < 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_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' }
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      "Test does not have a 'When' step."
+    end
+
+  end
+end

data/lib/cuke_linter/linters/test_with_no_name_linter.rb

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,23 @@
+module CukeLinter
+
+  # A linter that detects scenarios and outlines that do not have a verification (i.e. 'Then') step
+
+  class TestWithNoVerificationStepLinter < 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_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' }
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      "Test does not have a 'Then' step."
+    end
+
+  end
+end

data/lib/cuke_linter/linters/test_with_too_many_steps_linter.rb

@@ -21,7 +21,7 @@ module CukeLinter
 
     # 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})"
+      "Test has too many steps. #{@linted_step_count} steps found (max #{@linted_step_threshold})."
     end
 
   end

data/lib/cuke_linter/version.rb

@@ -1,4 +1,4 @@
 module CukeLinter
   # The release version of this gem
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/testing/cucumber/features/command_line.feature

@@ -59,15 +59,17 @@ Feature: Using cuke_linter on the command line
   Scenario: Specifying directories and files to lint
     Given the following feature file "some.feature":
       """
-      Feature:
+      Feature: Some feature
         Scenario: A scenario
-          * a step
+          When a step
+          Then a step
       """
     And the following feature file "a_directory/with_a.feature":
       """
-      Feature:
+      Feature: Some feature
         Scenario: A scenario
-          * a step
+          When a step
+          Then a step
       """
     When the following command is executed:
       """

data/testing/cucumber/features/configuration/configuring_linters.feature

@@ -17,3 +17,39 @@ Feature: Configuration of linters
     When the configuration file is used
     And the feature is linted
     Then no error is reported
+
+  Scenario: Setting a common configuration for all linters
+
+  Note: Any property could be set for all linters, but disabling them (and then re-enabling a select few) is one of the few things that you are likely to want to do to all linters.
+
+    Given a linter registered as "AlwaysFindsAProblem"
+    And the following configuration file:
+      """
+      AllLinters:
+        Enabled: false
+      """
+    And the following feature:
+      """
+      Feature: Something in which a problem could exist
+      """
+    When the configuration file is used
+    And the feature is linted
+    Then no error is reported
+
+  Scenario: Overriding a common configuration
+    Given a linter registered as "AlwaysFindsAProblem"
+    And the following configuration file:
+      """
+      AllLinters:
+        Enabled: false
+
+      AlwaysFindsAProblem:
+        Enabled: true
+      """
+    And the following feature:
+      """
+      Feature: Something in which a problem could exist
+      """
+    When the configuration file is used
+    And the feature is linted
+    Then an error is reported

data/testing/cucumber/features/linters/{background_does_more_than_setup_linter.feature → background_does_more_than_setup.feature}

@@ -16,7 +16,7 @@ Feature: Background does more than setup linter
           When some action
       """
     When it is linted
-    Then an error is reported
+    Then an error is reported:
       | linter                            | problem                        | location         |
       | BackgroundDoesMoreThanSetupLinter | Background has non-setup steps | <path_to_file>:3 |
 
@@ -31,7 +31,7 @@ Feature: Background does more than setup linter
           Then some verification
       """
     When it is linted
-    Then an error is reported
+    Then an error is reported:
       | linter                            | problem                        | location         |
       | BackgroundDoesMoreThanSetupLinter | Background has non-setup steps | <path_to_file>:3 |
 

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

@@ -1,6 +1,6 @@
 Feature: Custom linters
 
-  In addition to the linters provided by CukeSlicer, custom linters can be used. A linter is essentially any object that provides a few needed methods. In order to simplify the creation of custom linters, a base linter class is available that provides these needed methods.
+  In addition to the linters provided by CukeLinter, custom linters can be used. A linter is essentially any object that provides a few needed methods. In order to simplify the creation of custom linters, a base linter class is available that provides these needed methods.
 
 
   Scenario: Creating a custom linter object
@@ -19,7 +19,7 @@ Feature: Custom linters
       """
     And a model to lint
     When the model is linted
-    Then an error is reported
+    Then an error is reported:
       | linter         | problem           | location                           |
       | MyCustomLinter | My custom message | <path_to_file>:<model_line_number> |
 
@@ -49,6 +49,6 @@ Feature: Custom linters
       """
     And a model to lint
     When the model is linted
-    Then an error is reported
+    Then an error is reported:
       | linter         | problem           | location                           |
       | MyCustomLinter | My custom message | <path_to_file>:<model_line_number> |

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

@@ -9,17 +9,21 @@ Feature: Default Linters
     Given no other linters have been registered or unregistered
     Then the following linters are registered by default
       | BackgroundDoesMoreThanSetupLinter |
+      | ElementWithTooManyTagsLinter      |
       | ExampleWithoutNameLinter          |
       | FeatureWithoutDescriptionLinter   |
+      | FeatureWithoutNameLinter          |
       | FeatureWithoutScenariosLinter     |
       | OutlineWithSingleExampleRowLinter |
       | SingleTestBackgroundLinter        |
       | StepWithEndPeriodLinter           |
       | StepWithTooManyCharactersLinter   |
+      | TestWithNoActionStepLinter        |
+      | TestWithNoNameLinter              |
+      | TestWithNoVerificationStepLinter  |
       | TestWithTooManyStepsLinter        |
 
 
-
   Scenario: Registering new linters
     Given no linters are currently registered
     When the following code is used:

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

@@ -0,0 +1,70 @@
+Feature: Element with too many tags linter
+
+  As a reader of documentation
+  I want taggable elements to not have an overabundance of tags
+  So that I can concentrate on the content of the scenario
+
+
+  Scenario: Linting
+
+  Note: Also works on outlines, features, and examples
+  Note: Tags inherited from other elements are not counted by default (see configuration options below)
+
+    Given a linter for elements with too many tags
+    And the following feature:
+      """
+      @this_tag_not_counted
+      Feature:
+
+        @tag_1 @tag_2 @tag_3 @tag_4 @tag_5 @tag_one_too_many
+        Scenario:
+          * a step
+      """
+    When it is linted
+    Then an error is reported:
+      | linter                       | problem                                           | location         |
+      | ElementWithTooManyTagsLinter | Scenario has too many tags. 6 tags found (max 5). | <path_to_file>:5 |
+
+
+  Scenario: Configuration of tag count threshold
+    Given a linter for elements with too many tags has been registered
+    And the following configuration file:
+      """
+      ElementWithTooManyTagsLinter:
+        TagCountThreshold: 3
+      """
+    And the following feature:
+      """
+      Feature:
+
+        @tag_1 @tag_2 @tag_3 @tag_one_too_many
+        Scenario:
+          * a step
+      """
+    When the configuration file is loaded
+    And it is linted
+    Then an error is reported:
+      | linter                       | problem                                           | location         |
+      | ElementWithTooManyTagsLinter | Scenario has too many tags. 4 tags found (max 3). | <path_to_file>:4 |
+
+  Scenario: Configuration of indirect tag count
+    Given a linter for elements with too many tags has been registered
+    And the following configuration file:
+      """
+      ElementWithTooManyTagsLinter:
+        CountInheritedTags: true
+      """
+    And the following feature:
+      """
+      @this_tag_is_also_counted
+      Feature:
+
+        @tag_1 @tag_2 @tag_3 @tag_4 @tag_one_too_many
+        Scenario:
+          * a step
+      """
+    When the configuration file is loaded
+    And it is linted
+    Then an error is reported:
+      | linter                       | problem                                           | location         |
+      | ElementWithTooManyTagsLinter | Scenario has too many tags. 6 tags found (max 5). | <path_to_file>:5 |