gherkin_language 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20a151e3bf96f970ae834694fa2e52d6741f7100
-  data.tar.gz: 934027d4a4613b2846eb266823e65e078a911317
+  metadata.gz: f3ff47e5efcaf5646238231cfc30a418a320d9a2
+  data.tar.gz: 435a443e36b153809de0fc9b0706e2a68cc1c6b0
 SHA512:
-  metadata.gz: 3e28b413f04838881e6913fe4ec59e5b0f46c755d313c082e87cbd982ac8ff1ea250e549e4e7176c3cfa433947727a6ae1c3bacb0c71f4d7d75b02aee5743cc2
-  data.tar.gz: c83b49a25e3c8dcba77c1750635df0dec54d7665a10140d892aa369fc9231706dcdc20252e65de6aa50d6a45c9578eafb03c0243571c44de7156e7122be055f8
+  metadata.gz: dbbed75c28198258ec1213db2bfaf63762cefc28ee1311cb2c4dfaf4052469f6160b411117b8f9bce0cdd4ce440b5d6c92e710a7bdcb6ebc10549d33c6a5913a
+  data.tar.gz: 5e00377cc5240362ac380f978e0b6caeeb40e43f448144b5150db8acda394545bb645e7947380430ff4e52b054ebe7a6df59246861ad414cd29e833ad08ca1d4

data/README.md

@@ -25,6 +25,8 @@ To ignore specific rules, mention them with an `--ignore RULE`. This allows to b
 
 To check for confused words, based on ngrams, add `--ngram`. Please note, that it requires much disk space and time.
 
+By default it will accept unknown words. For warnings about unknown words add `--unknown-words`.
+
 Get a readability report using `--readability`. It indicates, which files are not good readable.
 
 

data/Rakefile

@@ -18,7 +18,7 @@ task test: :cucumber
 
 desc 'Publishes the Gem'
 task push: :build do
-  sh 'gem push gherkin_language-0.1.3.gem'
+  sh 'gem push gherkin_language-0.1.4.gem'
 end
 
 desc 'Checks ruby style'

data/bin/gherkin_language

@@ -26,9 +26,15 @@ OptionParser.new do |opts|
   opts.on('--readability', 'readbility by file') do |readability|
     options[:readability] = readability
   end
+  opts.on('--unknown-words', 'determine unknown words') do |unknown_words|
+    options[:unknown_words] = unknown_words
+  end
 end.parse!
 
-language = GherkinLanguage.new(options.key?(:no_cache), options.key?(:ngram))
+language = GherkinLanguage.new(
+  options.key?(:no_cache),
+  options.key?(:ngram),
+  options.key?(:unknown_words))
 
 if options.key? :sentences
   ARGV.each { |file| puts language.extract_sentences language.parse file }

data/features/correct.feature

@@ -39,3 +39,17 @@ Feature: Correct
       """
 
       """
+
+  Scenario: Scenario without Given
+    Given a file named "test.feature" with:
+      """
+      Feature: Test
+        Scenario: Test
+          When execute
+          Then verify
+      """
+    When I run `ruby report.rb`
+    Then it should pass with exactly:
+      """
+
+      """

data/features/exception.feature

@@ -14,6 +14,7 @@ Feature: Exception
       language.ignore 'EN_A_VS_AN'
       language.analyze 'test.feature'
       exit language.report
+
       """
 
   Scenario: Accept ignored rules
@@ -48,6 +49,5 @@ Feature: Exception
         Context: Given a test when exicute then pass
         Replacements: execute
         References: test.feature
-      1 unknown words: exicute
 
       """

data/features/glossary.feature

@@ -10,7 +10,9 @@ Feature: Glossary
       require 'gherkin_language'
 
       no_cache = true
-      language = GherkinLanguage.new no_cache
+      ngram = false
+      unknown_words = true
+      language = GherkinLanguage.new no_cache, ngram, unknown_words
       language.analyze 'test.feature'
       exit language.report
 

data/features/report.feature

@@ -10,7 +10,9 @@ Feature: Report
       require 'gherkin_language'
 
       no_cache = true
-      language = GherkinLanguage.new no_cache
+      ngram = false
+      unknown_words = true
+      language = GherkinLanguage.new no_cache, ngram, unknown_words
       language.analyze 'test.feature'
       exit language.report
 

data/features/tag.feature

@@ -10,7 +10,9 @@ Feature: Tag
       require 'gherkin_language'
 
       no_cache = true
-      language = GherkinLanguage.new no_cache
+      ngram = false
+      unknown_words = true
+      language = GherkinLanguage.new no_cache, ngram, unknown_words
       puts language.tag ['tag.feature']
 
       """
@@ -35,6 +37,4 @@ Feature: Tag
       execute[execute/VB,execute/VBP,B-VP]
       then[then/JJ,then/NN,then/RB,I-VP]
       pass[pass/JJ,pass/NN,pass/VB,pass/VBP,I-VP]"["/'',B-ADVP]][</S>,O]
-
-
       """

data/gherkin_language.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'gherkin_language'
-  s.version     = '0.1.3'
-  s.date        = '2016-02-03'
+  s.version     = '0.1.4'
+  s.date        = '2016-02-28'
   s.summary     = 'Gherkin Language'
   s.description = 'Check language and readability of Gherkin Files'
   s.authors     = ['Stefan Rohe']

data/lib/gherkin_language.rb

@@ -18,7 +18,7 @@ require 'digest'
 
 # gherkin utilities
 class GherkinLanguage
-  def initialize(no_cache = false, ngram = false)
+  def initialize(no_cache = false, ngram = false, unknown_words = false)
     path = "~/.gherkin_language/#{LanguageToolProcess::VERSION}/accepted_paragraphs.yml"
     @settings_path = File.expand_path path
     @accepted_paragraphs = {}
@@ -29,8 +29,9 @@ class GherkinLanguage
     end
     @references = {}
     @line_to_reference = {}
-    @exceptions = []
+    @exceptions = %w(SENTENCE_FRAGMENT) # sentences starting with 'When' are perfectly fine in gherkin
     @ngram = ngram
+    @unknown_words = unknown_words
   end
 
   def ignore(exception)
@@ -115,7 +116,7 @@ class GherkinLanguage
 
   def report
     return 0 if @references.keys.empty?
-    language = LanguageToolProcess.new @ngram
+    language = LanguageToolProcess.new(@ngram, @unknown_words)
     language.start!
 
     @references.keys.each do |sentence|

data/lib/gherkin_language/language_tool_process.rb

@@ -21,7 +21,7 @@ class LanguageToolProcess
   NGRAM_VERSION = 'ngrams-en-20150817'.freeze
   NGRAM_URL = "https://languagetool.org/download/ngram-data/#{NGRAM_VERSION}.zip".freeze
 
-  def initialize(ngrams = false)
+  def initialize(ngrams = false, unknown_words = false)
     path = Dir.tmpdir
     download(path, URL) unless File.exist? "#{path}/#{VERSION}/languagetool-commandline.jar"
     if ngrams
@@ -32,6 +32,7 @@ class LanguageToolProcess
     @p = nil
     @reference_line = 0
     @errors = []
+    @check_unknown_words = unknown_words
     @unknown_words = []
     @ngrams = ngrams
     use_user_glossary "#{path}/#{VERSION}" if File.exist? '.glossary'
@@ -57,8 +58,10 @@ class LanguageToolProcess
     @unknown_words = []
     @reference_line = 0
     Dir.chdir("#{@path}/#{VERSION}/") do
-      command = 'java -jar languagetool-commandline.jar --list-unknown --api --language en-US'
-      command += " --languagemodel #{@ngrams_path}" if @ngrams
+      command = 'java -jar languagetool-commandline.jar '
+      command += '--list-unknown ' if @check_unknown_words
+      command += '--api --language en-US '
+      command += "--languagemodel #{@ngrams_path}" if @ngrams
       @p = IO.popen("#{command} -", 'r+')
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_language
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Stefan Rohe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -116,7 +116,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 Language