gherkin_lint 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0115886cf68f342c7e96db6fed9b810821d39586
-  data.tar.gz: bc8c412c92394916145f3b4998e1455a942f1ef0
+  metadata.gz: d3daa67e7b175ac10bdcc6698e7d49f45a294c4e
+  data.tar.gz: 5c7c0835a63af9a94fe99056f0a89f3d798dadbe
 SHA512:
-  metadata.gz: 5b1fb9da007d9908a43ea4ae5d7b9c4cad6604b9030306e9a254cab5cc0680011b2de551bf16a2556951620cfc82279b2521f11e8ee53e8b4cc5088c6b5fa0df
-  data.tar.gz: 1f5c003ef09b1bb24bf732816a43982ca7605ce541a60af1971094f694e3b30d03551e3de2fe87ef4fe1b2b97ef6234ec112d277c1bda2e2369d130aa0db3219
+  metadata.gz: 5538c69efcd96aeabc32aa6bbb4746edddc89e71f8823c00ecdc3e6862529b406dd738a8748a8a3ed530a233eb7aff669b92aaf83494008a9efebdbf3a98cfd5
+  data.tar.gz: a867fa1ea399b7f5f564a0be95c411df25582cc8a0d06278b29f18ddc03e4dbecdb98c3c429e64ad43fcad59511172053085410936ef38d85342b98b8f15729f

data/lib/gherkin_lint.rb

@@ -1,3 +1,4 @@
+require 'amatch'
 require 'gherkin/formatter/json_formatter'
 require 'gherkin/parser/parser'
 require 'stringio'
@@ -59,6 +60,31 @@ class GherkinLint
       end
     end
 
+    def filled_scenarios
+      @files.each do |file, content|
+        content.each do |feature|
+          next unless feature.key? 'elements'
+          feature['elements'].each do |scenario|
+            next if scenario['keyword'] == 'Background'
+            next unless scenario.include? 'steps'
+            yield(file, feature, scenario)
+          end
+        end
+      end
+    end
+
+    def steps
+      @files.each do |file, content|
+        content.each do |feature|
+          next unless feature.key? 'elements'
+          feature['elements'].each do |scenario|
+            next unless scenario.include? 'steps'
+            scenario['steps'].each { |step| yield(file, feature, scenario, step) }
+          end
+        end
+      end
+    end
+
     def backgrounds
       @files.each do |file, content|
         content.each do |feature|
@@ -133,6 +159,17 @@ class GherkinLint
     end
   end
 
+  # service class to lint for too long steps
+  class TooLongStep < Linter
+    def lint
+      steps do |file, feature, scenario, step|
+        next if step['name'].length < 80
+        references = [reference(file, feature, scenario, step)]
+        add_issue(references, "Used #{step['name'].length} characters")
+      end
+    end
+  end
+
   # service class to lint for missing verifications
   class MissingVerification < Linter
     def lint
@@ -254,8 +291,7 @@ class GherkinLint
       steps.each do |step|
         break if step['keyword'] == 'When '
         references = [reference(file, feature, scenario, step)]
-        description = 'Missing Action'
-        add_issue(references, description) if step['keyword'] == 'Then '
+        add_issue(references, 'Missing Action') if step['keyword'] == 'Then '
       end
     end
   end
@@ -275,6 +311,31 @@ class GherkinLint
     end
   end
 
+  # service class to lint for too clumsy scenarios
+  class TooClumsy < Linter
+    def lint
+      scenarios do |file, feature, scenario|
+        next unless scenario.include? 'steps'
+        characters = scenario['steps'].map { |step| step['name'].length }.inject(0, :+)
+        next if characters < 400
+        references = [reference(file, feature, scenario)]
+        add_issue(references, "Used #{characters} Characters")
+      end
+    end
+  end
+
+  # service class to lint for too many steps
+  class TooManySteps < Linter
+    def lint
+      scenarios do |file, feature, scenario|
+        next unless scenario.include? 'steps'
+        next if scenario['steps'].length < 10
+        references = [reference(file, feature, scenario)]
+        add_issue(references, "Used #{scenario['steps'].length} Steps")
+      end
+    end
+  end
+
   # service class to lint for invalid file names
   class InvalidFileName < Linter
     def lint
@@ -290,7 +351,7 @@ class GherkinLint
   # service class to lint for unknown variables
   class UnknownVariable < Linter
     def lint
-      scenarios do |file, feature, scenario|
+      filled_scenarios do |file, feature, scenario|
         known_vars = known_variables scenario
         scenario['steps'].each do |step|
           step_vars(step).each do |used_var|
@@ -314,7 +375,7 @@ class GherkinLint
     end
 
     def gather_vars(string)
-      string.scan(/<.+>/).map { |val| val[1..-2] }
+      string.scan(/<.+?>/).map { |val| val[1..-2] }
     end
 
     def known_variables(scenario)
@@ -379,6 +440,85 @@ class GherkinLint
     end
   end
 
+  # service class to lint for using background
+  class UseBackground < Linter
+    def lint
+      features do |file, feature|
+        givens = gather_givens feature
+        next if givens.length <= 1
+        next if givens.uniq.length > 1
+        references = [reference(file, feature)]
+        add_issue(references, "Step '#{givens.uniq.first}' should be part of background")
+      end
+    end
+
+    def gather_givens(feature)
+      result = []
+      return result unless feature.include? 'elements'
+      feature['elements'].each do |scenario|
+        next if scenario['keyword'] == 'Background'
+        next unless scenario.include? 'steps'
+        return [] unless scenario['steps'].first['keyword'] == 'Given '
+        result.push scenario['steps'].first['name']
+      end
+      result
+    end
+  end
+
+  # service class to lint for using outline
+  class UseOutline < Linter
+    def lint
+      features do |file, feature|
+        check_similarity gather_scenarios(file, feature)
+      end
+    end
+
+    def check_similarity(scenarios)
+      scenarios.product(scenarios) do |lhs, rhs|
+        next if lhs == rhs
+        next if lhs[:reference] > rhs[:reference]
+        similarity = determine_similarity(lhs[:text], rhs[:text])
+        next unless similarity >= 0.95
+        references = [lhs[:reference], rhs[:reference]]
+        add_issue(references, "Scenarios are similar by #{similarity.round(3) * 100} %")
+      end
+    end
+
+    def determine_similarity(lhs, rhs)
+      matcher = Amatch::Jaro.new lhs
+      matcher.match rhs
+    end
+
+    def gather_scenarios(file, feature)
+      scenarios = []
+      return scenarios unless feature.include? 'elements'
+      feature['elements'].each do |scenario|
+        next unless scenario['keyword'] == 'Scenario'
+        next unless scenario.include? 'steps'
+        scenarios.push generate_reference(file, feature, scenario)
+      end
+      scenarios
+    end
+
+    def generate_reference(file, feature, scenario)
+      reference = {}
+      reference[:reference] = reference(file, feature, scenario)
+      reference[:text] = scenario['steps'].map { |step| render(step) }.join ' '
+      reference
+    end
+
+    def render(step)
+      value = "#{step['keyword']}#{step['name']}"
+      value += "\n#{step['doc_string']['value']}" if step.include? 'doc_string'
+      if step.include? 'rows'
+        value += step['rows'].map do |row|
+          row['cells'].join '|'
+        end.join "|\n"
+      end
+      value
+    end
+  end
+
   LINTER = [
     AvoidPeriod,
     BackgroundDoesMoreThanSetup,
@@ -392,9 +532,14 @@ class GherkinLint
     MissingVerification,
     InvalidFileName,
     InvalidStepFlow,
+    TooClumsy,
+    TooManySteps,
+    TooLongStep,
     UniqueScenarioNames,
     UnknownVariable,
-    UnusedVariable
+    UnusedVariable,
+    UseBackground,
+    UseOutline
   ]
 
   def initialize

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_lint
 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-07-04 00:00:00.000000000 Z
+date: 2015-07-05 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: amatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement