gherkin_readability 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9efe1814b0c5cdfbd914a80f900c9cc066377e4
-  data.tar.gz: 5a598253c9b72d40133a96712e8fb1535f695455
+  metadata.gz: c7ddf801d76b6879a3e7d348307f1f86e7160174
+  data.tar.gz: 4d1d99982cb6898dc9c487343f15fce09f93e732
 SHA512:
-  metadata.gz: 68f6f7a7e2bb627f51619ebad972f9d73a7777b14f8e474cd520f69b0a1e62371423ea28672bef19dc236e785e75e6a8f22dc9a5afe7e16b20662897e6d187ea
-  data.tar.gz: 09f8ab184f08990fefff3f1ebfbaca52f276153f8cf42ddfa1617c95193d82e5baa1b00d9178303afda4d69e0c3301340657333cc0dd2059fd505e83a2662c74
+  metadata.gz: 307e3d01180f8bbc0144ec6ee36f16e7379cf5044059849c8e46dd2e30efeaf366c78649366889a685d4d345e27360e23dcd25253ed8d49cbebe284717e46883
+  data.tar.gz: e7645371433a2df1690c8f18405b1fcadc3fafb40a1be037181f050c7347051660f7c0400e073977e05f4d5e4acc7ea09d262d65a4294d5ba50a326b3d49b048

data/.rubocop.yml

@@ -1,26 +1,27 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-10-31 21:09:23 +0100 using RuboCop version 0.34.2.
+# on 2016-02-28 18:50:53 +0100 using RuboCop version 0.37.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 2
 Metrics/AbcSize:
-  Max: 22
+  Max: 21
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 140
+  Max: 121
 
 # Offense count: 8
-# Configuration parameters: AllowURI, URISchemes.
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
 Metrics/LineLength:
-  Max: 115
+  Max: 111
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 21
+  Max: 17

data/Gemfile

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

data/Rakefile

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

data/gherkin_readability.gemspec

@@ -1,14 +1,15 @@
 Gem::Specification.new do |s|
   s.name        = 'gherkin_readability'
-  s.version     = '0.0.5'
-  s.date        = '2016-01-17'
+  s.version     = '0.1.0'
+  s.date        = '2016-02-28'
   s.summary     = 'Gherkin Readability'
-  s.description = 'Check readability of Gherkin Files'
+  s.description = 'Determine readability of Gherkin Files'
   s.authors     = ['Stefan Rohe']
+  s.licenses    = ['MIT']
   s.homepage    = 'http://github.com/funkwerk/gherkin_readability/'
   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 'gherkin', ['= 3.2.0']
   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']

data/lib/gherkin_readability.rb

@@ -1,8 +1,7 @@
 # encoding: utf-8
-gem 'gherkin', '=2.12.2'
+gem 'gherkin', '=3.2.0'
 
-require 'gherkin/formatter/json_formatter'
-require 'gherkin/parser/parser'
+require 'gherkin/parser'
 require 'rexml/document'
 require 'stringio'
 require 'multi_json'
@@ -75,43 +74,26 @@ class GherkinReadability
 
   def parse(file)
     content = File.read file
-    to_json(content, file)
+    Gherkin::Parser.new.parse content
   end
 
-  def extract_sentences(parsed)
-    feature_names = lambda do |input|
-      input.map { |feature| feature['name'] unless feature['name'] == '' }
-    end
-
-    descriptions = lambda do |input|
-      input.map { |feature| feature['description'] unless feature['description'] == '' }
-    end
+  def extract_sentences(input)
+    sentences = []
 
-    sentences = feature_names.call(parsed) + descriptions.call(parsed) + scenario_names(parsed) + sentences(parsed)
-    sentences.select! { |sentence| sentence }
+    sentences.push input[:name] unless input[:name].empty?
+    sentences.push input[:description] if input.key? :description
+    sentences.push input[:background][:name] if input.key?(:background) && !input[:background][:name].empty?
+    sentences += scenario_names input
+    sentences += sentences input
     sentences.map { |sentence| sentence.gsub(/ «.+»/, '') }
   end
 
-  def to_json(input, file = 'generated.feature')
-    io = StringIO.new
-    formatter = Gherkin::Formatter::JSONFormatter.new(io)
-    parser = Gherkin::Parser::Parser.new(formatter, true)
-    parser.parse(input, file, 0)
-    formatter.done
-    MultiJson.load io.string
-  end
-
   def scenario_names(input)
-    # TODO: scenario outlines with example values inside?
     scenarios = []
-    input.each do |features|
-      next unless features.key? 'elements'
-      elements = features['elements']
-      elements.each do |scenario|
-        scenarios.push scenario['name'] if scenario['type'] == 'scenario'
-        scenarios.push scenario['name'] if scenario['type'] == 'scenario_outline'
-        scenarios.push scenario['description'] unless scenario['description'].empty?
-      end
+
+    input[:scenarioDefinitions].each do |scenario|
+      scenarios.push scenario[:name]
+      scenarios.push scenario[:description] if scenario.key? :description
     end
     scenarios
   end
@@ -119,23 +101,21 @@ class GherkinReadability
   def sentences(input)
     sentences = []
     background = []
-    input.each do |features|
-      next unless features.key? 'elements'
-      features['elements'].each do |scenario|
-        next unless scenario.key? 'steps'
-        terms = background.dup
-        if scenario['type'] == 'background'
-          background.push extract_terms_from_scenario(scenario['steps'], terms)
-          next
-        end
-
-        terms.push extract_terms_from_scenario(scenario['steps'], background)
-        sentence = terms.join(' ').strip
-        if scenario.key? 'examples'
-          sentences += extract_examples(scenario['examples'], sentence)
-        else
-          sentences.push sentence
-        end
+
+    if input.key?(:background) && input[:background].key?(:steps)
+      background = extract_terms_from_scenario(input[:background][:steps], [])
+    end
+
+    input[:scenarioDefinitions].each do |scenario|
+      next unless scenario.key? :steps
+      terms = background.dup
+
+      terms.push extract_terms_from_scenario(scenario[:steps], background)
+      sentence = terms.join(' ').strip
+      if scenario.key? :examples
+        sentences += extract_examples(scenario[:examples], sentence)
+      else
+        sentences.push sentence
       end
     end
     sentences
@@ -143,20 +123,19 @@ class GherkinReadability
 
   def extract_terms_from_scenario(steps, background)
     steps.map do |step|
-      keyword = step['keyword']
+      keyword = step[:keyword]
       keyword = 'and ' unless background.empty? || keyword != 'Given '
-      terms = [keyword, step['name']].join
+      terms = [keyword, step[:text]].join
       terms = uncapitalize(terms) unless background.empty?
       background = terms
-      terms
     end.flatten
   end
 
   def extract_examples(examples, prototype)
     examples.map do |example|
       sentences = []
-      sentences.push example['name'] unless example['name'].empty?
-      sentences.push example['description'] unless example['description'].empty?
+      sentences.push example[:name] unless example[:name].empty?
+      sentences.push example[:description] if example.key? :description
       sentences += expand_outlines(prototype, example)
       sentences
     end.flatten
@@ -168,10 +147,12 @@ class GherkinReadability
 
   def expand_outlines(sentence, example)
     result = []
-    headers = example['rows'][0]['cells']
-    example['rows'].slice(1, example['rows'].length).each do |row|
+    headers = example[:tableHeader][:cells].map { |cell| cell[:value] }
+
+    example[:tableBody].each do |row|
       modified_sentence = sentence.dup
-      headers.zip(row['cells']).map { |key, value| modified_sentence.gsub!("<#{key}>", value) }
+      values = row[:cells].map { |cell| cell[:value] }
+      headers.zip(values).map { |key, value| modified_sentence.gsub!("<#{key}>", value) }
       result.push modified_sentence
     end
     result

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_readability
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Stefan Rohe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-17 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.12.2
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.12.2
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.2
-description: Check readability of Gherkin Files
+description: Determine readability of Gherkin Files
 email: 
 executables:
 - gherkin_readability
@@ -89,7 +89,8 @@ files:
 - gherkin_readability.gemspec
 - lib/gherkin_readability.rb
 homepage: http://github.com/funkwerk/gherkin_readability/
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -107,7 +108,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 Readability