From 9d0703f898f13feb5da1405e0b1571740450b770 Mon Sep 17 00:00:00 2001
From: Manuel Fuhr <manuel@knid.net>
Date: Sun, 13 Nov 2022 12:20:38 +0100
Subject: [PATCH] Add PMD and enable quickstart ruleset

PMD allows checking code for violation and quickstart provides a ruleset
which are "rules that are most likely to apply everywhere". Violated
rules are disabled to get started.
---
 build.gradle               | 18 ++++++++---
 config/pmd/pmd-ruleset.xml | 62 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 76 insertions(+), 4 deletions(-)
 create mode 100644 config/pmd/pmd-ruleset.xml

diff --git a/build.gradle b/build.gradle
index f4571ba..8d58199 100644
--- a/build.gradle
+++ b/build.gradle
@@ -1,14 +1,14 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 
 buildscript {
-	
+
     repositories {
         mavenCentral()
         google()
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:7.0.2'
-        
+
 
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
@@ -23,12 +23,12 @@ allprojects {
     // OsmTrack (version and versionDate)
     project.version  "1.6.3"
     group 'org.btools'
-	
+
     repositories {
         mavenCentral()
         google()
     }
-	
+
     apply plugin: "maven-publish"
     publishing {
         repositories {
@@ -47,6 +47,16 @@ allprojects {
     }
 
     apply plugin: "checkstyle"
+    apply plugin: "pmd"
+
+    pmd {
+        consoleOutput = true
+        toolVersion = "6.51.0"
+        rulesMinimumPriority = 5
+        ruleSetFiles = files("${rootProject.rootDir}/config/pmd/pmd-ruleset.xml")
+        ruleSets = []
+        // ignoreFailures = true
+    }
 }
 
 task clean(type: Delete) {
diff --git a/config/pmd/pmd-ruleset.xml b/config/pmd/pmd-ruleset.xml
new file mode 100644
index 0000000..8350b0f
--- /dev/null
+++ b/config/pmd/pmd-ruleset.xml
@@ -0,0 +1,62 @@
+<?xml version="1.0"?>
+
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Custom Rules"
+    xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+    xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+    <description>
+        BRouter PMD Ruleset
+    </description>
+
+    <rule ref="rulesets/java/quickstart.xml">
+        <exclude name="AbstractClassWithoutAnyMethod" />
+        <exclude name="AssignmentInOperand" />
+        <exclude name="AssignmentToNonFinalStatic" />
+        <exclude name="AvoidBranchingStatementAsLastInLoop" />
+        <exclude name="AvoidCatchingThrowable" />
+        <exclude name="AvoidInstanceofChecksInCatchClause" />
+        <exclude name="AvoidProtectedFieldInFinalClass" />
+        <exclude name="AvoidUsingVolatile" />
+        <exclude name="CloseResource" />
+        <exclude name="CompareObjectsWithEquals" />
+        <exclude name="ControlStatementBraces" />
+        <exclude name="DoNotCallGarbageCollectionExplicitly" />
+        <exclude name="EmptyCatchBlock" />
+        <exclude name="EmptyControlStatement" />
+        <exclude name="ForLoopCanBeForeach" />
+        <exclude name="LiteralsFirstInComparisons" />
+        <exclude name="LogicInversion" />
+        <exclude name="LooseCoupling" />
+        <exclude name="MissingOverride" />
+        <exclude name="OneDeclarationPerLine" />
+        <exclude name="OverrideBothEqualsAndHashcode" />
+        <exclude name="PreserveStackTrace" />
+        <exclude name="PrimitiveWrapperInstantiation" />
+        <exclude name="ReturnEmptyCollectionRatherThanNull" />
+        <exclude name="SimplifiableTestAssertion" />
+        <exclude name="SimplifiedTernary" />
+        <exclude name="SimplifyBooleanReturns" />
+        <exclude name="SingularField" />
+        <exclude name="UncommentedEmptyConstructor" />
+        <exclude name="UncommentedEmptyMethodBody" />
+        <exclude name="UnnecessaryFullyQualifiedName" />
+        <exclude name="UnnecessaryImport" />
+        <exclude name="UnnecessaryModifier" />
+        <exclude name="UnnecessaryReturn" />
+        <exclude name="UnusedFormalParameter" />
+        <exclude name="UnusedLocalVariable" />
+        <exclude name="UnusedPrivateField" />
+        <exclude name="UnusedPrivateMethod" />
+        <exclude name="UseCollectionIsEmpty" />
+        <exclude name="UseLocaleWithCaseConversions" />
+        <exclude name="UseNotifyAllInsteadOfNotify" />
+        <exclude name="UseUtilityClass" />
+        <exclude name="UselessParentheses" />
+
+        <!-- Naming -->
+        <exclude name="FormalParameterNamingConventions" />
+        <exclude name="LocalVariableNamingConventions" />
+        <exclude name="MethodNamingConventions" />
+    </rule>
+
+</ruleset>