gherkin_language 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f52b34c694e27a08860df95867077c5e3d7e0d0
-  data.tar.gz: 4136e08b3ffb5bfa69cc5aaf957440c52071d44f
+  metadata.gz: d845d6ef0a078c47dca82dbf52e8f3c2ec582315
+  data.tar.gz: 58d2b113ee3fc79522e71923e8b05dac5b861878
 SHA512:
-  metadata.gz: baaf62978c29a36a3ab016e656901d6420171df554507dcb033bf43f7635a4f2389a27ee725d9f618c8a2dda26f9507193ae1c57c94b92e558488320ca26352b
-  data.tar.gz: 40c3fd852df0d975262e06914a9acb7d86b7506dc071ba29ce966d8c89c97fc3ac409886395030d10c01d06d84c3e5e987b718b14819d4e06e1547d061204aa8
+  metadata.gz: 0672226fa52098d827610ad1fec13b641e58fbf2aa08c87369c794f26393e75d11c80aa6f58653e066860e0e41207dac7ece6fb34aba0012deca52574eff21a9
+  data.tar.gz: 6f4949dd6382fe18c24f582d9e1f0ab0d79f9375ff1d31b973ec53ef0db8c900b8e1cc2c55cc91b8a295099c52df37a1269c770d2df1fe43f6ec12b4132aa2db

data/.rubocop.yml

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

data/Gemfile

@@ -1,8 +1,9 @@
 source 'https://rubygems.org'
-gem 'rubocop'
+gem 'aruba'
 gem 'gherkin'
 gem 'gherkin_lint'
 gem 'gherkin_format'
 gem 'rake'
-gem 'aruba'
+gem 'rubocop'
+gem 'syllables'
 gem 'term-ansicolor'

data/bin/gherkin_language

@@ -23,6 +23,9 @@ OptionParser.new do |opts|
   opts.on('--ignore [EXCEPTIONS]', 'ignore exceptions, Separated by ","') do |exceptions|
     options[:ignore] = exceptions.split ','
   end
+  opts.on('--readability', 'readbility by file') do |readability|
+    options[:readability] = readability
+  end
 end.parse!
 
 language = GherkinLanguage.new(options.key?(:no_cache), options.key?(:ngram))
@@ -36,6 +39,8 @@ if options.key? :tag
   exit
 end
 
+language.determine_readability_by_file(ARGV) if options.key? :readability
+
 ARGV.each { |file| language.analyze file }
 
 if options.key? :ignore

data/features/readability.feature

@@ -0,0 +1,47 @@
+Feature: Readability
+  As a Business Analyst
+  I want to be informed about non readable features
+  so that I know when I need to restructure
+
+  Background:
+    Given a file named "readability.rb" with:
+      """
+      $LOAD_PATH << '../../lib'
+      require 'gherkin_language'
+
+      no_cache = true
+      ngrams = false
+      language = GherkinLanguage.new(no_cache, ngrams)
+      language.determine_readability_by_file %w(default.feature unreadable.feature)
+      exit language.report
+
+      """
+    And a file named "default.feature" with:
+      """
+      Feature: Default
+        Scenario: Tag
+          Given a test
+          When execute
+          Then pass
+      """
+
+  Scenario: Sort by readability
+    Given a file named "unreadable.feature" with:
+      """
+      Feature: Unreadable busting complexity check
+        Scenario: nonsense and unreadable
+          Given a fancy-hyper non-readable and quite complex test specification
+          When consider to execute that
+          Then verification is successful
+      """
+    When I run `ruby readability.rb`
+    Then it should pass with exactly:
+      """
+      Readability. Sorted from best to worst readable feature
+
+      119: default.feature
+      30: unreadable.feature
+
+      2 files analyzed. Average readability is 74
+
+      """

data/gherkin_language.gemspec

@@ -1,14 +1,15 @@
 Gem::Specification.new do |s|
   s.name        = 'gherkin_language'
-  s.version     = '0.0.9'
-  s.date        = '2015-10-05'
+  s.version     = '0.1.0'
+  s.date        = '2015-10-11'
   s.summary     = 'Gherkin Language'
-  s.description = 'Check language of Gherkin Files'
+  s.description = 'Check language and readability of Gherkin Files'
   s.authors     = ['Stefan Rohe']
   s.homepage    = 'http://github.com/funkwerk/gherkin_language/'
   s.files       = `git ls-files`.split("\n")
   s.executables = s.files.grep(%r{^bin/}) { |file| File.basename(file) }
   s.add_runtime_dependency 'gherkin', ['>= 2.12.2']
   s.add_runtime_dependency 'term-ansicolor', ['>= 1.3.2']
+  s.add_runtime_dependency 'syllables', ['>= 0.1.4']
   s.add_development_dependency 'aruba', ['>= 0.6.2']
 end

data/lib/gherkin_language.rb

@@ -46,6 +46,33 @@ class GherkinLanguage
     end
   end
 
+  def determine_readability_by_file(files)
+    puts "Readability. Sorted from best to worst readable feature\n\n" if files.length > 1
+    readability_by_file = {}
+    files.each do |file|
+      sentences = extract_sentences parse(file)
+      readability_by_file[file] = readability sentences
+    end
+    average_readability = 0
+    readability_by_file.sort { |lhs, rhs| lhs[1] <=> rhs[1] }.reverse_each do |file, rating|
+      puts "#{rating.round}: #{file}"
+      average_readability += rating / files.length
+    end
+    puts "\n#{files.length} files analyzed. Average readability is #{average_readability.round}" if files.length > 1
+  end
+
+  def readability(sentences)
+    require 'syllables'
+
+    total_words = 0
+    total_syllabels = 0
+    Syllables.new(sentences.join '\n').to_h.each do |_word, syllabels|
+      total_words += 1
+      total_syllabels += syllabels
+    end
+    206.835 - 1.015 * (total_words / sentences.length) - 84.6 * (total_syllabels / total_words)
+  end
+
   def accepted?(sentence)
     return false if @accepted_paragraphs.nil?
     key = :without_glossary

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_language
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Stefan Rohe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-05 00:00:00.000000000 Z
+date: 2015-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: syllables
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.2
-description: Check language of Gherkin Files
+description: Check language and readability of Gherkin Files
 email: 
 executables:
 - gherkin_language
@@ -71,6 +85,7 @@ files:
 - features/correct.feature
 - features/exception.feature
 - features/glossary.feature
+- features/readability.feature
 - features/report.feature
 - features/sentences.feature
 - features/support/env.rb
@@ -100,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Gherkin Language