goodcheck 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa64d7f536fc7b357fbae7aa685827211236015ff9203bc7291847705e4a8189
-  data.tar.gz: bf23ca5741b3e424d064d45b9e16ccc28fbf53d299d8a4966ce7a5566c277a0f
+  metadata.gz: c52f33a7ac472299ab9acdfe418c10f14d7e36c1d709118484ed89bc4c336597
+  data.tar.gz: 9b2021e6127d5f4d5892ac248b04d612ee88d6efb2e0237d54e3e17a25b5ab67
 SHA512:
-  metadata.gz: d184c5e83feb1b656afdbb2aa71c724b33c584a674de2def35201bbd8a66275b5c2a45b466c477aee38689f53dc6e39a0ee4183a6ad61b3ba587485eeb7f3d89
-  data.tar.gz: 215b0532befa04bdbbdbb0ac24be805fde46ebe51bafda8d6193df1c3a183fbf0faad0495454b9dcfe6dec27015f817b5b52f99b4fa26936f57ac491fa923bf5
+  metadata.gz: eb9085ae8573a2c07a29e7a75f0dd3f3b56340e1cde25ff10fb369c4eb4f1592f3101fc7bcb93a596d2a69fe3b69e0b4e2d35a81cbf65624fa4d471e7853e42e
+  data.tar.gz: 4eb596ffc6d63a26ef61b3b437b363eb517ff4d0923973b484b587ef39026475d927a408f9ab33c29eb72b207f072d844a12135a96dbd3040be9c5f73a8cf2d4

data/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 ## HEAD
 
+## 3.1.0 (2021-07-15)
+
+* Improve coloring for text format [#208](https://github.com/sider/goodcheck/pull/208)
+* Output justification with text format [#210](https://github.com/sider/goodcheck/pull/210)
+
+## 3.0.3 (2021-06-25)
+
+* Fix HTTP GET retrying [#203](https://github.com/sider/goodcheck/pull/203)
+
+## 3.0.2 (2021-06-23)
+
+* Retry importing on Net::OpenTimeout [#202](https://github.com/sider/goodcheck/pull/202)
+
+## 3.0.1 (2021-06-14)
+
+* Retry HTTP GET request on importing rules [#197](https://github.com/sider/goodcheck/pull/197)
+
 ## 3.0.0 (2021-06-14)
 
 Breaking changes:

data/README.md

@@ -37,12 +37,12 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 To release a new version, follows the steps below:
 
-1. Update the version number in [`version.rb`](lib/goodcheck/version.rb).
-2. Add the new version's entry to the [changelog](CHANGELOG.md).
-3. Update the documentation via `bundle exec rake docs:update_version`.
-4. Commit the above changes like `git commit -m 'Version 1.2.3'`.
-5. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-6. Publish the updated documentation like `GIT_USER=some_user USE_SSH=true bundle exec rake docs:publish`.
+1. Update [`lib/goodcheck/version.rb`](lib/goodcheck/version.rb).
+2. Update [CHANGELOG.md](CHANGELOG.md).
+3. Run `bundle exec rake docs:update_version`.
+4. Run `git add . && git commit -m 'Version <new_version>'`.
+5. Run `bundle exec rake release`, which will create a tag, push the commit and tag, and publish the gem to [RubyGems.org](https://rubygems.org).
+6. Run `GIT_USER=<your_nickname> [USE_SSH=true] bundle exec rake docs:publish`.
 
 ## Contributing
 

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

data/lib/goodcheck/import_loader.rb

@@ -18,6 +18,15 @@ module Goodcheck
       end
     end
 
+    class HTTPGetError < Error
+      attr_reader :response
+
+      def initialize(res)
+        super("HTTP GET #{res.uri} => #{res.code} #{res.message}")
+        @response = res
+      end
+    end
+
     attr_reader :cache_path
     attr_reader :expires_in
     attr_reader :force_download
@@ -122,15 +131,30 @@ module Goodcheck
     def http_get(uri, limit = 10)
       raise ArgumentError, "Too many HTTP redirects" if limit == 0
 
-      res = Net::HTTP.get_response URI(uri)
-      case res
-      when Net::HTTPSuccess
-        res.body
-      when Net::HTTPRedirection
-        location = res['Location']
-        http_get location, limit - 1
-      else
-        raise "Error: HTTP GET #{uri.inspect} #{res.inspect}"
+      max_retry_count = 2
+      retry_count = 0
+      begin
+        res = Net::HTTP.get_response URI(uri)
+        case res
+        when Net::HTTPSuccess
+          res.body
+        when Net::HTTPRedirection
+          location = res['Location']
+          http_get location, limit - 1
+        when Net::HTTPClientError, Net::HTTPServerError
+          raise HTTPGetError.new(res)
+        else
+          raise Error, "HTTP GET failed due to #{res.inspect}"
+        end
+      rescue Net::OpenTimeout, HTTPGetError => exn
+        if retry_count < max_retry_count
+          retry_count += 1
+          Goodcheck.logger.info "Retry ##{retry_count} - HTTP GET #{uri} due to #{exn.inspect}..."
+          sleep 1
+          retry
+        else
+          raise
+        end
       end
     end
 

data/lib/goodcheck/reporters/text.rb

@@ -25,7 +25,16 @@ module Goodcheck
       def issue(issue)
         @issue_count += 1
 
-        message = issue.rule.message.lines.first.chomp
+        format_line = lambda do |line:, column:|
+          format_args = {
+            path: Rainbow(issue.path).cyan,
+            location: Rainbow(":#{line}:#{column}:").dimgray,
+            message: issue.rule.message.lines.first.chomp,
+            rule: Rainbow("(#{issue.rule.id})").dimgray,
+            severity: issue.rule.severity ? Rainbow("[#{issue.rule.severity}]").magenta : ""
+          }
+          format("%<path>s%<location>s %<message>s  %<rule>s  %<severity>s", format_args).strip
+        end
 
         if issue.location
           start_line = issue.location.start_line
@@ -37,13 +46,21 @@ module Goodcheck
                         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 format_line.call(line: start_line, column: start_column)
           stdout.puts line.chomp
           stdout.puts (" " * start_column_index) + Rainbow("^" + "~" * (column_size - 1)).yellow
         else
-          stdout.puts "#{Rainbow(issue.path).cyan}:-:-: #{message}"
+          stdout.puts format_line.call(line: "-", column: "-")
+        end
+
+        justifications = issue.rule.justifications
+        unless justifications.empty?
+          stdout.puts ""
+          stdout.puts "  #{Rainbow('Justifications').dimgray.underline.italic}:"
+          justifications.each do |justification|
+            stdout.puts "    • #{Rainbow(justification).dimgray.italic}"
+          end
+          stdout.puts ""
         end
       end
 

data/lib/goodcheck/version.rb

@@ -1,3 +1,3 @@
 module Goodcheck
-  VERSION = "3.0.0".freeze
+  VERSION = "3.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goodcheck
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Sider Corporation
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -209,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.2.23
 signing_key:
 specification_version: 4
 summary: Regexp based customizable linter.