gherkin_lint 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3daa67e7b175ac10bdcc6698e7d49f45a294c4e
-  data.tar.gz: 5c7c0835a63af9a94fe99056f0a89f3d798dadbe
+  metadata.gz: 1d0d99d8c45ff4c504466326ac7f7dea6be3bcab
+  data.tar.gz: 680a25d303d1502e64218883dfaf01bbf8dd0eba
 SHA512:
-  metadata.gz: 5538c69efcd96aeabc32aa6bbb4746edddc89e71f8823c00ecdc3e6862529b406dd738a8748a8a3ed530a233eb7aff669b92aaf83494008a9efebdbf3a98cfd5
-  data.tar.gz: a867fa1ea399b7f5f564a0be95c411df25582cc8a0d06278b29f18ddc03e4dbecdb98c3c429e64ad43fcad59511172053085410936ef38d85342b98b8f15729f
+  metadata.gz: 3690cf08438bb34015d64a2e9218c60061ba4bfcb706346fe13a23ebaffe2a746f13b8bd4beb339238c6ab6340ec65ecc330f498a682f85e69c4a2979364e842
+  data.tar.gz: 63bf4c8d24cd0222a38efe34a0c30cc5eaa3b83574c9b8e6391df1034e4ce208ef267021509c9b9283e45263ff899096da9890d6e28a34eb5a457e1a94025f9e

data/lib/gherkin_lint.rb

@@ -128,6 +128,22 @@ class GherkinLint
     def add_issue(references, description = nil)
       @issues.push Issue.new(name, references, description)
     end
+
+    def gather_tags(element)
+      return [] unless element.include? 'tags'
+      element['tags'].map { |tag| tag['name'][1..-1] }
+    end
+
+    def render_step(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
 
   # service class to lint for unique scenario names
@@ -159,6 +175,53 @@ class GherkinLint
     end
   end
 
+  # service class to lint for too many tags
+  class TooManyTags < Linter
+    def lint
+      scenarios do |file, feature, scenario|
+        tags = gather_tags(feature) + gather_tags(scenario)
+        next unless tags.length >= 3
+        references = [reference(file, feature, scenario)]
+        add_issue(references, "Used #{tags.length} Tags")
+      end
+    end
+  end
+
+  # service class to lint for too many different tags
+  class TooManyDifferentTags < Linter
+    def lint
+      overall_tags = []
+      overall_references = []
+      features do |file, feature|
+        tags = tags_for_feature(feature)
+        overall_tags += tags
+        references = [reference(file, feature)]
+        overall_references += references unless tags.empty?
+        warn_single_feature(references, tags)
+      end
+      warn_across_all_features(overall_references, overall_tags)
+    end
+
+    def warn_single_feature(references, tags)
+      tags.uniq!
+      references.uniq!
+      return false unless tags.length >= 3
+      add_issue(references, "Used #{tags.length} Tags within single Feature")
+    end
+
+    def warn_across_all_features(references, tags)
+      tags.uniq!
+      references.uniq!
+      return false unless tags.length >= 10
+      add_issue(references, "Used #{tags.length} Tags across all Features")
+    end
+
+    def tags_for_feature(feature)
+      return [] unless feature.include? 'elements'
+      gather_tags(feature) + feature['elements'].map { |scenario| gather_tags(scenario) }.flatten
+    end
+  end
+
   # service class to lint for too long steps
   class TooLongStep < Linter
     def lint
@@ -221,6 +284,24 @@ class GherkinLint
     end
   end
 
+  # service class to lint for file name differs feature name
+  class FileNameDiffersFeatureName < Linter
+    def lint
+      features do |file, feature|
+        next unless feature.include? 'name'
+        expected_feature_name = title_case file
+        next unless feature['name'] != expected_feature_name
+        references = [reference(file, feature)]
+        add_issue(references, "Feature name should be '#{expected_feature_name}'")
+      end
+    end
+
+    def title_case(value)
+      value = File.basename(value, '.feature')
+      value.split('_').collect(&:capitalize).join(' ')
+    end
+  end
+
   # service class to lint for missing feature descriptions
   class MissingFeatureDescription < Linter
     def lint
@@ -459,7 +540,7 @@ class GherkinLint
         next if scenario['keyword'] == 'Background'
         next unless scenario.include? 'steps'
         return [] unless scenario['steps'].first['keyword'] == 'Given '
-        result.push scenario['steps'].first['name']
+        result.push render_step scenario['steps'].first
       end
       result
     end
@@ -503,20 +584,9 @@ class GherkinLint
     def generate_reference(file, feature, scenario)
       reference = {}
       reference[:reference] = reference(file, feature, scenario)
-      reference[:text] = scenario['steps'].map { |step| render(step) }.join ' '
+      reference[:text] = scenario['steps'].map { |step| render_step(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 = [
@@ -524,6 +594,7 @@ class GherkinLint
     BackgroundDoesMoreThanSetup,
     BackgroundRequiresMultipleScenarios,
     BadScenarioName,
+    FileNameDiffersFeatureName,
     MissingExampleName,
     MissingFeatureDescription,
     MissingFeatureName,
@@ -533,7 +604,9 @@ class GherkinLint
     InvalidFileName,
     InvalidStepFlow,
     TooClumsy,
+    TooManyDifferentTags,
     TooManySteps,
+    TooManyTags,
     TooLongStep,
     UniqueScenarioNames,
     UnknownVariable,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Stefan Rohe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-05 00:00:00.000000000 Z
+date: 2015-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin