gergich 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfb1410453dc4f232425a565900e4054e6bd78e9
-  data.tar.gz: 4f0d4313f19a6ce70a7b23964b89f861df60fd52
+  metadata.gz: 899a2175e74f907763c70a483437eefd9bda8b2b
+  data.tar.gz: 77fad0f1d44722607d1cb6e1af67d15205a4ac16
 SHA512:
-  metadata.gz: ef08bf7c85453189cfa490ab83a958e6b6f4e9330bd523f964df3b2a2211a15703dafd07ca64f6b5faef006b60c0d88c90b85fe5c4e0ebdef8751c2635211258
-  data.tar.gz: e39a847e30678b76ed6bb51c1e900c01ac72359f2aca89f379a927cd4b9cceb39efecc22ddc4cf80dfea8f179790fdb9811da68389c58afbaa84d2e50da31986
+  metadata.gz: 163de2c94245b125515c2dec581e314db68fe6cfc42e0cc9b661c485818c6a03cf2ceb160a93bd9101e78d4564f0275c0697aa1decd3adf4d9e48e4e1f726570
+  data.tar.gz: ea96e37e0ea8ce2c3374f6354699116768ce87e45f01fd9a288a32aa2e4679d2b59914c76761c020691945f04d82af631749270072b51053a85c913d0dbcc1e3

data/README.md

@@ -103,6 +103,7 @@ do `gergich comment` calls so you don't have to wire it up yourself.
 * `eslint`
 * `i18nliner`
 * `flake8`
+* `stylelint`
 * `custom:<path>:<class_name>` - file path and ruby class_name of a custom
   formatter.
 

data/lib/gergich/capture.rb

@@ -1,7 +1,14 @@
+require "English"
+
 module Gergich
   module Capture
     class BaseCapture
       def self.inherited(subclass)
+        name = normalize_captor_class_name(subclass)
+        Capture.captors[name] = subclass
+      end
+
+      def self.normalize_captor_class_name(subclass)
         name = subclass.name
         # borrowed from AS underscore, since we may not have it
         name.gsub!(/.*::|Capture\z/, "")
@@ -9,7 +16,6 @@ module Gergich
         name.gsub!(/([a-z\d])([A-Z])/, "\\1_\\2")
         name.tr!("-", "_")
         name.downcase!
-        Capture.captors[name] = subclass
       end
     end
 

data/lib/gergich/capture/stylelint_capture.rb

@@ -0,0 +1,50 @@
+module Gergich
+  module Capture
+    class StylelintCapture < BaseCapture
+      # 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
+      #  3:17  ⚠  Expected "#owiehfi" to be "#OWIEHFI"      color-hex-case
+      #
+      # app/stylesheets/base/_variables.scss
+      #   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
+
+      SEVERITY_MAP = {
+        "✖" => "error",
+        "⚠" => "warn"
+      }.freeze
+
+      # example file line:
+      # app/stylesheets/base/_variables.scss
+      FILE_PATH_PATTERN = /([^\n]+)\n/
+
+      # 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/
+      # rubocop:enable Style/AsciiComments
+
+      PATTERN = /#{FILE_PATH_PATTERN}((#{ERROR_PATTERN})+)/
+
+      def run(output)
+        output.scan(PATTERN).map { |file, errors|
+          errors.scan(ERROR_PATTERN).map { |line, severity, error|
+            severity = SEVERITY_MAP[severity]
+            {
+              path: file,
+              message: "#{MESSAGE_PREFIX} #{error}",
+              position: line.to_i,
+              severity: severity
+            }
+          }
+        }.flatten.compact
+      end
+    end
+  end
+end

data/lib/gergich/cli/gergich.rb

@@ -205,6 +205,7 @@ do `gergich comment` calls so you don't have to wire it up yourself.
                   * eslint
                   * i18nliner
                   * flake8
+                  * stylelint
                   * custom:<path>:<class_name> - file path and ruby
                     class_name of a custom formatter.
 

data/spec/gergich/capture/androidlint_capture_spec.rb

@@ -0,0 +1,56 @@
+require_relative "../../support/capture_shared_examples"
+
+RSpec.describe Gergich::Capture::AndroidlintCapture do
+  # rubocop:disable Metrics/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]' }
+  let(:output) do
+    <<-OUTPUT
+/path/to/some.xml:27: Warning: #{rtl_hardcoded}
+    android:drawableLeft="@drawable/ic_cv_media"/>
+    ~~~~~~~~~~~~~~~~~~~~
+
+/path/to/AndroidManifest.xml: Warning: #{rtl_enabled}
+
+/path/to/library/0.0.2: Error: #{lint_error}
+
+/path/to/values.xml:5: Warning: #{unused_quantity}
+    <plurals name="number">
+    ^
+
+    OUTPUT
+  end
+
+  let(:comments) do
+    [
+      {
+        path: "/path/to/some.xml",
+        position: 27,
+        message: "[androidlint] #{rtl_hardcoded}\n\n    android:drawableLeft=\"@drawable/ic_cv_media\"/>\n    ~~~~~~~~~~~~~~~~~~~~",
+        severity: "warn"
+      },
+      {
+        path: "/path/to/AndroidManifest.xml",
+        position: 0,
+        message: "[androidlint] #{rtl_enabled}",
+        severity: "warn"
+      },
+      {
+        path: "/path/to/library/0.0.2",
+        position: 0,
+        message: "[androidlint] #{lint_error}",
+        severity: "error"
+      },
+      {
+        path: "/path/to/values.xml",
+        position: 5,
+        message: "[androidlint] #{unused_quantity}\n\n    <plurals name=\"number\">\n    ^",
+        severity: "warn"
+      }
+    ]
+  end
+
+  it_behaves_like "a captor"
+end

data/spec/gergich/capture/custom_capture_spec.rb

@@ -0,0 +1,39 @@
+require_relative "../../../lib/gergich/capture"
+
+RSpec.describe "CustomCaptor" do
+  class CustomCaptor
+    def run(output)
+      output.scan(/^(.+?):(\d+): (.*)$/).map do |file, line, error|
+        { path: file, message: error, position: line.to_i, severity: "error" }
+      end
+    end
+  end
+
+  let(:described_class) { CustomCaptor }
+  let(:capture_format) { "custom:sqlite3:CustomCaptor" }
+  let(:output) do
+    <<-OUTPUT
+foo.rb:1: you done screwed up
+    OUTPUT
+  end
+  let(:comments) do
+    [
+      {
+        path: "foo.rb",
+        position: 1,
+        message: "you done screwed up",
+        severity: "error"
+      }
+    ]
+  end
+
+  it "loads" do
+    captor = Gergich::Capture.load_captor(capture_format)
+    expect(captor).to eq(described_class)
+  end
+
+  it "catches errors" do
+    comments = subject.run(output)
+    expect(comments).to match_array(comments)
+  end
+end

data/spec/gergich/capture/eslint_capture_spec.rb

@@ -0,0 +1,29 @@
+require_relative "../../support/capture_shared_examples"
+
+RSpec.describe Gergich::Capture::EslintCapture do
+  let(:output) do
+    <<-OUTPUT
+jsapp/models/user.js
+  4:21  error    Missing semicolon  semi
+  5:1   warning  Too much cowbell   cowbell-overload
+    OUTPUT
+  end
+  let(:comments) do
+    [
+      {
+        path: "jsapp/models/user.js",
+        position: 4,
+        message: "[eslint] Missing semicolon",
+        severity: "error"
+      },
+      {
+        path: "jsapp/models/user.js",
+        position: 5,
+        message: "[eslint] Too much cowbell",
+        severity: "warn"
+      }
+    ]
+  end
+
+  it_behaves_like "a captor"
+end

data/spec/gergich/capture/flake8_capture_spec.rb

@@ -0,0 +1,21 @@
+require_relative "../../support/capture_shared_examples"
+
+RSpec.describe Gergich::Capture::Flake8Capture do
+  let(:output) do
+    <<-OUTPUT
+./djangogeneric/settings/base.py:73:80: E501 line too long (81 > 79 characters)
+    OUTPUT
+  end
+  let(:comments) do
+    [
+      {
+        path: "./djangogeneric/settings/base.py",
+        position: 73,
+        message: "[flake8] E501 line too long (81 > 79 characters)",
+        severity: "error"
+      }
+    ]
+  end
+
+  it_behaves_like "a captor"
+end

data/spec/gergich/capture/i18nliner_capture_spec.rb

@@ -0,0 +1,23 @@
+require_relative "../../support/capture_shared_examples"
+
+RSpec.describe Gergich::Capture::I18nlinerCapture do
+  let(:output) do
+    <<-OUTPUT
+1)
+invalid signature on line 4: <unsupported expression>
+jsapp/models/user.js
+    OUTPUT
+  end
+  let(:comments) do
+    [
+      {
+        path: "jsapp/models/user.js",
+        position: 4,
+        message: "[i18n] invalid signature: <unsupported expression>",
+        severity: "error"
+      }
+    ]
+  end
+
+  it_behaves_like "a captor"
+end

data/spec/gergich/capture/rubocop_capture_spec.rb

@@ -0,0 +1,37 @@
+require_relative "../../support/capture_shared_examples"
+
+RSpec.describe Gergich::Capture::RubocopCapture do
+  let(:output) do
+    <<-OUTPUT
+bin/gergich:47:8: C: Prefer double-quoted strings
+if ENV['DEBUG']
+       ^^^^^^^
+lib/gergich.rb:22:55: W: Line is too long. [55/54]
+    def initialize(ref = "HEAD", revision_number = nil)
+                                                     ^^
+    OUTPUT
+  end
+  let(:comments) do
+    [
+      {
+        path: "bin/gergich",
+        position: 47,
+        message: "[rubocop] Prefer double-quoted strings\n\n if ENV['DEBUG']\n        ^^^^^^^\n",
+        severity: "info"
+      },
+      {
+        path: "lib/gergich.rb",
+        position: 22,
+        message: <<-OUTPUT,
+        [rubocop] Line is too long. [55/54]
+
+             def initialize(ref = "HEAD", revision_number = nil)
+                                                              ^^
+        OUTPUT
+        severity: "warn"
+      }
+    ]
+  end
+
+  it_behaves_like "a captor"
+end

data/spec/gergich/capture/stylelint_capture_spec.rb

@@ -0,0 +1,45 @@
+require_relative "../../support/capture_shared_examples"
+
+RSpec.describe Gergich::Capture::StylelintCapture do
+  let(:output) do
+    <<-OUTPUT
+app/stylesheets/base/_print.scss
+ 3:17  ✖  Unexpected invalid hex color "#owiehfi"   color-no-invalid-hex
+ 3:17  ⚠  Expected "#owiehfi" to be "#OWIEHFI"      color-hex-case
+
+app/stylesheets/base/_variables.scss
+  2:15  ✖  Unexpected invalid hex color "#2D3B4"   color-no-invalid-hex
+ 30:15  ⚠  Expected "#2d3b4a" to be "#2D3B4A"      color-hex-case
+    OUTPUT
+  end
+  let(:comments) do
+    [
+      {
+        path: "app/stylesheets/base/_print.scss",
+        position: 3,
+        message: "[stylelint] Unexpected invalid hex color \"#owiehfi\"",
+        severity: "error"
+      },
+      {
+        path: "app/stylesheets/base/_print.scss",
+        position: 3,
+        message: "[stylelint] Expected \"#owiehfi\" to be \"#OWIEHFI\"",
+        severity: "warn"
+      },
+      {
+        path: "app/stylesheets/base/_variables.scss",
+        position: 2,
+        message: "[stylelint] Unexpected invalid hex color \"#2D3B4\"",
+        severity: "error"
+      },
+      {
+        path: "app/stylesheets/base/_variables.scss",
+        position: 30,
+        message: "[stylelint] Expected \"#2d3b4a\" to be \"#2D3B4A\"",
+        severity: "warn"
+      }
+    ]
+  end
+
+  it_behaves_like "a captor"
+end

data/spec/gergich/capture/swiftlint_capture_spec.rb

@@ -0,0 +1,39 @@
+require_relative "../../support/capture_shared_examples"
+
+RSpec.describe Gergich::Capture::SwiftlintCapture do
+  # rubocop:disable Metrics/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)" }
+  let(:output) do
+    <<-OUTPUT
+/path/to/My.swift:13:22: warning: #{colon_violation}
+/path/to/Fail.swift:76: warning: #{line_length_violation}
+/path/to/Cast.swift:15:9: error: #{force_cast_violation}
+    OUTPUT
+  end
+  let(:comments) do
+    [
+      {
+        path: "/path/to/My.swift",
+        position: 13,
+        message: "[swiftlint] #{colon_violation}",
+        severity: "warn"
+      },
+      {
+        path: "/path/to/Fail.swift",
+        position: 76,
+        message: "[swiftlint] #{line_length_violation}",
+        severity: "warn"
+      },
+      {
+        path: "/path/to/Cast.swift",
+        position: 15,
+        message: "[swiftlint] #{force_cast_violation}",
+        severity: "error"
+      }
+    ]
+  end
+
+  it_behaves_like "a captor"
+end

data/spec/gergich/capture_spec.rb

@@ -1,189 +1,10 @@
 require_relative "../../lib/gergich/capture"
-require_relative "../../lib/gergich"
 
 RSpec.describe Gergich::Capture do
   let!(:draft) { double }
 
   before do
     allow(Gergich::Draft).to receive(:new).and_return(draft)
-    $stdout = StringIO.new
-  end
-
-  after do
-    $stdout = STDOUT
-  end
-
-  context "rubocop" do
-    it "should catch errors" do
-      allow(described_class).to receive(:run_command).and_return([0, <<-OUTPUT])
-bin/gergich:47:8: C: Prefer double-quoted strings
-if ENV['DEBUG']
-       ^^^^^^^
-lib/gergich.rb:22:55: W: Line is too long. [55/54]
-    def initialize(ref = "HEAD", revision_number = nil)
-                                                     ^^
-OUTPUT
-      expect(draft).to receive(:add_comment).with(
-        "bin/gergich",
-        47,
-        "[rubocop] Prefer double-quoted strings\n\n if ENV['DEBUG']\n        ^^^^^^^\n",
-        "info"
-      )
-      expect(draft).to receive(:add_comment)
-        .with("lib/gergich.rb", 22, <<-OUTPUT, "warn")
-[rubocop] Line is too long. [55/54]
-
-     def initialize(ref = "HEAD", revision_number = nil)
-                                                      ^^
-OUTPUT
-      described_class.run("rubocop", "false")
-    end
-  end
-
-  # rubocop:disable Metrics/LineLength
-  context "swiftlint" do
-    it "should catch errors" do
-      colon_violation = "Colon Violation: Colons should be next to the identifier when specifying a type. (colon)"
-      line_length_violation = "Line Length Violation: Line should be 100 characters or less: currently 129 characters (line_length)"
-      force_cast_violation = "Force Cast Violation: Force casts should be avoided. (force_cast)"
-      allow(described_class).to receive(:run_command).and_return([0, <<-OUTPUT])
-/path/to/My.swift:13:22: warning: #{colon_violation}
-/path/to/Fail.swift:76: warning: #{line_length_violation}
-/path/to/Cast.swift:15:9: error: #{force_cast_violation}
-      OUTPUT
-      expect(draft).to receive(:add_comment).with(
-        "/path/to/My.swift",
-        13,
-        "[swiftlint] #{colon_violation}",
-        "warn"
-      )
-      expect(draft).to receive(:add_comment).with(
-        "/path/to/Fail.swift",
-        76,
-        "[swiftlint] #{line_length_violation}",
-        "warn"
-      )
-      expect(draft).to receive(:add_comment).with(
-        "/path/to/Cast.swift",
-        15,
-        "[swiftlint] #{force_cast_violation}",
-        "error"
-      )
-      described_class.run("swiftlint", "false")
-    end
-  end
-
-  context "androidlint" do
-    it "should catch errors" do
-      rtl_hardcoded = 'Consider adding android:drawableStart="@drawable/a_media" to better support right-to-left layouts [RtlHardcoded]'
-      rtl_enabled = "The project references RTL attributes, but does not explicitly enable or disable RTL support with android:supportsRtl in the manifest [RtlEnabled]"
-      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]'
-      unused_quantity = 'For language "fr" (French) the following quantities are not relevant: few, zero [UnusedQuantity]'
-      allow(described_class).to receive(:run_command).and_return([0, <<-OUTPUT])
-/path/to/some.xml:27: Warning: #{rtl_hardcoded}
-    android:drawableLeft="@drawable/ic_cv_media"/>
-    ~~~~~~~~~~~~~~~~~~~~
-
-/path/to/AndroidManifest.xml: Warning: #{rtl_enabled}
-
-/path/to/library/0.0.2: Error: #{lint_error}
-
-/path/to/values.xml:5: Warning: #{unused_quantity}
-    <plurals name="number">
-    ^
-
-      OUTPUT
-      expect(draft).to receive(:add_comment).with(
-        "/path/to/some.xml",
-        27,
-        "[androidlint] #{rtl_hardcoded}\n\n    android:drawableLeft=\"@drawable/ic_cv_media\"/>\n    ~~~~~~~~~~~~~~~~~~~~",
-        "warn"
-      )
-      expect(draft).to receive(:add_comment).with(
-        "/path/to/AndroidManifest.xml",
-        0,
-        "[androidlint] #{rtl_enabled}",
-        "warn"
-      )
-      expect(draft).to receive(:add_comment).with(
-        "/path/to/library/0.0.2",
-        0,
-        "[androidlint] #{lint_error}",
-        "error"
-      )
-      expect(draft).to receive(:add_comment).with(
-        "/path/to/values.xml",
-        5,
-        "[androidlint] #{unused_quantity}\n\n    <plurals name=\"number\">\n    ^",
-        "warn"
-      )
-      described_class.run("androidlint", "false")
-    end
-  end
-
-  context "eslint" do
-    it "should catch errors" do
-      allow(described_class).to receive(:run_command).and_return([0, <<-OUTPUT])
-jsapp/models/user.js
-  4:21  error    Missing semicolon  semi
-  5:1   warning  Too much cowbell   cowbell-overload
-OUTPUT
-      expect(draft).to receive(:add_comment).with(
-        "jsapp/models/user.js",
-        4,
-        "[eslint] Missing semicolon",
-        "error"
-      )
-
-      expect(draft).to receive(:add_comment).with(
-        "jsapp/models/user.js",
-        5,
-        "[eslint] Too much cowbell",
-        "warn"
-      )
-      described_class.run("eslint", "false")
-    end
-  end
-
-  context "i18nliner" do
-    it "should catch errors" do
-      allow(described_class).to receive(:run_command).and_return([0, <<-OUTPUT])
-1)
-invalid signature on line 4: <unsupported expression>
-jsapp/models/user.js
-OUTPUT
-      expect(draft).to receive(:add_comment).with(
-        "jsapp/models/user.js",
-        4,
-        "[i18n] invalid signature: <unsupported expression>",
-        "error"
-      )
-      described_class.run("i18nliner", "false")
-    end
-  end
-
-  context "custom" do
-    class CustomCaptor
-      def run(output)
-        puts output
-        output.scan(/^(.+?):(\d+): (.*)$/).map do |file, line, error|
-          { path: file, message: error, position: line.to_i, severity: "error" }
-        end
-      end
-    end
-
-    it "should catch errors" do
-      allow(described_class).to receive(:run_command).and_return([0, <<-OUTPUT])
-foo.rb:1: you done screwed up
-OUTPUT
-      expect(draft).to receive(:add_comment).with(
-        "foo.rb",
-        1,
-        "you done screwed up",
-        "error"
-      )
-      described_class.run("custom:sqlite3:CustomCaptor", "false")
-    end
   end
 
   context "stdin" do

data/spec/gergich_spec.rb

@@ -1,5 +1,3 @@
-require_relative "../lib/gergich"
-
 RSpec.describe Gergich::API do
   let(:result) { double(:result, { body: "Not Found: 1234" }) }
 

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require "simplecov" if ENV["COVERAGE"]
+require_relative "../lib/gergich"
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

data/spec/support/capture_shared_examples.rb

@@ -0,0 +1,17 @@
+require_relative "../../lib/gergich/capture"
+
+RSpec.shared_examples_for "a captor" do
+  let(:capture_format) do
+    Gergich::Capture::BaseCapture.normalize_captor_class_name(described_class)
+  end
+
+  it "loads" do
+    captor = Gergich::Capture.load_captor(capture_format)
+    expect(captor).to eq(described_class)
+  end
+
+  it "catches errors" do
+    comments = subject.run(output)
+    expect(comments).to match_array(comments)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gergich
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Jon Jensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -60,13 +60,23 @@ files:
 - lib/gergich/capture/flake8_capture.rb
 - lib/gergich/capture/i18nliner_capture.rb
 - lib/gergich/capture/rubocop_capture.rb
+- lib/gergich/capture/stylelint_capture.rb
 - lib/gergich/capture/swiftlint_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/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/stylelint_capture_spec.rb
+- spec/gergich/capture/swiftlint_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
@@ -87,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Command-line tool for adding Gerrit comments