Refactored php file generators to extend PhpFileGenerator, fixed static test issues, fixed Edit entity controller generation code duplication

Author: bohdan-harniuk

src/com/magento/idea/magento2plugin/actions/generation/data/converter/newentitydialog/FormViewControllerDtoConverter.java

@@ -16,8 +16,14 @@
 public class UiComponentFormLayoutDtoConverter extends UiComponentFormFileData
         implements DataObjectConverter {
 
-    private final static String SUBMIT_ACTION_NAME = "Save";
+    private static final String SUBMIT_ACTION_NAME = "Save";
 
+    /**
+     * Ui Component form layout DTO converter.
+     *
+     * @param generationContextData EntityCreatorContextData
+     * @param newEntityDialogData NewEntityDialogData
+     */
     public UiComponentFormLayoutDtoConverter(
             final @NotNull EntityCreatorContextData generationContextData,
             final @NotNull NewEntityDialogData newEntityDialogData

src/com/magento/idea/magento2plugin/actions/generation/data/converter/newentitydialog/UiComponentFormLayoutDtoConverter.java

@@ -219,12 +219,8 @@ private void generateDataModelFile() {
     private void generatePreferenceForInterface() {
         new PreferenceDiXmlGenerator(new PreferenceDiXmFileData(
                 getModuleName(),
-                new DataModelInterfaceFile(
-                        getDtoInterfaceName()
-                ).getNamespaceBuilder(getModuleName()).getClassFqn(),
-                new DataModelFile(
-                        getDtoModelName()
-                ).getNamespaceBuilder(getModuleName()).getClassFqn(),
+                new DataModelInterfaceFile(getModuleName(), getDtoInterfaceName()).getClassFqn(),
+                new DataModelFile(getModuleName(), getDtoModelName()).getClassFqn(),
                 "base"
         ), project).generate(OverrideClassByAPreferenceAction.ACTION_NAME);
     }

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

@@ -45,7 +45,7 @@
 import com.magento.idea.magento2plugin.magento.packages.PropertiesTypes;
 import com.magento.idea.magento2plugin.magento.packages.database.TableEngines;
 import com.magento.idea.magento2plugin.magento.packages.database.TableResources;
-import com.magento.idea.magento2plugin.magento.packages.uiComponent.FormElementType;
+import com.magento.idea.magento2plugin.magento.packages.uicomponent.FormElementType;
 import com.magento.idea.magento2plugin.stubs.indexes.xml.MenuIndex;
 import com.magento.idea.magento2plugin.ui.FilteredComboBox;
 import com.magento.idea.magento2plugin.ui.table.TableGroupWrapper;
@@ -443,9 +443,9 @@ private EntityCreatorContextData getEntityCreatorContextData(
         final String actionsPathPrefix = dialogData.getRoute() + File.separator
                 + FirstLetterToLowercaseUtil.convert(entityName) + File.separator;
         final NamespaceBuilder dtoModelNamespace =
-                new DataModelFile(dtoClassName).getNamespaceBuilder(moduleName);
+                new DataModelFile(moduleName, dtoClassName).getNamespaceBuilder();
         final NamespaceBuilder dtoInterfaceNamespace =
-                new DataModelInterfaceFile(dtoInterfaceClassName).getNamespaceBuilder(moduleName);
+                new DataModelInterfaceFile(moduleName, dtoInterfaceClassName).getNamespaceBuilder();
 
         final NamespaceBuilder formViewNamespaceBuilder =
                 new NamespaceBuilder(
@@ -600,9 +600,9 @@ private List<UiComponentFormFieldData> getFields() {
             final String dataType = model.getValueAt(count, 1).toString();
 
             final String label = Arrays.stream(name.split("_")).map(
-                            string -> string.substring(0, 1).toUpperCase(Locale.getDefault())
-                                    + string.substring(1)).collect(Collectors.joining(" ")
-                    );
+                    string -> string.substring(0, 1).toUpperCase(Locale.getDefault())
+                            + string.substring(1)).collect(Collectors.joining(" ")
+            );
             final String sortOrder = String.valueOf(count).concat("0");
             final String fieldset = "general";
 

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

@@ -8,7 +8,6 @@
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.ui.ComboBoxTableRenderer;
 import com.intellij.psi.PsiDirectory;
-import com.intellij.psi.PsiFile;
 import com.magento.idea.magento2plugin.actions.generation.NewUiComponentFormAction;
 import com.magento.idea.magento2plugin.actions.generation.data.AclXmlData;
 import com.magento.idea.magento2plugin.actions.generation.data.ControllerFileData;
@@ -47,7 +46,7 @@
 import com.magento.idea.magento2plugin.magento.packages.Areas;
 import com.magento.idea.magento2plugin.magento.packages.File;
 import com.magento.idea.magento2plugin.magento.packages.HttpMethod;
-import com.magento.idea.magento2plugin.magento.packages.uiComponent.FormElementType;
+import com.magento.idea.magento2plugin.magento.packages.uicomponent.FormElementType;
 import com.magento.idea.magento2plugin.ui.FilteredComboBox;
 import com.magento.idea.magento2plugin.ui.table.ComboBoxEditor;
 import com.magento.idea.magento2plugin.ui.table.DeleteRowButton;
@@ -72,7 +71,6 @@
 import javax.swing.KeyStroke;
 import javax.swing.table.DefaultTableModel;
 import javax.swing.table.TableColumn;
-import org.jetbrains.annotations.NotNull;
 
 @SuppressWarnings({
         "PMD.TooManyFields",

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

@@ -7,10 +7,10 @@
 
 import com.google.common.base.CaseFormat;
 import com.magento.idea.magento2plugin.actions.generation.data.code.ClassPropertyData;
-import org.apache.commons.lang.StringUtils;
-import javax.swing.table.DefaultTableModel;
 import java.util.ArrayList;
 import java.util.List;
+import javax.swing.table.DefaultTableModel;
+import org.apache.commons.lang.StringUtils;
 
 public final class ClassPropertyFormatterUtil {
 
@@ -27,8 +27,8 @@ public static List<String> formatProperties(final DefaultTableModel table) {
         final List<String> properties = new ArrayList<>();
 
         for (int index = 0; index < table.getRowCount(); index++) {
-            String name = table.getValueAt(index, 0).toString();
-            String type = table.getValueAt(index, 1).toString();
+            final String name = table.getValueAt(index, 0).toString();
+            final String type = table.getValueAt(index, 1).toString();
 
             properties.add(ClassPropertyFormatterUtil.formatSingleProperty(name, type));
         }

src/com/magento/idea/magento2plugin/actions/generation/dialog/util/ClassPropertyFormatterUtil.java

@@ -5,38 +5,19 @@
 
 package com.magento.idea.magento2plugin.actions.generation.generator;
 
-import com.intellij.openapi.command.WriteCommandAction;
 import com.intellij.openapi.project.Project;
-import com.intellij.psi.PsiDirectory;
-import com.intellij.psi.PsiFile;
-import com.jetbrains.php.lang.psi.PhpFile;
-import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.actions.generation.data.DataModelData;
-import com.magento.idea.magento2plugin.actions.generation.generator.util.DirectoryGenerator;
-import com.magento.idea.magento2plugin.actions.generation.generator.util.FileFromTemplateGenerator;
 import com.magento.idea.magento2plugin.actions.generation.generator.util.PhpClassGeneratorUtil;
 import com.magento.idea.magento2plugin.actions.generation.generator.util.PhpClassTypesBuilder;
-import com.magento.idea.magento2plugin.bundles.CommonBundle;
-import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
-import com.magento.idea.magento2plugin.indexes.ModuleIndex;
+import com.magento.idea.magento2plugin.magento.files.AbstractPhpFile;
 import com.magento.idea.magento2plugin.magento.files.DataModelFile;
 import com.magento.idea.magento2plugin.magento.files.DataModelInterfaceFile;
-import com.magento.idea.magento2plugin.util.GetFirstClassOfFile;
-import com.magento.idea.magento2plugin.util.GetPhpClassByFQN;
 import java.util.Properties;
-import javax.swing.JOptionPane;
 import org.jetbrains.annotations.NotNull;
 
-public class DataModelGenerator extends FileGenerator {
+public class DataModelGenerator extends PhpFileGenerator {
 
-    private final Project project;
     private final DataModelData data;
-    private final DirectoryGenerator directoryGenerator;
-    private final FileFromTemplateGenerator fileFromTemplateGenerator;
-    private final GetFirstClassOfFile getFirstClassOfFile;
-    private final ValidatorBundle validatorBundle;
-    private final CommonBundle commonBundle;
-    private final DataModelFile file;
 
     /**
      * Data model generator constructor.
@@ -48,83 +29,28 @@ public DataModelGenerator(
             final @NotNull Project project,
             final @NotNull DataModelData data
     ) {
-        super(project);
-        this.project = project;
-        this.data = data;
-        this.directoryGenerator = DirectoryGenerator.getInstance();
-        this.fileFromTemplateGenerator = new FileFromTemplateGenerator(project);
-        this.getFirstClassOfFile = GetFirstClassOfFile.getInstance();
-        this.validatorBundle = new ValidatorBundle();
-        this.commonBundle = new CommonBundle();
-        file = new DataModelFile(data.getName());
-    }
-
-    @Override
-    public PsiFile generate(final @NotNull String actionName) {
-        final PsiFile[] files = new PsiFile[1];
-
-        WriteCommandAction.runWriteCommandAction(project, () -> {
-            PhpClass dataModel = GetPhpClassByFQN.getInstance(project).execute(
-                    file.getNamespaceBuilder(data.getModuleName()).getClassFqn()
-            );
-
-            if (dataModel == null) {
-                dataModel = createModel(actionName);
-
-                if (dataModel == null) {
-                    final String errorMessage = this.validatorBundle.message(
-                            "validator.file.cantBeCreated",
-                            "Data Model"
-                    );
-                    JOptionPane.showMessageDialog(
-                            null,
-                            errorMessage,
-                            commonBundle.message("common.error"),
-                            JOptionPane.ERROR_MESSAGE
-                    );
-                } else {
-                    files[0] = dataModel.getContainingFile();
-                }
-            } else {
-                final String errorMessage = this.validatorBundle.message(
-                        "validator.file.alreadyExists",
-                        "Data Model"
-                );
-                JOptionPane.showMessageDialog(
-                        null,
-                        errorMessage,
-                        commonBundle.message("common.error"),
-                        JOptionPane.ERROR_MESSAGE
-                );
-            }
-        });
-
-        return files[0];
+        this(project, data, true);
     }
 
     /**
-     * Create model class.
-     *
-     * @param actionName String
+     * Data model generator constructor.
      *
-     * @return PhpClass
+     * @param project Project
+     * @param data DataModelData
+     * @param checkFileAlreadyExists boolean
      */
-    private PhpClass createModel(final @NotNull String actionName) {
-        final PsiDirectory parentDirectory = new ModuleIndex(project)
-                .getModuleDirectoryByModuleName(data.getModuleName());
-        final PsiDirectory dataModelDirectory = directoryGenerator.findOrCreateSubdirectories(
-                parentDirectory,
-                DataModelFile.DIRECTORY
-        );
-
-        final PsiFile dataModelFile = fileFromTemplateGenerator.generate(
-                file,
-                getAttributes(),
-                dataModelDirectory,
-                actionName
-        );
+    public DataModelGenerator(
+            final @NotNull Project project,
+            final @NotNull DataModelData data,
+            final boolean checkFileAlreadyExists
+    ) {
+        super(project, checkFileAlreadyExists);
+        this.data = data;
+    }
 
-        return dataModelFile == null ? null : getFirstClassOfFile.execute((PhpFile) dataModelFile);
+    @Override
+    protected AbstractPhpFile initFile() {
+        return new DataModelFile(data.getModuleName(), data.getName());
     }
 
     /**
@@ -137,10 +63,7 @@ protected void fillAttributes(final @NotNull Properties attributes) {
         final PhpClassTypesBuilder phpClassTypesBuilder = new PhpClassTypesBuilder();
 
         phpClassTypesBuilder
-                .appendProperty(
-                        "NAMESPACE",
-                        file.getNamespaceBuilder(data.getModuleName()).getNamespace()
-                )
+                .appendProperty("NAMESPACE", file.getNamespace())
                 .appendProperty("NAME", data.getName())
                 .appendProperty("PROPERTIES", data.getProperties())
                 .appendProperty("HASINTERFACE", Boolean.toString(data.hasInterface()))
@@ -150,8 +73,9 @@ protected void fillAttributes(final @NotNull Properties attributes) {
             phpClassTypesBuilder.append(
                     "IMPLEMENTS",
                     new DataModelInterfaceFile(
+                            data.getModuleName(),
                             data.getInterfaceName()
-                    ).getNamespaceBuilder(data.getModuleName()).getClassFqn());
+                    ).getClassFqn());
         }
 
         phpClassTypesBuilder.mergeProperties(attributes);