gergich 1.1.0 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffdbc2a21d3ed536da68e308de2725ce8d2a8d1984125fe222fffd2534a2a5ee
-  data.tar.gz: b404be4990fad059d5ef41885587a477a67af54b08ec0cc79f105bb8da460383
+  metadata.gz: 209022ec9ca1bfed90a33f905f9d0e36f016b7f25485e66041e276ff393fec6e
+  data.tar.gz: f6477fb1a8f75192b6f516cfe1197db7800a3b221a703d71da7a1204db3a23bc
 SHA512:
-  metadata.gz: e35654c3f320bd82918e7a8338cfa5a0a81f050e978cfe662f91b9f9c634e4e9017bec7779918b022e578f07bf4372ef1c227e7e40d6abaa395ca5abcff7bcb5
-  data.tar.gz: f04f09c89a36d7ebcde2e5d2b4e4e56414281b1013fa671a91a27b793d3855e54e97268445c3f0eadcd5916ec622506ef196b90e5d58b7132845fce7f7336595
+  metadata.gz: f6ffba5044485692318eb057407f9d6032eccd9118942233e34b3d727201784ca2111c56adb1e5ce306814916d90585b6341ff19eeb1df6c1cc0bf98d4b6b5df
+  data.tar.gz: f7b5f8e726eabc13f722da011df51d7c0fb137480130573819c928d1bca02057f91330d995cbda0a7ad8ad7661ee28a026a3df12f5d87911f2848f9cfd369113

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
@@ -107,6 +106,7 @@ do `gergich comment` calls so you don't have to wire it up yourself.
 * `i18nliner`
 * `flake8`
 * `stylelint`
+* `yamllint`
 * `shellcheck` - shellcheck json output
 * `custom:<path>:<class_name>` - file path and ruby class_name of a custom
   formatter.

data/bin/run_tests.sh

@@ -2,51 +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
+  bundle exec bin/gergich status
 fi
 
-run_command bin/check_coverage
-
-clean_up_and_exit
+bundle exec bin/check_coverage

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

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?

data/lib/gergich/capture/swiftlint_capture.rb

@@ -12,13 +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 Metrics/LineLength
+        # rubocop:enable Layout/LineLength
         pattern = /
           ^([^:\n]+):(\d+)(?::\d+)?:\s(\w+):\s(.*?)\n
         /mx

data/lib/gergich/capture/yamllint_capture.rb

@@ -0,0 +1,25 @@
+# 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: "[yamllint] #{error}", position: line.to_i, severity: severity }
+          }
+        }.compact.flatten
+      end
+    end
+  end
+end

data/lib/gergich/capture.rb

@@ -12,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")
@@ -109,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/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
 
@@ -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.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")
@@ -292,6 +290,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]
@@ -363,11 +363,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

data/spec/gergich/capture/androidlint_capture_spec.rb

@@ -3,12 +3,12 @@
 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 Metrics/LineLength
+  # rubocop:enable Layout/LineLength
   let(:output) do
     <<~OUTPUT
       /path/to/some.xml:27: Warning: #{rtl_hardcoded}
@@ -31,9 +31,9 @@ RSpec.describe Gergich::Capture::AndroidlintCapture do
       {
         path: "/path/to/some.xml",
         position: 27,
-        # rubocop:disable Metrics/LineLength
+        # rubocop:disable Layout/LineLength
         message: "[androidlint] #{rtl_hardcoded}\n\n    android:drawableLeft=\"@drawable/ic_cv_media\"/>\n    ~~~~~~~~~~~~~~~~~~~~",
-        # rubocop:enable Metrics/LineLength
+        # rubocop:enable Layout/LineLength
         severity: "warn"
       },
       {

data/spec/gergich/capture/rubocop_capture_spec.rb

@@ -19,6 +19,8 @@ RSpec.describe Gergich::Capture::RubocopCapture do
       lib/gergich.rb:22:55: W: Line is too long. [55/54]
           def initialize(ref = "HEAD", revision_number = nil)
                                                            ^^
+
+      1 file inspected, 35 offenses detected, 27 offenses auto-correctable
     OUTPUT
   end
   let(:comments) do
@@ -63,4 +65,11 @@ RSpec.describe Gergich::Capture::RubocopCapture do
   end
 
   it_behaves_like "a captor"
+
+  it "raises an error if it couldn't run" do
+    expect { subject.run(<<-OUTPUT) }.to raise_error(/RuboCop failed to run properly/)
+      Could not find i18n-1.8.9 in any of the sources
+      Run `bundle install` to install missing gems.
+    OUTPUT
+  end
 end

data/spec/gergich/capture/swiftlint_capture_spec.rb

@@ -3,11 +3,11 @@
 require_relative "../../support/capture_shared_examples"
 
 RSpec.describe Gergich::Capture::SwiftlintCapture do
-  # rubocop:disable Metrics/LineLength
+  # rubocop:disable Layout/LineLength
   let(:colon_violation) { "Colon Violation: Colons should be next to the identifier when specifying a type. (colon)" }
   let(:line_length_violation) { "Line Length Violation: Line should be 100 characters or less: currently 129 characters (line_length)" }
   let(:force_cast_violation) { "Force Cast Violation: Force casts should be avoided. (force_cast)" }
-  # rubocop:enable Metrics/LineLength
+  # rubocop:enable Layout/LineLength
   let(:output) do
     <<~OUTPUT
       /path/to/My.swift:13:22: warning: #{colon_violation}

data/spec/gergich/capture/yamllint_capture_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "../../support/capture_shared_examples"
+
+RSpec.describe Gergich::Capture::YamllintCapture do
+  let(:output) do
+    <<~OUTPUT
+      ./api/config/lti/development/config.yml
+        2:8       error    string value is redundantly quoted with double quotes  (quoted-strings)
+        12:3      warning  comment not indented like content  (comments-indentation)
+    OUTPUT
+  end
+  let(:comments) do
+    [
+      {
+        path: "api/config/lti/development/config.yml",
+        position: 2,
+        message: "[yamllint] string value is redundantly quoted with double quotes",
+        severity: "error"
+      },
+      {
+        path: "api/config/lti/development/config.yml",
+        position: 12,
+        message: "[yamllint] comment not indented like content",
+        severity: "warn"
+      }
+    ]
+  end
+
+  it_behaves_like "a captor"
+end

data/spec/gergich_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "httparty"
+
 RSpec.describe Gergich::API do
   context "bad change-id" do
     let(:result) { double(:result, body: "Not Found: 1234") }
@@ -90,6 +92,21 @@ RSpec.describe Gergich::Draft do
     draft.reset!
   end
 
+  context "#GERGICH_DB_PATH" do
+    it "uses the custom path" do
+      original_db_path = ENV["GERGICH_DB_PATH"]
+      ENV["GERGICH_DB_PATH"] = "/custom"
+
+      expect(draft.db_file).to eq("/custom/gergich-test.sqlite3")
+
+      ENV["GERGICH_DB_PATH"] = original_db_path
+    end
+
+    it "uses the default path" do
+      expect(draft.db_file).to eq("/tmp/gergich-test.sqlite3")
+    end
+  end
+
   describe "#info" do
     subject { draft.info }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gergich
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.3
 platform: ruby
 authors:
 - Jon Jensen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-10 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,84 +16,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.1
 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
@@ -120,6 +134,7 @@ files:
 - lib/gergich/capture/shellcheck_capture.rb
 - lib/gergich/capture/stylelint_capture.rb
 - lib/gergich/capture/swiftlint_capture.rb
+- lib/gergich/capture/yamllint_capture.rb
 - lib/gergich/cli.rb
 - lib/gergich/cli/gergich.rb
 - lib/gergich/cli/master_bouncer.rb
@@ -133,6 +148,7 @@ files:
 - 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
@@ -141,7 +157,7 @@ homepage: https://github.com/instructure/gergich
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,9 +172,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.2.24
+signing_key:
 specification_version: 4
 summary: Command-line tool for adding Gerrit comments
 test_files: []