goodcheck 2.5.2 → 3.0.1

data/lib/goodcheck.rb

@@ -1,19 +1,19 @@
 require "strscan"
 require "pathname"
+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"
 
 require "goodcheck/version"
+require "goodcheck/error"
 require "goodcheck/logger"
 require "goodcheck/home_path"
-
+require "goodcheck/exit_status"
 require "goodcheck/glob"
 require "goodcheck/buffer"
 require "goodcheck/location"
@@ -33,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

@@ -1,9 +1,9 @@
 require "optparse"
 
-Version = Goodcheck::VERSION
-
 module Goodcheck
   class CLI
+    include ExitStatus
+
     attr_reader :stdout
     attr_reader :stderr
 
@@ -19,8 +19,7 @@ module Goodcheck
       pattern: "Print regexp for rules",
       version: "Print version",
       help: "Show help and quit"
-    }
-
+    }.freeze
 
     def run(args)
       command = args.shift&.to_sym
@@ -30,16 +29,22 @@ module Goodcheck
       elsif command == :"--version"
         version(args)
       else
-        stderr.puts "Invalid command: #{command}" if command
+        if command
+          stderr.puts "invalid command: #{command}"
+          stderr.puts ""
+        end
         help(args)
-        1
+        EXIT_ERROR
       end
+    rescue OptionParser::ParseError => exn
+      stderr.puts exn
+      EXIT_ERROR
     rescue => exn
       stderr.puts exn.inspect
       exn.backtrace.each do |bt|
         stderr.puts "  #{bt}"
       end
-      1
+      EXIT_ERROR
     end
 
     def home_path
@@ -51,35 +56,31 @@ module Goodcheck
     end
 
     def check(args)
-      config_path = Pathname("goodcheck.yml")
+      config_path = Pathname(DEFAULT_CONFIG_FILE)
       targets = []
       rules = []
-      format = nil
-      loglevel = Logger::ERROR
+      formats = [:text, :json]
+      format = :text
+      loglevel = nil
       force_download = false
 
-      OptionParser.new("Usage: goodcheck check [options] dirs...") do |opts|
-        opts.on("-c CONFIG", "--config=CONFIG") do |config|
-          config_path = Pathname(config)
-        end
-        opts.on("-R RULE", "--rule=RULE") do |rule|
+      OptionParser.new("Usage: goodcheck check [options] paths...") do |opts|
+        config_option(opts) { |config| config_path = config }
+        verbose_option(opts) { |level| loglevel = level }
+        debug_option(opts) { |level| loglevel = level }
+        force_download_option(opts) { force_download = true }
+        common_options(opts)
+
+        opts.on("-R RULE", "--rule=RULE", "Only rule(s) to check") do |rule|
           rules << rule
         end
-        opts.on("--format=<text|json> [default: 'text']") do |f|
+
+        opts.on("--format=<#{formats.join('|')}>", formats, "Output format [default: '#{format}']") do |f|
           format = f
         end
-        opts.on("-v", "--verbose") do
-          loglevel = Logger::INFO
-        end
-        opts.on("-d", "--debug") do
-          loglevel = Logger::DEBUG
-        end
-        opts.on("--force") do
-          force_download = true
-        end
       end.parse!(args)
 
-      Goodcheck.logger.level = loglevel
+      Goodcheck.logger.level = loglevel if loglevel
 
       if args.empty?
         targets << Pathname(".")
@@ -88,13 +89,12 @@ module Goodcheck
       end
 
       reporter = case format
-                 when "text", nil
+                 when :text
                    Reporters::Text.new(stdout: stdout)
-                 when "json"
+                 when :json
                    Reporters::JSON.new(stdout: stdout, stderr: stderr)
                  else
-                   stderr.puts "Unknown format: #{format}"
-                   return 1
+                   raise ArgumentError, format.inspect
                  end
 
       Goodcheck.logger.info "Configuration = #{config_path}"
@@ -108,23 +108,16 @@ module Goodcheck
     end
 
     def test(args)
-      config_path = Pathname("goodcheck.yml")
-      loglevel = Logger::ERROR
+      config_path = Pathname(DEFAULT_CONFIG_FILE)
+      loglevel = ::Logger::ERROR
       force_download = false
 
       OptionParser.new("Usage: goodcheck test [options]") do |opts|
-        opts.on("-c CONFIG", "--config=CONFIG") do |config|
-          config_path = Pathname(config)
-        end
-        opts.on("-v", "--verbose") do
-          loglevel = Logger::INFO
-        end
-        opts.on("-d", "--debug") do
-          loglevel = Logger::DEBUG
-        end
-        opts.on("--force") do
-          force_download = true
-        end
+        config_option(opts) { |config| config_path = config }
+        verbose_option(opts) { |level| loglevel = level }
+        debug_option(opts) { |level| loglevel = level }
+        force_download_option(opts) { force_download = true }
+        common_options(opts)
       end.parse!(args)
 
       Goodcheck.logger.level = loglevel
@@ -137,14 +130,14 @@ module Goodcheck
     end
 
     def init(args)
-      config_path = Pathname("goodcheck.yml")
+      config_path = Pathname(DEFAULT_CONFIG_FILE)
       force = false
 
       OptionParser.new("Usage: goodcheck init [options]") do |opts|
-        opts.on("-c CONFIG", "--config=CONFIG") do |config|
-          config_path = Pathname(config)
-        end
-        opts.on("--force") do
+        config_option(opts) { |config| config_path = config }
+        common_options(opts)
+
+        opts.on("--force", "Overwrite an existing file") do
           force = true
         end
       end.parse!(args)
@@ -152,9 +145,9 @@ module Goodcheck
       Commands::Init.new(stdout: stdout, stderr: stderr, path: config_path, force: force).run
     end
 
-    def version(args)
+    def version(_args = nil)
       stdout.puts "goodcheck #{VERSION}"
-      0
+      EXIT_SUCCESS
     end
 
     def help(args)
@@ -164,19 +157,48 @@ module Goodcheck
       COMMANDS.each do |c, msg|
         stdout.puts "  goodcheck #{c}\t#{msg}"
       end
-      0
+      EXIT_SUCCESS
     end
 
     def pattern(args)
-      config_path = Pathname("goodcheck.yml")
+      config_path = Pathname(DEFAULT_CONFIG_FILE)
 
-      OptionParser.new("Usage: goodcheck pattern [options] ids...") do |opts|
-        opts.on("-c CONFIG", "--config=CONFIG") do |config|
-          config_path = Pathname(config)
-        end
+      OptionParser.new do |opts|
+        opts.banner = "Usage: goodcheck pattern [options] ids..."
+        config_option(opts) { |config| config_path = config }
+        common_options(opts)
       end.parse!(args)
 
       Commands::Pattern.new(stdout: stdout, stderr: stderr, path: config_path, ids: Set.new(args), home_path: home_path).run
     end
+
+    def config_option(opts)
+      opts.on("-c CONFIG", "--config=CONFIG", "Configuration file path [default: '#{DEFAULT_CONFIG_FILE}']") do |config|
+        yield Pathname(config)
+      end
+    end
+
+    def verbose_option(opts)
+      opts.on("-v", "--verbose", "Set log level to verbose") { yield ::Logger::INFO }
+    end
+
+    def debug_option(opts)
+      opts.on("-d", "--debug", "Set log level to debug") { yield ::Logger::DEBUG }
+    end
+
+    def force_download_option(opts, &block)
+      opts.on("--force", "Download importing files always", &block)
+    end
+
+    def common_options(opts)
+      opts.on_tail("--version", COMMANDS.fetch(:version)) do
+        version
+        exit EXIT_SUCCESS
+      end
+      opts.on_tail("-h", "--help", COMMANDS.fetch(:help)) do
+        stdout.puts opts.help
+        exit EXIT_SUCCESS
+      end
+    end
   end
 end

data/lib/goodcheck/commands/check.rb

@@ -13,6 +13,7 @@ module Goodcheck
 
       include ConfigLoading
       include HomePath
+      include ExitStatus
 
       def initialize(config_path:, rules:, targets:, reporter:, stderr:, home_path:, force_download:)
         @config_path = config_path
@@ -30,6 +31,14 @@ module Goodcheck
 
           reporter.analysis do
             load_config!(force_download: force_download, cache_path: cache_dir_path)
+
+            unless missing_rules.empty?
+              missing_rules.each do |rule|
+                stderr.puts "missing rule: #{rule}"
+              end
+              return EXIT_ERROR
+            end
+
             each_check do |buffer, rule, trigger|
               reported_issues = Set[]
 
@@ -46,38 +55,43 @@ module Goodcheck
             end
           end
 
-          issue_reported ? 2 : 0
+          reporter.summary
+
+          issue_reported ? EXIT_MATCH : EXIT_SUCCESS
+        end
+      end
+
+      def missing_rules
+        @missing_rules ||= begin
+          config_rule_ids = config.rules.map(&:id)
+          rules.reject { |rule| config_rule_ids.include?(rule) }
         end
       end
 
       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
@@ -94,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
@@ -113,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