Code refactoring after merging

Author: bohdan-harniuk

resources/META-INF/plugin.xml

@@ -207,8 +207,8 @@
 
         <localInspection language="XML" groupPath="XML"
                          shortName="WebApiServiceInspection"
-                         displayName="Inspection for the Web API XML service declaration"
-                         groupName="Magento 2"
+                         bundle="magento2.inspection" key="inspection.displayName.WebApiServiceInspection"
+                         groupBundle="magento2.inspection" groupKey="inspection.group.name"
                          enabledByDefault="true" level="WARNING"
                          implementationClass="com.magento.idea.magento2plugin.inspections.xml.WebApiServiceInspection"/>
 

resources/magento2/inspection.properties

@@ -6,6 +6,7 @@ inspection.displayName.PluginDeclarationInspection=Duplicated Plugin Usage in di
 inspection.displayName.CacheableFalseInDefaultLayoutInspection=Inspection for disabled cache site-wide
 inspection.displayName.ModuleDeclarationInModuleXmlInspection=Inspection for the Module declaration in the `etc/module.xml` file
 inspection.displayName.AclResourceXmlInspection=Inspection for the Title XML required attribute in the `etc/acl.xml` file
+inspection.displayName.WebApiServiceInspection=Inspection for the Web API XML service declaration
 inspection.displayName.InvalidDiTypeInspection=Invalid type configuration in the `etc/di.xml` file
 inspection.plugin.duplicateInSameFile=The plugin name already used in this file. For more details see Inspection Description.
 inspection.plugin.duplicateInOtherPlaces=The plugin name "{0}" for targeted "{1}" class is already used in the module "{2}" ({3} scope). For more details see Inspection Description.

src/com/magento/idea/magento2plugin/inspections/xml/WebApiServiceInspection.java

@@ -17,6 +17,9 @@
 import com.jetbrains.php.lang.psi.elements.Method;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.bundles.InspectionBundle;
+import com.magento.idea.magento2plugin.inspections.validator.InspectionValidator;
+import com.magento.idea.magento2plugin.inspections.validator.NotEmptyValidator;
+import com.magento.idea.magento2plugin.inspections.validator.PhpClassExistenceValidator;
 import com.magento.idea.magento2plugin.inspections.xml.fix.MethodNotPublicAccessQuickFix;
 import com.magento.idea.magento2plugin.magento.files.ModuleWebApiXmlFile;
 import java.util.Collection;
@@ -33,7 +36,12 @@ public PsiElementVisitor buildVisitor(
             final boolean isOnTheFly
     ) {
         return new XmlElementVisitor() {
+
             private final InspectionBundle inspectionBundle = new InspectionBundle();
+            // Inspection validators
+            private final InspectionValidator notEmptyValidator = new NotEmptyValidator();
+            private final InspectionValidator phpClassExistenceValidator =
+                    new PhpClassExistenceValidator(problemsHolder.getProject());
 
             @Override
             public void visitXmlTag(final XmlTag xmlTag) {
@@ -55,7 +63,8 @@ public void visitXmlTag(final XmlTag xmlTag) {
                     return;
                 }
                 final String classFqn = classAttribute.getValue();
-                if (classFqn == null || classFqn.isEmpty()) {
+
+                if (!notEmptyValidator.validate(classFqn)) {
                     problemsHolder.registerProblem(
                             classAttribute,
                             inspectionBundle.message(
@@ -68,14 +77,7 @@ public void visitXmlTag(final XmlTag xmlTag) {
                     return;
                 }
 
-                //Check whether the class exists
-                final PhpIndex phpIndex = PhpIndex.getInstance(
-                        problemsHolder.getProject()
-                );
-                @NotNull final Collection<PhpClass> classes = phpIndex.getClassesByFQN(classFqn);
-                @NotNull final Collection<PhpClass> interfaces = phpIndex
-                        .getInterfacesByFQN(classFqn);
-                if (classes.isEmpty() && interfaces.isEmpty()) {
+                if (!phpClassExistenceValidator.validate(classFqn)) {
                         problemsHolder.registerProblem(
                                 classAttribute,
                                 inspectionBundle.message(
@@ -95,7 +97,8 @@ public void visitXmlTag(final XmlTag xmlTag) {
                     return;
                 }
                 final String methodName = methodAttribute.getValue();
-                if (methodName == null || methodName.isEmpty()) {
+
+                if (!notEmptyValidator.validate(methodName)) {
                     problemsHolder.registerProblem(
                             classAttribute,
                             inspectionBundle.message(
@@ -109,10 +112,16 @@ public void visitXmlTag(final XmlTag xmlTag) {
                 }
 
                 //Check whether method exists
+                final PhpIndex phpIndex = PhpIndex.getInstance(problemsHolder.getProject());
+                final @NotNull Collection<PhpClass> classes = phpIndex.getClassesByFQN(classFqn);
+                final @NotNull Collection<PhpClass> interfaces = phpIndex
+                        .getInterfacesByFQN(classFqn);
+
                 Method targetMethod = findTargetMethod(classes, methodName);
                 if (targetMethod == null) {
                     targetMethod = findTargetMethod(interfaces, methodName);
                 }
+
                 if (targetMethod == null && methodAttribute.getValueElement() != null) {
                     problemsHolder.registerProblem(
                             methodAttribute.getValueElement(),
@@ -127,7 +136,9 @@ public void visitXmlTag(final XmlTag xmlTag) {
                 }
 
                 //API method should have public access
-                if (targetMethod.getAccess() != null && !targetMethod.getAccess().isPublic()) {
+                if (targetMethod != null
+                        && targetMethod.getAccess() != null
+                        && !targetMethod.getAccess().isPublic()) {
                     problemsHolder.registerProblem(
                             methodAttribute,
                             inspectionBundle.message(
@@ -140,8 +151,7 @@ public void visitXmlTag(final XmlTag xmlTag) {
                 }
             }
 
-            @Nullable
-            private Method findTargetMethod(
+            private @Nullable Method findTargetMethod(
                     final Collection<PhpClass> classes,
                     final String methodName
             ) {