class Danger::DangerPmd
Checks on your Gradle project's Java source files. This is done using [PMD](pmd.github.io) Results are passed out as tables in markdown.
@example Running PMD with its basic configuration
pmd.report
@example Running PMD with a specific Gradle task or report file (glob accepted)
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' # default: result of `git rev-parse --show-toplevel` 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'] pmd.report
@example Running PMD without running a Gradle task
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
Attributes
Custom Gradle task to run. This is useful when your project has different flavors. Defaults to 'pmd'.
@return [String]
Location of report file. 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]
Location of report files. If your PMD task outputs to a different location, you can specify it here. Defaults to ['app/build/reports/pmd/pmd.xml'].
@return [Array]
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]
Skip Gradle task. If you skip Gradle task, for example project does not manage Gradle. Defaults to `false`.
@return [Boolean]
Public Instance Methods
A getter for `gradle_task`, returning 'pmd' if value is nil.
@return [String]
# File lib/pmd/plugin.rb, line 52 def gradle_task @gradle_task ||= 'pmd' end
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. It fails if `report_files` is empty.
@param [Boolean] inline_mode Report as inline comment, defaults to [true].
@return [Array]
# File lib/pmd/plugin.rb, line 120 def report(inline_mode: true) unless skip_gradle_task raise('Could not find `gradlew` inside current directory') unless gradlew_exists? exec_gradle_task end report_files_expanded = Dir.glob(report_files).sort raise("Could not find matching PMD report files for #{report_files} inside current directory") if report_files_expanded.empty? do_comment(report_files_expanded, inline_mode) end
A getter for `report_file`, returning 'app/build/reports/pmd/pmd.xml' if value is nil.
@return [String]
# File lib/pmd/plugin.rb, line 94 def report_file @report_file ||= 'app/build/reports/pmd/pmd.xml' end
A getter for `report_files`, returning ['app/build/reports/pmd/pmd.xml'] if value is nil.
@return [Array]
# File lib/pmd/plugin.rb, line 108 def report_files @report_files ||= [report_file] end
A getter for `root_path`, returning result of `git rev-parse –show-toplevel` if value is nil.
@return [String]
# File lib/pmd/plugin.rb, line 80 def root_path @root_path ||= `git rev-parse --show-toplevel`.chomp end
A getter for `skip_gradle_task`, returning false if value is nil.
@return [Boolean]
# File lib/pmd/plugin.rb, line 66 def skip_gradle_task @skip_gradle_task ||= false end
Private Instance Methods
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]
# File lib/pmd/plugin.rb, line 182 def do_comment(report_files, inline_mode) pmd_issues = [] report_files.each do |report_file| pmd_issues(report_file).each do |pmd_file| next unless target_files.include? pmd_file.relative_path pmd_issues.push(pmd_file) send_comment(pmd_file, inline_mode) end end pmd_issues end
Run Gradle task.
@return [void]
# File lib/pmd/plugin.rb, line 145 def exec_gradle_task system "./gradlew #{gradle_task}" end
Check gradlew file exists in current directory.
@return [Boolean]
# File lib/pmd/plugin.rb, line 138 def gradlew_exists? !`ls gradlew`.strip.empty? end
A getter for PMD issues, returning PMD issues.
@param [String] report_file
The report file.
@return [Array]
# File lib/pmd/plugin.rb, line 164 def pmd_issues(report_file) pmd_report(report_file).xpath('//file').map do |pmd_file| PmdFile.new(root_path, pmd_file) end end
A getter for `pmd_report`, returning PMD report.
@param [String] report_file
The report file.
@return [Oga::XML::Document]
# File lib/pmd/plugin.rb, line 154 def pmd_report(report_file) require 'oga' Oga.parse_xml(File.open(report_file)) end
# File lib/pmd/plugin.rb, line 198 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) else send(pmd_violation.type, "#{pmd_file.relative_path} : #{pmd_violation.description} at #{pmd_violation.line}") end end end
A getter for current updated files.
@return [Array]
# File lib/pmd/plugin.rb, line 173 def target_files @target_files ||= (git.modified_files - git.deleted_files) + git.added_files end