-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1188 from anzin/1139-add-setup-data-patch
1139: Creating a new data patch template
- Loading branch information
Showing
12 changed files
with
777 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
resources/fileTemplates/internal/Magento Module Setup Patch File.php.ft
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| <?php | ||
| #parse("PHP File Header.php") | ||
|
|
||
| namespace ${MODULE_NAME}\Setup\Patch\Data; | ||
|
|
||
| use Magento\Framework\Setup\ModuleDataSetupInterface; | ||
| use Magento\Framework\Setup\Patch\DataPatchInterface; | ||
|
|
||
| /** | ||
| * Patch is mechanism, that allows to do atomic upgrade data changes. | ||
| */ | ||
| class ${CLASS_NAME} implements DataPatchInterface | ||
| { | ||
| /** | ||
| * @var ModuleDataSetupInterface | ||
| */ | ||
| private $moduleDataSetup; | ||
|
|
||
| /** | ||
| * @param ModuleDataSetupInterface $moduleDataSetup | ||
| */ | ||
| public function __construct( | ||
| ModuleDataSetupInterface $moduleDataSetup | ||
| ) { | ||
| $this->moduleDataSetup = $moduleDataSetup; | ||
| } | ||
|
|
||
| /** | ||
| * Do Upgrade. | ||
| * | ||
| * @return void | ||
| */ | ||
| public function apply() | ||
| { | ||
| $this->moduleDataSetup->getConnection()->startSetup(); | ||
|
|
||
| // TODO: The code that you want apply in the patch | ||
|
|
||
| $this->moduleDataSetup->getConnection()->endSetup(); | ||
| } | ||
|
|
||
| /** | ||
| * Get aliases (previous names) for the patch. | ||
| * | ||
| * @return string[] | ||
| */ | ||
| public function getAliases() | ||
| { | ||
| return []; | ||
| } | ||
|
|
||
| /** | ||
| * Get array of patches that have to be executed prior to this. | ||
| * | ||
| * Example of implementation: | ||
| * | ||
| * [ | ||
| * \Vendor_Name\Module_Name\Setup\Patch\Patch1::class, | ||
| * \Vendor_Name\Module_Name\Setup\Patch\Patch2::class | ||
| * ] | ||
| * | ||
| * @return string[] | ||
| */ | ||
| public static function getDependencies() | ||
| { | ||
| return []; | ||
| } | ||
| } |
38 changes: 38 additions & 0 deletions
38
resources/fileTemplates/internal/Magento Module Setup Patch File.php.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| <!-- | ||
| /* | ||
| * Copyright © Magento, Inc. All rights reserved. | ||
| * See COPYING.txt for license details. | ||
| */ | ||
| --> | ||
| <html> | ||
| <body> | ||
| <table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse"> | ||
| <tr> | ||
| <td><font face="verdana" size="-1"> | ||
| A data patch is a class that contains data modification instructions. | ||
| </font><br> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><font face="verdana" size="-1"> | ||
| Read more About the data and schema patches in the | ||
| <a href="https://devdocs.magento.com/guides/v2.4/extension-dev-guide/declarative-schema/data-patches.html"> | ||
| DevDocs</a>. | ||
| </font><br> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| <table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse"> | ||
| <tr> | ||
| <td colspan="3"><font face="verdana" size="-1">Predefined variables explanation:</font></td> | ||
| </tr> | ||
| <tr> | ||
| <td valign="top"><nobr><font face="verdana" size="-2"><b>${CLASS_NAME}</b></font></nobr></td> | ||
| <td width="10"> </td> | ||
| <td width="100%" valign="top"><font face="verdana" size="-1">Specifies the name of your class | ||
| </font> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| </body> | ||
| </html> |
90 changes: 90 additions & 0 deletions
90
src/com/magento/idea/magento2plugin/actions/context/php/NewSetupDataPatchAction.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| /* | ||
| * Copyright © Magento, Inc. All rights reserved. | ||
| * See COPYING.txt for license details. | ||
| */ | ||
|
|
||
| package com.magento.idea.magento2plugin.actions.context.php; | ||
|
|
||
| import com.intellij.openapi.actionSystem.AnActionEvent; | ||
| import com.intellij.psi.PsiDirectory; | ||
| import com.intellij.psi.PsiFile; | ||
| import com.magento.idea.magento2plugin.actions.context.CustomGeneratorContextAction; | ||
| import com.magento.idea.magento2plugin.actions.generation.dialog.NewSetupDataPatchDialog; | ||
| import com.magento.idea.magento2plugin.magento.packages.ComponentType; | ||
| import com.magento.idea.magento2plugin.magento.packages.Package; | ||
| import com.magento.idea.magento2plugin.util.magento.GetMagentoModuleUtil; | ||
| import org.jetbrains.annotations.NotNull; | ||
|
|
||
| public class NewSetupDataPatchAction extends CustomGeneratorContextAction { | ||
|
|
||
| public static final String ACTION_NAME = "Magento 2 Setup Data Patch"; | ||
| public static final String ACTION_DESCRIPTION = "Create a new Magento 2 Setup Data Patch"; | ||
| public static final String SETUP_DIRECTORY = "Setup"; | ||
| public static final String PATCH_DIRECTORY = "Patch"; | ||
| public static final String DATA_DIRECTORY = "Data"; | ||
|
|
||
| public NewSetupDataPatchAction() { | ||
| super(ACTION_NAME, ACTION_DESCRIPTION); | ||
| } | ||
|
|
||
| @Override | ||
| public void actionPerformed(final @NotNull AnActionEvent event) { | ||
| final GetMagentoModuleUtil.MagentoModuleData moduleData = getModuleData(); | ||
|
|
||
| if (event.getProject() == null || moduleData == null || getDirectory() == null) { | ||
| return; | ||
| } | ||
| final String[] module = moduleData.getName().split(Package.vendorModuleNameSeparator); | ||
|
|
||
| if (module.length != 2) { //NOPMD | ||
| return; | ||
| } | ||
| final PsiDirectory rootDirectory = moduleData.getModuleDir().findSubdirectory( | ||
| SETUP_DIRECTORY | ||
| ); | ||
|
|
||
| if (rootDirectory == null) { | ||
| return; | ||
| } | ||
| NewSetupDataPatchDialog.open(event.getProject(), rootDirectory, module[0], module[1]); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean isVisible( | ||
| final @NotNull GetMagentoModuleUtil.MagentoModuleData moduleData, | ||
| final PsiDirectory targetDirectory, | ||
| final PsiFile targetFile | ||
| ) { | ||
| if (!moduleData.getType().equals(ComponentType.module)) { | ||
| return false; | ||
| } | ||
|
|
||
| if (SETUP_DIRECTORY.equals(targetDirectory.getName())) { | ||
| return moduleData.getModuleDir().equals(targetDirectory.getParentDirectory()); | ||
| } | ||
|
|
||
| if (PATCH_DIRECTORY.equals(targetDirectory.getName())) { | ||
| final PsiDirectory setupDirCandidate = targetDirectory.getParentDirectory(); | ||
|
|
||
| return setupDirCandidate != null | ||
| && SETUP_DIRECTORY.equals(setupDirCandidate.getName()) | ||
| && moduleData.getModuleDir().equals(setupDirCandidate.getParentDirectory()); | ||
| } | ||
|
|
||
| if (DATA_DIRECTORY.equals(targetDirectory.getName())) { | ||
| final PsiDirectory patchDirCandidate = targetDirectory.getParentDirectory(); | ||
|
|
||
| if (patchDirCandidate == null) { | ||
| return false; | ||
| } | ||
| final PsiDirectory setupDirCandidate = patchDirCandidate.getParentDirectory(); | ||
|
|
||
| return setupDirCandidate != null | ||
| && PATCH_DIRECTORY.equals(patchDirCandidate.getName()) | ||
| && SETUP_DIRECTORY.equals(setupDirCandidate.getName()) | ||
| && moduleData.getModuleDir().equals(setupDirCandidate.getParentDirectory()); | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
| } |
52 changes: 52 additions & 0 deletions
52
src/com/magento/idea/magento2plugin/actions/generation/ModuleSetupDataPatchData.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /* | ||
| * Copyright © Magento, Inc. All rights reserved. | ||
| * See COPYING.txt for license details. | ||
| */ | ||
|
|
||
| package com.magento.idea.magento2plugin.actions.generation; | ||
|
|
||
| import com.intellij.psi.PsiDirectory; | ||
| import org.jetbrains.annotations.NotNull; | ||
|
|
||
| public class ModuleSetupDataPatchData { | ||
|
|
||
| private final String packageName; | ||
| private final String moduleName; | ||
| private final PsiDirectory baseDir; | ||
| private final String className; | ||
|
|
||
| /** | ||
| * Constructor. | ||
| * | ||
| * @param packageName String | ||
| * @param moduleName String | ||
| * @param baseDir PsiDirectory | ||
| */ | ||
| public ModuleSetupDataPatchData( | ||
| final @NotNull String packageName, | ||
| final @NotNull String moduleName, | ||
| final @NotNull PsiDirectory baseDir, | ||
| final @NotNull String className | ||
| ) { | ||
| this.packageName = packageName; | ||
| this.moduleName = moduleName; | ||
| this.baseDir = baseDir; | ||
| this.className = className; | ||
| } | ||
|
|
||
| public @NotNull String getPackageName() { | ||
| return packageName; | ||
| } | ||
|
|
||
| public @NotNull String getModuleName() { | ||
| return moduleName; | ||
| } | ||
|
|
||
| public @NotNull PsiDirectory getBaseDir() { | ||
| return baseDir; | ||
| } | ||
|
|
||
| public @NotNull String getClassName() { | ||
| return className; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.