goodcheck 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 883ed31ce90c345b08d6b9e12b89a13c802baa1f6836d986f440a2eac816ec41
-  data.tar.gz: 196cc57241e9fc0f1505122225d4f165930c9fed34cf30f58146f415c53eaeef
+  metadata.gz: 8c2de636a6040f67abd7f2a24da8cd3519d76490724c0897ec4da3e8594e9a88
+  data.tar.gz: 690af43e3de713f7185fe3d080d8d99b647423e389b941981d18c2a84e049169
 SHA512:
-  metadata.gz: 857d4fb3c2048887c3c4e2809c17357e22eb968ad895a125db39059b52e81ccb9f7fb956827e3c4d0f927c052b8deb1f277f4183c2d0542f09fb45b016f14aed
-  data.tar.gz: f306f2e95696190574f577b141bccefd641bc62171008cb0a47c8bd7fe9966dba0a9c92881f91c186dfafab49c3173519537017bf377579aecce686e275e1890
+  metadata.gz: 8e6d05a4a287d13d41fcb42af646d259aa50b1cb0c8b0c39d14aa09ce96fa97839331dbf192f1048737f56b5a253ef590187add746f82251c3acb8e45ceaaa7a
+  data.tar.gz: aeec81a86feffac3321ad616c10f5f319a37dd6efce177a446e0a316c35db1fdc8de405d5c2afd5a7e450a9faafb359578ea92a1283411bfc988f78722c35eb5

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## HEAD
 
+## 2.7.0 (2020-12-02)
+
+* Goodbye ActiveSupport [#155](https://github.com/sider/goodcheck/pull/155)
+* Fix zero column [#160](https://github.com/sider/goodcheck/pull/160)
+* Improve text reporter [#161](https://github.com/sider/goodcheck/pull/161)
+
 ## 2.6.1 (2020-11-19)
 
 * Add missing doc for importing glob feature [#151](https://github.com/sider/goodcheck/pull/151)

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"

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

@@ -43,7 +43,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 +51,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 +70,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 +81,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

@@ -63,7 +63,7 @@ module Goodcheck
       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 +82,7 @@ module Goodcheck
         end
       end.parse!(args)
 
-      Goodcheck.logger.level = loglevel
+      Goodcheck.logger.level = loglevel if loglevel
 
       if args.empty?
         targets << Pathname(".")

data/lib/goodcheck/commands/check.rb

@@ -57,6 +57,8 @@ module Goodcheck
             end
           end
 
+          reporter.summary
+
           issue_reported ? EXIT_MATCH : EXIT_SUCCESS
         end
       end
@@ -71,31 +73,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 +110,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

data/lib/goodcheck/commands/config_loading.rb

@@ -5,6 +5,7 @@ module Goodcheck
         attr_reader :path
 
         def initialize(path:)
+          super(path.to_s)
           @path = path
         end
       end
@@ -20,7 +21,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

data/lib/goodcheck/commands/test.rb

@@ -51,7 +51,8 @@ module Goodcheck
           true
         else
           count = duplicated_ids.size
-          stdout.puts(Rainbow("  Found #{count} #{'duplication'.pluralize(count)}.😞").red)
+          duplication = count == 1 ? 'duplication' : 'duplications'
+          stdout.puts(Rainbow("  Found #{count} #{duplication}.😞").red)
           duplicated_ids.each do |id|
             stdout.puts "    #{id}"
           end
@@ -76,7 +77,7 @@ module Goodcheck
                 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, _|
@@ -92,7 +93,7 @@ module Goodcheck
                   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
@@ -102,7 +103,7 @@ module Goodcheck
                   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
@@ -132,10 +133,11 @@ module Goodcheck
         end
 
         rule_count = success_count + failure_count
+        rule = rule_count == 1 ? "1 rule" : "#{rule_count} rules"
+        success = Rainbow(success_count == 1 ? "1 success" : "#{success_count} successes").green
+        failure = Rainbow(failure_count == 1 ? "1 failure" : "#{failure_count} failures").red
         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 "Tested #{rule}, #{success}, #{failure}"
 
         test_pass
       end

data/lib/goodcheck/config_loader.rb

@@ -214,21 +214,19 @@ module Goodcheck
 
     def load
       Goodcheck.logger.info "Loading configuration: #{path}"
-      Goodcheck.logger.tagged "#{path}" do
-        Schema.config.coerce(content)
+      Schema.config.coerce(content)
 
-        rules = []
+      rules = []
 
-        load_rules(rules, array(content[:rules]))
+      load_rules(rules, array(content[:rules]))
 
-        Array(content[:import]).each do |import|
-          load_import rules, import
-        end
+      Array(content[:import]).each do |import|
+        load_import rules, import
+      end
 
-        exclude_paths = Array(content[:exclude])
+      exclude_paths = Array(content[:exclude])
 
-        Config.new(rules: rules, exclude_paths: exclude_paths)
-      end
+      Config.new(rules: rules, exclude_paths: exclude_paths)
     end
 
     def load_rules(rules, array)
@@ -240,13 +238,11 @@ module Goodcheck
     def load_import(rules, import)
       Goodcheck.logger.info "Importing rules from #{import}"
 
-      Goodcheck.logger.tagged import do
-        import_loader.load(import) do |content|
-          json = JSON.parse(JSON.dump(YAML.load(content, filename: import)), symbolize_names: true)
+      import_loader.load(import) do |content|
+        json = JSON.parse(JSON.dump(YAML.load(content, filename: import)), symbolize_names: true)
 
-          Schema.rules.coerce json
-          load_rules(rules, json)
-        end
+        Schema.rules.coerce json
+        load_rules(rules, json)
       end
     end
 

data/lib/goodcheck/issue.rb

@@ -1,15 +1,15 @@
 module Goodcheck
   class Issue
     attr_reader :buffer
-    attr_reader :range
     attr_reader :rule
     attr_reader :text
+    attr_reader :range
 
-    def initialize(buffer:, range:, rule:, text:)
+    def initialize(buffer:, rule:, text: nil, text_begin_pos: nil)
       @buffer = buffer
-      @range = range
       @rule = rule
       @text = text
+      @range = text ? text_begin_pos..(text_begin_pos + text.bytesize - 1) : nil
       @location = nil
     end
 

data/lib/goodcheck/location.rb

@@ -1,4 +1,18 @@
 module Goodcheck
+  # In the example below, each attribute is:
+  #
+  # - start_line: 2
+  # - start_column: 3
+  # - end_line: 2
+  # - end_column: 9
+  #
+  # @example
+  #
+  #   1 |
+  #   2 | A matched text
+  #   3 |   ^~~~~~~
+  #         3456789
+  #
   class Location
     attr_reader :start_line
     attr_reader :start_column
@@ -12,6 +26,14 @@ module Goodcheck
       @end_column = end_column
     end
 
+    def one_line?
+      start_line == end_line
+    end
+
+    def column_size
+      end_column - start_column + 1
+    end
+
     def ==(other)
       other.is_a?(Location) &&
         other.start_line == start_line &&
@@ -19,5 +41,11 @@ module Goodcheck
         other.end_line == end_line &&
         other.end_column == end_column
     end
+
+    alias eql? ==
+
+    def hash
+      self.class.hash ^ start_line.hash ^ start_column.hash ^ end_line.hash ^ end_column.hash
+    end
   end
 end

data/lib/goodcheck/logger.rb

@@ -1,8 +1,8 @@
 module Goodcheck
   def self.logger
-    @logger ||= ActiveSupport::TaggedLogging.new(Logger.new(STDERR)).tap do |logger|
-      logger.push_tags VERSION
-      logger.level = Logger::ERROR
-    end
+    @logger ||= Logger.new(
+      STDERR, level: Logger::ERROR,
+      formatter: ->(severity, time, progname, msg) { "[#{severity}] #{msg}\n" }
+    )
   end
 end

data/lib/goodcheck/reporters/json.rb

@@ -44,6 +44,10 @@ module Goodcheck
       def issue(issue)
         issues << issue
       end
+
+      def summary
+        # noop
+      end
     end
   end
 end

data/lib/goodcheck/reporters/text.rb

@@ -5,6 +5,8 @@ module Goodcheck
 
       def initialize(stdout:)
         @stdout = stdout
+        @file_count = 0
+        @issue_count = 0
       end
 
       def analysis
@@ -12,6 +14,7 @@ module Goodcheck
       end
 
       def file(path)
+        @file_count += 1
         yield
       end
 
@@ -20,21 +23,49 @@ module Goodcheck
       end
 
       def issue(issue)
+        @issue_count += 1
+
+        message = issue.rule.message.lines.first.chomp
+
         if issue.location
-          line = issue.buffer.line(issue.location.start_line)
-          end_column = if issue.location.start_line == issue.location.end_line
-                         issue.location.end_column
-                       else
-                         line.bytesize
-                       end
-          colored_line = line.byteslice(0, issue.location.start_column) + Rainbow(line.byteslice(issue.location.start_column, end_column - issue.location.start_column)).red + line.byteslice(end_column, line.bytesize)
-          stdout.puts "#{issue.path}:#{issue.location.start_line}:#{colored_line.chomp}:\t#{issue.rule.message.lines.first.chomp}"
+          start_line = issue.location.start_line
+          start_column = issue.location.start_column
+          start_column_index = start_column - 1
+          line = issue.buffer.line(start_line)
+          column_size = if issue.location.one_line?
+                          issue.location.column_size
+                        else
+                          line.bytesize - start_column
+                        end
+          stdout.puts "#{Rainbow(issue.path).cyan}:#{start_line}:#{start_column}: #{message}"
+          stdout.puts line.chomp
+          stdout.puts (" " * start_column_index) + Rainbow("^" + "~" * (column_size - 1)).yellow
         else
-          line = issue.buffer.line(1)&.chomp
-          line = line ? Rainbow(line).red : '-'
-          stdout.puts "#{issue.path}:-:#{line}:\t#{issue.rule.message.lines.first.chomp}"
+          stdout.puts "#{Rainbow(issue.path).cyan}:-:-: #{message}"
         end
       end
+
+      def summary
+        files = case @file_count
+                when 0
+                  "no files"
+                when 1
+                  "1 file"
+                else
+                  "#{@file_count} files"
+                end
+        issues = case @issue_count
+                 when 0
+                   Rainbow("no issues").green
+                 when 1
+                   Rainbow("1 issue").red
+                 else
+                   Rainbow("#{@issue_count} issues").red
+                 end
+
+        stdout.puts ""
+        stdout.puts "#{files} inspected, #{issues} detected"
+      end
     end
   end
 end

data/lib/goodcheck/version.rb

@@ -1,3 +1,3 @@
 module Goodcheck
-  VERSION = "2.6.1".freeze
+  VERSION = "2.7.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goodcheck
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,64 +28,58 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :runtime
+        version: '0.18'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: strong_json
   requirement: !ruby/object:Gem::Requirement
@@ -110,16 +104,22 @@ dependencies:
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement