gergich 0.2.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dc6e202255732bf23a6df2c75e18250897744e99
-  data.tar.gz: 1942f228ae335675740fa7ae626a92204ce7e7a5
+SHA256:
+  metadata.gz: 9f81bdfdf24629e16b6af3486388f244e73aa43721febfb8e959af52cba8efbe
+  data.tar.gz: f13157b630762c91edfcdeb342aac476f62af114cad2edbb40b18a0814060b7e
 SHA512:
-  metadata.gz: 88c9113246e2e97fda409346032d88de432c910c360ec72c28b368e33e9bb34606663f2588601ef2be3e4bdab18644eac6498cc94749404dc941a373b0865238
-  data.tar.gz: d3266350ace476809d572e191275a7a18dab184d48954f8e3407680f8ec2b3e5840524c3c626d98ea6f7bd970ca21fa7a46108c67894d6e75153de430ef9ce28
+  metadata.gz: 81e0ce4960ce3338693de120d489d7e045ddac8c57c5c20331ca6f6e30daf68dc162dcadd158e0c39838f0b3a6a6bc906f837ab9e55da0e68185b9ed999c3516
+  data.tar.gz: '0687478859b3e572d5f0e888c93cd8d5e0965cc546f9dd6a688a1050d4eb4174b189214dd9f3f581f9c3df8392bcb903b81101de76f85b53c3c387a72b6523e8'

data/LICENSE

@@ -13,8 +13,8 @@ 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 PURPOa AND
-NONINFRINGEMENT. IN NO EVENT SaALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+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.

data/README.md

@@ -1,7 +1,6 @@
 # Gergich
 
 [![Gem Version](https://badge.fury.io/rb/gergich.svg)](https://rubygems.org/gems/gergich)
-[![Dependency Status](https://gemnasium.com/badges/a2946a7849cd94f5ec0f4c3173a968f4.svg)](https://gemnasium.com/cc6fb44edee9fcf855cec82d3b6aed0f)
 [![Build Status](https://travis-ci.org/instructure/gergich.svg?branch=master)](https://travis-ci.org/instructure/gergich)
 
 Gergich is a command-line tool (and ruby lib) for easily posting comments

data/bin/check_coverage

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "simplecov"
 
 SimpleCov.command_name "check_coverage"
-SimpleCov.minimum_coverage 90
+SimpleCov.minimum_coverage 85
 SimpleCov.at_exit { SimpleCov.result.format! }

data/bin/gergich

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 if ENV["COVERAGE"]
   require "simplecov"

data/bin/master_bouncer

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# encoding=utf-8
+# frozen_string_literal: true
 
 if ENV["COVERAGE"]
   require "simplecov"

data/bin/run_tests.sh

@@ -2,56 +2,21 @@
 
 set -e
 
-function run_command {
-  echo -e "\n[$@] STARTING $(date)"
-  last_status=0
-  "$@" || last_status=$?
-  if [[ $last_status == 0 ]]; then
-    echo -e "[$@] \033[32mOK\033[0m"
-  else
-    echo -e "[$@] \033[31mFAILED!\033[0m"
-  fi
-  echo -e "[$@] FINISHED $(date)\n"
+bundle exec rubocop --fail-level autocorrect
 
-  [[ $last_status == 0 ]] || clean_up_and_exit
-}
+ruby -v | egrep "^ruby 2\.4" && export COVERAGE=1
 
-function clean_up_and_exit {
-  end_timestamp=$(date +%s)
-  duration=$((end_timestamp-start_timestamp))
-
-  if [[ $last_status != 0 ]]; then
-    echo -e "\033[31mBUILD FAILED\033[0m in $duration seconds\n"
-  else
-    echo "BUILD PASSED in $duration seconds"
-  fi
-  exit $last_status
-}
-
-start_timestamp=$(date +%s)
-
-run_command bundle exec rubocop
-
-export COVERAGE=1
-
-run_command bundle exec rspec
+bundle exec rspec
 
 # these actually hit gerrit; only run them in CI land (you can do it
 # locally if you set all the docker-compose env vars)
 if [[ "$GERRIT_PATCHSET_REVISION" ]]; then
-  run_command bin/gergich citest
-  run_command bin/master_bouncer check
-  DRY_RUN=1 run_command bin/master_bouncer check_all
+  bundle exec bin/gergich citest
+  bundle exec bin/master_bouncer check
+  DRY_RUN=1 bundle exec bin/master_bouncer check_all
   # ensure gergich works without .git directories
   rm -rf .git
-  run_command bin/gergich status
-fi
-
-run_command bin/check_coverage
-
-if [[ "$GEMNASIUM_TOKEN" && "$GEMNASIUM_ENABLED" ]]; then
-  # Push our dependency specification files to gemnasium for analysis
-  run_command gemnasium dependency_files push -f=gergich.gemspec
+  bundle exec bin/gergich status
 fi
 
-clean_up_and_exit
+bundle exec bin/check_coverage

data/lib/gergich.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "erb"
 require "sqlite3"
 require "json"
@@ -105,18 +107,9 @@ module Gergich
 
       API.post(generate_url, generate_payload)
 
-      # because why not
-      if change_name?
-        API.put("/accounts/self/name", { name: whats_his_face }.to_json)
-      end
-
       review_info
     end
 
-    def change_name?
-      ENV["GERGICH_CHANGE_NAME"] != "0" && rand < 0.01 && GERGICH_USER == "gergich"
-    end
-
     def anything_to_publish?
       !review_info[:comments].empty? ||
         !review_info[:cover_message_parts].empty? ||
@@ -202,7 +195,7 @@ module Gergich
     end
 
     def my_messages
-      @messages ||= API.get("/changes/#{commit.change_id}/detail")["messages"]
+      @my_messages ||= API.get("/changes/#{commit.change_id}/detail")["messages"]
         .select { |message| message["author"] && message["author"]["username"] == GERGICH_USER }
     end
 
@@ -227,6 +220,7 @@ module Gergich
     # then grab the comment's revision.
     def current_label_revision
       return nil if my_messages.empty?
+
       @current_label_revision ||= begin
         date = current_label_date
         comment_for_current_label = my_messages.find { |message| message["date"] == date } ||
@@ -254,17 +248,13 @@ module Gergich
       score = upcoming_score
       prefix_parts = []
       prefix_parts << unique_comment_prefix if multi_build_setup?
-      prefix_parts << score if score < 0
+      prefix_parts << score if score.negative?
       prefix_parts.join(":")
       # [].join(":") => ""
       # [-2].join(":") => "-2"
       # ["some build prefix", -2].join(":") => "some build prefix:-2"
     end
 
-    def whats_his_face
-      "#{%w[Garry Larry Terry Jerry].sample} Gergich (Bot)"
-    end
-
     def review_info
       @review_info ||= draft.info
     end
@@ -306,7 +296,8 @@ module Gergich
         ret = HTTParty.send(method, url, options).body
         return ret if options[:raw]
 
-        if ret.sub!(/\A\)\]\}'\n/, "") && ret =~ /\A("|\[|\{)/
+        ret = ret.sub(/\A\)\]\}'\n/, "")
+        if ret && ret =~ /\A("|\[|\{)/
           JSON.parse("[#{ret}]")[0] # array hack so we can parse a string literal
         elsif ret =~ /Not found: (?<change_id>.*)/i
           raise("Cannot find Change-Id: #{Regexp.last_match[:change_id]} at #{url}.\n"\
@@ -321,7 +312,7 @@ module Gergich
       end
 
       def base_uri
-        @base_url ||= \
+        @base_uri ||= \
           ENV["GERRIT_BASE_URL"] ||
           ENV.key?("GERRIT_HOST") && "https://#{ENV['GERRIT_HOST']}" ||
           raise(GergichError, "need to set GERRIT_BASE_URL or GERRIT_HOST")
@@ -372,7 +363,9 @@ 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
@@ -452,13 +445,16 @@ module Gergich
     #            severe comment will be used to determine the overall
     #            Code-Review score (0, -1, or -2 respectively)
     def add_comment(path, position, message, severity)
+      stripped_path = path.strip
+
       raise GergichError, "invalid position `#{position}`" unless valid_position?(position)
+
       position = position.to_json if position.is_a?(Hash)
       raise GergichError, "invalid severity `#{severity}`" unless SEVERITY_MAP.key?(severity)
       raise GergichError, "no message specified" unless message.is_a?(String) && !message.empty?
 
       db.execute "INSERT INTO comments (path, position, message, severity) VALUES (?, ?, ?, ?)",
-                 [path, position, message, severity]
+                 [stripped_path, position, message, severity]
     end
 
     POSITION_KEYS = %w[end_character end_line start_character start_line].freeze
@@ -478,7 +474,7 @@ module Gergich
           labels[row["name"]] = row["score"]
         end
         score = min_comment_score
-        labels[GERGICH_REVIEW_LABEL] = score if score < 0 && score < labels[GERGICH_REVIEW_LABEL]
+        labels[GERGICH_REVIEW_LABEL] = score if score < [0, labels[GERGICH_REVIEW_LABEL]].min
         labels
       end
     end
@@ -535,21 +531,21 @@ module Gergich
     end
 
     def orphaned_message
-      message = "NOTE: I couldn't create inline comments for everything. " \
+      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):"
+                "generated from stuff you *did* change):"]
 
       other_comments.each do |file|
         file.comments.each do |position, comments|
           comments.each do |comment|
             line = position.is_a?(Integer) ? position : position["start_line"]
-            message << "\n\n#{file.path}:#{line}: #{comment}"
+            messages << "#{file.path}:#{line}: #{comment}"
           end
         end
       end
 
-      message
+      messages.join("\n\n")
     end
 
     def cover_message_parts

data/lib/gergich/capture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "../gergich"
 require "English"
 
@@ -10,7 +12,7 @@ module Gergich
       end
 
       def self.normalize_captor_class_name(subclass)
-        name = subclass.name
+        name = subclass.name.dup
         # borrowed from AS underscore, since we may not have it
         name.gsub!(/.*::|Capture\z/, "")
         name.gsub!(/([A-Z\d]+)([A-Z][a-z])/, "\\1_\\2")
@@ -35,6 +37,7 @@ module Gergich
         if add_comments
           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]
           end
@@ -67,12 +70,12 @@ module Gergich
       end
 
       def wiretap(io, suppress_output)
-        output = ""
+        output = []
         io.each do |line|
           $stdout.puts line unless suppress_output
           output << line
         end
-        output
+        output.join("")
       end
 
       def load_captor(format)
@@ -81,6 +84,7 @@ module Gergich
         else
           captor = captors[format]
           raise GergichError, "Unrecognized format `#{format}`" unless captor
+
           captor
         end
       end
@@ -105,4 +109,4 @@ module Gergich
   end
 end
 
-Dir[File.dirname(__FILE__) + "/capture/*.rb"].each { |file| require file }
+Dir[File.dirname(__FILE__) + "/capture/*.rb"].sort.each { |file| require file }

data/lib/gergich/capture/androidlint_capture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gergich
   module Capture
     class AndroidlintCapture < BaseCapture
@@ -9,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]
@@ -23,6 +25,8 @@ module Gergich
         # /path/to/values.xml:5: Warning: For language "fr" (French) the following quantities are not relevant: few, zero [UnusedQuantity]
         #    <plurals name="number">
         #    ^
+        #
+        # rubocop:enable Layout/LineLength
         pattern = /
           ^([^:\n]+):(\d+)?:?\s(\w+):\s(.*?)\n
           ([^\n]+\n

data/lib/gergich/capture/brakeman_capture.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Gergich
   module Capture
     class BrakemanCapture < BaseCapture
       # Map Brakeman "confidence level" to severity.
       # http://brakemanscanner.org/docs/confidence/
       SEVERITY_MAP = {
-        "Weak"   => "warn",
+        "Weak" => "warn",
         "Medium" => "warn",
-        "High"   => "error"
+        "High" => "error"
       }.freeze
 
       def run(output)

data/lib/gergich/capture/eslint_capture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gergich
   module Capture
     class EslintCapture < BaseCapture

data/lib/gergich/capture/flake8_capture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gergich
   module Capture
     class Flake8Capture < BaseCapture

data/lib/gergich/capture/i18nliner_capture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gergich
   module Capture
     class I18nlinerCapture < BaseCapture

data/lib/gergich/capture/rubocop_capture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gergich
   module Capture
     class RubocopCapture < BaseCapture

data/lib/gergich/capture/shellcheck_capture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 
 module Gergich

data/lib/gergich/capture/stylelint_capture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gergich
   module Capture
     class StylelintCapture < BaseCapture
@@ -14,23 +16,24 @@ 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]".freeze
+      MESSAGE_PREFIX = "[stylelint]"
 
       SEVERITY_MAP = {
         "✖" => "error",
-        "⚠" => "warn"
+        "⚠" => "warn",
+        "ℹ" => "info"
       }.freeze
 
       # example file line:
       # app/stylesheets/base/_variables.scss
-      FILE_PATH_PATTERN = /([^\n]+)\n/
+      FILE_PATH_PATTERN = /([^\n]+)\n/.freeze
 
       # 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/
+      ERROR_PATTERN = /^\s+(\d+):\d+\s+(✖|⚠|ℹ)\s+(.*?)\s\s+[^\n]+\n/.freeze
       # rubocop:enable Style/AsciiComments
 
-      PATTERN = /#{FILE_PATH_PATTERN}((#{ERROR_PATTERN})+)/
+      PATTERN = /#{FILE_PATH_PATTERN}((#{ERROR_PATTERN})+)/.freeze
 
       def run(output)
         output.scan(PATTERN).map { |file, errors|

data/lib/gergich/capture/swiftlint_capture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gergich
   module Capture
     class SwiftlintCapture < BaseCapture
@@ -10,11 +12,13 @@ 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 Layout/LineLength
         pattern = /
           ^([^:\n]+):(\d+)(?::\d+)?:\s(\w+):\s(.*?)\n
         /mx