chore(qulice): resolved all Qulice warnings

Author: nergal-perm

src/main/java/ru/ewc/checklogic/ServerInstance.java

@@ -130,13 +130,13 @@ public boolean isAvailable(final String command, final String field) {
     }
 
     public void update(final List<String> values) {
-        final InMemoryLocator request = InMemoryLocator.empty(requestLocatorName());
+        final InMemoryLocator request = InMemoryLocator.empty(this.requestLocatorName());
         values.forEach(
             value -> {
                 final String[] split = value.split(":");
                 request.setFragmentValue(split[0].trim(), split[1].trim());
             });
-        this.state.locators().put(this.server.requestLocatorName(), request);
+        this.state.locators().put(this.requestLocatorName(), request);
         this.context = new ComputationContext(this.state, this.getAllTables());
     }
 

src/main/java/ru/ewc/checklogic/server/AllEndpoints.java

@@ -46,9 +46,9 @@ public final class AllEndpoints implements Endpoints {
      */
     private final WebPages pages;
 
-    public AllEndpoints(final ServerInstance context, ServerConfiguration configuration) {
+    public AllEndpoints(final ServerInstance context, final ServerConfiguration config) {
         this.context = context;
-        this.pages = WebPages.create(new ResourceTemplateRender(), context.getRoot(), configuration);
+        this.pages = new WebPages(new ResourceTemplateRender(), context.getRoot(), config);
     }
 
     @Override

src/main/java/ru/ewc/checklogic/server/WebPages.java

@@ -54,18 +54,21 @@ public final class WebPages {
      */
     private final String root;
 
+    /**
+     * Server configuration that holds the request locator name.
+     */
     private final ServerConfiguration config;
 
-    private WebPages(final TemplateRender processors, final String root, ServerConfiguration config) {
+    public WebPages(
+        final TemplateRender processors,
+        final String root,
+        final ServerConfiguration config
+    ) {
         this.processors = processors;
         this.root = root;
         this.config = config;
     }
 
-    public static WebPages create(final TemplateRender processors, final String root, ServerConfiguration configuration) {
-        return new WebPages(processors, root, configuration);
-    }
-
     public static WebPages testable() {
         return new WebPages(new MockTemplateRender(), "root folder", new ServerConfiguration());
     }

src/main/java/ru/ewc/checklogic/testing/CheckFailure.java

@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024 Eugene Terekhov
+ * Copyright (c) 2024 Decision-Driven Development
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal

src/main/java/ru/ewc/checklogic/testing/CheckFile.java

@@ -33,24 +33,37 @@
 import ru.ewc.decisions.commands.Assignment;
 import ru.ewc.decisions.conditions.Condition;
 
-public class CheckFile {
-    private final List<RuleFragments> rules;
+/**
+ * I am a single file containing one or more tests. I am responsible for performing all the tests
+ * and logging the results.
+ *
+ * @since 0.4.1
+ */
+public final class CheckFile {
+    /**
+     * The collection of single tests inside the file.
+     */
+    private final List<RuleFragments> tests;
 
-    public CheckFile(List<RuleFragments> rules) {
-        this.rules = rules;
+    public CheckFile(final List<RuleFragments> tests) {
+        this.tests = tests;
     }
 
-    public List<TestResult> performChecks(ComputationContext context, String locator) {
-        return this.rules.stream()
+    public List<TestResult> performChecks(final ComputationContext context, final String locator) {
+        return this.tests.stream()
             .map(rule -> CheckFile.performAndLog(context, rule, locator))
             .toList();
     }
 
-    private static TestResult performAndLog(final ComputationContext ctx, final RuleFragments rule, String locator) {
+    private static TestResult performAndLog(
+        final ComputationContext ctx,
+        final RuleFragments rule,
+        final String locator
+    ) {
         logCheckpoint(ctx, "%s - started".formatted(rule.header()));
         final OutputTracker<String> tracker = ctx.startTracking();
-        List<CheckFailure> failures = new ArrayList<>(1);
-        for (RuleFragment fragment : rule.getFragments()) {
+        final List<CheckFailure> failures = new ArrayList<>(1);
+        for (final RuleFragment fragment : rule.getFragments()) {
             if (fragment.nonEmptyOfType("CND")) {
                 final Condition check = Condition.from(fragment);
                 if (!check.evaluate(ctx)) {
@@ -69,7 +82,11 @@ private static TestResult performAndLog(final ComputationContext ctx, final Rule
         );
     }
 
-    private static void perform(RuleFragment fragment, ComputationContext ctx, String locator) {
+    private static void perform(
+        final RuleFragment fragment,
+        final ComputationContext ctx,
+        final String locator
+    ) {
         switch (fragment.type()) {
             case "ASG" -> new Assignment(fragment.left(), fragment.right()).performIn(ctx);
             case "OUT" -> {
@@ -79,7 +96,6 @@ private static void perform(RuleFragment fragment, ComputationContext ctx, Strin
                 }
             }
             default -> {
-                // do nothing, because we don't know what to do with such a fragment type
             }
         }
     }

src/main/java/ru/ewc/checklogic/testing/CheckSuite.java

@@ -1,7 +1,7 @@
 /*
  * MIT License
  *
- * Copyright (c) 2024 Eugene Terekhov
+ * Copyright (c) 2024 Decision-Driven Development
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -30,10 +30,10 @@
 import ru.ewc.decisions.input.ContentsReader;
 
 /**
- * I represent a collection of test-cases to performChecks. My main responsibility is to run all the tests
- * and collect the results.
+ * I represent a collection of test-cases to performChecks. My main responsibility is to run all
+ * the tests and collect the results.
  *
- * @since 0.8.0
+ * @since 0.4.1
  */
 @SuppressWarnings("PMD.ProhibitPublicStaticMethods")
 public final class CheckSuite {
@@ -49,7 +49,8 @@ private CheckSuite(final Collection<CheckFile> tests) {
     public static CheckSuite using(final ContentsReader reader) {
         return new CheckSuite(reader.readAll().stream()
             .map(sl -> new CheckFile(sl.specifiedRulesFragments()))
-            .toList());
+            .toList()
+        );
     }
 
     public List<TestResult> perform(final ComputationContext context, final String locator) {

src/main/java/ru/ewc/checklogic/testing/CheckResult.java renamed to src/main/java/ru/ewc/checklogic/testing/package-info.java

@@ -21,16 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-package ru.ewc.checklogic.testing;
-
-import ru.ewc.decisions.api.RuleFragments;
-
-public class CheckResult {
-   private final RuleFragments rule;
-
-    public CheckResult(RuleFragments rule) {
-        this.rule = rule;
-    }
 
-
-}
+/**
+ * Package for all the testing-related classes.
+ */
+package ru.ewc.checklogic.testing;