chutney.rb in chutney-2.0.0.rc1

- old
+ new

@@ -1,15 +1,16 @@
-require 'gherkin/parser'
+require 'amatch'
+require 'chutney/configuration'
 require 'chutney/linter'
+require 'chutney/linter/avoid_full_stop'
 require 'chutney/linter/avoid_outline_for_single_example'
-require 'chutney/linter/avoid_period'
 require 'chutney/linter/avoid_scripting'
 require 'chutney/linter/background_does_more_than_setup'
 require 'chutney/linter/background_requires_multiple_scenarios'
 require 'chutney/linter/bad_scenario_name'
-require 'chutney/linter/be_declarative'
 require 'chutney/linter/file_name_differs_feature_name'
+require 'chutney/linter/givens_after_background'
 require 'chutney/linter/invalid_file_name'
 require 'chutney/linter/invalid_step_flow'
 require 'chutney/linter/missing_example_name'
 require 'chutney/linter/missing_feature_description'
 require 'chutney/linter/missing_feature_name'
@@ -28,105 +29,80 @@
 require 'chutney/linter/unique_scenario_names'
 require 'chutney/linter/unknown_variable'
 require 'chutney/linter/unused_variable'
 require 'chutney/linter/use_background'
 require 'chutney/linter/use_outline'
-require 'multi_json'
+require 'forwardable'
+require 'gherkin/dialect'
+require 'gherkin/parser'
+require 'i18n'
 require 'set'
-require 'chutney/configuration'
+require 'yaml'
 
 module Chutney
   # gherkin linter
   class ChutneyLint
+    extend Forwardable
     attr_accessor :verbose
-    default_file = File.expand_path('..', __dir__), '**/config', 'default.yml'
-    DEFAULT_CONFIG = Dir.glob(File.join(default_file)).first.freeze
-    LINTER = Linter.descendants
+    attr_reader :files
+    attr_reader :results
+    
+    def_delegators :@files, :<<, :clear, :delete, :include?
 
-    def initialize(path = nil)
-      @files = {}
-      @linter = []
-      @config = Configuration.new path || DEFAULT_CONFIG
-      @verbose = false
-    end
+    def initialize(*files)
+      @files = files
+      @results = Hash.new { |h, k| h[k] = [] }
+      i18n_paths = Dir[File.expand_path(File.join(__dir__, 'config/locales')) + '/*.yml']
+      return if I18n.load_path.include?(i18n_paths)
 
-    def enabled(linter_name, value)
-      @config.config[linter_name]['Enabled'] = value if @config.config.key? linter_name
+      I18n.load_path << i18n_paths
     end
-
-    def enable(enabled_linters)
-      enabled_linters.each do |linter|
-        enabled linter, true
+    
+    def configuration
+      unless @config
+        default_file = [File.expand_path('..', __dir__), '**/config', 'chutney.yml']
+        config_file = Dir.glob(File.join(default_file)).first.freeze
+        @config = Configuration.new(config_file)
       end
+      @config
     end
-
-    def disable(disabled_linters)
-      disabled_linters.each do |linter|
-        enabled linter, false
-      end
+    
+    def configuration=(config)
+      @config = config
     end
-
-    # Testing feature
-    def disable_all
-      @config.config.each do |member|
-        @config.config[member[0]]['Enabled'] = false
+    
+    def analyse
+      files.each do |f|
+        lint(f)
       end
+      @results
     end
-
-    def set_linter
-      @linter = []
-      LINTER.each do |linter|
-        new_linter = linter.new
-        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
+    # alias for non-british English
+    # https://dictionary.cambridge.org/dictionary/english/analyse
+    alias analyze analyse
+    
+    def linters
+      @linters ||= Linter.descendants.filter { |l| configuration.dig(l.linter_name, 'Enabled') }
     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
+    
+    def linters=(*linters)
+      @linters = linters
     end
-
-    def analyze(file)
-      @files[file] = parse file
+    
+    private
+    
+    def parse(text)
+      @parser ||= Gherkin::Parser.new
+      scanner = Gherkin::TokenScanner.new(text)
+      @parser.parse(scanner)
     end
-
-    def parse(file)
-      to_json File.read(file)
-    end
-
-    def report
-      issues = @linter.map do |linter|
-        linter.lint_files(@files, disable_tags)
-        linter.issues
-      end.flatten
-
-      print issues
-      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)
-      parser = Gherkin::Parser.new
-      scanner = Gherkin::TokenScanner.new input
-
-      parser.parse(scanner)
-    end
-
-    def print(issues)
-      puts 'There are no issues' if issues.empty? && @verbose
-      issues.each { |issue| puts issue.render }
+    
+    def lint(file)
+      parsed = parse(File.read(file))
+      linters.each do |linter_class|
+        linter = linter_class.new(file, parsed, configuration[linter_class.linter_name])
+        linter.lint
+        @results[file] << { linter: linter.linter_name, issues: linter.issues }
+      end
     end
   end
 end