diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml index ef32d53de..c22b26d43 100644 --- a/resources/META-INF/plugin.xml +++ b/resources/META-INF/plugin.xml @@ -501,6 +501,13 @@ enabledByDefault="false" level="WARNING" implementationClass="com.magento.idea.magento2uct.inspections.php.api.PossibleDependencyOnImplDetails"/> + diff --git a/resources/inspectionDescriptions/CalledNonInterfaceMethod.html b/resources/inspectionDescriptions/CalledNonInterfaceMethod.html new file mode 100644 index 000000000..0b8244a80 --- /dev/null +++ b/resources/inspectionDescriptions/CalledNonInterfaceMethod.html @@ -0,0 +1,7 @@ + + +

[1449] Called non-interface method (that is present in implementation).

+ +

The purpose of this inspection is to find places where there is called a method that is not declared in the interface.

+ + diff --git a/resources/uct/bundle/inspection.properties b/resources/uct/bundle/inspection.properties index f9fb116a0..d51e8fdc2 100644 --- a/resources/uct/bundle/inspection.properties +++ b/resources/uct/bundle/inspection.properties @@ -37,6 +37,7 @@ inspection.displayName.ImplementedNonApiInterface=Implemented non Adobe Commerce inspection.displayName.ExtendedNonApiClass=Extended non Adobe Commerce API class inspection.displayName.InheritedNonApiInterface=Inherited non Adobe Commerce API interface inspection.displayName.PossibleDependencyOnImplDetails=Possible dependency on implementation details +inspection.displayName.CalledNonInterfaceMethod=Called non-interface method customCode.warnings.deprecated.1131=[1131] Extended class ''{0}'' that is @deprecated in the ''{1}'' customCode.warnings.deprecated.1132=[1132] Imported class ''{0}'' that is @deprecated in the ''{1}'' customCode.warnings.deprecated.1134=[1134] Used class ''{0}'' that is @deprecated in the ''{1}'' @@ -72,3 +73,4 @@ customCode.errors.api.1328=[1328] Implemented interface ''{0}'' is not marked as customCode.errors.api.1121=[1121] Extended class ''{0}'' is not marked as an API customCode.errors.api.1327=[1327] Inherited interface ''{0}'' is not marked as an API customCode.errors.api.1428=[1428] Possible dependency on implementation details. Consider using the interface ''{0}'' +customCode.errors.api.1449=[1449] Called non-interface method. Consider using only methods declared in ''{0}'' diff --git a/src/com/magento/idea/magento2uct/inspections/php/api/CalledNonInterfaceMethod.java b/src/com/magento/idea/magento2uct/inspections/php/api/CalledNonInterfaceMethod.java new file mode 100644 index 000000000..2667ec9f1 --- /dev/null +++ b/src/com/magento/idea/magento2uct/inspections/php/api/CalledNonInterfaceMethod.java @@ -0,0 +1,89 @@ +/* + * Copyright © Magento, Inc. All rights reserved. + * See COPYING.txt for license details. + */ + +package com.magento.idea.magento2uct.inspections.php.api; + +import com.intellij.codeInspection.ProblemHighlightType; +import com.intellij.codeInspection.ProblemsHolder; +import com.intellij.openapi.project.Project; +import com.jetbrains.php.PhpIndex; +import com.jetbrains.php.actions.PhpExpressionTypeProvider; +import com.jetbrains.php.lang.psi.elements.Method; +import com.jetbrains.php.lang.psi.elements.MethodReference; +import com.jetbrains.php.lang.psi.elements.PhpClass; +import com.magento.idea.magento2plugin.inspections.php.util.PhpClassImplementsInterfaceUtil; +import com.magento.idea.magento2uct.inspections.UctProblemsHolder; +import com.magento.idea.magento2uct.inspections.php.CallMethodInspection; +import com.magento.idea.magento2uct.packages.IssueSeverityLevel; +import com.magento.idea.magento2uct.packages.SupportedIssue; +import java.util.Collection; +import java.util.List; +import java.util.stream.Collectors; +import org.jetbrains.annotations.NotNull; + +public class CalledNonInterfaceMethod extends CallMethodInspection { + + private final PhpExpressionTypeProvider typeProvider = new PhpExpressionTypeProvider(); + + @Override + protected void execute( + final Project project, + final @NotNull ProblemsHolder problemsHolder, + final MethodReference methodReference, + final Method method + ) { + final PhpClass parentClass = method.getContainingClass(); + + if (parentClass == null) { + return; + } + final String informationHint = typeProvider.getInformationHint(methodReference); + + if (informationHint.isEmpty()) { + return; + } + final Collection searchResult = PhpIndex.getInstance(project) + .getInterfacesByFQN(informationHint); + + if (searchResult.isEmpty()) { + return; + } + final PhpClass interfaceCandidate = searchResult.stream().iterator().next(); + + if (interfaceCandidate == null + || !interfaceCandidate.isInterface() + || !PhpClassImplementsInterfaceUtil.execute(interfaceCandidate, parentClass) + ) { + return; + } + final Collection methodList = interfaceCandidate.getMethods(); + final List methodNames = methodList + .stream() + .map(Method::getName) + .collect(Collectors.toList()); + + if (methodNames.contains(method.getName())) { + return; + } + + if (problemsHolder instanceof UctProblemsHolder) { + ((UctProblemsHolder) problemsHolder).setReservedErrorCode( + SupportedIssue.CALLED_NON_INTERFACE_METHOD.getCode() + ); + } + problemsHolder.registerProblem( + methodReference, + SupportedIssue.CALLED_NON_INTERFACE_METHOD.getMessage( + interfaceCandidate.getFQN() + ), + ProblemHighlightType.WARNING + ); + } + + @Override + protected IssueSeverityLevel getSeverityLevel() { + return SupportedIssue.CALLED_NON_INTERFACE_METHOD.getLevel(); + } +} diff --git a/src/com/magento/idea/magento2uct/packages/SupportedIssue.java b/src/com/magento/idea/magento2uct/packages/SupportedIssue.java index b18ca9c7c..e0771622f 100644 --- a/src/com/magento/idea/magento2uct/packages/SupportedIssue.java +++ b/src/com/magento/idea/magento2uct/packages/SupportedIssue.java @@ -10,6 +10,7 @@ import com.magento.idea.magento2uct.bundles.UctInspectionBundle; import com.magento.idea.magento2uct.inspections.UctProblemsHolder; import com.magento.idea.magento2uct.inspections.php.api.CalledNonApiMethod; +import com.magento.idea.magento2uct.inspections.php.api.CalledNonInterfaceMethod; import com.magento.idea.magento2uct.inspections.php.api.ExtendedNonApiClass; import com.magento.idea.magento2uct.inspections.php.api.ImplementedNonApiInterface; import com.magento.idea.magento2uct.inspections.php.api.ImportedNonApiClass; @@ -261,6 +262,12 @@ public enum SupportedIssue { IssueSeverityLevel.ERROR, "customCode.errors.api.1428", PossibleDependencyOnImplDetails.class + ), + CALLED_NON_INTERFACE_METHOD( + 1449, + IssueSeverityLevel.ERROR, + "customCode.errors.api.1449", + CalledNonInterfaceMethod.class ); private final int code; diff --git a/src/com/magento/idea/magento2uct/versioning/indexes/data/DeprecationStateIndex.java b/src/com/magento/idea/magento2uct/versioning/indexes/data/DeprecationStateIndex.java index a9ca57673..b5d2b1c36 100644 --- a/src/com/magento/idea/magento2uct/versioning/indexes/data/DeprecationStateIndex.java +++ b/src/com/magento/idea/magento2uct/versioning/indexes/data/DeprecationStateIndex.java @@ -72,7 +72,7 @@ public synchronized boolean has(final @NotNull String key) { public String getVersion(final @NotNull String fqn) { final String version = changelog.get(fqn); - return version == null ? "some" : version; + return version == null ? "2.3.0 or before" : version; } @Override diff --git a/src/com/magento/idea/magento2uct/versioning/indexes/data/ExistenceStateIndex.java b/src/com/magento/idea/magento2uct/versioning/indexes/data/ExistenceStateIndex.java index b934ab088..25d677a57 100644 --- a/src/com/magento/idea/magento2uct/versioning/indexes/data/ExistenceStateIndex.java +++ b/src/com/magento/idea/magento2uct/versioning/indexes/data/ExistenceStateIndex.java @@ -76,7 +76,7 @@ public synchronized boolean has(final @NotNull String fqn) { public String getVersion(final @NotNull String fqn) { final String version = changelog.get(fqn); - return version == null ? "some" : version; + return version == null ? "2.3.0 or before" : version; } /**