gherkin_readability 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c95a0fbaeb4d85bd01be2e5d236fe64e0377b813
+  data.tar.gz: b667a4d2006fb2c9ad2d8bbaea60d51f4990741d
+SHA512:
+  metadata.gz: 883d17fff6f2e77d72607430d8dc5511fd1949b55d4b120e9f8310700ce13537fc266034e8c28a6f5ac39f3aaeaa84f1f27626931c3164dc60b80e62b07ef147
+  data.tar.gz: bdfe3af27284bb00b0a771cdee0989a127e8e98a5d6ae005d04a76255397a27efe80dde024fbcb56671e25416a8794e6362e970046e68cac9c154a51142b5ff1

data/.rubocop.yml

@@ -0,0 +1,26 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-10-31 21:09:23 +0100 using RuboCop version 0.34.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
+Metrics/AbcSize:
+  Max: 22
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 121
+
+# Offense count: 8
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 115
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 21

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+ - 2.1.0
+ - 2.0.0

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby
+MAINTAINER think@hotmail.de
+
+RUN \
+  gem install gherkin_readability --no-format-exec
+
+CMD gherkin_readability

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+gem 'aruba'
+gem 'gherkin'
+gem 'gherkin_lint'
+gem 'gherkin_format'
+gem 'rake'
+gem 'rubocop'
+gem 'simplecov', require: false, group: :test
+gem 'syllables'
+gem 'term-ansicolor'

data/Guardfile

@@ -0,0 +1,3 @@
+guard 'rake', task: :default do
+  watch(%r{^lib/.*$})
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Funkwerk AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,13 @@
+Check Readability of Gherkin Files
+==================================
+
+[![Build Status](https://travis-ci.org/funkwerk/gherkin_readability.svg)](https://travis-ci.org/funkwerk/gherkin_readability)
+
+This tool checks the readability of gherkin files.
+
+Usage
+-----
+
+run `gherkin_readability` on a list of files
+
+    gherkin_readability FEATURE_FILES

data/Rakefile

@@ -0,0 +1,35 @@
+task default: :build
+
+desc 'Builds the Gem.'
+task build: :test do
+  sh 'gem build gherkin_readability.gemspec'
+end
+
+task test: :format
+task test: :lint
+task test: :rubocop
+task test: :cucumber
+
+desc 'Publishes the Gem'
+task push: :build do
+  sh 'gem push gherkin_readability-0.0.1.gem'
+end
+
+desc 'Checks ruby style'
+task :rubocop do
+  sh 'rubocop'
+end
+
+task :cucumber do
+  options = %w()
+  options.push '--tags ~@slow' unless ENV['slow']
+  sh "cucumber #{options * ' '}"
+end
+
+task :lint do
+  sh 'gherkin_lint features/*.feature'
+end
+
+task :format do
+  sh 'gherkin_format features/*.feature'
+end

data/bin/gherkin_readability

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require 'gherkin_readability'
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: gherkin_readability [files]'
+  opts.on('--[no-]summary', 'Print summary') do |summary|
+    options[:summary] = summary
+  end
+end.parse!
+
+readability = GherkinReadability.new
+
+readability.analyze ARGV
+
+readability.report if options.key? :summary

data/features/rate.feature

@@ -0,0 +1,57 @@
+Feature: Rate
+  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_readability'
+
+      readability = GherkinReadability.new
+
+      readability.analyze %w(default.feature test.feature)
+
+      """
+    And a file named "default.feature" with:
+      """
+      Feature: Default
+        Scenario: Tag
+          Given a test
+          When execute
+          Then pass
+      """
+
+  Scenario: Sort poor readable
+    Given a file named "test.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:
+      """
+      119: default.feature
+      30: test.feature
+
+      """
+
+  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:
+      """
+      120: test.feature
+      119: default.feature
+
+      """

data/features/summary.feature

@@ -0,0 +1,56 @@
+Feature: Summary
+  As a Business Analyst
+  I want to be informed about non readable features
+  so that I know about the average readabilty of my feature files
+
+  Background:
+    Given a file named "readability.rb" with:
+      """
+      $LOAD_PATH << '../../lib'
+      require 'gherkin_readability'
+
+      readability = GherkinReadability.new
+
+      readability.analyze %w(default.feature test.feature)
+      readability.report
+
+      """
+    And a file named "default.feature" with:
+      """
+      Feature: Default
+        Scenario: Tag
+          Given a test
+          When execute
+          Then pass
+      """
+
+  Scenario: Sort poor readable
+    Given a file named "test.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:
+      """
+      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:
+      """
+      2 files analyzed. Average readability is 120
+
+      """

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/gherkin_readability.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'gherkin_readability'
+  s.version     = '0.0.1'
+  s.date        = '2015-10-31'
+  s.summary     = 'Gherkin Readability'
+  s.description = 'Check readability of Gherkin Files'
+  s.authors     = ['Stefan Rohe']
+  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 '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_readability.rb

@@ -0,0 +1,155 @@
+# encoding: utf-8
+require 'gherkin/formatter/json_formatter'
+require 'gherkin/parser/parser'
+require 'rexml/document'
+require 'stringio'
+require 'multi_json'
+require 'term/ansicolor'
+include Term::ANSIColor
+require 'tmpdir'
+require 'fileutils'
+require 'yaml'
+require 'set'
+require 'digest'
+
+# gherkin utilities
+class GherkinReadability
+  def initialize
+    @readability_by_file = {}
+  end
+
+  def analyze(files)
+    files.each do |file|
+      sentences = extract_sentences parse(file)
+      @readability_by_file[file] = readability sentences
+    end
+    @readability_by_file.sort { |lhs, rhs| lhs[1] <=> rhs[1] }.reverse_each do |file, rating|
+      puts "#{rating.round}: #{file}"
+    end
+  end
+
+  def report
+    average_readability = 0
+    @readability_by_file.each do |_, rating|
+      average_readability += rating
+    end
+    average_readability /= @readability_by_file.length
+    puts "\n#{@readability_by_file.length} files analyzed. Average readability is #{average_readability.round}"
+  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 parse(file)
+    content = File.read file
+    to_json(content, file)
+  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
+
+    sentences = feature_names.call(parsed) + descriptions.call(parsed) + scenario_names(parsed) + sentences(parsed)
+    sentences.select! { |sentence| sentence }
+    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
+    end
+    scenarios
+  end
+
+  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
+      end
+    end
+    sentences
+  end
+
+  def extract_terms_from_scenario(steps, background)
+    steps.map do |step|
+      keyword = step['keyword']
+      keyword = 'and ' unless background.empty? || keyword != 'Given '
+      terms = [keyword, step['name']].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 += expand_outlines(prototype, example)
+      sentences
+    end.flatten
+  end
+
+  def uncapitalize(term)
+    term[0, 1].downcase + term[1..-1]
+  end
+
+  def expand_outlines(sentence, example)
+    result = []
+    headers = example['rows'][0]['cells']
+    example['rows'].slice(1, example['rows'].length).each do |row|
+      modified_sentence = sentence.dup
+      headers.zip(row['cells']).map { |key, value| modified_sentence.gsub!("<#{key}>", value) }
+      result.push modified_sentence
+    end
+    result
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: gherkin_readability
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefan Rohe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gherkin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.2
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+description: Check readability of Gherkin Files
+email: 
+executables:
+- gherkin_readability
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".travis.yml"
+- Dockerfile
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/gherkin_readability
+- features/rate.feature
+- features/summary.feature
+- features/support/env.rb
+- gherkin_readability.gemspec
+- lib/gherkin_readability.rb
+homepage: http://github.com/funkwerk/gherkin_readability/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Gherkin Readability
+test_files: []