gherkin_lint 0.6.3 → 1.0.0

data/features/unique_scenario_names.feature

@@ -11,6 +11,7 @@ Feature: Unique Scenario Names
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(UniqueScenarioNames)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -42,5 +43,4 @@ Feature: Unique Scenario Names
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/unknown_variable.feature

@@ -11,6 +11,7 @@ Feature: Unknown Variable
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(UnknownVariable)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -115,5 +116,4 @@ Feature: Unknown Variable
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/unused_variable.feature

@@ -11,6 +11,7 @@ Feature: Unused Variable
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(UnusedVariable)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -98,5 +99,4 @@ Feature: Unused Variable
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/use_background.feature

@@ -11,6 +11,7 @@ Feature: Use Background
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(UseBackground)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -85,7 +86,6 @@ Feature: Use Background
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """
 
   Scenario: Valid Single Scenario
@@ -105,5 +105,4 @@ Feature: Use Background
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/features/use_outline.feature

@@ -11,6 +11,7 @@ Feature: Use Outline
 
       linter = GherkinLint::GherkinLint.new
       linter.enable %w(UseOutline)
+      linter.set_linter
       linter.analyze 'lint.feature'
       exit linter.report
 
@@ -54,7 +55,6 @@ Feature: Use Outline
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """
 
   Scenario: Valid Example
@@ -75,5 +75,4 @@ Feature: Use Outline
     When I run `ruby lint.rb`
     Then it should pass with exactly:
       """
-
       """

data/gherkin_lint.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name        = 'gherkin_lint'
-  s.version     = '0.6.3'
-  s.date        = '2017-03-12'
+  s.version     = '1.0.0'
+  s.date        = '2017-08-25'
   s.summary     = 'Gherkin Lint'
   s.description = 'Lint Gherkin Files'
-  s.authors     = ['Stefan Rohe']
+  s.authors     = ['Stefan Rohe', 'Nishtha Argawal', 'John Gluck']
   s.homepage    = 'http://github.com/funkwerk/gherkin_lint/'
   s.files       = `git ls-files`.split("\n")
   s.executables = s.files.grep(%r{^bin/}) { |file| File.basename(file) }

data/lib/gherkin_lint.rb

@@ -1,6 +1,7 @@
 gem 'gherkin', '>=4.0.0'
 
 require 'gherkin/parser'
+require 'gherkin_lint/linter'
 require 'gherkin_lint/linter/avoid_outline_for_single_example'
 require 'gherkin_lint/linter/avoid_period'
 require 'gherkin_lint/linter/avoid_scripting'
@@ -17,6 +18,7 @@ require 'gherkin_lint/linter/missing_feature_name'
 require 'gherkin_lint/linter/missing_scenario_name'
 require 'gherkin_lint/linter/missing_test_action'
 require 'gherkin_lint/linter/missing_verification'
+require 'gherkin_lint/linter/required_tags_starts_with'
 require 'gherkin_lint/linter/same_tag_for_all_scenarios'
 require 'gherkin_lint/linter/tag_used_multiple_times'
 require 'gherkin_lint/linter/too_clumsy'
@@ -31,69 +33,61 @@ require 'gherkin_lint/linter/use_background'
 require 'gherkin_lint/linter/use_outline'
 require 'multi_json'
 require 'set'
-
+require 'gherkin_lint/configuration'
 module GherkinLint
   # gherkin linter
   class GherkinLint
-    LINTER = [
-      AvoidOutlineForSingleExample,
-      AvoidPeriod,
-      AvoidScripting,
-      BackgroundDoesMoreThanSetup,
-      BackgroundRequiresMultipleScenarios,
-      BadScenarioName,
-      BeDeclarative,
-      FileNameDiffersFeatureName,
-      MissingExampleName,
-      MissingFeatureDescription,
-      MissingFeatureName,
-      MissingScenarioName,
-      MissingTestAction,
-      MissingVerification,
-      InvalidFileName,
-      InvalidStepFlow,
-      SameTagForAllScenarios,
-      TagUsedMultipleTimes,
-      TooClumsy,
-      TooManyDifferentTags,
-      TooManySteps,
-      TooManyTags,
-      TooLongStep,
-      UniqueScenarioNames,
-      UnknownVariable,
-      UnusedVariable,
-      UseBackground,
-      UseOutline
-    ].freeze
-
-    def initialize
+    attr_accessor :verbose
+    default_file = File.expand_path('../../', __FILE__), '**/config', 'default.yml'
+    DEFAULT_CONFIG = Dir.glob(File.join(default_file)).first.freeze
+    LINTER = Linter.descendants
+
+    def initialize(path = nil)
       @files = {}
       @linter = []
-      enable_all
+      @config = Configuration.new path || DEFAULT_CONFIG
+      @verbose = false
     end
 
-    def enable_all
-      disable []
+    def enabled(linter_name, value)
+      @config.config[linter_name]['Enabled'] = value if @config.config.key? linter_name
     end
 
-    def enable(enabled_linter)
-      set_linter(enabled_linter)
+    def enable(enabled_linters)
+      enabled_linters.each do |linter|
+        enabled linter, true
+      end
     end
 
-    def disable(disabled_linter)
-      set_linter(LINTER.map { |linter| linter.new.name.split('::').last }, disabled_linter)
+    def disable(disabled_linters)
+      disabled_linters.each do |linter|
+        enabled linter, false
+      end
+    end
+
+    # Testing feature
+    def disable_all
+      @config.config.each do |member|
+        @config.config[member[0]]['Enabled'] = false
+      end
     end
 
-    def set_linter(enabled_linter, disabled_linter = [])
+    def set_linter
       @linter = []
-      enabled_linter = Set.new enabled_linter
-      disabled_linter = Set.new disabled_linter
       LINTER.each do |linter|
         new_linter = linter.new
-        name = new_linter.class.name.split('::').last
-        next unless enabled_linter.include? name
-        next if disabled_linter.include? name
-        @linter.push new_linter
+        linter_enabled = @config.config[new_linter.class.name.split('::').last]['Enabled']
+        evaluate_members(new_linter) if linter_enabled
+        @linter.push new_linter if linter_enabled
+      end
+    end
+
+    def evaluate_members(linter)
+      @config.config[linter.class.name.split('::').last].each do |member, value|
+        next if member.downcase.casecmp('enabled').zero?
+        member = member.downcase.to_sym
+        raise 'Member not found! Check the YAML' unless linter.respond_to? member
+        linter.public_send(member, value)
       end
     end
 
@@ -111,8 +105,7 @@ module GherkinLint
         linter.issues
       end.flatten
 
-      issues.each { |issue| puts issue.render }
-
+      print issues
       return 0 if issues.select { |issue| issue.class == Error }.empty?
       -1
     end
@@ -129,8 +122,8 @@ module GherkinLint
     end
 
     def print(issues)
-      puts "There are #{issues.length} Issues" unless issues.empty?
-      issues.each { |issue| puts issue }
+      puts 'There are no issues' if issues.empty? && @verbose
+      issues.each { |issue| puts issue.render }
     end
   end
 end

data/lib/gherkin_lint/configuration.rb

@@ -0,0 +1,32 @@
+require 'yaml'
+module GherkinLint
+  # gherkin_lint configuration object
+  class Configuration
+    attr_reader :config
+
+    def initialize(path)
+      @path = path
+      @config = load_configuration || ''
+      load_user_configuration
+    end
+
+    def configuration_path
+      @path
+    end
+
+    def load_configuration
+      YAML.load_file configuration_path || '' if File.exist? configuration_path
+    end
+
+    def load_user_configuration
+      config_file = Dir.glob(File.join(Dir.pwd, '**', '.gherkin_lint.yml')).first
+      merge_config(config_file) if !config_file.nil? && File.exist?(config_file)
+    end
+
+    private
+
+    def merge_config(config_file)
+      @config.merge!(YAML.load_file(config_file)) { |_k, old, new| old.merge!(new) } unless @config.empty?
+    end
+  end
+end

data/lib/gherkin_lint/issue.rb

@@ -1,9 +1,9 @@
 require 'term/ansicolor'
-include Term::ANSIColor
 
 module GherkinLint
   # entity value class for issues
   class Issue
+    include Term::ANSIColor
     attr_reader :name, :references, :description
 
     def initialize(name, references, description = nil)

data/lib/gherkin_lint/linter.rb

@@ -6,6 +6,10 @@ module GherkinLint
   class Linter
     attr_reader :issues
 
+    def self.descendants
+      ObjectSpace.each_object(::Class).select { |klass| klass < self }
+    end
+
     def initialize
       @issues = []
       @files = {}
@@ -55,7 +59,6 @@ module GherkinLint
     def elements
       @files.each do |file, content|
         feature = content[:feature]
-
         next if feature.nil?
         next unless feature.key? :children
         feature[:children].each do |scenario|
@@ -76,11 +79,10 @@ module GherkinLint
     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.reject { |item| tag?(item, tag) }.map { |item| filter_tag(item, tag) } if data.class == Array
       return {} if (data.class == Hash) && (data.include? :feature) && tag?(data[:feature], tag)
       return data unless data.respond_to? :each_pair
       result = {}
-
       data.each_pair { |key, value| result[key] = filter_tag(value, tag) }
       result
     end
@@ -98,14 +100,13 @@ module GherkinLint
 
       data.each_pair do |key, value|
         value = suppress(value, tags) if key == :tags
-
         result[key] = suppress_tags(value, tags)
       end
       result
     end
 
     def suppress(data, tags)
-      data.select { |item| !tags.map { |tag| "@#{tag}" }.include? item[:name] }
+      data.reject { |item| tags.map { |tag| "@#{tag}" }.include? item[:name] }
     end
 
     def lint
@@ -135,11 +136,6 @@ module GherkinLint
       @issues.push Warning.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[:text]}"
       value += render_step_argument step[:argument] if step.include? :argument

data/lib/gherkin_lint/linter/avoid_scripting.rb

@@ -16,7 +16,7 @@ module GherkinLint
     def filter_when_steps(steps)
       steps = steps.drop_while { |step| step[:keyword] != 'When ' }
       steps = steps.reverse.drop_while { |step| step[:keyword] != 'Then ' }.reverse
-      steps.select { |step| step[:keyword] != 'Then ' }
+      steps.reject { |step| step[:keyword] == 'Then ' }
     end
   end
 end

data/lib/gherkin_lint/linter/background_requires_multiple_scenarios.rb

@@ -5,7 +5,7 @@ module GherkinLint
   class BackgroundRequiresMultipleScenarios < Linter
     def lint
       backgrounds do |file, feature, background|
-        scenarios = feature[:children].select { |element| element[:type] != :Background }
+        scenarios = feature[:children].reject { |element| element[:type] == :Background }
         next if scenarios.length >= 2
 
         references = [reference(file, feature, background)]

data/lib/gherkin_lint/linter/bad_scenario_name.rb

@@ -8,7 +8,7 @@ module GherkinLint
         next if scenario[:name].empty?
         references = [reference(file, feature, scenario)]
         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 = %w[test verif check]
         bad_words.each do |bad_word|
           add_error(references, description) if scenario[:name].downcase.include? bad_word
         end

data/lib/gherkin_lint/linter/be_declarative.rb

@@ -25,14 +25,16 @@ module GherkinLint
     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 =
+        %i[
+          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
 

data/lib/gherkin_lint/linter/required_tags_starts_with.rb

@@ -0,0 +1,16 @@
+require 'gherkin_lint/linter/tag_constraint'
+require 'gherkin_lint/linter'
+
+module GherkinLint
+  # service class to lint for tags used multiple times
+  class RequiredTagsStartsWith < Linter
+    include TagConstraint
+
+    def match_pattern?(target)
+      target.each do |t|
+        return true if t.delete!('@').start_with?(*@pattern)
+      end
+      false
+    end
+  end
+end

data/lib/gherkin_lint/linter/tag_collector.rb

@@ -0,0 +1,9 @@
+module GherkinLint
+  # Mixin to lint for tags based on their relationship to eachother
+  module TagCollector
+    def gather_tags(element)
+      return [] unless element.include? :tags
+      element[:tags].map { |tag| tag[:name][1..-1] }
+    end
+  end
+end

data/lib/gherkin_lint/linter/tag_constraint.rb

@@ -0,0 +1,32 @@
+module GherkinLint
+  # Mixin to lint for tags that have certain string contraints
+  module TagConstraint
+    def lint
+      scenarios do |file, feature, scenario|
+        next if match_pattern? tags(feature)
+        next if match_pattern? tags(scenario)
+        references = [reference(file, feature, scenario)]
+        add_error(references, 'Required Tag not found')
+      end
+    end
+
+    def tags(element)
+      return [] unless element.include? :tags
+      element[:tags].map { |a| a[:name] }
+    end
+
+    def matcher(pattern)
+      @pattern = pattern
+      validate_input
+    end
+
+    def match_pattern?(_tags)
+      raise NoMethodError, 'This is an abstraction that must be implemented by the includer'
+    end
+
+    def validate_input
+      raise 'No Tags provided in the YAML' if @pattern.nil?
+      warn 'Required Tags matcher has no value' if @pattern.empty?
+    end
+  end
+end