gergich 1.2.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 209022ec9ca1bfed90a33f905f9d0e36f016b7f25485e66041e276ff393fec6e
-  data.tar.gz: f6477fb1a8f75192b6f516cfe1197db7800a3b221a703d71da7a1204db3a23bc
+  metadata.gz: 2266d14e8768ee3abd861d8ea5783ccec76f2d739a7f47714a716d2b2633d315
+  data.tar.gz: 117e4a786302fb5f1f8edb314dcbf610bac9509c088fb2187eed12e66b27b8ef
 SHA512:
-  metadata.gz: f6ffba5044485692318eb057407f9d6032eccd9118942233e34b3d727201784ca2111c56adb1e5ce306814916d90585b6341ff19eeb1df6c1cc0bf98d4b6b5df
-  data.tar.gz: f7b5f8e726eabc13f722da011df51d7c0fb137480130573819c928d1bca02057f91330d995cbda0a7ad8ad7661ee28a026a3df12f5d87911f2848f9cfd369113
+  metadata.gz: 3e834a5eae2e31b72820880ffbcb6b3dfd2ead64d03e774f322a63b0758a9dad48eb51c24ed9e6cd0fb5d598c91b1d042b3034df41d8c417e6406636370ee058
+  data.tar.gz: 8eb5874994069df2ef550b86ad41377ae37f9cf1f2ef9a54769cc29279a0e1f899447a66f36c5c069b4265210f888696d906fbe6e3d1d13407b4bea6e8060f1a

data/lib/gergich/capture/androidlint_capture.rb

@@ -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

@@ -49,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

@@ -24,7 +24,7 @@ module Gergich
         /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/tsc_capture.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Gergich
+  module Capture
+    class TscCapture < BaseCapture
+      def run(output)
+        pattern = /([^(\n]+)\((\d+),(\d+)\): (\w+) (\w+): (.*(\n  .*)*)/
+
+        output.scan(pattern).map { |file, line, pos, severity, code, error|
+          {
+            path: file,
+            message: error,
+            source: "tsc",
+            rule: code,
+            position: {
+              start_line: line.to_i,
+              start_position: pos.to_i,
+              end_line: line.to_i,
+              end_position: pos.to_i
+            },
+            severity: severity
+          }
+        }
+      end
+    end
+  end
+end

data/lib/gergich/capture/yamllint_capture.rb

@@ -9,14 +9,20 @@ module Gergich
         # 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
+          ^./([^\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: "[yamllint] #{error}", position: line.to_i, severity: severity }
+            {
+              path: file,
+              message: error,
+              source: "yamllint",
+              position: line.to_i,
+              severity: severity
+            }
           }
         }.compact.flatten
       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

@@ -9,7 +9,9 @@ CI_TEST_ARGS = {
       { path: "foo.rb", position: 3, severity: "error", message: "ಠ_ಠ" },
       { path: "/COMMIT_MSG", position: 1, severity: "info", message: "cool story bro" },
       { path: "/COMMIT_MSG", severity: "info", message: "lol",
-        position: { start_line: 1, start_character: 1, end_line: 1, end_character: 2 } }
+        position: { start_line: 1, start_character: 1, end_line: 1, end_character: 2 } },
+      { path: "/COMMIT_MSG", severity: "info", message: "more",
+        position: { start_line: 1, start_character: 5, end_line: 1, end_character: 5 } }
     ].to_json
   ],
   "label" => ["Code-Review", 1],
@@ -41,7 +43,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
@@ -109,8 +111,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)
 
@@ -210,6 +212,7 @@ commands["capture"] = {
                         * i18nliner
                         * flake8
                         * stylelint
+                        * tsc
                         * 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,10 @@ 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+" \
+        "branch:master" \
+        "&o=CURRENT_REVISION"
   changes = Gergich::API.get(url)
   changes.reject { |c| c["subject"] =~ /\Awip($|\W)/i }
 end
@@ -62,7 +61,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

@@ -51,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
 
@@ -70,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
@@ -97,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?
 
@@ -200,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
@@ -232,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
@@ -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] ||= {}
@@ -515,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,
@@ -533,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|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gergich
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Jon Jensen
-autorequire:
-bindir: bin
+autorequire: 
+bindir: exe
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2023-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -86,28 +86,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.21.2
 description: Gergich is a little command-line tool for wiring up linters to Gerrit
   so you can get nice inline comments right on the review
 email: jon@instructure.com
@@ -117,12 +145,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
-- README.md
-- bin/check_coverage
-- bin/gergich
-- bin/master_bouncer
-- bin/run_tests.sh
+- exe/gergich
+- exe/master_bouncer
 - lib/gergich.rb
 - lib/gergich/capture.rb
 - lib/gergich/capture/androidlint_capture.rb
@@ -134,30 +158,16 @@ files:
 - lib/gergich/capture/shellcheck_capture.rb
 - lib/gergich/capture/stylelint_capture.rb
 - lib/gergich/capture/swiftlint_capture.rb
+- lib/gergich/capture/tsc_capture.rb
 - lib/gergich/capture/yamllint_capture.rb
 - lib/gergich/cli.rb
 - lib/gergich/cli/gergich.rb
 - lib/gergich/cli/master_bouncer.rb
-- spec/gergich/capture/androidlint_capture_spec.rb
-- spec/gergich/capture/brakeman_capture_spec.rb
-- spec/gergich/capture/custom_capture_spec.rb
-- spec/gergich/capture/eslint_capture_spec.rb
-- spec/gergich/capture/flake8_capture_spec.rb
-- spec/gergich/capture/i18nliner_capture_spec.rb
-- spec/gergich/capture/rubocop_capture_spec.rb
-- spec/gergich/capture/shellcheck_capture_spec.rb
-- spec/gergich/capture/stylelint_capture_spec.rb
-- spec/gergich/capture/swiftlint_capture_spec.rb
-- spec/gergich/capture/yamllint_capture_spec.rb
-- spec/gergich/capture_spec.rb
-- spec/gergich_spec.rb
-- spec/spec_helper.rb
-- spec/support/capture_shared_examples.rb
 homepage: https://github.com/instructure/gergich
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -165,15 +175,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.24
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Command-line tool for adding Gerrit comments
 test_files: []

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2015-2016 Instructure, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.