danger-pmd 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25bc46f8d31771647e30e868e5c70414c8a09f5d020351b4442f998698f7f8a5
-  data.tar.gz: 882f95e0c94495be3507a2f5be3af5e5eebcf26af3fe9f98fe3b37590719f22b
+  metadata.gz: 3dafff6ceb58505c4b23ec986c622262c7f86dc4cc700d6dcd22ebf26e588683
+  data.tar.gz: 7247d9dd0fa56d8c889118357a62b844f4c5a2390664f63382469726ee5d554a
 SHA512:
-  metadata.gz: 9e86137b4137acdc557fa7c17ddfe8958c3d2f153adbe1a2ce8eabfef2d24421aaa641777cecf85088fe9ff7d7b1b8a9bd5b75d52b1c8a761f03e628ee1e0b6b
-  data.tar.gz: 17a959da13097dab76c2eab0eee92357701a63f876a2b3743c2b57e4313175fe68a5e53f9d147f214b4c99bfeb72d1ab6131d3cd5f6af6619d03843ec78bef24
+  metadata.gz: fa586124b9ff281a55364ff172c3bcc7533817e02175a1a957a2bd573244b3d54a10df38e32bcd9fe04d16233dbe5ee771e291ad4ba20774c70f40e17cab1abd
+  data.tar.gz: a6666d735f488a85145653d64b501dde58250fc6d184255ce66799093559ea779064ae3d4cbefb9c353c09494f8b18fe04612849cacbb521ccf7925583912cd7

data/README.md

@@ -1,6 +1,6 @@
 # Danger PMD
 
-Danger plugin for PMD report XML file. This plugin is inspired from https://github.com/kazy1991/danger-findbugs.
+Danger plugin for PMD formatted xml file. This plugin is inspired from https://github.com/kazy1991/danger-findbugs.
 
 ## Installation
 
@@ -11,6 +11,54 @@ Danger plugin for PMD report XML file. This plugin is inspired from https://gith
     Methods and attributes from this plugin are available in
     your `Dangerfile` under the `pmd` namespace.
 
+<blockquote>Running PMD with its basic configuration
+<pre>
+pmd.report
+</pre>
+</blockquote>
+
+<blockquote>Running PMD with a specific Gradle task or report_file
+<pre>
+pmd.gradle_task = 'app:pmd' #defalut: pmd
+pmd.report_file = "app/build/reports/pmd/pmd.xml"
+pmd.report
+</pre>
+</blockquote>
+
+#### Attributes
+
+`gradle_module` - Custom Gradle module to run.
+This is useful when your project has different flavors.
+Defaults to "app".
+
+`gradle_task` - Custom Gradle task to run.
+This is useful when your project has different flavors.
+Defaults to "pmd".
+
+`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".
+
+#### Methods
+
+`report` - Calls pmd task of your Gradle project.
+It fails if `gradlew` cannot be found inside current directory.
+It fails if `report_file` cannot be found inside current directory.
+
+`target_files` - A getter for current updated files
+
+`exec_gradle_task` - Run Gradle task
+
+`gradlew_exists?` - Check gradlew file exists in current directory
+
+`report_file_exist?` - Check report_file exists in current directory
+
+`pmd_report` - A getter for `pmd_report`, returning PMD report.
+
+`pmd_issues` - A getter for PMD issues, returning PMD issues.
+
+`send_inline_comment` - Send inline comment with danger's warn or fail method
+
 ## Development
 
 1. Clone this repo

data/lib/pmd/gem_version.rb

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

data/lib/pmd/plugin.rb

@@ -42,7 +42,7 @@ module Danger
     GRADLEW_NOT_FOUND = "Could not find `gradlew` inside current directory"
     REPORT_FILE_NOT_FOUND = "PMD report not found"
 
-    # Calls pmd task of your gradle project.
+    # Calls PMD task of your Gradle project.
     # It fails if `gradlew` cannot be found inside current directory.
     # It fails if `report_file` cannot be found inside current directory.
     # @return [void]
@@ -81,7 +81,7 @@ module Danger
       @target_files ||= (git.modified_files - git.deleted_files) + git.added_files
     end
 
-    # Run gradle task
+    # Run Gradle task
     # @return [void]
     def exec_gradle_task
       system "./gradlew #{gradle_task}"
@@ -99,26 +99,25 @@ module Danger
       File.exist?(report_file)
     end
 
-    # A getter for `gradle_task`, returning "pmd" if value is nil.
+    # A getter for `pmd_report`, returning PMD report.
     # @return [Oga::XML::Document]
     def pmd_report
       require "oga"
       @pmd_report ||= Oga.parse_xml(File.open(report_file))
     end
 
-    # A getter for PMD files.
+    # A getter for PMD issues, returning PMD issues.
     # @return [Array[PmdFile]]
-    def pmd_files
-      @pmd_files ||= pmd_report.xpath("//file").map do |pmd_file|
+    def pmd_issues
+      @pmd_issues ||= pmd_report.xpath("//file").map do |pmd_file|
         PmdFile.new(gradle_module, pmd_file)
       end
     end
 
     # Send inline comment with Danger's warn or fail method
-    #
     # @return [void]
     def send_inline_comment
-      pmd_files.each do |pmd_file|
+      pmd_issues.each do |pmd_file|
         next unless target_files.include? pmd_file.absolute_path
 
         pmd_file.violations.each do |pmd_violation|

data/spec/pmd_spec.rb

@@ -47,51 +47,51 @@ module Danger
       it "Create files" do
         custom_report_path = "spec/fixtures/pmd_report.xml"
         @my_plugin.report_file = custom_report_path
-        pmd_files = @my_plugin.pmd_files
-        expect(pmd_files).not_to be_nil
+        pmd_issues = @my_plugin.pmd_issues
+        expect(pmd_issues).not_to be_nil
 
-        pmd_file1 = pmd_files[0]
-        expect(pmd_file1).not_to be_nil
-        expect(pmd_file1.source_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java")
-        expect(pmd_file1.absolute_path).to eq("app/src/main/java/com/android/sample/Tools.java")
-        expect(pmd_file1.violations).not_to be_nil
-        expect(pmd_file1.violations.length).to eq(1)
-        expect(pmd_file1.violations.first).not_to be_nil
-        expect(pmd_file1.violations.first.line).to eq(5)
-        expect(pmd_file1.violations.first.description).to eq("The utility class name 'Tools' doesn't match '[A-Z][a-zA-Z0-9]+(Utils?|Helper)'")
+        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("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
+        expect(pmd_issue1.violations.first.line).to eq(5)
+        expect(pmd_issue1.violations.first.description).to eq("The utility class name 'Tools' doesn't match '[A-Z][a-zA-Z0-9]+(Utils?|Helper)'")
 
-        pmd_file2 = pmd_files[1]
-        expect(pmd_file2).not_to be_nil
-        expect(pmd_file2.source_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/MainActivity.java")
-        expect(pmd_file2.absolute_path).to eq("app/src/main/java/com/android/sample/MainActivity.java")
-        expect(pmd_file2.violations).not_to be_nil
-        expect(pmd_file2.violations.length).to eq(1)
-        expect(pmd_file2.violations.first).not_to be_nil
-        expect(pmd_file2.violations.first.line).to eq(39)
-        expect(pmd_file2.violations.first.description).to eq("Use equals() to compare strings instead of '==' or '!='")
+        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("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
+        expect(pmd_issue2.violations.first.line).to eq(39)
+        expect(pmd_issue2.violations.first.description).to eq("Use equals() to compare strings instead of '==' or '!='")
 
-        pmd_file3 = pmd_files[2]
-        expect(pmd_file3).not_to be_nil
-        expect(pmd_file3.source_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ExampleUnitTest.java")
-        expect(pmd_file3.absolute_path).to eq("app/src/test/java/com/android/sample/ExampleUnitTest.java")
-        expect(pmd_file3.violations).not_to be_nil
-        expect(pmd_file3.violations.length).to eq(1)
-        expect(pmd_file3.violations.first).not_to be_nil
-        expect(pmd_file3.violations.first.line).to eq(15)
-        expect(pmd_file3.violations.first.description).to eq("The JUnit 4 test method name 'addition_isCorrect' doesn't match '[a-z][a-zA-Z0-9]*'")
+        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("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
+        expect(pmd_issue3.violations.first.line).to eq(15)
+        expect(pmd_issue3.violations.first.description).to eq("The JUnit 4 test method name 'addition_isCorrect' doesn't match '[a-z][a-zA-Z0-9]*'")
 
-        pmd_file4 = pmd_files[3]
-        expect(pmd_file4).not_to be_nil
-        expect(pmd_file4.source_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ToolsTest.java")
-        expect(pmd_file4.absolute_path).to eq("app/src/test/java/com/android/sample/ToolsTest.java")
-        expect(pmd_file4.violations).not_to be_nil
-        expect(pmd_file4.violations.length).to eq(2)
-        expect(pmd_file4.violations[0]).not_to be_nil
-        expect(pmd_file4.violations[0].line).to eq(12)
-        expect(pmd_file4.violations[0].description).to eq("The JUnit 4 test method name 'getLabel_1' doesn't match '[a-z][a-zA-Z0-9]*'")
-        expect(pmd_file4.violations[1]).not_to be_nil
-        expect(pmd_file4.violations[1].line).to eq(18)
-        expect(pmd_file4.violations[1].description).to eq("The JUnit 4 test method name 'getLabel_2' doesn't match '[a-z][a-zA-Z0-9]*'")
+        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("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
+        expect(pmd_issue4.violations[0].line).to eq(12)
+        expect(pmd_issue4.violations[0].description).to eq("The JUnit 4 test method name 'getLabel_1' doesn't match '[a-z][a-zA-Z0-9]*'")
+        expect(pmd_issue4.violations[1]).not_to be_nil
+        expect(pmd_issue4.violations[1].line).to eq(18)
+        expect(pmd_issue4.violations[1].description).to eq("The JUnit 4 test method name 'getLabel_2' doesn't match '[a-z][a-zA-Z0-9]*'")
       end
 
       it "Send inline comments" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger-pmd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mathieu Rul