Merge branch '4.0.0-develop' into only-viisible-fields-validation

Author: ProkopovVitaliy

CHANGELOG.md

@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).
 
 ## 4.0.0
 
+## 3.2.1
+
+### Fixed
+
+- Directory validator
+- Entity data mapper file template
+
 ## 3.2.0
 
 ### Added

build.gradle

@@ -4,7 +4,7 @@
  */
 
 plugins {
-    id 'org.jetbrains.intellij' version '0.6.5'
+    id 'org.jetbrains.intellij' version '0.7.2'
     id 'checkstyle'
     id 'pmd'
     id 'org.jetbrains.changelog' version '0.6.2'

gradle-tasks/checkstyle/checkstyle.xml

@@ -330,4 +330,8 @@
         </module>
     </module>
     <module name="SuppressWarningsFilter"/>
+    <module name="RegexpHeader">
+        <property name="header" value="^\/\*\n \* Copyright © Magento, Inc."/>
+        <property name="fileExtensions" value="java"/>
+    </module>
 </module>

resources/META-INF/plugin.xml

@@ -96,6 +96,9 @@
         <action id="OverrideInTheme.Menu" class="com.magento.idea.magento2plugin.actions.generation.OverrideInThemeAction">
             <add-to-group group-id="ProjectViewPopupMenu"/>
         </action>
+        <action id="MagentoCreateAWebApiDeclaration.Menu" class="com.magento.idea.magento2plugin.actions.generation.NewWebApiDeclarationAction">
+            <add-to-group group-id="EditorPopupMenu"/>
+        </action>
 
         <action id="CopyMagentoPath"
                 class="com.magento.idea.magento2plugin.actions.CopyMagentoPath"

resources/fileTemplates/code/Magento Web Api Declaration.xml.ft

@@ -0,0 +1,6 @@
+<route url="/V1/${ROUTE}" method="${METHOD}">
+    <service class="${SERVICE}" method="${SERVICE_METHOD}"/>
+    <resources>
+        <resource ref="${RESOURCE}"/>
+    </resources>
+</route>

resources/fileTemplates/code/Magento Web Api Declaration.xml.html

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<routes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Webapi:etc/webapi.xsd">
+</routes>

resources/fileTemplates/internal/Magento Web Api XML.xml.ft

@@ -11,6 +11,7 @@ validator.onlyNumbers=The {0} field must contain numbers only
 validator.mustNotBeNegative={0} must not be negative
 validator.identifier=The {0} field must contain letters, numbers, dashes, and underscores only
 validator.identifier.colon=The {0} field must contain letters, numbers, colons, dashes, and underscores only
+validator.identifier.forwardSlash=The {0} field must contain letters, numbers, dashes, forward slashes and underscores only
 validator.class.isNotValid=The {0} field does not contain a valid class name
 validator.fqn.isNotValid=The {0} field does not contain a valid fully qualified class name
 validator.class.shouldBeUnique=Duplicated class {0}

resources/fileTemplates/internal/Magento Web Api XML.xml.html

@@ -0,0 +1,92 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.actions.generation;
+
+import com.intellij.openapi.actionSystem.AnAction;
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import com.intellij.openapi.project.Project;
+import com.intellij.psi.PsiDirectory;
+import com.jetbrains.php.lang.psi.elements.Method;
+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 Web API declaration for this method";
+    public static final String ACTION_DESCRIPTION =
+            "Create a new Magento 2 Web API XML declaration";
+    private Method currentPhpMethod;
+
+    /**
+     * New WebApi declaration action constructor.
+     */
+    public NewWebApiDeclarationAction() {
+        super(ACTION_NAME, ACTION_DESCRIPTION, MagentoIcons.MODULE);
+    }
+
+    @Override
+    public void update(final @NotNull AnActionEvent event) {
+        setIsAvailableForEvent(event, false);
+        final Project project = event.getProject();
+        final Method method = PhpPsiElementsUtil.getPhpMethod(event);
+
+        if (project == null || !Settings.isEnabled(project) || method == null) {
+            return;
+        }
+
+        if (method.getContainingClass() == null) {
+            return;
+        }
+
+        if (!method.getAccess().isPublic()
+                || method.getName().equals(MagentoPhpClass.CONSTRUCT_METHOD_NAME)) {
+            return;
+        }
+
+        currentPhpMethod = method;
+        setIsAvailableForEvent(event, true);
+    }
+
+    @Override
+    public void actionPerformed(final @NotNull AnActionEvent event) {
+        final PsiDirectory directory =
+                currentPhpMethod.getContainingFile().getContainingDirectory();
+
+        if (event.getProject() == null || directory == null) {
+            return;
+        }
+
+        final PhpClass phpClass = currentPhpMethod.getContainingClass();
+
+        if (phpClass == null) {
+            return;
+        }
+
+        final String classFqn = phpClass.getPresentableFQN();
+        final String methodName = currentPhpMethod.getName();
+
+        NewWebApiDeclarationDialog.open(event.getProject(), directory, classFqn, methodName);
+    }
+
+    /**
+     * Set is action available for event.
+     *
+     * @param event AnActionEvent
+     * @param isAvailable boolean
+     */
+    private void setIsAvailableForEvent(
+            final @NotNull AnActionEvent event,
+            final boolean isAvailable
+    ) {
+        event.getPresentation().setVisible(isAvailable);
+        event.getPresentation().setEnabled(isAvailable);
+    }
+}