gherkin_lint 0.6.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a0564cbdd460a09454d8abeebefc4e04a7f2a74
-  data.tar.gz: 73ae15d6afbb81cabc6953429d6fafc1616f86e9
+  metadata.gz: 1b9ad10d82b638f8b53bea62cc731d72f0285537
+  data.tar.gz: 0a779d0729f79747f9fc9f776c12ca3453341a76
 SHA512:
-  metadata.gz: d1951a9f14e1fee9ff34b83bb1335b74cb7a76a3b6183242fbe10af169e193b0053cbb7a117eb4c2b178dea6b255be092f901b702210cd99795f5fdd7c0c197c
-  data.tar.gz: 0d1e213a2656598e2515dce0a94ab3708f7f6f7b6fc95b6e9c24aefc1c633161b943e43cfa6e837ecbd7411606be4a4b34bc63fc78aab5af971709fec23a28ba
+  metadata.gz: edc57cb10fb6f52db675742da92d40924b2c3cf49cd104b02ad04d2379eab61b4cbf484bcd0c6f62cd9787f6f26f9f22caab60ee36cacedde3730f358f13b13a
+  data.tar.gz: c066a1bd07d54b6e911581abe31bc0b74781eddb20cc0a8abac59b0c934eb0ef4f8968614a43a3152d34b3d8f954a87d55d02a20df318266d42a8a3e57e9b165

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+.bundle
+.idea
+tmp

data/.rubocop.yml

@@ -20,7 +20,8 @@ Metrics/ClassLength:
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 116
-
+  Exclude:
+    - "**/*_spec.rb"
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
@@ -33,3 +34,20 @@ Metrics/MethodLength:
 Style/NumericPredicate:
   Exclude:
     - 'lib/gherkin_lint/linter/file_name_differs_feature_name.rb'
+
+Metrics/ModuleLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+
+Layout/IndentationWidth:
+  Exclude:
+    - "**/*_spec.rb"
+
+Layout/IndentHeredoc:
+  Exclude:
+    - "**/*_spec.rb"
+

data/Dockerfile

@@ -3,5 +3,7 @@ MAINTAINER think@hotmail.de
 
 RUN gem install gherkin_lint --no-format-exec
 
+ENV LC_ALL=C.UTF-8
+
 ENTRYPOINT ["gherkin_lint"]
 CMD ["--help"]

data/Gemfile

@@ -1,10 +1,11 @@
 source 'https://rubygems.org'
-gem 'aruba'
 gem 'amatch'
+gem 'aruba'
+gem 'engtagger', '>=0.2.1'
 gem 'gherkin', '>=4.0.0'
 # TODO: update to gherkin4 gem 'gherkin_format'
 # TODO: update to gherkin4 gem 'gherkin_language'
 gem 'rake'
+gem 'rspec'
 gem 'rubocop'
 gem 'term-ansicolor'
-gem 'engtagger', '>=0.2.1'

data/README.md

@@ -2,6 +2,9 @@
 
 [![Build Status](https://travis-ci.org/funkwerk/gherkin_lint.svg)](https://travis-ci.org/funkwerk/gherkin_lint)
 [![Code Climate](https://codeclimate.com/github/funkwerk/gherkin_lint/badges/gpa.svg)](https://codeclimate.com/github/funkwerk/gherkin_lint)
+[![Docker Build](https://img.shields.io/docker/automated/gherkin/lint.svg)](https://hub.docker.com/r/gherkin/lint/)
+[![Downloads](https://img.shields.io/gem/dt/gherkin_lint.svg)](https://rubygems.org/gems/gherkin_lint)
+[![Latest Tag](https://img.shields.io/github/tag/funkwerk/gherkin_lint.svg)](https://rubygems.org/gems/gherkin_lint)
 
 This tool lints gherkin files.
 
@@ -9,13 +12,20 @@ This tool lints gherkin files.
 
 run `gherkin_lint` on a list of files
 
-    gherkin_lint FEATURE_FILES
+    gherkin_lint -f '<wild_card_path>' #default is `features/**/*.feature`
 
-With `--disable CHECK` or `--enable CHECK` it's possible to disable respectivly enable program wide checks.
+With `--disable CHECK` or `--enable CHECK` it's possible to disable respectivly enable program wide checks except when a linter requires additional values to be set in order to be valid.  Currently only RequiredTagStartsWith meets this criteria. 
 
 Checks could be disabled using tags within Feature Files. To do so, add @disableCHECK.
 Detailed usage within the [disable_tags](https://github.com/funkwerk/gherkin_lint/blob/master/features/disable_tags.feature) feature.
 
+### Usage with Docker
+
+Assuming there are feature files in the current directory. Then call.
+
+`docker run -ti -v $(pwd):/src -w /src gherkin/lint *.feature`
+
+This will mount the current directory within the Gherkin Lint Docker Container and then check all feature files.
 
 ## Checks
 
@@ -35,6 +45,7 @@ Detailed usage within the [disable_tags](https://github.com/funkwerk/gherkin_lin
  - [missing scenario name](https://github.com/funkwerk/gherkin_lint/blob/master/features/missing_scenario_name.feature)
  - [missing test action](https://github.com/funkwerk/gherkin_lint/blob/master/features/missing_test_action.feature)
  - [missing verification](https://github.com/funkwerk/gherkin_lint/blob/master/features/missing_verification.feature)
+ - [required tag starts with](https://github.com/funkwerk/gherkin_lint/blob/master/features/required_tag_starts_with.feature) - disabled by default
  - [same tag for all scenarios](https://github.com/funkwerk/gherkin_lint/blob/master/features/same_tag_for_all_scenarios.feature)
  - [tag used multiple times](https://github.com/funkwerk/gherkin_lint/blob/master/features/tag_used_multiple_times.feature)
  - [too clumsy](https://github.com/funkwerk/gherkin_lint/blob/master/features/too_clumsy.feature)
@@ -59,3 +70,14 @@ These new checks will stay some releases as warning and will be later declared a
 ### Errors
 
 If there is at least one error, the returncode will be set to ERROR (!= 0).
+
+## Installation
+
+Install it with:
+
+`sudo gem install gherkin_lint`
+
+After that `gherkin_lint` executable is available.
+
+## Configuration
+If you have a custom configuration you'd like to run on a regular basis instead of passing enable and disable flags through the CLI on every run, you can configure a ```.gherkin_lint.yml``` file that will be loaded on execution.  The format and available linters are in [```config/default.yml```](config/default.yml)

data/Rakefile

@@ -11,7 +11,7 @@ end
 
 desc 'Publishes the Gem'
 task :push do
-  sh 'gem push gherkin_lint-0.6.3.gem'
+  sh 'gem push gherkin_lint-1.0.0.gem'
 end
 
 desc 'Checks ruby style'
@@ -36,9 +36,9 @@ task :language do
 end
 
 task :self_check do
-  disabled_checks = %w(
+  disabled_checks = %w[
     UnknownVariable
     BadScenarioName
-  )
+  ]
   sh "RUBYLIB=lib ./bin/gherkin_lint --disable #{disabled_checks.join ','} features/*.feature"
 end

data/bin/gherkin_lint

@@ -14,13 +14,21 @@ OptionParser.new do |opts|
   opts.on('--disable [CHECKS]', 'Disabled checks. Separated by ","') do |checks|
     options[:disable] = checks.split(',')
   end
+  opts.on('-f', '--filepath [file/s]', 'File path where features are located') do |file|
+    options[:files] = file
+  end
 end.parse!
 
 linter = GherkinLint::GherkinLint.new
-
 linter.disable options[:disable] if options.key? :disable
 linter.enable options[:enable] if options.key? :enable
+linter.set_linter
+
+options[:files] = 'features/**/*.feature' if options[:files].nil?
+files = Dir.glob(options[:files])
 
-ARGV.each { |file| linter.analyze file }
+files.each do |file|
+  linter.analyze file
+end
 
 exit linter.report

data/config/default.yml

@@ -0,0 +1,58 @@
+AvoidOutlineForSingleExample:
+    Enabled: true
+AvoidPeriod:
+    Enabled: true
+AvoidScripting:
+    Enabled: true
+BackgroundDoesMoreThanSetup:
+    Enabled: true
+BackgroundRequiresMultipleScenarios:
+    Enabled: true
+BadScenarioName:
+    Enabled: true
+BeDeclarative:
+    Enabled: true
+FileNameDiffersFeatureName:
+    Enabled: true
+MissingExampleName:
+    Enabled: true
+MissingFeatureDescription:
+    Enabled: true
+MissingFeatureName:
+    Enabled: true
+MissingScenarioName:
+    Enabled: true
+MissingTestAction:
+    Enabled: true
+MissingVerification:
+    Enabled: true
+InvalidFileName:
+    Enabled: true
+InvalidStepFlow:
+    Enabled: true
+RequiredTagsStartsWith:
+    Enabled: false
+SameTagForAllScenarios:
+    Enabled: true
+TagUsedMultipleTimes:
+    Enabled: true
+TooClumsy:
+    Enabled: true
+TooManyDifferentTags:
+    Enabled: true
+TooManySteps:
+    Enabled: true
+TooManyTags:
+    Enabled: true
+TooLongStep:
+    Enabled: true
+UniqueScenarioNames:
+    Enabled: true
+UnknownVariable:
+    Enabled: true
+UnusedVariable:
+    Enabled: true
+UseBackground:
+    Enabled: true
+UseOutline:
+    Enabled: true

data/features/avoid_outline_for_single_example.feature

@@ -4,6 +4,7 @@ Feature: Avoid Outline for single Example
   so that it's easier to reuse verification steps
 
   Background: Prepare Testee
+
     Given a file named "lint.rb" with:
       """
       $LOAD_PATH << '../../lib'
@@ -11,6 +12,7 @@ Feature: Avoid Outline for single Example
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(AvoidOutlineForSingleExample)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -52,5 +54,4 @@ Feature: Avoid Outline for single Example
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/avoid_period.feature

@@ -11,6 +11,7 @@ Feature: Avoid Period
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(AvoidPeriod)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -45,5 +46,4 @@ Feature: Avoid Period
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/avoid_scripting.feature

@@ -11,6 +11,7 @@ Feature: Avoid Scripting
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(AvoidScripting)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -65,5 +66,4 @@ Feature: Avoid Scripting
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/background_does_more_than_setup.feature

@@ -11,6 +11,7 @@ Feature: Background Does More Than Setup
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(BackgroundDoesMoreThanSetup)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -42,5 +43,4 @@ Feature: Background Does More Than Setup
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/background_requires_scenario.feature

@@ -11,6 +11,7 @@ Feature: Background Requires Scenario
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(BackgroundRequiresMultipleScenarios)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -53,5 +54,4 @@ Feature: Background Requires Scenario
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/bad_scenario_name.feature

@@ -11,6 +11,7 @@ Feature: Bad Scenario Name
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(BadScenarioName)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -49,5 +50,4 @@ Feature: Bad Scenario Name
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/be_declarative.feature

@@ -11,6 +11,7 @@ Feature: Be Declarative
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(BeDeclarative)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -49,5 +50,4 @@ Feature: Be Declarative
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/disable_tags.feature

@@ -11,6 +11,7 @@ Feature: Disable Tags
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(InvalidStepFlow)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -54,7 +55,6 @@ Feature: Disable Tags
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """
 
   Scenario: Disable on Feature Level
@@ -73,5 +73,4 @@ Feature: Disable Tags
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/file_name_differs_feature_name.feature

@@ -11,6 +11,7 @@ Feature: File Name Differs Feature Name
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(FileNameDiffersFeatureName)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -37,7 +38,6 @@ Feature: File Name Differs Feature Name
     When I run `ruby lint.rb lint.feature`
     Then it should pass with exactly:
       """
-
       """
 
     Examples: Valid Names
@@ -54,6 +54,7 @@ Feature: File Name Differs Feature Name
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(FileNameDiffersFeatureName)
+      linter.set_linter
       linter.analyze 'lint_test.feature'
       exit linter.report
 
@@ -65,7 +66,6 @@ Feature: File Name Differs Feature Name
     When I run `ruby lint.rb lint_test.feature`
     Then it should pass with exactly:
       """
-
       """
 
     Examples: Valid Names

data/features/invalid_file_name.feature

@@ -13,6 +13,7 @@ Feature: Invalid File Name
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(InvalidFileName)
+      linter.set_linter
       ARGV.each { |file| linter.analyze file }
       exit linter.report
 
@@ -46,5 +47,4 @@ Feature: Invalid File Name
     When I run `ruby lint.rb lint.feature`
     Then it should pass with exactly:
       """
-
       """

data/features/invalid_step_flow.feature

@@ -11,6 +11,7 @@ Feature: Invalid Step Flow
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(InvalidStepFlow)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -81,5 +82,4 @@ Feature: Invalid Step Flow
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/missing_example_name.feature

@@ -11,6 +11,7 @@ Feature: Missing Example Name
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(MissingExampleName)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -57,7 +58,6 @@ Feature: Missing Example Name
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """
 
   Scenario: Valid Example
@@ -83,5 +83,4 @@ Feature: Missing Example Name
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/missing_feature_description.feature

@@ -11,6 +11,7 @@ Feature: Missing Feature Description
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(MissingFeatureDescription)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -40,5 +41,4 @@ Feature: Missing Feature Description
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """