1023: added functional for addtional scanning files

Author: doninAtwix

src/com/magento/idea/magento2plugin/magento/files/ThemeXml.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.magento.files;
+
+import com.intellij.lang.Language;
+import com.intellij.lang.xml.XMLLanguage;
+
+public class ThemeXml implements ModuleFileInterface {
+    public static final String FILE_NAME = "theme.xml";
+    public static final String TITLE_ELEMENT_NAME = "title";
+    public static final String TEMPLATE = "Magento Theme XML";
+    private static final ThemeXml INSTANCE = new ThemeXml();
+
+    /**
+     * Getter for singleton instance of class.
+     */
+    public static ThemeXml getInstance() {
+        return INSTANCE;
+    }
+
+    @Override
+    public String getFileName() {
+        return FILE_NAME;
+    }
+
+    @Override
+    public String getTemplate() {
+        return TEMPLATE;
+    }
+
+    @Override
+    public Language getLanguage() {
+        return XMLLanguage.INSTANCE;
+    }
+}

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

@@ -26,6 +26,8 @@
 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;
@@ -81,6 +83,7 @@ public void processTerminated(final @NotNull ProcessEvent event) {
     public void execute() {
         output.write("Upgrade compatibility tool\n");
         final PsiDirectory rootDirectory = getTargetPsiDirectory();
+        final PsiDirectory additionalDirectory = getAdditionalTargetPsiDirectory();
 
         if (rootDirectory == null) {
             output.print(
@@ -99,6 +102,10 @@ 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(() -> {
@@ -152,6 +159,56 @@ 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());
                 outputUtil.printSummary(summary);
@@ -201,4 +258,25 @@ 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/scanner/ThemeFilesScanner.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2uct.execution.scanner;
+
+import com.intellij.psi.PsiDirectory;
+import com.intellij.psi.PsiFile;
+import com.jetbrains.php.lang.psi.PhpFile;
+import com.magento.idea.magento2uct.execution.scanner.data.ComponentData;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+
+public class ThemeFilesScanner implements Iterable<PsiFile> {
+
+    private final ComponentData componentData;
+    private final List<PsiFile> files;
+
+    /**
+     * Module files scanner constructor.
+     *
+     * @param componentData ComponentData
+     */
+    public ThemeFilesScanner(final @NotNull ComponentData componentData) {
+        this.componentData = componentData;
+        files = new ArrayList<>();
+    }
+
+    @Override
+    public @NotNull Iterator<PsiFile> iterator() {
+        return run().iterator();
+    }
+
+    /**
+     * Collect module files.
+     *
+     * @return List[PsiFile]
+     */
+    private List<PsiFile> run() {
+        files.clear();
+        collectFilesInDirectoryRecursively(componentData.getDirectory());
+
+        return files;
+    }
+
+    /**
+     * Collect all files in directory recursively.
+     *
+     * @param directory PsiDirectory
+     */
+    private void collectFilesInDirectoryRecursively(final @NotNull PsiDirectory directory) {
+        for (final PsiFile file : directory.getFiles()) {
+            if (!(file instanceof PhpFile)) {
+                files.add(file);
+            }
+        }
+
+        for (final PsiDirectory subDirectory : directory.getSubdirectories()) {
+            collectFilesInDirectoryRecursively(subDirectory);
+        }
+    }
+}