Merge branch '4.3.0-develop' of github.com:magento/magento2-phpstorm-plugin into 409-add-argument-replacement-action

bohdan-harniuk · bohdan-harniuk · commit f8901e25c93d · 2022-03-09T11:16:32.000+02:00
diff --git a/src/com/magento/idea/magento2plugin/actions/CopyMagentoPath.java b/src/com/magento/idea/magento2plugin/actions/CopyMagentoPath.java
@@ -15,8 +15,10 @@
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiManager;
 import com.magento.idea.magento2plugin.util.magento.GetModuleNameByDirectoryUtil;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import javax.imageio.ImageIO;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -27,6 +29,8 @@ public class CopyMagentoPath extends CopyPathProvider {
     public static final String CSS_EXTENSION = "css";
     private final List<String> acceptedTypes
             = Arrays.asList(PHTML_EXTENSION, JS_EXTENSION, CSS_EXTENSION);
+    private static final List<String> SUPPORTED_IMAGE_EXTENSIONS
+            = new ArrayList<>(Arrays.asList(ImageIO.getReaderFormatNames()));
     public static final String SEPARATOR = "::";
     private int index;
 
@@ -44,6 +48,15 @@ public class CopyMagentoPath extends CopyPathProvider {
         "web/"
     };
 
+    /**
+     * Copy Magento Path actions for phtml, css, js, images extensions.
+     */
+    public CopyMagentoPath() {
+        super();
+
+        SUPPORTED_IMAGE_EXTENSIONS.add("svg");
+    }
+
     @Override
     public void update(@NotNull final AnActionEvent event) {
         final VirtualFile virtualFile = event.getData(PlatformDataKeys.VIRTUAL_FILE);
@@ -54,7 +67,8 @@ public void update(@NotNull final AnActionEvent event) {
 
     private boolean isNotValidFile(final VirtualFile virtualFile) {
         return virtualFile != null && virtualFile.isDirectory()
-                || virtualFile != null && !acceptedTypes.contains(virtualFile.getExtension());
+                || virtualFile != null && !acceptedTypes.contains(virtualFile.getExtension())
+                && !SUPPORTED_IMAGE_EXTENSIONS.contains(virtualFile.getExtension());
     }
 
     @Override
@@ -85,24 +99,23 @@ private boolean isNotValidFile(final VirtualFile virtualFile) {
         if (PHTML_EXTENSION.equals(virtualFile.getExtension())) {
             paths = templatePaths;
         } else if (JS_EXTENSION.equals(virtualFile.getExtension())
-                || CSS_EXTENSION.equals(virtualFile.getExtension())) {
+                || CSS_EXTENSION.equals(virtualFile.getExtension())
+                || SUPPORTED_IMAGE_EXTENSIONS.contains(virtualFile.getExtension())) {
             paths = webPaths;
         } else {
             return fullPath.toString();
         }
-        int endIndex;
 
         try {
-            endIndex = getIndexOf(paths, fullPath, paths[++index]);
-        } catch (ArrayIndexOutOfBoundsException exception) {
-            // endIndex could not be found.
-            return "";
-        }
-        final int offset = paths[index].length();
+            final int endIndex = getIndexOf(paths, fullPath, paths[++index]);
+            final int offset = paths[index].length();
 
-        fullPath.replace(0, endIndex + offset, "");
+            fullPath.replace(0, endIndex + offset, "");
 
-        return moduleName + SEPARATOR + fullPath;
+            return moduleName + SEPARATOR + fullPath;
+        } catch (ArrayIndexOutOfBoundsException exception) {
+            return fullPath.toString();
+        }
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/NewModuleAction.java b/src/com/magento/idea/magento2plugin/actions/generation/NewModuleAction.java
@@ -19,6 +19,7 @@
 import com.magento.idea.magento2plugin.actions.generation.util.IsClickedDirectoryInsideProject;
 import com.magento.idea.magento2plugin.project.Settings;
 import com.magento.idea.magento2plugin.util.magento.GetModuleNameByDirectoryUtil;
+import com.magento.idea.magento2plugin.util.magento.MagentoBasePathUtil;
 import org.jetbrains.annotations.NotNull;
 
 public class NewModuleAction extends com.intellij.openapi.actionSystem.AnAction {
@@ -89,6 +90,16 @@ public void update(final AnActionEvent event) {
             final String moduleName = GetModuleNameByDirectoryUtil
                     .execute((PsiDirectory) psiElement, project);
             if (moduleName == null) {
+                final String sourceDirPath = ((PsiDirectory) psiElement).getVirtualFile().getPath();
+                final boolean isCustomCodeSourceDirValid =
+                        MagentoBasePathUtil.isCustomCodeSourceDirValid(sourceDirPath);
+                final boolean isCustomVendorDirValid =
+                        MagentoBasePathUtil.isCustomVendorDirValid(sourceDirPath);
+
+                if (!isCustomCodeSourceDirValid && !isCustomVendorDirValid) { //NOPMD
+                    event.getPresentation().setVisible(false);
+                    return;
+                }
                 event.getPresentation().setVisible(true);
                 return;
             }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewModuleDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewModuleDialog.java
@@ -6,6 +6,7 @@
 package com.magento.idea.magento2plugin.actions.generation.dialog;//NOPMD
 
 import com.intellij.openapi.project.Project;
+import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiDirectory;
 import com.intellij.psi.PsiFile;
 import com.magento.idea.magento2plugin.actions.generation.NewModuleAction;
@@ -23,9 +24,9 @@
 import com.magento.idea.magento2plugin.indexes.ModuleIndex;
 import com.magento.idea.magento2plugin.magento.files.ComposerJson;
 import com.magento.idea.magento2plugin.magento.packages.Licenses;
-import com.magento.idea.magento2plugin.magento.packages.Package;
 import com.magento.idea.magento2plugin.project.Settings;
 import com.magento.idea.magento2plugin.util.CamelCaseToHyphen;
+import com.magento.idea.magento2plugin.util.magento.MagentoBasePathUtil;
 import com.magento.idea.magento2plugin.util.magento.MagentoVersionUtil;
 import java.awt.event.ActionEvent;
 import java.awt.event.KeyEvent;
@@ -163,8 +164,9 @@ public void windowClosing(final WindowEvent event) {
     }
 
     private void detectPackageName(final @NotNull PsiDirectory initialBaseDir) {
-        final PsiDirectory parentDir = initialBaseDir.getParent();
-        if (parentDir != null && parentDir.toString().endsWith(Package.packagesRoot)) {
+        final VirtualFile initialBaseDirVf = initialBaseDir.getVirtualFile();
+
+        if (MagentoBasePathUtil.isCustomVendorDirValid(initialBaseDirVf.getPath())) {
             packageName.setVisible(false);
             packageNameLabel.setVisible(false);
             this.detectedPackageName = initialBaseDir.getName();
diff --git a/src/com/magento/idea/magento2plugin/magento/packages/Package.java b/src/com/magento/idea/magento2plugin/magento/packages/Package.java
@@ -6,6 +6,7 @@
 package com.magento.idea.magento2plugin.magento.packages;
 
 public class Package { //NOPMD
+    public static final String V_FILE_SEPARATOR = "/";
     public static String packagesRoot = "app/code";
     public static String libWebRoot = "lib/web";
     public static String frameworkRootComposer = "vendor/magento/framework";
diff --git a/src/com/magento/idea/magento2plugin/magento/packages/UiFormButtonTypeSettings.java b/src/com/magento/idea/magento2plugin/magento/packages/UiFormButtonTypeSettings.java
@@ -14,15 +14,28 @@ public enum UiFormButtonTypeSettings {
     SAVE("Save", "save primary", "''", "[\n"
             + "                'mage-init' => ['button' => ['event' => 'save']],\n"
             + "                'form-role' => 'save'\n"
-            + "            ]", 10, "Save entity button."),
-    DELETE("Delete", "delete", "'deleteConfirm(\\''\n"
-            + "            . __('Are you sure you want to delete this $varName?')\n"
-            + "            . '\\', \\'' . $this->getUrl(\n'*/*/delete',\n[$varIdConst => "
-            + "$this->$varEntityIdAccessor]\n) . '\\')'", "[]", 20, "Delete entity button."),
+            + "            ]", 30, "Save entity button."),
+    DELETE(
+            "Delete",
+            "delete",
+            "sprintf(\"deleteConfirm('%s', '%s')\", \n"
+                    + "__('Are you sure you want to delete this $varName?'),\n"
+                    + "$this->getUrl(\n'*/*/delete',\n[$varIdConst => "
+                    + "$this->$varEntityIdAccessor]\n)\n)",
+            "[]",
+            20,
+            "Delete entity button."),
     BACK("Back To Grid", "back",
             "sprintf(\"location.href = '%s';\", $this->getUrl('*/*/'))",
-            "[]", 30, "Back to list button."),
-    CUSTOM("Custom Button", "custom", "''", "[]", 0, "Custom button.");
+            "[]", 10, "Back to list button."),
+    CUSTOM(
+            "Custom Button",
+            "custom",
+            "''",
+            "[]",
+            0,
+            "Custom button."
+    );
 
     private final String label;
     private final String classes;
diff --git a/src/com/magento/idea/magento2plugin/util/magento/GetModuleNameByDirectoryUtil.java b/src/com/magento/idea/magento2plugin/util/magento/GetModuleNameByDirectoryUtil.java
@@ -44,7 +44,11 @@ private GetModuleNameByDirectoryUtil() {}
             final String moduleNamePath =  matcher.group(0);
 
             if (!moduleNamePath.isEmpty()) {
-                return moduleNamePath.split("/")[5];
+                final String[] moduleNamePathParts = moduleNamePath.split("/");
+
+                if (moduleNamePathParts.length >= 6) { //NOPMD
+                    return moduleNamePath.split("/")[5];
+                }
             }
         }
 
diff --git a/src/com/magento/idea/magento2plugin/util/magento/MagentoBasePathUtil.java b/src/com/magento/idea/magento2plugin/util/magento/MagentoBasePathUtil.java
@@ -9,8 +9,10 @@
 import com.intellij.openapi.vfs.LocalFileSystem;
 import com.intellij.openapi.vfs.VfsUtil;
 import com.intellij.openapi.vfs.VirtualFile;
-import com.magento.idea.magento2plugin.magento.packages.File;
 import com.magento.idea.magento2plugin.magento.packages.Package;
+import java.io.File;
+import java.util.Arrays;
+import org.jetbrains.annotations.NotNull;
 
 public final class MagentoBasePathUtil {
 
@@ -38,4 +40,54 @@ public static boolean isMagentoFolderValid(final String path) {
         }
         return false;
     }
+
+    /**
+     * Check if specified path belongs to the correct vendor name.
+     *
+     * @param path String
+     *
+     * @return boolean
+     */
+    public static boolean isCustomVendorDirValid(final @NotNull String path) {
+        final String[] pathParts = path.split(Package.V_FILE_SEPARATOR);
+
+        if (pathParts.length < 3) { //NOPMD
+            return false;
+        }
+
+        final String[] sourceCandidateParts = Arrays.copyOfRange(
+                pathParts,
+                pathParts.length - 3,
+                pathParts.length - 1
+        );
+
+        return Package.packagesRoot.equals(
+                String.join(Package.V_FILE_SEPARATOR, sourceCandidateParts)
+        );
+    }
+
+    /**
+     * Check if specified path belongs to the correct packages folder.
+     *
+     * @param path String
+     *
+     * @return boolean
+     */
+    public static boolean isCustomCodeSourceDirValid(final @NotNull String path) {
+        final String[] pathParts = path.split(Package.V_FILE_SEPARATOR);
+
+        if (pathParts.length < 2) { //NOPMD
+            return false;
+        }
+
+        final String[] sourceCandidateParts = Arrays.copyOfRange(
+                pathParts,
+                pathParts.length - 2,
+                pathParts.length
+        );
+
+        return Package.packagesRoot.equals(
+                String.join(Package.V_FILE_SEPARATOR, sourceCandidateParts)
+        );
+    }
 }
diff --git a/testData/actions/generation/generator/FormButtonBlockGenerator/generateBackButtonBlock/MyBackButton.php b/testData/actions/generation/generator/FormButtonBlockGenerator/generateBackButtonBlock/MyBackButton.php
@@ -21,7 +21,7 @@ public function getButtonData(): array
             'back',
             sprintf("location.href = '%s';", $this->getUrl('*/*/')),
             [],
-            30
+            10
         );
     }
 }
diff --git a/testData/actions/generation/generator/FormButtonBlockGenerator/generateDeleteButtonBlock/DeleteBlock.php b/testData/actions/generation/generator/FormButtonBlockGenerator/generateDeleteButtonBlock/DeleteBlock.php
@@ -20,12 +20,13 @@ public function getButtonData(): array
         return $this->wrapButtonSettings(
             'Delete',
             'delete',
-            'deleteConfirm(\''
-            . __('Are you sure you want to delete this book?')
-            . '\', \'' . $this->getUrl(
-                '*/*/delete',
-                [BookData::BOOK_ID => $this->getBookId()]
-            ) . '\')',
+            sprintf("deleteConfirm('%s', '%s')",
+                __('Are you sure you want to delete this book?'),
+                $this->getUrl(
+                    '*/*/delete',
+                    [BookData::BOOK_ID => $this->getBookId()]
+                )
+            ),
             [],
             20
         );
diff --git a/testData/actions/generation/generator/FormButtonBlockGenerator/generateSaveButtonBlock/SaveBlock.php b/testData/actions/generation/generator/FormButtonBlockGenerator/generateSaveButtonBlock/SaveBlock.php
@@ -24,7 +24,7 @@ public function getButtonData(): array
                 'mage-init' => ['button' => ['event' => 'save']],
                 'form-role' => 'save'
             ],
-            10
+            30
         );
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,11 @@ private GetModuleNameByDirectoryUtil() {}`
`44`	`44`	`final String moduleNamePath = matcher.group(0);`
`45`	`45`
`46`	`46`	`if (!moduleNamePath.isEmpty()) {`
`47`		`- return moduleNamePath.split("/")[5];`
	`47`	`+ final String[] moduleNamePathParts = moduleNamePath.split("/");`
	`48`	`+`
	`49`	`+ if (moduleNamePathParts.length >= 6) { //NOPMD`
	`50`	`+ return moduleNamePath.split("/")[5];`
	`51`	`+ }`
`48`	`52`	`}`
`49`	`53`	`}`
`50`	`54`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public function getButtonData(): array`
`21`	`21`	`'back',`
`22`	`22`	`sprintf("location.href = '%s';", $this->getUrl('//')),`
`23`	`23`	`[],`
`24`		`- 30`
	`24`	`+ 10`
`25`	`25`	`);`
`26`	`26`	`}`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public function getButtonData(): array`
`24`	`24`	`'mage-init' => ['button' => ['event' => 'save']],`
`25`	`25`	`'form-role' => 'save'`
`26`	`26`	`],`
`27`		`- 10`
	`27`	`+ 30`
`28`	`28`	`);`
`29`	`29`	`}`
`30`	`30`	`}`