danger-android_lint 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14a8b24ca402a1f8615991280e363bf0fe02eb9d
-  data.tar.gz: 4be292fab2a1db392f729bda485a831f1533c611
+  metadata.gz: bc51ff27951c956c5534a2adc9219db6ef8b23ea
+  data.tar.gz: 162c31a66338d95c2d184864ad9cbbb02377668c
 SHA512:
-  metadata.gz: f5842a73db7eaac24acc5a704c582bbbcd690b95499392f57214e45fb6bd9eb71dbd510cc17456017922823a1544bda1bf8ee63dd62371cd1c47bdbc06c48301
-  data.tar.gz: 205b8756e1b4f3fdf34256b4baa551475fcec0e5ec239dc68fde22616856c6ae7052b44b66bd9898d6683c5aceeba93e44a7cef7d8427a715ef0f6d2fbada307
+  metadata.gz: e34ff70dab0f608b3bfd09aa5f3ec7e3a83812fa95f3597bbb88c67d6e3854991caf156f61ec652f7415509082731665c1bc8060dc912e98761e06f0a1728b6b
+  data.tar.gz: 53601dfb052fed83d66a369edfc6843759d47c9786f9bd477a65f84fb1208815f9c1a8cc66067b8de597755dfa3fb47848cff8f75ea08848737822f8d6e34374

data/CHANGELOG.md

@@ -1,9 +1,13 @@
+# 0.0.4
+- Add `filtering` parameter, default to false, to run lint only on modified files ([@leonhartX](https://github.com/leonhartX))
+- Add support for GitHub's inline comments ([@leonhartX](https://github.com/leonhartX))
+
 # 0.0.3
-- Add `report_file` parameter, so users can set a custom path for their report xmls (@churowa)
+- Add `report_file` parameter, so users can set a custom path for their report xmls ([@churowa](https://github.com/churowa))
 
 ## 0.0.2
-- Fix check for inexistent report file (@barbosa)
-- Fix markdown message being printed without any issues reported (@barbosa)
+- Fix check for inexistent report file ([@barbosa](https://github.com/barbosa))
+- Fix markdown message being printed without any issues reported ([@barbosa](https://github.com/barbosa))
 
 ## 0.0.1
-- Initial version (@barbosa)
+- Initial version ([@barbosa](https://github.com/barbosa))

data/README.md

@@ -58,6 +58,21 @@ android_lint.severity = "Error"
 android_lint.lint
 ```
 
+#### Lint only added/modified files
+
+If you're dealing with a legacy project, with tons of warnings, you may want to lint only new/modified files. You can easily achieve that, setting the `filtering` parameter to `true`.
+
+```rb
+android_lint.filtering = true
+android_lint.lint
+```
+
+#### Make Danger comment directly on the line instead of printing a Markdown table (GitHub only)
+
+```rb
+android_lint.lint(inline_mode: true)
+```
+
 ## Development
 
 1. Clone this repo
@@ -68,4 +83,4 @@ android_lint.lint
 
 ## License
 
-MIT
+[MIT](https://raw.githubusercontent.com/loadsmart/danger-android_lint/master/LICENSE.txt)

data/lib/android_lint/gem_version.rb

@@ -1,3 +1,3 @@
 module AndroidLint
-  VERSION = "0.0.3".freeze
+  VERSION = "0.0.4".freeze
 end

data/lib/android_lint/plugin.rb

@@ -50,13 +50,17 @@ module Danger
     # @return [String]
     attr_writer :severity
 
+    # Enable filtering
+    # Only show messages within changed files.
+    attr_accessor :filtering
+
     # Calls lint task of your gradle project.
     # It fails if `gradlew` cannot be found inside current directory.
     # It fails if `severity` level is not a valid option.
     # It fails if `xmlReport` configuration is not set to `true` in your `build.gradle` file.
     # @return [void]
     #
-    def lint
+    def lint(inline_mode: false)
       unless gradlew_exists?
         fail("Could not find `gradlew` inside current directory")
         return
@@ -77,8 +81,13 @@ module Danger
       issues = read_issues_from_report
       filtered_issues = filter_issues_by_severity(issues)
 
-      message = message_for_issues(filtered_issues)
-      markdown(message) unless filtered_issues.empty?
+      if inline_mode
+        # Report with inline comment
+        send_inline_comment(filtered_issues)
+      else
+        message = message_for_issues(filtered_issues)
+        markdown(message) unless filtered_issues.empty?
+      end
     end
 
     # A getter for `severity`, returning "Warning" if value is nil.
@@ -120,6 +129,8 @@ module Danger
     end
 
     def parse_results(results, heading)
+      target_files = (git.modified_files - git.deleted_files) + git.added_files
+      dir = "#{Dir.pwd}/"
       message = "#### #{heading} (#{results.count})\n\n"
 
       message << "| File | Line | Reason |\n"
@@ -127,7 +138,8 @@ module Danger
 
       results.each do |r|
         location = r.xpath('location').first
-        filename = location.get('file').split('/').last
+        filename = location.get('file').gsub(dir, "")
+        next unless !filtering || (target_files.include? filename)
         line = location.get('line') || 'N/A'
         reason = r.get('message')
 
@@ -137,6 +149,26 @@ module Danger
       message
     end
 
+
+    # Send inline comment with danger's warn or fail method
+    #
+    # @return [void]
+    def send_inline_comment (issues)
+      target_files = (git.modified_files - git.deleted_files) + git.added_files
+      dir = "#{Dir.pwd}/"
+      SEVERITY_LEVELS.reverse.each do |level|
+        filtered = issues.select{|issue| issue.get("severity") == level}
+        next if filtered.empty?
+        filtered.each do |r|
+          location = r.xpath('location').first
+          filename = location.get('file').gsub(dir, "")
+          next unless !filtering || (target_files.include? filename)
+          line = (location.get('line') || "0").to_i
+          send(level === "Warning" ? "warn" : "fail", r.get('message'), file: filename, line: line)
+        end
+      end
+    end
+
     def gradlew_exists?
       `ls gradlew`.strip.empty? == false
     end

data/spec/android_lint_spec.rb

@@ -10,6 +10,12 @@ module Danger
       before do
         @dangerfile = testing_dangerfile
         @android_lint = @dangerfile.android_lint
+        allow(@android_lint.git).to receive(:deleted_files).and_return([])
+        allow(@android_lint.git).to receive(:added_files).and_return([])
+        allow(@android_lint.git).to receive(:modified_files).and_return([
+          "/Users/gustavo/Developer/app-android/app/src/main/java/com/loadsmart/common/views/AvatarView.java",
+          "/Users/gustavo/Developer/app-android/app/src/main/java/com/loadsmart/analytics/Events.java"
+        ])
       end
 
       it "Fails if gradlew does not exist" do
@@ -94,13 +100,13 @@ module Danger
           expect(markdown).to include("AndroidLint found issues")
 
           expect(markdown).to include("Fatal (1)")
-          expect(markdown).to include("`AvatarView.java` | 60 | Implicitly using the default locale is a common source of bugs: Use `toUpperCase(Locale)` instead")
+          expect(markdown).to include("`/Users/gustavo/Developer/app-android/app/src/main/java/com/loadsmart/common/views/AvatarView.java` | 60 | Implicitly using the default locale is a common source of bugs: Use `toUpperCase(Locale)` instead")
 
           expect(markdown).to include("Error (1)")
-          expect(markdown).to include("`Events.java` | 21 | Implicitly using the default locale is a common source of bugs: Use `String.format(Locale, ...)` instead")
+          expect(markdown).to include("`/Users/gustavo/Developer/app-android/app/src/main/java/com/loadsmart/analytics/Events.java` | 21 | Implicitly using the default locale is a common source of bugs: Use `String.format(Locale, ...)` instead")
 
           expect(markdown).to include("Warning (1)")
-          expect(markdown).to include("`Events.java` | 24 | Implicitly using the default locale is a common source of bugs: Use `String.format(Locale, ...)` instead")
+          expect(markdown).to include("`/Users/gustavo/Developer/app-android/app/src/main/java/com/loadsmart/analytics/Events.java` | 24 | Implicitly using the default locale is a common source of bugs: Use `String.format(Locale, ...)` instead")
         end
 
         it 'Doesn`t print anything if no errors were found' do
@@ -124,6 +130,37 @@ module Danger
           expect(markdown).to be_nil
         end
 
+        it 'Send inline comment instead of markdown' do
+          fake_result = File.open("spec/fixtures/lint-result-with-everything.xml")
+          allow(File).to receive(:open).with(@android_lint.report_file).and_return(fake_result)
+
+          @android_lint.lint inline_mode: true
+          error = @android_lint.status_report[:errors]
+          expect(error).to include("Implicitly using the default locale is a common source of bugs: Use `toUpperCase(Locale)` instead")
+          expect(error).to include("Implicitly using the default locale is a common source of bugs: Use `String.format(Locale, ...)` instead")
+
+          warn = @android_lint.status_report[:warnings]
+          expect(warn).to include("Implicitly using the default locale is a common source of bugs: Use `String.format(Locale, ...)` instead")
+        end
+
+        it 'Only show comment in changed files' do
+          allow(@android_lint.git).to receive(:modified_files).and_return([
+          "/Users/gustavo/Developer/app-android/app/src/main/java/com/loadsmart/common/views/AvatarView.java",
+          ])
+
+          fake_result = File.open("spec/fixtures/lint-result-with-everything.xml")
+          allow(File).to receive(:open).with(@android_lint.report_file).and_return(fake_result)
+
+          @android_lint.filtering = true
+          @android_lint.lint inline_mode: true
+          error = @android_lint.status_report[:errors]
+          expect(error).to include("Implicitly using the default locale is a common source of bugs: Use `toUpperCase(Locale)` instead")
+          expect(error).not_to include("Implicitly using the default locale is a common source of bugs: Use `String.format(Locale, ...)` instead")
+
+          warn = @android_lint.status_report[:warnings]
+          expect(warn).not_to include("Implicitly using the default locale is a common source of bugs: Use `String.format(Locale, ...)` instead")
+        end
+
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-android_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Gustavo Barbosa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oga