Added apply_to property for attribute generation

ProkopovVitaliy · ProkopovVitaliy · commit 4fa88f815358 · 2021-04-12T12:49:25.000+03:00
diff --git a/resources/fileTemplates/internal/Magento Eav Attribute Data Patch Class.php.ft b/resources/fileTemplates/internal/Magento Eav Attribute Data Patch Class.php.ft
@@ -82,7 +82,7 @@ class ${CLASS_NAME} implements ${IMPLEMENTS} {
         '${ATTRIBUTE_CODE}',
             [
             #set ($attributeSet = ${ATTRIBUTE_SET})
-            #foreach ($attribute in $attributeSet.split(","))
+            #foreach ($attribute in $attributeSet.split("->"))
                 $attribute,
             #end
 ]
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
@@ -17,6 +17,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;
@@ -73,6 +74,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;
     }
@@ -174,6 +179,7 @@ public String getGroup() {
         return group;
     }
 
+    @Override
     public String getSource() {
         return source;
     }
@@ -182,6 +188,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="3" 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="659"/>
+      <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,57 @@
               </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="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="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="148" height="15"/>
+                  </grid>
+                </constraints>
+                <properties>
+                  <text value="Apply to"/>
+                  <toolTipText value=""/>
+                </properties>
+              </component>
+              <component id="fffe8" class="javax.swing.JTextField" binding="applyToTextField">
+                <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>
+                </constraints>
+                <properties/>
+              </component>
+              <component id="fbc8d" class="javax.swing.JTextPane" binding="applyToRecommendationTextPanel">
+                <constraints>
+                  <grid row="1" column="1" row-span="1" col-span="1" vsize-policy="6" hsize-policy="6" anchor="0" fill="3" indent="0" use-parent-layout="false">
+                    <preferred-size width="150" height="-1"/>
+                  </grid>
+                </constraints>
+                <properties>
+                  <text value="Enter comma separated product types for which attribute will available, for example: simple,configurable,bundle,virtual,downloadable,category. Or leave this property blank if you want apply attribute for all product types."/>
+                  <toolTipText value=""/>
+                </properties>
+              </component>
+            </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,9 +12,11 @@
 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.EavAttributeInputItemListener;
 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;
@@ -37,6 +39,7 @@
 import javax.swing.JComponent;
 import javax.swing.JPanel;
 import javax.swing.JTextField;
+import javax.swing.JTextPane;
 import javax.swing.KeyStroke;
 import javax.swing.event.DocumentEvent;
 import org.codehaus.plexus.util.StringUtils;
@@ -92,6 +95,12 @@ public class NewEavAttributeDialog extends AbstractDialog {
     @FieldValidation(rule = RuleRegistry.NOT_EMPTY,
             message = {NotEmptyRule.MESSAGE, "Source Model Name"})
     private JTextField sourceModelNameTexField;
+    @FieldValidation(rule = RuleRegistry.COMMA_SEPARATED_STRING,
+            message = {CommaSeparatedStringRule.MESSAGE, "Apply To"})
+    private JTextField applyToTextField;
+    private JCheckBox applyToAllProductsCheckBox;
+    private JPanel applyToPanel;
+    private JTextPane applyToRecommendationTextPanel;
     private final Project project;
     private final SourceModelData sourceModelData;
 
@@ -112,12 +121,17 @@ public NewEavAttributeDialog(final Project project, final PsiDirectory directory
         addActionListenersForButtons();
         addCancelActionForWindow();
         addCancelActionForEsc();
+        addApplyToVisibilityAction();
         setAutocompleteListenerForAttributeCodeField();
         fillEntityComboBoxes();
         addDependBetweenInputAndSourceModel();
         setDefaultSources();
     }
 
+    private void addApplyToVisibilityAction() {
+        applyToAllProductsCheckBox.addChangeListener(new ApplyToVisibleListener(applyToPanel));
+    }
+
     @SuppressWarnings("PMD.AccessorMethodGeneration")
     private void addDependBetweenInputAndSourceModel() {
         inputComboBox.addItemListener(
@@ -295,7 +309,7 @@ private void generateSourceModelFile() {
 
         if (selectedSource == null
                 || !selectedSource.getText().equals(
-                        AttributeSourceModel.GENERATE_SOURCE.getSource()
+                AttributeSourceModel.GENERATE_SOURCE.getSource()
         )) {
             return;
         }
@@ -336,6 +350,10 @@ private ProductEntityData populateProductEntityData(final ProductEntityData prod
         productEntityData.setScope(getAttributeScope());
         productEntityData.setSource(getAttributeSource());
 
+        if (!applyToAllProductsCheckBox.isSelected()) {
+            productEntityData.setApplyTo(applyToTextField.getText().trim());
+        }
+
         return productEntityData;
     }
 
@@ -344,7 +362,7 @@ private String getAttributeSource() {
 
         if (selectedItem == null
                 || selectedItem.getText().equals(
-                        AttributeSourceModel.NULLABLE_SOURCE.getSource()
+                AttributeSourceModel.NULLABLE_SOURCE.getSource()
         )) {
             return null;
         }
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/EavAttributeSetupPatchGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/EavAttributeSetupPatchGenerator.java
@@ -63,7 +63,7 @@ protected void fillAttributes(final Properties attributes) {
                 .appendProperty("NAMESPACE", this.getFile().getNamespace())
                 .appendProperty("ENTITY_CLASS", data.getEntityClass())
                 .appendProperty("ATTRIBUTE_CODE", data.getCode())
-                .appendProperty("ATTRIBUTE_SET", String.join(",", getAttributesList(data)))
+                .appendProperty("ATTRIBUTE_SET", String.join("->", getAttributesList(data)))
                 .append(
                         "IMPLEMENTS",
                         DataPatchDependency.DATA_PATCH_INTERFACE.getClassPatch()
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
@@ -71,6 +71,11 @@ private Map<String, String> getMappedAttributes(final ProductEntityData eavEntit
         mappedAttributes.put(EavAttribute.VISIBLE_ON_FRONT.getAttribute(),
                 Boolean.toString(eavEntityData.isVisibleOnFront()));
 
+        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/magento/packages/eav/EavAttribute.java b/src/com/magento/idea/magento2plugin/magento/packages/eav/EavAttribute.java
@@ -19,7 +19,8 @@ public enum EavAttribute {
     IS_FILTERABLE_IN_GRID("is_filterable_in_grid"),
     VISIBLE("visible"),
     IS_HTML_ALLOWED_ON_FRONT("is_html_allowed_on_front"),
-    VISIBLE_ON_FRONT("visible_on_front");
+    VISIBLE_ON_FRONT("visible_on_front"),
+    APPLY_TO("apply_to");
 
     private String attribute;
 
diff --git a/src/com/magento/idea/magento2plugin/util/RegExUtil.java b/src/com/magento/idea/magento2plugin/util/RegExUtil.java
@@ -68,6 +68,9 @@ public static class Magento {
 
         public static final String XML_IDENTIFIER =
                 "^([A-Z]+[a-zA-Z0-9]{1,}){1,}_[A-Z]+[A-Z0-9a-z]{1,}::[A-Za-z_0-9]{1,}$";
+
+        public static final String COMMA_SEPARATED_STRING =
+                "^[^\\s,]+(?:,\\s*[^\\s,]+)*$";
     }
 
     public class PhpRegex {

Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ class ${CLASS_NAME} implements ${IMPLEMENTS} {`
`82`	`82`	`'${ATTRIBUTE_CODE}',`
`83`	`83`	`[`
`84`	`84`	`#set ($attributeSet = ${ATTRIBUTE_SET})`
`85`		`- #foreach ($attribute in $attributeSet.split(","))`
	`85`	`+ #foreach ($attribute in $attributeSet.split("->"))`
`86`	`86`	`$attribute,`
`87`	`87`	`#end`
`88`	`88`	`]`
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
`@@ -17,6 +17,7 @@ public class ProductEntityData implements EavEntityDataInterface {`
`17`	`17`	`private String input;`
`18`	`18`	`private String source;`
`19`	`19`	`private String scope;`
	`20`	`+ private String applyTo;`
`20`	`21`	`private boolean required;`
`21`	`22`	`private boolean usedInGrid;`
`22`	`23`	`private boolean visibleInGrid;`
`@@ -73,6 +74,10 @@ public void setScope(final String scope) {`
`73`	`74`	`this.scope = scope;`
`74`	`75`	`}`
`75`	`76`
	`77`	`+ public void setApplyTo(final String applyTo) {`
	`78`	`+ this.applyTo = applyTo;`
	`79`	`+ }`
	`80`	`+`
`76`	`81`	`public void setRequired(final boolean required) {`
`77`	`82`	`this.required = required;`
`78`	`83`	`}`
`@@ -174,6 +179,7 @@ public String getGroup() {`
`174`	`179`	`return group;`
`175`	`180`	`}`
`176`	`181`
	`182`	`+ @Override`
`177`	`183`	`public String getSource() {`
`178`	`184`	`return source;`
`179`	`185`	`}`
`@@ -182,6 +188,10 @@ public String getScope() {`
`182`	`188`	`return scope;`
`183`	`189`	`}`
`184`	`190`
	`191`	`+ public String getApplyTo() {`
	`192`	`+ return applyTo;`
	`193`	`+ }`
	`194`	`+`
`185`	`195`	`public boolean isRequired() {`
`186`	`196`	`return required;`
`187`	`197`	`}`