cuke_linter 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02379fe769af15463f334b6762e9ced230bdc612b4243e44d180afa40dd9fce4'
-  data.tar.gz: 042acec109e1ac3fd283ac115019946038a9ec6bc6716a3636cb215f6fec4513
+  metadata.gz: a58ecea412dacacc176aff36844a22a2be89b6e8fb530140c4a4c9af6f68b33d
+  data.tar.gz: 6c59e3ef19cecf4f8348ffbb4b6e5f64b230bd38c569c776dda1afe0b214c856
 SHA512:
-  metadata.gz: 42c283c86a2617818efdb8585281075397b9e6c4f14688f43baab1733259811c5c9b0e5c76987446fd32705003d41ab5efc9a789aeb0c5332b89880bc15aea83
-  data.tar.gz: eb53e88817540ff8fc3bdea75e9f36d0930407ed9ce301695382cf74f583f6a60bac2b215ca6a03ed21d46146734dac6c650f95451ce77f95bce3d627420a385
+  metadata.gz: 163ed0e7cc11da407ce4af1a275f2cd51d0513caacdd007395af27782a111af83baa72928a85c7ba13b6a47d332564a71da906d068293f0d5cb4a5074c27d563
+  data.tar.gz: 0d8098a3e266207030fa8bfcd573344aacf849eda5f33a308a3ecea3f4931ff6fb3f8dd86b62afcf76116ba30e5b2fad468d8ad287d8cb45aa1a3f6819c41c62

data/CHANGELOG.md

@@ -8,6 +8,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Nothing yet...
 
+## [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
@@ -169,7 +176,8 @@ Nothing yet...
 - Custom linters, formatters, and command line usability
 
 
-[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v1.2.0...HEAD
+[Unreleased]: https://github.com/enkessler/cuke_linter/compare/v1.2.1...HEAD
+[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

data/LICENSE.txt

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

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', '< 4.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', '<= 0.16.1' # Coveralls gem does not support any newer version than this
+  # 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/lib/cuke_linter/version.rb

@@ -1,4 +1,4 @@
 module CukeLinter
   # The release version of this gem
-  VERSION = '1.2.0'.freeze
+  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: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Eric Kessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-08 00:00:00.000000000 Z
+date: 2021-06-14 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: 0.16.1
+        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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.16.1
-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:
@@ -299,7 +315,12 @@ files:
 homepage: https://github.com/enkessler/cuke_linter
 licenses:
 - MIT
-metadata: {}
+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:
@@ -308,7 +329,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4.0'