danger-pmd 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d44fdbb62edb14a8de5ece8c8340f4746c300e8c54fae34a72436dd42ae5ec1
-  data.tar.gz: 60d66c53e9495fee4e5238625504458168b3c4bf68fb08f1188fbfa26560a483
+  metadata.gz: ed7c20c01b799e6dbb65c79231881419974d23e159eb37eac8a06c6515f54e74
+  data.tar.gz: 713039e5ddc346d2d9d4ad1584f0ca0e9c12195f9d185c831286cca13d90a335
 SHA512:
-  metadata.gz: ec9f06385c7419e7b671e941bc89cce31e909220aab39f84a1837f5a5a680d3e571f8653b86b4b43b999e6f6495be4f7740d252592baeb3efad5713d1a7dd165
-  data.tar.gz: 7512fe083ce53ced178c0a92b23ce8e02ba7d8b411533ef18fa92165b6bf876b963ebfdd0905e7bfdb1f0d7e231c742c2fed05c2835c39101bd21cae9f7847b8
+  metadata.gz: ab07baefcd8d71857370394b05fda51321a163269db0c5eb7b04aa3fae69e20b4f0241aec79f66aeb8dc1eeef30e3f51e73c4fb3ceb5c4577862941bcb79456e
+  data.tar.gz: 3d27b055ada8d15588e9585c60b10ddf45d5cc990bbd41f380e5b2e2e69181c9c2f67f639ca3444354e17bcd7869f3b72142302674da6a4997048dd99940fd1a

data/README.md

@@ -48,6 +48,10 @@ Defaults to "pmd".
 `skip_gradle_task` - Skip Gradle task.
 If you skip Gradle task, for example project does not manage Gradle.
 
+`root_path` - Location of the project root
+If your project root is different from git's top-level path.
+Defaults to result of "git rev-parse --show-toplevel".
+
 `report_file` - Location of report file
 If your pmd task outputs to a different location, you can specify it here.
 Defaults to "app/build/reports/pmd/pmd.xml".
@@ -66,6 +70,8 @@ It fails if `report_file` or `report_files` cannot be found inside current direc
 
 `skip_gradle_task` - A getter for `skip_gradle_task`.
 
+`root_path` - A getter for `root_path`.
+
 `report_file` - A getter for `report_file`.
 
 `report_files` - A getter for `report_files`.

data/lib/pmd/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pmd
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/pmd/plugin.rb

@@ -15,6 +15,11 @@ module Danger
   #          pmd.report_file = "module/build/reports/pmd/pmd.xml" #defalut: app/build/reports/pmd/pmd.xml
   #          pmd.report
   #
+  # @example Running PMD with a specific root path
+  #
+  #          pmd.root_path = '/Users/developer/project
+  #          pmd.report
+  #
   # @example Running PMD with an array of report files (glob accepted)
   #
   #          pmd.report_files = ["modules/**/build/reports/pmd/pmd.xml", "app/build/reports/pmd/pmd.xml"]
@@ -55,6 +60,18 @@ module Danger
       @skip_gradle_task ||= false
     end
 
+    # An absolute path to a root.
+    # To comment errors to VCS, this needs to know relative path of files from the root.
+    # Defaults to result of "git rev-parse --show-toplevel".
+    # @return [String] the root path of git repository by default.
+    attr_writer :root_path
+
+    # A getter for `root_path`, returning result of "git rev-parse --show-toplevel" if value is nil.
+    # @return [String]
+    def root_path
+      @root_path ||= `git rev-parse --show-toplevel`.chomp
+    end
+
     # Location of report file.
     # If your pmd task outputs to a different location, you can specify it here.
     # Defaults to "app/build/reports/pmd/pmd.xml".
@@ -84,7 +101,7 @@ module Danger
     # It fails if `report_file` cannot be found inside current directory.
     # It fails if `report_files` is empty.
     # @return [Array[PmdFile]]
-    def report(inline_mode = true)
+    def report(inline_comment = true)
       unless skip_gradle_task
         return fail("Could not find `gradlew` inside current directory") unless gradlew_exists?
 
@@ -94,7 +111,7 @@ module Danger
       report_files_expanded = Dir.glob(report_files).sort
       return fail("Could not find matching PMD report files for #{report_files} inside current directory") if report_files_expanded.empty?
 
-      report_and_send_inline_comment(report_files_expanded, inline_mode)
+      do_comment(report_files_expanded, inline_comment)
     end
 
     private
@@ -128,7 +145,7 @@ module Danger
     # @return [Array[PmdFile]]
     def pmd_issues(report_file)
       pmd_report(report_file).xpath("//file").map do |pmd_file|
-        PmdFile.new(pmd_file)
+        PmdFile.new(root_path, pmd_file)
       end
     end
 
@@ -140,19 +157,21 @@ module Danger
 
     # Generate report and send inline comment with Danger's warn or fail method.
     # @return [Array[PmdFile]]
-    def report_and_send_inline_comment(report_files, inline_mode = true)
+    def do_comment(report_files, inline_comment = true)
       pmd_issues = []
 
       report_files.each do |report_file|
         pmd_issues(report_file).each do |pmd_file|
-          next unless target_files.include? pmd_file.absolute_path
+          next unless target_files.include? pmd_file.relative_path
 
           pmd_issues.push(pmd_file)
 
-          next if inline_mode
-
           pmd_file.violations.each do |pmd_violation|
-            send(pmd_violation.type, pmd_violation.description, file: pmd_file.absolute_path, line: pmd_violation.line)
+            if inline_comment
+              send(pmd_violation.type, pmd_violation.description, file: pmd_file.relative_path, line: pmd_violation.line)
+            else
+              send(pmd_violation.type, "#{pmd_file.relative_path} : #{pmd_violation.description} at #{pmd_violation.line}")
+            end
           end
         end
       end

data/lib/pmd/pmd_file.rb

@@ -2,25 +2,34 @@
 
 class PmdFile
   require_relative "./pmd_violation"
+
   attr_accessor :file
 
-  def initialize(file)
+  # An absolute path to this file
+  #
+  # @return [String]
+  attr_reader :absolute_path
+
+  # A relative path to this file
+  #
+  # @return [String]
+  attr_reader :relative_path
+
+  def initialize(prefix, file)
     @file = file
-  end
+    @absolute_path = file.attribute("name").value.to_s
 
-  def source_path
-    @source_path ||= file.attribute("name").value.to_s
-  end
+    if prefix.end_with?(file_separator)
+      @prefix = prefix
+    else
+      @prefix = prefix + file_separator
+    end
 
-  def absolute_path
-    dirname = File.basename(Dir.getwd)
-    if source_path.index(dirname)
-      index_start = source_path.index(dirname) + dirname.length + 1
+    if @absolute_path.start_with?(@prefix)
+      @relative_path = @absolute_path[@prefix.length, @absolute_path.length - @prefix.length]
     else
-      index_start = 0
+      @relative_path = @absolute_path
     end
-    index_end = source_path.length
-    @absolute_path ||= Pathname.new(source_path[index_start, index_end]).to_s
   end
 
   def violations
@@ -28,4 +37,10 @@ class PmdFile
       PmdViolation.new(pmd_violation)
     end
   end
+
+  private
+
+  def file_separator
+    File::ALT_SEPARATOR || File::SEPARATOR
+  end
 end

data/spec/pmd_spec.rb

@@ -14,6 +14,26 @@ module Danger
         @pmd = @dangerfile.pmd
       end
 
+      it "Check default Gradle task" do
+        expect(@pmd.gradle_task).to eq("pmd")
+      end
+
+      it "Set custom Gradle task" do
+        custom_task = "pmdStagingDebug"
+        @pmd.gradle_task = custom_task
+        expect(@pmd.gradle_task).to eq(custom_task)
+      end
+
+      it "Check default skip Gradle task" do
+        expect(@pmd.skip_gradle_task).to eq(false)
+      end
+
+      it "Set custom skip Gradle task" do
+        skip_gradle_task = true
+        @pmd.skip_gradle_task = skip_gradle_task
+        expect(@pmd.skip_gradle_task).to eq(skip_gradle_task)
+      end
+
       it "Check default report file path" do
         expect(@pmd.report_file).to eq("app/build/reports/pmd/pmd.xml")
       end
@@ -34,36 +54,27 @@ module Danger
         expect(@pmd.report_files).to eq(custom_report_paths)
       end
 
-      it "Check default Gradle task" do
-        expect(@pmd.gradle_task).to eq("pmd")
+      it "Check default root path" do
+        expect(@pmd.root_path).to eq(Dir.pwd)
       end
 
-      it "Set custom Gradle task" do
-        custom_task = "pmdStagingDebug"
-        @pmd.gradle_task = custom_task
-        expect(@pmd.gradle_task).to eq(custom_task)
-      end
-
-      it "Check default skip Gradle task" do
-        expect(@pmd.skip_gradle_task).to eq(false)
-      end
-
-      it "Skip Gradle task" do
-        skip_gradle_task = true
-        @pmd.skip_gradle_task = skip_gradle_task
-        expect(@pmd.skip_gradle_task).to eq(skip_gradle_task)
+      it "Set custom root path" do
+        root_path = "/Users/developer/sample/"
+        @pmd.root_path = root_path
+        expect(@pmd.root_path).to eq(root_path)
       end
 
       it "Report with report file" do
         target_files = [
-          "/Users/developer/sample/app/src/main/java/com/android/sample/MainActivity.java",
-          "/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java",
-          "/Users/developer/sample/app/src/test/java/com/android/sample/ExampleUnitTest.java",
-          "/Users/developer/sample/app/src/test/java/com/android/sample/ToolsTest.java"
+          "app/src/main/java/com/android/sample/MainActivity.java",
+          "app/src/main/java/com/android/sample/Tools.java",
+          "app/src/test/java/com/android/sample/ExampleUnitTest.java",
+          "app/src/test/java/com/android/sample/ToolsTest.java"
         ]
         allow_any_instance_of(Danger::DangerPmd).to receive(:target_files).and_return(target_files)
 
         @pmd.report_file = "spec/fixtures/pmd_report.xml"
+        @pmd.root_path = "/Users/developer/sample/"
         @pmd.skip_gradle_task = true
 
         pmd_issues = @pmd.report
@@ -72,8 +83,8 @@ module Danger
 
         pmd_issue1 = pmd_issues[0]
         expect(pmd_issue1).not_to be_nil
-        expect(pmd_issue1.source_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java")
         expect(pmd_issue1.absolute_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java")
+        expect(pmd_issue1.relative_path).to eq("app/src/main/java/com/android/sample/Tools.java")
         expect(pmd_issue1.violations).not_to be_nil
         expect(pmd_issue1.violations.length).to eq(1)
         expect(pmd_issue1.violations.first).not_to be_nil
@@ -82,8 +93,8 @@ module Danger
 
         pmd_issue2 = pmd_issues[1]
         expect(pmd_issue2).not_to be_nil
-        expect(pmd_issue2.source_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/MainActivity.java")
         expect(pmd_issue2.absolute_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/MainActivity.java")
+        expect(pmd_issue2.relative_path).to eq("app/src/main/java/com/android/sample/MainActivity.java")
         expect(pmd_issue2.violations).not_to be_nil
         expect(pmd_issue2.violations.length).to eq(1)
         expect(pmd_issue2.violations.first).not_to be_nil
@@ -92,8 +103,8 @@ module Danger
 
         pmd_issue3 = pmd_issues[2]
         expect(pmd_issue3).not_to be_nil
-        expect(pmd_issue3.source_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ExampleUnitTest.java")
         expect(pmd_issue3.absolute_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ExampleUnitTest.java")
+        expect(pmd_issue3.relative_path).to eq("app/src/test/java/com/android/sample/ExampleUnitTest.java")
         expect(pmd_issue3.violations).not_to be_nil
         expect(pmd_issue3.violations.length).to eq(1)
         expect(pmd_issue3.violations.first).not_to be_nil
@@ -102,8 +113,8 @@ module Danger
 
         pmd_issue4 = pmd_issues[3]
         expect(pmd_issue4).not_to be_nil
-        expect(pmd_issue4.source_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ToolsTest.java")
         expect(pmd_issue4.absolute_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ToolsTest.java")
+        expect(pmd_issue4.relative_path).to eq("app/src/test/java/com/android/sample/ToolsTest.java")
         expect(pmd_issue4.violations).not_to be_nil
         expect(pmd_issue4.violations.length).to eq(2)
         expect(pmd_issue4.violations[0]).not_to be_nil
@@ -116,12 +127,13 @@ module Danger
 
       it "Report with report file not in target files" do
         target_files = [
-          "/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java",
-          "/Users/developer/sample/app/src/test/java/com/android/sample/ToolsTest.java"
+          "app/src/main/java/com/android/sample/Tools.java",
+          "app/src/test/java/com/android/sample/ToolsTest.java"
         ]
         allow_any_instance_of(Danger::DangerPmd).to receive(:target_files).and_return(target_files)
 
         @pmd.report_file = "spec/fixtures/pmd_report.xml"
+        @pmd.root_path = "/Users/developer/sample/"
         @pmd.skip_gradle_task = true
 
         pmd_issues = @pmd.report
@@ -130,8 +142,8 @@ module Danger
 
         pmd_issue1 = pmd_issues[0]
         expect(pmd_issue1).not_to be_nil
-        expect(pmd_issue1.source_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java")
         expect(pmd_issue1.absolute_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java")
+        expect(pmd_issue1.relative_path).to eq("app/src/main/java/com/android/sample/Tools.java")
         expect(pmd_issue1.violations).not_to be_nil
         expect(pmd_issue1.violations.length).to eq(1)
         expect(pmd_issue1.violations.first).not_to be_nil
@@ -140,8 +152,8 @@ module Danger
 
         pmd_issue2 = pmd_issues[1]
         expect(pmd_issue2).not_to be_nil
-        expect(pmd_issue2.source_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ToolsTest.java")
         expect(pmd_issue2.absolute_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ToolsTest.java")
+        expect(pmd_issue2.relative_path).to eq("app/src/test/java/com/android/sample/ToolsTest.java")
         expect(pmd_issue2.violations).not_to be_nil
         expect(pmd_issue2.violations.length).to eq(2)
         expect(pmd_issue2.violations[0]).not_to be_nil
@@ -154,16 +166,17 @@ module Danger
 
       it "Report with report files" do
         target_files = [
-          "/Users/developer/sample/app/src/main/java/com/android/sample/Application.java",
-          "/Users/developer/sample/app/src/main/java/com/android/sample/MainActivity.java",
-          "/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java",
-          "/Users/developer/sample/app/src/main/java/com/android/sample/Utils.java",
-          "/Users/developer/sample/app/src/test/java/com/android/sample/ExampleUnitTest.java",
-          "/Users/developer/sample/app/src/test/java/com/android/sample/ToolsTest.java"
+          "app/src/main/java/com/android/sample/Application.java",
+          "app/src/main/java/com/android/sample/MainActivity.java",
+          "app/src/main/java/com/android/sample/Tools.java",
+          "app/src/main/java/com/android/sample/Utils.java",
+          "app/src/test/java/com/android/sample/ExampleUnitTest.java",
+          "app/src/test/java/com/android/sample/ToolsTest.java"
         ]
         allow_any_instance_of(Danger::DangerPmd).to receive(:target_files).and_return(target_files)
 
         @pmd.report_files = ["spec/fixtures/pmd_report.xml", "spec/fixtures/**/pmd_sub_report.xml"]
+        @pmd.root_path = "/Users/developer/sample"
         @pmd.skip_gradle_task = true
 
         pmd_issues = @pmd.report
@@ -172,8 +185,8 @@ module Danger
 
         pmd_issue1 = pmd_issues[0]
         expect(pmd_issue1).not_to be_nil
-        expect(pmd_issue1.source_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java")
         expect(pmd_issue1.absolute_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java")
+        expect(pmd_issue1.relative_path).to eq("app/src/main/java/com/android/sample/Tools.java")
         expect(pmd_issue1.violations).not_to be_nil
         expect(pmd_issue1.violations.length).to eq(1)
         expect(pmd_issue1.violations.first).not_to be_nil
@@ -182,8 +195,8 @@ module Danger
 
         pmd_issue2 = pmd_issues[1]
         expect(pmd_issue2).not_to be_nil
-        expect(pmd_issue2.source_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/MainActivity.java")
         expect(pmd_issue2.absolute_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/MainActivity.java")
+        expect(pmd_issue2.relative_path).to eq("app/src/main/java/com/android/sample/MainActivity.java")
         expect(pmd_issue2.violations).not_to be_nil
         expect(pmd_issue2.violations.length).to eq(1)
         expect(pmd_issue2.violations.first).not_to be_nil
@@ -192,8 +205,8 @@ module Danger
 
         pmd_issue3 = pmd_issues[2]
         expect(pmd_issue3).not_to be_nil
-        expect(pmd_issue3.source_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ExampleUnitTest.java")
         expect(pmd_issue3.absolute_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ExampleUnitTest.java")
+        expect(pmd_issue3.relative_path).to eq("app/src/test/java/com/android/sample/ExampleUnitTest.java")
         expect(pmd_issue3.violations).not_to be_nil
         expect(pmd_issue3.violations.length).to eq(1)
         expect(pmd_issue3.violations.first).not_to be_nil
@@ -202,8 +215,8 @@ module Danger
 
         pmd_issue4 = pmd_issues[3]
         expect(pmd_issue4).not_to be_nil
-        expect(pmd_issue4.source_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ToolsTest.java")
         expect(pmd_issue4.absolute_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ToolsTest.java")
+        expect(pmd_issue4.relative_path).to eq("app/src/test/java/com/android/sample/ToolsTest.java")
         expect(pmd_issue4.violations).not_to be_nil
         expect(pmd_issue4.violations.length).to eq(2)
         expect(pmd_issue4.violations[0]).not_to be_nil
@@ -215,8 +228,8 @@ module Danger
 
         pmd_issue5 = pmd_issues[4]
         expect(pmd_issue5).not_to be_nil
-        expect(pmd_issue5.source_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Utils.java")
         expect(pmd_issue5.absolute_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Utils.java")
+        expect(pmd_issue5.relative_path).to eq("app/src/main/java/com/android/sample/Utils.java")
         expect(pmd_issue5.violations).not_to be_nil
         expect(pmd_issue5.violations.length).to eq(2)
         expect(pmd_issue5.violations[0]).not_to be_nil
@@ -228,8 +241,8 @@ module Danger
 
         pmd_issue6 = pmd_issues[5]
         expect(pmd_issue6).not_to be_nil
-        expect(pmd_issue6.source_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Application.java")
         expect(pmd_issue6.absolute_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Application.java")
+        expect(pmd_issue6.relative_path).to eq("app/src/main/java/com/android/sample/Application.java")
         expect(pmd_issue6.violations).not_to be_nil
         expect(pmd_issue6.violations.length).to eq(1)
         expect(pmd_issue6.violations[0]).not_to be_nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-pmd
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Mathieu Rul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-26 00:00:00.000000000 Z
+date: 2019-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api