gherkin_language 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81c9bc84bfd759e138af42fc5badda27881e0392
-  data.tar.gz: 875f612c67a66184c6b6b6654ee556642d3a843f
+  metadata.gz: 04aee53e8b36b777bf0889ce6b0cdcd94fdef265
+  data.tar.gz: 54aaa1ba0d8625f05aeb8ee79e09878657988957
 SHA512:
-  metadata.gz: c58c13eacf296ed1d23a9826535cfef0cfdbb6e8d79d9383e59ad026404a254d6c3c04c9ba6e833d24992ee923c23e7f534e8ca3c450786df396b0ea449e9c23
-  data.tar.gz: 90e86a9d251f6d3c8b053b01223c846ebde6e620e30a3c03be3792a402d204394d7a591c5f90461f1c2a3a34b7c8a05f8756852892706d40ded949f8412bb432
+  metadata.gz: b3186581735b4460df28c170f865f4ee3cbb4e203cba63d77e78c3d6e1d9622a777483b9e104749972847c1a7eca36f93cd89c7f46afad1fca6be17d42903f12
+  data.tar.gz: 4563bb4bdfe7815bf4573c8352160c6db8fb86d01a120c0ae1155a053f7fdd423cc5e012f0a607f9d7ac17b98019c36a123147ae51d6571c555b863ad2cc0dc1

data/.rubocop.yml

@@ -12,7 +12,7 @@ Metrics/AbcSize:
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 161
+  Max: 171
 
 # Offense count: 2
 Metrics/CyclomaticComplexity:

data/README.md

@@ -21,6 +21,8 @@ To just extract the sentences, start it with `--sentences`. This could be helpfu
 
 To tag all words used, start it with `--tag`. This allows to build up a glossary based on the feature files provided.
 
+To ignore specific rules, mention them with an `--ignore RULE`. This allows to bypass the checks.
+
 
 Glossary
 --------

data/Rakefile

@@ -17,8 +17,8 @@ task test: :rubocop
 task test: :cucumber
 
 desc 'Publishes the Gem'
-task :push do
-  sh 'gem push gherkin_language-0.0.6.gem'
+task push: :build do
+  sh 'gem push gherkin_language-0.0.7.gem'
 end
 
 desc 'Checks ruby style'

data/features/correct.feature

@@ -12,7 +12,8 @@ Feature: Correct
       no_cache = true
       language = GherkinLanguage.new no_cache
       language.analyze 'test.feature'
-      exit language.report
+      result = language.report
+      exit result unless result.nil?
 
       """
 

data/features/exception.feature

@@ -0,0 +1,53 @@
+Feature: Exception
+  As a Business Analyst
+  I want to define exceptions for checks
+  so that I am able to bypass false positives
+
+  Background:
+    Given a file named "exception.rb" with:
+      """
+      $LOAD_PATH << '../../lib'
+      require 'gherkin_language'
+
+      no_cache = true
+      language = GherkinLanguage.new no_cache
+      language.ignore 'EN_A_VS_AN'
+      language.analyze 'test.feature'
+      exit language.report
+      """
+
+  Scenario: Accept ignored rules
+    Given a file named "test.feature" with:
+      """
+      Feature: Test
+        Scenario: Tag
+          Given an test
+          When execute
+          Then pass
+      """
+    When I run `ruby exception.rb`
+    Then it should pass with exactly:
+      """
+
+      """
+
+  Scenario: Fails for non ignored rules
+    Given a file named "test.feature" with:
+      """
+      Feature: Test
+        Scenario: Tag
+          Given a test
+          When exicute
+          Then pass
+      """
+    When I run `ruby exception.rb`
+    Then it should fail with exactly:
+      """
+      [misspelling] MORFOLOGIK_RULE_EN_US
+        Possible spelling mistake found
+        Context: Given a test when exicute then pass
+        Replacements: execute
+        References: test.feature
+      1 unknown words: exicute
+
+      """

data/gherkin_language.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'gherkin_language'
-  s.version     = '0.0.6'
-  s.date        = '2015-07-19'
+  s.version     = '0.0.7'
+  s.date        = '2015-10-04'
   s.summary     = 'Gherkin Language'
   s.description = 'Check language of Gherkin Files'
   s.authors     = ['Stefan Rohe']

data/lib/gherkin_language.rb

@@ -161,6 +161,11 @@ class GherkinLanguage
     end
     @references = {}
     @line_to_reference = {}
+    @exceptions = []
+  end
+
+  def ignore(exception)
+    @exceptions.push exception
   end
 
   def analyze(file)
@@ -228,6 +233,9 @@ class GherkinLanguage
     used_refs = Set.new []
     errors.each do |error|
       used_refs.add @line_to_reference[error.from_y]
+    end
+    errors.select! { |error| !@exceptions.include? error.rule }
+    errors.each do |error|
       local_refs = @references[@line_to_reference[error.from_y]]
       puts error.str local_refs
     end
@@ -235,6 +243,13 @@ class GherkinLanguage
     puts red "#{unknown_words.count} unknown words: #{unknown_words * ', '}" unless unknown_words.empty?
     return -1 unless unknown_words.empty?
 
+    write_accepted_paragraphs used_refs
+
+    return -1 unless errors.empty?
+    0
+  end
+
+  def write_accepted_paragraphs(used_refs)
     @references.each do |sentence, _refs|
       next if used_refs.include? sentence
       key = :without_glossary
@@ -248,8 +263,6 @@ class GherkinLanguage
     File.open(@settings_path, 'w') do |settings_file|
       settings_file.write @accepted_paragraphs.to_yaml
     end
-    return -1 unless errors.empty?
-    0
   end
 
   def to_json(input, file = 'generated.feature')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_language
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Stefan Rohe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-19 00:00:00.000000000 Z
+date: 2015-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -68,6 +68,7 @@ files:
 - Rakefile
 - bin/gherkin_language
 - features/correct.feature
+- features/exception.feature
 - features/glossary.feature
 - features/report.feature
 - features/sentences.feature