UCT-715: Refactored using deprecated property inspection

Author: bohdan-harniuk

src/com/magento/idea/magento2uct/inspections/php/deprecation/UsingDeprecatedProperty.java

@@ -8,84 +8,75 @@
 import com.intellij.codeInspection.ProblemHighlightType;
 import com.intellij.codeInspection.ProblemsHolder;
 import com.intellij.openapi.project.Project;
-import com.intellij.psi.PsiElement;
-import com.intellij.psi.PsiElementVisitor;
-import com.intellij.psi.PsiFile;
-import com.jetbrains.php.lang.inspections.PhpInspection;
+import com.jetbrains.php.lang.psi.elements.ClassConstantReference;
 import com.jetbrains.php.lang.psi.elements.Field;
 import com.jetbrains.php.lang.psi.elements.FieldReference;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
-import com.jetbrains.php.lang.psi.visitors.PhpElementVisitor;
+import com.jetbrains.php.lang.psi.elements.impl.ClassConstImpl;
 import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
+import com.magento.idea.magento2uct.inspections.php.UsedFieldInspection;
+import com.magento.idea.magento2uct.packages.IssueSeverityLevel;
 import com.magento.idea.magento2uct.packages.SupportedIssue;
-import com.magento.idea.magento2uct.settings.UctSettingsService;
 import com.magento.idea.magento2uct.versioning.VersionStateManager;
 import org.jetbrains.annotations.NotNull;
 
-public class UsingDeprecatedProperty extends PhpInspection {
+public class UsingDeprecatedProperty extends UsedFieldInspection {
 
     @Override
-    @SuppressWarnings("PMD.CognitiveComplexity")
-    public @NotNull PsiElementVisitor buildVisitor(
+    protected void execute(
+            final Project project,
             final @NotNull ProblemsHolder problemsHolder,
-            final boolean isOnTheFly
+            final Field field,
+            final FieldReference fieldReference
     ) {
-        return new PhpElementVisitor() {
-
-            @Override
-            public void visitPhpFieldReference(final FieldReference fieldReference) {
-                final Project project = fieldReference.getProject();
-                final UctSettingsService settings = UctSettingsService.getInstance(project);
-
-                if (!settings.isEnabled() || !settings.isIssueLevelSatisfiable(
-                        SupportedIssue.USING_DEPRECATED_PROPERTY.getLevel())
-                ) {
-                    return;
-                }
-                final PsiElement element = fieldReference.resolve();
-                final PsiFile file = fieldReference.getContainingFile();
-
-                if (!(element instanceof Field) || element.getContainingFile().equals(file)) {
-                    return;
-                }
-                final Field field = (Field) element;
+        if (VersionStateManager.getInstance(project).isDeprecated(field.getFQN())) {
+            if (problemsHolder instanceof UctProblemsHolder) {
+                ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
+                        SupportedIssue.USING_DEPRECATED_PROPERTY.getCode()
+                );
+            }
+            problemsHolder.registerProblem(
+                    fieldReference,
+                    SupportedIssue.USING_DEPRECATED_PROPERTY.getMessage(
+                            field.getFQN().replace(".", "::")
+                    ),
+                    ProblemHighlightType.LIKE_DEPRECATED
+            );
+        } else {
+            final PhpClass containingClass = field.getContainingClass();
 
-                if (VersionStateManager.getInstance(project).isDeprecated(field.getFQN())) {
-                    if (problemsHolder instanceof UctProblemsHolder) {
-                        ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
-                                SupportedIssue.USING_DEPRECATED_PROPERTY.getCode()
-                        );
-                    }
-                    problemsHolder.registerProblem(
-                            fieldReference,
-                            SupportedIssue.USING_DEPRECATED_PROPERTY.getMessage(
-                                    field.getFQN().replace(".", "::")
-                            ),
-                            ProblemHighlightType.LIKE_DEPRECATED
+            if (containingClass == null) {
+                return;
+            }
+            if (VersionStateManager.getInstance(project).isDeprecated(containingClass.getFQN())) {
+                if (problemsHolder instanceof UctProblemsHolder) {
+                    ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
+                            SupportedIssue.USING_DEPRECATED_PROPERTY.getCode()
                     );
-                } else {
-                    final PhpClass containingClass = field.getContainingClass();
-
-                    if (containingClass == null) {
-                        return;
-                    }
-                    if (VersionStateManager.getInstance(project)
-                            .isDeprecated(containingClass.getFQN())) {
-                        if (problemsHolder instanceof UctProblemsHolder) {
-                            ((UctProblemsHolder) problemsHolder).setReservedErrorCode(
-                                    SupportedIssue.USING_DEPRECATED_PROPERTY.getCode()
-                            );
-                        }
-                        problemsHolder.registerProblem(
-                                fieldReference,
-                                SupportedIssue.USING_DEPRECATED_PROPERTY.getMessage(
-                                        field.getFQN().replace(".", "::")
-                                ),
-                                ProblemHighlightType.LIKE_DEPRECATED
-                        );
-                    }
                 }
+                problemsHolder.registerProblem(
+                        fieldReference,
+                        SupportedIssue.USING_DEPRECATED_PROPERTY.getMessage(
+                                field.getFQN().replace(".", "::")
+                        ),
+                        ProblemHighlightType.LIKE_DEPRECATED
+                );
             }
-        };
+        }
+    }
+
+    @Override
+    protected void execute(
+            final Project project,
+            final @NotNull ProblemsHolder problemsHolder,
+            final ClassConstImpl constant,
+            final ClassConstantReference constantReference
+    ) {
+        // We do not need to check constant in the field inspection.
+    }
+
+    @Override
+    protected IssueSeverityLevel getSeverityLevel() {
+        return SupportedIssue.USING_DEPRECATED_PROPERTY.getLevel();
     }
 }