goodcheck 2.6.0 → 3.0.2

data/lib/goodcheck.rb

@@ -4,9 +4,7 @@ require "set"
 require "strong_json"
 require "yaml"
 require "json"
-require "active_support/core_ext/hash/indifferent_access"
-require "active_support/core_ext/integer/inflections"
-require "active_support/tagged_logging"
+require "logger"
 require "rainbow"
 require "digest/sha2"
 require "net/http"
@@ -35,3 +33,8 @@ require "goodcheck/commands/init"
 require "goodcheck/commands/test"
 require "goodcheck/import_loader"
 require "goodcheck/commands/pattern"
+require "goodcheck/unarchiver"
+
+module Goodcheck
+  DEFAULT_CONFIG_FILE = "goodcheck.yml".freeze
+end

data/lib/goodcheck/analyzer.rb

@@ -13,7 +13,7 @@ module Goodcheck
     def scan(&block)
       if block_given?
         if trigger.patterns.empty?
-          yield Issue.new(buffer: buffer, range: nil, rule: rule, text: nil)
+          yield Issue.new(buffer: buffer, rule: rule)
         else
           var_pats, novar_pats = trigger.patterns.partition {|pat|
             pat.is_a?(Pattern::Token) && !pat.variables.empty?
@@ -44,9 +44,7 @@ module Goodcheck
         while true
           case
           when scanner.scan_until(regexp)
-            text = scanner.matched
-            range = (scanner.pos - text.bytesize) .. scanner.pos
-            issues << Issue.new(buffer: buffer, range: range, rule: rule, text: text)
+            issues << new_issue_with_matched(scanner)
           else
             break
           end
@@ -55,7 +53,7 @@ module Goodcheck
         issues.each(&block)
       else
         unless regexp =~ buffer.content
-          yield Issue.new(buffer: buffer, range: nil, rule: rule, text: nil)
+          yield Issue.new(buffer: buffer, rule: rule)
         end
       end
     end
@@ -68,9 +66,7 @@ module Goodcheck
           case
           when scanner.scan_until(pat.regexp)
             if pat.test_variables(scanner)
-              text = scanner.matched
-              range = (scanner.pos - text.bytesize) .. scanner.pos
-              yield Issue.new(buffer: buffer, range: range, rule: rule, text: text)
+              yield new_issue_with_matched(scanner)
             end
           else
             break
@@ -84,11 +80,19 @@ module Goodcheck
               break
             end
           else
-            yield Issue.new(buffer: buffer, range: nil, rule: rule, text: nil)
+            yield Issue.new(buffer: buffer, rule: rule)
             break
           end
         end
       end
     end
+
+    private
+
+    def new_issue_with_matched(scanner)
+      Issue.new(buffer: buffer, rule: rule,
+                text: scanner.matched,
+                text_begin_pos: scanner.pos - scanner.matched_size)
+    end
   end
 end

data/lib/goodcheck/buffer.rb

@@ -1,8 +1,5 @@
 module Goodcheck
   class Buffer
-    attr_reader :path
-    attr_reader :content
-
     DISABLE_LINE_PATTERNS = [
       /\/\/ goodcheck-disable-line$/, #JS, Java, C, ...
       /# goodcheck-disable-line$/, # Ruby, Python, PHP, ...
@@ -25,10 +22,8 @@ module Goodcheck
       /' goodcheck-disable-next-line$/, # VB
     ].freeze
 
-    class << self
-        attr_accessor :DISABLE_LINE_PATTERNS
-        attr_accessor :DISABLE_NEXT_LINE_PATTERNS
-    end
+    attr_reader :path
+    attr_reader :content
 
     def initialize(path:, content:)
       @path = path
@@ -43,7 +38,7 @@ module Goodcheck
         start_position = 0
 
         content.split(/\n/, -1).each do |line|
-          range = start_position...(start_position + line.bytesize)
+          range = start_position..(start_position + line.bytesize)
           @line_ranges << range
           start_position = range.end + 1
         end
@@ -51,10 +46,10 @@ module Goodcheck
 
       @line_ranges
     end
-    
+
     def line_disabled?(line_number)
       if line_number > 1
-        return true if DISABLE_NEXT_LINE_PATTERNS.any? { |pattern| line(line_number - 1).match?(pattern) } 
+        return true if DISABLE_NEXT_LINE_PATTERNS.any? { |pattern| line(line_number - 1).match?(pattern) }
       end
 
       if line_number <= lines.length
@@ -70,7 +65,9 @@ module Goodcheck
       end
 
       if line_index
-        [line_index + 1, position - line_ranges[line_index].begin]
+        line_number = line_index + 1
+        column_number = position - line_ranges[line_index].begin + 1
+        [line_number, column_number]
       end
     end
 
@@ -79,16 +76,7 @@ module Goodcheck
     end
 
     def line(line_number)
-      lines[line_number-1]
-    end
-
-    def position_for_location(line, column)
-      if (range = line_ranges[line-1])
-        pos = range.begin + column
-        if pos <= range.end
-          pos
-        end
-      end
+      lines[line_number - 1]
     end
   end
 end

data/lib/goodcheck/cli.rb

@@ -21,8 +21,6 @@ module Goodcheck
       help: "Show help and quit"
     }.freeze
 
-    DEFAULT_CONFIG_FILE = Pathname("goodcheck.yml").freeze
-
     def run(args)
       command = args.shift&.to_sym
 
@@ -58,12 +56,12 @@ module Goodcheck
     end
 
     def check(args)
-      config_path = DEFAULT_CONFIG_FILE
+      config_path = Pathname(DEFAULT_CONFIG_FILE)
       targets = []
       rules = []
       formats = [:text, :json]
       format = :text
-      loglevel = Logger::ERROR
+      loglevel = nil
       force_download = false
 
       OptionParser.new("Usage: goodcheck check [options] paths...") do |opts|
@@ -82,7 +80,7 @@ module Goodcheck
         end
       end.parse!(args)
 
-      Goodcheck.logger.level = loglevel
+      Goodcheck.logger.level = loglevel if loglevel
 
       if args.empty?
         targets << Pathname(".")
@@ -110,7 +108,7 @@ module Goodcheck
     end
 
     def test(args)
-      config_path = DEFAULT_CONFIG_FILE
+      config_path = Pathname(DEFAULT_CONFIG_FILE)
       loglevel = ::Logger::ERROR
       force_download = false
 
@@ -132,7 +130,7 @@ module Goodcheck
     end
 
     def init(args)
-      config_path = DEFAULT_CONFIG_FILE
+      config_path = Pathname(DEFAULT_CONFIG_FILE)
       force = false
 
       OptionParser.new("Usage: goodcheck init [options]") do |opts|
@@ -163,7 +161,7 @@ module Goodcheck
     end
 
     def pattern(args)
-      config_path = DEFAULT_CONFIG_FILE
+      config_path = Pathname(DEFAULT_CONFIG_FILE)
 
       OptionParser.new do |opts|
         opts.banner = "Usage: goodcheck pattern [options] ids..."

data/lib/goodcheck/commands/check.rb

@@ -15,8 +15,6 @@ module Goodcheck
       include HomePath
       include ExitStatus
 
-      EXIT_MATCH = 2
-
       def initialize(config_path:, rules:, targets:, reporter:, stderr:, home_path:, force_download:)
         @config_path = config_path
         @rules = rules
@@ -57,6 +55,8 @@ module Goodcheck
             end
           end
 
+          reporter.summary
+
           issue_reported ? EXIT_MATCH : EXIT_SUCCESS
         end
       end
@@ -71,31 +71,27 @@ module Goodcheck
       def each_check
         targets.each do |target|
           Goodcheck.logger.info "Checking target: #{target}"
-          Goodcheck.logger.tagged target.to_s do
-            each_file target, immediate: true do |path|
-              Goodcheck.logger.debug "Checking file: #{path}"
-              Goodcheck.logger.tagged path.to_s do
-                reporter.file(path) do
-                  buffers = {}
-
-                  config.rules_for_path(path, rules_filter: rules) do |rule, glob, trigger|
-                    Goodcheck.logger.debug "Checking rule: #{rule.id}"
-                    begin
-                      encoding = glob&.encoding || Encoding.default_external.name
-
-                      if buffers[encoding]
-                        buffer = buffers[encoding]
-                      else
-                        content = path.read(encoding: encoding).encode(Encoding.default_internal || Encoding::UTF_8)
-                        buffer = Buffer.new(path: path, content: content)
-                        buffers[encoding] = buffer
-                      end
-
-                      yield buffer, rule, trigger
-                    rescue ArgumentError => exn
-                      stderr.puts "#{path}: #{exn.inspect}"
-                    end
+          each_file target, immediate: true do |path|
+            Goodcheck.logger.debug "Checking file: #{path}"
+            reporter.file(path) do
+              buffers = {}
+
+              config.rules_for_path(path, rules_filter: rules) do |rule, glob, trigger|
+                Goodcheck.logger.debug "Checking rule: #{rule.id}"
+                begin
+                  encoding = glob&.encoding || Encoding.default_external.name
+
+                  if buffers[encoding]
+                    buffer = buffers[encoding]
+                  else
+                    content = path.read(encoding: encoding).encode(Encoding.default_internal || Encoding::UTF_8)
+                    buffer = Buffer.new(path: path, content: content)
+                    buffers[encoding] = buffer
                   end
+
+                  yield buffer, rule, trigger
+                rescue ArgumentError => exn
+                  stderr.puts "#{path}: #{exn.inspect}"
                 end
               end
             end
@@ -112,7 +108,7 @@ module Goodcheck
           when DEFAULT_EXCLUSIONS.include?(path.basename.to_s)
             # noop
           when immediate || !excluded?(path)
-            path.children.each do |child|
+            path.children.sort.each do |child|
               each_file(child, &block)
             end
           end
@@ -131,7 +127,7 @@ module Goodcheck
       end
 
       def excluded?(path)
-        config.exclude_paths.any? {|pattern| path.fnmatch?(pattern, File::FNM_PATHNAME | File::FNM_EXTGLOB) }
+        config.exclude_path?(path)
       end
     end
   end

data/lib/goodcheck/commands/config_loading.rb

@@ -1,10 +1,13 @@
 module Goodcheck
   module Commands
     module ConfigLoading
+      include ExitStatus
+
       class ConfigFileNotFound < Error
         attr_reader :path
 
         def initialize(path:)
+          super(path.to_s)
           @path = path
         end
       end
@@ -20,7 +23,7 @@ module Goodcheck
           end
 
         import_loader = ImportLoader.new(cache_path: cache_path, force_download: force_download, config_path: config_path)
-        content = JSON.parse(JSON.dump(YAML.load(config_content, filename: config_path.to_s)), symbolize_names: true)
+        content = JSON.parse(JSON.dump(YAML.safe_load(config_content, filename: config_path.to_s)), symbolize_names: true)
         loader = ConfigLoader.new(path: config_path, content: content, stderr: stderr, import_loader: import_loader)
         @config = loader.load
       end
@@ -30,20 +33,23 @@ module Goodcheck
           yield
         rescue ConfigFileNotFound => exn
           stderr.puts "Configuration file not found: #{exn.path}"
-          1
+          EXIT_ERROR
+        rescue ConfigLoader::InvalidPattern => exn
+          stderr.puts exn.message
+          EXIT_ERROR
         rescue Psych::Exception => exn
           stderr.puts "Unexpected error happens while loading YAML file: #{exn.inspect}"
           exn.backtrace.each do |trace_loc|
             stderr.puts "  #{trace_loc}"
           end
-          1
+          EXIT_ERROR
         rescue StrongJSON::Type::TypeError, StrongJSON::Type::UnexpectedAttributeError => exn
           stderr.puts "Invalid config: #{exn.message}"
           stderr.puts StrongJSON::ErrorReporter.new(path: exn.path).to_s
-          1
+          EXIT_ERROR
         rescue Errno::ENOENT => exn
           stderr.puts "#{exn}"
-          1
+          EXIT_ERROR
         end
       end
     end

data/lib/goodcheck/commands/test.rb

@@ -28,15 +28,15 @@ module Goodcheck
             return EXIT_SUCCESS
           end
 
-          validate_rule_uniqueness or return EXIT_ERROR
-          validate_rules or return EXIT_ERROR
+          validate_rule_uniqueness or return EXIT_TEST_FAILED
+          validate_rules or return EXIT_TEST_FAILED
 
           EXIT_SUCCESS
         end
       end
 
       def validate_rule_uniqueness
-        stdout.puts "Validating rule id uniqueness..."
+        stdout.puts "Validating rule ID uniqueness..."
 
         duplicated_ids = []
 
@@ -47,36 +47,35 @@ module Goodcheck
         end
 
         if duplicated_ids.empty?
-          stdout.puts "  OK!👍"
+          stdout.puts Rainbow("  OK! 👍").green
           true
         else
           count = duplicated_ids.size
-          stdout.puts(Rainbow("  Found #{count} #{'duplication'.pluralize(count)}.😞").red)
+          duplication = count == 1 ? 'duplication' : 'duplications'
+          stdout.puts "  Found #{Rainbow(count).bold} #{duplication}. 😱"
           duplicated_ids.each do |id|
-            stdout.puts "    #{id}"
+            stdout.puts "    - #{Rainbow(id).background(:red)}"
           end
           false
         end
       end
 
       def validate_rules
-        test_pass = true
         success_count = 0
-        failure_count = 0
         failed_rule_ids = Set[]
 
         config.rules.each do |rule|
-          if rule.triggers.any? {|trigger| !trigger.passes.empty? || !trigger.fails.empty?}
-            stdout.puts "Testing rule #{Rainbow(rule.id).cyan}..."
+          stdout.puts "Testing rule #{Rainbow(rule.id).cyan}..."
 
-            rule_ok = true
+          rule_ok = true
 
+          if rule.triggers.any? {|trigger| !trigger.passes.empty? || !trigger.fails.empty?}
             rule.triggers.each.with_index do |trigger, index|
               if !trigger.passes.empty? || !trigger.fails.empty?
                 if trigger.by_pattern?
                   stdout.puts "  Testing pattern..."
                 else
-                  stdout.puts "  Testing #{(index+1).ordinalize} trigger..."
+                  stdout.puts "  #{index + 1}. Testing trigger..."
                 end
 
                 pass_errors = trigger.passes.each.with_index.select do |pass, _|
@@ -88,21 +87,19 @@ module Goodcheck
                 end
 
                 unless pass_errors.empty?
-                  test_pass = false
                   rule_ok = false
 
                   pass_errors.each do |_, index|
-                    stdout.puts "    #{(index+1).ordinalize} #{Rainbow('pass').green} example matched.😱"
+                    stdout.puts "    #{index + 1}. #{Rainbow('pass').green} example matched. 😱"
                     failed_rule_ids << rule.id
                   end
                 end
 
                 unless fail_errors.empty?
-                  test_pass = false
                   rule_ok = false
 
                   fail_errors.each do |_, index|
-                    stdout.puts "    #{(index+1).ordinalize} #{Rainbow('fail').red} example didn't match.😱"
+                    stdout.puts "    #{index + 1}. #{Rainbow('fail').red} example didn’t match. 😱"
                     failed_rule_ids << rule.id
                   end
                 end
@@ -110,16 +107,27 @@ module Goodcheck
             end
 
             if rule.triggers.any?(&:skips_fail_examples?)
-              stdout.puts "  🚨 The rule contains a `pattern` with `glob`, which is not supported by the test command."
+              stdout.puts "    The rule contains a `pattern` with `glob`, which is not supported by the test command. 🚨"
               stdout.puts "    Skips testing `fail` examples."
             end
+          end
 
-            if rule_ok
-              stdout.puts "  OK!🎉"
-              success_count += 1
-            else
-              failure_count += 1
-            end
+          if rule.severity && !config.severity_allowed?(rule.severity)
+            allowed_severities = config.allowed_severities.map { |s| %("#{s}") }.join(', ')
+            stdout.puts Rainbow("  \"#{rule.severity}\" severity isn’t allowed. Must be one of #{allowed_severities}. 😱").red
+            rule_ok = false
+            failed_rule_ids << rule.id
+          end
+
+          if !rule.severity && config.severity_required?
+            stdout.puts Rainbow("  Severity is required. 😱").red
+            rule_ok = false
+            failed_rule_ids << rule.id
+          end
+
+          if rule_ok
+            stdout.puts Rainbow("  OK! 👍").green
+            success_count += 1
           end
         end
 
@@ -131,13 +139,12 @@ module Goodcheck
           end
         end
 
-        rule_count = success_count + failure_count
+        total = success_count + failed_rule_ids.size
         stdout.puts ""
-        stdout.puts ["Tested #{rule_count} #{'rule'.pluralize(rule_count)}",
-                     Rainbow("#{success_count} #{'success'.pluralize(success_count)}").green,
-                     Rainbow("#{failure_count} #{'failure'.pluralize(failure_count)}").red].join(", ")
+        stdout.puts "#{Rainbow(total).bold} #{total == 1 ? 'rule' : 'rules'} tested: " \
+                    "#{Rainbow(success_count.to_s + ' successful').green.bold}, #{Rainbow(failed_rule_ids.size.to_s + ' failed').red.bold}"
 
-        test_pass
+        failed_rule_ids.empty?
       end
 
       def rule_matches_example?(rule, trigger, example)