gherkin_lint 0.1.2 → 0.3.0

data/Rakefile

@@ -11,7 +11,7 @@ end
 
 desc 'Publishes the Gem'
 task :push do
-  sh 'gem push gherkin_lint-0.1.2.gem'
+  sh 'gem push gherkin_lint-0.3.0.gem'
 end
 
 desc 'Checks ruby style'
@@ -36,5 +36,9 @@ task :language do
 end
 
 task :self_check do
-  sh 'RUBYLIB=lib ./bin/gherkin_lint --disable UnknownVariable,BadScenarioName features/*.feature'
+  disabled_checks = %w(
+    UnknownVariable
+    BadScenarioName
+  )
+  sh "RUBYLIB=lib ./bin/gherkin_lint --disable #{disabled_checks.join ','} features/*.feature"
 end

data/features/avoid_scripting.feature

@@ -31,6 +31,7 @@ Feature: Avoid Scripting
       """
       AvoidScripting - Multiple Actions
         lint.feature (2): Test.A
+
       """
 
   Scenario: Repeat Action-Verfication Steps
@@ -49,6 +50,7 @@ Feature: Avoid Scripting
       """
       AvoidScripting - Multiple Actions
         lint.feature (2): Test.A
+
       """
 
   Scenario: Valid Example

data/features/be_declarative.feature

@@ -0,0 +1,53 @@
+Feature: Be Declarative
+  As a Customer
+  I want to read declarative scenarios
+  so that I'm able to understand how to set the system in the state and how to prove the state
+
+  Background: Prepare Testee
+    Given a file named "lint.rb" with:
+      """
+      $LOAD_PATH << '../../lib'
+      require 'gherkin_lint'
+
+      linter = GherkinLint::GherkinLint.new
+      linter.enable %w(BeDeclarative)
+      linter.analyze 'lint.feature'
+      exit linter.report
+
+      """
+
+  Scenario: Non Declarative Scenario
+    Given a file named "lint.feature" with:
+      """
+      Feature: Test
+        Scenario: A
+          Given a number 1
+          And another number 2
+          When add these numbers
+          Then the result is 3
+      """
+    When I run `ruby lint.rb`
+    Then it should pass with exactly:
+      """
+      BeDeclarative (Warning) - no verb
+        lint.feature (3): Test.A step: a number 1
+      BeDeclarative (Warning) - no verb
+        lint.feature (4): Test.A step: another number 2
+
+      """
+
+  Scenario: Valid Example
+    Given a file named "lint.feature" with:
+      """
+      Feature: Test
+        Scenario: A
+          Given a number is set to 1
+          And another number is set to 2
+          When add these numbers
+          Then the result is 3
+      """
+    When I run `ruby lint.rb`
+    Then it should pass with exactly:
+      """
+
+      """

data/features/missing_example_name.feature

@@ -27,12 +27,36 @@ Feature: Missing Example Name
           Examples:
             | value |
             | test  |
+
+          Examples:
+            | value |
+            | test  |
       """
     When I run `ruby lint.rb`
     Then it should fail with exactly:
       """
       MissingExampleName - No Example Name
         lint.feature (2): Test.A
+      MissingExampleName - No Example Name
+        lint.feature (2): Test.A
+
+      """
+
+  Scenario: Names could be omitted for scenarios with a single example
+    Given a file named "lint.feature" with:
+      """
+      Feature: Test
+        Scenario Outline: A
+          When test
+          Then <value>
+
+          Examples:
+            | value |
+            | test  |
+      """
+    When I run `ruby lint.rb`
+    Then it should pass with exactly:
+      """
 
       """
 

data/features/same_tag_for_all_scenarios.feature

@@ -16,7 +16,7 @@ Feature: Same Tag For All Scenarios
 
       """
 
-  Scenario: Many Tags
+  Scenario: Tags used multiple times for scenario
     Given a file named "lint.feature" with:
       """
       Feature: Test
@@ -33,6 +33,46 @@ Feature: Same Tag For All Scenarios
 
       """
 
+  Scenario: Tags used multiple times for example
+    Given a file named "lint.feature" with:
+      """
+      Feature: Test
+        Scenario Outline: A
+          When test
+
+          @A
+          Examples: First
+            | field |
+            | value |
+
+          @A
+          Examples: Second
+            | field |
+            | value |
+      """
+    When I run `ruby lint.rb`
+    Then it should fail with exactly:
+      """
+      SameTagForAllScenarios - Tag '@A' should be used at Scenario Outline level
+        lint.feature (2): Test.A
+
+      """
+
+  Scenario: @skip is an exception
+    Given a file named "lint.feature" with:
+      """
+      Feature: Test
+        @skip
+        Scenario: A
+        @skip
+        Scenario: B
+      """
+    When I run `ruby lint.rb`
+    Then it should pass with exactly:
+      """
+
+      """
+
   Scenario: Valid Example with different Tags
     Given a file named "lint.feature" with:
       """

data/gherkin_lint.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'gherkin_lint'
-  s.version     = '0.1.2'
-  s.date        = '2016-04-17'
+  s.version     = '0.3.0'
+  s.date        = '2016-05-01'
   s.summary     = 'Gherkin Lint'
   s.description = 'Lint Gherkin Files'
   s.authors     = ['Stefan Rohe']
@@ -11,5 +11,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'gherkin', ['= 2.12.2']
   s.add_runtime_dependency 'term-ansicolor', ['>= 1.3.2']
   s.add_runtime_dependency 'amatch', ['>= 0.3.0']
+  s.add_runtime_dependency 'engtagger', ['>=0.2.0']
   s.add_development_dependency 'aruba', ['>= 0.6.2']
 end

data/lib/gherkin_lint.rb

@@ -8,6 +8,7 @@ require 'gherkin_lint/linter/avoid_scripting'
 require 'gherkin_lint/linter/background_does_more_than_setup'
 require 'gherkin_lint/linter/background_requires_multiple_scenarios'
 require 'gherkin_lint/linter/bad_scenario_name'
+require 'gherkin_lint/linter/be_declarative'
 require 'gherkin_lint/linter/file_name_differs_feature_name'
 require 'gherkin_lint/linter/invalid_file_name'
 require 'gherkin_lint/linter/invalid_step_flow'
@@ -36,12 +37,13 @@ module GherkinLint
   # gherkin linter
   class GherkinLint
     LINTER = [
+      AvoidOutlineForSingleExample,
       AvoidPeriod,
       AvoidScripting,
-      AvoidOutlineForSingleExample,
       BackgroundDoesMoreThanSetup,
       BackgroundRequiresMultipleScenarios,
       BadScenarioName,
+      BeDeclarative,
       FileNameDiffersFeatureName,
       MissingExampleName,
       MissingFeatureDescription,
@@ -106,14 +108,18 @@ module GherkinLint
 
     def report
       issues = @linter.map do |linter|
-        tags_to_suppress = LINTER.map { |lint| "disable#{lint.new.class.name.split('::').last}" }
-        linter.lint_files(@files, tags_to_suppress)
+        linter.lint_files(@files, disable_tags)
         linter.issues
       end.flatten
 
       issues.each { |issue| puts issue.render }
 
-      issues.empty? ? 0 : -1
+      return 0 if issues.select { |issue| issue.class == Error }.empty?
+      -1
+    end
+
+    def disable_tags
+      LINTER.map { |lint| "disable#{lint.new.class.name.split('::').last}" }
     end
 
     def to_json(input, file = 'generated.feature')

data/lib/gherkin_lint/issue.rb

@@ -11,7 +11,10 @@ module GherkinLint
       @references = references
       @description = description
     end
+  end
 
+  # entity value class for errors
+  class Error < Issue
     def render
       result = red(@name)
       result += " - #{@description}" unless @description.nil?
@@ -19,4 +22,14 @@ module GherkinLint
       result
     end
   end
+
+  # entity value class for warnings
+  class Warning < Issue
+    def render
+      result = "#{yellow(@name)} (Warning)"
+      result += " - #{@description}" unless @description.nil?
+      result += "\n  " + green(@references.uniq * "\n  ")
+      result
+    end
+  end
 end

data/lib/gherkin_lint/linter.rb

@@ -73,12 +73,6 @@ module GherkinLint
       lint
     end
 
-    def tag?(data, tag)
-      return false if data.class != Hash
-      return false unless data.key? 'tags'
-      data['tags'].map { |item| item['name'] }.include? "@#{tag}"
-    end
-
     def filter_tag(data, tag)
       return data.select { |item| !tag?(item, tag) }.map { |item| filter_tag(item, tag) } if data.class == Array
       return data unless data.class == Hash
@@ -88,8 +82,10 @@ module GherkinLint
       result
     end
 
-    def suppress(data, tags)
-      data.select { |item| !tags.map { |tag| "@#{tag}" }.include? item['name'] }
+    def tag?(data, tag)
+      return false if data.class != Hash
+      return false unless data.key? 'tags'
+      data['tags'].map { |item| item['name'] }.include? "@#{tag}"
     end
 
     def suppress_tags(data, tags)
@@ -105,8 +101,12 @@ module GherkinLint
       result
     end
 
+    def suppress(data, tags)
+      data.select { |item| !tags.map { |tag| "@#{tag}" }.include? item['name'] }
+    end
+
     def lint
-      raise 'not implemented'
+      fail 'not implemented'
     end
 
     def reference(file, feature = nil, scenario = nil, step = nil)
@@ -124,8 +124,12 @@ module GherkinLint
       line
     end
 
-    def add_issue(references, description = nil)
-      @issues.push Issue.new(name, references, description)
+    def add_error(references, description = nil)
+      @issues.push Error.new(name, references, description)
+    end
+
+    def add_warning(references, description = nil)
+      @issues.push Warning.new(name, references, description)
     end
 
     def gather_tags(element)

data/lib/gherkin_lint/linter/avoid_outline_for_single_example.rb

@@ -12,7 +12,7 @@ module GherkinLint
         next if scenario['examples'].first['rows'].length > 2
 
         references = [reference(file, feature, scenario)]
-        add_issue(references, 'Better write a scenario')
+        add_error(references, 'Better write a scenario')
       end
     end
   end

data/lib/gherkin_lint/linter/avoid_period.rb

@@ -9,7 +9,7 @@ module GherkinLint
 
         scenario['steps'].each do |step|
           references = [reference(file, feature, scenario, step)]
-          add_issue(references) if step['name'].strip.end_with? '.'
+          add_error(references) if step['name'].strip.end_with? '.'
         end
       end
     end

data/lib/gherkin_lint/linter/avoid_scripting.rb

@@ -9,7 +9,7 @@ module GherkinLint
 
         next if steps.length <= 1
         references = [reference(file, feature, scenario)]
-        add_issue(references, 'Multiple Actions')
+        add_error(references, 'Multiple Actions')
       end
     end
 

data/lib/gherkin_lint/linter/background_does_more_than_setup.rb

@@ -9,7 +9,7 @@ module GherkinLint
         invalid_steps = background['steps'].select { |step| step['keyword'] == 'When ' || step['keyword'] == 'Then ' }
         next if invalid_steps.empty?
         references = [reference(file, feature, background, invalid_steps[0])]
-        add_issue(references, 'Just Given Steps allowed')
+        add_error(references, 'Just Given Steps allowed')
       end
     end
   end

data/lib/gherkin_lint/linter/background_requires_multiple_scenarios.rb

@@ -9,7 +9,7 @@ module GherkinLint
         next if scenarios.length >= 2
 
         references = [reference(file, feature, background)]
-        add_issue(references, "There are just #{scenarios.length} scenarios")
+        add_error(references, "There are just #{scenarios.length} scenarios")
       end
     end
   end

data/lib/gherkin_lint/linter/bad_scenario_name.rb

@@ -10,7 +10,7 @@ module GherkinLint
         description = 'Prefer to rely just on Given and When steps when name your scenario to keep it stable'
         bad_words = %w(test verif check)
         bad_words.each do |bad_word|
-          add_issue(references, description) if scenario['name'].downcase.include? bad_word
+          add_error(references, description) if scenario['name'].downcase.include? bad_word
         end
       end
     end

data/lib/gherkin_lint/linter/be_declarative.rb

@@ -0,0 +1,45 @@
+require 'gherkin_lint/linter'
+require 'engtagger'
+
+module GherkinLint
+  # service class to lint for avoiding periods
+  class BeDeclarative < Linter
+    def initialize
+      super
+    end
+
+    def lint
+      filled_scenarios do |file, feature, scenario|
+        scenario['steps'].each do |step|
+          references = [reference(file, feature, scenario, step)]
+          add_warning(references, 'no verb') unless verb? step
+        end
+      end
+    end
+
+    def verb?(step)
+      tagged = tagger.add_tags step['name']
+      step_verbs = verbs tagged
+
+      !step_verbs.empty?
+    end
+
+    def verbs(tagged_text)
+      verbs = [
+        :get_infinitive_verbs,
+        :get_past_tense_verbs,
+        :get_gerund_verbs,
+        :get_passive_verbs,
+        :get_present_verbs,
+        :get_base_present_verbs
+      ]
+      verbs.map { |verb| tagger.send(verb, tagged_text).keys }.flatten
+    end
+
+    def tagger
+      @tagger = EngTagger.new unless instance_variable_defined? :@tagger
+
+      @tagger
+    end
+  end
+end

data/lib/gherkin_lint/linter/file_name_differs_feature_name.rb

@@ -9,7 +9,7 @@ module GherkinLint
         expected_feature_name = title_case file
         next if feature['name'].casecmp(expected_feature_name) == 0
         references = [reference(file, feature)]
-        add_issue(references, "Feature name should be '#{expected_feature_name}'")
+        add_error(references, "Feature name should be '#{expected_feature_name}'")
       end
     end