Merge branch 'mainline-eav-attr-code-genearators' into 545-attribute-options

ProkopovVitaliy · ProkopovVitaliy · commit d5e2476a0d51 · 2021-04-15T10:59:48.000+03:00
# Conflicts:
#	resources/fileTemplates/internal/Magento Eav Attribute Data Patch Class.php.ft
#	src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEavAttributeDialog.form
#	src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEavAttributeDialog.java
#	src/com/magento/idea/magento2plugin/actions/generation/generator/util/eav/ProductAttributeMapper.java
#	src/com/magento/idea/magento2plugin/magento/packages/eav/EavAttribute.java
#	tests/com/magento/idea/magento2plugin/actions/generation/generator/EavAttributeSetupPatchGeneratorTest.java
diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml
@@ -141,6 +141,7 @@
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.xml.MenuIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.xml.DeclarativeSchemaElementsIndex" />
         <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.xml.UIComponentIndex" />
+        <fileBasedIndex implementation="com.magento.idea.magento2plugin.stubs.indexes.xml.ProductTypeIndex" />
 
         <codeInsight.lineMarkerProvider language="PHP" implementationClass="com.magento.idea.magento2plugin.linemarker.php.PluginLineMarkerProvider"/>
         <codeInsight.lineMarkerProvider language="PHP" implementationClass="com.magento.idea.magento2plugin.linemarker.php.PluginTargetLineMarkerProvider"/>
diff --git a/resources/magento2/validation.properties b/resources/magento2/validation.properties
@@ -37,3 +37,4 @@ validator.db.invalidTableNameLength=Table name must contain up to 64 characters
 validator.lowerSnakeCase=The {0} field must be of the lower snake case format
 validator.menuIdentifierInvalid=The menu identifier is invalid
 validator.someFieldsHaveErrors=Please, check the dialog. Some fields have errors
+validator.commaSeparatedString.isNotValid=The {0} field must contain comma separated string without whitespaces
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/data/EavEntityDataInterface.java b/src/com/magento/idea/magento2plugin/actions/generation/data/EavEntityDataInterface.java
@@ -19,4 +19,6 @@ public interface EavEntityDataInterface {
     public String getDataPatchName();
 
     public String getEntityClass();
+
+    public String getSource();
 }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/data/ProductEntityData.java b/src/com/magento/idea/magento2plugin/actions/generation/data/ProductEntityData.java
@@ -18,6 +18,7 @@ public class ProductEntityData implements EavEntityDataInterface {
     private String input;
     private String source;
     private String scope;
+    private String applyTo;
     private boolean required;
     private boolean usedInGrid;
     private boolean visibleInGrid;
@@ -76,6 +77,10 @@ public void setScope(final String scope) {
         this.scope = scope;
     }
 
+    public void setApplyTo(final String applyTo) {
+        this.applyTo = applyTo;
+    }
+
     public void setRequired(final boolean required) {
         this.required = required;
     }
@@ -193,6 +198,7 @@ public String getGroup() {
         return group;
     }
 
+    @Override
     public String getSource() {
         return source;
     }
@@ -201,6 +207,10 @@ public String getScope() {
         return scope;
     }
 
+    public String getApplyTo() {
+        return applyTo;
+    }
+
     public boolean isRequired() {
         return required;
     }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEavAttributeDialog.form b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEavAttributeDialog.form
@@ -3,15 +3,15 @@
   <grid id="28350" binding="contentPanel" layout-manager="GridLayoutManager" row-count="4" column-count="1" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
     <margin top="10" left="10" bottom="10" right="10"/>
     <constraints>
-      <xy x="-1" y="5" width="870" height="790"/>
+      <xy x="-1" y="5" width="764" height="763"/>
     </constraints>
     <properties>
       <enabled value="true"/>
       <preferredSize width="800" height="800"/>
     </properties>
     <border type="none"/>
     <children>
-      <grid id="6fc7e" layout-manager="GridLayoutManager" row-count="16" column-count="3" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
+      <grid id="6fc7e" layout-manager="GridLayoutManager" row-count="17" column-count="3" 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"/>
@@ -322,6 +322,53 @@
               </component>
             </children>
           </grid>
+          <component id="64ef9" class="javax.swing.JCheckBox" binding="applyToAllProductsCheckBox">
+            <constraints>
+              <grid row="5" column="2" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+            </constraints>
+            <properties>
+              <selected value="true"/>
+              <text value="Apply to all products types"/>
+            </properties>
+          </component>
+          <grid id="27880" binding="applyToPanel" layout-manager="GridLayoutManager" row-count="1" 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="16" column="0" row-span="1" col-span="3" vsize-policy="3" hsize-policy="3" anchor="0" fill="3" indent="0" use-parent-layout="false"/>
+            </constraints>
+            <properties>
+              <visible value="false"/>
+            </properties>
+            <border type="none"/>
+            <children>
+              <component id="b41e7" class="javax.swing.JLabel">
+                <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="144" height="15"/>
+                  </grid>
+                </constraints>
+                <properties>
+                  <text value="Apply to"/>
+                  <toolTipText value=""/>
+                </properties>
+              </component>
+              <scrollpane id="f0efd">
+                <constraints>
+                  <grid row="0" column="1" row-span="1" col-span="1" vsize-policy="7" hsize-policy="7" anchor="0" fill="3" indent="0" use-parent-layout="false"/>
+                </constraints>
+                <properties/>
+                <border type="none"/>
+                <children>
+                  <component id="9e8b9" class="javax.swing.JList" binding="productsTypesList">
+                    <constraints/>
+                    <properties>
+                      <enabled value="true"/>
+                    </properties>
+                  </component>
+                </children>
+              </scrollpane>
+            </children>
+          </grid>
         </children>
       </grid>
       <hspacer id="75d92">
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEavAttributeDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/NewEavAttributeDialog.java
@@ -12,12 +12,14 @@
 import com.magento.idea.magento2plugin.actions.generation.data.ProductEntityData;
 import com.magento.idea.magento2plugin.actions.generation.data.SourceModelData;
 import com.magento.idea.magento2plugin.actions.generation.data.ui.ComboBoxItemData;
+import com.magento.idea.magento2plugin.actions.generation.dialog.event.ApplyToVisibleListener;
 import com.magento.idea.magento2plugin.actions.generation.dialog.event.AttributeSourcePanelComponentListener;
 import com.magento.idea.magento2plugin.actions.generation.dialog.event.AttributeSourceRelationsItemListener;
 import com.magento.idea.magento2plugin.actions.generation.dialog.event.EavAttributeInputItemListener;
 import com.magento.idea.magento2plugin.actions.generation.dialog.event.OptionsPanelVisibilityChangeListener;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.annotation.FieldValidation;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.annotation.RuleRegistry;
+import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.CommaSeparatedStringRule;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.Lowercase;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.NotEmptyRule;
 import com.magento.idea.magento2plugin.actions.generation.generator.EavAttributeSetupPatchGenerator;
@@ -31,17 +33,20 @@
 import com.magento.idea.magento2plugin.magento.packages.eav.EavEntity;
 import com.magento.idea.magento2plugin.ui.table.TableGroupWrapper;
 import com.magento.idea.magento2plugin.util.magento.GetModuleNameByDirectoryUtil;
+import com.magento.idea.magento2plugin.util.magento.GetProductTypesListUtil;
 import java.awt.event.KeyEvent;
 import java.awt.event.WindowAdapter;
 import java.awt.event.WindowEvent;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
+import javax.swing.DefaultListModel;
 import javax.swing.JButton;
 import javax.swing.JCheckBox;
 import javax.swing.JComboBox;
 import javax.swing.JComponent;
+import javax.swing.JList;
 import javax.swing.JPanel;
 import javax.swing.JTable;
 import javax.swing.JTextField;
@@ -103,6 +108,11 @@ public class NewEavAttributeDialog extends AbstractDialog {
     private JTable optionTable;
     private JButton addOptionButton;
     private JPanel optionsPanel;
+    @FieldValidation(rule = RuleRegistry.COMMA_SEPARATED_STRING,
+            message = {CommaSeparatedStringRule.MESSAGE, "Apply To"})
+    private JCheckBox applyToAllProductsCheckBox;
+    private JPanel applyToPanel;
+    private JList productsTypesList;
     private final Project project;
     private final SourceModelData sourceModelData;
     private TableGroupWrapper entityPropertiesTableGroupWrapper;
@@ -126,6 +136,9 @@ public NewEavAttributeDialog(final Project project, final PsiDirectory directory
         addActionListenersForButtons();
         addCancelActionForWindow();
         addCancelActionForEsc();
+        addApplyToVisibilityAction();
+        fillEntityComboBoxes();
+        fillProductsTypesList();
         addDependBetweenInputAndSourceModel();
         addOptionPanelListener();
         setAutocompleteListenerForAttributeCodeField();
@@ -148,6 +161,19 @@ private void initPropertiesTable() {
         entityPropertiesTableGroupWrapper.initTableGroup();
     }
 
+    private void fillProductsTypesList() {
+        final List<String> productTypes = GetProductTypesListUtil.execute(project);
+
+        final DefaultListModel<String> listModel = new DefaultListModel<>();
+        listModel.addAll(productTypes);
+        productsTypesList.setModel(listModel);
+        productsTypesList.setSelectedIndex(0);
+    }
+
+    private void addApplyToVisibilityAction() {
+        applyToAllProductsCheckBox.addChangeListener(new ApplyToVisibleListener(applyToPanel));
+    }
+
     @SuppressWarnings("PMD.AccessorMethodGeneration")
     private void addDependBetweenInputAndSourceModel() {
         inputComboBox.addItemListener(
@@ -368,6 +394,12 @@ private ProductEntityData populateProductEntityData(final ProductEntityData prod
         productEntityData.setOptionsSortOrder(GetAttributeOptionPropertiesUtil.getSortOrders(
                 entityPropertiesTableGroupWrapper.getColumnsData()));
 
+        if (!applyToAllProductsCheckBox.isSelected()) {
+            productEntityData.setApplyTo(
+                    String.join(",", productsTypesList.getSelectedValuesList())
+            );
+        }
+
         return productEntityData;
     }
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/event/ApplyToVisibleListener.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/event/ApplyToVisibleListener.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.actions.generation.dialog.event;
+
+import javax.swing.JCheckBox;
+import javax.swing.JPanel;
+import javax.swing.event.ChangeEvent;
+import javax.swing.event.ChangeListener;
+import org.jetbrains.annotations.NotNull;
+
+public class ApplyToVisibleListener implements ChangeListener {
+
+    private final JPanel applyToPanel;
+
+    public ApplyToVisibleListener(@NotNull final JPanel applyToPanel) {
+        this.applyToPanel = applyToPanel;
+    }
+
+    @Override
+    public void stateChanged(final ChangeEvent changeEvent) {
+        final JCheckBox checkBox = (JCheckBox) changeEvent.getSource();
+
+        if (checkBox.isSelected()) {
+            applyToPanel.setVisible(false);
+        } else {
+            applyToPanel.setVisible(true);
+        }
+    }
+}
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/annotation/RuleRegistry.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/annotation/RuleRegistry.java
@@ -12,6 +12,7 @@
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.AlphanumericWithUnderscoreRule;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.BoxNotEmptyRule;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.CliCommandRule;
+import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.CommaSeparatedStringRule;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.ConfigPathRule;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.CronScheduleRule;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.DirectoryRule;
@@ -52,7 +53,8 @@ public enum RuleRegistry {
     CLI_COMMAND(CliCommandRule.class),
     NUMERIC(NumericRule.class),
     TABLE_NAME_LENGTH(TableNameLength.class),
-    MENU_IDENTIFIER(MenuIdentifierRule.class);
+    MENU_IDENTIFIER(MenuIdentifierRule.class),
+    COMMA_SEPARATED_STRING(CommaSeparatedStringRule.class);
 
     private Class<?> rule;
 
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/CommaSeparatedStringRule.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/rule/CommaSeparatedStringRule.java
@@ -0,0 +1,22 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule;
+
+import com.magento.idea.magento2plugin.util.RegExUtil;
+
+public class CommaSeparatedStringRule implements ValidationRule {
+    public static final String MESSAGE = "validator.commaSeparatedString.isNotValid";
+    private static final ValidationRule INSTANCE = new CommaSeparatedStringRule();
+
+    @Override
+    public boolean check(final String value) {
+        return value.isEmpty() || value.matches(RegExUtil.Magento.COMMA_SEPARATED_STRING);
+    }
+
+    public static ValidationRule getInstance() {
+        return INSTANCE;
+    }
+}
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/util/eav/ProductAttributeMapper.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/util/eav/ProductAttributeMapper.java
@@ -80,6 +80,11 @@ private Map<String, String> getMappedAttributes(final ProductEntityData eavEntit
                     getMappedOptions(eavEntityData.getOptions(), eavEntityData.getOptionsSortOrder()));
         }
 
+        if (eavEntityData.getApplyTo() != null && !eavEntityData.getApplyTo().isEmpty()) {
+            mappedAttributes.put(EavAttribute.APPLY_TO.getAttribute(),
+                    wrapStringValueForTemplate(eavEntityData.getApplyTo()));
+        }
+
         return mappedAttributes;
     }
 
diff --git a/src/com/magento/idea/magento2plugin/indexes/IndexManager.java b/src/com/magento/idea/magento2plugin/indexes/IndexManager.java
@@ -28,6 +28,7 @@
 import com.magento.idea.magento2plugin.stubs.indexes.xml.DeclarativeSchemaElementsIndex;
 import com.magento.idea.magento2plugin.stubs.indexes.xml.MenuIndex;
 import com.magento.idea.magento2plugin.stubs.indexes.xml.PhpClassNameIndex;
+import com.magento.idea.magento2plugin.stubs.indexes.xml.ProductTypeIndex;
 import com.magento.idea.magento2plugin.stubs.indexes.xml.UIComponentIndex;
 
 @SuppressWarnings({"PMD.ClassNamingConventions", "PMD.UseUtilityClass"})
@@ -69,7 +70,9 @@ public static void manualReindex() {
             SectionIndex.KEY,
             TestNameIndex.KEY,
             //graphql
-            GraphQlResolverIndex.KEY
+            GraphQlResolverIndex.KEY,
+            //product types
+            ProductTypeIndex.KEY
         };
 
         for (final ID<?, ?> id: indexIds) {
diff --git a/src/com/magento/idea/magento2plugin/magento/files/ProductTypeXml.java b/src/com/magento/idea/magento2plugin/magento/files/ProductTypeXml.java
@@ -0,0 +1,33 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.magento.files;
+
+import com.intellij.lang.Language;
+import com.intellij.lang.xml.XMLLanguage;
+
+public class ProductTypeXml implements ModuleFileInterface {
+    public static final String FILE_NAME = "product_types.xml";
+    public static final String TEMPLATE = "Magento Product Types";
+
+    //attributes
+    public static final String XML_TAG_TYPE = "type";
+    public static final String XML_ATTRIBUTE_NAME = "name";
+
+    @Override
+    public String getFileName() {
+        return FILE_NAME;
+    }
+
+    @Override
+    public String getTemplate() {
+        return TEMPLATE;
+    }
+
+    @Override
+    public Language getLanguage() {
+        return XMLLanguage.INSTANCE;
+    }
+}
diff --git a/src/com/magento/idea/magento2plugin/magento/packages/eav/EavAttribute.java b/src/com/magento/idea/magento2plugin/magento/packages/eav/EavAttribute.java
@@ -20,6 +20,7 @@ public enum EavAttribute {
     VISIBLE("visible"),
     IS_HTML_ALLOWED_ON_FRONT("is_html_allowed_on_front"),
     VISIBLE_ON_FRONT("visible_on_front"),
+    APPLY_TO("apply_to"),
     OPTION("option");
 
     private String attribute;
diff --git a/src/com/magento/idea/magento2plugin/stubs/indexes/xml/ProductTypeIndex.java b/src/com/magento/idea/magento2plugin/stubs/indexes/xml/ProductTypeIndex.java
diff --git a/src/com/magento/idea/magento2plugin/util/RegExUtil.java b/src/com/magento/idea/magento2plugin/util/RegExUtil.java
diff --git a/src/com/magento/idea/magento2plugin/util/magento/GetProductTypesListUtil.java b/src/com/magento/idea/magento2plugin/util/magento/GetProductTypesListUtil.java
diff --git a/testData/actions/generation/generator/EavAttributeSetupPatchGenerator/generateFileWithApplyToAttribute/AddAppliedToAttribute.php b/testData/actions/generation/generator/EavAttributeSetupPatchGenerator/generateFileWithApplyToAttribute/AddAppliedToAttribute.php
diff --git a/tests/com/magento/idea/magento2plugin/actions/generation/generator/EavAttributeSetupPatchGeneratorTest.java b/tests/com/magento/idea/magento2plugin/actions/generation/generator/EavAttributeSetupPatchGeneratorTest.java

Original file line number	Diff line number	Diff line change
`@@ -19,4 +19,6 @@ public interface EavEntityDataInterface {`
`19`	`19`	`public String getDataPatchName();`
`20`	`20`
`21`	`21`	`public String getEntityClass();`
	`22`	`+`
	`23`	`+ public String getSource();`
`22`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ public class ProductEntityData implements EavEntityDataInterface {`
`18`	`18`	`private String input;`
`19`	`19`	`private String source;`
`20`	`20`	`private String scope;`
	`21`	`+ private String applyTo;`
`21`	`22`	`private boolean required;`
`22`	`23`	`private boolean usedInGrid;`
`23`	`24`	`private boolean visibleInGrid;`
`@@ -76,6 +77,10 @@ public void setScope(final String scope) {`
`76`	`77`	`this.scope = scope;`
`77`	`78`	`}`
`78`	`79`
	`80`	`+ public void setApplyTo(final String applyTo) {`
	`81`	`+ this.applyTo = applyTo;`
	`82`	`+ }`
	`83`	`+`
`79`	`84`	`public void setRequired(final boolean required) {`
`80`	`85`	`this.required = required;`
`81`	`86`	`}`
`@@ -193,6 +198,7 @@ public String getGroup() {`
`193`	`198`	`return group;`
`194`	`199`	`}`
`195`	`200`
	`201`	`+ @Override`
`196`	`202`	`public String getSource() {`
`197`	`203`	`return source;`
`198`	`204`	`}`
`@@ -201,6 +207,10 @@ public String getScope() {`
`201`	`207`	`return scope;`
`202`	`208`	`}`
`203`	`209`
	`210`	`+ public String getApplyTo() {`
	`211`	`+ return applyTo;`
	`212`	`+ }`
	`213`	`+`
`204`	`214`	`public boolean isRequired() {`
`205`	`215`	`return required;`
`206`	`216`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,6 +80,11 @@ private Map<String, String> getMappedAttributes(final ProductEntityData eavEntit`
`80`	`80`	`getMappedOptions(eavEntityData.getOptions(), eavEntityData.getOptionsSortOrder()));`
`81`	`81`	`}`
`82`	`82`
	`83`	`+ if (eavEntityData.getApplyTo() != null && !eavEntityData.getApplyTo().isEmpty()) {`
	`84`	`+ mappedAttributes.put(EavAttribute.APPLY_TO.getAttribute(),`
	`85`	`+ wrapStringValueForTemplate(eavEntityData.getApplyTo()));`
	`86`	`+ }`
	`87`	`+`
`83`	`88`	`return mappedAttributes;`
`84`	`89`	`}`
`85`	`90`