#3160 Enable PMD for eo-runime

eo-runtime/pom.xml

@@ -336,7 +336,14 @@ SOFTWARE.
             <artifactId>qulice-maven-plugin</artifactId>
             <configuration>
               <excludes>
-                <exclude>pmd:.*</exclude>
+                <!--
+                @todo #3160:60min Enable PMD check for eo-runtime/src/main/java/EOorg package,
+                 excluding only those rules that cannot be resolved
+                 (PMD.PackageCase, PMD.AvoidDollarSigns). All the others PMD violations should be
+                 resolved.
+                -->
+                <exclude>pmd:/src/main/java/EOorg/.*</exclude>
+                <exclude>pmd:/src/test/java/EOorg/.*</exclude>
                 <exclude>dependencies:org.eolang:eo-maven-plugin</exclude>
               </excludes>
             </configuration>

eo-runtime/src/main/java/org/eolang/Bytes.java

@@ -51,8 +51,9 @@ public interface Bytes {
      * OR operation.
      * @param other Bytes.
      * @return Bytes.
-     * @checkstyle MethodNameCheck (2 lines)
+     * @checkstyle MethodNameCheck (3 lines)
      */
+    @SuppressWarnings("PMD.ShortMethodName")
     Bytes or(Bytes other);
 
     /**

eo-runtime/src/main/java/org/eolang/BytesOf.java

@@ -33,6 +33,7 @@
  * @since 1.0
  */
 @Versionized
+@SuppressWarnings({"PMD.TooManyMethods", "PMD.GodClass"})
 public final class BytesOf implements Bytes {
 
     /**
@@ -44,6 +45,7 @@ public final class BytesOf implements Bytes {
      * Ctor.
      * @param data Data.
      */
+    @SuppressWarnings("PMD.ArrayIsStoredDirectly")
     public BytesOf(final byte[] data) {
         this.data = data;
     }
@@ -108,6 +110,7 @@ public Bytes and(final Bytes other) {
     }
 
     @Override
+    @SuppressWarnings("PMD.ShortMethodName")
     public Bytes or(final Bytes other) {
         final byte[] first = this.take();
         final byte[] second = other.take();
@@ -128,6 +131,7 @@ public Bytes xor(final Bytes other) {
     }
 
     @Override
+    @SuppressWarnings("PMD.CognitiveComplexity")
     public Bytes shift(final int bits) {
         // @checkstyle MethodBodyCommentsCheck (3 lines)
         // @checkstyle NestedIfDepthCheck (40 lines)

eo-runtime/src/main/java/org/eolang/Data.java

@@ -32,6 +32,7 @@
  * @since 0.1
  */
 @Versionized
+@SuppressWarnings("PMD.TooManyMethods")
 public interface Data {
     /**
      * Attach data to the object.
@@ -197,6 +198,11 @@ private static Phi toPhi(final Object obj) {
          * @checkstyle NestedIfDepthCheck (100 lines)
          * @checkstyle ModifiedControlVariableCheck (100 lines)
          */
+        @SuppressWarnings({
+            "PMD.AvoidReassigningLoopVariables",
+            "PMD.CognitiveComplexity",
+            "PMD.NPathComplexity"
+        })
         private static String unescapeJavaString(final String str) {
             final StringBuilder unescaped = new StringBuilder(str.length());
             for (int idx = 0; idx < str.length(); ++idx) {
@@ -209,19 +215,19 @@ private static String unescapeJavaString(final String str) {
                         next = str.charAt(idx + 1);
                     }
                     if (next >= '0' && next <= '7') {
-                        String code = String.valueOf(next);
+                        final StringBuilder code = new StringBuilder(String.valueOf(next));
                         ++idx;
                         if (idx < str.length() - 1 && str.charAt(idx + 1) >= '0'
                             && str.charAt(idx + 1) <= '7') {
-                            code += str.charAt(idx + 1);
+                            code.append(str.charAt(idx + 1));
                             ++idx;
                             if (idx < str.length() - 1 && str.charAt(idx + 1) >= '0'
                                 && str.charAt(idx + 1) <= '7') {
-                                code += str.charAt(idx + 1);
+                                code.append(str.charAt(idx + 1));
                                 ++idx;
                             }
                         }
-                        unescaped.append((char) Integer.parseInt(code, 8));
+                        unescaped.append((char) Integer.parseInt(code.toString(), 8));
                         continue;
                     }
                     switch (next) {

eo-runtime/src/main/java/org/eolang/Dataized.java

@@ -150,14 +150,4 @@ public <T> T take(final Class<T> type) {
         }
         return type.cast(strong);
     }
-
-    /**
-     * Clean up resources.
-     * This includes call of {@link ThreadLocal#remove()} method to prevent
-     * memory leaks.
-     */
-    public static void cleanUp() {
-        Dataized.LEVEL.remove();
-        Dataized.MAX_LEVEL.remove();
-    }
 }

eo-runtime/src/main/java/org/eolang/ExAbstract.java

@@ -42,25 +42,26 @@ public abstract class ExAbstract extends RuntimeException {
 
     /**
      * Ctor.
+     * @param cause Exception cause
      */
-    public ExAbstract() {
-        this(null);
+    public ExAbstract(final String cause) {
+        super(cause);
     }
 
     /**
      * Ctor.
      * @param cause Exception cause
+     * @param root Root cause exception
      */
-    public ExAbstract(final String cause) {
-        super(cause);
+    public ExAbstract(final String cause, final Throwable root) {
+        super(cause, root);
     }
 
     /**
      * Ctor.
-     * @param cause Exception cause
      * @param root Root cause exception
      */
-    ExAbstract(final String cause, final Throwable root) {
-        super(cause, root);
+    public ExAbstract(final Throwable root) {
+        super(root);
     }
 }

eo-runtime/src/main/java/org/eolang/ExInterrupted.java

@@ -38,8 +38,9 @@ public class ExInterrupted extends ExAbstract {
 
     /**
      * Ctor.
+     * @param root Root cause exception
      */
-    public ExInterrupted() {
-        super(null);
+    public ExInterrupted(final InterruptedException root) {
+        super(root);
     }
 }

eo-runtime/src/main/java/org/eolang/Main.java

@@ -49,6 +49,7 @@
  * @since 0.1
  */
 @Versionized
+@SuppressWarnings("PMD.MoreThanOneLogger")
 public final class Main {
 
     /**
@@ -182,7 +183,8 @@ private static void run(final List<String> opts) throws Exception {
                 .newInstance();
         } catch (final ClassNotFoundException ex) {
             throw new ExUnset(
-                String.format("Can not find '%s' object", opts.get(0))
+                String.format("Can not find '%s' object", opts.get(0)),
+                ex
             );
         }
         if (opts.size() > 1) {

eo-runtime/src/main/java/org/eolang/PhDefault.java

@@ -42,7 +42,7 @@
  * @checkstyle DesignForExtensionCheck (500 lines)
  */
 @Versionized
-@SuppressWarnings({"PMD.TooManyMethods", "PMD.ConstructorShouldDoInitialization"})
+@SuppressWarnings({"PMD.TooManyMethods", "PMD.ConstructorShouldDoInitialization", "PMD.GodClass"})
 public class PhDefault implements Phi, Cloneable {
     /**
      * Vertices.
@@ -300,15 +300,6 @@ public String forma() {
         return this.form;
     }
 
-    /**
-     * Clean up resources.
-     * This includes call of {@link ThreadLocal#remove()} method to prevent
-     * memory leaks.
-     */
-    public static void cleanUp() {
-        PhDefault.NESTING.remove();
-    }
-
     /**
      * Add new attribute.
      *

eo-runtime/src/main/java/org/eolang/PhFake.java

@@ -47,6 +47,7 @@ public PhFake() {
      * Ctor.
      * @param sup The function to return the real object
      */
+    @SuppressWarnings("PMD.ConstructorOnlyInitializesOrCallOtherConstructors")
     public PhFake(final Supplier<Phi> sup) {
         this.add("args", new AtVoid("args"));
         this.add("φ", new AtComposite(this, rho -> sup.get()));

eo-runtime/src/main/java/org/eolang/PhLocated.java

@@ -29,6 +29,7 @@
  *
  * @since 0.21
  */
+@SuppressWarnings("PMD.TooManyMethods")
 @Versionized
 public final class PhLocated implements Phi {
 

eo-runtime/src/main/java/org/eolang/PhLogged.java

@@ -34,6 +34,7 @@
  * @since 0.24
  */
 @Versionized
+@SuppressWarnings({"PMD.TooManyMethods", "PMD.SystemPrintln"})
 public final class PhLogged implements Phi {
 
     /**

eo-runtime/src/main/java/org/eolang/PhNamed.java

@@ -30,6 +30,7 @@
  * @since 0.17
  */
 @Versionized
+@SuppressWarnings("PMD.TooManyMethods")
 final class PhNamed implements Phi {
 
     /**

eo-runtime/src/main/java/org/eolang/PhOnce.java

@@ -33,6 +33,7 @@
  * @since 0.1
  */
 @Versionized
+@SuppressWarnings("PMD.TooManyMethods")
 class PhOnce implements Phi {
 
     /**

eo-runtime/src/main/java/org/eolang/PhPackage.java

@@ -35,6 +35,7 @@
  * @since 0.22
  */
 @Versionized
+@SuppressWarnings({"PMD.TooManyMethods", "PMD.ConstructorShouldDoInitialization"})
 final class PhPackage implements Phi {
 
     /**

eo-runtime/src/main/java/org/eolang/PhSafe.java

@@ -33,6 +33,7 @@
  * @since 0.26
  */
 @Versionized
+@SuppressWarnings("PMD.TooManyMethods")
 public final class PhSafe implements Phi {
 
     /**

eo-runtime/src/main/java/org/eolang/PhTraced.java

@@ -35,11 +35,13 @@
  * @since 0.36
  */
 @Versionized
+@SuppressWarnings("PMD.TooManyMethods")
 public final class PhTraced implements Phi {
 
     /**
      * Name of property that responsible for keeping max depth.
      */
+    @SuppressWarnings("PMD.LongVariable")
     public static final String
         MAX_CAGE_RECURSION_DEPTH_PROPERTY_NAME = "EO_MAX_CAGE_RECURSION_DEPTH";
 
@@ -58,6 +60,7 @@ public final class PhTraced implements Phi {
     /**
      * Locator of encaged object.
      */
+    @SuppressWarnings("PMD.AvoidFieldNameMatchingMethodName")
     private final Integer locator;
 
     /**

eo-runtime/src/main/java/org/eolang/PhWrite.java

@@ -50,6 +50,7 @@ public final class PhWrite extends PhDefault implements Atom {
      * @param attr Attribute name
      * @param ret Return value function
      */
+    @SuppressWarnings("PMD.ConstructorOnlyInitializesOrCallOtherConstructors")
     public PhWrite(
         final String attr,
         final Function<Phi, Phi> ret

eo-runtime/src/main/java/org/eolang/Phi.java

@@ -44,6 +44,7 @@ public interface Phi extends Term, Data {
      * @checkstyle ConstantNameCheck (5 lines)
      * @checkstyle AnonInnerLengthCheck (30 lines)
      */
+    @SuppressWarnings("PMD.FieldNamingConventions")
     Phi Φ = new Phi() {
         /**
          * Default package.

eo-runtime/src/main/java/org/eolang/SafeFunc.java

@@ -47,18 +47,17 @@ class SafeFunc<T> implements Supplier<T> {
     }
 
     @Override
+    @SuppressWarnings({"PMD.AvoidCatchingGenericException", "PMD.AvoidRethrowingException"})
     public T get() {
         try {
             return this.origin.call();
         } catch (final InterruptedException ex) {
             Thread.currentThread().interrupt();
-            throw new ExInterrupted();
-        } catch (final ExAbstract ex) {
-            throw ex;
+            throw new ExInterrupted(ex);
             // @checkstyle IllegalCatchCheck (3 line)
         } catch (final RuntimeException ex) {
             throw ex;
-        } catch (final Throwable ex) {
+        } catch (final Exception ex) {
             throw new ExFailure(
                 String.format(
                     "Unexpected error '%s' of type %s",

eo-runtime/src/main/java/org/eolang/Term.java

@@ -42,6 +42,7 @@ public interface Term {
      * @return The expression in φ-calculus
      * @checkstyle MethodNameCheck (5 lines)
      */
+    @SuppressWarnings("PMD.MethodNamingConventions")
     String φTerm();
 
 }

eo-runtime/src/main/java/org/eolang/UniverseSafe.java

@@ -40,6 +40,7 @@
  * @checkstyle IllegalCatchCheck (200 lines)
  */
 @Versionized
+@SuppressWarnings("PMD.AvoidCatchingThrowable")
 public final class UniverseSafe implements Universe {
 
     /**

eo-runtime/src/main/java/org/eolang/VerboseBytesAsString.java

@@ -44,6 +44,7 @@ public final class VerboseBytesAsString implements Supplier<String> {
      * Ctor.
      * @param data Data.
      */
+    @SuppressWarnings("PMD.ArrayIsStoredDirectly")
     public VerboseBytesAsString(final byte[] data) {
         this.data = data;
     }
@@ -81,6 +82,7 @@ public String get() {
                     Arrays.toString(this.data),
                     new String(this.data, StandardCharsets.UTF_8)
                 );
+                break;
         }
         return result;
     }

eo-runtime/src/test/java/org/eolang/AtCompositeTest.java

@@ -34,6 +34,7 @@
  *
  * @since 0.16
  */
+@SuppressWarnings("PMD.JUnit5TestShouldBePackagePrivate")
 public final class AtCompositeTest {
 
     /**
@@ -95,6 +96,7 @@ private static class Rnd extends PhDefault {
         /**
          * Ctor.
          */
+        @SuppressWarnings("PMD.ConstructorOnlyInitializesOrCallOtherConstructors")
         Rnd() {
             super();
             this.add(

eo-runtime/src/test/java/org/eolang/AtLoggedTest.java

@@ -39,7 +39,7 @@
  *
  * @since 0.29
  */
-class AtLoggedTest {
+final class AtLoggedTest {
 
     /**
      * Testable object.

eo-runtime/src/test/java/org/eolang/AtNamedTest.java

@@ -64,6 +64,7 @@ private static class Dummy extends PhDefault {
         /**
          * Ctor.
          */
+        @SuppressWarnings("PMD.ConstructorOnlyInitializesOrCallOtherConstructors")
         Dummy() {
             super();
             this.add(

eo-runtime/src/test/java/org/eolang/BytesOfTest.java

@@ -35,6 +35,7 @@
  *
  * @since 1.0
  */
+@SuppressWarnings("PMD.TooManyMethods")
 final class BytesOfTest {
 
     @Test