chore: Update PMD rules

Signed-off-by: Jorge Solórzano <[email protected]>
ongres · Apr 26, 2024 · 61a7d21 · 61a7d21
1 parent c38c08f
commit 61a7d21
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 34 deletions.
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
@@ -21,10 +21,10 @@ jobs:
       uses: actions/setup-java@v3
       with:
         java-version: '21'
-        distribution: 'temurin'
+        distribution: 'zulu'
         cache: maven
     - name: Build with Maven
-      run: ./mvnw -B verify -Pchecks,run-its --file pom.xml
+      run: ./mvnw -B verify -P checks -P run-its
 
     # Optional: Uploads the full dependency graph to GitHub to improve the quality of Dependabot alerts this repository can receive
     - name: Update dependency graph

diff --git a/checks/pmd-ruleset.xml b/checks/pmd-ruleset.xml
@@ -1,42 +1,30 @@
 <?xml version="1.0"?>
-<ruleset name="Custom Rules" 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">
+<ruleset name="Custom Rules" 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>Custom Rules</description>
 
   <exclude-pattern>.*/target/.*</exclude-pattern>
   <exclude-pattern>.*/generated/.*</exclude-pattern>
-  <exclude-pattern>.*/Tables.java</exclude-pattern>
+  <exclude-pattern>.*/com/ongres/stringprep/Tables.*</exclude-pattern>
 
-  <!-- Your rules will come here -->
-  <rule ref="rulesets/java/quickstart.xml">
-    <exclude name="ClassNamingConventions" />
-  </rule>
-
-  <rule ref="category/java/codestyle.xml/TooManyStaticImports" />
+  <rule ref="rulesets/java/quickstart.xml" />
 
-  <rule ref="category/java/design.xml">
-    <exclude name="CognitiveComplexity" />
-    <exclude name="CyclomaticComplexity" />
-    <exclude name="LawOfDemeter" />
-    <exclude name="LoosePackageCoupling" />
-    <exclude name="NPathComplexity" />
-    <exclude name="GodClass" />
-    <exclude name="TooManyFields" />
+  <rule ref="category/java/bestpractices.xml">
+    <exclude name="UseVarargs" />
+    <exclude name="ForLoopVariableCount" />
+    <exclude name="AvoidReassigningLoopVariables" />
   </rule>
 
-  <rule ref="category/java/errorprone.xml">
-    <exclude name="AvoidLiteralsInIfCondition" />
-    <exclude name="DataflowAnomalyAnalysis" />
-    <exclude name="CloseResource" />
-  </rule>
+  <rule ref="category/java/errorprone.xml" />
+
+  <rule ref="category/java/multithreading.xml" />
 
-  <rule ref="category/java/errorprone.xml/EmptyCatchBlock">
-    <properties>
-      <property name="allowCommentedBlocks" value="true" />
-      <property name="allowExceptionNameRegex" value="^(ignored|expected)$" />
-    </properties>
+  <rule ref="category/java/performance.xml">
+    <exclude name="StringInstantiation" />
   </rule>
 
-  <rule ref="category/java/performance.xml" />
+  <rule ref="category/java/security.xml" />
 
 </ruleset>
diff --git a/nameprep/src/main/java/com/ongres/nameprep/Nameprep.java b/nameprep/src/main/java/com/ongres/nameprep/Nameprep.java
@@ -23,7 +23,7 @@
 @ProfileName("Nameprep")
 public final class Nameprep implements Profile {
 
-  private final EnumSet<Option> nameprepProfile;
+  private final Set<Option> nameprepProfile;
 
   /**
    * Construct an instance of the {@code Nameprep} profile.
@@ -47,7 +47,7 @@ public Nameprep() {
 
   @Override
   public Set<Option> profile() {
-    return nameprepProfile.clone();
+    return nameprepProfile;
   }
 
 }
diff --git a/saslprep/src/main/java/com/ongres/saslprep/SASLprep.java b/saslprep/src/main/java/com/ongres/saslprep/SASLprep.java
@@ -25,7 +25,7 @@
 @ProfileName("SASLprep")
 public final class SASLprep implements Profile {
 
-  private final EnumSet<Option> saslprepProfile;
+  private final Set<Option> saslprepProfile;
 
   /**
    * Construct an instance of the {@code SASLprep} profile.
@@ -50,7 +50,7 @@ public SASLprep() {
 
   @Override
   public Set<Option> profile() {
-    return saslprepProfile.clone();
+    return saslprepProfile;
   }
 
   /**

diff --git a/stringprep/src/main/java/com/ongres/stringprep/Stringprep.java b/stringprep/src/main/java/com/ongres/stringprep/Stringprep.java
@@ -10,6 +10,7 @@
 import java.util.EnumSet;
 import java.util.Locale;
 import java.util.Objects;
+import java.util.Set;
 import java.util.function.IntPredicate;
 
 /**
@@ -53,7 +54,7 @@ public final class Stringprep {
    */
   Stringprep(Profile profile, boolean storedStrings) {
     Objects.requireNonNull(profile);
-    EnumSet<Option> options = EnumSet.copyOf(Objects.requireNonNull(profile.profile()));
+    Set<Option> options = EnumSet.copyOf(Objects.requireNonNull(profile.profile()));
     this.mapToNothing = options.contains(Option.MAP_TO_NOTHING);
     this.additionalMapping = options.contains(Option.ADDITIONAL_MAPPING);
     this.caseFoldNfkc = options.contains(Option.CASE_FOLD_NFKC);