Merge pull request #1029 from magento/mainline/uct-1023-theme-scanning-feature

Mainline/UCT-1023: Theme scanning feature

Author: Iamwade

src/com/magento/idea/magento2plugin/magento/packages/ComponentType.java

@@ -10,7 +10,8 @@
 @SuppressWarnings({"PMD.FieldNamingConventions"})
 public enum ComponentType {
     module,
-    theme;
+    theme,
+    library;
 
     /**
      * Get component type by value.

src/com/magento/idea/magento2uct/execution/GenerateUctReportCommand.java

@@ -37,6 +37,7 @@
 import com.magento.idea.magento2uct.util.inspection.FilterDescriptorResultsUtil;
 import com.magento.idea.magento2uct.util.inspection.SortDescriptorResultsUtil;
 import java.nio.file.Paths;
+import java.util.ArrayList;
 import java.util.List;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -84,7 +85,7 @@ public void processTerminated(final @NotNull ProcessEvent event) {
     @SuppressWarnings({"PMD.ExcessiveMethodLength", "PMD.AvoidInstantiatingObjectsInLoops"})
     public void execute() {
         output.write("Upgrade compatibility tool\n");
-        final PsiDirectory rootDirectory = getTargetPsiDirectory();
+        final PsiDirectory rootDirectory = getTargetPsiDirectory(settingsService.getModulePath());
 
         if (rootDirectory == null) {
             output.print(
@@ -93,8 +94,21 @@ public void execute() {
             process.destroyProcess();
             return;
         }
+        final List<PsiDirectory> directoriesToScan = new ArrayList<>();
+        directoriesToScan.add(rootDirectory);
+
+        if (settingsService.getHasAdditionalPath()) {
+            final PsiDirectory additionalDirectory = getTargetPsiDirectory(
+                    settingsService.getAdditionalPath()
+            );
+
+            if (additionalDirectory != null) {
+                directoriesToScan.add(additionalDirectory);
+            }
+        }
+
         final ModuleScanner scanner = new ModuleScanner(
-                rootDirectory,
+                directoriesToScan,
                 new ExcludeMagentoBundledFilter()
         );
         final Summary summary = new Summary(
@@ -136,7 +150,7 @@ public void execute() {
 
                         if (fileProblemsHolder.hasResults()) {
                             if (!isModuleHeaderPrinted) {
-                                outputUtil.printModuleName(componentData.getName());
+                                outputUtil.printModuleName(componentData);
                                 isModuleHeaderPrinted = true;
                             }
                             outputUtil.printProblemFile(filename);
@@ -165,9 +179,10 @@ public void execute() {
                 }
                 summary.trackProcessFinished();
                 summary.setProcessedModules(scanner.getModuleCount());
+                summary.setProcessedThemes(scanner.getThemeCount());
                 outputUtil.printSummary(summary, resolvedEdition);
 
-                if (summary.getProcessedModules() == 0) {
+                if (summary.getProcessedModules() == 0 && summary.getProcessedThemes() == 0) {
                     process.destroyProcess();
                     return;
                 }
@@ -196,11 +211,11 @@ public void execute() {
     /**
      * Get target psi directory.
      *
+     * @param targetDirPath String
+     *
      * @return PsiDirectory
      */
-    private @Nullable PsiDirectory getTargetPsiDirectory() {
-        final String targetDirPath = settingsService.getModulePath();
-
+    private @Nullable PsiDirectory getTargetPsiDirectory(final String targetDirPath) {
         if (targetDirPath == null) {
             return null;
         }

src/com/magento/idea/magento2uct/execution/output/ReportBuilder.java

@@ -163,6 +163,7 @@ public JsonFile build() {
                     + "installedVersion\": \"" + summary.getInstalledVersion() + "\","
                     + "\"AdobeCommerceVersion\": \"" + summary.getTargetVersion() + "\","
                     + "\"checkedModules\": " + summary.getProcessedModules() + ","
+                    + "\"checkedThemes\": " + summary.getProcessedThemes() + ","
                     + "\"runningTime\": \"" + summary.getProcessRunningTime() + "\","
                     + "\"totalWarnings\": " + summary.getPhpWarnings() + ","
                     + "\"totalErrors\": " + summary.getPhpErrors() + ","

src/com/magento/idea/magento2uct/execution/output/Summary.java

@@ -18,6 +18,7 @@ public class Summary {
     private final SupportedVersion installedVersion;
     private final SupportedVersion targetVersion;
     private int processedModules;
+    private int processedThemes;
     private long processStartedTime;
     private long processEndedTime;
     private int phpWarnings;
@@ -74,6 +75,24 @@ public void setProcessedModules(final int processedModules) {
         this.processedModules = processedModules;
     }
 
+    /**
+     * Get processed theme qty.
+     *
+     * @return int
+     */
+    public int getProcessedThemes() {
+        return processedThemes;
+    }
+
+    /**
+     * Set processed theme qty.
+     *
+     * @param processedThemes int
+     */
+    public void setProcessedThemes(final int processedThemes) {
+        this.processedThemes = processedThemes;
+    }
+
     /**
      * Track time before process is started.
      */

src/com/magento/idea/magento2uct/execution/output/UctReportOutputUtil.java

@@ -8,8 +8,10 @@
 import com.intellij.codeInspection.ProblemDescriptor;
 import com.magento.idea.magento2uct.bundles.UctInspectionBundle;
 import com.magento.idea.magento2uct.execution.process.OutputWrapper;
+import com.magento.idea.magento2uct.execution.scanner.data.ComponentData;
 import com.magento.idea.magento2uct.packages.SupportedIssue;
 import java.util.LinkedHashMap;
+import java.util.Locale;
 import java.util.Map;
 import org.jetbrains.annotations.NotNull;
 
@@ -31,10 +33,19 @@ public UctReportOutputUtil(final @NotNull OutputWrapper output) {
     /**
      * Print module name header.
      *
-     * @param moduleName String
+     * @param componentData ComponentData
      */
-    public void printModuleName(final @NotNull String moduleName) {
-        final String moduleNameLine = "Module Name: ".concat(moduleName);
+    public void printModuleName(final @NotNull ComponentData componentData) {
+        final String componentType = componentData.getType().toString();
+        final String componentTypeFormatted = componentType
+                .substring(0, 1)
+                .toUpperCase(new Locale("en","EN"))
+                .concat(componentType.substring(1));
+
+        final String moduleNameLine = componentTypeFormatted
+                .concat(" Name: ")
+                .concat(componentData.getName());
+
         stdout.print("\n\n" + stdout.wrapInfo(moduleNameLine).concat("\n"));
         stdout.print(stdout.wrapInfo("-".repeat(moduleNameLine.length())).concat("\n"));
     }
@@ -80,9 +91,9 @@ public void printIssue(final @NotNull ProblemDescriptor descriptor, final int co
      * @param summary Summary
      * @param platformName String
      */
-    @SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops")
+    @SuppressWarnings({"PMD.AvoidInstantiatingObjectsInLoops", "PMD.CyclomaticComplexity"})
     public void printSummary(final Summary summary, final String platformName) {
-        if (summary.getProcessedModules() == 0) {
+        if (summary.getProcessedModules() == 0 && summary.getProcessedThemes() == 0) {
             stdout.print(stdout.wrapInfo("Couldn't find modules to analyse").concat("\n"));
             return;
         }
@@ -96,6 +107,7 @@ public void printSummary(final Summary summary, final String platformName) {
         summaryMap.put(platformName + " version", summary.getTargetVersion());
         summaryMap.put("Running time", summary.getProcessRunningTime());
         summaryMap.put("Checked modules", String.valueOf(summary.getProcessedModules()));
+        summaryMap.put("Checked themes", String.valueOf(summary.getProcessedThemes()));
         summaryMap.put("Total warnings found", String.valueOf(summary.getPhpWarnings()));
         summaryMap.put("Total errors found", String.valueOf(summary.getPhpErrors()));
         summaryMap.put("Total critical errors found",