Skip to content

Commit 1a7f3ec

Browse files
bohdan-harniukbohdan-harniuk
committed
UCT-720-724: Added extended and implemented non api inspections
1 parent 87be924 commit 1a7f3ec

File tree

7 files changed

+145
-0
lines changed

7 files changed

+145
-0
lines changed

‎resources/META-INF/plugin.xml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -473,6 +473,20 @@
473473
enabledByDefault="false"
474474
level="WARNING"
475475
implementationClass="com.magento.idea.magento2uct.inspections.php.api.UsedNonApiType"/>
476+
<localInspection language="PHP" groupPath="UCT"
477+
shortName="ImplementedNonApiInterface"
478+
bundle="uct.bundle.inspection" key="inspection.displayName.ImplementedNonApiInterface"
479+
groupBundle="uct.bundle.inspection" groupKey="inspection.api.group.name"
480+
enabledByDefault="false"
481+
level="WARNING"
482+
implementationClass="com.magento.idea.magento2uct.inspections.php.api.ImplementedNonApiInterface"/>
483+
<localInspection language="PHP" groupPath="UCT"
484+
shortName="ExtendedNonApiClass"
485+
bundle="uct.bundle.inspection" key="inspection.displayName.ExtendedNonApiClass"
486+
groupBundle="uct.bundle.inspection" groupKey="inspection.api.group.name"
487+
enabledByDefault="false"
488+
level="WARNING"
489+
implementationClass="com.magento.idea.magento2uct.inspections.php.api.ExtendedNonApiClass"/>
476490
<!-- \UCT inspection -->
477491

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

‎resources/inspectionDescriptions/ExtendedNonApiClass.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>[1121] The extended class is not marked as an API.</p>
4+
<!-- tooltip end -->
5+
</body>
6+
</html>

‎resources/inspectionDescriptions/ImplementedNonApiInterface.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>[1328] The implemented interface is not marked as an API.</p>
4+
<!-- tooltip end -->
5+
</body>
6+
</html>

‎resources/uct/bundle/inspection.properties

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ inspection.displayName.OverriddenNonApiProperty=Overridden non Adobe Commerce AP
3333
inspection.displayName.UsedNonApiConstant=Used non Adobe Commerce API constant
3434
inspection.displayName.UsedNonApiProperty=Used non Adobe Commerce API property
3535
inspection.displayName.UsedNonApiType=Used non Adobe Commerce API type
36+
inspection.displayName.ImplementedNonApiInterface=Implemented non Adobe Commerce API interface
37+
inspection.displayName.ExtendedNonApiClass=Extended non Adobe Commerce API class
3638
customCode.warnings.deprecated.1131=[1131] Extended class ''{0}'' that is @deprecated in the ''{1}''
3739
customCode.warnings.deprecated.1132=[1132] Imported class ''{0}'' that is @deprecated in the ''{1}''
3840
customCode.warnings.deprecated.1134=[1134] Used class ''{0}'' that is @deprecated in the ''{1}''
@@ -64,3 +66,5 @@ customCode.errors.api.1525=[1525] Overridden property ''{0}'' is not marked as a
6466
customCode.errors.api.1224=[1224] Used constant ''{0}'' is not marked as an API
6567
customCode.errors.api.1524=[1524] Used property ''{0}'' is not marked as an API
6668
customCode.errors.api.1124=[1124] Used type ''{0}'' is not marked as an API
69+
customCode.errors.api.1328=[1328] Implemented interface ''{0}'' is not marked as an API
70+
customCode.errors.api.1121=[1121] Extended class ''{0}'' is not marked as an API

‎src/com/magento/idea/magento2uct/inspections/php/api/ExtendedNonApiClass.java

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
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.api;
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.ClassReference;
12+
import com.jetbrains.php.lang.psi.elements.ExtendsList;
13+
import com.jetbrains.php.lang.psi.elements.PhpClass;
14+
import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
15+
import com.magento.idea.magento2uct.inspections.php.ExtendInspection;
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 ExtendedNonApiClass extends ExtendInspection {
22+
23+
@Override
24+
protected void execute(
25+
final Project project,
26+
final @NotNull ProblemsHolder problemsHolder,
27+
final PhpClass parentClass,
28+
final ExtendsList childExtends
29+
) {
30+
if (VersionStateManager.getInstance(project).isApi(parentClass.getFQN())) {
31+
return;
32+
}
33+
final String message = SupportedIssue.EXTENDED_NON_API_CLASS.getMessage(
34+
parentClass.getFQN()
35+
);
36+
37+
if (problemsHolder instanceof UctProblemsHolder) {
38+
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
39+
SupportedIssue.EXTENDED_NON_API_CLASS.getCode()
40+
);
41+
}
42+
43+
for (final ClassReference reference : childExtends.getReferenceElements()) {
44+
if (parentClass.getFQN().equals(reference.getFQN())) {
45+
problemsHolder.registerProblem(reference, message, ProblemHighlightType.WARNING);
46+
}
47+
}
48+
}
49+
50+
@Override
51+
protected IssueSeverityLevel getSeverityLevel() {
52+
return SupportedIssue.EXTENDED_NON_API_CLASS.getLevel();
53+
}
54+
}

‎src/com/magento/idea/magento2uct/inspections/php/api/ImplementedNonApiInterface.java

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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.api;
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.ClassReference;
12+
import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
13+
import com.magento.idea.magento2uct.inspections.php.ImplementInspection;
14+
import com.magento.idea.magento2uct.packages.IssueSeverityLevel;
15+
import com.magento.idea.magento2uct.packages.SupportedIssue;
16+
import com.magento.idea.magento2uct.versioning.VersionStateManager;
17+
import org.jetbrains.annotations.NotNull;
18+
19+
public class ImplementedNonApiInterface extends ImplementInspection {
20+
21+
@Override
22+
protected void execute(
23+
final Project project,
24+
final @NotNull ProblemsHolder problemsHolder,
25+
final ClassReference reference,
26+
final String interfaceFqn
27+
) {
28+
if (VersionStateManager.getInstance(project).isApi(interfaceFqn)) {
29+
return;
30+
}
31+
final String message = SupportedIssue.IMPLEMENTED_NON_API_INTERFACE.getMessage(
32+
interfaceFqn
33+
);
34+
35+
if (problemsHolder instanceof UctProblemsHolder) {
36+
((UctProblemsHolder) problemsHolder).setReservedErrorCode(
37+
SupportedIssue.IMPLEMENTED_NON_API_INTERFACE.getCode()
38+
);
39+
}
40+
problemsHolder.registerProblem(reference, message, ProblemHighlightType.WARNING);
41+
}
42+
43+
@Override
44+
protected IssueSeverityLevel getSeverityLevel() {
45+
return SupportedIssue.IMPLEMENTED_NON_API_INTERFACE.getLevel();
46+
}
47+
}

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010
import com.magento.idea.magento2uct.bundles.UctInspectionBundle;
1111
import com.magento.idea.magento2uct.inspections.UctProblemsHolder;
1212
import com.magento.idea.magento2uct.inspections.php.api.CalledNonApiMethod;
13+
import com.magento.idea.magento2uct.inspections.php.api.ExtendedNonApiClass;
14+
import com.magento.idea.magento2uct.inspections.php.api.ImplementedNonApiInterface;
1315
import com.magento.idea.magento2uct.inspections.php.api.ImportedNonApiClass;
1416
import com.magento.idea.magento2uct.inspections.php.api.ImportedNonApiInterface;
1517
import com.magento.idea.magento2uct.inspections.php.api.OverriddenNonApiConstant;
@@ -233,6 +235,18 @@ public enum SupportedIssue {
233235
IssueSeverityLevel.ERROR,
234236
"customCode.errors.api.1124",
235237
UsedNonApiType.class
238+
),
239+
IMPLEMENTED_NON_API_INTERFACE(
240+
1328,
241+
IssueSeverityLevel.ERROR,
242+
"customCode.errors.api.1328",
243+
ImplementedNonApiInterface.class
244+
),
245+
EXTENDED_NON_API_CLASS(
246+
1121,
247+
IssueSeverityLevel.ERROR,
248+
"customCode.errors.api.1121",
249+
ExtendedNonApiClass.class
236250
);
237251

238252
private final int code;

0 commit comments

Comments
 (0)