danger-pmd 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25bc46f8d31771647e30e868e5c70414c8a09f5d020351b4442f998698f7f8a5
+  data.tar.gz: 882f95e0c94495be3507a2f5be3af5e5eebcf26af3fe9f98fe3b37590719f22b
+SHA512:
+  metadata.gz: 9e86137b4137acdc557fa7c17ddfe8958c3d2f153adbe1a2ce8eabfef2d24421aaa641777cecf85088fe9ff7d7b1b8a9bd5b75d52b1c8a761f03e628ee1e0b6b
+  data.tar.gz: 17a959da13097dab76c2eab0eee92357701a63f876a2b3743c2b57e4313175fe68a5e53f9d147f214b4c99bfeb72d1ab6131d3cd5f6af6619d03843ec78bef24

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+.idea/
+.yardoc

data/.rubocop.yml

@@ -0,0 +1,152 @@
+# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+# If you don't like these settings, just delete this file :)
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# It's better to be more explicit about the type
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/IndentFirstHashElement:
+  Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# FIXME: 25
+Metrics/BlockLength:
+  Max: 345
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/MixinGrouping:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%":  ()
+    "%i": ()
+    "%q": ()
+    "%Q": ()
+    "%r": "{}"
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": ()
+
+Security/YAMLLoad:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-pmd.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,145 @@
+PATH
+  remote: .
+  specs:
+    danger-pmd (0.0.1)
+      danger-plugin-api (~> 1.0)
+      oga (~> 2.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    ast (2.4.0)
+    claide (1.0.3)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.2)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (6.1.0)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.5)
+      kramdown (~> 2.0)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.3)
+    faraday (0.16.2)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.0.0)
+      faraday (~> 0.8)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    git (1.5.0)
+    guard (2.15.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.3)
+    kramdown (2.1.0)
+    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)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.14.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    oga (2.15)
+      ast
+      ruby-ll (~> 2.1)
+    open4 (1.3.4)
+    parallel (1.17.0)
+    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)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.3)
+    rubocop (0.75.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-ll (2.1.2)
+      ansi
+      ast
+    ruby-progressbar (1.10.1)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.20.3)
+    unicode-display_width (1.6.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  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)
+
+BUNDLED WITH
+   1.17.2

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+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.

data/README.md

@@ -0,0 +1,20 @@
+# Danger PMD
+
+Danger plugin for PMD report XML file. This plugin is inspired from https://github.com/kazy1991/danger-findbugs.
+
+## Installation
+
+    $ gem install danger-pmd
+
+## Usage
+
+    Methods and attributes from this plugin are available in
+    your `Dangerfile` under the `pmd` namespace.
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = %w(lib/**/*.rb spec/**/*.rb)
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-pmd.gemspec

@@ -0,0 +1,50 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$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.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+  spec.add_runtime_dependency 'oga', '~> 2.10'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_development_dependency 'rubocop', '~> 0.75'
+  spec.add_development_dependency 'yard', '~> 0.9.20'
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_plugin.rb

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

data/lib/danger_pmd.rb

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

data/lib/pmd/gem_version.rb

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

data/lib/pmd/plugin.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Danger
+  # 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.
+  #
+  # @example Running PMD with its basic configuration
+  #
+  #          pmd.report
+  #
+  # @example Running PMD with a specific Gradle task or report_file
+  #
+  #          pmd.gradle_task = 'app:pmd' #defalut: pmd
+  #          pmd.report_file = "app/build/reports/pmd/pmd.xml"
+  #          pmd.report
+  #
+  # @see mathroule/danger-pmd
+  # @tags java, android, pmd
+
+  class DangerPmd < Plugin
+    require_relative "./pmd_file"
+
+    # Custom Gradle module to run.
+    # This is useful when your project has different flavors.
+    # Defaults to "app".
+    # @return [String]
+    attr_writer :gradle_module
+
+    # Custom Gradle task to run.
+    # This is useful when your project has different flavors.
+    # Defaults to "pmd".
+    # @return [String]
+    attr_writer :gradle_task
+
+    # Location of report file
+    # If your pmd task outputs to a different location, you can specify it here.
+    # Defaults to "build/reports/pmd/pmd.xml".
+    # @return [String]
+    attr_writer :report_file
+
+    GRADLEW_NOT_FOUND = "Could not find `gradlew` inside current directory"
+    REPORT_FILE_NOT_FOUND = "PMD report not found"
+
+    # 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.
+    # @return [void]
+    def report(inline_mode = true)
+      return fail(GRADLEW_NOT_FOUND) unless gradlew_exists?
+
+      exec_gradle_task
+      return fail(REPORT_FILE_NOT_FOUND) unless report_file_exist?
+
+      if inline_mode
+        send_inline_comment
+      end
+    end
+
+    # A getter for `gradle_module`, returning "app" if value is nil.
+    # @return [String]
+    def gradle_module
+      @gradle_module ||= "app"
+    end
+
+    # A getter for `gradle_task`, returning "pmd" if value is nil.
+    # @return [String]
+    def gradle_task
+      @gradle_task ||= "pmd"
+    end
+
+    # 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
+
+    # A getter for current updated files
+    # @return [Array[String]]
+    def target_files
+      @target_files ||= (git.modified_files - git.deleted_files) + git.added_files
+    end
+
+    # Run gradle task
+    # @return [void]
+    def exec_gradle_task
+      system "./gradlew #{gradle_task}"
+    end
+
+    # Check gradlew file exists in current directory
+    # @return [Bool]
+    def gradlew_exists?
+      !`ls gradlew`.strip.empty?
+    end
+
+    # Check report_file exists in current directory
+    # @return [Bool]
+    def report_file_exist?
+      File.exist?(report_file)
+    end
+
+    # A getter for `gradle_task`, returning "pmd" if value is nil.
+    # @return [Oga::XML::Document]
+    def pmd_report
+      require "oga"
+      @pmd_report ||= Oga.parse_xml(File.open(report_file))
+    end
+
+    # A getter for PMD files.
+    # @return [Array[PmdFile]]
+    def pmd_files
+      @pmd_files ||= pmd_report.xpath("//file").map do |pmd_file|
+        PmdFile.new(gradle_module, pmd_file)
+      end
+    end
+
+    # Send inline comment with Danger's warn or fail method
+    #
+    # @return [void]
+    def send_inline_comment
+      pmd_files.each do |pmd_file|
+        next unless target_files.include? pmd_file.absolute_path
+
+        pmd_file.violations.each do |pmd_violation|
+          send(pmd_violation.type, pmd_violation.description, file: pmd_file.absolute_path, line: pmd_violation.line)
+        end
+      end
+    end
+  end
+end

data/lib/pmd/pmd_file.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class PmdFile
+  require_relative "./pmd_violation"
+  attr_accessor :module_name
+  attr_accessor :file
+
+  def initialize(module_name, file)
+    @module_name = module_name
+    @file = file
+  end
+
+  def source_path
+    @source_path ||= file.attribute("name").value.to_s
+  end
+
+  def absolute_path
+    @absolute_path ||= Pathname.new(source_path[source_path.index(module_name), source_path.length]).to_s
+  end
+
+  def violations
+    @violations ||= file.xpath("violation").map do |pmd_violation|
+      PmdViolation.new(module_name, pmd_violation)
+    end
+  end
+end

data/lib/pmd/pmd_violation.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class PmdViolation
+  PRIORITY_ERROR_THRESHOLD = 2
+  attr_accessor :module_name
+  attr_accessor :violation
+
+  def initialize(module_name, violation)
+    @module_name = module_name
+    @violation = violation
+  end
+
+  def priority
+    @priority ||= violation.attribute("priority").value.to_i
+  end
+
+  def type
+    @type ||= priority < PRIORITY_ERROR_THRESHOLD ? :warn : :fail
+  end
+
+  def line
+    @line ||= violation.attribute("beginline").value.to_i
+  end
+
+  def description
+    @description ||= violation.text.gsub("\n", "")
+  end
+end

data/spec/fixtures/pmd_report.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<pmd xmlns="http://pmd.sourceforge.net/report/2.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://pmd.sourceforge.net/report/2.0.0 http://pmd.sourceforge.net/report_2_0_0.xsd"
+    version="6.8.0" timestamp="2019-10-03T20:34:18.074">
+<file name="/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java">
+<violation beginline="5" endline="10" begincolumn="8" endcolumn="1" rule="ClassNamingConventions" ruleset="Code Style" package="com.android.sample" class="Tools" externalInfoUrl="https://pmd.github.io/pmd-6.8.0/pmd_rules_java_codestyle.html#classnamingconventions" priority="1">
+The utility class name 'Tools' doesn't match '[A-Z][a-zA-Z0-9]+(Utils?|Helper)'
+</violation>
+</file>
+<file name="/Users/developer/sample/app/src/main/java/com/android/sample/MainActivity.java">
+<violation beginline="39" endline="39" begincolumn="25" endcolumn="35" rule="UseEqualsToCompareStrings" ruleset="Error Prone" package="com.android.sample" class="MainActivity" method="onCreate" externalInfoUrl="https://pmd.github.io/pmd-6.8.0/pmd_rules_java_errorprone.html#useequalstocomparestrings" priority="3">
+Use equals() to compare strings instead of '==' or '!='
+</violation>
+</file>
+<file name="/Users/developer/sample/app/src/test/java/com/android/sample/ExampleUnitTest.java">
+<violation beginline="15" endline="17" begincolumn="12" endcolumn="5" rule="MethodNamingConventions" ruleset="Code Style" package="com.android.sample" class="ExampleUnitTest" method="addition_isCorrect" externalInfoUrl="https://pmd.github.io/pmd-6.8.0/pmd_rules_java_codestyle.html#methodnamingconventions" priority="1">
+The JUnit 4 test method name 'addition_isCorrect' doesn't match '[a-z][a-zA-Z0-9]*'
+</violation>
+</file>
+<file name="/Users/developer/sample/app/src/test/java/com/android/sample/ToolsTest.java">
+<violation beginline="12" endline="14" begincolumn="12" endcolumn="5" rule="MethodNamingConventions" ruleset="Code Style" package="com.mathroule.demoapp" class="HelperTest" method="getLabel_1" externalInfoUrl="https://pmd.github.io/pmd-6.8.0/pmd_rules_java_codestyle.html#methodnamingconventions" priority="1">
+The JUnit 4 test method name 'getLabel_1' doesn't match '[a-z][a-zA-Z0-9]*'
+</violation>
+<violation beginline="18" endline="20" begincolumn="12" endcolumn="5" rule="MethodNamingConventions" ruleset="Code Style" package="com.mathroule.demoapp" class="HelperTest" method="getLabel_2" externalInfoUrl="https://pmd.github.io/pmd-6.8.0/pmd_rules_java_codestyle.html#methodnamingconventions" priority="1">
+The JUnit 4 test method name 'getLabel_2' doesn't match '[a-z][a-zA-Z0-9]*'
+</violation>
+</file>
+</pmd>

data/spec/pmd_spec.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require File.expand_path("spec_helper", __dir__)
+
+module Danger
+  describe Danger::DangerPmd do
+    it "should be a plugin" do
+      expect(Danger::DangerPmd.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @my_plugin = @dangerfile.pmd
+      end
+
+      it "Check default report file path" do
+        expect(@my_plugin.report_file).to eq("app/build/reports/pmd/pmd.xml")
+      end
+
+      it "Set custom report file path" do
+        custom_report_path = "custom/pmd_report.xml"
+        @my_plugin.report_file = custom_report_path
+        expect(@my_plugin.report_file).to eq(custom_report_path)
+      end
+
+      it "Check default Gradle module" do
+        expect(@my_plugin.gradle_module).to eq("app")
+      end
+
+      it "Set custom Gradle module" do
+        my_module = "custom_module"
+        @my_plugin.gradle_module = my_module
+        expect(@my_plugin.gradle_module).to eq(my_module)
+      end
+
+      it "Check default Gradle task" do
+        expect(@my_plugin.gradle_task).to eq("pmd")
+      end
+
+      it "Set custom Gradle task" do
+        custom_task = "pmdStagingDebug"
+        @my_plugin.gradle_task = custom_task
+        expect(@my_plugin.gradle_task).to eq(custom_task)
+      end
+
+      it "Create files" do
+        custom_report_path = "spec/fixtures/pmd_report.xml"
+        @my_plugin.report_file = custom_report_path
+        pmd_files = @my_plugin.pmd_files
+        expect(pmd_files).not_to be_nil
+
+        pmd_file1 = pmd_files[0]
+        expect(pmd_file1).not_to be_nil
+        expect(pmd_file1.source_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/Tools.java")
+        expect(pmd_file1.absolute_path).to eq("app/src/main/java/com/android/sample/Tools.java")
+        expect(pmd_file1.violations).not_to be_nil
+        expect(pmd_file1.violations.length).to eq(1)
+        expect(pmd_file1.violations.first).not_to be_nil
+        expect(pmd_file1.violations.first.line).to eq(5)
+        expect(pmd_file1.violations.first.description).to eq("The utility class name 'Tools' doesn't match '[A-Z][a-zA-Z0-9]+(Utils?|Helper)'")
+
+        pmd_file2 = pmd_files[1]
+        expect(pmd_file2).not_to be_nil
+        expect(pmd_file2.source_path).to eq("/Users/developer/sample/app/src/main/java/com/android/sample/MainActivity.java")
+        expect(pmd_file2.absolute_path).to eq("app/src/main/java/com/android/sample/MainActivity.java")
+        expect(pmd_file2.violations).not_to be_nil
+        expect(pmd_file2.violations.length).to eq(1)
+        expect(pmd_file2.violations.first).not_to be_nil
+        expect(pmd_file2.violations.first.line).to eq(39)
+        expect(pmd_file2.violations.first.description).to eq("Use equals() to compare strings instead of '==' or '!='")
+
+        pmd_file3 = pmd_files[2]
+        expect(pmd_file3).not_to be_nil
+        expect(pmd_file3.source_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ExampleUnitTest.java")
+        expect(pmd_file3.absolute_path).to eq("app/src/test/java/com/android/sample/ExampleUnitTest.java")
+        expect(pmd_file3.violations).not_to be_nil
+        expect(pmd_file3.violations.length).to eq(1)
+        expect(pmd_file3.violations.first).not_to be_nil
+        expect(pmd_file3.violations.first.line).to eq(15)
+        expect(pmd_file3.violations.first.description).to eq("The JUnit 4 test method name 'addition_isCorrect' doesn't match '[a-z][a-zA-Z0-9]*'")
+
+        pmd_file4 = pmd_files[3]
+        expect(pmd_file4).not_to be_nil
+        expect(pmd_file4.source_path).to eq("/Users/developer/sample/app/src/test/java/com/android/sample/ToolsTest.java")
+        expect(pmd_file4.absolute_path).to eq("app/src/test/java/com/android/sample/ToolsTest.java")
+        expect(pmd_file4.violations).not_to be_nil
+        expect(pmd_file4.violations.length).to eq(2)
+        expect(pmd_file4.violations[0]).not_to be_nil
+        expect(pmd_file4.violations[0].line).to eq(12)
+        expect(pmd_file4.violations[0].description).to eq("The JUnit 4 test method name 'getLabel_1' doesn't match '[a-z][a-zA-Z0-9]*'")
+        expect(pmd_file4.violations[1]).not_to be_nil
+        expect(pmd_file4.violations[1].line).to eq(18)
+        expect(pmd_file4.violations[1].description).to eq("The JUnit 4 test method name 'getLabel_2' doesn't match '[a-z][a-zA-Z0-9]*'")
+      end
+
+      it "Send inline comments" do
+        allow_any_instance_of(Danger::DangerPmd).to receive(:target_files).and_return([])
+        custom_report_path = "spec/fixtures/pmd_report.xml"
+        @my_plugin.report_file = custom_report_path
+        expect(@my_plugin.send_inline_comment).not_to be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "pathname"
+ROOT = Pathname.new(File.expand_path("..", __dir__))
+$:.unshift((ROOT + "lib").to_s)
+$:.unshift((ROOT + "spec").to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+if `git remote -v` == ""
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: danger-pmd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mathieu Rul
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.75'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.75'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Danger plugin for PMD.
+email:
+- mathroule@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-pmd.gemspec
+- lib/danger_plugin.rb
+- lib/danger_pmd.rb
+- lib/pmd/gem_version.rb
+- lib/pmd/plugin.rb
+- lib/pmd/pmd_file.rb
+- lib/pmd/pmd_violation.rb
+- spec/fixtures/pmd_report.xml
+- spec/pmd_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mathroule/danger-pmd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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/fixtures/pmd_report.xml
+- spec/pmd_spec.rb
+- spec/spec_helper.rb