gergich 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d2ed144a6c64e2faa3cdad9dfdcb75fe535203b5
-  data.tar.gz: e52ae51766e213f18050a7885b724cd106ae953e
+SHA256:
+  metadata.gz: 49e238094aaf4cc412c50cff9e0704824f0460d28a38301a99ece910a9e4e3ca
+  data.tar.gz: 8a9d5bdf120832ef21c3a65bfc3e89e70ad0800eb6c76ec61ff32b866ae0a33c
 SHA512:
-  metadata.gz: bb201b5e1f6b385bbbdbbda08c9ca4b3c8046e67a1a6bf0aa9d560be6106535a591c4e0ba773858de4f49c928538c646fcb02f69a1923690e7048aabc13749c1
-  data.tar.gz: 239fa8d431558eb4bc9fa16373ad9aca7235c75c30e7d113f9fd9b8a4a3cf3844525a664006262723fa5af5d01c78941f89fedc9b2a8344ba7d0e29598a0a613
+  metadata.gz: 309de3347fb62da85de07807aa6b0f69913f756a69be2b515c928076077053378f5342961311adb17f07c7168413511ee42c95551f7029dfef36a00816fd6576
+  data.tar.gz: caae7f11e0f027d6bee1154b355dd04da9b3e149c3328bcf73016343724442e8b22454eaf47c869c392e983e941319bdf4a21e98fbf720a6d540fb9e688fc58b

data/lib/gergich/capture/androidlint_capture.rb

@@ -11,7 +11,7 @@ module Gergich
       }.freeze
 
       def run(output)
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         #
         # Example:
         # /path/to/some.xml:27: Warning: Consider adding android:drawableStart="@drawable/a_media" to better support right-to-left layouts [RtlHardcoded]
@@ -26,7 +26,7 @@ module Gergich
         #    <plurals name="number">
         #    ^
         #
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
         pattern = /
           ^([^:\n]+):(\d+)?:?\s(\w+):\s(.*?)\n
           ([^\n]+\n
@@ -34,9 +34,14 @@ module Gergich
         /mx
 
         output.scan(pattern).map { |file, line, severity, error, context|
-          context = "\n\n" + context if context
-          { path: file, message: "[androidlint] #{error}#{context}".strip,
-            position: (line || 0).to_i, severity: SEVERITY_MAP[severity] }
+          context = "\n\n#{context}" if context
+          {
+            path: file,
+            message: "#{error}#{context}".strip,
+            position: (line || 0).to_i,
+            severity: SEVERITY_MAP[severity],
+            source: "androidlint"
+          }
         }.compact
       end
     end

data/lib/gergich/capture/brakeman_capture.rb

@@ -14,7 +14,7 @@ module Gergich
       def run(output)
         # See brakeman_example.json for sample output.
         JSON.parse(output)["warnings"].map { |warning|
-          message = "[brakeman] #{warning['warning_type']}: #{warning['message']}"
+          message = "#{warning['warning_type']}: #{warning['message']}"
           message += "\n  Code: #{warning['code']}" if warning["code"]
           message += "\n  User Input: #{warning['user_input']}" if warning["user_input"]
           message += "\n  See: #{warning['link']}" if warning["link"]
@@ -22,7 +22,8 @@ module Gergich
             path: warning["file"],
             position: warning["line"] || 0,
             message: message,
-            severity: SEVERITY_MAP[warning["confidence"]]
+            severity: SEVERITY_MAP[warning["confidence"]],
+            source: "brakeman"
           }
         }.compact
       end

data/lib/gergich/capture/eslint_capture.rb

@@ -16,7 +16,8 @@ module Gergich
         output.scan(pattern).map { |file, errors|
           errors.scan(error_pattern).map { |line, severity, error|
             severity = SEVERITY_MAP[severity]
-            { path: file, message: "[eslint] #{error}", position: line.to_i, severity: severity }
+            { path: file, message: error, source: "eslint", position: line.to_i,
+              severity: severity }
           }
         }.compact.flatten
       end

data/lib/gergich/capture/flake8_capture.rb

@@ -11,7 +11,7 @@ module Gergich
         /mx
 
         output.scan(pattern).map { |file, line, error|
-          { path: file, message: "[flake8] #{error}",
+          { path: file, message: error, source: "flake8",
             position: line.to_i, severity: "error" }
         }.compact
       end

data/lib/gergich/capture/i18nliner_capture.rb

@@ -16,7 +16,7 @@ module Gergich
             line = Regexp.last_match[1]
             ""
           end
-          { path: file, message: "[i18n] #{error}", position: line.to_i, severity: "error" }
+          { path: file, message: error, source: "i18n", position: line.to_i, severity: "error" }
         }.compact
       end
     end

data/lib/gergich/capture/rubocop_capture.rb

@@ -16,10 +16,29 @@ module Gergich
         #   bin/gergich:47:8: C: Prefer double-quoted strings
         #   if ENV['DEBUG']
         #          ^^^^^^^
+        #
+        # 1 file inspected, 35 offenses detected, 27 offenses auto-correctable
+        #
+        # Example:
+        # 2 files inspected, 40 offenses detected, 31 offenses auto-correctable
+        #
+        # Example:
+        # 1 file inspected, no offenses detected
+
         first_line_pattern = /^([^:\n]+):(\d+):\d+:\s(\w):\s/
 
         parts = output.split(first_line_pattern)
+
+        unless parts.last.match?(/^\d+ files? inspect/)
+          raise "RuboCop failed to run properly:\n\n#{output}"
+        end
+
+        # strip off the summary line from the last error
+        parts[-1] = parts[-1].split("\n")[0..-2].join("\n")
+
+        # strip off the header
         parts.shift
+
         messages = []
 
         until parts.empty?
@@ -30,15 +49,31 @@ module Gergich
           # if there is code context at the end, separate it and indent it
           # so that gerrit preserves formatting
           if /(?<context>[^\n]+\n *\^+\n)/m =~ message
-            message.sub!(context, "\n" + context.gsub(/^/, " "))
+            message.sub!(context, "\n#{context.gsub(/^/, ' ')}")
           end
+          match = message.match(
+            %r{
+              \A
+              (?<corrected>\[Corrected\]\s)?
+              (?<correctable>\[Correctable\]\s)?
+              (?:(?<cop>[A-Za-z/]+):\s)?
+              (?<message>.*)
+              \z
+              }mx
+          )
 
+          # rubocop:disable Style/DoubleNegation
           messages << {
             path: file,
             position: line.to_i,
-            message: "[rubocop] #{message}",
-            severity: SEVERITY_MAP[severity]
+            message: match[:message],
+            rule: match[:cop],
+            corrected: !!match[:corrected],
+            correctable: !!match[:correctable],
+            severity: SEVERITY_MAP[severity],
+            source: "rubocop"
           }
+          # rubocop:enable Style/DoubleNegation
         end
 
         messages

data/lib/gergich/capture/shellcheck_capture.rb

@@ -20,7 +20,8 @@ module Gergich
             path: warning.fetch("file"),
             position: warning.fetch("line"),
             message: warning.fetch("message"),
-            severity: SEVERITY_MAP.fetch(severity)
+            severity: SEVERITY_MAP.fetch(severity),
+            source: "shellcheck"
           }
         end
       end

data/lib/gergich/capture/stylelint_capture.rb

@@ -6,7 +6,6 @@ module Gergich
       # stylelint is a css linter
       # https://github.com/stylelint/stylelint
       #
-      # rubocop:disable Style/AsciiComments
       # example full output:
       # app/stylesheets/base/_print.scss
       #  3:17  ✖  Unexpected invalid hex color "#owiehfi"   color-no-invalid-hex
@@ -16,8 +15,6 @@ module Gergich
       #   2:15  ✖  Unexpected invalid hex color "#2D3B4"   color-no-invalid-hex
       #  30:15  ⚠  Expected "#2d3b4a" to be "#2D3B4A"      color-hex-case
 
-      MESSAGE_PREFIX = "[stylelint]"
-
       SEVERITY_MAP = {
         "✖" => "error",
         "⚠" => "warn",
@@ -31,7 +28,6 @@ module Gergich
       # example error line:
       #   1:15  ✖  Unexpected invalid hex color "#2D3B4"   color-no-invalid-hex
       ERROR_PATTERN = /^\s+(\d+):\d+\s+(✖|⚠|ℹ)\s+(.*?)\s\s+[^\n]+\n/.freeze
-      # rubocop:enable Style/AsciiComments
 
       PATTERN = /#{FILE_PATH_PATTERN}((#{ERROR_PATTERN})+)/.freeze
 
@@ -41,7 +37,8 @@ module Gergich
             severity = SEVERITY_MAP[severity]
             {
               path: file,
-              message: "#{MESSAGE_PREFIX} #{error}",
+              message: error,
+              source: "stylelint",
               position: line.to_i,
               severity: severity
             }

data/lib/gergich/capture/swiftlint_capture.rb

@@ -12,19 +12,19 @@ module Gergich
       }.freeze
 
       def run(output)
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         #
         # Example:
         # /path/to/My.swift:13:22: warning: Colon Violation: Colons should be next to the identifier when specifying a type. (colon)
         # /path/to/Fail.swift:80: warning: Line Length Violation: Line should be 100 characters or less: currently 108 characters (line_length)
         #
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
         pattern = /
           ^([^:\n]+):(\d+)(?::\d+)?:\s(\w+):\s(.*?)\n
         /mx
 
         output.scan(pattern).map { |file, line, severity, error, _context|
-          { path: file, message: "[swiftlint] #{error}",
+          { path: file, message: error, source: "swiftlint",
             position: line.to_i, severity: SEVERITY_MAP[severity] }
         }.compact
       end

data/lib/gergich/capture/yamllint_capture.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Gergich
+  module Capture
+    class YamllintCapture < BaseCapture
+      SEVERITY_MAP = { "error" => "error", "warning" => "warn" }.freeze
+
+      def run(output)
+        # e.g. "  9:5       error    string value redundantly  (quoted-strings)"
+        error_pattern = %r{\s\s+(\d+):\d+\s+(\w+)\s+(.*?)\s+\([\w/-]+\)\n}
+        pattern = %r{            # Example:
+          ^./([^\n]+)\n         #   ./api/config/lti/development/config.yml
+          ((#{error_pattern})+)  #     9:5       error    string value redundantly  (quoted-strings)
+        }mx
+
+        output.scan(pattern).map { |file, errors|
+          errors.scan(error_pattern).map { |line, severity, error|
+            severity = SEVERITY_MAP[severity]
+            {
+              path: file,
+              message: error,
+              source: "yamllint",
+              position: line.to_i,
+              severity: severity
+            }
+          }
+        }.compact.flatten
+      end
+    end
+  end
+end

data/lib/gergich/capture.rb

@@ -7,6 +7,7 @@ module Gergich
   module Capture
     class BaseCapture
       def self.inherited(subclass)
+        super
         name = normalize_captor_class_name(subclass)
         Capture.captors[name] = subclass
       end
@@ -38,8 +39,14 @@ module Gergich
           comments.each do |comment|
             next if skip_paths.any? { |path| comment[:path].start_with?(path) }
 
-            draft.add_comment comment[:path], comment[:position],
-                              comment[:message], comment[:severity]
+            message = +"[#{comment[:source]}] "
+            message << "#{comment[:rule]}: " if comment[:rule]
+            message << comment[:message]
+
+            draft.add_comment comment[:path],
+                              comment[:position],
+                              message,
+                              comment[:severity]
           end
         end
 
@@ -47,7 +54,7 @@ module Gergich
       end
 
       def base_path
-        @base_path ||= File.expand_path(GERGICH_GIT_PATH) + "/"
+        @base_path ||= "#{File.expand_path(GERGICH_GIT_PATH)}/"
       end
 
       def relativize(path)
@@ -75,7 +82,7 @@ module Gergich
           $stdout.puts line unless suppress_output
           output << line
         end
-        output.join("")
+        output.join
       end
 
       def load_captor(format)
@@ -109,4 +116,4 @@ module Gergich
   end
 end
 
-Dir[File.dirname(__FILE__) + "/capture/*.rb"].sort.each { |file| require file }
+Dir["#{File.dirname(__FILE__)}/capture/*.rb"].sort.each { |file| require file }

data/lib/gergich/cli/gergich.rb

@@ -14,10 +14,11 @@ CI_TEST_ARGS = {
   ],
   "label" => ["Code-Review", 1],
   "message" => ["this is a test"],
-  "capture" => ["rubocop", "echo #{Shellwords.escape(<<~OUTPUT)}"]
+  "capture" => ["rubocop", format("echo %<output>s", output: Shellwords.escape(<<~OUTPUT))]
     bin/gergich:47:8: C: Prefer double-quoted strings
     if ENV['DEBUG']
            ^^^^^^^
+    1 file inspected, 35 offenses detected, 27 offenses auto-correctable
   OUTPUT
 }.freeze
 
@@ -40,7 +41,7 @@ def run_ci_test!(all_commands)
 
   commands.each do |command, args = []|
     arglist = args.map { |arg| Shellwords.escape(arg.to_s) }
-    output = `bin/gergich #{command} #{arglist.join(" ")} 2>&1`
+    output = `bundle exec gergich #{command} #{arglist.join(" ")} 2>&1`
     unless $CHILD_STATUS.success?
       error "`gergich citest` failed on step `#{command}`:\n\n#{output.gsub(/^/, '  ')}\n"
     end
@@ -108,8 +109,8 @@ commands["comment"] = {
   action: ->(comment_data) {
     comment_data = begin
       JSON.parse(comment_data)
-                   rescue JSON::ParserError
-                     error("Unable to parse <comment_data> json", "comment")
+    rescue JSON::ParserError
+      error("Unable to parse <comment_data> json", "comment")
     end
     comment_data = [comment_data] unless comment_data.is_a?(Array)
 
@@ -209,6 +210,7 @@ commands["capture"] = {
                         * i18nliner
                         * flake8
                         * stylelint
+                        * yamllint
                         * custom:<path>:<class_name> - file path and ruby
                           class_name of a custom formatter.
 

data/lib/gergich/cli/master_bouncer.rb

@@ -15,11 +15,11 @@ ERROR_DISTANCE = ENV.fetch("MASTER_BOUNCER_ERROR_DISTANCE", 100).to_i
 
 def potentially_mergeable_changes
   url = "/changes/?q=status:open+" \
-                    "p:#{PROJECT}+" \
-                    "label:Verified=1+" \
-                    "is:mergeable+" \
-                    "branch:master" \
-                 "&o=CURRENT_REVISION"
+        "p:#{PROJECT}+" \
+        "label:Verified=1+" \
+        "is:mergeable+" \
+        "branch:master" \
+        "&o=CURRENT_REVISION"
   changes = Gergich::API.get(url)
   changes.reject { |c| c["subject"] =~ /\Awip($|\W)/i }
 end
@@ -62,7 +62,7 @@ def maybe_bounce_commit!(commit)
   # similarly, over time the same patchset will become more out of date,
   # so we allow_repost (so to speak) so we can add increasingly negative
   # reviews
-  review.publish!(:allow_repost)
+  review.publish!(allow_repost: true)
 end
 
 commands = {}

data/lib/gergich/cli.rb

@@ -12,7 +12,7 @@ def info(text)
 end
 
 def script_name
-  $PROGRAM_NAME.sub(%r{.*\/}, "")
+  $PROGRAM_NAME.sub(%r{.*/}, "")
 end
 
 def usage(content = nil)

data/lib/gergich.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
 require "erb"
-require "sqlite3"
 require "json"
 require "fileutils"
-require "httparty"
 require "base64"
 
 GERGICH_REVIEW_LABEL = ENV.fetch("GERGICH_REVIEW_LABEL", "Code-Review")
@@ -53,15 +51,13 @@ module Gergich
     end
 
     def files
-      @files ||= begin
-        if Gergich.use_git?
-          Gergich.git("diff-tree --no-commit-id --name-only -r #{ref}").split
-        else
-          raw = API.get("/changes/#{change_id}/revisions/#{revision_id}/patch", raw: true)
-          Base64.decode64(raw)
-            .scan(%r{^diff --git a/.*? b/(.*?)$})
-            .flatten
-        end
+      @files ||= if Gergich.use_git?
+        Gergich.git("diff-tree --no-commit-id --name-only -r #{ref}").split
+      else
+        raw = API.get("/changes/#{change_id}/revisions/#{revision_id}/patch", raw: true)
+        Base64.decode64(raw)
+          .scan(%r{^diff --git a/.*? b/(.*?)$})
+          .flatten
       end
     end
 
@@ -72,7 +68,7 @@ module Gergich
     def revision_number
       @revision_number ||= begin
         patchset_number = ENV["GERRIT_PATCHSET_NUMBER"]
-        return patchset_number unless patchset_number.nil?
+        return patchset_number unless patchset_number.nil? # rubocop:disable Lint/NoReturnInBeginEndBlocks
 
         gerrit_info = API.get("/changes/?q=#{change_id}&o=ALL_REVISIONS")[0]
         raise GergichError, "Gerrit patchset not found" unless gerrit_info
@@ -99,7 +95,7 @@ module Gergich
     end
 
     # Public: publish all draft comments/labels/messages
-    def publish!(allow_repost = false)
+    def publish!(allow_repost: false)
       # only publish if we have something to say or if our last score was negative
       return unless anything_to_publish?
 
@@ -202,13 +198,11 @@ module Gergich
     # currently, cover message only supports the GERGICH_REVIEW_LABEL.
     # i.e., even if gergich has "Code-Review: -2"
     def current_label
-      @current_label ||= begin
-        API.get("/changes/#{commit.change_id}/detail")["labels"]
-          .fetch(GERGICH_REVIEW_LABEL, {})
-          .fetch("all", [])
-          .select { |label| label["username"] == GERGICH_USER }
-          .first
-      end
+      @current_label ||= API.get("/changes/#{commit.change_id}/detail")["labels"]
+        .fetch(GERGICH_REVIEW_LABEL, {})
+        .fetch("all", [])
+        .select { |label| label["username"] == GERGICH_USER }
+        .first
     end
 
     def current_label_date
@@ -234,7 +228,7 @@ module Gergich
     end
 
     def current_score
-      current_label && current_label["value"] || 0
+      (current_label && current_label["value"]) || 0
     end
 
     def cover_message
@@ -292,6 +286,8 @@ module Gergich
       private
 
       def perform(method, url, options)
+        # delay requiring httparty until here, to make local command line runs as fast as possible
+        require "httparty"
         options = prepare_options(options)
         ret = HTTParty.send(method, url, options).body
         return ret if options[:raw]
@@ -314,7 +310,7 @@ module Gergich
       def base_uri
         @base_uri ||= \
           ENV["GERRIT_BASE_URL"] ||
-          ENV.key?("GERRIT_HOST") && "https://#{ENV['GERRIT_HOST']}" ||
+          (ENV.key?("GERRIT_HOST") && "https://#{ENV['GERRIT_HOST']}") ||
           raise(GergichError, "need to set GERRIT_BASE_URL or GERRIT_HOST")
       end
 
@@ -338,7 +334,7 @@ module Gergich
 
       def prepare_options(options)
         options = {
-          base_uri: base_uri + "/a"
+          base_uri: "#{base_uri}/a"
         }.merge(auth_config).merge(options)
         if options[:body]
           options[:headers] ||= {}
@@ -363,11 +359,14 @@ module Gergich
     end
 
     def db_file
-      @db_file ||= File.expand_path("/tmp/#{GERGICH_USER}-#{commit.revision_id}.sqlite3")
+      @db_file ||= File.expand_path(
+        "#{ENV.fetch('GERGICH_DB_PATH', '/tmp')}/#{GERGICH_USER}-#{commit.revision_id}.sqlite3"
+      )
     end
 
     def db
       @db ||= begin
+        require "sqlite3"
         db_exists = File.exist?(db_file)
         db = SQLite3::Database.new(db_file)
         db.results_as_hash = true
@@ -512,7 +511,7 @@ module Gergich
 
     def info
       @info ||= begin
-        comments = Hash[inline_comments.map { |file| [file.path, file.to_a] }]
+        comments = inline_comments.map { |file| [file.path, file.to_a] }.to_h
 
         {
           comments: comments,
@@ -530,9 +529,9 @@ module Gergich
 
     def orphaned_message
       messages = ["NOTE: I couldn't create inline comments for everything. " \
-                "Although this isn't technically part of your commit, you " \
-                "should still check it out (i.e. side effects or auto-" \
-                "generated from stuff you *did* change):"]
+                  "Although this isn't technically part of your commit, you " \
+                  "should still check it out (i.e. side effects or auto-" \
+                  "generated from stuff you *did* change):"]
 
       other_comments.each do |file|
         file.comments.each do |position, comments|