gherkin_readability 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f74dea223b57a5464602efa142839ab830801706
-  data.tar.gz: 6ba4a14b709b0a0ce74c05c4002f8155a198ff67
+  metadata.gz: a2a2bae7e922dd999e348f414ef91d60cc699b58
+  data.tar.gz: 2ff9c0171ba577ae96f5ade5488e553151c63739
 SHA512:
-  metadata.gz: bbdec8abcb32f2e3538c4596430f8aca8e6cc738b2425a7802a25cb7ea049215f7b7e5786f77c29c8f1e4af5d665b039bbfde5dd363f6b2b19635eaeb3ce464a
-  data.tar.gz: 05e43fc346538457d32fd745248ed766632b646d037ebc5ee1e1d6878d12e243eb29c3476d9a92f9bc8847ba6154ac316916d832c909a22d8f603d2356009733
+  metadata.gz: 34c7c8c147337464e42649f4fc96e3d42e836a6c999a573f99debab3cb0472cdc6265f0b88777f6abf17e97862020a549b556870e36821e0ee0185bbb5c0da8b
+  data.tar.gz: 417c5fe519fe83a79b134471dd5a963712fcbe1c9eaf97a9184f2d072118de086c6a3172afb72f3e9ed7d0dd5e9f43fe722240da66d4aefef3137d075c37b5dc

data/.rubocop.yml

@@ -13,7 +13,7 @@ Metrics/AbcSize:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 137
+  Max: 140
 
 # Offense count: 8
 # Configuration parameters: AllowURI, URISchemes.

data/Rakefile

@@ -12,7 +12,7 @@ task test: :cucumber
 
 desc 'Publishes the Gem'
 task push: :build do
-  sh 'gem push gherkin_readability-0.0.2.gem'
+  sh 'gem push gherkin_readability-0.0.3.gem'
 end
 
 desc 'Checks ruby style'

data/bin/gherkin_readability

@@ -14,11 +14,15 @@ OptionParser.new do |opts|
   opts.on('--above [THRESHOLD]', 'Selects just files above the threshold') do |threshold|
     options[:above] = threshold.to_i
   end
+  opts.on('--verbose', 'Verbose output') do |verbose|
+    options[:verbose] = verbose
+  end
 end.parse!
 
 readability = GherkinReadability.new
 
-readability.analyze ARGV
+verbose = options.key?(:verbose) ? options[:verbose] : false
+readability.analyze(ARGV, verbose)
 
 readability.select_below! options[:below] if options.key? :below
 readability.select_above! options[:above] if options.key? :above

data/features/verbose.feature

@@ -0,0 +1,33 @@
+Feature: Verbose
+  As a Business Analyst
+  I want to read verbose output
+  so that I know which scenarios are too complex
+
+  Scenario: Verbose output
+    Given a file named "readability.rb" with:
+      """
+      $LOAD_PATH << '../../lib'
+      require 'gherkin_readability'
+
+      readability = GherkinReadability.new
+
+      verbose = true
+      readability.analyze %w(default.feature), verbose
+
+      """
+    And a file named "default.feature" with:
+      """
+      Feature: Default
+        Scenario: Tag
+          Given a test
+          When execute
+          Then pass
+      """
+    When I run `ruby readability.rb`
+    Then it should pass with:
+      """
+      37 - Default
+      121 - Tag
+      115 - Given a test when execute then pass
+
+      """

data/gherkin_readability.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'gherkin_readability'
-  s.version     = '0.0.2'
-  s.date        = '2015-11-10'
+  s.version     = '0.0.3'
+  s.date        = '2015-11-13'
   s.summary     = 'Gherkin Readability'
   s.description = 'Check readability of Gherkin Files'
   s.authors     = ['Stefan Rohe']

data/lib/gherkin_readability.rb

@@ -12,15 +12,18 @@ require 'yaml'
 require 'set'
 require 'digest'
 
-# gherkin utilities
+# gherkin readability
 class GherkinReadability
   def initialize
     @readability_by_file = {}
   end
 
-  def analyze(files)
+  def analyze(files, verbose = false)
     files.each do |file|
       sentences = extract_sentences parse(file)
+      sentences.each do |sentence|
+        puts "#{readability([sentence]).round} - #{sentence.tr("\n", ' ').strip}"
+      end if verbose
       @readability_by_file[file] = readability sentences
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_readability
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Stefan Rohe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-10 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -85,6 +85,7 @@ files:
 - features/rate.feature
 - features/summary.feature
 - features/support/env.rb
+- features/verbose.feature
 - gherkin_readability.gemspec
 - lib/gherkin_readability.rb
 homepage: http://github.com/funkwerk/gherkin_readability/