Code refactoring after code review

Author: bohdan-harniuk

src/com/magento/idea/magento2plugin/actions/generation/NewWebApiDeclarationAction.java

@@ -14,14 +14,16 @@
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.MagentoIcons;
 import com.magento.idea.magento2plugin.actions.generation.dialog.NewWebApiDeclarationDialog;
+import com.magento.idea.magento2plugin.magento.packages.MagentoPhpClass;
 import com.magento.idea.magento2plugin.project.Settings;
 import com.magento.idea.magento2plugin.util.php.PhpPsiElementsUtil;
 import org.jetbrains.annotations.NotNull;
 
 public class NewWebApiDeclarationAction extends AnAction {
 
-    public static final String ACTION_NAME = "Create a new WebApi declaration for this method";
-    public static final String ACTION_DESCRIPTION = "Create a new Magento 2 WebApi XML declaration";
+    public static final String ACTION_NAME = "Create a new Web API declaration for this method";
+    public static final String ACTION_DESCRIPTION =
+            "Create a new Magento 2 Web API XML declaration";
     private Method currentPhpMethod;
 
     /**
@@ -48,7 +50,7 @@ public void update(final @NotNull AnActionEvent event) {
         final PhpDocComment classDocComment = method.getContainingClass().getDocComment();
 
         if (!method.getAccess().isPublic()
-                || method.getName().equals("__construct")
+                || method.getName().equals(MagentoPhpClass.CONSTRUCT_METHOD_NAME)
                 || classDocComment == null
                 || !classDocComment.getText().contains("@api")) {
             return;

src/com/magento/idea/magento2plugin/actions/generation/data/xml/WebApiXmlRouteData.java

@@ -17,7 +17,7 @@ public class WebApiXmlRouteData {
     private final String aclResource;
 
     /**
-     * Web Api xml declaration DTO constructor.
+     * Web API XML declaration DTO constructor.
      *
      * @param moduleName String
      * @param url String

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewWebApiDeclarationDialog.java

@@ -17,13 +17,12 @@
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.NotEmptyRule;
 import com.magento.idea.magento2plugin.actions.generation.generator.xml.WebApiDeclarationGenerator;
 import com.magento.idea.magento2plugin.magento.packages.HttpMethod;
+import com.magento.idea.magento2plugin.magento.packages.WebApiResource;
 import com.magento.idea.magento2plugin.ui.FilteredComboBox;
 import com.magento.idea.magento2plugin.util.magento.GetModuleNameByDirectoryUtil;
 import java.awt.event.KeyEvent;
 import java.awt.event.WindowAdapter;
 import java.awt.event.WindowEvent;
-import java.util.Arrays;
-import java.util.LinkedList;
 import javax.swing.JButton;
 import javax.swing.JComboBox;
 import javax.swing.JComponent;
@@ -173,7 +172,7 @@ private void createUIComponents() {
         for (final String method : HttpMethod.getHttpMethodList()) {
             httpMethod.addItem(new ComboBoxItemData(method, method));
         }
-        aclResource = new FilteredComboBox(new LinkedList<>(Arrays.asList("self", "anonymous")));
+        aclResource = new FilteredComboBox(WebApiResource.getDefaultResourcesList());
     }
 
     /**

src/com/magento/idea/magento2plugin/actions/generation/generator/xml/WebApiDeclarationGenerator.java

@@ -65,7 +65,7 @@ public WebApiDeclarationGenerator(
     }
 
     /**
-     * Generate WEB API xml declaration.
+     * Generate Web API XML declaration.
      *
      * @param actionName String
      *

src/com/magento/idea/magento2plugin/inspections/php/PluginInspection.java

@@ -145,7 +145,7 @@ private void checkTargetMethod(
                     final String targetClassMethodName,
                     final Method targetMethod
             ) {
-                if (targetClassMethodName.equals(Plugin.CONSTRUCT_METHOD_NAME)) {
+                if (targetClassMethodName.equals(MagentoPhpClass.CONSTRUCT_METHOD_NAME)) {
                     problemsHolder.registerProblem(
                             pluginMethod.getNameIdentifier(),
                             inspectionBundle.message("inspection.plugin.error.constructMethod"),
@@ -200,10 +200,11 @@ private void checkParametersCompatibility(
                                     pluginMethodParameter,
                                     PhpBundle.message(
                                             WRONG_PARAM_TYPE,
-                                            new Object[]{declaredType, targetClassFqn}
-                                            ),
+                                            declaredType,
+                                            targetClassFqn
+                                    ),
                                     ProblemHighlightType.ERROR
-                                );
+                            );
                         }
                         if (!checkPossibleTypeIncompatibility(targetClassFqn, declaredType)) {
                             problemsHolder.registerProblem(
@@ -219,21 +220,24 @@ private void checkParametersCompatibility(
                     if (index == 2 && pluginPrefix.equals(Plugin.PluginType.around.toString())) {
                         if (!checkTypeIncompatibility(Plugin.CALLABLE_PARAM, declaredType)
                                 && !checkTypeIncompatibility(
-                                    Package.fqnSeparator.concat(Plugin.CLOSURE_PARAM),
-                                    declaredType)
+                                Package.fqnSeparator.concat(Plugin.CLOSURE_PARAM),
+                                declaredType)
                         ) {
                             problemsHolder.registerProblem(
                                     pluginMethodParameter,
                                     PhpBundle.message(
-                                        WRONG_PARAM_TYPE,
-                                        new Object[]{declaredType, "callable"}
+                                            WRONG_PARAM_TYPE,
+                                            declaredType,
+                                            "callable"
                                     ),
                                     ProblemHighlightType.ERROR);
                         }
                         continue;
                     }
                     if (index == 2 && pluginPrefix.equals(Plugin.PluginType.after.toString())
-                            && !targetMethod.getDeclaredType().toString().equals("void")) {
+                            && !MagentoPhpClass.VOID_RETURN_TYPE.equals(
+                                    targetMethod.getDeclaredType().toString()
+                    )) {
                         if (declaredType.isEmpty() || targetMethod.getDeclaredType()
                                 .toString().isEmpty()) {
                             continue;
@@ -244,9 +248,9 @@ private void checkParametersCompatibility(
                                     pluginMethodParameter,
                                     PhpBundle.message(
                                             WRONG_PARAM_TYPE,
-                                                new Object[]{declaredType,
-                                                targetMethod.getDeclaredType().toString()}
-                                                ),
+                                            declaredType,
+                                            targetMethod.getDeclaredType().toString()
+                                    ),
                                     ProblemHighlightType.ERROR
                             );
                         }
@@ -265,7 +269,9 @@ private void checkParametersCompatibility(
                         continue;
                     }
                     if (index == 2 && pluginPrefix.equals(Plugin.PluginType.after.toString())
-                            && targetMethod.getDeclaredType().toString().equals("void")) {
+                            && MagentoPhpClass.VOID_RETURN_TYPE.equals(
+                                    targetMethod.getDeclaredType().toString()
+                    )) {
                         if (declaredType.isEmpty()) {
                             continue;
                         }
@@ -274,8 +280,7 @@ private void checkParametersCompatibility(
                                     pluginMethodParameter,
                                     PhpBundle.message(
                                             WRONG_PARAM_TYPE,
-                                            new Object[]{declaredType, "null"}
-                                            ),
+                                            declaredType, "null"),
                                     ProblemHighlightType.ERROR);
                         }
                         continue;
@@ -306,9 +311,9 @@ private void checkParametersCompatibility(
                                 pluginMethodParameter,
                                 PhpBundle.message(
                                         WRONG_PARAM_TYPE,
-                                        new Object[]{declaredType,
-                                                targetMethodParameterDeclaredType}
-                                            ),
+                                        declaredType,
+                                        targetMethodParameterDeclaredType
+                                ),
                                 ProblemHighlightType.ERROR);
                     }
                     if (!checkPossibleTypeIncompatibility(

src/com/magento/idea/magento2plugin/magento/files/Plugin.java

@@ -24,9 +24,6 @@ public enum PluginType {
         around//NOPMD
     }
 
-    //forbidden target method
-    public static final String CONSTRUCT_METHOD_NAME = "__construct";
-
     //allowed methods access type
     public static final String PUBLIC_ACCESS = "public";
 

src/com/magento/idea/magento2plugin/magento/packages/MagentoPhpClass.java

@@ -6,6 +6,8 @@
 package com.magento.idea.magento2plugin.magento.packages;
 
 public class MagentoPhpClass { //NOPMD
+
+    public static final String CONSTRUCT_METHOD_NAME = "__construct";
     public static final String CLOSING_TAG = "}";
     public static final String VOID_RETURN_TYPE = "void";
     public static final String MIXED_RETURN_TYPE = "mixed";

src/com/magento/idea/magento2plugin/magento/packages/WebApiResource.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.magento.packages;
+
+import java.util.LinkedList;
+import java.util.List;
+import org.jetbrains.annotations.NotNull;
+
+public enum WebApiResource {
+
+    SELF("self"),
+    ANONYMOUS("anonymous");
+
+    private final String resource;
+
+    /**
+     * Web API resource ENUM constructor.
+     *
+     * @param resource String
+     */
+    WebApiResource(final @NotNull String resource) {
+        this.resource = resource;
+    }
+
+    /**
+     * Get Web API resource name.
+     *
+     * @return String
+     */
+    public String getResource() {
+        return resource;
+    }
+
+    /**
+     * Get default Web API resources.
+     *
+     * @return List[String]
+     */
+    public static List<String> getDefaultResourcesList() {
+        final List<String> resources = new LinkedList<>();
+
+        for (final WebApiResource resource : WebApiResource.values()) {
+            resources.add(resource.getResource());
+        }
+
+        return resources;
+    }
+}

src/com/magento/idea/magento2plugin/util/magento/plugin/IsPluginAllowedForMethodUtil.java

@@ -7,6 +7,7 @@
 
 import com.jetbrains.php.lang.psi.elements.Method;
 import com.magento.idea.magento2plugin.magento.files.Plugin;
+import com.magento.idea.magento2plugin.magento.packages.MagentoPhpClass;
 
 public final class IsPluginAllowedForMethodUtil {
 
@@ -20,7 +21,7 @@ private IsPluginAllowedForMethodUtil() {}
      */
     public static boolean check(final Method targetMethod) {
         final String targetMethodName = targetMethod.getName();
-        if (targetMethodName.equals(Plugin.CONSTRUCT_METHOD_NAME)) {
+        if (targetMethodName.equals(MagentoPhpClass.CONSTRUCT_METHOD_NAME)) {
             return false;
         }
         if (targetMethod.isFinal()) {