cuke_linter 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b911b1679a6fb00926c3b64558813e575c745da01f3ba6e95a8b51fe59412724
-  data.tar.gz: 1aa6dbd5a0d469f2870495c8f02ed2650633aba21d7098463a61797681e43ec1
+  metadata.gz: c131f0cd2c39b7ca961f791d36057e5bb502a58642b81a87f0e5ced67fca7e30
+  data.tar.gz: 131411ade0634a8a03813996cab553303f78d28208d015302089400af07bb6e5
 SHA512:
-  metadata.gz: 4761dd56728c44a2537bc283794a24a8d071bf643609f7a82f0fd033c73f733e5aba11978ea7eedbd42c353bb22b8cea962412510c4d0e91aa806a137bdc2b0e
-  data.tar.gz: 2546da3f22c1b3e33d4f735ed6cf02ceda2e9f54aab37fc051833075193718ec13fe941a7b313721d8e059523abb1b642fcf00c8c6a8e66bf6e9df9c92eeafcc
+  metadata.gz: 8d6ed6d47f19beefe74c57865171d6cfc0ccf8770ef648dd7103ff4c4fc183a621dc24fc53cb6d3ab9b6adb1e713b6f871d1c782d2514f1c301dc5590b9d8bb8
+  data.tar.gz: 1b8d2841790e2f48351f01ae3af0c230256ec3b2a020317469b46bd1f7279d055963f6c050f1889e08482f592af9f4fa853b1f82e10eb4fe81254fa8c2faecde

data/CHANGELOG.md

@@ -8,6 +8,28 @@ 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
+ - Updated the minimum required Ruby version to `2.1`. The gem has never had `2.0` compatible code (due to using 
+   named parameters without default values), so it's easier to just officially drop `2.0` 'support' than to change 
+   the API to enable a use case that was never used anyway. 
+
+## [1.2.0] - 2021-01-08
+
+### Added
+ - Ruby 3.x is now supported
+
 ## [1.1.0] - 2020-06-14
 
 ### Added
@@ -164,7 +186,10 @@ Nothing yet...
 - Custom linters, formatters, and command line usability
 
 
-[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v1.1.0...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
 [1.0.1]: https://github.com/enkessler/cuke_linter/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/enkessler/cuke_linter/compare/v0.13.0...v1.0.0

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2020 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

@@ -4,12 +4,11 @@ Basic stuff:
 [![Downloads](https://img.shields.io/gem/dt/cuke_linter.svg)](https://rubygems.org/gems/cuke_linter)
 
 User stuff:
-[![Cucumber Docs](http://img.shields.io/badge/Documentation-Features-green.svg)](https://app.cucumber.pro/projects/cuke_linter)
+[![Cucumber Docs](http://img.shields.io/badge/Documentation-Features-green.svg)](https://github.com/enkessler/cuke_linter/tree/master/testing/cucumber/features)
 [![Yard Docs](http://img.shields.io/badge/Documentation-API-blue.svg)](https://www.rubydoc.info/gems/cuke_linter)
 
 Developer stuff:
-[![Build Status](https://travis-ci.org/enkessler/cuke_linter.svg?branch=master)](https://travis-ci.org/enkessler/cuke_linter)
-[![Build Status](https://ci.appveyor.com/api/projects/status/g5o70u747x073evy/branch/master?svg=true)](https://ci.appveyor.com/project/enkessler/cuke-linter/branch/master)
+[![Build Status](https://github.com/enkessler/cuke_linter/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/enkessler/cuke_linter/actions/workflows/ci.yml)
 [![Coverage Status](https://coveralls.io/repos/github/enkessler/cuke_linter/badge.svg?branch=master)](https://coveralls.io/github/enkessler/cuke_linter?branch=master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/d1b86760e59a457c8e73/maintainability)](https://codeclimate.com/github/enkessler/cuke_linter/maintainability)
 [![Inline docs](http://inch-ci.org/github/enkessler/cuke_linter.svg?branch=master)](https://inch-ci.org/github/enkessler/cuke_linter?branch=master)
@@ -149,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/cuke_linter.gemspec

@@ -9,13 +9,24 @@ Gem::Specification.new do |spec|
   spec.email         = ['morrow748@gmail.com']
 
   spec.summary       = 'Lints feature files used by Cucumber and other similar frameworks.'
+  spec.description   = ["This gem provides linters for detecting common 'smells' in `.feature` files. ",
+                        'In addition to the provided linters, custom linters can be made in order to ',
+                        'create custom linting rules.'].join
   spec.homepage      = 'https://github.com/enkessler/cuke_linter'
   spec.license       = 'MIT'
 
+  spec.metadata = {
+    'bug_tracker_uri'   => 'https://github.com/enkessler/cuke_linter/issues',
+    'changelog_uri'     => 'https://github.com/enkessler/cuke_linter/blob/master/CHANGELOG.md',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/cuke_linter',
+    'homepage_uri'      => 'https://github.com/enkessler/cuke_linter',
+    'source_code_uri'   => 'https://github.com/enkessler/cuke_linter'
+  }
+
 
   # 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('', __dir__)) do
+  spec.files = Dir.chdir(File.expand_path('', __dir__)) do
     source_controlled_files = `git ls-files -z`.split("\x0")
     source_controlled_files.keep_if { |file| file =~ %r{^(lib|exe|testing/cucumber/features)} }
     source_controlled_files + ['README.md', 'LICENSE.txt', 'CHANGELOG.md', 'cuke_linter.gemspec']
@@ -24,13 +35,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.0'
+  spec.required_ruby_version = '>= 2.1', '< 4.0'
 
   spec.add_runtime_dependency 'cuke_modeler', '>= 1.5', '< 4.0'
 
   spec.add_development_dependency 'bundler', '< 3.0'
-  spec.add_development_dependency 'childprocess', '~> 3.0'
-  spec.add_development_dependency 'coveralls', '< 1.0.0'
+  spec.add_development_dependency 'childprocess', '< 4.0'
   spec.add_development_dependency 'cucumber', '< 5.0'
   spec.add_development_dependency 'cuke_slicer', '>= 2.0.2', '< 3.0'
   spec.add_development_dependency 'ffi', '~> 1.0'
@@ -39,6 +49,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'require_all', '~> 2.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '< 1.0.0'
-  spec.add_development_dependency 'simplecov', '< 1.0.0'
+  # RuboCop drops Ruby 2.1 support after this version and we need
+  # to maintain Ruby 2.1 compatibility when writing code for this gem
+  spec.add_development_dependency 'rubocop', '<= 0.57.2'
+  spec.add_development_dependency 'simplecov', '< 1.0'
+  spec.add_development_dependency 'simplecov-lcov', '< 1.0'
+  spec.add_development_dependency 'yard', '< 1.0'
 end

data/exe/cuke_linter

@@ -107,6 +107,6 @@ elsif File.exist?("#{Dir.pwd}/.cuke_linter")
   CukeLinter.load_configuration
 end
 
-results = CukeLinter.lint(options)
+results = CukeLinter.lint(**options)
 
 exit(1) unless results.empty?

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.1.0'.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/command_line.feature

@@ -101,7 +101,8 @@ Feature: Using cuke_linter on the command line
 
   Scenario: Specifying a formatter to use
 
-  Note: The file containing the formatter class will have to be explicitly loaded if not using one of the built in formatters
+  Note: The file containing the formatter class will have to be explicitly loaded if not using one
+        of the built in formatters
 
     Given the following feature file "some.feature":
       """
@@ -134,7 +135,9 @@ Feature: Using cuke_linter on the command line
 
   Scenario: Redirecting output for specific formatters
 
-  Note: Formatters match to output locations in the same order that they are specified. Formatters that do not have their output location specified will output to STDOUT. Output locations that are not matched to a formatter will use the default formatter.
+  Note: Formatters match to output locations in the same order that they are specified. Formatters
+        that do not have their output location specified will output to STDOUT. Output locations
+        that are not matched to a formatter will use the default formatter.
 
     Given the following feature file "some.feature":
       """

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

@@ -1,6 +1,8 @@
 Feature: Configuration of linters
 
-  Instead of having to modify the linting object directly in a script at runtime, a configuration file can be used so that specific linters can be configured in a more convenient, static manner. Some configurable properties are available across all linters while some are linter specific.
+  Instead of having to modify the linting object directly in a script at runtime, a configuration file can
+  be used so that specific linters can be configured in a more convenient, static manner. Some configurable
+  properties are available across all linters while some are linter specific.
 
 
   Scenario: Disabling a linter
@@ -20,7 +22,8 @@ Feature: Configuration of linters
 
   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.
+  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:

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

@@ -4,12 +4,17 @@ Feature: Locally scoping linters
   I want to be able to limit the scope of linters for certain portions of the documentation
   So that exceptions to rules can be made
 
-  In addition to using configurations to change whether or not a given linter is used when linting, linters can be enabled/disabled for specific portions of a `.feature` file. To enable/disable one (or more) linters, add a comment line before the portion of the file where the change should apply. Add a comment with the opposite change at the point in the file when the default behavior should resume. Unless so countermanded, changes remain in effect for the remainder of the feature file.
+  In addition to using configurations to change whether or not a given linter is used when linting, linters
+  can be enabled/disabled for specific portions of a `.feature` file. To enable/disable one (or more) linters,
+  add a comment line before the portion of the file where the change should apply. Add a comment with the
+  opposite change at the point in the file when the default behavior should resume. Unless so countermanded,
+  changes remain in effect for the remainder of the feature file.
 
 
   Scenario: Enabling/disabling a linter within a feature file
 
-  Note: This example disables linters that are enabled by default but enabling a linter that is disabled by default works in the same manner
+  Note: This example disables linters that are enabled by default but enabling a linter that is disabled by
+        default works in the same manner
 
     Given the default linters are being used
     And a feature file model based on the following text:

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

@@ -1,6 +1,7 @@
 Feature: Using a configuration
 
-  Configuration can be done during a script or through a configuration file. This file can be explicitly provided or a default configuration file will be used.
+  Configuration can be done during a script or through a configuration file. This file can be explicitly
+  provided or a default configuration file will be used.
 
 
   Scenario: Providing a configuration directly

data/testing/cucumber/features/custom_linters.feature

@@ -1,6 +1,8 @@
 Feature: Custom linters
 
-  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.
+  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

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.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Eric Kessler
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-14 00:00:00.000000000 Z
+date: 2022-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuke_modeler
@@ -46,32 +46,18 @@ dependencies:
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: childprocess
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -192,33 +178,63 @@ dependencies:
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
-description: 
+        version: '1.0'
+description: This gem provides linters for detecting common 'smells' in `.feature`
+  files. In addition to the provided linters, custom linters can be made in order
+  to create custom linting rules.
 email:
 - morrow748@gmail.com
 executables:
@@ -253,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
@@ -283,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
@@ -299,25 +318,32 @@ files:
 homepage: https://github.com/enkessler/cuke_linter
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/enkessler/cuke_linter/issues
+  changelog_uri: https://github.com/enkessler/cuke_linter/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/cuke_linter
+  homepage_uri: https://github.com/enkessler/cuke_linter
+  source_code_uri: https://github.com/enkessler/cuke_linter
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Lints feature files used by Cucumber and other similar frameworks.
 test_files: []