gergich 0.2.2 → 1.2.1

data/lib/gergich/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "shellwords"
 require "English"
 
@@ -38,7 +40,7 @@ def help_command(commands)
       end
     },
     help: -> {
-      indentation = commands.keys.map(&:size).sort.last
+      indentation = commands.keys.map(&:size).max
       commands_help = commands
         .to_a
         .sort_by(&:first)
@@ -73,7 +75,7 @@ def run_app(commands)
       run_command(action)
     rescue GergichError
       error $ERROR_INFO.message
-    rescue
+    rescue StandardError
       error "Unhandled exception: #{$ERROR_INFO}\n#{$ERROR_INFO.backtrace.join("\n")}"
     end
   else

data/lib/gergich/cli/gergich.rb

@@ -1,4 +1,4 @@
-# encoding=utf-8
+# frozen_string_literal: true
 
 require_relative "../cli"
 require_relative "../../gergich"
@@ -14,11 +14,11 @@ CI_TEST_ARGS = {
   ],
   "label" => ["Code-Review", 1],
   "message" => ["this is a test"],
-  "capture" => ["rubocop", "echo #{Shellwords.escape(<<-OUTPUT)}"]
-bin/gergich:47:8: C: Prefer double-quoted strings
-if ENV['DEBUG']
-       ^^^^^^^
-OUTPUT
+  "capture" => ["rubocop", format("echo %<output>s", output: Shellwords.escape(<<~OUTPUT))]
+    bin/gergich:47:8: C: Prefer double-quoted strings
+    if ENV['DEBUG']
+           ^^^^^^^
+  OUTPUT
 }.freeze
 
 def run_ci_test!(all_commands)
@@ -27,13 +27,14 @@ def run_ci_test!(all_commands)
   commands_to_test << "status" # put it at the end, so we maximize the stuff it tests
 
   commands = commands_to_test.map { |command| [command, CI_TEST_ARGS[command] || []] }
-  commands.concat all_commands.map { |command| ["help", [command]] }
+  commands.concat(all_commands.map { |command| ["help", [command]] })
 
   # after running our test commands, reset and publish frd:
   commands << ["reset"]
-  commands << ["label", ["QA-Review", 1]]
-  commands << ["label", ["Product-Review", 1]]
-  commands << ["label", ["Code-Review", 1]]
+  # Note that while gergich should always be able to vote on these labels, he may be used to
+  # vone on other branches depending on project usage and project-specific permissions
+  commands << ["label", ["Lint-Review", 1]]
+  commands << ["label", ["Code-Review", 1]] # Not all projects have Lint-Review
   commands << ["message", ["\`gergich citest\` checks out :thumbsup: :mj:"]]
   commands << ["publish"]
 
@@ -50,21 +51,21 @@ commands = {}
 
 commands["reset"] = {
   summary: "Clear out pending comments/labels/messages for this patchset",
-  action: ->() {
+  action: -> {
     Gergich::Draft.new.reset!
   },
   help: -> {
-    <<-TEXT
-gergich reset
+    <<~TEXT
+      gergich reset
 
-Clear out the draft for this patchset. Useful for testing.
-TEXT
+      Clear out the draft for this patchset. Useful for testing.
+    TEXT
   }
 }
 
 commands["publish"] = {
   summary: "Publish the draft for this patchset",
-  action: ->() {
+  action: -> {
     if (data = Gergich::Review.new.publish!)
       puts "Published #{data[:total_comments]} comments, set score to #{data[:score]}"
     else
@@ -72,33 +73,33 @@ commands["publish"] = {
     end
   },
   help: -> {
-    <<-TEXT
-gergich publish
+    <<~TEXT
+      gergich publish
 
-Publish all draft comments/labels/messages for this patchset. no-op if
-there are none.
+      Publish all draft comments/labels/messages for this patchset. no-op if
+      there are none.
 
-The cover message and Code-Review label (e.g. -2) are inferred from the
-comments, but labels and messages may be manually set (via `gergich
-message` and `gergich labels`)
-TEXT
+      The cover message and Code-Review label (e.g. -2) are inferred from the
+      comments, but labels and messages may be manually set (via `gergich
+      message` and `gergich labels`)
+    TEXT
   }
 }
 
 commands["status"] = {
   summary: "Show the current draft for this patchset",
-  action: ->() {
+  action: -> {
     Gergich::Review.new.status
   },
   help: -> {
-    <<-TEXT
-gergich status
+    <<~TEXT
+      gergich status
 
-Show the current draft for this patchset
+      Show the current draft for this patchset
 
-Display any labels, cover messages and inline comments that will be set
-as part of this review.
-TEXT
+      Display any labels, cover messages and inline comments that will be set
+      as part of this review.
+    TEXT
   }
 }
 
@@ -107,8 +108,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)
 
@@ -120,36 +121,36 @@ commands["comment"] = {
                         comment["severity"]
     end
   },
-  help: ->() {
-    <<-TEXT
-gergich comment <comment_data>
-
-<comment_data> is a JSON object (or array of objects). Each comment object
-should have the following properties:
-  path     - the relative file path, e.g. "app/models/user.rb"
-  position - either a number (line) or an object (range). If an object,
-             must have the following numeric properties:
-               * start_line
-               * start_character
-               * end_line
-               * end_character
-  message  - the text of the comment
-  severity - "info"|"warn"|"error" - this will automatically prefix the
-             comment (e.g. "[ERROR] message here"), and the most severe
-             comment will be used to determine the overall Code-Review
-             score (0, -1, or -2 respectively)
-
-Note that a cover message and Code-Review score will be inferred from the
-most severe comment.
-
-Examples
-    gergich comment '{"path":"foo.rb","position":3,"severity":"error",
-                      "message":"ಠ_ಠ"}'
-    gergich comment '{"path":"bar.rb","severity":"warn",
-                      "position":{"start_line":3,"start_character":5,...},
-                      "message":"¯\\_(ツ)_/¯"}'
-    gergich comment '[{"path":"baz.rb",...}, {...}, {...}]'
-TEXT
+  help: -> {
+    <<~TEXT
+      gergich comment <comment_data>
+
+      <comment_data> is a JSON object (or array of objects). Each comment object
+      should have the following properties:
+        path     - the relative file path, e.g. "app/models/user.rb"
+        position - either a number (line) or an object (range). If an object,
+                   must have the following numeric properties:
+                     * start_line
+                     * start_character
+                     * end_line
+                     * end_character
+        message  - the text of the comment
+        severity - "info"|"warn"|"error" - this will automatically prefix the
+                   comment (e.g. "[ERROR] message here"), and the most severe
+                   comment will be used to determine the overall Code-Review
+                   score (0, -1, or -2 respectively)
+
+      Note that a cover message and Code-Review score will be inferred from the
+      most severe comment.
+
+      Examples
+          gergich comment '{"path":"foo.rb","position":3,"severity":"error",
+                            "message":"ಠ_ಠ"}'
+          gergich comment '{"path":"bar.rb","severity":"warn",
+                            "position":{"start_line":3,"start_character":5,...},
+                            "message":"¯\\_(ツ)_/¯"}'
+          gergich comment '[{"path":"baz.rb",...}, {...}, {...}]'
+    TEXT
   }
 }
 
@@ -159,13 +160,13 @@ commands["message"] = {
     draft = Gergich::Draft.new
     draft.add_message message
   },
-  help: ->() {
-    <<-TEXT
-gergich message <message>
+  help: -> {
+    <<~TEXT
+      gergich message <message>
 
-<message> will be appended to existing cover messages (inferred or manually
-added) for this patchset.
-TEXT
+      <message> will be appended to existing cover messages (inferred or manually
+      added) for this patchset.
+    TEXT
   }
 }
 
@@ -174,16 +175,16 @@ commands["label"] = {
   action: ->(label, score) {
     Gergich::Draft.new.add_label label, score
   },
-  help: ->() {
-    <<-TEXT
-gergich label <label> <score>
+  help: -> {
+    <<~TEXT
+      gergich label <label> <score>
 
-Add a draft label to this patchset. If the same label is set multiple
-times, the lowest score will win.
+      Add a draft label to this patchset. If the same label is set multiple
+      times, the lowest score will win.
 
-<label>  - a valid label (e.g. "Code-Review")
-<score>  - a valid score (e.g. -1)
-TEXT
+      <label>  - a valid label (e.g. "Code-Review")
+      <score>  - a valid score (e.g. -1)
+    TEXT
   }
 }
 
@@ -194,63 +195,63 @@ commands["capture"] = {
     status, = Gergich::Capture.run(format, command)
     exit status
   },
-  help: ->() {
-    <<-TEXT
-gergich capture <format> <command>
+  help: -> {
+    <<~TEXT
+      gergich capture <format> <command>
 
-For common linting formats, `gergich capture` can be used to automatically
-do `gergich comment` calls so you don't have to wire it up yourself.
+      For common linting formats, `gergich capture` can be used to automatically
+      do `gergich comment` calls so you don't have to wire it up yourself.
 
-<format>        - One of the following:
-                  * brakeman
-                  * rubocop
-                  * eslint
-                  * i18nliner
-                  * flake8
-                  * stylelint
-                  * custom:<path>:<class_name> - file path and ruby
-                    class_name of a custom formatter.
+      <format>        - One of the following:
+                        * brakeman
+                        * rubocop
+                        * eslint
+                        * i18nliner
+                        * flake8
+                        * stylelint
+                        * custom:<path>:<class_name> - file path and ruby
+                          class_name of a custom formatter.
 
-<command>       - The command to run whose output conforms to <format>.
-                  Output from the command will still go to STDOUT, and
-                  Gergich will preserve its exit status.
-                  If command is "-", Gergich will simply read from STDIN
-                  and the exit status will always be 0.
+      <command>       - The command to run whose output conforms to <format>.
+                        Output from the command will still go to STDOUT, and
+                        Gergich will preserve its exit status.
+                        If command is "-", Gergich will simply read from STDIN
+                        and the exit status will always be 0.
 
-Examples:
-    gergich capture rubocop "bundle exec rubocop"
+      Examples:
+          gergich capture rubocop "bundle exec rubocop"
 
-    gergich capture eslint eslint
+          gergich capture eslint eslint
 
-    gergich capture i18nliner "rake i18nliner:check"
+          gergich capture i18nliner "rake i18nliner:check"
 
-    gergich capture custom:./gergich/xss:Gergich::XSS "node script/xsslint"
+          gergich capture custom:./gergich/xss:Gergich::XSS "node script/xsslint"
 
-    docker-compose run --rm web eslint | gergich capture eslint -
-    # you might be interested in $PIPESTATUS[0]
-TEXT
+          docker-compose run --rm web eslint | gergich capture eslint -
+          # you might be interested in $PIPESTATUS[0]
+    TEXT
   }
 }
 
 commands["citest"] = {
   summary: "Do a full gergich test based on the current commit",
-  action: ->() {
+  action: -> {
     # automagically test any new command that comes along
     run_ci_test!(commands.keys)
   },
-  help: ->() {
-    <<-TEXT
-gergich citest
-
-You shouldn't need to run this locally, it runs on jenkins. It does the
-following:
-
-1. runs all the gergich commands (w/ dummy data)
-2. ensure all `help` commands work
-3. ensures gergich status is correct
-4. resets
-5. posts an actual +1
-6. publishes
+  help: -> {
+    <<~TEXT
+      gergich citest
+
+      You shouldn't need to run this locally, it runs on jenkins. It does the
+      following:
+
+      1. runs all the gergich commands (w/ dummy data)
+      2. ensure all `help` commands work
+      3. ensures gergich status is correct
+      4. resets
+      5. posts an actual +1
+      6. publishes
     TEXT
   }
 }

data/lib/gergich/cli/master_bouncer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "../cli"
 
 ENV["GERGICH_USER"] = ENV.fetch("MASTER_BOUNCER_USER", "master_bouncer")
@@ -19,7 +21,7 @@ def potentially_mergeable_changes
                     "branch:master" \
                  "&o=CURRENT_REVISION"
   changes = Gergich::API.get(url)
-  changes.select { |c| c["subject"] !~ /\Awip($|\W)/i }
+  changes.reject { |c| c["subject"] =~ /\Awip($|\W)/i }
 end
 
 def maybe_bounce_commit!(commit)
@@ -67,22 +69,22 @@ commands = {}
 
 commands["check"] = {
   summary: "Check the current commit's age",
-  action: ->() {
+  action: -> {
     maybe_bounce_commit! Gergich::Commit.new
   },
-  help: ->() {
-    <<-TEXT
-master_bouncer check
+  help: -> {
+    <<~TEXT
+      master_bouncer check
 
-Check the current commit's age, and bounce it if it's too old (-1 or -2,
-depending on the threshold)
-TEXT
+      Check the current commit's age, and bounce it if it's too old (-1 or -2,
+      depending on the threshold)
+    TEXT
   }
 }
 
 commands["check_all"] = {
   summary: "Check the age of all potentially mergeable changes",
-  action: ->() {
+  action: -> {
     Gergich.git("fetch")
     gerrit_host = ENV["GERRIT_HOST"] || error("No GERRIT_HOST set")
 
@@ -102,12 +104,12 @@ commands["check_all"] = {
       sleep 1
     end
   },
-  help: ->() {
-    <<-TEXT
-master_bouncer check_all
+  help: -> {
+    <<~TEXT
+      master_bouncer check_all
 
-Check all open Verified+1 patchsets and bounce any that are too old.
-TEXT
+      Check all open Verified+1 patchsets and bounce any that are too old.
+    TEXT
   }
 }
 

data/spec/gergich/capture/androidlint_capture_spec.rb

@@ -1,24 +1,27 @@
+# frozen_string_literal: true
+
 require_relative "../../support/capture_shared_examples"
 
 RSpec.describe Gergich::Capture::AndroidlintCapture do
-  # rubocop:disable Metrics/LineLength
+  # rubocop:disable Layout/LineLength
   let(:rtl_hardcoded) { 'Consider adding android:drawableStart="@drawable/a_media" to better support right-to-left layouts [RtlHardcoded]' }
   let(:rtl_enabled) { "The project references RTL attributes, but does not explicitly enable or disable RTL support with android:supportsRtl in the manifest [RtlEnabled]" }
   let(:lint_error) { 'No .class files were found in project "0.0.2", so none of the classfile based checks could be run. Does the project need to be built first? [LintError]' }
   let(:unused_quantity) { 'For language "fr" (French) the following quantities are not relevant: few, zero [UnusedQuantity]' }
+  # rubocop:enable Layout/LineLength
   let(:output) do
-    <<-OUTPUT
-/path/to/some.xml:27: Warning: #{rtl_hardcoded}
-    android:drawableLeft="@drawable/ic_cv_media"/>
-    ~~~~~~~~~~~~~~~~~~~~
+    <<~OUTPUT
+      /path/to/some.xml:27: Warning: #{rtl_hardcoded}
+          android:drawableLeft="@drawable/ic_cv_media"/>
+          ~~~~~~~~~~~~~~~~~~~~
 
-/path/to/AndroidManifest.xml: Warning: #{rtl_enabled}
+      /path/to/AndroidManifest.xml: Warning: #{rtl_enabled}
 
-/path/to/library/0.0.2: Error: #{lint_error}
+      /path/to/library/0.0.2: Error: #{lint_error}
 
-/path/to/values.xml:5: Warning: #{unused_quantity}
-    <plurals name="number">
-    ^
+      /path/to/values.xml:5: Warning: #{unused_quantity}
+          <plurals name="number">
+          ^
 
     OUTPUT
   end
@@ -28,7 +31,9 @@ RSpec.describe Gergich::Capture::AndroidlintCapture do
       {
         path: "/path/to/some.xml",
         position: 27,
+        # rubocop:disable Layout/LineLength
         message: "[androidlint] #{rtl_hardcoded}\n\n    android:drawableLeft=\"@drawable/ic_cv_media\"/>\n    ~~~~~~~~~~~~~~~~~~~~",
+        # rubocop:enable Layout/LineLength
         severity: "warn"
       },
       {