Static fixes, enhanced version state manager

bohdan-harniuk · bohdan-harniuk · commit fe89e9be5e9e · 2021-09-15T03:15:29.000+03:00
diff --git a/src/com/magento/idea/magento2uct/execution/GenerateUctReportCommand.java b/src/com/magento/idea/magento2uct/execution/GenerateUctReportCommand.java
@@ -157,6 +157,11 @@ public void execute() {
                 summary.trackProcessFinished();
                 summary.setProcessedModules(scanner.getModuleCount());
                 outputUtil.printSummary(summary);
+
+                if (summary.getProcessedModules() == 0) {
+                    process.destroyProcess();
+                    return;
+                }
                 reportBuilder.addSummary(summary);
             });
 
@@ -173,8 +178,8 @@ public void execute() {
                         psiDocumentManager.commitDocument(document);
                     }
                     outputUtil.printReportFile(report.getVirtualFile().getPath());
-                    process.destroyProcess();
                 }
+                process.destroyProcess();
             });
         });
     }
diff --git a/src/com/magento/idea/magento2uct/execution/output/ReportBuilder.java b/src/com/magento/idea/magento2uct/execution/output/ReportBuilder.java
@@ -86,7 +86,11 @@ public void addSummary(final Summary summary) {
      *
      * @return JsonFile
      */
-    @SuppressWarnings({"PMD.NPathComplexity", "PMD.CyclomaticComplexity"})
+    @SuppressWarnings({
+            "PMD.NPathComplexity",
+            "PMD.CyclomaticComplexity",
+            "PMD.CognitiveComplexity",
+    })
     public JsonFile build() {
         if (report.getIssues().isEmpty() || report.getSummary() == null) {
             return null;
@@ -129,7 +133,7 @@ public JsonFile build() {
         WriteCommandAction.runWriteCommandAction(project, () -> {
             savedFile.add((JsonFile) ideaDirectory.add(reportFile));
 
-            if (savedFile.size() == 0) {
+            if (savedFile.isEmpty()) {
                 return;
             }
             final JsonObject topNode = (JsonObject) savedFile.get(0).getTopLevelValue();
@@ -143,14 +147,14 @@ public JsonFile build() {
             for (final Issue issue : report.getIssues()) {
                 final JsonObject issueObject = jsonElementGenerator.createObject("\"lineNumber\": "
                         + issue.getLine() + ","
-                        + "\"level\": \"" + issue.getLevel() + "\","
+                        + "\"level\": \"" + issue.getLevel() + "\","//NOPMD
                         + "\"message\": \"" + JSONObject.escape(issue.getMessage()) + "\","
                         + "\"code\": \"" + issue.getCode() + "\","
                         + "\"fileName\": \"" + JSONObject.escape(issue.getFilename()) + "\","
                         + "\"validationType\": \"" + issue.getValidationType() + "\""
                 );
                 if (issuesValueBuilder.length() > 0) {
-                    issuesValueBuilder.append(",");
+                    issuesValueBuilder.append(',');
                 }
                 issuesValueBuilder.append(issueObject.getText());
             }
@@ -163,7 +167,7 @@ public JsonFile build() {
                     + "\"totalWarnings\": " + summary.getPhpWarnings() + ","
                     + "\"totalErrors\": " + summary.getPhpErrors() + ","
                     + "\"totalCriticalErrors\": " + summary.getPhpCriticalErrors() + ","
-                    + "\"complexityScore\": " + summary.getComplexityScore() + ""
+                    + "\"complexityScore\": " + summary.getComplexityScore()
             );
             JsonPsiUtil.addProperty(
                     topNode,
@@ -180,7 +184,7 @@ public JsonFile build() {
             );
         });
 
-        return savedFile.size() > 0 ? savedFile.get(0) : reportFile;
+        return savedFile.isEmpty() ? reportFile : savedFile.get(0);
     }
 
     /**
diff --git a/src/com/magento/idea/magento2uct/execution/output/UctReportOutputUtil.java b/src/com/magento/idea/magento2uct/execution/output/UctReportOutputUtil.java
@@ -81,10 +81,13 @@ public void printIssue(final @NotNull ProblemDescriptor descriptor, final int co
      */
     @SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops")
     public void printSummary(final Summary summary) {
-        if (!summary.hasProblems()) {
+        if (summary.getProcessedModules() == 0) {
             stdout.print(stdout.wrapInfo("Couldn't find modules to analyse").concat("\n"));
             return;
         }
+        if (!summary.hasProblems()) {
+            stdout.print("\n" + stdout.wrapInfo("No problems found").concat("\n"));
+        }
         printNavigateToDetailedErrorsLink();
 
         final Map<String, String> summaryMap = new LinkedHashMap<>();
@@ -116,16 +119,13 @@ public void printSummary(final Summary summary) {
         printSummarySeparator(longestKey + 2, longestValue + 2);
 
         for (final Map.Entry<String, String> summaryEntry : summaryMap.entrySet()) {
-            final StringBuilder header = new StringBuilder(summaryEntry.getKey());
+            String header = summaryEntry.getKey();
             final String value = "  " + summaryEntry.getValue();
 
             if (header.length() < longestKey) {
-                header.append(" ".repeat(longestKey - header.length()));
+                header += " ".repeat(longestKey - header.length());//NOPMD
             }
-            stdout.print(
-                    " " + stdout.wrapSummary(header.toString())
-                            .concat("  ").concat(value).concat("\n")
-            );
+            stdout.print(" " + stdout.wrapSummary(header).concat("  ").concat(value).concat("\n"));
         }
         printSummarySeparator(longestKey + 2, longestValue + 2);
     }
diff --git a/src/com/magento/idea/magento2uct/execution/scanner/ModuleScanner.java b/src/com/magento/idea/magento2uct/execution/scanner/ModuleScanner.java
@@ -18,12 +18,11 @@
 import com.magento.idea.magento2plugin.magento.files.ModuleXml;
 import com.magento.idea.magento2plugin.magento.packages.Package;
 import com.magento.idea.magento2uct.execution.scanner.data.ComponentData;
+import com.magento.idea.magento2uct.execution.scanner.filter.ModuleScannerFilter;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Iterator;
 import java.util.List;
-
-import com.magento.idea.magento2uct.execution.scanner.filter.ModuleScannerFilter;
 import org.jetbrains.annotations.NotNull;
 
 public final class ModuleScanner implements Iterable<ComponentData> {
diff --git a/src/com/magento/idea/magento2uct/execution/scanner/filter/ExcludeMagentoBundledFilter.java b/src/com/magento/idea/magento2uct/execution/scanner/filter/ExcludeMagentoBundledFilter.java
@@ -49,7 +49,7 @@ public boolean isExcluded(final ComponentData component) {
     private @Nullable String extractVendorFromModuleName(final @NotNull String moduleName) {
         String[] moduleNamePats = moduleName.split("_");
 
-        if (moduleNamePats.length > 1) {//NOPMD
+        if (moduleNamePats.length > 1) { //NOPMD
             return moduleNamePats[0].toLowerCase(Locale.ROOT);
         }
         moduleNamePats = moduleName.split("/");
diff --git a/src/com/magento/idea/magento2uct/ui/ConfigurationDialog.java b/src/com/magento/idea/magento2uct/ui/ConfigurationDialog.java
@@ -131,7 +131,7 @@ private void onOK() {
 
         settingsService.setCurrentVersion(
                 currentVersionValue.isEmpty()
-                ? null
+                ? null//NOPMD
                 : SupportedVersion.getVersion(currentVersionValue)
         );
         final SupportedVersion targetVersionValue = SupportedVersion.getVersion(
diff --git a/src/com/magento/idea/magento2uct/versioning/VersionStateManager.java b/src/com/magento/idea/magento2uct/versioning/VersionStateManager.java
@@ -16,10 +16,11 @@
 
 public final class VersionStateManager {
 
-    private final UctSettingsService settingsService;
-
     private static VersionStateManager instance;
     private final DeprecationStateIndex deprecationStateIndex;
+    private final Boolean isSetIgnoreFlag;
+    private final SupportedVersion currentVersion;
+    private final SupportedVersion targetVersion;
 
     /**
      * Get instance of the version state manager.
@@ -28,31 +29,63 @@ public final class VersionStateManager {
      *
      * @return VersionStateManager
      */
-    public synchronized static VersionStateManager getInstance(final @NotNull Project project) {//NOPMD
-        if (instance == null) {
+    @SuppressWarnings("PMD.AvoidSynchronizedAtMethodLevel")
+    public static synchronized VersionStateManager getInstance(
+            final @NotNull Project project
+    ) { //NOPMD
+        final UctSettingsService settingsService = UctSettingsService.getInstance(project);
+
+        if (instance == null
+                || !instance.isValidFor(settingsService.shouldIgnoreCurrentVersion(),
+                settingsService.getCurrentVersion(),
+                settingsService.getTargetVersion()
+        )) {
             instance = new VersionStateManager(project);
         }
         return instance;
     }
 
+    /**
+     * Check if specified FQN exists in the deprecation index.
+     *
+     * @param fqn String
+     *
+     * @return boolean
+     */
+    public boolean isDeprecated(final @NotNull String fqn) {
+        return deprecationStateIndex.has(fqn);
+    }
+
     /**
      * Version state manager constructor.
      */
     private VersionStateManager(final @NotNull Project project) {
-        settingsService = UctSettingsService.getInstance(project);
+        final UctSettingsService settingsService = UctSettingsService.getInstance(project);
         deprecationStateIndex = new DeprecationStateIndex();
+        isSetIgnoreFlag = settingsService.shouldIgnoreCurrentVersion();
+        currentVersion = settingsService.getCurrentVersion();
+        targetVersion = settingsService.getTargetVersion();
+
         compute(deprecationStateIndex);
     }
 
     /**
-     * Check if specified FQN exists in the deprecation index.
+     * Check if current instance is valid for settings.
      *
-     * @param fqn String
+     * @param isSetIgnoreFlag boolean
+     * @param currentVersion SupportedVersion
+     * @param targetVersion SupportedVersion
      *
      * @return boolean
      */
-    public boolean isDeprecated(final @NotNull String fqn) {
-        return deprecationStateIndex.has(fqn);
+    private boolean isValidFor(
+            final Boolean isSetIgnoreFlag,
+            final SupportedVersion currentVersion,
+            final SupportedVersion targetVersion
+    ) {
+        return this.isSetIgnoreFlag.equals(isSetIgnoreFlag)
+                && this.currentVersion.equals(currentVersion)
+                && this.targetVersion.equals(targetVersion);
     }
 
     /**
@@ -61,23 +94,14 @@ public boolean isDeprecated(final @NotNull String fqn) {
      * @param index VersionStateIndex
      */
     private void compute(final VersionStateIndex index) {
-        final Boolean hasIgnoreFlagStoredValue = settingsService.shouldIgnoreCurrentVersion();
-        boolean hasIgnoringFlag = false;
-
-        if (hasIgnoreFlagStoredValue != null) {
-            hasIgnoringFlag = hasIgnoreFlagStoredValue;
-        }
-        final SupportedVersion targetVersion = settingsService.getTargetVersion();
-
         if (targetVersion == null) {
             return;
         }
         final List<SupportedVersion> versionsToLoad = new LinkedList<>();
-        final SupportedVersion currentVersion = settingsService.getCurrentVersion();
 
         for (final SupportedVersion version : SupportedVersion.values()) {
             if (version.compareTo(targetVersion) <= 0) {
-                if (hasIgnoringFlag) {
+                if (isSetIgnoreFlag != null && isSetIgnoreFlag) {
                     // If current version is NULL, it is less than minimum supported version.
                     if (currentVersion == null || version.compareTo(currentVersion) > 0) {
                         versionsToLoad.add(version);
diff --git a/src/com/magento/idea/magento2uct/versioning/indexes/IndexRepository.java b/src/com/magento/idea/magento2uct/versioning/indexes/IndexRepository.java
@@ -110,13 +110,21 @@ public void put(final @NotNull Map<K, V> data, final String version) {
     @Override
     public @Nullable Map<K, V> load(final @NotNull String resourceName)
             throws IOException, ClassNotFoundException {
-        try (
-                InputStream inputStream = getClass().getResourceAsStream(resourceName);
-                ObjectInputStream objectInputStream = new ObjectInputStream(inputStream)
-        ) {
+        ObjectInputStream objectInputStream = null;
+
+        try (InputStream inputStream = getClass().getResourceAsStream(resourceName)) { //NOPMD
+            if (inputStream == null) {
+                return null;
+            }
+            objectInputStream = new ObjectInputStream(inputStream);
+
             return (HashMap<K, V>) objectInputStream.readObject();
         } catch (ClassCastException exception) {
             return null;
+        } finally {
+            if (objectInputStream != null) {
+                objectInputStream.close();
+            }
         }
     }
 }
diff --git a/src/com/magento/idea/magento2uct/versioning/indexes/data/DeprecationStateIndex.java b/src/com/magento/idea/magento2uct/versioning/indexes/data/DeprecationStateIndex.java
@@ -74,7 +74,7 @@ public void load(final @NotNull List<SupportedVersion> versions) {
                     .replace("%key", registrationInfo.getKey());
             try {
                 putIndexData(version.getVersion(), storage.load(RESOURCE_PATH + indexName));
-            } catch (IOException | ClassNotFoundException exception) {//NOPMD
+            } catch (IOException | ClassNotFoundException exception) { //NOPMD
                 // Just go for the next version.
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public boolean isExcluded(final ComponentData component) {`
`49`	`49`	`private @Nullable String extractVendorFromModuleName(final @NotNull String moduleName) {`
`50`	`50`	`String[] moduleNamePats = moduleName.split("_");`
`51`	`51`
`52`		`- if (moduleNamePats.length > 1) {//NOPMD`
	`52`	`+ if (moduleNamePats.length > 1) { //NOPMD`
`53`	`53`	`return moduleNamePats[0].toLowerCase(Locale.ROOT);`
`54`	`54`	`}`
`55`	`55`	`moduleNamePats = moduleName.split("/");`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ public void load(final @NotNull List<SupportedVersion> versions) {`
`74`	`74`	`.replace("%key", registrationInfo.getKey());`
`75`	`75`	`try {`
`76`	`76`	`putIndexData(version.getVersion(), storage.load(RESOURCE_PATH + indexName));`
`77`		`- } catch (IOException \| ClassNotFoundException exception) {//NOPMD`
	`77`	`+ } catch (IOException \| ClassNotFoundException exception) { //NOPMD`
`78`	`78`	`// Just go for the next version.`
`79`	`79`	`}`
`80`	`80`	`}`