gergich 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f81bdfdf24629e16b6af3486388f244e73aa43721febfb8e959af52cba8efbe
-  data.tar.gz: f13157b630762c91edfcdeb342aac476f62af114cad2edbb40b18a0814060b7e
+  metadata.gz: 209022ec9ca1bfed90a33f905f9d0e36f016b7f25485e66041e276ff393fec6e
+  data.tar.gz: f6477fb1a8f75192b6f516cfe1197db7800a3b221a703d71da7a1204db3a23bc
 SHA512:
-  metadata.gz: 81e0ce4960ce3338693de120d489d7e045ddac8c57c5c20331ca6f6e30daf68dc162dcadd158e0c39838f0b3a6a6bc906f837ab9e55da0e68185b9ed999c3516
-  data.tar.gz: '0687478859b3e572d5f0e888c93cd8d5e0965cc546f9dd6a688a1050d4eb4174b189214dd9f3f581f9c3df8392bcb903b81101de76f85b53c3c387a72b6523e8'
+  metadata.gz: f6ffba5044485692318eb057407f9d6032eccd9118942233e34b3d727201784ca2111c56adb1e5ce306814916d90585b6341ff19eeb1df6c1cc0bf98d4b6b5df
+  data.tar.gz: f7b5f8e726eabc13f722da011df51d7c0fb137480130573819c928d1bca02057f91330d995cbda0a7ad8ad7661ee28a026a3df12f5d87911f2848f9cfd369113

data/README.md

@@ -106,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/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/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/cli/gergich.rb

@@ -18,6 +18,7 @@ CI_TEST_ARGS = {
     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]
@@ -370,6 +370,7 @@ module Gergich
 
     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/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/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") }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gergich
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Jon Jensen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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
@@ -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,8 +172,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.24
+signing_key:
 specification_version: 4
 summary: Command-line tool for adding Gerrit comments
 test_files: []