gherkin_language 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d845d6ef0a078c47dca82dbf52e8f3c2ec582315
-  data.tar.gz: 58d2b113ee3fc79522e71923e8b05dac5b861878
+  metadata.gz: 7a590ba82c3ddcfadb69cdb406e9f748ffde3ab8
+  data.tar.gz: 9e1b9775fdff0c5da5189c3a5f6ba39f165e19e1
 SHA512:
-  metadata.gz: 0672226fa52098d827610ad1fec13b641e58fbf2aa08c87369c794f26393e75d11c80aa6f58653e066860e0e41207dac7ece6fb34aba0012deca52574eff21a9
-  data.tar.gz: 6f4949dd6382fe18c24f582d9e1f0ab0d79f9375ff1d31b973ec53ef0db8c900b8e1cc2c55cc91b8a295099c52df37a1269c770d2df1fe43f6ec12b4132aa2db
+  metadata.gz: 7fa9d18fbde5d760c308a421a81c6e865738797d8f979bcaa39d557c96ee7174cd89840e0597ddd940dc502dc6f13442ed478404338caff28dd4e70d6c6a4d28
+  data.tar.gz: a787411778379f5b51cc50119d2ac86f8efef1b32ac97591879700f761657e78502219419e170523eeed3efb16690da9e064f1fa6bc4ccf3d272e64b4dcf6acd

data/Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby
+MAINTAINER think@hotmail.de
+
+# TODO: activate --ngram
+RUN \
+  apt-get update && \
+  apt-get install -y unzip default-jre && \
+  gem install gherkin_language --no-format-exec && \
+  echo "Feature: Empty" > /tmp/empty.feature && \
+  gherkin_language /tmp/empty.feature && \
+  rm /tmp/empty.feature 
+
+CMD gherkin_language

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 gem 'aruba'
-gem 'gherkin'
+gem 'gherkin', '=2.12.2'
 gem 'gherkin_lint'
 gem 'gherkin_format'
 gem 'rake'

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.
 
+Get a readability report using `--readability`. It indicates, which files are not good readable.
+
 
 Glossary
 --------

data/Rakefile

@@ -18,7 +18,7 @@ task test: :cucumber
 
 desc 'Publishes the Gem'
 task push: :build do
-  sh 'gem push gherkin_language-0.0.9.gem'
+  sh 'gem push gherkin_language-0.1.1.gem'
 end
 
 desc 'Checks ruby style'
@@ -27,7 +27,9 @@ task :rubocop do
 end
 
 task :cucumber do
-  sh 'cucumber'
+  options = %w()
+  options.push '--tags ~@slow' unless ENV['slow']
+  sh "cucumber #{options * ' '}"
 end
 
 task :lint do

data/features/confused_words.feature

@@ -1,3 +1,4 @@
+@slow
 Feature: Confused Words
   As a Business Analyst
   I want to be informed for confused words
@@ -34,6 +35,7 @@ Feature: Confused Words
         Context: Given I do not now where it is when execute then pass
         Replacements: know
         References: test.feature
+
       """
 
   Scenario: Accept non confused words

data/features/readability.feature

@@ -12,7 +12,7 @@ Feature: Readability
       no_cache = true
       ngrams = false
       language = GherkinLanguage.new(no_cache, ngrams)
-      language.determine_readability_by_file %w(default.feature unreadable.feature)
+      language.determine_readability_by_file %w(default.feature test.feature)
       exit language.report
 
       """
@@ -25,8 +25,8 @@ Feature: Readability
           Then pass
       """
 
-  Scenario: Sort by readability
-    Given a file named "unreadable.feature" with:
+  Scenario: Sort poor readable
+    Given a file named "test.feature" with:
       """
       Feature: Unreadable busting complexity check
         Scenario: nonsense and unreadable
@@ -40,8 +40,28 @@ Feature: Readability
       Readability. Sorted from best to worst readable feature
 
       119: default.feature
-      30: unreadable.feature
+      30: test.feature
 
       2 files analyzed. Average readability is 74
 
       """
+
+  Scenario: Sort highly readable
+    Given a file named "test.feature" with:
+      """
+      Feature: Test
+        Scenario: Test
+          When execute
+          Then test
+      """
+    When I run `ruby readability.rb`
+    Then it should pass with exactly:
+      """
+      Readability. Sorted from best to worst readable feature
+
+      120: test.feature
+      119: default.feature
+
+      2 files analyzed. Average readability is 120
+
+      """

data/features/support/env.rb

@@ -1,5 +1,5 @@
 require 'aruba/cucumber'
 
 Before do
-  @aruba_timeout_seconds = 1000  # external java process, give it some time
+  @aruba_timeout_seconds = 1000 # external java process, give it some time
 end

data/features/tag.feature

@@ -26,26 +26,15 @@ Feature: Tag
     Then it should pass with exactly:
       """
       <S>
-      [[[/null]
-      "["/``]
-      Test[Test/NNP]
-      "["/'']
-      ,[,/,,O]
-      "["/``,O]
-      Tag[tag/NN:UN,tag/VB,tag/VBP]
-      "["/'']
-      ,[,/,,O]
-      "["/``,O]
-      Given[Given/NNP,B-VP]
+      [[[/null]"["/``]Test[Test/NNP]"["/''],[,/,,O]
+      "["/``,O]Tag[tag/NN:UN,tag/VB,tag/VBP]"["/''],[,/,,O]
+      "["/``,O]Given[Given/NNP,B-VP]
       a[a/DT,B-NP-singular]
       test[test/JJ,test/NN,test/VB,test/VBP,E-NP-singular]
       when[when/WRB,B-ADVP]
       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]
+      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.0'
-  s.date        = '2015-10-11'
+  s.version     = '0.1.1'
+  s.date        = '2016-01-17'
   s.summary     = 'Gherkin Language'
   s.description = 'Check language and readability of Gherkin Files'
   s.authors     = ['Stefan Rohe']

data/lib/gherkin_language.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+gem 'gherkin', '2.12.2'
+
 require 'gherkin/formatter/json_formatter'
 require 'gherkin/parser/parser'
 require 'gherkin_language/error'
@@ -66,7 +68,7 @@ class GherkinLanguage
 
     total_words = 0
     total_syllabels = 0
-    Syllables.new(sentences.join '\n').to_h.each do |_word, syllabels|
+    Syllables.new(sentences.join('\n')).to_h.each do |_word, syllabels|
       total_words += 1
       total_syllabels += syllabels
     end
@@ -76,7 +78,7 @@ class GherkinLanguage
   def accepted?(sentence)
     return false if @accepted_paragraphs.nil?
     key = :without_glossary
-    key = hash(File.read '.glossary') if File.exist? '.glossary'
+    key = hash(File.read('.glossary')) if File.exist? '.glossary'
 
     return false unless @accepted_paragraphs.key? key
     @accepted_paragraphs[key].include? hash sentence
@@ -147,7 +149,7 @@ class GherkinLanguage
     @references.each do |sentence, _refs|
       next if used_refs.include? sentence
       key = :without_glossary
-      key = hash(File.read '.glossary') if File.exist? '.glossary'
+      key = hash(File.read('.glossary')) if File.exist? '.glossary'
 
       @accepted_paragraphs[key] = Set.new [] unless @accepted_paragraphs.key? key
       @accepted_paragraphs[key].add hash sentence

data/lib/gherkin_language/language_tool_process.rb

@@ -16,10 +16,10 @@ require 'digest'
 class LanguageToolProcess
   attr_accessor :errors, :unknown_words
 
-  VERSION = 'LanguageTool-3.1'
-  URL = "https://www.languagetool.org/download/#{VERSION}.zip"
-  NGRAM_VERSION = 'ngrams-en-20150817'
-  NGRAM_URL = "https://languagetool.org/download/ngram-data/#{NGRAM_VERSION}.zip"
+  VERSION = 'LanguageTool-3.1'.freeze
+  URL = "https://www.languagetool.org/download/#{VERSION}.zip".freeze
+  NGRAM_VERSION = 'ngrams-en-20150817'.freeze
+  NGRAM_URL = "https://languagetool.org/download/ngram-data/#{NGRAM_VERSION}.zip".freeze
 
   def initialize(ngrams = false)
     path = Dir.tmpdir
@@ -77,9 +77,9 @@ class LanguageToolProcess
       end
       p.close
     end
-    output.gsub!(' ', "\n")
-    output.gsub!(']', "]\n")
-    output.gsub!("\n\n", "\n")
+    output.tr!(' ', "\n")
+    output.tr!(']', "]\n")
+    output.tr!("\n\n", "\n")
     output
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_language
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stefan Rohe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-11 00:00:00.000000000 Z
+date: 2016-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - Guardfile
 - LICENSE
@@ -115,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Gherkin Language