Merge pull request #338 from drpayyne/issue-296

Changed validator for NewCLICommandDialog

Author: coderimus

resources/magento2/validation.properties

@@ -12,6 +12,7 @@ validator.class.shouldBeUnique=Duplicated class {0}
 validator.namespace.isNotValid=The {0} is not valid namespace name
 validator.directory.isNotValid={0} is not valid
 validator.directory.php.isNotValid=The {0} field does not contain a valid PHP directory
+validator.command.isNotValid=The {0} field does not contain a valid Magento 2 CLI command
 validator.module.noSuchModule=No such module {0}
 validator.file.alreadyExists={0} already exists
 validator.file.cantBeCreated={0} can't be created

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

@@ -26,6 +26,7 @@
 import javax.swing.JComponent;
 import javax.swing.JDialog;
 import javax.swing.JOptionPane;
+import javax.swing.JTextArea;
 import javax.swing.JTextField;
 
 /**
@@ -185,6 +186,8 @@ private String resolveFieldValueByComponentType(final Object field) {
             return ((JTextField) field).getText();
         } else if (field instanceof JComboBox) {
             return ((JComboBox) field).getSelectedItem().toString();
+        } else if (field instanceof JTextArea) {
+            return ((JTextArea) field).getText();
         }
         return null;
     }

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

@@ -7,14 +7,22 @@
 
 import com.intellij.openapi.project.Project;
 import com.intellij.psi.PsiDirectory;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.actions.generation.NewCLICommandAction;
 import com.magento.idea.magento2plugin.actions.generation.data.CLICommandClassData;
 import com.magento.idea.magento2plugin.actions.generation.data.CLICommandXmlData;
-import com.magento.idea.magento2plugin.actions.generation.dialog.validator.NewCLICommandValidator;
+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.CliCommandRule;
+import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.DirectoryRule;
+import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.NotEmptyRule;
+import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.PhpClassRule;
 import com.magento.idea.magento2plugin.actions.generation.generator.CLICommandClassGenerator;
 import com.magento.idea.magento2plugin.actions.generation.generator.CLICommandDiXmlGenerator;
 import com.magento.idea.magento2plugin.actions.generation.generator.util.NamespaceBuilder;
+import com.magento.idea.magento2plugin.bundles.CommonBundle;
 import com.magento.idea.magento2plugin.util.CamelCaseToSnakeCase;
+import com.magento.idea.magento2plugin.util.GetPhpClassByFQN;
 import com.magento.idea.magento2plugin.util.magento.GetModuleNameByDirectoryUtil;
 import java.awt.event.KeyEvent;
 import java.awt.event.WindowAdapter;
@@ -28,19 +36,41 @@
 import javax.swing.JTextField;
 import javax.swing.KeyStroke;
 
-@SuppressWarnings({"PMD.MissingSerialVersionUID"})
+@SuppressWarnings({"PMD.MissingSerialVersionUID", "PMD.ExcessiveImports"})
 public class NewCLICommandDialog extends AbstractDialog {
     private JPanel contentPane;
+    private JButton buttonCancel;
+    private JButton buttonOK;
+    private static final String CLASS_NAME = "class name";
+    private static final String PARENT_DIRECTORY = "parent directory";
+    private static final String COMMAND_NAME = "command name";
+    private static final String COMMAND_DESCRIPTION = "description";
+
+    @FieldValidation(rule = RuleRegistry.NOT_EMPTY,
+            message = {NotEmptyRule.MESSAGE, CLASS_NAME})
+    @FieldValidation(rule = RuleRegistry.PHP_CLASS,
+            message = {PhpClassRule.MESSAGE, CLASS_NAME})
     private JTextField cliCommandClassNameField;
+
+    @FieldValidation(rule = RuleRegistry.NOT_EMPTY,
+            message = {NotEmptyRule.MESSAGE, PARENT_DIRECTORY})
+    @FieldValidation(rule = RuleRegistry.DIRECTORY,
+            message = {DirectoryRule.MESSAGE, PARENT_DIRECTORY})
     private JTextField cliCommandParentDirectoryField;
+
+    @FieldValidation(rule = RuleRegistry.NOT_EMPTY,
+            message = {NotEmptyRule.MESSAGE, COMMAND_NAME})
+    @FieldValidation(rule = RuleRegistry.CLI_COMMAND,
+            message = {CliCommandRule.MESSAGE, COMMAND_NAME})
     private JTextField cliCommandNameField;
+
+    @FieldValidation(rule = RuleRegistry.NOT_EMPTY,
+            message = {NotEmptyRule.MESSAGE, COMMAND_DESCRIPTION})
     private JTextArea cliCommandDescriptionField;
-    private JButton buttonCancel;
-    private JButton buttonOK;
 
+    private final CommonBundle commonBundle;
     private final Project project;
     private final String moduleName;
-    private final NewCLICommandValidator validator;
     private final CamelCaseToSnakeCase toSnakeCase;
 
     /**
@@ -53,8 +83,8 @@ public NewCLICommandDialog(final Project project, final PsiDirectory directory)
         super();
         this.project = project;
         this.moduleName = GetModuleNameByDirectoryUtil.execute(directory, project);
-        this.validator = new NewCLICommandValidator();
         this.toSnakeCase = CamelCaseToSnakeCase.getInstance();
+        this.commonBundle = new CommonBundle();
 
         setContentPane(contentPane);
         setModal(true);
@@ -145,13 +175,38 @@ public String getCLICommandClassFqn() {
     }
 
     private void onOK() {
-        if (!validator.validate(this.project,this)) {
+        if (!validateFormFields() || !isPHPClassValid()) {
             return;
         }
         this.generate();
         this.setVisible(false);
     }
 
+    private Boolean isPHPClassValid() {
+        final NamespaceBuilder namespaceBuilder = new NamespaceBuilder(
+                moduleName,
+                getCLICommandClassName(),
+                getCLICommandParentDirectory()
+        );
+        final String namespace = namespaceBuilder.getClassFqn();
+        final PhpClass phpClass = GetPhpClassByFQN.getInstance(project).execute(namespace);
+        if (phpClass != null) {
+            final String errorMessage = validatorBundle.message(
+                    "validator.file.alreadyExists",
+                    commonBundle.message("common.cli.class.title")
+            );
+            JOptionPane.showMessageDialog(
+                    null,
+                    errorMessage,
+                    commonBundle.message("common.validationErrorTitle"),
+                    JOptionPane.ERROR_MESSAGE
+            );
+            return false;
+        }
+
+        return true;
+    }
+
     private void generate() {
         try {
             this.generateCLICommandClass();

src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/NewCLICommandValidator.java

@@ -8,6 +8,7 @@
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.AclResourceIdRule;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.AlphanumericRule;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.AlphanumericWithUnderscoreRule;
+import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.CliCommandRule;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.DirectoryRule;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.IdentifierRule;
 import com.magento.idea.magento2plugin.actions.generation.dialog.validator.rule.Lowercase;
@@ -32,6 +33,7 @@ public enum RuleRegistry {
     START_WITH_NUMBER_OR_CAPITAL_LETTER(StartWithNumberOrCapitalLetterRule.class),
     ACL_RESOURCE_ID(AclResourceIdRule.class),
     LOWERCASE(Lowercase.class),
+    CLI_COMMAND(CliCommandRule.class),
     NUMERIC(NumericRule.class);
 
     private Class<?> rule;

src/com/magento/idea/magento2plugin/actions/generation/dialog/validator/annotation/RuleRegistry.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 CliCommandRule implements ValidationRule {
+    public static final String MESSAGE = "validator.command.isNotValid";
+    private static final ValidationRule INSTANCE = new CliCommandRule();
+
+    @Override
+    public boolean check(final String value) {
+        return value.matches(RegExUtil.CLI_COMMAND_NAME);
+    }
+
+    public static ValidationRule getInstance() {
+        return INSTANCE;
+    }
+}