Refactored generators

Author: ProkopovVitaliy

src/com/magento/idea/magento2plugin/actions/generation/data/ProductEntityData.java

@@ -5,8 +5,7 @@
 
 package com.magento.idea.magento2plugin.actions.generation.data;
 
-import com.magento.idea.magento2plugin.magento.packages.File;
-import com.magento.idea.magento2plugin.magento.packages.Package;
+import com.magento.idea.magento2plugin.magento.files.EavAttributeDataPatchFile;
 import com.magento.idea.magento2plugin.magento.packages.eav.EavEntity;
 
 @SuppressWarnings({"PMD.TooManyFields"})
@@ -144,25 +143,9 @@ public String getInput() {
 
     @Override
     public String getNamespace() {
-        if (namespace == null) {
-            namespace = getDataPathNamespace();
-        }
-
         return namespace;
     }
 
-    private String getDataPathNamespace() {
-        final String[] parts = moduleName.split(Package.vendorModuleNameSeparator);
-        if (parts[0] == null || parts[1] == null || parts.length > 2) {
-            return null;
-        }
-        final String directoryPart = getDirectory().replace(
-                File.separator,
-                Package.fqnSeparator
-        );
-        return parts[0] + Package.fqnSeparator + parts[1] + Package.fqnSeparator + directoryPart;
-    }
-
     @Override
     public String getModuleName() {
         return moduleName;
@@ -171,7 +154,7 @@ public String getModuleName() {
     @Override
     public String getDirectory() {
         if (directory == null) {
-            directory = "Setup/Patch/Data";
+            directory = EavAttributeDataPatchFile.DEFAULT_DIR;
         }
 
         return directory;

src/com/magento/idea/magento2plugin/actions/generation/data/SourceModelData.java

@@ -6,47 +6,16 @@
 package com.magento.idea.magento2plugin.actions.generation.data;
 
 import com.magento.idea.magento2plugin.magento.files.SourceModelFile;
-import com.magento.idea.magento2plugin.magento.packages.File;
-import com.magento.idea.magento2plugin.magento.packages.Package;
 
 public class SourceModelData {
     private String className;
-    private String namespace;
     private String moduleName;
     private String directory;
 
     public String getClassName() {
         return className;
     }
 
-    /**
-     * Constructor.
-     */
-    public String getNamespace() {
-        if (namespace == null) {
-            namespace = getDefaultSourceModelNamespace();
-        }
-
-        return namespace;
-    }
-
-    /**
-     * Provides default namespace.
-     *
-     * @return String
-     */
-    public String getDefaultSourceModelNamespace() {
-        final String[] parts = moduleName.split(Package.vendorModuleNameSeparator);
-        if (parts[0] == null || parts[1] == null || parts.length > 2) {
-            return null;
-        }
-        final String directoryPart = getDirectory().replace(
-                File.separator,
-                Package.fqnSeparator
-        );
-        return parts[0] + Package.fqnSeparator + parts[1] + Package.fqnSeparator + directoryPart;
-    }
-
     /**
      * Get default namespace.
      *
@@ -73,10 +42,6 @@ public void setClassName(final String className) {
         this.className = className;
     }
 
-    public void setNamespace(final String namespace) {
-        this.namespace = namespace;
-    }
-
     public void setModuleName(final String moduleName) {
         this.moduleName = moduleName;
     }

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

@@ -19,8 +19,12 @@
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.NotEmptyRule;
 import com.magento.idea.magento2plugin.actions.generation.generator.EavAttributeSetupPatchGenerator;
 import com.magento.idea.magento2plugin.actions.generation.generator.SourceModelGenerator;
-import com.magento.idea.magento2plugin.magento.packages.Package;
-import com.magento.idea.magento2plugin.magento.packages.eav.*;
+import com.magento.idea.magento2plugin.magento.files.SourceModelFile;
+import com.magento.idea.magento2plugin.magento.packages.eav.AttributeInput;
+import com.magento.idea.magento2plugin.magento.packages.eav.AttributeScope;
+import com.magento.idea.magento2plugin.magento.packages.eav.AttributeSourceModel;
+import com.magento.idea.magento2plugin.magento.packages.eav.AttributeType;
+import com.magento.idea.magento2plugin.magento.packages.eav.EavEntity;
 import com.magento.idea.magento2plugin.util.magento.GetModuleNameByDirectoryUtil;
 import java.awt.event.ItemEvent;
 import java.awt.event.ItemListener;
@@ -38,7 +42,12 @@
 import org.codehaus.plexus.util.StringUtils;
 import org.jetbrains.annotations.NotNull;
 
-@SuppressWarnings({"PMD.TooManyFields", "PMD.ExcessiveImports", "PMD.TooManyMethods", "PMD.UnusedPrivateField"})
+@SuppressWarnings({
+        "PMD.TooManyFields",
+        "PMD.ExcessiveImports",
+        "PMD.TooManyMethods",
+        "PMD.UnusedPrivateField"
+})
 public class NewEavAttributeDialog extends AbstractDialog {
     private final String moduleName;
     private JPanel contentPanel;
@@ -285,7 +294,9 @@ private void generateSourceModelFile() {
         final ComboBoxItemData selectedSource = (ComboBoxItemData) sourceComboBox.getSelectedItem();
 
         if (selectedSource == null
-                || !selectedSource.getText().equals(AttributeSourceModel.GENERATE_SOURCE.getSource())) {
+                || !selectedSource.getText().equals(
+                        AttributeSourceModel.GENERATE_SOURCE.getSource()
+        )) {
             return;
         }
 
@@ -332,19 +343,20 @@ private String getAttributeSource() {
         final ComboBoxItemData selectedItem = (ComboBoxItemData) sourceComboBox.getSelectedItem();
 
         if (selectedItem == null
-                || selectedItem.getText().equals(AttributeSourceModel.NULLABLE_SOURCE.getSource())) {
+                || selectedItem.getText().equals(
+                        AttributeSourceModel.NULLABLE_SOURCE.getSource()
+        )) {
             return null;
         }
 
         if (selectedItem.getText().equals(AttributeSourceModel.GENERATE_SOURCE.getSource())
                 && sourceModelData != null) {
 
-            return String.join(
-                    Package.fqnSeparator,
-                    "",
-                    sourceModelData.getNamespace(),
-                    sourceModelData.getClassName()
-            );
+            return "\\" + new SourceModelFile(
+                    sourceModelData.getModuleName(),
+                    sourceModelData.getClassName(),
+                    sourceModelData.getDirectory()
+            ).getClassFqn();
         }
 
         return sourceComboBox.getSelectedItem().toString();
@@ -361,7 +373,8 @@ private String getAttributeScope() {
     }
 
     private String getAttributeInput() {
-        final ComboBoxItemData selectedAttributeInput = (ComboBoxItemData) inputComboBox.getSelectedItem();
+        final ComboBoxItemData selectedAttributeInput =
+                (ComboBoxItemData) inputComboBox.getSelectedItem();
 
         if (selectedAttributeInput != null) {
             return selectedAttributeInput.getText().trim();

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

@@ -60,7 +60,7 @@ protected void fillAttributes(final Properties attributes) {
 
         phpClassTypesBuilder
                 .appendProperty("CLASS_NAME", data.getDataPatchName())
-                .appendProperty("NAMESPACE", data.getNamespace())
+                .appendProperty("NAMESPACE", this.getFile().getNamespace())
                 .appendProperty("ENTITY_CLASS", data.getEntityClass())
                 .appendProperty("ATTRIBUTE_CODE", data.getCode())
                 .appendProperty("ATTRIBUTE_SET", String.join(",", getAttributesList(data)))

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

@@ -64,7 +64,7 @@ protected void fillAttributes(final Properties attributes) {
         uses.add(abstractSourceClass);
 
         attributes.setProperty("NAME", data.getClassName());
-        attributes.setProperty("NAMESPACE", data.getNamespace());
+        attributes.setProperty("NAMESPACE", this.getFile().getNamespace());
         attributes.setProperty(
                 "EXTENDS",
                 PhpClassGeneratorUtil.getNameFromFqn(abstractSourceClass)

src/com/magento/idea/magento2plugin/actions/generation/generator/util/eav/ProductAttributeMapper.java

@@ -50,12 +50,8 @@ private Map<String, String> getMappedAttributes(final ProductEntityData eavEntit
                 wrapStringValueForTemplate(eavEntityData.getLabel()));
         mappedAttributes.put(EavAttribute.INPUT.getAttribute(),
                 wrapStringValueForTemplate(eavEntityData.getInput()));
-
-        final String eavSource = eavEntityData.getSource();
         mappedAttributes.put(EavAttribute.SOURCE.getAttribute(),
-                eavSource == null || eavSource.equals(AttributeSourceModel.NULLABLE_SOURCE.getSource())
-                        ? null : eavSource + "::class");
-
+                getEntitySource(eavEntityData));
         mappedAttributes.put(EavAttribute.REQUIRED.getAttribute(),
                 Boolean.toString(eavEntityData.isRequired()));
         mappedAttributes.put(EavAttribute.SORT_ORDER.getAttribute(),
@@ -81,4 +77,13 @@ private Map<String, String> getMappedAttributes(final ProductEntityData eavEntit
     private String wrapStringValueForTemplate(final String value) {
         return "'" + value + "'";
     }
+
+
+    private String getEntitySource(final ProductEntityData eavEntityData) {
+        final String eavSource = eavEntityData.getSource();
+
+        return eavSource == null
+                || eavSource.equals(AttributeSourceModel.NULLABLE_SOURCE.getSource())
+                ? null : eavSource + "::class";
+    }
 }

testData/actions/generation/generator/SourceModelGenerator/generateFile/CustomSourceModel.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Foo\Bar\Setup\Patch\Data;
+namespace Foo\Bar\Model\Source;
 
 use Magento\Eav\Model\Entity\Attribute\Source\AbstractSource;
 

testData/actions/generation/generator/SourceModelGenerator/generateFileInCustomDirectory/CustomSourceModel.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Foo\Bar\Custom\Source\Directory;
+
+use Magento\Eav\Model\Entity\Attribute\Source\AbstractSource;
+
+class CustomSourceModel extends AbstractSource
+{
+    /**
+     * Retrieve All options
+     *
+     * @return array
+     */
+    public function getAllOptions(): array
+    {
+        // TODO: Implement getAllOptions() method.
+    }
+}

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

@@ -12,7 +12,6 @@
 
 public class EavAttributeSetupPatchGeneratorTest extends BaseGeneratorTestCase {
     private final static String MODULE_NAME = "Foo_Bar";
-    private final static String DATA_PATCH_NAMESPACE = "Foo\\Bar\\Setup\\Patch\\Data";
 
     /**
      * Test Data patch for product's eav attribute generator.
@@ -37,7 +36,6 @@ public void testGenerateFile() {
         productEntityData.setGroup("General");
 
         productEntityData.setDataPatchName("AddTestAttribute");
-        productEntityData.setNamespace(DATA_PATCH_NAMESPACE);
         productEntityData.setModuleName(MODULE_NAME);
 
         final EavAttributeSetupPatchGenerator setupPatchGenerator =
@@ -71,7 +69,6 @@ public void testGenerateFileWithBooleanSourceModel() {
         productEntityData.setGroup("General");
 
         productEntityData.setDataPatchName("AddBooleanInputAttributeAttribute");
-        productEntityData.setNamespace(DATA_PATCH_NAMESPACE);
         productEntityData.setModuleName(MODULE_NAME);
 
         final EavAttributeSetupPatchGenerator setupPatchGenerator =
@@ -105,7 +102,6 @@ public void testGenerateFileWithGeneratedSourceModel() {
         productEntityData.setGroup("General");
 
         productEntityData.setDataPatchName("AddAttributeWithCustomSourceAttribute");
-        productEntityData.setNamespace(DATA_PATCH_NAMESPACE);
         productEntityData.setModuleName(MODULE_NAME);
 
         final EavAttributeSetupPatchGenerator setupPatchGenerator =

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

@@ -11,18 +11,16 @@
 
 public class SourceModelGeneratorTest extends BaseGeneratorTestCase {
     private final static String MODULE_NAME = "Foo_Bar";
-    private final static String SOURCE_MODEL_NAMESPACE = "Foo\\Bar\\Setup\\Patch\\Data";
 
     /**
-     * Test Data patch for product's eav attribute generator.
+     * Test source model generation
      */
     public void testGenerateFile() {
         final Project project = myFixture.getProject();
 
         final SourceModelData sourceModelData = new SourceModelData();
         sourceModelData.setClassName("CustomSourceModel");
         sourceModelData.setModuleName(MODULE_NAME);
-        sourceModelData.setNamespace(SOURCE_MODEL_NAMESPACE);
 
         final SourceModelGenerator sourceModelGeneratorGenerator =
                 new SourceModelGenerator(sourceModelData, project);
@@ -36,4 +34,28 @@ public void testGenerateFile() {
                 dataPatchFile
         );
     }
+
+    /**
+     * Test source model in custom directory generation
+     */
+    public void testGenerateFileInCustomDirectory() {
+        final Project project = myFixture.getProject();
+
+        final SourceModelData sourceModelData = new SourceModelData();
+        sourceModelData.setClassName("CustomSourceModel");
+        sourceModelData.setModuleName(MODULE_NAME);
+        sourceModelData.setDirectory("Custom/Source/Directory");
+
+        final SourceModelGenerator sourceModelGeneratorGenerator =
+                new SourceModelGenerator(sourceModelData, project);
+        final PsiFile dataPatchFile = sourceModelGeneratorGenerator.generate("test custom dir");
+        final String filePatch = this.getFixturePath("CustomSourceModel.php");
+        final PsiFile expectedFile = myFixture.configureByFile(filePatch);
+
+        assertGeneratedFileIsCorrect(
+                expectedFile,
+                "src/app/code/Foo/Bar/Custom/Source/Directory",
+                dataPatchFile
+        );
+    }
 }