1139: Code refactoring

Author: bohdan-harniuk

resources/fileTemplates/internal/Magento Module Setup Patch File.php.ft

@@ -7,7 +7,7 @@ use Magento\Framework\Setup\ModuleDataSetupInterface;
 use Magento\Framework\Setup\Patch\DataPatchInterface;
 
 /**
-* Patch is mechanism, that allows to do atomic upgrade data changes
+* Patch is mechanism, that allows to do atomic upgrade data changes.
 */
 class ${CLASS_NAME} implements DataPatchInterface
 {
@@ -26,7 +26,7 @@ class ${CLASS_NAME} implements DataPatchInterface
     }
 
     /**
-     * Do Upgrade
+     * Do Upgrade.
      *
      * @return void
      */

src/com/magento/idea/magento2plugin/actions/generation/dialog/NewSetupDataPatchDialog.form

@@ -56,7 +56,7 @@
       <grid id="ad0b1" layout-manager="GridLayoutManager" row-count="2" column-count="2" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
         <margin top="0" left="0" bottom="0" right="0"/>
         <constraints>
-          <grid row="0" column="0" row-span="1" col-span="1" vsize-policy="3" hsize-policy="3" anchor="0" fill="3" indent="0" use-parent-layout="false"/>
+          <grid row="0" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="1" fill="1" indent="0" use-parent-layout="false"/>
         </constraints>
         <properties/>
         <border type="none"/>
@@ -71,19 +71,15 @@
           </component>
           <component id="662ad" class="javax.swing.JLabel" binding="classNameLabel">
             <constraints>
-              <grid row="0" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="8" fill="0" indent="0" use-parent-layout="false">
-                <preferred-size width="113" height="16"/>
-              </grid>
+              <grid row="0" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="0" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
             </constraints>
             <properties>
               <text value="Class Name"/>
             </properties>
           </component>
           <component id="292c" class="javax.swing.JTextField" binding="className">
             <constraints>
-              <grid row="0" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="6" anchor="8" fill="1" indent="0" use-parent-layout="false">
-                <preferred-size width="150" height="-1"/>
-              </grid>
+              <grid row="0" column="1" row-span="1" col-span="1" vsize-policy="0" hsize-policy="6" anchor="8" fill="1" indent="0" use-parent-layout="false"/>
             </constraints>
             <properties/>
           </component>

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

@@ -142,7 +142,7 @@ private void generateFile() {
     }
 
     public String getClassName() {
-        return className.getText();
+        return className.getText().trim();
     }
 
     private boolean validateFields() {
@@ -151,10 +151,14 @@ private boolean validateFields() {
         if (NewSetupDataPatchAction.DATA_DIRECTORY.equals(targetDirectory.getName())) {
             final PsiFile[] files = targetDirectory.getFiles();
             for (final PsiFile file : files) {
-                if (file.getName().equals(getClassName() + ModuleSetupDataPatchFile.FILE_NAME)) {
+                final String className = ModuleSetupDataPatchFile.resolveClassNameFromInput(
+                        getClassName()
+                );
+
+                if (file.getName().equals(className + ".php")) {
                     showErrorMessage(
                             fieldsValidationsList.get(0).getField(),
-                            "Class name " + getClassName() + " already exist."
+                            "Class name `" + className + "` already exist."
                     );
 
                     return false;

src/com/magento/idea/magento2plugin/actions/generation/generator/ModuleSetupDataPatchGenerator.java

@@ -57,7 +57,9 @@ public PsiFile generate(final String actionName) {
      */
     @Override
     protected void fillAttributes(final Properties attributes) {
-        attributes.setProperty("CLASS_NAME", moduleSetupPatchData.getClassName() + "Patch");
+        attributes.setProperty("CLASS_NAME", ModuleSetupDataPatchFile.resolveClassNameFromInput(
+                moduleSetupPatchData.getClassName()
+        ));
         attributes.setProperty(
                 "MODULE_NAME",
                 moduleSetupPatchData.getPackageName() + "\\" + moduleSetupPatchData.getModuleName()

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

@@ -11,19 +11,45 @@
 
 public class ModuleSetupDataPatchFile implements ModuleFileInterface {
 
-    public static final String FILE_NAME = "Patch.php";
+    public static final String FILE_SUFFIX = "Patch";
+    public static final String EXTENSION = ".php";
     public static final String TEMPLATE = "Magento Module Setup Patch File";
     private final String className;
 
+    /**
+     * Constructor.
+     *
+     * @param className String
+     */
     public ModuleSetupDataPatchFile(
             final @NotNull String className
     ) {
-        this.className = className;
+        this.className = resolveClassNameFromInput(className);
+    }
+
+    /**
+     * Resolve class name from user input.
+     *
+     * @param input String
+     *
+     * @return String
+     */
+    public static String resolveClassNameFromInput(final String input) {
+        if (input.length() <= FILE_SUFFIX.length()) {
+            return input + FILE_SUFFIX;
+        }
+        String suffix = input.substring(input.length() - FILE_SUFFIX.length());
+
+        if (FILE_SUFFIX.equals(suffix)) {
+            return input;
+        } else {
+            return input + FILE_SUFFIX;
+        }
     }
 
     @Override
     public String getFileName() {
-        return className + FILE_NAME;
+        return className + EXTENSION;
     }
 
     @Override

testData/actions/generation/generator/ModuleSetupDataPatchGenerator/generateModuleSetupDataPatchFile/TestClassPatch.php

@@ -6,7 +6,7 @@
 use Magento\Framework\Setup\Patch\DataPatchInterface;
 
 /**
- * Patch is mechanism, that allows to do atomic upgrade data changes
+ * Patch is mechanism, that allows to do atomic upgrade data changes.
  */
 class TestClassPatch implements DataPatchInterface
 {
@@ -26,7 +26,7 @@ public function __construct(
     }
 
     /**
-     * Do Upgrade
+     * Do Upgrade.
      *
      * @return void
      */

tests/com/magento/idea/magento2plugin/actions/generation/generator/ModuleSetupDataPatchGeneratorTest.java

@@ -10,14 +10,15 @@
 import com.magento.idea.magento2plugin.magento.files.ModuleSetupDataPatchFile;
 
 public final class ModuleSetupDataPatchGeneratorTest extends BaseGeneratorTestCase {
-    private static final String CLASS_NAME = "TestClass";
+
+    private static final String CLASS_NAME = "TestClassPatch";
 
     /**
      * Test module README.md file generation.
      */
     public void testGenerateModuleSetupDataPatchFile() {
         final PsiFile expectedFile = myFixture.configureByFile(
-                getFixturePath(CLASS_NAME + ModuleSetupDataPatchFile.FILE_NAME)
+                getFixturePath(CLASS_NAME + ModuleSetupDataPatchFile.EXTENSION)
         );
         final ModuleSetupDataPatchGenerator generator = new ModuleSetupDataPatchGenerator(
                 new ModuleSetupDataPatchData(