1023: Added phtml files support

Author: bohdan-harniuk

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

@@ -139,7 +139,7 @@ public void execute() {
 
                         if (fileProblemsHolder.hasResults()) {
                             if (!isModuleHeaderPrinted) {
-                                outputUtil.printModuleName(componentData.getName());
+                                outputUtil.printModuleName(componentData);
                                 isModuleHeaderPrinted = true;
                             }
                             outputUtil.printProblemFile(filename);
@@ -171,7 +171,7 @@ public void execute() {
                 summary.setProcessedThemes(scanner.getThemeCount());
                 outputUtil.printSummary(summary);
 
-                if (summary.getProcessedModules() == 0) {
+                if (summary.getProcessedModules() == 0 && summary.getProcessedThemes() == 0) {
                     process.destroyProcess();
                     return;
                 }

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"));
     }
@@ -81,7 +92,7 @@ public void printIssue(final @NotNull ProblemDescriptor descriptor, final int co
      */
     @SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops")
     public void printSummary(final Summary summary) {
-        if (summary.getProcessedModules() == 0) {
+        if (summary.getProcessedModules() == 0 && summary.getProcessedThemes() == 0) {
             stdout.print(stdout.wrapInfo("Couldn't find modules to analyse").concat("\n"));
             return;
         }

src/com/magento/idea/magento2uct/inspections/UctInspectionManager.java

@@ -52,19 +52,14 @@ public UctInspectionManager(final @NotNull Project project) {
         if (!(psiFile instanceof PhpFile)) {
             return null;
         }
-        final PhpClass phpClass = GetFirstClassOfFile.getInstance().execute((PhpFile) psiFile);
-
-        if (phpClass == null) {
-            return null;
-        }
         final UctProblemsHolder problemsHolder = new UctProblemsHolder(
                 InspectionManager.getInstance(project),
                 psiFile,
                 false
         );
         final List<PsiElementVisitor> visitors = SupportedIssue.getVisitors(problemsHolder);
 
-        for (final PsiElement element : collectElements(phpClass)) {
+        for (final PsiElement element : collectElements(psiFile)) {
             for (final PsiElementVisitor visitor : visitors) {
                 element.accept(visitor);
             }
@@ -76,26 +71,31 @@ public UctInspectionManager(final @NotNull Project project) {
     /**
      * Collect elements for PHP based inspections.
      *
-     * @param phpClass PhpClass
+     * @param psiFile PsiFile
      *
      * @return List[PsiElement]
      */
-    private List<PsiElement> collectElements(final @NotNull PhpClass phpClass) {
+    private List<PsiElement> collectElements(final @NotNull PsiFile psiFile) {
         final List<PsiElement> elements = new LinkedList<>();
-        elements.add(phpClass);
 
-        final PhpPsiElement scopeForUseOperator = PhpCodeInsightUtil.findScopeForUseOperator(
-                phpClass
-        );
-        if (scopeForUseOperator != null) {
-            elements.addAll(PhpCodeInsightUtil.collectImports(scopeForUseOperator));
+        final PhpClass phpClass = GetFirstClassOfFile.getInstance().execute((PhpFile) psiFile);
+
+        if (phpClass != null) {
+            elements.add(phpClass);
+            final PhpPsiElement scopeForUseOperator = PhpCodeInsightUtil.findScopeForUseOperator(
+                    phpClass
+            );
+
+            if (scopeForUseOperator != null) {
+                elements.addAll(PhpCodeInsightUtil.collectImports(scopeForUseOperator));
+            }
+            elements.addAll(Arrays.asList(phpClass.getOwnFields()));
         }
-        elements.addAll(PsiTreeUtil.findChildrenOfType(phpClass, ClassConstantReference.class));
-        elements.addAll(Arrays.asList(phpClass.getOwnFields()));
-        elements.addAll(PsiTreeUtil.findChildrenOfType(phpClass, MethodReference.class));
-        elements.addAll(PsiTreeUtil.findChildrenOfType(phpClass, AssignmentExpression.class));
-        elements.addAll(PsiTreeUtil.findChildrenOfType(phpClass, ClassReference.class));
-        elements.addAll(PsiTreeUtil.findChildrenOfType(phpClass, FieldReference.class));
+        elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, ClassConstantReference.class));
+        elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, MethodReference.class));
+        elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, AssignmentExpression.class));
+        elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, ClassReference.class));
+        elements.addAll(PsiTreeUtil.findChildrenOfType(psiFile, FieldReference.class));
 
         return elements;
     }