Changed actions column and edit page buttons generation, added new test case for grid list generation

bohdan-harniuk · bohdan-harniuk · commit 1a73c59d3d1f · 2021-04-06T14:54:05.000+03:00
diff --git a/resources/fileTemplates/internal/Magento UI Component Grid XML.xml.ft b/resources/fileTemplates/internal/Magento UI Component Grid XML.xml.ft
@@ -69,10 +69,12 @@
                 $column
             #end
         #end
+#if (${ACTION_COLUMN})
         <actionsColumn name="actions" class="${ACTION_COLUMN}">
             <settings>
                 <indexField>${ID_FIELD_NAME}</indexField>
             </settings>
         </actionsColumn>
+#end
     </columns>
 </listing>
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/data/UiComponentGridData.java b/src/com/magento/idea/magento2plugin/actions/generation/data/UiComponentGridData.java
@@ -18,6 +18,7 @@ public class UiComponentGridData {
     private final String acl;
     private final String dataProviderName;
     private final String dataProviderPath;
+    private final String entityName;
     private final UiComponentGridToolbarData gridToolbarData;
     private final List<Map<String, String>> columns;
 
@@ -51,6 +52,7 @@ public UiComponentGridData(
                 acl,
                 dataProviderName,
                 dataProviderPath,
+                null,
                 gridToolbarData,
                 new ArrayList<>()
         );
@@ -66,6 +68,7 @@ public UiComponentGridData(
      * @param acl String
      * @param dataProviderName String
      * @param dataProviderPath String
+     * @param entityName String
      * @param gridToolbarData UiComponentGridToolbarData
      * @param columns List
      */
@@ -77,6 +80,7 @@ public UiComponentGridData(
             final String acl,
             final String dataProviderName,
             final String dataProviderPath,
+            final String entityName,
             final UiComponentGridToolbarData gridToolbarData,
             final List<Map<String, String>> columns
     ) {
@@ -87,6 +91,7 @@ public UiComponentGridData(
         this.acl = acl;
         this.dataProviderName = dataProviderName;
         this.dataProviderPath = dataProviderPath;
+        this.entityName = entityName;
         this.gridToolbarData = gridToolbarData;
         this.columns = columns;
     }
@@ -154,6 +159,15 @@ public String getDataProviderPath() {
         return dataProviderPath;
     }
 
+    /**
+     * Get entity name.
+     *
+     * @return String
+     */
+    public String getEntityName() {
+        return entityName;
+    }
+
     /**
      * Get ID field name.
      *
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/data/converter/newentitydialog/UiComponentGridDtoConverter.java b/src/com/magento/idea/magento2plugin/actions/generation/data/converter/newentitydialog/UiComponentGridDtoConverter.java
@@ -34,6 +34,7 @@ public UiComponentGridDtoConverter(
                 newEntityDialogData.getAclId(),
                 newEntityDialogData.getEntityName().concat("DataProvider"),
                 UiComponentDataProviderFile.DIRECTORY,
+                newEntityDialogData.getEntityName(),
                 new UiComponentGridToolbarDtoConverter(generationContextData, newEntityDialogData),
                 generationContextData.getEntityProps()
         );
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEntityDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEntityDialog.java
@@ -378,6 +378,10 @@ private void generateNewEntityFiles(final @NotNull ActionEvent event) {
             buttonOK.setEnabled(false);
             buttonCancel.setEnabled(false);
 
+            if (propertyTable.isEditing()) {
+                propertyTable.getCellEditor().stopCellEditing();
+            }
+
             new ProcessWorker(
                     this::onOK,
                     this::releaseDialogAfterGeneration,
@@ -518,7 +522,7 @@ private List<UiComponentFormFieldsetData> getFieldSets() {
      */
     private List<UiComponentFormButtonData> getButtons() {
         final List<UiComponentFormButtonData> buttons = new ArrayList<>();
-        final String directory = "Block/Form";
+        final String directory = "Block/Form/" + entityName.getText().trim();
 
         final NamespaceBuilder namespaceBuilderSave = new NamespaceBuilder(
                 moduleName,
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/FormGenericButtonBlockGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/FormGenericButtonBlockGenerator.java
@@ -53,7 +53,7 @@ public FormGenericButtonBlockGenerator(
 
     @Override
     protected AbstractPhpFile initFile() {
-        return new FormGenericButtonBlockFile(data.getModuleName());
+        return new FormGenericButtonBlockFile(data.getModuleName(), data.getEntityName());
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/GridActionColumnFileGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/GridActionColumnFileGenerator.java
@@ -50,7 +50,7 @@ public GridActionColumnFileGenerator(
 
     @Override
     protected AbstractPhpFile initFile() {
-        return new GridActionColumnFile(data.getModuleName());
+        return new GridActionColumnFile(data.getModuleName(), data.getEntityName());
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/UiComponentFormButtonBlockGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/UiComponentFormButtonBlockGenerator.java
@@ -31,6 +31,7 @@
 import org.jetbrains.annotations.NotNull;
 
 public class UiComponentFormButtonBlockGenerator extends FileGenerator {
+
     private final UiComponentFormButtonData buttonData;
     private final Project project;
     private final FileFromTemplateGenerator fileFromTemplateGenerator;
@@ -148,15 +149,18 @@ protected void fillAttributes(final @NotNull Properties attributes) {
                 PhpClassGeneratorUtil.getNameFromFqn(FormButtonBlockFile.DATA_PROVIDER_TYPE));
         uses.add(FormButtonBlockFile.DATA_PROVIDER_TYPE);
 
+        final FormGenericButtonBlockFile genericButtonBlockFile =
+                new FormGenericButtonBlockFile(buttonData.getButtonModule(), entityName);
+
         final NamespaceBuilder genericBtnNamespace = new NamespaceBuilder(
                 buttonData.getButtonModule(),
                 FormGenericButtonBlockFile.CLASS_NAME,
-                FormGenericButtonBlockFile.DIRECTORY
+                genericButtonBlockFile.getDirectory()
         );
         attributes.setProperty("GENERIC_BUTTON",
                 PhpClassGeneratorUtil.getNameFromFqn(genericBtnNamespace.getClassFqn()));
 
-        if (!FormGenericButtonBlockFile.DIRECTORY.equals(buttonData.getButtonDirectory())) {
+        if (!genericButtonBlockFile.getDirectory().equals(buttonData.getButtonDirectory())) {
             uses.add(genericBtnNamespace.getClassFqn());
         }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/UiComponentGridXmlGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/UiComponentGridXmlGenerator.java
@@ -205,12 +205,11 @@ private void prepareColumnsProperties(final @NotNull Properties attributes) {
             attributes.setProperty("COLUMNS", String.join("\n", columnsTextList));
         }
 
-        final NamespaceBuilder actionColumnNamespace = new NamespaceBuilder(
-                data.getModuleName(),
-                GridActionColumnFile.CLASS_NAME,
-                GridActionColumnFile.DIRECTORY
-        );
-        attributes.setProperty("ACTION_COLUMN", actionColumnNamespace.getClassFqn());
+        if (data.getEntityName() != null) {
+            final GridActionColumnFile gridActionColumnFile =
+                    new GridActionColumnFile(data.getModuleName(), data.getEntityName());
+            attributes.setProperty("ACTION_COLUMN", gridActionColumnFile.getClassFqn());
+        }
     }
 
     /**
diff --git a/src/com/magento/idea/magento2plugin/magento/files/FormGenericButtonBlockFile.java b/src/com/magento/idea/magento2plugin/magento/files/FormGenericButtonBlockFile.java
@@ -12,16 +12,22 @@ public final class FormGenericButtonBlockFile extends AbstractPhpFile {
     public static final String CLASS_NAME = "GenericButton";
     public static final String HUMAN_READABLE_NAME = "Generic button block class";
     public static final String TEMPLATE = "Magento PHP Form Generic Button Block Class";
-    public static final String DIRECTORY = "Block/Form";
     public static final String CONTEXT = "Magento\\Backend\\Block\\Widget\\Context";
+    private static final String DIRECTORY = "Block/Form";
+    private final String entityName;
 
     /**
      * Form generic button block file constructor.
      *
      * @param moduleName String
+     * @param entityName String
      */
-    public FormGenericButtonBlockFile(final @NotNull String moduleName) {
+    public FormGenericButtonBlockFile(
+            final @NotNull String moduleName,
+            final @NotNull String entityName
+    ) {
         super(moduleName, CLASS_NAME);
+        this.entityName = entityName;
     }
 
     @Override
@@ -31,7 +37,7 @@ public String getHumanReadableName() {
 
     @Override
     public String getDirectory() {
-        return DIRECTORY;
+        return DIRECTORY.concat("/" + entityName);
     }
 
     @Override
diff --git a/src/com/magento/idea/magento2plugin/magento/files/GridActionColumnFile.java b/src/com/magento/idea/magento2plugin/magento/files/GridActionColumnFile.java
@@ -9,20 +9,27 @@
 
 public final class GridActionColumnFile extends AbstractPhpFile {
 
-    public static final String CLASS_NAME = "BlockActions";
     public static final String HUMAN_READABLE_NAME = "Grid Ui Component actions column class";
     public static final String TEMPLATE = "Magento Grid Ui Component Action Column Class";
-    public static final String DIRECTORY = "Ui/Component/Listing/Column";
     public static final String PARENT_CLASS = "Magento\\Ui\\Component\\Listing\\Columns\\Column";
     public static final String CONTEXT =
             "Magento\\Framework\\View\\Element\\UiComponent\\ContextInterface";
     public static final String UI_COMPONENT_FACTORY =
             "Magento\\Framework\\View\\Element\\UiComponentFactory";
-
+    private static final String CLASS_NAME = "BlockActions";
+    private static final String DIRECTORY = "Ui/Component/Listing/Column";
+
+    /**
+     * Grid actions column file constructor.
+     *
+     * @param moduleName String
+     * @param entityName String
+     */
     public GridActionColumnFile(
-            final @NotNull String moduleName
+            final @NotNull String moduleName,
+            final @NotNull String entityName
     ) {
-        super(moduleName, CLASS_NAME);
+        super(moduleName, entityName.concat(CLASS_NAME));
     }
 
     @Override
diff --git a/testData/actions/generation/generator/FormButtonBlockGenerator/generateBackButtonBlock/MyBackButton.php b/testData/actions/generation/generator/FormButtonBlockGenerator/generateBackButtonBlock/MyBackButton.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Foo\Bar\Block\Form;
+namespace Foo\Bar\Block\Form\Book;
 
 use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
 
diff --git a/testData/actions/generation/generator/FormButtonBlockGenerator/generateCustomButtonBlock/MyCustom.php b/testData/actions/generation/generator/FormButtonBlockGenerator/generateCustomButtonBlock/MyCustom.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Foo\Bar\Block\Form;
+namespace Foo\Bar\Block\Form\Book;
 
 use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
 
diff --git a/testData/actions/generation/generator/FormButtonBlockGenerator/generateDeleteButtonBlock/DeleteBlock.php b/testData/actions/generation/generator/FormButtonBlockGenerator/generateDeleteButtonBlock/DeleteBlock.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Foo\Bar\Block\Form;
+namespace Foo\Bar\Block\Form\Book;
 
 use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
 
diff --git a/testData/actions/generation/generator/FormButtonBlockGenerator/generateSaveButtonBlock/SaveBlock.php b/testData/actions/generation/generator/FormButtonBlockGenerator/generateSaveButtonBlock/SaveBlock.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Foo\Bar\Block\Form;
+namespace Foo\Bar\Block\Form\Book;
 
 use Magento\Framework\View\Element\UiComponent\Control\ButtonProviderInterface;
 
diff --git a/testData/actions/generation/generator/FormGenericButtonBlockGenerator/generateFormGenericButtonBlockFile/GenericButton.php b/testData/actions/generation/generator/FormGenericButtonBlockGenerator/generateFormGenericButtonBlockFile/GenericButton.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Foo\Bar\Block\Form;
+namespace Foo\Bar\Block\Form\Book;
 
 use Magento\Backend\Block\Widget\Context;
 use Magento\Framework\UrlInterface;
diff --git a/testData/actions/generation/generator/GridActionColumnFileGenerator/generateGridActionColumnFile/BookBlockActions.php b/testData/actions/generation/generator/GridActionColumnFileGenerator/generateGridActionColumnFile/BookBlockActions.php
@@ -10,7 +10,7 @@
 /**
  * Class to build edit and delete link for each item.
  */
-class BlockActions extends Column
+class BookBlockActions extends Column
 {
     /**
      * Entity name.
diff --git a/testData/actions/generation/generator/UiComponentGridXmlGenerator/generateUiGridForBaseArea/custom_entity_grid.xml b/testData/actions/generation/generator/UiComponentGridXmlGenerator/generateUiGridForBaseArea/custom_entity_grid.xml
@@ -43,10 +43,5 @@
                 <sorting>desc</sorting>
             </settings>
         </column>
-        <actionsColumn name="actions" class="Foo\Bar\Ui\Component\Listing\Column\BlockActions">
-            <settings>
-                <indexField>entity_id</indexField>
-            </settings>
-        </actionsColumn>
     </columns>
 </listing>
diff --git a/testData/actions/generation/generator/UiComponentGridXmlGenerator/generateUiGridForBaseAreaWithActionsColumnColumn/custom_entity_grid.xml b/testData/actions/generation/generator/UiComponentGridXmlGenerator/generateUiGridForBaseAreaWithActionsColumnColumn/custom_entity_grid.xml
@@ -0,0 +1,52 @@
+<?xml version="1.0"?>
+<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
+    <argument name="data" xsi:type="array">
+        <item name="js_config" xsi:type="array">
+            <item name="provider" xsi:type="string">custom_entity_grid.custom_entity_grid_data_source</item>
+            <item name="deps" xsi:type="string">custom_entity_grid.custom_entity_grid_data_source</item>
+        </item>
+    </argument>
+    <settings>
+        <buttons>
+            <button name="add">
+                <url path="*/*/new"/>
+                <class>primary</class>
+                <label translate="true">Add New</label>
+            </button>
+        </buttons>
+        <spinner>custom_entity_grid_columns</spinner>
+        <deps>
+            <dep>custom_entity_grid.custom_entity_grid_data_source</dep>
+        </deps>
+    </settings>
+    <dataSource name="custom_entity_grid_data_source" component="Magento_Ui/js/grid/provider">
+        <settings>
+            <storageConfig>
+                <param name="indexField" xsi:type="string">entity_id</param>
+            </storageConfig>
+            <updateUrl path="mui/index/render"/>
+        </settings>
+        <aclResource>Foo_Bar::custom_entity</aclResource>
+        <dataProvider class="Foo\Bar\Ui\Listing\DataProvider" name="custom_entity_grid_data_source">
+            <settings>
+                <requestFieldName>entity_id</requestFieldName>
+                <primaryFieldName>entity_id</primaryFieldName>
+            </settings>
+        </dataProvider>
+    </dataSource>
+    <columns name="custom_entity_grid_columns">
+        <column name="entity_id">
+            <settings>
+                <filter>textRange</filter>
+                <label translate="true">ID</label>
+                <sorting>desc</sorting>
+            </settings>
+        </column>
+        <actionsColumn name="actions" class="Foo\Bar\Ui\Component\Listing\Column\BookBlockActions">
+            <settings>
+                <indexField>entity_id</indexField>
+            </settings>
+        </actionsColumn>
+    </columns>
+</listing>
diff --git a/testData/actions/generation/generator/UiComponentGridXmlGenerator/generateUiGridWithoutToolbar/custom_entity_grid.xml b/testData/actions/generation/generator/UiComponentGridXmlGenerator/generateUiGridWithoutToolbar/custom_entity_grid.xml
@@ -50,10 +50,5 @@
                 <sorting>desc</sorting>
             </settings>
         </column>
-        <actionsColumn name="actions" class="Foo\Bar\Ui\Component\Listing\Column\BlockActions">
-            <settings>
-                <indexField>entity_id</indexField>
-            </settings>
-        </actionsColumn>
     </columns>
 </listing>
diff --git a/tests/com/magento/idea/magento2plugin/actions/generation/generator/FormButtonBlockGeneratorTest.java b/tests/com/magento/idea/magento2plugin/actions/generation/generator/FormButtonBlockGeneratorTest.java
@@ -11,13 +11,15 @@
 import com.magento.idea.magento2plugin.actions.generation.generator.util.NamespaceBuilder;
 
 public class FormButtonBlockGeneratorTest extends BaseGeneratorTestCase {
+
     private static final String MODULE_NAME = "Foo_Bar";
     private static final String FORM_NAME = "my_form";
-    private static final String BLOCK_DIRECTORY = "Block/Form";
-    private static final String ACTION_NAME = "test";
     private static final String ENTITY_NAME = "Book";
+    private static final String BLOCK_DIRECTORY = "Block/Form/" + ENTITY_NAME;
+    private static final String ACTION_NAME = "test";
     private static final String ENTITY_ID = "book_id";
-    public static final String EXPECTED_DIRECTORY = "src/app/code/Foo/Bar/Block/Form";
+    public static final String EXPECTED_DIRECTORY
+            = "src/app/code/Foo/Bar/Block/Form/" + ENTITY_NAME;
 
     /**
      * Test creation Block type Save.
diff --git a/tests/com/magento/idea/magento2plugin/actions/generation/generator/FormGenericButtonBlockGeneratorTest.java b/tests/com/magento/idea/magento2plugin/actions/generation/generator/FormGenericButtonBlockGeneratorTest.java
@@ -13,7 +13,8 @@ public class FormGenericButtonBlockGeneratorTest extends BaseGeneratorTestCase {
     private static final String MODULE_NAME = "Foo_Bar";
     private static final String ENTITY_NAME = "Book";
     private static final String ENTITY_ID = "book_id";
-    private static final String EXPECTED_DIRECTORY = "src/app/code/Foo/Bar/Block/Form";
+    private static final String EXPECTED_DIRECTORY
+            = "src/app/code/Foo/Bar/Block/Form/" + ENTITY_NAME;
 
     /**
      * Test generation of form ui component generic button block.
@@ -31,7 +32,7 @@ public void testGenerateFormGenericButtonBlockFile() {
                         false
                 );
         final String filePath = this.getFixturePath(
-                new FormGenericButtonBlockFile(MODULE_NAME).getFileName()
+                new FormGenericButtonBlockFile(MODULE_NAME, ENTITY_NAME).getFileName()
         );
 
         assertGeneratedFileIsCorrect(
diff --git a/tests/com/magento/idea/magento2plugin/actions/generation/generator/GridActionColumnFileGeneratorTest.java b/tests/com/magento/idea/magento2plugin/actions/generation/generator/GridActionColumnFileGeneratorTest.java
@@ -20,7 +20,7 @@ public class GridActionColumnFileGeneratorTest extends BaseGeneratorTestCase {
      * Test generation of grid actions column file.
      */
     public void testGenerateGridActionColumnFile() {
-        final GridActionColumnFile file = new GridActionColumnFile(MODULE_NAME);
+        final GridActionColumnFile file = new GridActionColumnFile(MODULE_NAME, ENTITY_NAME);
         final GridActionColumnData data = new GridActionColumnData(
                 MODULE_NAME,
                 ENTITY_NAME,
diff --git a/tests/com/magento/idea/magento2plugin/actions/generation/generator/UiComponentGridXmlGeneratorTest.java b/tests/com/magento/idea/magento2plugin/actions/generation/generator/UiComponentGridXmlGeneratorTest.java

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public FormGenericButtonBlockGenerator(`
`53`	`53`
`54`	`54`	`@Override`
`55`	`55`	`protected AbstractPhpFile initFile() {`
`56`		`- return new FormGenericButtonBlockFile(data.getModuleName());`
	`56`	`+ return new FormGenericButtonBlockFile(data.getModuleName(), data.getEntityName());`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public GridActionColumnFileGenerator(`
`50`	`50`
`51`	`51`	`@Override`
`52`	`52`	`protected AbstractPhpFile initFile() {`
`53`		`- return new GridActionColumnFile(data.getModuleName());`
	`53`	`+ return new GridActionColumnFile(data.getModuleName(), data.getEntityName());`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`/**`
`11`	`11`	`* Class to build edit and delete link for each item.`
`12`	`12`	`*/`
`13`		`-class BlockActions extends Column`
	`13`	`+class BookBlockActions extends Column`
`14`	`14`	`{`
`15`	`15`	`/**`
`16`	`16`	`* Entity name.`