Skip to content

Commit adfdf5a

Browse files
bohdan-harniukbohdan-harniuk
committed
UCT-708: Developed OverriddenNonExistentConstant inspection
1 parent 720331b commit adfdf5a

File tree

5 files changed

+86
-0
lines changed

5 files changed

+86
-0
lines changed

‎resources/META-INF/plugin.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -375,6 +375,13 @@
375375
enabledByDefault="false"
376376
level="ERROR"
377377
implementationClass="com.magento.idea.magento2uct.inspections.php.existence.ExtendedNonExistentClass"/>
378+
<localInspection language="PHP" groupPath="UCT"
379+
shortName="OverriddenNonExistentConstant"
380+
bundle="uct.bundle.inspection" key="inspection.displayName.OverriddenNonExistentConstant"
381+
groupBundle="uct.bundle.inspection" groupKey="inspection.existence.group.name"
382+
enabledByDefault="false"
383+
level="ERROR"
384+
implementationClass="com.magento.idea.magento2uct.inspections.php.existence.OverriddenNonExistentConstant"/>
378385
<!-- \UCT inspection -->
379386

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

‎resources/inspectionDescriptions/OverriddenNonExistentConstant.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>[1215] The overridden constant 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
@@ -18,6 +18,7 @@ inspection.displayName.ImportingNonExistentInterface=Importing non-existent Adob
1818
inspection.displayName.InheritedNonExistentInterface=Inherited non-existent Adobe Commerce interface
1919
inspection.displayName.ImplementedNonExistentInterface=Implemented non-existent Adobe Commerce interface
2020
inspection.displayName.ExtendedNonExistentClass=Extended non-existent Adobe Commerce class
21+
inspection.displayName.OverriddenNonExistentConstant=Overridden non-existent Adobe Commerce constant
2122
customCode.warnings.deprecated.1131=[1131] Extending from @deprecated class ''{0}''
2223
customCode.warnings.deprecated.1132=[1132] Importing @deprecated class ''{0}''
2324
customCode.warnings.deprecated.1134=[1134] Using @deprecated class ''{0}''
@@ -40,3 +41,5 @@ customCode.critical.existence.1318=[1318] Implemented non-existent interface ''{
4041
customCode.critical.existence.1318.changelog=[1318] Implemented interface ''{0}'' that is removed in the ''{1}''
4142
customCode.critical.existence.1111=[1111] Extended non-existent class ''{0}''
4243
customCode.critical.existence.1111.changelog=[1111] Extended class ''{0}'' that is removed in the ''{1}''
44+
customCode.critical.existence.1215=[1215] Overridden non-existent constant ''{0}''
45+
customCode.critical.existence.1215.changelog=[1215] Overridden constant ''{0}'' that is removed in the ''{1}''

‎src/com/magento/idea/magento2uct/inspections/php/existence/OverriddenNonExistentConstant.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 OverriddenNonExistentConstant extends OverriddenFieldInspection {
22+
23+
@Override
24+
protected void execute(
25+
final Project project,
26+
final @NotNull ProblemsHolder problemsHolder,
27+
final Field field,
28+
final Field overriddenField,
29+
final PhpClass parentClass
30+
) {
31+
if (VersionStateManager.getInstance(project).isExists(overriddenField.getFQN())) {
32+
return;
33+
}
34+
final String messageArg = parentClass
35+
.getFQN()
36+
.concat("::")
37+
.concat(overriddenField.getName());
38+
39+
final String removedIn = VersionStateManager.getInstance(project).getRemovedInVersion();
40+
final String message = removedIn.isEmpty()
41+
? SupportedIssue.OVERRIDDEN_NON_EXISTENT_CONSTANT.getMessage(messageArg)
42+
: SupportedIssue.OVERRIDDEN_NON_EXISTENT_CONSTANT.getChangelogMessage(
43+
messageArg, removedIn);
44+
45+
if (problemsHolder instanceof UctProblemsHolder) {
46+
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
47+
SupportedIssue.OVERRIDDEN_NON_EXISTENT_CONSTANT.getCode()
48+
);
49+
}
50+
problemsHolder.registerProblem(field, 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_CONSTANT.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
@@ -26,6 +26,7 @@
2626
import com.magento.idea.magento2uct.inspections.php.existence.ImportingNonExistentClass;
2727
import com.magento.idea.magento2uct.inspections.php.existence.ImportingNonExistentInterface;
2828
import com.magento.idea.magento2uct.inspections.php.existence.InheritedNonExistentInterface;
29+
import com.magento.idea.magento2uct.inspections.php.existence.OverriddenNonExistentConstant;
2930
import java.lang.reflect.InvocationTargetException;
3031
import java.util.LinkedList;
3132
import java.util.List;
@@ -139,6 +140,13 @@ public enum SupportedIssue {
139140
"customCode.critical.existence.1111",
140141
ExtendedNonExistentClass.class,
141142
"customCode.critical.existence.1111.changelog"
143+
),
144+
OVERRIDDEN_NON_EXISTENT_CONSTANT(
145+
1215,
146+
IssueSeverityLevel.CRITICAL,
147+
"customCode.critical.existence.1215",
148+
OverriddenNonExistentConstant.class,
149+
"customCode.critical.existence.1215.changelog"
142150
);
143151

144152
private final int code;

0 commit comments

Comments
 (0)