From cae601cf6febf20398ad8335afef6ced6f1696ae Mon Sep 17 00:00:00 2001
From: "Erik C. Thauvin" <erik@thauvin.net>
Date: Fri, 27 Oct 2023 03:09:18 -0700
Subject: [PATCH] Added PMD config

---
 .idea/misc.xml                                |   4 +
 config/pmd.xml                                | 110 ++++++++++++++++++
 lib/bld/bld-wrapper.properties                |   4 +-
 .../rife/bld/extension/SpringBootBuild.java   |  11 +-
 4 files changed, 126 insertions(+), 3 deletions(-)
 create mode 100644 config/pmd.xml

diff --git a/.idea/misc.xml b/.idea/misc.xml
index c2e6353..e447412 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -1,4 +1,8 @@
 <project version="4">
+  <component name="EntryPointsManager">
+    <pattern value="rife.bld.extension.SpringBootBuild" method="pmd" />
+    <pattern value="rife.bld.extension.SpringBootBuild" />
+  </component>
   <component name="PDMPlugin">
     <option name="customRuleSets">
       <list>
diff --git a/config/pmd.xml b/config/pmd.xml
new file mode 100644
index 0000000..cb0b643
--- /dev/null
+++ b/config/pmd.xml
@@ -0,0 +1,110 @@
+<?xml version="1.0"?>
+<ruleset name="erik"
+         xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+    <description>Erik's Ruleset</description>
+    <!-- BEST PRACTICES -->
+    <rule ref="category/java/bestpractices.xml">
+        <exclude name="AvoidPrintStackTrace"/>
+        <exclude name="JUnit4TestShouldUseTestAnnotation"/>
+        <exclude name="JUnitTestContainsTooManyAsserts"/>
+        <exclude name="GuardLogStatement"/>
+    </rule>
+
+    <rule ref="category/java/bestpractices.xml/MissingOverride">
+        <properties>
+            <property name="violationSuppressXPath"
+                      value="//MethodDeclaration[@Name='hashCode' or @Name='equals' or @Name='toString']"/>
+        </properties>
+    </rule>
+
+    <!-- CODE STYLE -->
+    <rule ref="category/java/codestyle.xml">
+        <exclude name="AtLeastOneConstructor"/>
+        <exclude name="ClassNamingConventions"/>
+        <exclude name="ConfusingTernary"/>
+        <exclude name="CommentDefaultAccessModifier"/>
+        <exclude name="FieldNamingConventions"/>
+        <exclude name="LocalVariableCouldBeFinal"/>
+        <exclude name="LocalVariableNamingConventions"/>
+        <exclude name="LongVariable"/>
+        <exclude name="MethodArgumentCouldBeFinal"/>
+        <exclude name="OnlyOneReturn"/>
+        <exclude name="PackageCase"/>
+        <exclude name="ShortClassName"/>
+        <exclude name="ShortMethodName"/>
+        <exclude name="ShortVariable"/>
+        <exclude name="UselessParentheses"/>
+        <exclude name="UseUnderscoresInNumericLiterals"/>
+    </rule>
+
+    <rule ref="category/java/codestyle.xml/UnnecessaryImport">
+        <properties>
+            <property name="violationSuppressRegex" value="Unused (static|.*\.\*).*"/>
+        </properties>
+    </rule>
+
+    <!-- DESIGN -->
+    <rule ref="category/java/design.xml">
+        <exclude name="AvoidCatchingGenericException"/>
+        <exclude name="AvoidDeeplyNestedIfStmts"/>
+        <exclude name="AvoidUncheckedExceptionsInSignatures"/>
+        <exclude name="CognitiveComplexity"/>
+        <exclude name="CyclomaticComplexity"/>
+        <exclude name="ExcessiveClassLength"/>
+        <exclude name="ExcessiveMethodLength"/>
+        <exclude name="ExcessiveParameterList"/>
+        <exclude name="ExcessivePublicCount"/>
+        <exclude name="GodClass"/>
+        <exclude name="LawOfDemeter"/>
+        <exclude name="LoosePackageCoupling"/>
+        <exclude name="NPathComplexity"/>
+        <exclude name="NcssCount"/>
+        <exclude name="TooManyFields"/>
+        <exclude name="TooManyMethods"/>
+        <exclude name="UseObjectForClearerAPI"/>
+    </rule>
+
+    <!-- DOCUMENTATION -->
+    <rule ref="category/java/documentation.xml">
+        <exclude name="CommentRequired"/>
+        <exclude name="CommentSize"/>
+    </rule>
+
+    <!-- ERROR PRONE -->
+    <rule ref="category/java/errorprone.xml">
+        <exclude name="AssignmentInOperand"/>
+        <exclude name="AvoidCatchingNPE"/>
+        <exclude name="AvoidDuplicateLiterals"/>
+        <exclude name="AvoidFieldNameMatchingMethodName"/>
+        <exclude name="AvoidFieldNameMatchingTypeName"/>
+        <exclude name="AvoidLiteralsInIfCondition"/>
+        <exclude name="NullAssignment"/>
+    </rule>
+
+    <rule ref="category/java/errorprone.xml/AssignmentInOperand">
+        <properties>
+            <property name="allowWhile" value="true"/>
+            <property name="allowFor" value="true"/>
+            <property name="allowIf" value="true"/>
+        </properties>
+    </rule>
+    <rule ref="category/java/errorprone.xml/AvoidDuplicateLiterals">
+        <properties>
+            <property name="skipAnnotations" value="true"/>
+        </properties>
+    </rule>
+
+    <!-- MULTITHREADING -->
+    <rule ref="category/java/multithreading.xml">
+    </rule>
+
+    <!-- PERFORMANCE -->
+    <rule ref="category/java/performance.xml">
+    </rule>
+
+    <!-- SECURITY -->
+    <rule ref="category/java/security.xml">
+    </rule>
+</ruleset>
\ No newline at end of file
diff --git a/lib/bld/bld-wrapper.properties b/lib/bld/bld-wrapper.properties
index 65caa7a..777383e 100644
--- a/lib/bld/bld-wrapper.properties
+++ b/lib/bld/bld-wrapper.properties
@@ -1,7 +1,7 @@
 bld.downloadExtensionJavadoc=false
 bld.downloadExtensionSources=true
-bld.extensions=
-bld.repositories=MAVEN_CENTRAL,RIFE2_RELEASES
+bld.extension-pmd=com.uwyn.rife2:bld-pmd:0.9.4
+bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_RELEASES
 bld.downloadLocation=
 bld.sourceDirectories=
 bld.version=1.7.5
diff --git a/src/bld/java/rife/bld/extension/SpringBootBuild.java b/src/bld/java/rife/bld/extension/SpringBootBuild.java
index 8f3f14a..9748827 100644
--- a/src/bld/java/rife/bld/extension/SpringBootBuild.java
+++ b/src/bld/java/rife/bld/extension/SpringBootBuild.java
@@ -16,6 +16,7 @@
 
 package rife.bld.extension;
 
+import rife.bld.BuildCommand;
 import rife.bld.Project;
 import rife.bld.publish.PublishDeveloper;
 import rife.bld.publish.PublishLicense;
@@ -39,7 +40,6 @@ public class SpringBootBuild extends Project {
         repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES);
 
         scope(compile)
-                .include(dependency("net.lingala.zip4j", "zip4j", version(2,11, 5)))
                 .include(dependency("com.uwyn.rife2", "bld", version(1, 7, 5)));
         scope(test)
                 .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 0)))
@@ -67,4 +67,13 @@ public class SpringBootBuild extends Project {
     public static void main(String[] args) {
         new SpringBootBuild().start(args);
     }
+
+    @BuildCommand(summary = "Runs PMD analysis")
+    public void pmd() {
+        new PmdOperation()
+                .fromProject(this)
+                .failOnViolation(true)
+                .ruleSets("config/pmd.xml")
+                .execute();
+    }
 }
\ No newline at end of file