cuke_linter 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a58ecea412dacacc176aff36844a22a2be89b6e8fb530140c4a4c9af6f68b33d
-  data.tar.gz: 6c59e3ef19cecf4f8348ffbb4b6e5f64b230bd38c569c776dda1afe0b214c856
+  metadata.gz: c131f0cd2c39b7ca961f791d36057e5bb502a58642b81a87f0e5ced67fca7e30
+  data.tar.gz: 131411ade0634a8a03813996cab553303f78d28208d015302089400af07bb6e5
 SHA512:
-  metadata.gz: 163ed0e7cc11da407ce4af1a275f2cd51d0513caacdd007395af27782a111af83baa72928a85c7ba13b6a47d332564a71da906d068293f0d5cb4a5074c27d563
-  data.tar.gz: 0d8098a3e266207030fa8bfcd573344aacf849eda5f33a308a3ecea3f4931ff6fb3f8dd86b62afcf76116ba30e5b2fad468d8ad287d8cb45aa1a3f6819c41c62
+  metadata.gz: 8d6ed6d47f19beefe74c57865171d6cfc0ccf8770ef648dd7103ff4c4fc183a621dc24fc53cb6d3ab9b6adb1e713b6f871d1c782d2514f1c301dc5590b9d8bb8
+  data.tar.gz: 1b8d2841790e2f48351f01ae3af0c230256ec3b2a020317469b46bd1f7279d055963f6c050f1889e08482f592af9f4fa853b1f82e10eb4fe81254fa8c2faecde

data/CHANGELOG.md

@@ -8,6 +8,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Nothing yet...
 
+## [1.3.0] - 2022-05-23
+
+### Added
+- New linters
+   - TestNameWithTooManyCharactersLinter
+
+- Linters that are impacted by `Rule` elements in Gherkin have been updated, now that Rules models are available 
+  in CukeModeler
+  - FeatureWithoutScenariosLinter
+
 ## [1.2.1] - 2021-06-13
 
 ### Fixed
@@ -176,7 +186,8 @@ Nothing yet...
 - Custom linters, formatters, and command line usability
 
 
-[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v1.2.1...HEAD
+[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v1.3.0...HEAD
+[1.3.0]: https://github.com/enkessler/cuke_linter/compare/v1.2.1...v1.3.0
 [1.2.1]: https://github.com/enkessler/cuke_linter/compare/v1.2.0...v1.2.1
 [1.2.0]: https://github.com/enkessler/cuke_linter/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/enkessler/cuke_linter/compare/v1.0.1...v1.1.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2021 Eric Kessler
+Copyright (c) 2018-2022 Eric Kessler
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -148,7 +148,7 @@ Rather than using the default linters or providing a custom set of of modified l
 
 ### <a id="documentation"></a>Everything Else
 
-For more detailed examples of usage, see the documentation [here](https://app.cucumber.pro/projects/cuke_linter).
+For more detailed examples of usage, see the documentation [here](https://github.com/enkessler/cuke_linter/tree/master/testing/cucumber/features).
 
 ## Development and Contributing
 

data/lib/cuke_linter/default_linters.rb

@@ -1,4 +1,4 @@
-module CukeLinter
+module CukeLinter # rubocop:disable Style/Documentation
 
   # Long names inherently result in long lines
   # rubocop:disable Metrics/LineLength

data/lib/cuke_linter/linters/background_does_more_than_setup_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects backgrounds that have non-setup steps
-
   class BackgroundDoesMoreThanSetupLinter < Linter
 
     # Changes the linting settings on the linter using the provided configuration

data/lib/cuke_linter/linters/element_with_common_tags_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects Gherkin elements that have the same tag on all of their taggable child elements
-
   class ElementWithCommonTagsLinter < Linter
 
     # The rule used to determine if a model has a problem

data/lib/cuke_linter/linters/element_with_duplicate_tags_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects taggable Gherkin elements that have duplicate tags
-
   class ElementWithDuplicateTagsLinter < Linter
 
     # Changes the linting settings on the linter using the provided configuration

data/lib/cuke_linter/linters/element_with_too_many_tags_linter.rb

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

data/lib/cuke_linter/linters/example_without_name_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects unnamed example groups
-
   class ExampleWithoutNameLinter < Linter
 
     # The rule used to determine if a model has a problem

data/lib/cuke_linter/linters/feature_file_with_invalid_name_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects invalid feature file names
-
   class FeatureFileWithInvalidNameLinter < Linter
 
     # The rule used to determine if a model has a problem

data/lib/cuke_linter/linters/feature_file_with_mismatched_name_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects mismatched feature file names
-
   class FeatureFileWithMismatchedNameLinter < Linter
 
     # The rule used to determine if a model has a problem

data/lib/cuke_linter/linters/feature_with_too_many_different_tags_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects features that contain too many different tags
-
   class FeatureWithTooManyDifferentTagsLinter < Linter
 
     # Changes the linting settings on the linter using the provided configuration

data/lib/cuke_linter/linters/feature_without_description_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects features that don't have a description
-
   class FeatureWithoutDescriptionLinter < Linter
 
     # The rule used to determine if a model has a problem

data/lib/cuke_linter/linters/feature_without_name_linter.rb

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

data/lib/cuke_linter/linters/feature_without_scenarios_linter.rb

@@ -1,14 +1,17 @@
 module CukeLinter
 
   # A linter that detects empty features
-
   class FeatureWithoutScenariosLinter < Linter
 
     # The rule used to determine if a model has a problem
-    def rule(model)
+    def rule(model) # rubocop:disable Metrics/CyclomaticComplexity # It's good enough
       return false unless model.is_a?(CukeModeler::Feature)
 
-      model.tests.nil? || model.tests.empty?
+      feature_tests = model.tests && model.tests.any?
+      rule_tests    = model.respond_to?(:rules) && # Earlier versions of CukeModeler did not have Rule models
+                      model.rules && model.rules.any? { |rule| rule.tests && rule.tests.any? }
+
+      !(feature_tests || rule_tests)
     end
 
     # The message used to describe the problem that has been found

data/lib/cuke_linter/linters/linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A generic linter that can be used to make arbitrary linting rules
-
   class Linter
 
     # Returns the name of the linter

data/lib/cuke_linter/linters/outline_with_single_example_row_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects outlines that don't have multiple example rows
-
   class OutlineWithSingleExampleRowLinter < Linter
 
     # The rule used to determine if a model has a problem

data/lib/cuke_linter/linters/single_test_background_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects backgrounds that apply to only one test
-
   class SingleTestBackgroundLinter < Linter
 
     # The rule used to determine if a model has a problem

data/lib/cuke_linter/linters/step_with_end_period_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects steps that end in a period
-
   class StepWithEndPeriodLinter < Linter
 
     # The rule used to determine if a model has a problem

data/lib/cuke_linter/linters/step_with_too_many_characters_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects steps that are too long
-
   class StepWithTooManyCharactersLinter < Linter
 
     # The threshold used if not otherwise configured

data/lib/cuke_linter/linters/test_name_with_too_many_characters_linter.rb

@@ -0,0 +1,38 @@
+module CukeLinter
+
+  # A linter that detects test names that are too long
+  class TestNameWithTooManyCharactersLinter < Linter
+
+    # The threshold used if not otherwise configured
+    DEFAULT_TEST_NAME_LENGTH_THRESHOLD = 80
+
+    # Changes the linting settings on the linter using the provided configuration
+    def configure(options)
+      @test_name_length_threshold = options['TestNameLengthThreshold'] if options['TestNameLengthThreshold']
+    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_test_name_length = model.name.nil? ? 0 : model.name.length
+
+      @linted_test_name_length > test_name_length_threshold
+    end
+
+    # The message used to describe the problem that has been found
+    def message
+      "Scenario name is too long. #{@linted_test_name_length} characters found (max #{test_name_length_threshold})"
+    end
+
+
+    private
+
+
+    # The maximum length allowable of a scenario name
+    def test_name_length_threshold
+      @test_name_length_threshold || DEFAULT_TEST_NAME_LENGTH_THRESHOLD
+    end
+
+  end
+end

data/lib/cuke_linter/linters/test_should_use_background_linter.rb

@@ -1,8 +1,8 @@
+# TODO: Make a new class that it is from the POV of a Feature model instead
+
 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
 
     # The rule used to determine if a model has a problem

data/lib/cuke_linter/linters/test_with_action_step_as_final_step_linter.rb

@@ -1,7 +1,6 @@
 module CukeLinter
 
   # A linter that detects scenarios and outlines that have an action step as their final step
-
   class TestWithActionStepAsFinalStepLinter < Linter
 
     # Changes the linting settings on the linter using the provided configuration

data/lib/cuke_linter/linters/test_with_bad_name_linter.rb

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

data/lib/cuke_linter/linters/test_with_no_action_step_linter.rb

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

data/lib/cuke_linter/linters/test_with_no_name_linter.rb

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

data/lib/cuke_linter/linters/test_with_no_verification_step_linter.rb

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

data/lib/cuke_linter/linters/test_with_setup_step_after_action_step_linter.rb

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

data/lib/cuke_linter/linters/test_with_setup_step_after_verification_step_linter.rb

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

data/lib/cuke_linter/linters/test_with_setup_step_as_final_step_linter.rb

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

data/lib/cuke_linter/linters/test_with_too_many_steps_linter.rb

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

data/lib/cuke_linter/version.rb

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

data/lib/cuke_linter.rb

@@ -19,6 +19,7 @@ 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_name_with_too_many_characters_linter'
 require 'cuke_linter/linters/test_should_use_background_linter'
 require 'cuke_linter/linters/test_with_action_step_as_final_step_linter'
 require 'cuke_linter/linters/test_with_bad_name_linter'
@@ -164,9 +165,6 @@ module CukeLinter
     def dynamic_linters
       # No need to keep making new ones over and over...
       @dynamic_linters ||= Hash.new { |hash, key| hash[key] = key.new }
-      # return @dynamic_linters if @dynamic_linters
-      #
-      # @dynamic_linters = {}
     end
 
     def format_data(formatters, linting_data)

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

@@ -5,7 +5,7 @@ Feature: Feature without scenarios linter
   So that I do not have incomplete documentation
 
 
-  Scenario: Linting
+  Scenario: Linting (Bad)
     Given a linter for features without scenarios
     And the following feature:
       """
@@ -15,3 +15,25 @@ Feature: Feature without scenarios linter
     Then an error is reported:
       | linter                        | problem                  | location         |
       | FeatureWithoutScenariosLinter | Feature has no scenarios | <path_to_file>:1 |
+
+  Scenario: Linting (Good)
+    Given a linter for features without scenarios
+    And the following feature:
+      """
+      Feature:
+        Scenario:
+      """
+    When it is linted
+    Then no error is reported
+
+  @cuke_modeler_min_version_3
+  Scenario: Linting (Good, with Rules)
+    Given a linter for features without scenarios
+    And the following feature:
+      """
+      Feature:
+        Rule:
+          Scenario:
+      """
+    When it is linted
+    Then no error is reported

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

@@ -0,0 +1,18 @@
+Feature: Feature without name linter
+
+  As a reader of documentation
+  I want every feature to have a name
+  So that I can get an idea of  what the feature is about without having to read every use case
+
+
+  Scenario: Linting
+    Given a linter for features without a name
+    And the following feature:
+      """
+      Feature:
+        This feature does not have a name
+      """
+    When it is linted
+    Then an error is reported:
+      | linter                   | problem                       | location         |
+      | FeatureWithoutNameLinter | Feature does not have a name. | <path_to_file>:1 |

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

@@ -0,0 +1,41 @@
+Feature: Scenario name with too many characters
+
+  As a reader of documentation
+  I want test names not to be unduly long
+  So that I can easily understand its purpose
+
+
+  Scenario: Linter
+
+    Given a linter for test names with too many characters
+    And the following feature:
+      """
+      Feature:
+
+        Scenario: tea exists and teapots exist and so do cups and saucers and there might be milk in the milk jug together with sugar cubes
+      """
+    When it is linted
+    Then an error is reported:
+      | linter                              | problem                                                  | location         |
+      | TestNameWithTooManyCharactersLinter | Scenario name is too long. 121 characters found (max 80) | <path_to_file>:3 |
+
+
+  Scenario: Configuration of test name count threshold
+
+    Given a linter for test names with too many characters has been registered
+    And the following configuration file:
+      """
+      TestNameWithTooManyCharactersLinter:
+        TestNameLengthThreshold: 30
+      """
+    And the following feature:
+      """
+      Feature:
+
+        Scenario: This scenario name is way too long so it would be better to shorten it somehow, please do so
+      """
+    When the configuration file is loaded
+    And the feature is linted
+    Then an error is reported:
+      | linter                              | problem                                                 | location         |
+      | TestNameWithTooManyCharactersLinter | Scenario name is too long. 92 characters found (max 30) | <path_to_file>:3 |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuke_linter
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Eric Kessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2022-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuke_modeler
@@ -269,6 +269,7 @@ files:
 - lib/cuke_linter/linters/single_test_background_linter.rb
 - lib/cuke_linter/linters/step_with_end_period_linter.rb
 - lib/cuke_linter/linters/step_with_too_many_characters_linter.rb
+- lib/cuke_linter/linters/test_name_with_too_many_characters_linter.rb
 - lib/cuke_linter/linters/test_should_use_background_linter.rb
 - lib/cuke_linter/linters/test_with_action_step_as_final_step_linter.rb
 - lib/cuke_linter/linters/test_with_bad_name_linter.rb
@@ -299,9 +300,11 @@ files:
 - testing/cucumber/features/linters/feature_without_name.feature
 - testing/cucumber/features/linters/feature_without_scenarios.feature
 - testing/cucumber/features/linters/outline_with_single_example_row.feature
+- testing/cucumber/features/linters/rule_without_name.feature
 - testing/cucumber/features/linters/single_test_background.feature
 - testing/cucumber/features/linters/step_too_long.feature
 - testing/cucumber/features/linters/step_with_end_period.feature
+- testing/cucumber/features/linters/test_name_too_long.feature
 - testing/cucumber/features/linters/test_should_use_background.feature
 - testing/cucumber/features/linters/test_with_action_as_final_step.feature
 - testing/cucumber/features/linters/test_with_bad_name.feature