danger-pmd 1.0.1 → 1.0.2

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    danger-pmd (1.0.1)
+    danger-pmd (1.0.2)
       danger-plugin-api (~> 1.0)
-      oga (~> 2.10)
+      oga (~> 2.15)
 
 GEM
   remote: https://rubygems.org/
@@ -11,17 +11,17 @@ 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 (8.2.2)
+    danger (8.2.3)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -33,10 +33,10 @@ GEM
       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)
+    diff-lcs (1.4.4)
     faraday (1.3.0)
       faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
@@ -44,11 +44,11 @@ GEM
     faraday-http-cache (2.2.0)
       faraday (>= 0.8)
     faraday-net_http (1.0.1)
-    ffi (1.11.3)
+    ffi (1.15.0)
     formatador (0.2.5)
     git (1.8.1)
       rchardet (~> 1.8)
-    guard (2.16.1)
+    guard (2.16.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -62,16 +62,15 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    jaro_winkler (1.5.4)
-    kramdown (2.3.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)
@@ -86,69 +85,81 @@ GEM
       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)
+    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 (13.0.1)
-    rb-fsevent (0.10.3)
+    rake (13.0.3)
+    rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rchardet (1.8.0)
+    regexp_parser (2.1.1)
     rexml (3.2.4)
-    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)
+    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
+  guard (~> 2.16.2)
+  guard-rspec (~> 4.7.3)
+  listen (~> 3.0.8)
+  pry (~> 0.14.0)
   rake (~> 13.0)
-  rspec (~> 3.4)
-  rubocop (~> 0.75)
-  yard (~> 0.9.20)
+  rspec (~> 3.10.0)
+  rubocop (~> 1.11.0)
+  rubocop-rake (~> 0.5.1)
+  rubocop-rspec (~> 2.2.0)
+  yard (~> 0.9.26)
 
 BUNDLED WITH
    2.2.14

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 '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

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
+# Represent a PMD file.
 class PmdFile
-  require_relative "./pmd_violation"
+  require_relative './pmd_violation'
 
   attr_accessor :file
 
@@ -17,23 +18,19 @@ class PmdFile
 
   def initialize(prefix, file)
     @file = file
-    @absolute_path = file.attribute("name").value.to_s
+    @absolute_path = file.attribute('name').value.to_s
 
-    if prefix.end_with?(file_separator)
-      @prefix = prefix
-    else
-      @prefix = prefix + file_separator
-    end
+    @prefix = prefix + (prefix.end_with?(file_separator) ? '' : file_separator)
 
-    if @absolute_path.start_with?(@prefix)
-      @relative_path = @absolute_path[@prefix.length, @absolute_path.length - @prefix.length]
-    else
-      @relative_path = @absolute_path
-    end
+    @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|
+    @violations ||= file.xpath('violation').map do |pmd_violation|
       PmdViolation.new(pmd_violation)
     end
   end

data/lib/pmd/entity/pmd_violation.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Represent a PMD violation.
 class PmdViolation
   PRIORITY_ERROR_THRESHOLD = 4
   attr_accessor :violation
@@ -9,7 +10,7 @@ class PmdViolation
   end
 
   def priority
-    @priority ||= violation.attribute("priority").value.to_i
+    @priority ||= violation.attribute('priority').value.to_i
   end
 
   def type
@@ -17,10 +18,10 @@ class PmdViolation
   end
 
   def line
-    @line ||= violation.attribute("beginline").value.to_i
+    @line ||= violation.attribute('beginline').value.to_i
   end
 
   def description
-    @description ||= violation.text.gsub("\n", "")
+    @description ||= violation.text.gsub("\n", '')
   end
 end

data/lib/pmd/gem_version.rb

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

data/lib/pmd/plugin.rb

@@ -33,18 +33,18 @@ module Danger
   # @see mathroule/danger-pmd
   # @tags java, android, pmd
   class DangerPmd < Plugin
-    require_relative "./entity/pmd_file"
+    require_relative './entity/pmd_file'
 
     # Custom Gradle task to run.
     # This is useful when your project has different flavors.
-    # Defaults to "pmd".
+    # Defaults to 'pmd'.
     # @return [String]
     attr_writer :gradle_task
 
-    # A getter for `gradle_task`, returning "pmd" if value is nil.
+    # A getter for `gradle_task`, returning 'pmd' if value is nil.
     # @return [String]
     def gradle_task
-      @gradle_task ||= "pmd"
+      @gradle_task ||= 'pmd'
     end
 
     # Skip Gradle task.
@@ -61,11 +61,11 @@ 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".
+    # 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.
+    # 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
@@ -73,23 +73,23 @@ module Danger
 
     # 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".
+    # 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.
+    # 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"
+      @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.
-    # Defaults to ["app/build/reports/pmd/pmd.xml"].
+    # 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.
+    # 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]
@@ -100,15 +100,15 @@ 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_mode: true)
       unless skip_gradle_task
-        return fail("Could not find `gradlew` inside current directory") unless gradlew_exists?
+        raise('Could not find `gradlew` inside current directory') unless gradlew_exists?
 
         exec_gradle_task
       end
 
       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?
+      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
@@ -136,14 +136,14 @@ module Danger
     # A getter for `pmd_report`, returning PMD report.
     # @return [Oga::XML::Document]
     def pmd_report(report_file)
-      require "oga"
+      require 'oga'
       Oga.parse_xml(File.open(report_file))
     end
 
     # A getter for PMD issues, returning PMD issues.
     # @return [Array[PmdFile]]
     def pmd_issues(report_file)
-      pmd_report(report_file).xpath("//file").map do |pmd_file|
+      pmd_report(report_file).xpath('//file').map do |pmd_file|
         PmdFile.new(root_path, pmd_file)
       end
     end
@@ -156,26 +156,30 @@ module Danger
 
     # Generate report and send inline comment with Danger's warn or fail method.
     # @return [Array[PmdFile]]
-    def do_comment(report_files, inline_mode = true)
+    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)
-
-          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
+          parse_file(pmd_file, pmd_issues, inline_mode)
         end
       end
 
       pmd_issues
     end
+
+    def parse_file(pmd_file, pmd_issues, inline_mode)
+      pmd_issues.push(pmd_file)
+
+      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
   end
 end