1023: Added support of the theme component

Author: bohdan-harniuk

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

@@ -26,8 +26,6 @@
 import com.magento.idea.magento2uct.execution.process.OutputWrapper;
 import com.magento.idea.magento2uct.execution.scanner.ModuleFilesScanner;
 import com.magento.idea.magento2uct.execution.scanner.ModuleScanner;
-import com.magento.idea.magento2uct.execution.scanner.ThemeFilesScanner;
-import com.magento.idea.magento2uct.execution.scanner.ThemeScanner;
 import com.magento.idea.magento2uct.execution.scanner.data.ComponentData;
 import com.magento.idea.magento2uct.execution.scanner.filter.ExcludeMagentoBundledFilter;
 import com.magento.idea.magento2uct.inspections.UctInspectionManager;
@@ -37,6 +35,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;
@@ -82,8 +81,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 additionalDirectory = getAdditionalTargetPsiDirectory();
+        final PsiDirectory rootDirectory = getTargetPsiDirectory(settingsService.getModulePath());
 
         if (rootDirectory == null) {
             output.print(
@@ -92,8 +90,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(
@@ -102,10 +113,6 @@ public void execute() {
         );
         final ReportBuilder reportBuilder = new ReportBuilder(project);
         final UctReportOutputUtil outputUtil = new UctReportOutputUtil(output);
-        final ThemeScanner themeScanner = new ThemeScanner(
-                additionalDirectory,
-                new ExcludeMagentoBundledFilter()
-        );
 
         ApplicationManager.getApplication().executeOnPooledThread(() -> {
             ApplicationManager.getApplication().runReadAction(() -> {
@@ -159,58 +166,9 @@ public void execute() {
                         }
                     }
                 }
-                for (final ComponentData themeComponentData: themeScanner) {
-                    if (process.isProcessTerminated()) {
-                        return;
-                    }
-                    boolean isThemeHeaderPrinted = false;
-
-                    for (final PsiFile psiFile : new ThemeFilesScanner(themeComponentData)) {
-                        if (!(psiFile instanceof PhpFile)) {
-                            continue;
-                        }
-
-                        final String filename = psiFile.getVirtualFile().getPath();
-                        final UctInspectionManager inspectionManager = new UctInspectionManager(
-                                project
-                        );
-                        final UctProblemsHolder fileProblemsHolder = inspectionManager.run(psiFile);
-
-                        if (fileProblemsHolder == null) {
-                            continue;
-                        }
-
-                        if (fileProblemsHolder.hasResults()) {
-                            if (!isThemeHeaderPrinted) {
-                                outputUtil.printModuleName(themeComponentData.getName());
-                                isThemeHeaderPrinted = true;
-                            }
-                            outputUtil.printProblemFile(filename);
-                        }
-                        final List<ProblemDescriptor> problems = SortDescriptorResultsUtil.sort(
-                                FilterDescriptorResultsUtil.filter(fileProblemsHolder)
-                        );
-
-                        for (final ProblemDescriptor descriptor : problems) {
-                            final SupportedIssue issue = fileProblemsHolder.getIssue(descriptor);
-
-                            final String errorMessage = descriptor
-                                    .getDescriptionTemplate()
-                                    .substring(6)
-                                    .trim();
-                            summary.addToSummary(issue.getLevel());
-                            reportBuilder.addIssue(
-                                    descriptor.getLineNumber() + 1,
-                                    filename,
-                                    errorMessage,
-                                    issue
-                            );
-                            outputUtil.printIssue(descriptor, issue.getCode());
-                        }
-                    }
-                }
                 summary.trackProcessFinished();
                 summary.setProcessedModules(scanner.getModuleCount());
+                summary.setProcessedThemes(scanner.getThemeCount());
                 outputUtil.printSummary(summary);
 
                 if (summary.getProcessedModules() == 0) {
@@ -242,11 +200,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;
         }
@@ -258,25 +216,4 @@ public void execute() {
 
         return PsiManager.getInstance(project).findDirectory(targetDirVirtualFile);
     }
-
-    /**
-     * Get additional target psi directory.
-     *
-     * @return PsiDirectory
-     */
-    private @Nullable PsiDirectory getAdditionalTargetPsiDirectory() {
-        final String additionalTargetDirPath = settingsService.getAdditionalPath();
-
-        if (additionalTargetDirPath == null) {
-            return null;
-        }
-        final VirtualFile targetDirVirtualFile
-                = VfsUtil.findFile(Paths.get(additionalTargetDirPath), false);
-
-        if (targetDirVirtualFile == null) {
-            return null;
-        }
-
-        return PsiManager.getInstance(project).findDirectory(targetDirVirtualFile);
-    }
 }

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

@@ -95,6 +95,7 @@ public void printSummary(final Summary summary) {
         summaryMap.put("Adobe Commerce 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",