danger-pmd 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd4d93b63b4d3ea4eae56af9b26c904bcb3775556ba1ac76c0f3e946e4d9a020
-  data.tar.gz: cab647a193c407d35280addde594b52fa3f2c8c07051de104acc4456d55274a7
+  metadata.gz: a536da3a3b5d479ac3f2ecc733a3751a58a09c15c06716f1c6d712c1d22f53c9
+  data.tar.gz: fed8e05378b9e6cc981055fbe63d7806452ed53d64d7b85dbade5dfd6b99d129
 SHA512:
-  metadata.gz: 0df54a5be420d1dc391079f98c67d381897429434f2ddc21118b3557671f9b1b4cbc2f3f4078e8cbfe43ebc355d12842394a833e4f2f182ec1b3eaaf36fd3f1c
-  data.tar.gz: 78145da8cabb58fce118efac7930ac5831f58aa83cc15fbe824775b163d952b7019fcc94043472b0ddb29f7c99454cf07da15f1ab3e742e3989232a57be02aff
+  metadata.gz: 12b0b73c71cad94acdd1d75e49addb227067ae1fe92950c54670bd49915717ddb16e53a218cca352f6a0cb690e777c9f7d112e06a59cd1ef48c1e066243f7b47
+  data.tar.gz: '068f0e26176ef43f1a3d07f6fccccc1b5d5eefec9b3d6a3d82726988920132e3e0661da4be7e236a365ceeb7d821a3b00d724b1fc0c5c0f293503973f9717f28'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-pmd (1.0.2)
+    danger-pmd (1.0.3)
       danger-plugin-api (~> 1.0)
       oga (~> 2.15)
 

data/README.md

@@ -23,15 +23,15 @@ pmd.report
 
 <blockquote>Running PMD with a specific Gradle task or report file (glob accepted)
   <pre>
-pmd.gradle_task = 'app:pmd' # default: pmd
-pmd.report_file = 'module/build/reports/pmd/pmd.xml' # default: app/build/reports/pmd/pmd.xml
+pmd.gradle_task = 'module:pmd' # default: 'pmd'
+pmd.report_file = 'module/build/reports/pmd/pmd.xml' # default: 'app/build/reports/pmd/pmd.xml'
 pmd.report
   </pre>
 </blockquote>
 
 <blockquote>Running PMD with a specific root path
   <pre>
-pmd.root_path = '/Users/developer/project'
+pmd.root_path = '/Users/developer/project' # default: result of `git rev-parse --show-toplevel`
 pmd.report
   </pre>
 </blockquote>
@@ -45,11 +45,17 @@ pmd.report
 
 <blockquote>Running PMD without running a Gradle task
   <pre>
-pmd.skip_gradle_task = true
+pmd.skip_gradle_task = true # default: false
 pmd.report
   </pre>
 </blockquote>
 
+<blockquote>Running PMD without inline comment
+  <pre>
+pmd.report(inline_mode: false) # default: true
+  </pre>
+</blockquote>
+
 #### Attributes
 
 `gradle_task` - Custom Gradle task to run.

data/lib/pmd/entity/pmd_file.rb

@@ -20,10 +20,9 @@ class PmdFile
     @file = file
     @absolute_path = file.attribute('name').value.to_s
 
-    @prefix = prefix + (prefix.end_with?(file_separator) ? '' : file_separator)
-
-    @relative_path = if @absolute_path.start_with?(@prefix)
-                       @absolute_path[@prefix.length, @absolute_path.length - @prefix.length]
+    prefix += (prefix.end_with?(file_separator) ? '' : file_separator)
+    @relative_path = if @absolute_path.start_with?(prefix)
+                       @absolute_path[prefix.length, @absolute_path.length - prefix.length]
                      else
                        @absolute_path
                      end

data/lib/pmd/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pmd
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/lib/pmd/plugin.rb

@@ -11,13 +11,13 @@ module Danger
   #
   # @example Running PMD with a specific Gradle task or report file (glob accepted)
   #
-  #          pmd.gradle_task = 'app:pmd' # default: pmd
-  #          pmd.report_file = 'module/build/reports/pmd/pmd.xml' # default: app/build/reports/pmd/pmd.xml
+  #          pmd.gradle_task = 'module:pmd' # default: 'pmd'
+  #          pmd.report_file = 'module/build/reports/pmd/pmd.xml' # default: 'app/build/reports/pmd/pmd.xml'
   #          pmd.report
   #
   # @example Running PMD with a specific root path
   #
-  #          pmd.root_path = '/Users/developer/project'
+  #          pmd.root_path = '/Users/developer/project' # default: result of `git rev-parse --show-toplevel`
   #          pmd.report
   #
   # @example Running PMD with an array of report files (glob accepted)
@@ -27,9 +27,13 @@ module Danger
   #
   # @example Running PMD without running a Gradle task
   #
-  #          pmd.skip_gradle_task = true
+  #          pmd.skip_gradle_task = true # default: false
   #          pmd.report
   #
+  # @example Running PMD without inline comment
+  #
+  #          pmd.report(inline_mode: false) # default: true
+  #
   # @see mathroule/danger-pmd
   # @tags java, android, pmd
   class DangerPmd < Plugin
@@ -38,10 +42,12 @@ module Danger
     # Custom Gradle task to run.
     # This is useful when your project has different flavors.
     # Defaults to 'pmd'.
+    #
     # @return [String]
     attr_writer :gradle_task
 
     # A getter for `gradle_task`, returning 'pmd' if value is nil.
+    #
     # @return [String]
     def gradle_task
       @gradle_task ||= 'pmd'
@@ -50,10 +56,12 @@ module Danger
     # Skip Gradle task.
     # If you skip Gradle task, for example project does not manage Gradle.
     # Defaults to `false`.
-    # @return [Bool]
+    #
+    # @return [Boolean]
     attr_writer :skip_gradle_task
 
     # A getter for `skip_gradle_task`, returning false if value is nil.
+    #
     # @return [Boolean]
     def skip_gradle_task
       @skip_gradle_task ||= false
@@ -62,34 +70,40 @@ module Danger
     # 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.
+    #
+    # @return [String]
     attr_writer :root_path
 
-    # A getter for `root_path`, returning result of 'git rev-parse --show-toplevel' if value is nil.
+    # 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.
+    # If your PMD task task outputs to a different location, you can specify it here.
     # Defaults to 'app/build/reports/pmd/pmd.xml'.
+    #
     # @return [String]
     attr_writer :report_file
 
     # A getter for `report_file`, returning 'app/build/reports/pmd/pmd.xml' if value is nil.
+    #
     # @return [String]
     def report_file
       @report_file ||= 'app/build/reports/pmd/pmd.xml'
     end
 
     # Location of report files.
-    # If your pmd task outputs to a different location, you can specify it here.
+    # If your PMD task outputs to a different location, you can specify it here.
     # Defaults to ['app/build/reports/pmd/pmd.xml'].
+    #
     # @return [Array[String]]
     attr_writer :report_files
 
     # A getter for `report_files`, returning ['app/build/reports/pmd/pmd.xml'] if value is nil.
+    #
     # @return [Array[String]]
     def report_files
       @report_files ||= [report_file]
@@ -99,6 +113,9 @@ module Danger
     # It fails if `gradlew` cannot be found inside current directory.
     # It fails if `report_file` cannot be found inside current directory.
     # It fails if `report_files` is empty.
+    #
+    # @param [Boolean] inline_mode Report as inline comment, defaults to [true].
+    #
     # @return [Array[PmdFile]]
     def report(inline_mode: true)
       unless skip_gradle_task
@@ -116,24 +133,23 @@ module Danger
     private
 
     # Check gradlew file exists in current directory.
-    # @return [Bool]
+    #
+    # @return [Boolean]
     def gradlew_exists?
       !`ls gradlew`.strip.empty?
     end
 
     # Run Gradle task.
+    #
     # @return [void]
     def exec_gradle_task
       system "./gradlew #{gradle_task}"
     end
 
-    # Check report_file exists in current directory.
-    # @return [Bool]
-    def report_file_exist?(report_file)
-      File.exist?(report_file)
-    end
-
     # A getter for `pmd_report`, returning PMD report.
+    #
+    # @param [String] report_file The report file.
+    #
     # @return [Oga::XML::Document]
     def pmd_report(report_file)
       require 'oga'
@@ -141,6 +157,9 @@ module Danger
     end
 
     # A getter for PMD issues, returning PMD issues.
+    #
+    # @param [String] report_file The report file.
+    #
     # @return [Array[PmdFile]]
     def pmd_issues(report_file)
       pmd_report(report_file).xpath('//file').map do |pmd_file|
@@ -149,12 +168,16 @@ module Danger
     end
 
     # A getter for current updated files.
+    #
     # @return [Array[String]]
     def target_files
       @target_files ||= (git.modified_files - git.deleted_files) + git.added_files
     end
 
     # Generate report and send inline comment with Danger's warn or fail method.
+    #
+    # @param [Boolean] inline_mode Report as inline comment, defaults to [true].
+    #
     # @return [Array[PmdFile]]
     def do_comment(report_files, inline_mode)
       pmd_issues = []
@@ -163,16 +186,16 @@ module Danger
         pmd_issues(report_file).each do |pmd_file|
           next unless target_files.include? pmd_file.relative_path
 
-          parse_file(pmd_file, pmd_issues, inline_mode)
+          pmd_issues.push(pmd_file)
+
+          send_comment(pmd_file, inline_mode)
         end
       end
 
       pmd_issues
     end
 
-    def parse_file(pmd_file, pmd_issues, inline_mode)
-      pmd_issues.push(pmd_file)
-
+    def send_comment(pmd_file, inline_mode)
       pmd_file.violations.each do |pmd_violation|
         if inline_mode
           send(pmd_violation.type, pmd_violation.description, file: pmd_file.relative_path, line: pmd_violation.line)

data/spec/pmd_spec.rb

@@ -19,19 +19,26 @@ module Danger
       end
 
       it 'Set custom Gradle task' do
-        custom_task = 'pmdStagingDebug'
-        @pmd.gradle_task = custom_task
-        expect(@pmd.gradle_task).to eq(custom_task)
+        @pmd.gradle_task = 'pmdStagingDebug'
+        expect(@pmd.gradle_task).to eq('pmdStagingDebug')
       end
 
       it 'Check default skip Gradle task' do
-        expect(@pmd.skip_gradle_task).to eq(false)
+        expect(@pmd.skip_gradle_task).to be_falsey
       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)
+        @pmd.skip_gradle_task = true
+        expect(@pmd.skip_gradle_task).to be_truthy
+      end
+
+      it 'Check default root path' do
+        expect(@pmd.root_path).to eq(Dir.pwd)
+      end
+
+      it 'Set custom root path' do
+        @pmd.root_path = '/Users/developer/project'
+        expect(@pmd.root_path).to eq('/Users/developer/project')
       end
 
       it 'Check default report file path' do
@@ -39,19 +46,17 @@ module Danger
       end
 
       it 'Set custom report file path' do
-        custom_report_path = 'custom-path/pmd_sub_report.xml'
-        @pmd.report_file = custom_report_path
-        expect(@pmd.report_file).to eq(custom_report_path)
+        @pmd.report_file = 'custom-path/pmd_sub_report.xml'
+        expect(@pmd.report_file).to eq('custom-path/pmd_sub_report.xml')
       end
 
       it 'Check default report files paths' do
-        expect(@pmd.report_files).to eq(['app/build/reports/pmd/pmd.xml'])
+        expect(@pmd.report_files).to contain_exactly('app/build/reports/pmd/pmd.xml')
       end
 
       it 'Set custom report files paths' do
-        custom_report_paths = %w[custom-path/pmd_report_1.xml custom-path/pmd_report_2.xml]
-        @pmd.report_files = custom_report_paths
-        expect(@pmd.report_files).to eq(custom_report_paths)
+        @pmd.report_files = %w[custom-path/pmd_report_1.xml custom-path/pmd_report_2.xml]
+        expect(@pmd.report_files).to contain_exactly('custom-path/pmd_report_1.xml', 'custom-path/pmd_report_2.xml')
       end
 
       it 'Check default root path' do
@@ -59,17 +64,17 @@ module Danger
       end
 
       it 'Set custom root path' do
-        root_path = '/Users/developer/sample/'
-        @pmd.root_path = root_path
-        expect(@pmd.root_path).to eq(root_path)
+        @pmd.root_path = '/Users/developer/sample/'
+        expect(@pmd.root_path).to eq('/Users/developer/sample/')
       end
 
       it 'Report with report file' do
+        # noinspection RubyLiteralArrayInspection
         target_files = [
-          "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"
+          '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)
 
@@ -125,15 +130,16 @@ module Danger
         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 "Report with report file not in target files" do
+      it 'Report with report file not in target files' do
+        # noinspection RubyLiteralArrayInspection
         target_files = [
-          "app/src/main/java/com/android/sample/Tools.java",
-          "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.report_file = 'spec/fixtures/pmd_report.xml'
+        @pmd.root_path = '/Users/developer/sample/'
         @pmd.skip_gradle_task = true
 
         pmd_issues = @pmd.report
@@ -164,14 +170,15 @@ module Danger
         expect(pmd_issue2.violations[1].description).to eq("The JUnit 4 test method name 'getLabel_2' doesn't match '[a-z][a-zA-Z0-9]*'")
       end
 
-      it "Report with report files" do
+      it 'Report with report files' do
+        # noinspection RubyLiteralArrayInspection
         target_files = [
-          "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"
+          '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)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-pmd
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Mathieu Rul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-18 00:00:00.000000000 Z
+date: 2021-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api