goodcheck 2.6.0 → 3.0.2

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,51 @@ 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
+          rule = Rainbow("(#{issue.rule.id})").darkgray
+          severity = issue.rule.severity ? Rainbow("[#{issue.rule.severity}]").magenta : ""
+          stdout.puts "#{Rainbow(issue.path).cyan}:#{start_line}:#{start_column}: #{message}  #{rule}  #{severity}".strip
+          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/rule.rb

@@ -4,12 +4,14 @@ module Goodcheck
     attr_reader :triggers
     attr_reader :message
     attr_reader :justifications
+    attr_reader :severity
 
-    def initialize(id:, triggers:, message:, justifications:)
+    def initialize(id:, triggers:, message:, justifications:, severity: nil)
       @id = id
       @triggers = triggers
       @message = message
       @justifications = justifications
+      @severity = severity
     end
   end
 end

data/lib/goodcheck/unarchiver.rb

@@ -0,0 +1,40 @@
+module Goodcheck
+  class Unarchiver
+    attr_reader :file_filter
+
+    def initialize(file_filter: ->(_filename) { true })
+      @file_filter = file_filter
+    end
+
+    def tar_gz?(filename)
+      name = filename.to_s.downcase
+      ext = ".tar.gz"
+      name.end_with?(ext) && name != ext
+    end
+
+    def tar_gz(content)
+      require "rubygems/package"
+
+      Gem::Package::TarReader.new(StringIO.new(gz(content))) do |tar_reader|
+        tar_reader.each do |file|
+          if file.file? && file_filter.call(file.full_name)
+            yield file.read, file.full_name
+          end
+        end
+      end
+    end
+
+    private
+
+    def gz(content)
+      require "zlib"
+
+      io = Zlib::GzipReader.new(StringIO.new(content))
+      begin
+        io.read
+      ensure
+        io.close
+      end
+    end
+  end
+end

data/lib/goodcheck/version.rb

@@ -1,3 +1,3 @@
 module Goodcheck
-  VERSION = "2.6.0".freeze
+  VERSION = "3.0.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goodcheck
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 3.0.2
 platform: ruby
 authors:
-- Soutaro Matsumoto
+- Sider Corporation
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,64 +28,64 @@ 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
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '0.18'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: marcel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: strong_json
   requirement: !ruby/object:Gem::Requirement
@@ -110,16 +110,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'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -129,7 +135,7 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -139,10 +145,11 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
-description: Regexp based customizable linter
+        version: '5.0'
+description: Goodcheck is a regexp based linter that allows you to define custom rules
+  in a YAML file.
 email:
-- matsumoto@soutaro.com
+- support@siderlabs.com
 executables:
 - goodcheck
 extensions: []
@@ -177,11 +184,16 @@ files:
 - lib/goodcheck/reporters/text.rb
 - lib/goodcheck/rule.rb
 - lib/goodcheck/trigger.rb
+- lib/goodcheck/unarchiver.rb
 - lib/goodcheck/version.rb
-homepage: https://github.com/sider/goodcheck
+homepage: https://sider.github.io/goodcheck/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://sider.github.io/goodcheck/
+  source_code_uri: https://github.com/sider/goodcheck
+  changelog_uri: https://github.com/sider/goodcheck/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/sider/goodcheck/issues
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -190,15 +202,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.20
 signing_key:
 specification_version: 4
-summary: Regexp based customizable linter
+summary: Regexp based customizable linter.
 test_files: []