danger-pmd 0.2.2 → 1.0.3

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    danger-pmd (0.2.1)
+    danger-pmd (1.0.3)
       danger-plugin-api (~> 1.0)
-      oga (~> 2.10)
+      oga (~> 2.15)
 
 GEM
   remote: https://rubygems.org/
@@ -11,40 +11,44 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
-    ast (2.4.0)
+    ast (2.4.2)
     claide (1.0.3)
     claide-plugins (0.9.2)
       cork
       nap
       open4 (~> 1.3)
-    coderay (1.1.2)
+    coderay (1.1.3)
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (6.1.0)
+    danger (8.2.3)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
-      faraday (~> 0.9)
+      faraday (>= 0.9.0, < 2.0)
       faraday-http-cache (~> 2.0)
-      git (~> 1.5)
-      kramdown (~> 2.0)
+      git (~> 1.7)
+      kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.0)
       no_proxy_fix
       octokit (~> 4.7)
-      terminal-table (~> 1)
+      terminal-table (>= 1, < 4)
     danger-plugin-api (1.0.0)
       danger (> 2.0)
-    diff-lcs (1.3)
-    faraday (0.17.1)
+    diff-lcs (1.4.4)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (2.0.0)
-      faraday (~> 0.8)
-    ffi (1.11.3)
+      ruby2_keywords
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    faraday-net_http (1.0.1)
+    ffi (1.15.0)
     formatador (0.2.5)
-    git (1.5.0)
-    guard (2.16.1)
+    git (1.8.1)
+      rchardet (~> 1.8)
+    guard (2.16.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -58,15 +62,15 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    jaro_winkler (1.5.4)
-    kramdown (2.1.0)
+    kramdown (2.3.1)
+      rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    listen (3.0.7)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9.7)
-    lumberjack (1.0.13)
-    method_source (0.9.2)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
     multipart-post (2.1.1)
     nap (1.1.0)
     nenv (0.3.0)
@@ -74,72 +78,88 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (4.14.0)
+    octokit (4.20.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     oga (2.15)
       ast
       ruby-ll (~> 2.1)
     open4 (1.3.4)
-    parallel (1.19.1)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    public_suffix (4.0.1)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (10.5.0)
-    rb-fsevent (0.10.3)
+    rake (13.0.3)
+    rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rchardet (1.8.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.78.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.11.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
     ruby-ll (2.1.2)
       ansi
       ast
-    ruby-progressbar (1.10.1)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
     shellany (0.0.1)
-    terminal-table (1.8.0)
+    terminal-table (3.0.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
-    thor (1.0.1)
-    unicode-display_width (1.6.0)
-    yard (0.9.20)
+    thor (1.1.0)
+    unicode-display_width (1.7.0)
+    yard (0.9.26)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.3)
+  bundler (~> 2.0)
   danger-pmd!
-  guard (~> 2.14)
-  guard-rspec (~> 4.7)
-  listen (= 3.0.7)
-  pry
-  rake (~> 10.0)
-  rspec (~> 3.4)
-  rubocop (~> 0.75)
-  yard (~> 0.9.20)
+  guard (~> 2.16.2)
+  guard-rspec (~> 4.7.3)
+  listen (~> 3.0.8)
+  pry (~> 0.14.0)
+  rake (~> 13.0)
+  rspec (~> 3.10.0)
+  rubocop (~> 1.11.0)
+  rubocop-rake (~> 0.5.1)
+  rubocop-rspec (~> 2.2.0)
+  yard (~> 0.9.26)
 
 BUNDLED WITH
-   1.17.3
+   2.2.14

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Mathieu Rul <mathroule@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,6 +1,10 @@
 # Danger PMD
 
-Danger plugin for PMD formatted xml file. This plugin is inspired from https://github.com/kazy1991/danger-findbugs.
+Checks on your Gradle project's Java source files.
+This is done using [PMD](https://pmd.github.io)
+Results are passed out as tables in markdown.
+
+This plugin is inspired from https://github.com/kazy1991/danger-findbugs.
 
 ## Installation
 
@@ -12,31 +16,44 @@ Danger plugin for PMD formatted xml file. This plugin is inspired from https://g
     your `Dangerfile` under the `pmd` namespace.
 
 <blockquote>Running PMD with its basic configuration
-<pre>
+  <pre>
+pmd.report
+  </pre>
+</blockquote>
+
+<blockquote>Running PMD with a specific Gradle task or report file (glob accepted)
+  <pre>
+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>
+  </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"
+<blockquote>Running PMD with a specific root path
+  <pre>
+pmd.root_path = '/Users/developer/project' # default: result of `git rev-parse --show-toplevel`
 pmd.report
-</pre>
+  </pre>
 </blockquote>
 
-<blockquote>Running PMD with an array of report files
-<pre>
-pmd.report_files = ["modules/**/build/reports/pmd/pmd.xml", "app/build/reports/pmd/pmd.xml"]
+<blockquote>Running PMD with an array of report files (glob accepted)
+  <pre>
+pmd.report_files = ['modules/**/build/reports/pmd/pmd.xml', 'app/build/reports/pmd/pmd.xml']
 pmd.report
-</pre>
+  </pre>
 </blockquote>
 
 <blockquote>Running PMD without running a Gradle task
-<pre>
-pmd.skip_gradle_task = true
+  <pre>
+pmd.skip_gradle_task = true # default: false
 pmd.report
-</pre>
+  </pre>
+</blockquote>
+
+<blockquote>Running PMD without inline comment
+  <pre>
+pmd.report(inline_mode: false) # default: true
+  </pre>
 </blockquote>
 
 #### Attributes
@@ -47,24 +64,26 @@ Defaults to "pmd".
 
 `skip_gradle_task` - Skip Gradle task.
 If you skip Gradle task, for example project does not manage Gradle.
+Defaults to `false`.
 
-`root_path` - Location of the project root
-If your project root is different from git's top-level path.
+`root_path` - 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".
 
-`report_file` - Location of report file
+`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".
 
-`report_files` - Location of report files
+`report_files` - 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]".
+Defaults to ['app/build/reports/pmd/pmd.xml'].
 
 #### Methods
 
-`report` - Calls PMD task of your Gradle project, send comment and return PMD issues.
+`report` - Calls PMD task of your Gradle project.
 It fails if `gradlew` cannot be found inside current directory.
-It fails if `report_file` or `report_files` cannot be found inside current directory.
+It fails if `report_file` cannot be found inside current directory.
+It fails if `report_files` is empty.
 
 `gradle_task` - A getter for `gradle_task`, returning Gradle task report.
 

data/danger-pmd.gemspec

@@ -4,40 +4,42 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pmd/gem_version.rb'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'danger-pmd'
-  spec.version       = Pmd::VERSION
-  spec.authors       = ['Mathieu Rul']
-  spec.email         = ['mathroule@gmail.com']
-  spec.description   = 'A Danger plugin for PMD.'
-  spec.summary       = 'A Danger plugin for PMD (Programming Mistake Detector), see https://pmd.github.io.'
-  spec.homepage      = 'https://github.com/mathroule/danger-pmd'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.name = 'danger-pmd'
+  spec.version = Pmd::VERSION
+  spec.authors = ['Mathieu Rul']
+  spec.email = ['mathroule@gmail.com']
+  spec.description = 'A Danger plugin for PMD.'
+  spec.summary = 'A Danger plugin for PMD (Programming Mistake Detector), see https://pmd.github.io.'
+  spec.homepage = 'https://github.com/mathroule/danger-pmd'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
-  spec.add_runtime_dependency 'oga', '~> 2.10'
+  spec.add_runtime_dependency 'oga', '~> 2.15'
 
   # General ruby development
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
 
   # Testing support
-  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
 
   # Linting code and docs
-  spec.add_development_dependency 'rubocop', '~> 0.75'
-  spec.add_development_dependency 'yard', '~> 0.9.20'
+  spec.add_development_dependency 'rubocop', '~> 1.11.0'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.5.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.2.0'
+  spec.add_development_dependency 'yard', '~> 0.9.26'
 
   # Makes testing easy via `bundle exec guard`
-  spec.add_development_dependency 'guard', '~> 2.14'
-  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'guard', '~> 2.16.2'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
 
   # If you want to work on older builds of ruby
-  spec.add_development_dependency 'listen', '3.0.7'
+  spec.add_development_dependency 'listen', '~> 3.0.8'
 
   # This gives you the chance to run a REPL inside your tests
   # via:
@@ -46,5 +48,5 @@ Gem::Specification.new do |spec|
   #    binding.pry
   #
   # This will stop test execution and let you inspect the results
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry', '~> 0.14.0'
 end

data/lib/danger_plugin.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require "pmd/plugin"
+require 'pmd/plugin'

data/lib/danger_pmd.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require "pmd/gem_version"
+require 'pmd/gem_version'

data/lib/pmd/entity/pmd_file.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Represent a PMD file.
+class PmdFile
+  require_relative './pmd_violation'
+
+  attr_accessor :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
+    @absolute_path = file.attribute('name').value.to_s
+
+    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
+  end
+
+  def violations
+    @violations ||= file.xpath('violation').map do |pmd_violation|
+      PmdViolation.new(pmd_violation)
+    end
+  end
+
+  private
+
+  def file_separator
+    File::ALT_SEPARATOR || File::SEPARATOR
+  end
+end