gherkin_lint 0.0.14 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f46709be4aaa5ea2b3e333bee9cbbed73b845a4
-  data.tar.gz: 69359d535eae291d385dd3881e5494251dfd66f5
+  metadata.gz: 6cdef24fc92e7521e9ca9994e41562dac5afa094
+  data.tar.gz: 707f5a596fb69a69ab80597edc91c0cfdb017f8f
 SHA512:
-  metadata.gz: 9d769a7b4ec15bd5c4b9a3127ea94d02b5d0cd22c359510019792d01f2d381775ccf33e93ec747db664cfd7557fc4f305f68f0338ee5bb638cf8eb69fc52998e
-  data.tar.gz: 61aa2a9d95b6a06c7ba4a2fe401561d3e57aa7905519917306b51fbec0d6fb97c3cb62eadcfd299d5906193bff3f4eb935fc014f7b639c13e0c1202b2b6f51b8
+  metadata.gz: 1ca646959b80d6112965790512885b7aeb86fd32b742d8a0245fbd502e7b6880d296a8ef5c069c7e4d705328732a232bf673c4b54631b15143af944a50c292ca
+  data.tar.gz: fcfc1d844dfafcfa9b40960c991087df43528c7c2482c716d4241044434ddf438001dae287bc48ff43c92d03d7e3cc016108ee19448224f75a150351ef7f0a5f

data/.rubocop.yml

@@ -1,11 +1,18 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-07-05 00:19:49 +0200 using RuboCop version 0.31.0.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-02-28 13:48:49 +0100 using RuboCop version 0.36.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 16
-# Configuration parameters: AllowURI, URISchemes.
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 116
+
+# Offense count: 3
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
 Metrics/LineLength:
   Max: 118

data/README.md

@@ -11,6 +11,10 @@ run `gherkin_lint` on a list of files
 
     gherkin_lint FEATURE_FILES
 
+With `--disable CHECK` or `--enable CHECK` it's possible to disable respectivly enable program wide checks.
+
+Checks could be disabled using tags within Feature Files. To do so, add @disableCHECK. Detailed usage within the disable_tags feature.
+
 ## Checks
 
 ### Feature Avoid colon (features/avoid_colon.feature)

data/Rakefile

@@ -11,7 +11,7 @@ end
 
 desc 'Publishes the Gem'
 task :push do
-  sh 'gem push gherkin_lint-0.0.14.gem'
+  sh 'gem push gherkin_lint-0.1.0.gem'
 end
 
 desc 'Checks ruby style'

data/features/disable_tags.feature

@@ -0,0 +1,77 @@
+Feature: Disable Tags
+  As a Business Analyst
+  I want to disable checks for specific scenarios
+  so that I can have exceptions on the exception, not on the whole code base
+
+  Background: Prepare Testee
+    Given a file named "lint.rb" with:
+      """
+      $LOAD_PATH << '../../lib'
+      require 'gherkin_lint'
+
+      linter = GherkinLint::GherkinLint.new
+      linter.enable %w(InvalidStepFlow)
+      linter.analyze 'lint.feature'
+      exit linter.report
+
+      """
+
+  Scenario: Broken
+    Given a file named "lint.feature" with:
+      """
+      Feature: Test
+        Background: Preparation
+          Given setup
+
+        Scenario: Test
+          Then check
+          When action
+          Given setup
+      """
+    When I run `ruby lint.rb`
+    Then it should fail with exactly:
+      """
+      InvalidStepFlow - Given after Action or Verification
+        lint.feature (8): Test.Test step: setup
+      InvalidStepFlow - Missing Action
+        lint.feature (6): Test.Test step: check
+
+      """
+
+  Scenario: Disable on Scenario Level
+    Given a file named "lint.feature" with:
+      """
+      Feature: Test
+        Background: Preparation
+          Given setup
+
+        @disableInvalidStepFlow
+        Scenario: Test
+          Then check
+          When action
+          Given setup
+      """
+    When I run `ruby lint.rb`
+    Then it should pass with exactly:
+      """
+
+      """
+
+  Scenario: Disable on Feature Level
+    Given a file named "lint.feature" with:
+      """
+      @disableInvalidStepFlow
+      Feature: Test
+        Background: Preparation
+          Given setup
+
+        Scenario: Test
+          Then check
+          When action
+          Given setup
+      """
+    When I run `ruby lint.rb`
+    Then it should pass with exactly:
+      """
+
+      """

data/gherkin_lint.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'gherkin_lint'
-  s.version     = '0.0.14'
-  s.date        = '2016-01-17'
+  s.version     = '0.1.0'
+  s.date        = '2016-02-28'
   s.summary     = 'Gherkin Lint'
   s.description = 'Lint Gherkin Files'
   s.authors     = ['Stefan Rohe']

data/lib/gherkin_lint.rb

@@ -77,7 +77,7 @@ module GherkinLint
     end
 
     def disable(disabled_linter)
-      set_linter([], disabled_linter)
+      set_linter(LINTER.map { |linter| linter.new.name.split('::').last }, disabled_linter)
     end
 
     def set_linter(enabled_linter, disabled_linter = [])
@@ -104,13 +104,14 @@ module GherkinLint
 
     def report
       issues = @linter.map do |linter|
-        linter.lint_files @files
+        tags_to_suppress = LINTER.map { |lint| "disable#{lint.new.class.name.split('::').last}" }
+        linter.lint_files(@files, tags_to_suppress)
         linter.issues
       end.flatten
 
       issues.each { |issue| puts issue.render }
-      return 0 if issues.length == 0
-      -1
+
+      issues.empty? ? 0 : -1
     end
 
     def to_json(input, file = 'generated.feature')

data/lib/gherkin_lint/linter.rb

@@ -66,11 +66,45 @@ module GherkinLint
       self.class.name.split('::').last
     end
 
-    def lint_files(files)
+    def lint_files(files, tags_to_suppress)
       @files = files
+      @files = filter_tag(@files, "disable#{name}")
+      @files = suppress_tags(@files, tags_to_suppress)
       lint
     end
 
+    def tag?(data, tag)
+      return false if data.class != Hash
+      return false unless data.key? 'tags'
+      data['tags'].map { |item| item['name'] }.include? "@#{tag}"
+    end
+
+    def filter_tag(data, tag)
+      return data.select { |item| !tag?(item, tag) }.map { |item| filter_tag(item, tag) } if data.class == Array
+      return data unless data.class == Hash
+      result = {}
+
+      data.each_pair { |key, value| result[key] = filter_tag(value, tag) }
+      result
+    end
+
+    def suppress(data, tags)
+      data.select { |item| !tags.map { |tag| "@#{tag}" }.include? item['name'] }
+    end
+
+    def suppress_tags(data, tags)
+      return data.map { |item| suppress_tags(item, tags) } if data.class == Array
+      return data unless data.class == Hash
+      result = {}
+
+      data.each_pair do |key, value|
+        value = suppress(value, tags) if key == 'tags'
+
+        result[key] = suppress_tags(value, tags)
+      end
+      result
+    end
+
     def lint
       fail 'not implemented'
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.1.0
 platform: ruby
 authors:
 - Stefan Rohe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-17 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -87,6 +87,7 @@ files:
 - features/background_does_more_than_setup.feature
 - features/background_requires_scenario.feature
 - features/bad_scenario_name.feature
+- features/disable_tags.feature
 - features/file_name_differs_feature_name.feature
 - features/invalid_file_name.feature
 - features/invalid_step_flow.feature
@@ -156,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gherkin Lint