Extracting the validation messages into a separate bundle and making them more flexible

Author: eduard13

src/com/magento/idea/magento2plugin/generation/validator/NewModuleFormValidator.java

@@ -5,6 +5,7 @@
 package com.magento.idea.magento2plugin.generation.validator;
 
 import com.magento.idea.magento2plugin.generation.NewModuleForm;
+import com.magento.idea.magento2plugin.resources.ValidatorBundle;
 import com.magento.idea.magento2plugin.util.Regex;
 import com.magento.idea.magento2plugin.util.magento.MagentoBasePathUtil;
 
@@ -24,40 +25,40 @@ public String validate()
     {
         String packageName = form.getPackageName();
         if (packageName.length() == 0) {
-            return "Package Name must not be empty.";
+            return ValidatorBundle.message("validator.notEmpty", "Package Name");
         }
 
         if (!packageName.matches(Regex.ALPHANUMERIC)) {
-            return "Package Name must contain letters and numbers only.";
+            return ValidatorBundle.message("validator.alphaNumericCharacters", "Package Name");
         }
 
         if (!Character.isUpperCase(packageName.charAt(0)) && !Character.isDigit(packageName.charAt(0))) {
-            return "Package Name must start from a number or a capital letter";
+            return ValidatorBundle.message("validator.startWithNumberOrCapitalLetter", "Package Name");
         }
 
         String moduleName = form.getModuleName();
         if (moduleName.length() == 0) {
-            return "Module Name must not be empty.";
+            return ValidatorBundle.message("validator.notEmpty", "Module Name");
         }
 
         if (!moduleName.matches(Regex.ALPHANUMERIC)) {
-            return "Module Name must contain letters and numbers only.";
+            return ValidatorBundle.message("validator.alphaNumericCharacters", "Module Name");
         }
 
         if (!Character.isUpperCase(moduleName.charAt(0)) && !Character.isDigit(moduleName.charAt(0))) {
-            return "Module Name must start from a number or a capital letter";
+            return ValidatorBundle.message("validator.startWithNumberOrCapitalLetter", "Module Name");
         }
 
         if (form.getModuleVersion().length() == 0) {
-            return "Module Version must not be empty.";
+            return ValidatorBundle.message("validator.notEmpty", "Module Version");
         }
 
         if (form.getModuleDescription().length() == 0) {
-            return "Module Version must not be empty.";
+            return ValidatorBundle.message("validator.notEmpty", "Module Description");
         }
 
         if (!MagentoBasePathUtil.isMagentoFolderValid(form.getMagentoPath())) {
-            return "Please specify valid magento installation path!";
+            return ValidatorBundle.message("validator.package.validPath");
         }
 
         return null;

src/com/magento/idea/magento2plugin/resources/ValidatorBundle.java

@@ -0,0 +1,88 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.resources;
+
+import com.intellij.CommonBundle;
+import com.intellij.openapi.util.text.StringUtil;
+import org.jetbrains.annotations.NonNls;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.jetbrains.annotations.PropertyKey;
+import java.util.ResourceBundle;
+
+public class ValidatorBundle {
+    /** The {@link ResourceBundle} path. */
+    @NonNls
+    public static final String BUNDLE_NAME = "messages.ValidatorBundle";
+
+    /** The {@link ResourceBundle} instance. */
+    @NotNull
+    private static final ResourceBundle BUNDLE = ResourceBundle.getBundle(BUNDLE_NAME);
+
+    /**
+     * Available syntax list.
+     */
+    public enum Syntax {
+        GLOB, REGEXP;
+
+        @NonNls
+        private static final String KEY = "syntax:";
+
+        @Nullable
+        public static Syntax find(@Nullable String name) {
+            if (name == null) {
+                return null;
+            }
+
+            try {
+                return Syntax.valueOf(name.toUpperCase());
+            } catch (IllegalArgumentException iae) {
+                return null;
+            }
+        }
+
+        @Override
+        public String toString() {
+            return super.toString().toLowerCase();
+        }
+
+        /**
+         * @return element presentation
+         */
+        public String getPresentation() {
+            return StringUtil.join(KEY, " ", toString());
+        }
+    }
+
+    /**
+     * Loads a {@link String} from the {@link #BUNDLE} {@link ResourceBundle}.
+     *
+     * @param key    the key of the resource
+     * @param params the optional parameters for the specific resource
+     *
+     * @return the {@link String} value or {@code null} if no resource found for the key
+     */
+    public static String message(@PropertyKey(resourceBundle = BUNDLE_NAME) String key, Object... params) {
+        return CommonBundle.message(BUNDLE, key, params);
+    }
+
+    /**
+     * Loads a {@link String} from the {@link #BUNDLE} {@link ResourceBundle}.
+     *
+     * @param key the key of the resource
+     * @param defaultValue the default value that will be returned if there is nothing set
+     * @param params the optional parameters for the specific resource
+     *
+     * @return the {@link String} value or {@code null} if no resource found for the key
+     */
+    public static String messageOrDefault(
+            @PropertyKey(resourceBundle = BUNDLE_NAME) String key,
+            String defaultValue,
+            Object... params
+    ) {
+        return CommonBundle.messageOrDefault(BUNDLE, key, defaultValue, params);
+    }
+}

src/com/magento/idea/magento2plugin/resources/messages/ValidatorBundle.properties

@@ -0,0 +1,4 @@
+validator.notEmpty={0} must not be empty
+validator.package.validPath=Please specify a valid Magento 2 installation path!
+validator.alphaNumericCharacters={0} must contain letters and numbers only
+validator.startWithNumberOrCapitalLetter={0} must start from a number or a capital letter