cuke_linter 0.13.0 → 1.2.1

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

@@ -14,40 +14,48 @@ module CukeLinter
 
       return false unless parent_feature_model.tests.count > 1
 
-      matching_steps = parent_feature_model.tests.all? do |test|
+      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
+    def message
+      '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
 
-      none_parameterized = parent_feature_model.tests.none? do |test|
+    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
-
-      matching_steps && none_parameterized
     end
 
-    # The message used to describe the problem that has been found
-    def message
-      'Test shares steps with all other tests in feature. Use a background.'
-    end
-
-
-    private
-
-
     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)
+          parameterized_doc_string?(step_model, parameter_string) ||
+          parameterized_table?(step_model, parameter_string)
       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_setup_step_as_final_step_linter.rb

@@ -27,7 +27,7 @@ module CukeLinter
     private
 
     def given_keywords
-       @given_keywords || [DEFAULT_GIVEN_KEYWORD]
+      @given_keywords || [DEFAULT_GIVEN_KEYWORD]
     end
 
   end

data/lib/cuke_linter/version.rb

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cuke_linter
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Eric Kessler
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuke_modeler
@@ -19,7 +19,7 @@ dependencies:
         version: '1.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,22 +44,56 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: cuke_slicer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: racatt
+  name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -72,6 +106,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  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: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,49 +176,65 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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: coveralls
+  name: simplecov-lcov
   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: rainbow
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 4.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:
@@ -164,25 +242,17 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".simplecov"
-- ".travis.yml"
 - CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- appveyor.yml
-- bin/console
-- bin/setup
 - cuke_linter.gemspec
-- environments/common_env.rb
-- environments/cucumber_env.rb
-- environments/rspec_env.rb
 - exe/cuke_linter
 - lib/cuke_linter.rb
+- lib/cuke_linter/configuration.rb
+- lib/cuke_linter/default_linters.rb
 - lib/cuke_linter/formatters/pretty_formatter.rb
+- lib/cuke_linter/gherkin.rb
+- lib/cuke_linter/linter_registration.rb
 - lib/cuke_linter/linters/background_does_more_than_setup_linter.rb
 - lib/cuke_linter/linters/element_with_common_tags_linter.rb
 - lib/cuke_linter/linters/element_with_duplicate_tags_linter.rb
@@ -242,100 +312,35 @@ files:
 - testing/cucumber/features/linters/test_with_setup_step_after_verification_step.feature
 - testing/cucumber/features/linters/test_with_setup_step_as_final_step.feature
 - testing/cucumber/features/linters/test_with_too_many_steps.feature
-- testing/cucumber/step_definitions/action_steps.rb
-- testing/cucumber/step_definitions/setup_steps.rb
-- testing/cucumber/step_definitions/verification_steps.rb
-- testing/file_helper.rb
-- testing/formatter_factory.rb
-- testing/gemfiles/cuke_modeler1.gemfile
-- testing/gemfiles/cuke_modeler2.gemfile
-- testing/linter_factory.rb
-- testing/model_factory.rb
-- testing/rspec/spec/integration/cli_integration_spec.rb
-- testing/rspec/spec/integration/configuration_spec.rb
-- testing/rspec/spec/integration/cuke_linter_integration_spec.rb
-- testing/rspec/spec/integration/formatters/formatter_integration_specs.rb
-- testing/rspec/spec/integration/formatters/pretty_formatter_integration_spec.rb
-- testing/rspec/spec/integration/linters/background_does_more_than_setup_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/element_with_common_tags_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/element_with_duplicate_tags_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/element_with_too_many_tags_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/example_without_name_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/feature_file_with_invalid_name_integration_spec.rb
-- testing/rspec/spec/integration/linters/feature_file_with_mismatched_name_integration_spec.rb
-- testing/rspec/spec/integration/linters/feature_with_too_many_different_tags_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/feature_without_description_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/feature_without_name_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/feature_without_scenarios_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/linter_integration_specs.rb
-- testing/rspec/spec/integration/linters/outline_with_single_example_row_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/single_test_background_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/step_with_end_period_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/step_with_too_many_characters_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_should_use_background_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_action_step_as_final_step_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_bad_name_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_no_action_step_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_no_name_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_no_verification_step_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_setup_step_after_action_step_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_setup_step_after_verification_step_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_setup_step_as_final_step_linter_integration_spec.rb
-- testing/rspec/spec/integration/linters/test_with_too_many_steps_linter_integration_spec.rb
-- testing/rspec/spec/unit/cuke_linter_unit_spec.rb
-- testing/rspec/spec/unit/formatters/formatter_unit_specs.rb
-- testing/rspec/spec/unit/formatters/pretty_formatter_unit_spec.rb
-- testing/rspec/spec/unit/linters/background_does_more_than_setup_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/configurable_linter_unit_specs.rb
-- testing/rspec/spec/unit/linters/element_with_common_tags_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/element_with_duplicate_tags_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/element_with_too_many_tags_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/example_without_name_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/feature_file_with_invalid_name_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/feature_file_with_mismatched_name_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/feature_with_too_many_different_tags_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/feature_without_description_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/feature_without_name_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/feature_without_scenarios_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/linter_unit_specs.rb
-- testing/rspec/spec/unit/linters/outline_with_single_example_row_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/single_test_background_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/step_with_end_period_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/step_with_too_many_characters_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_should_use_background_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_action_step_as_final_step_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_bad_name_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_no_action_step_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_no_name_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_no_verification_step_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_setup_step_after_action_step_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_setup_step_after_verification_step_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_setup_step_as_final_step_linter_unit_spec.rb
-- testing/rspec/spec/unit/linters/test_with_too_many_steps_linter_unit_spec.rb
 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: []