gergich 0.2.2 → 1.2.1

data/spec/gergich/capture/brakeman_capture_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "../../support/capture_shared_examples"
 
 RSpec.describe Gergich::Capture::BrakemanCapture do
@@ -10,75 +12,75 @@ RSpec.describe Gergich::Capture::BrakemanCapture do
   let(:comments) do
     [
       {
-        path:     "app/models/custom_data.rb",
+        path: "app/models/custom_data.rb",
         position: 36,
-        message:  <<-MESSAGE.strip,
-[brakeman] Attribute Restriction: attr_accessible is recommended over attr_protected
-  See: http://brakemanscanner.org/docs/warning_types/attribute_restriction/
-                  MESSAGE
+        message: <<~MESSAGE.strip,
+          [brakeman] Attribute Restriction: attr_accessible is recommended over attr_protected
+            See: http://brakemanscanner.org/docs/warning_types/attribute_restriction/
+        MESSAGE
         severity: "warn"
       },
       {
-        path:     "app/models/submission_comment.rb",
+        path: "app/models/submission_comment.rb",
         position: 0,
-        message:  <<-MESSAGE.strip,
-[brakeman] Mass Assignment: Potentially dangerous attribute available for mass assignment
-  Code: :context_id
-  See: http://brakemanscanner.org/docs/warning_types/mass_assignment/
-                  MESSAGE
+        message: <<~MESSAGE.strip,
+          [brakeman] Mass Assignment: Potentially dangerous attribute available for mass assignment
+            Code: :context_id
+            See: http://brakemanscanner.org/docs/warning_types/mass_assignment/
+        MESSAGE
         severity: "warn"
       },
       {
-        path:     "app/controllers/context_controller.rb",
+        path: "app/controllers/context_controller.rb",
         position: 60,
-        message:  <<-MESSAGE.strip,
-[brakeman] Redirect: Possible unprotected redirect
-  Code: redirect_to(CanvasKaltura::ClientV3.new.assetSwfUrl(params[:id]))
-  User Input: params[:id]
-  See: http://brakemanscanner.org/docs/warning_types/redirect/
-                  MESSAGE
+        message: <<~MESSAGE.strip,
+          [brakeman] Redirect: Possible unprotected redirect
+            Code: redirect_to(CanvasKaltura::ClientV3.new.assetSwfUrl(params[:id]))
+            User Input: params[:id]
+            See: http://brakemanscanner.org/docs/warning_types/redirect/
+        MESSAGE
         severity: "warn"
       },
       {
-        path:     "app/views/context/object_snippet.html.erb",
+        path: "app/views/context/object_snippet.html.erb",
         position: 6,
-        message:  <<-MESSAGE.strip,
-[brakeman] Cross Site Scripting: Unescaped parameter value
-  Code: Base64.decode64((params[:object_data] or ""))
-  User Input: params[:object_data]
-  See: http://brakemanscanner.org/docs/warning_types/cross_site_scripting
+        message: <<~MESSAGE.strip,
+          [brakeman] Cross Site Scripting: Unescaped parameter value
+            Code: Base64.decode64((params[:object_data] or ""))
+            User Input: params[:object_data]
+            See: http://brakemanscanner.org/docs/warning_types/cross_site_scripting
         MESSAGE
         severity: "warn"
       },
       {
-        path:     "app/models/account.rb",
+        path: "app/models/account.rb",
         position: 795,
-        message:  <<-MESSAGE.strip,
-[brakeman] SQL Injection: Possible SQL injection
-  Code: Account.find_by_sql(Account.sub_account_ids_recursive_sql(parent_account_id))
-  User Input: Account.sub_account_ids_recursive_sql(parent_account_id)
-  See: http://brakemanscanner.org/docs/warning_types/sql_injection/
+        message: <<~MESSAGE.strip,
+          [brakeman] SQL Injection: Possible SQL injection
+            Code: Account.find_by_sql(Account.sub_account_ids_recursive_sql(parent_account_id))
+            User Input: Account.sub_account_ids_recursive_sql(parent_account_id)
+            See: http://brakemanscanner.org/docs/warning_types/sql_injection/
         MESSAGE
         severity: "error"
       },
       {
-        path:     "lib/cc/importer/blti_converter.rb",
+        path: "lib/cc/importer/blti_converter.rb",
         position: 145,
-        message:  <<-MESSAGE.strip,
-[brakeman] SSL Verification Bypass: SSL certificate verification was bypassed
-  Code: Net::HTTP.new(URI.parse(url).host, URI.parse(url).port).verify_mode = OpenSSL::SSL::VERIFY_NONE
-  See: http://brakemanscanner.org/docs/warning_types/ssl_verification_bypass/
+        message: <<~MESSAGE.strip,
+          [brakeman] SSL Verification Bypass: SSL certificate verification was bypassed
+            Code: Net::HTTP.new(URI.parse(url).host, URI.parse(url).port).verify_mode = OpenSSL::SSL::VERIFY_NONE
+            See: http://brakemanscanner.org/docs/warning_types/ssl_verification_bypass/
         MESSAGE
         severity: "error"
       },
       {
-        path:     "lib/cc/importer/canvas/quiz_converter.rb",
+        path: "lib/cc/importer/canvas/quiz_converter.rb",
         position: 44,
-        message:  <<-MESSAGE.strip,
-[brakeman] Command Injection: Possible command injection
-  Code: `\#{Qti.get_conversion_command(File.join(qti_folder, "qti_2_1"), qti_folder)}`
-  User Input: Qti.get_conversion_command(File.join(qti_folder, "qti_2_1"), qti_folder)
-  See: http://brakemanscanner.org/docs/warning_types/command_injection/
+        message: <<~MESSAGE.strip,
+          [brakeman] Command Injection: Possible command injection
+            Code: `\#{Qti.get_conversion_command(File.join(qti_folder, "qti_2_1"), qti_folder)}`
+            User Input: Qti.get_conversion_command(File.join(qti_folder, "qti_2_1"), qti_folder)
+            See: http://brakemanscanner.org/docs/warning_types/command_injection/
         MESSAGE
         severity: "warn"
       }

data/spec/gergich/capture/custom_capture_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "../../../lib/gergich/capture"
 
 RSpec.describe "CustomCaptor" do
@@ -12,8 +14,8 @@ RSpec.describe "CustomCaptor" do
   let(:described_class) { CustomCaptor }
   let(:capture_format) { "custom:sqlite3:CustomCaptor" }
   let(:output) do
-    <<-OUTPUT
-foo.rb:1: you done screwed up
+    <<~OUTPUT
+      foo.rb:1: you done screwed up
     OUTPUT
   end
   let(:comments) do

data/spec/gergich/capture/eslint_capture_spec.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 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
+      jsapp/models/user.js
+        4:21  error    Missing semicolon  semi
+        5:1   warning  Too much cowbell   cowbell-overload
     OUTPUT
   end
   let(:comments) do

data/spec/gergich/capture/flake8_capture_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 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
+      ./djangogeneric/settings/base.py:73:80: E501 line too long (81 > 79 characters)
     OUTPUT
   end
   let(:comments) do

data/spec/gergich/capture/i18nliner_capture_spec.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 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
+      1)
+      invalid signature on line 4: <unsupported expression>
+      jsapp/models/user.js
     OUTPUT
   end
   let(:comments) do

data/spec/gergich/capture/rubocop_capture_spec.rb

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 require_relative "../../support/capture_shared_examples"
 
 RSpec.describe Gergich::Capture::RubocopCapture do
   let(:output) do
-    <<-OUTPUT
-Offenses:
+    <<~OUTPUT
+      Offenses:
 
-bin/gergich:47:8: C: Prefer double-quoted strings
-if ENV['DEBUG']
-       ^^^^^^^
-foo/bar/baz.rb:1:2: W: no context for this one :shrug:
-lib/gergich.rb:10:9: E: this is a terrible name
+      bin/gergich:47:8: C: Prefer double-quoted strings
+      if ENV['DEBUG']
+             ^^^^^^^
+      foo/bar/baz.rb:1:2: W: no context for this one :shrug:
+      lib/gergich.rb:10:9: E: this is a terrible name
 
-seriously, what were you thinking?
-    def foo
-        ^^^
-lib/gergich.rb:22:55: W: Line is too long. [55/54]
-    def initialize(ref = "HEAD", revision_number = nil)
-                                                     ^^
+      seriously, what were you thinking?
+          def foo
+              ^^^
+      lib/gergich.rb:22:55: W: Line is too long. [55/54]
+          def initialize(ref = "HEAD", revision_number = nil)
+                                                           ^^
     OUTPUT
   end
   let(:comments) do
@@ -36,24 +38,24 @@ lib/gergich.rb:22:55: W: Line is too long. [55/54]
       {
         path: "lib/gergich.rb",
         position: 10,
-        message: <<-OUTPUT,
-[rubocop] this is a terrible name
+        message: <<~OUTPUT,
+          [rubocop] this is a terrible name
 
-seriously, what were you thinking?
+          seriously, what were you thinking?
 
-     def foo
-         ^^^
+               def foo
+                   ^^^
         OUTPUT
         severity: "error"
       },
       {
         path: "lib/gergich.rb",
         position: 22,
-        message: <<-OUTPUT,
-[rubocop] Line is too long. [55/54]
+        message: <<~OUTPUT,
+          [rubocop] Line is too long. [55/54]
 
-     def initialize(ref = "HEAD", revision_number = nil)
-                                                      ^^
+               def initialize(ref = "HEAD", revision_number = nil)
+                                                                ^^
         OUTPUT
         severity: "warn"
       }

data/spec/gergich/capture/shellcheck_capture_spec.rb

@@ -1,50 +1,52 @@
+# frozen_string_literal: true
+
 require_relative "../../support/capture_shared_examples"
 
 RSpec.describe Gergich::Capture::ShellcheckCapture do
   let(:output) do
-    <<-'OUTPUT'
-[
-  {
-    "file": "bin/sync-translations.sh",
-    "line": 23,
-    "endLine": 23,
-    "column": 21,
-    "endColumn": 21,
-    "level": "style",
-    "code": 2006,
-    "message": "Use $(..) instead of legacy `..`."
-  },
-  {
-    "file": "bin/sync-translations.sh",
-    "line": 23,
-    "endLine": 23,
-    "column": 43,
-    "endColumn": 43,
-    "level": "warning",
-    "code": 2046,
-    "message": "Quote this to prevent word splitting."
-  },
-  {
-    "file": "bin/sync-translations.sh",
-    "line": 32,
-    "endLine": 32,
-    "column": 62,
-    "endColumn": 62,
-    "level": "info",
-    "code": 2086,
-    "message": "Double quote to prevent globbing and word splitting."
-  },
-  {
-    "file": "fail.sh",
-    "line": 3,
-    "endLine": 3,
-    "column": 12,
-    "endColumn": 12,
-    "level": "error",
-    "code": 1101,
-    "message": "Delete trailing spaces after \\ to break line (or use quotes for literal space)."
-  }
-]
+    <<~'OUTPUT'
+      [
+        {
+          "file": "bin/sync-translations.sh",
+          "line": 23,
+          "endLine": 23,
+          "column": 21,
+          "endColumn": 21,
+          "level": "style",
+          "code": 2006,
+          "message": "Use $(..) instead of legacy `..`."
+        },
+        {
+          "file": "bin/sync-translations.sh",
+          "line": 23,
+          "endLine": 23,
+          "column": 43,
+          "endColumn": 43,
+          "level": "warning",
+          "code": 2046,
+          "message": "Quote this to prevent word splitting."
+        },
+        {
+          "file": "bin/sync-translations.sh",
+          "line": 32,
+          "endLine": 32,
+          "column": 62,
+          "endColumn": 62,
+          "level": "info",
+          "code": 2086,
+          "message": "Double quote to prevent globbing and word splitting."
+        },
+        {
+          "file": "fail.sh",
+          "line": 3,
+          "endLine": 3,
+          "column": 12,
+          "endColumn": 12,
+          "level": "error",
+          "code": 1101,
+          "message": "Delete trailing spaces after \\ to break line (or use quotes for literal space)."
+        }
+      ]
     OUTPUT
   end
 

data/spec/gergich/capture/stylelint_capture_spec.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 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
+    <<~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
+      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
+       45:12  ℹ  Expected "#2d3b4a" to be "#2D3B4A"      color-hex-case
     OUTPUT
   end
   let(:comments) do
@@ -37,6 +40,12 @@ app/stylesheets/base/_variables.scss
         position: 30,
         message: "[stylelint] Expected \"#2d3b4a\" to be \"#2D3B4A\"",
         severity: "warn"
+      },
+      {
+        path: "app/stylesheets/base/_variables.scss",
+        position: 45,
+        message: "[stylelint] Expected \"#2d3b4a\" to be \"#2D3B4A\"",
+        severity: "info"
       }
     ]
   end

data/spec/gergich/capture/swiftlint_capture_spec.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 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 Layout/LineLength
   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
+      /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

data/spec/gergich/capture_spec.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require_relative "../../lib/gergich/capture"
 
 RSpec.describe Gergich::Capture do
   let!(:draft) { double }
 
   let :output do
-    <<-OUTPUT
-#{path}
-  4:21  error  Missing semicolon  semi
-OUTPUT
+    <<~OUTPUT
+      #{path}
+        4:21  error  Missing semicolon  semi
+    OUTPUT
   end
 
   before do

data/spec/gergich_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe Gergich::API do
   context "bad change-id" do
     let(:result) { double(:result, body: "Not Found: 1234") }
@@ -88,6 +90,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 }
 
@@ -99,6 +116,11 @@ RSpec.describe Gergich::Draft do
         expect(subject).to eq("foo.rb" => [{ line: 1, message: "[INFO] fix foo" }])
       end
 
+      it "strips whitespace from filename" do
+        draft.add_comment " foo.rb\n", 1, "fix foo", "info"
+        expect(subject).to eq("foo.rb" => [{ line: 1, message: "[INFO] fix foo" }])
+      end
+
       it "includes COMMIT_MSG comments" do
         draft.add_comment "/COMMIT_MSG", 1, "fix commit", "info"
         expect(subject).to eq("/COMMIT_MSG" => [{ line: 1, message: "[INFO] fix commit" }])
@@ -210,16 +232,18 @@ RSpec.describe Gergich::Draft do
 end
 
 RSpec.describe Gergich::Review do
+  let(:change_id) { "test" }
   let!(:commit) do
     double(
       :commit,
+      change_id: change_id,
       files: [
         "foo.rb",
         "bar/baz.lol"
       ],
-      revision_id: "test",
-      revision_number: 1,
-      change_id: "test"
+      info: {},
+      revision_id: change_id,
+      revision_number: 1
     )
   end
   let!(:draft) do
@@ -231,6 +255,37 @@ RSpec.describe Gergich::Review do
     draft.reset!
   end
 
+  describe "#status" do
+    subject { review.status }
+
+    context "nothing to publish" do
+      before :each do
+        allow(review).to receive(:anything_to_publish?).and_return(false)
+      end
+      it { expect { subject }.to output(include("Nothing to publish")).to_stdout }
+    end
+
+    context "something to publish" do
+      before :each do
+        allow(review).to receive(:anything_to_publish?).and_return(true)
+        allow(review).to receive(:already_commented?).and_return(false)
+        allow(review).to receive(:generate_payload).and_return({})
+        allow(review).to receive(:my_messages).and_return([])
+      end
+      it {
+        expected_outputs = [
+          "Project:",
+          "Branch:",
+          "Revision:",
+          "ChangeId: #{change_id}",
+          "Files:"
+          # There's more... but this is good
+        ]
+        expect { subject }.to output(include(*expected_outputs)).to_stdout
+      }
+    end
+  end
+
   describe "#publish!" do
     context "nothing to publish" do
       before :each do
@@ -253,7 +308,6 @@ RSpec.describe Gergich::Review do
 
       it "publishes via the api" do
         expect(Gergich::API).to receive(:post)
-        allow(review).to receive(:change_name?).and_return(false)
         review.publish!
       end
     end