feat(#2642): checkstyle

objectionary · Dec 5, 2023 · ce0533d · ce0533d
1 parent 8d22a32
commit ce0533d
Show file tree

Hide file tree

Showing 12 changed files with 37 additions and 44 deletions.
diff --git a/eo-maven-plugin/src/main/java/org/eolang/maven/ParseMojo.java b/eo-maven-plugin/src/main/java/org/eolang/maven/ParseMojo.java
@@ -26,7 +26,6 @@
 import com.jcabi.log.Logger;
 import com.jcabi.xml.XML;
 import com.jcabi.xml.XMLDocument;
-import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.nio.file.Path;
 import java.util.List;
@@ -38,7 +37,6 @@
 import org.cactoos.Scalar;
 import org.cactoos.experimental.Threads;
 import org.cactoos.io.InputOf;
-import org.cactoos.io.OutputTo;
 import org.cactoos.iterable.Filtered;
 import org.cactoos.iterable.Mapped;
 import org.cactoos.number.SumOf;

diff --git a/eo-maven-plugin/src/test/java/org/eolang/maven/JavaFilesTest.java b/eo-maven-plugin/src/test/java/org/eolang/maven/JavaFilesTest.java
@@ -24,14 +24,11 @@
 package org.eolang.maven;
 
 import com.jcabi.xml.XML;
-import com.jcabi.xml.XMLDocument;
 import com.yegor256.xsline.Xsline;
-import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import org.cactoos.io.InputOf;
-import org.cactoos.io.OutputTo;
 import org.cactoos.io.ResourceOf;
 import org.cactoos.text.TextOf;
 import org.eolang.maven.util.HmBase;

diff --git a/eo-parser/pom.xml b/eo-parser/pom.xml
@@ -189,7 +189,7 @@ SOFTWARE.
             <artifactId>qulice-maven-plugin</artifactId>
             <configuration>
               <excludes>
-                <exclude>checkstyle:/src/main/java/org/eolang/parser/XeListener.java</exclude>
+                <exclude>checkstyle:/src/main/java/org/eolang/parser/XeEoListener.java</exclude>
               </excludes>
             </configuration>
           </plugin>

diff --git a/eo-parser/src/main/java/org/eolang/parser/CheckPack.java b/eo-parser/src/main/java/org/eolang/parser/CheckPack.java
@@ -25,18 +25,15 @@
 
 import com.jcabi.log.Logger;
 import com.jcabi.xml.XML;
-import com.jcabi.xml.XMLDocument;
 import com.yegor256.xsline.Shift;
 import com.yegor256.xsline.StClasspath;
 import com.yegor256.xsline.Train;
 import com.yegor256.xsline.Xsline;
-import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.util.Collection;
 import java.util.LinkedList;
 import java.util.Map;
 import org.cactoos.io.InputOf;
-import org.cactoos.io.OutputTo;
 import org.yaml.snakeyaml.Yaml;
 
 /**

diff --git a/eo-parser/src/main/java/org/eolang/parser/EoSyntax.java b/eo-parser/src/main/java/org/eolang/parser/EoSyntax.java
@@ -84,6 +84,7 @@ public EoSyntax(final String nme, final Input ipt) {
      * be generated and saved. Read it in order to find the errors,
      * at <tt>/program/errors</tt> XPath.</p>
      *
+     * @return Parsed XML
      * @throws IOException If fails
      */
     public XML parsed() throws IOException {

diff --git a/eo-parser/src/main/java/org/eolang/parser/PhiSyntax.java b/eo-parser/src/main/java/org/eolang/parser/PhiSyntax.java
@@ -39,7 +39,7 @@
  * Syntax parser, from Phi-calculus to XMIR, using ANTLR4.
  * @since 0.34.0
  */
-public class PhiSyntax implements Syntax {
+public final class PhiSyntax implements Syntax {
     /**
      * Name of the program.
      */
@@ -81,7 +81,7 @@ public XML parsed() throws IOException {
             ).domQuietly()
         );
         new Schema(dom).check();
-        Logger.debug(this,"Input of PHI calculus compiled, no errors");
+        Logger.debug(this, "Input of PHI calculus compiled, no errors");
         return dom;
     }
 }
diff --git a/eo-parser/src/main/java/org/eolang/parser/SourceText.java b/eo-parser/src/main/java/org/eolang/parser/SourceText.java
@@ -30,7 +30,7 @@
  * Source text of parser context.
  * @since 0.34.0
  */
-public class SourceText {
+public final class SourceText {
     /**
      * Context.
      */

diff --git a/eo-parser/src/main/java/org/eolang/parser/XeEoListener.java b/eo-parser/src/main/java/org/eolang/parser/XeEoListener.java
@@ -32,7 +32,6 @@
 import java.util.Iterator;
 import java.util.StringJoiner;
 import org.antlr.v4.runtime.ParserRuleContext;
-import org.antlr.v4.runtime.misc.Interval;
 import org.antlr.v4.runtime.tree.ErrorNode;
 import org.antlr.v4.runtime.tree.TerminalNode;
 import org.apache.commons.text.StringEscapeUtils;
@@ -942,6 +941,7 @@ public void exitVersion(final EoParser.VersionContext ctx) {
         // Nothing here
     }
 
+    @Override
     @SuppressWarnings("PMD.ConfusingTernary")
     public void enterAs(final EoParser.AsContext ctx) {
         this.objects.enter();

diff --git a/eo-parser/src/main/java/org/eolang/parser/XePhiListener.java b/eo-parser/src/main/java/org/eolang/parser/XePhiListener.java
@@ -82,7 +82,7 @@ public final class XePhiListener implements PhiListener, Iterable<Directive> {
     /**
      * Objects.
      */
-    private final Deque<Objects> objects;
+    private final Deque<Objects> objs;
 
     /**
      * Packages.
@@ -101,12 +101,12 @@ public final class XePhiListener implements PhiListener, Iterable<Directive> {
 
     /**
      * Ctor.
-     * @param name The name of it
+     * @param nme The name of it
      */
-    public XePhiListener(final String name) {
-        this.name = name;
+    public XePhiListener(final String nme) {
+        this.name = nme;
         this.dirs = new Directives();
-        this.objects = new ArrayDeque<>();
+        this.objs = new ArrayDeque<>();
         this.attributes = new Stack<>();
         this.properties = new Stack<>();
         this.packages = new ListOf<>();
@@ -115,7 +115,7 @@ public XePhiListener(final String name) {
 
     @Override
     public void enterProgram(final PhiParser.ProgramContext ctx) {
-        this.objects.add(new Objects.ObjXembly());
+        this.objs.add(new Objects.ObjXembly());
         this.dirs.add("program")
             .attr("name", this.name)
             .attr("version", Manifests.read("EO-Version"))
@@ -147,7 +147,7 @@ public void exitProgram(final PhiParser.ProgramContext ctx) {
                 .up().up();
         }
         this.dirs.add("objects")
-            .append(this.objects.pollLast())
+            .append(this.objs.pollLast())
             .up()
             .attr("ms", (System.nanoTime() - this.start) / (1000L * 1000L));
     }
@@ -181,14 +181,14 @@ public void exitFormation(final PhiParser.FormationContext ctx) {
     public void enterBindings(final PhiParser.BindingsContext ctx) {
         if (XePhiListener.hasLambdaPackage(ctx)) {
             this.packages.add(this.attributes.peek());
-            this.objects.add(new Objects.ObjXembly());
+            this.objs.add(new Objects.ObjXembly());
         }
     }
 
     @Override
     public void exitBindings(final PhiParser.BindingsContext ctx) {
         if (XePhiListener.hasLambdaPackage(ctx)) {
-            this.objects.poll();
+            this.objs.poll();
         }
     }
 
@@ -201,10 +201,9 @@ public void enterBinding(final PhiParser.BindingContext ctx) {
 
     @Override
     public void exitBinding(final PhiParser.BindingContext ctx) {
-        if (ctx.alphaBinding() != null || ctx.emptyBinding() != null) {
-            if (this.objects.size() > this.packages.size()) {
-                this.objects().leave();
-            }
+        if ((ctx.alphaBinding() != null || ctx.emptyBinding() != null)
+            && this.objs.size() > this.packages.size()) {
+            this.objects().leave();
         }
     }
 
@@ -219,6 +218,7 @@ public void exitAlphaBinding(final PhiParser.AlphaBindingContext ctx) {
     }
 
     @Override
+    @SuppressWarnings("PMD.ConfusingTernary")
     public void enterAttribute(final PhiParser.AttributeContext ctx) {
         final String attr;
         if (ctx.PHI() != null) {
@@ -313,6 +313,7 @@ public void exitBnds(final PhiParser.BndsContext ctx) {
     }
 
     @Override
+    @SuppressWarnings("PMD.ConfusingTernary")
     public void enterDispatch(final PhiParser.DispatchContext ctx) {
         if (ctx.HOME() != null) {
             this.objects().prop("base", "Q").leave();
@@ -331,22 +332,22 @@ public void exitDispatch(final PhiParser.DispatchContext ctx) {
     }
 
     @Override
-    public void enterDisp(PhiParser.DispContext ctx) {
+    public void enterDisp(final PhiParser.DispContext ctx) {
         // Nothing here
     }
 
     @Override
-    public void exitDisp(PhiParser.DispContext ctx) {
+    public void exitDisp(final PhiParser.DispContext ctx) {
         // Nothing here
     }
 
     @Override
-    public void enterDispBnds(PhiParser.DispBndsContext ctx) {
+    public void enterDispBnds(final PhiParser.DispBndsContext ctx) {
         this.objects().enter();
     }
 
     @Override
-    public void exitDispBnds(PhiParser.DispBndsContext ctx) {
+    public void exitDispBnds(final PhiParser.DispBndsContext ctx) {
         this.objects().leave();
     }
 
@@ -374,22 +375,22 @@ public void exitTermination(final PhiParser.TerminationContext ctx) {
     }
 
     @Override
-    public void visitTerminal(TerminalNode terminalNode) {
+    public void visitTerminal(final TerminalNode node) {
         // Nothing here
     }
 
     @Override
-    public void visitErrorNode(ErrorNode errorNode) {
+    public void visitErrorNode(final ErrorNode node) {
         // Nothing here
     }
 
     @Override
-    public void enterEveryRule(ParserRuleContext parserRuleContext) {
+    public void enterEveryRule(final ParserRuleContext ctx) {
         // Nothing here
     }
 
     @Override
-    public void exitEveryRule(ParserRuleContext parserRuleContext) {
+    public void exitEveryRule(final ParserRuleContext ctx) {
         // Nothing here
     }
 
@@ -403,7 +404,7 @@ public Iterator<Directive> iterator() {
      * @return Objects
      */
     private Objects objects() {
-        return this.objects.getLast();
+        return this.objs.getLast();
     }
 
     /**
@@ -414,7 +415,9 @@ private Objects objects() {
     private static boolean hasLambdaPackage(final PhiParser.BindingsContext ctx) {
         return ctx.binding()
             .stream()
-            .anyMatch(context -> context.lambdaBidning() != null
-                && context.lambdaBidning().FUNCTION().getText().equals(XePhiListener.LAMBDA_PACKAGE));
+            .anyMatch(
+                context -> context.lambdaBidning() != null
+                && context.lambdaBidning().FUNCTION().getText().equals(XePhiListener.LAMBDA_PACKAGE)
+            );
     }
-}
+}
diff --git a/eo-parser/src/test/java/org/eolang/parser/EoIndentLexerTest.java b/eo-parser/src/test/java/org/eolang/parser/EoIndentLexerTest.java
@@ -57,7 +57,7 @@ void ensuresGrammarFile() throws IOException {
         MatcherAssert.assertThat(
             lexer.getGrammarFileName(),
             Matchers.is(
-                "Program.g4"
+                "Eo.g4"
             )
         );
     }

diff --git a/eo-parser/src/test/java/org/eolang/parser/EoSyntaxTest.java b/eo-parser/src/test/java/org/eolang/parser/EoSyntaxTest.java
@@ -101,7 +101,8 @@ void copiesListingCorrectly() throws Exception {
                     "test-22",
                     new InputOf(src)
                 ).parsed().toString().getBytes(),
-                StandardCharsets.UTF_8)
+                StandardCharsets.UTF_8
+            )
         );
         MatcherAssert.assertThat(
             xml.xpath("/program/listing/text()"),

diff --git a/eo-parser/src/test/java/org/eolang/parser/XMIRTest.java b/eo-parser/src/test/java/org/eolang/parser/XMIRTest.java
@@ -26,13 +26,9 @@
 import com.jcabi.log.Logger;
 import com.jcabi.xml.ClasspathSources;
 import com.jcabi.xml.XML;
-import com.jcabi.xml.XMLDocument;
-import com.jcabi.xml.XSL;
 import com.jcabi.xml.XSLDocument;
-import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import org.cactoos.io.InputOf;
-import org.cactoos.io.OutputTo;
 import org.eolang.jucs.ClasspathSource;
 import org.hamcrest.MatcherAssert;
 import org.hamcrest.Matchers;