danger-pmd 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed7c20c01b799e6dbb65c79231881419974d23e159eb37eac8a06c6515f54e74
-  data.tar.gz: 713039e5ddc346d2d9d4ad1584f0ca0e9c12195f9d185c831286cca13d90a335
+  metadata.gz: 4cc9fb89231f4e208ace7fecad1dc8efc13a5cbc762a044ce10e280cfa8bf4cf
+  data.tar.gz: e7aa70238501b80d9106bb088ae8da08f816fdf7f0f21f13e64ac1a37f667686
 SHA512:
-  metadata.gz: ab07baefcd8d71857370394b05fda51321a163269db0c5eb7b04aa3fae69e20b4f0241aec79f66aeb8dc1eeef30e3f51e73c4fb3ceb5c4577862941bcb79456e
-  data.tar.gz: 3d27b055ada8d15588e9585c60b10ddf45d5cc990bbd41f380e5b2e2e69181c9c2f67f639ca3444354e17bcd7869f3b72142302674da6a4997048dd99940fd1a
+  metadata.gz: dacdaeac8a0bbcdc9776876c3ddb6aca4e7124771de19389ed2a3b242fbfa451461190777350195ea6c77ffa51cc6e0a781387fb086b925ee0c49d1180a3875b
+  data.tar.gz: b3c230a67ea00f6bef06997204e142f6a5dbcb36a50b9ae814183e479bb736eb27e3e85bcf6d8ff9e748fb9b2d6d6637171edb9fa4874a4ea3eb90572002437a

data/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+    branches: [ main ]
+
+jobs:
+  test:
+    name: Publish gem
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake spec
+      - name: Publish gem
+        uses: dawidd6/action-publish-gem@v1
+        with:
+          api_key: ${{secrets.RUBYGEMS_API_KEY}}
+      - name: Create git tag
+        uses: duderman/gh-gem-tag-action@v1
+        id: release_info
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: xresloader/upload-to-github-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.release_info.outputs.tag }}
+          draft: false
+          file: '*.gem'

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake spec

data/.rubocop.yml

@@ -3,7 +3,7 @@
 # If you don't like these settings, just delete this file :)
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-pmd (0.1.1)
+    danger-pmd (1.0.1)
       danger-plugin-api (~> 1.0)
       oga (~> 2.10)
 
@@ -21,15 +21,15 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (6.1.0)
+    danger (8.2.2)
       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)
@@ -37,13 +37,17 @@ GEM
     danger-plugin-api (1.0.0)
       danger (> 2.0)
     diff-lcs (1.3)
-    faraday (0.17.1)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (2.0.0)
-      faraday (~> 0.8)
+      ruby2_keywords
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    faraday-net_http (1.0.1)
     ffi (1.11.3)
     formatador (0.2.5)
-    git (1.5.0)
+    git (1.8.1)
+      rchardet (~> 1.8)
     guard (2.16.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -59,7 +63,8 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     jaro_winkler (1.5.4)
-    kramdown (2.1.0)
+    kramdown (2.3.0)
+      rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     listen (3.0.7)
@@ -74,7 +79,8 @@ 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
@@ -86,12 +92,14 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (4.0.1)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    rchardet (1.8.0)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -116,6 +124,7 @@ GEM
       ansi
       ast
     ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.4)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
@@ -136,10 +145,10 @@ DEPENDENCIES
   guard-rspec (~> 4.7)
   listen (= 3.0.7)
   pry
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.4)
   rubocop (~> 0.75)
   yard (~> 0.9.20)
 
 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,38 @@ 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 = 'app: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'
 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>
+  <pre>
 pmd.skip_gradle_task = true
 pmd.report
-</pre>
+  </pre>
 </blockquote>
 
 #### Attributes
@@ -47,24 +58,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

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
   # General ruby development
   spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
 
   # Testing support
   spec.add_development_dependency 'rspec', '~> 3.4'

data/lib/pmd/{pmd_violation.rb → entity/pmd_violation.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class PmdViolation
-  PRIORITY_ERROR_THRESHOLD = 2
+  PRIORITY_ERROR_THRESHOLD = 4
   attr_accessor :violation
 
   def initialize(violation)

data/lib/pmd/gem_version.rb

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

data/lib/pmd/plugin.rb

@@ -11,18 +11,18 @@ module Danger
   #
   # @example Running PMD with a specific Gradle task or report file (glob accepted)
   #
-  #          pmd.gradle_task = 'app:pmd' #defalut: pmd
-  #          pmd.report_file = "module/build/reports/pmd/pmd.xml" #defalut: app/build/reports/pmd/pmd.xml
+  #          pmd.gradle_task = 'app: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'
   #          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_files = ['modules/**/build/reports/pmd/pmd.xml', 'app/build/reports/pmd/pmd.xml']
   #          pmd.report
   #
   # @example Running PMD without running a Gradle task
@@ -32,9 +32,8 @@ module Danger
   #
   # @see mathroule/danger-pmd
   # @tags java, android, pmd
-
   class DangerPmd < Plugin
-    require_relative "./pmd_file"
+    require_relative "./entity/pmd_file"
 
     # Custom Gradle task to run.
     # This is useful when your project has different flavors.
@@ -101,7 +100,7 @@ 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_comment = true)
+    def report(inline_mode = true)
       unless skip_gradle_task
         return fail("Could not find `gradlew` inside current directory") unless gradlew_exists?
 
@@ -111,7 +110,7 @@ module Danger
       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?
 
-      do_comment(report_files_expanded, inline_comment)
+      do_comment(report_files_expanded, inline_mode)
     end
 
     private
@@ -157,7 +156,7 @@ module Danger
 
     # Generate report and send inline comment with Danger's warn or fail method.
     # @return [Array[PmdFile]]
-    def do_comment(report_files, inline_comment = true)
+    def do_comment(report_files, inline_mode = true)
       pmd_issues = []
 
       report_files.each do |report_file|
@@ -167,7 +166,7 @@ module Danger
           pmd_issues.push(pmd_file)
 
           pmd_file.violations.each do |pmd_violation|
-            if inline_comment
+            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}")

data/spec/entity/pmd_file_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "../spec_helper"
+
+module Pmd
+  require "oga"
+
+  describe PmdFile do
+    it "should initialize relative path ending with file separator" do
+      xml = Oga.parse_xml(File.open("spec/fixtures/pmd_report.xml"))
+      pmd_file = PmdFile.new("/Users/developer/sample/", xml.xpath("//file").first)
+
+      expect(pmd_file.absolute_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java")
+      expect(pmd_file.relative_path).to eq("app/src/main/java/com/android/sample/Tools.java")
+      expect(pmd_file.violations).not_to be_nil
+      expect(pmd_file.violations.length).to eq(1)
+      expect(pmd_file.violations.first).not_to be_nil
+      expect(pmd_file.violations.first.line).to eq(5)
+      expect(pmd_file.violations.first.description).to eq("The utility class name 'Tools' doesn't match '[A-Z][a-zA-Z0-9]+(Utils?|Helper)'")
+    end
+
+    it "should initialize relative path not ending with file separator" do
+      xml = Oga.parse_xml(File.open("spec/fixtures/pmd_report.xml"))
+      pmd_file = PmdFile.new("/Users/developer/sample", xml.xpath("//file").first)
+
+      expect(pmd_file.absolute_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java")
+      expect(pmd_file.relative_path).to eq("app/src/main/java/com/android/sample/Tools.java")
+      expect(pmd_file.violations).not_to be_nil
+      expect(pmd_file.violations.length).to eq(1)
+      expect(pmd_file.violations.first).not_to be_nil
+      expect(pmd_file.violations.first.line).to eq(5)
+      expect(pmd_file.violations.first.description).to eq("The utility class name 'Tools' doesn't match '[A-Z][a-zA-Z0-9]+(Utils?|Helper)'")
+    end
+
+    it "should initialize relative path not prefixed" do
+      xml = Oga.parse_xml(File.open("spec/fixtures/pmd_report.xml"))
+      pmd_file = PmdFile.new("/Users/developer/something", xml.xpath("//file").first)
+
+      expect(pmd_file.absolute_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java")
+      expect(pmd_file.relative_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java")
+      expect(pmd_file.violations).not_to be_nil
+      expect(pmd_file.violations.length).to eq(1)
+      expect(pmd_file.violations.first).not_to be_nil
+      expect(pmd_file.violations.first.line).to eq(5)
+      expect(pmd_file.violations.first.description).to eq("The utility class name 'Tools' doesn't match '[A-Z][a-zA-Z0-9]+(Utils?|Helper)'")
+    end
+  end
+end

data/spec/pmd_spec.rb

@@ -176,7 +176,7 @@ module Danger
         allow_any_instance_of(Danger::DangerPmd).to receive(:target_files).and_return(target_files)
 
         @pmd.report_files = ["spec/fixtures/pmd_report.xml", "spec/fixtures/**/pmd_sub_report.xml"]
-        @pmd.root_path = "/Users/developer/sample"
+        @pmd.root_path = "/Users/developer/sample/"
         @pmd.skip_gradle_task = true
 
         pmd_issues = @pmd.report

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-pmd
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mathieu Rul
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-30 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -171,22 +171,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/publish.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - Guardfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - danger-pmd.gemspec
 - lib/danger_plugin.rb
 - lib/danger_pmd.rb
+- lib/pmd/entity/pmd_file.rb
+- lib/pmd/entity/pmd_violation.rb
 - lib/pmd/gem_version.rb
 - lib/pmd/plugin.rb
-- lib/pmd/pmd_file.rb
-- lib/pmd/pmd_violation.rb
+- spec/entity/pmd_file_spec.rb
 - spec/fixtures/pmd_report.xml
 - spec/fixtures/report_1/pmd_sub_report.xml
 - spec/fixtures/report_2/pmd_sub_report.xml
@@ -211,11 +213,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A Danger plugin for PMD (Programming Mistake Detector), see https://pmd.github.io.
 test_files:
+- spec/entity/pmd_file_spec.rb
 - spec/fixtures/pmd_report.xml
 - spec/fixtures/report_1/pmd_sub_report.xml
 - spec/fixtures/report_2/pmd_sub_report.xml

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-cache:
-  directories:
-    - bundle
-
-rvm:
-  - 2.3.8
-
-script:
-    - bundle exec rake spec

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2019 Mathieu Rul <mathroule@gmail.com>
-
-MIT License
-
-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.