Skip to content

Commit d76606c

Browse files
andrewbessandrewbess
authored
Merge pull request #763 from bohdan-harniuk/uct-inspection-overridden-non-existent-property
UCT-716: Developed OverriddenNonExistentProperty inspection
2 parents fd6e4e2 + 01c02ef commit d76606c

File tree

6 files changed

+120
-61
lines changed

6 files changed

+120
-61
lines changed

‎resources/META-INF/plugin.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -382,6 +382,13 @@
382382
enabledByDefault="false"
383383
level="ERROR"
384384
implementationClass="com.magento.idea.magento2uct.inspections.php.existence.OverriddenNonExistentConstant"/>
385+
<localInspection language="PHP" groupPath="UCT"
386+
shortName="OverriddenNonExistentProperty"
387+
bundle="uct.bundle.inspection" key="inspection.displayName.OverriddenNonExistentProperty"
388+
groupBundle="uct.bundle.inspection" groupKey="inspection.existence.group.name"
389+
enabledByDefault="false"
390+
level="ERROR"
391+
implementationClass="com.magento.idea.magento2uct.inspections.php.existence.OverriddenNonExistentProperty"/>
385392
<!-- \UCT inspection -->
386393

387394
<internalFileTemplate name="Magento Composer JSON"/>

‎resources/inspectionDescriptions/OverriddenNonExistentProperty.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<html>
2+
<body>
3+
<p>[1515] The overridden property is no longer present in the codebase.</p>
4+
<!-- tooltip end -->
5+
</body>
6+
</html>

‎resources/uct/bundle/inspection.properties

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ inspection.displayName.InheritedNonExistentInterface=Inherited non-existent Adob
1919
inspection.displayName.ImplementedNonExistentInterface=Implemented non-existent Adobe Commerce interface
2020
inspection.displayName.ExtendedNonExistentClass=Extended non-existent Adobe Commerce class
2121
inspection.displayName.OverriddenNonExistentConstant=Overridden non-existent Adobe Commerce constant
22+
inspection.displayName.OverriddenNonExistentProperty=Overridden non-existent Adobe Commerce property
2223
customCode.warnings.deprecated.1131=[1131] Extending from @deprecated class ''{0}''
2324
customCode.warnings.deprecated.1132=[1132] Importing @deprecated class ''{0}''
2425
customCode.warnings.deprecated.1134=[1134] Using @deprecated class ''{0}''
@@ -43,3 +44,5 @@ customCode.critical.existence.1111=[1111] Extended non-existent class ''{0}''
4344
customCode.critical.existence.1111.changelog=[1111] Extended class ''{0}'' that is removed in the ''{1}''
4445
customCode.critical.existence.1215=[1215] Overridden non-existent constant ''{0}''
4546
customCode.critical.existence.1215.changelog=[1215] Overridden constant ''{0}'' that is removed in the ''{1}''
47+
customCode.critical.existence.1515=[1515] Overridden non-existent property ''{0}''
48+
customCode.critical.existence.1515.changelog=[1515] Overridden property ''{0}'' that is removed in the ''{1}''

‎src/com/magento/idea/magento2uct/inspections/php/deprecation/OverridingDeprecatedProperty.java

Lines changed: 34 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -8,80 +8,53 @@
88
import com.intellij.codeInspection.ProblemHighlightType;
99
import com.intellij.codeInspection.ProblemsHolder;
1010
import com.intellij.openapi.project.Project;
11-
import com.intellij.psi.PsiElementVisitor;
12-
import com.jetbrains.php.lang.inspections.PhpInspection;
1311
import com.jetbrains.php.lang.psi.elements.Field;
1412
import com.jetbrains.php.lang.psi.elements.PhpClass;
1513
import com.jetbrains.php.lang.psi.elements.impl.ClassConstImpl;
16-
import com.jetbrains.php.lang.psi.resolve.types.PhpTypeAnalyserVisitor;
1714
import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
15+
import com.magento.idea.magento2uct.inspections.php.OverriddenFieldInspection;
16+
import com.magento.idea.magento2uct.packages.IssueSeverityLevel;
1817
import com.magento.idea.magento2uct.packages.SupportedIssue;
19-
import com.magento.idea.magento2uct.settings.UctSettingsService;
2018
import com.magento.idea.magento2uct.versioning.VersionStateManager;
2119
import org.jetbrains.annotations.NotNull;
2220

23-
public class OverridingDeprecatedProperty extends PhpInspection {
21+
public class OverridingDeprecatedProperty extends OverriddenFieldInspection {
2422

2523
@Override
26-
@SuppressWarnings("PMD.CognitiveComplexity")
27-
public @NotNull PsiElementVisitor buildVisitor(
24+
protected void execute(
25+
final Project project,
2826
final @NotNull ProblemsHolder problemsHolder,
29-
final boolean isOnTheFly
27+
final Field field,
28+
final Field overriddenField,
29+
final PhpClass parentClass
3030
) {
31-
return new PhpTypeAnalyserVisitor() {
32-
33-
@Override
34-
public void visitPhpField(final Field field) {
35-
final Project project = field.getProject();
36-
final UctSettingsService settings = UctSettingsService.getInstance(project);
37-
38-
if (!settings.isEnabled() || !settings.isIssueLevelSatisfiable(
39-
SupportedIssue.OVERRIDING_DEPRECATED_PROPERTY.getLevel())
40-
) {
41-
return;
42-
}
43-
super.visitPhpField(field);
44-
45-
if (field instanceof ClassConstImpl) {
46-
return;
47-
}
48-
final PhpClass phpClass = field.getContainingClass();
31+
if (!VersionStateManager.getInstance(project).isDeprecated(overriddenField.getFQN())) {
32+
return;
33+
}
34+
35+
if (problemsHolder instanceof UctProblemsHolder) {
36+
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
37+
SupportedIssue.OVERRIDING_DEPRECATED_PROPERTY.getCode()
38+
);
39+
}
40+
problemsHolder.registerProblem(
41+
field,
42+
SupportedIssue.OVERRIDING_DEPRECATED_PROPERTY.getMessage(
43+
parentClass.getFQN()
44+
.concat("::")
45+
.concat(overriddenField.getName())
46+
),
47+
ProblemHighlightType.LIKE_DEPRECATED
48+
);
49+
}
4950

50-
if (phpClass == null) {
51-
return;
52-
}
53-
PhpClass parentClass = phpClass.getSuperClass();
54-
boolean isFound = false;
51+
@Override
52+
protected boolean isTypeValid(final Field field) {
53+
return !(field instanceof ClassConstImpl);
54+
}
5555

56-
while (parentClass != null && !isFound) {
57-
for (final Field parentField : parentClass.getOwnFields()) {
58-
if (!(parentField instanceof ClassConstImpl)
59-
&& parentField.getName().equals(field.getName())
60-
&& VersionStateManager
61-
.getInstance(field.getProject())
62-
.isDeprecated(parentField.getFQN())
63-
) {
64-
if (problemsHolder instanceof UctProblemsHolder) {
65-
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
66-
SupportedIssue.OVERRIDING_DEPRECATED_PROPERTY.getCode()
67-
);
68-
}
69-
problemsHolder.registerProblem(
70-
field,
71-
SupportedIssue.OVERRIDING_DEPRECATED_PROPERTY.getMessage(
72-
parentClass.getFQN()
73-
.concat("::")
74-
.concat(parentField.getName())
75-
),
76-
ProblemHighlightType.LIKE_DEPRECATED
77-
);
78-
isFound = true;
79-
break;
80-
}
81-
}
82-
parentClass = parentClass.getSuperClass();
83-
}
84-
}
85-
};
56+
@Override
57+
protected IssueSeverityLevel getSeverityLevel() {
58+
return SupportedIssue.OVERRIDING_DEPRECATED_PROPERTY.getLevel();
8659
}
8760
}

‎src/com/magento/idea/magento2uct/inspections/php/existence/OverriddenNonExistentProperty.java

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
/*
2+
* Copyright © Magento, Inc. All rights reserved.
3+
* See COPYING.txt for license details.
4+
*/
5+
6+
package com.magento.idea.magento2uct.inspections.php.existence;
7+
8+
import com.intellij.codeInspection.ProblemHighlightType;
9+
import com.intellij.codeInspection.ProblemsHolder;
10+
import com.intellij.openapi.project.Project;
11+
import com.jetbrains.php.lang.psi.elements.Field;
12+
import com.jetbrains.php.lang.psi.elements.PhpClass;
13+
import com.jetbrains.php.lang.psi.elements.impl.ClassConstImpl;
14+
import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
15+
import com.magento.idea.magento2uct.inspections.php.OverriddenFieldInspection;
16+
import com.magento.idea.magento2uct.packages.IssueSeverityLevel;
17+
import com.magento.idea.magento2uct.packages.SupportedIssue;
18+
import com.magento.idea.magento2uct.versioning.VersionStateManager;
19+
import org.jetbrains.annotations.NotNull;
20+
21+
public class OverriddenNonExistentProperty extends OverriddenFieldInspection {
22+
23+
@Override
24+
protected void execute(
25+
final Project project,
26+
final @NotNull ProblemsHolder problemsHolder,
27+
final Field property,
28+
final Field overriddenProperty,
29+
final PhpClass parentClass
30+
) {
31+
if (VersionStateManager.getInstance(project).isExists(overriddenProperty.getFQN())) {
32+
return;
33+
}
34+
final String messageArg = parentClass
35+
.getFQN()
36+
.concat("::")
37+
.concat(overriddenProperty.getName());
38+
39+
final String removedIn = VersionStateManager.getInstance(project).getRemovedInVersion();
40+
final String message = removedIn.isEmpty()
41+
? SupportedIssue.OVERRIDDEN_NON_EXISTENT_PROPERTY.getMessage(messageArg)
42+
: SupportedIssue.OVERRIDDEN_NON_EXISTENT_PROPERTY.getChangelogMessage(
43+
messageArg, removedIn);
44+
45+
if (problemsHolder instanceof UctProblemsHolder) {
46+
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
47+
SupportedIssue.OVERRIDDEN_NON_EXISTENT_PROPERTY.getCode()
48+
);
49+
}
50+
problemsHolder.registerProblem(property, message, ProblemHighlightType.ERROR);
51+
}
52+
53+
@Override
54+
protected boolean isTypeValid(final Field field) {
55+
return !(field instanceof ClassConstImpl);
56+
}
57+
58+
@Override
59+
protected IssueSeverityLevel getSeverityLevel() {
60+
return SupportedIssue.OVERRIDDEN_NON_EXISTENT_PROPERTY.getLevel();
61+
}
62+
}

‎src/com/magento/idea/magento2uct/packages/SupportedIssue.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
import com.magento.idea.magento2uct.inspections.php.existence.ImportingNonExistentInterface;
2828
import com.magento.idea.magento2uct.inspections.php.existence.InheritedNonExistentInterface;
2929
import com.magento.idea.magento2uct.inspections.php.existence.OverriddenNonExistentConstant;
30+
import com.magento.idea.magento2uct.inspections.php.existence.OverriddenNonExistentProperty;
3031
import java.lang.reflect.InvocationTargetException;
3132
import java.util.LinkedList;
3233
import java.util.List;
@@ -147,6 +148,13 @@ public enum SupportedIssue {
147148
"customCode.critical.existence.1215",
148149
OverriddenNonExistentConstant.class,
149150
"customCode.critical.existence.1215.changelog"
151+
),
152+
OVERRIDDEN_NON_EXISTENT_PROPERTY(
153+
1515,
154+
IssueSeverityLevel.CRITICAL,
155+
"customCode.critical.existence.1515",
156+
OverriddenNonExistentProperty.class,
157+
"customCode.critical.existence.1515.changelog"
150158
);
151159

152160
private final int code;

0 commit comments

Comments
 (0)