Refactoring and add test for the CLI class generation

Author: coderimus

src/com/magento/idea/magento2plugin/actions/generation/NewCLICommandAction.java

@@ -2,39 +2,43 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.actions.generation;
 
 import com.intellij.ide.IdeView;
-import com.intellij.openapi.actionSystem.*;
+import com.intellij.openapi.actionSystem.AnAction;
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import com.intellij.openapi.actionSystem.CommonDataKeys;
+import com.intellij.openapi.actionSystem.DataContext;
+import com.intellij.openapi.actionSystem.LangDataKeys;
 import com.intellij.openapi.project.Project;
 import com.intellij.psi.PsiDirectory;
 import com.magento.idea.magento2plugin.MagentoIcons;
 import com.magento.idea.magento2plugin.actions.generation.dialog.NewCLICommandDialog;
 import org.jetbrains.annotations.NotNull;
 
 public class NewCLICommandAction extends AnAction {
-    public static String ACTION_NAME = "Magento 2 CLI Command";
-    public static String ACTION_DESCRIPTION = "Create a new Magento 2 CLI Command";
+    public static String ACTION_NAME = "Magento 2 CLI Command";//NOPMD
+    public static String ACTION_DESCRIPTION = "Create a new Magento 2 CLI Command";//NOPMD
 
-    NewCLICommandAction() {
+    public NewCLICommandAction() {
         super(ACTION_NAME, ACTION_DESCRIPTION, MagentoIcons.MODULE);
     }
 
     @Override
-    public void actionPerformed(@NotNull AnActionEvent e) {
-        DataContext dataContext = e.getDataContext();
-        IdeView view = LangDataKeys.IDE_VIEW.getData(dataContext);
-
+    public void actionPerformed(@NotNull final AnActionEvent event) {
+        final DataContext context = event.getDataContext();
+        final IdeView view = LangDataKeys.IDE_VIEW.getData(context);
         if (view == null) {
-            return;
+            return;//NOPMD
         }
 
-        Project project = CommonDataKeys.PROJECT.getData(dataContext);
+        final Project project = CommonDataKeys.PROJECT.getData(context);
         if (project == null) {
-            return;
+            return;//NOPMD
         }
 
-        PsiDirectory directory = view.getOrChooseDirectory();
+        final PsiDirectory directory = view.getOrChooseDirectory();
         if (directory == null) {
             return;
         }

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

@@ -2,28 +2,39 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.actions.generation.data;
 
-public class CLICommandClassData {
+public class CLICommandClassData { //NOPMD
     private final String className;
     private final String parentDirectory;
     private final String commandName;
-    private final String commandDescription;
+    private final String description;
     private final String namespace;
     private final String moduleName;
 
+    /**
+     * CLI Command PHP class data class.
+     *
+     * @param cliClassName PHP class name
+     * @param parentDirectory Prent directory of a PHP class
+     * @param cliCommandName CLI Command name
+     * @param description CLI Command description
+     * @param namespace namespace of a PHP class
+     * @param moduleName CLI Command module name
+     */
     public CLICommandClassData(
-        String cliClassName,
-        String cliParentDirectory,
-        String cliCommandName,
-        String cliCommandDescription,
-        String namespace,
-        String moduleName
+            final String cliClassName,
+            final String parentDirectory,
+            final String cliCommandName,
+            final String description,
+            final String namespace,
+            final String moduleName
     ) {
         this.className = cliClassName;
-        this.parentDirectory = cliParentDirectory;
+        this.parentDirectory = parentDirectory;
         this.commandName = cliCommandName;
-        this.commandDescription = cliCommandDescription;
+        this.description = description;
         this.namespace = namespace;
         this.moduleName = moduleName;
     }
@@ -41,7 +52,7 @@ public String getCommandName() {
     }
 
     public String getCommandDescription() {
-        return commandDescription;
+        return description;
     }
 
     public String getNamespace() {

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

@@ -2,19 +2,25 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-package com.magento.idea.magento2plugin.actions.generation.data;
 
-import com.jetbrains.php.lang.psi.elements.PhpClass;
+package com.magento.idea.magento2plugin.actions.generation.data;
 
 public class CLICommandXmlData {
     private final String cliCommandModule;
     private final String cliCommandClass;
     private final String cliCommandDiName;
 
+    /**
+     * CLI Command xml data class.
+     *
+     * @param cliCommandModule CLI Command module
+     * @param cliCommandClass CLI Command PHP class
+     * @param cliCommandDiName CLI Command di.xml item name
+     */
     public CLICommandXmlData(
-            String cliCommandModule,
-            String cliCommandClass,
-            String cliCommandDiName
+            final String cliCommandModule,
+            final String cliCommandClass,
+            final String cliCommandDiName
     ) {
         this.cliCommandModule = cliCommandModule;
         this.cliCommandClass = cliCommandClass;
@@ -24,7 +30,11 @@ public CLICommandXmlData(
     public String getCLICommandModule() {
         return cliCommandModule;
     }
-    public String getCliCommandClass() { return cliCommandClass; }
+
+    public String getCliCommandClass() {
+        return cliCommandClass;
+    }
+
     public String getCliCommandDiName() {
         return cliCommandDiName;
     }

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

@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.actions.generation.dialog;
 
 import com.intellij.openapi.project.Project;
@@ -15,8 +16,17 @@
 import com.magento.idea.magento2plugin.actions.generation.generator.util.NamespaceBuilder;
 import com.magento.idea.magento2plugin.util.CamelCaseToSnakeCase;
 import com.magento.idea.magento2plugin.util.magento.GetModuleNameByDirectory;
-import javax.swing.*;
-import java.awt.event.*;
+import java.awt.event.KeyEvent;
+import java.awt.event.WindowAdapter;
+import java.awt.event.WindowEvent;
+import java.util.Locale;
+import javax.swing.JButton;
+import javax.swing.JComponent;
+import javax.swing.JOptionPane;
+import javax.swing.JPanel;
+import javax.swing.JTextArea;
+import javax.swing.JTextField;
+import javax.swing.KeyStroke;
 
 public class NewCLICommandDialog extends AbstractDialog {
     private JPanel contentPane;
@@ -32,6 +42,12 @@ public class NewCLICommandDialog extends AbstractDialog {
     private final NewCLICommandValidator validator;
     private final CamelCaseToSnakeCase toSnakeCase;
 
+    /**
+     * Open new dialog for adding a new CLI Command.
+     *
+     * @param project Project
+     * @param directory PsiDirectory
+     */
     public NewCLICommandDialog(final Project project, final PsiDirectory directory) {
         super();
         this.project = project;
@@ -55,16 +71,15 @@ public void windowClosing(final WindowEvent event) {
             }
         });
 
-        contentPane.registerKeyboardAction(new ActionListener() {
-            @Override
-            public void actionPerformed(final ActionEvent event) {
-                onCancel();
-            }
-        }, KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
+        contentPane.registerKeyboardAction(
+                event -> onCancel(),
+                KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
+                JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT
+        );
     }
 
     /**
-     * Open a new CLI command dialog
+     * Open a new CLI command dialog.
      *
      * @param project Project
      * @param directory Directory
@@ -93,16 +108,32 @@ public String getCLICommandDescription() {
         return this.cliCommandDescriptionField.getText().trim();
     }
 
+    /**
+     * Get di.xml item nme for CLI command based on the module name and class name.
+     * @return di.xml item name
+     */
     public String getDIXmlItemName() {
         final String diItemName = this.toSnakeCase.convert(this.getCLICommandClassName());
 
-        return this.moduleName.toLowerCase() + "_" + diItemName;
+        return this.moduleName.toLowerCase(new Locale("en","EN"))
+                + "_"
+                + diItemName;
     }
 
+    /**
+     * Get current module name for which a CLI Command is being added.
+     *
+     * @return module name
+     */
     public String getCLICommandModule() {
         return this.moduleName;
     }
 
+    /**
+     * Get a CLI Command PHP class namespace.
+     *
+     * @return PHP class namespace
+     */
     public String getCLICommandClassFqn() {
         final NamespaceBuilder namespaceBuilder = new NamespaceBuilder(
                 moduleName,
@@ -124,7 +155,7 @@ private void generate() {
         try {
             this.generateCLICommandClass();
             this.generateCLICommandDiXmlRegistration();
-        } catch (Exception exception) {
+        } catch (Exception exception) { //NOPMD
             JOptionPane.showMessageDialog(
                     null,
                     exception.getMessage(),
@@ -136,13 +167,15 @@ private void generate() {
 
     private void generateCLICommandClass() {
         final CLICommandClassData dataClass = this.initializeCLICommandClassData();
-        final CLICommandClassGenerator classGenerator = new CLICommandClassGenerator(project, dataClass);
+        final CLICommandClassGenerator classGenerator =
+                new CLICommandClassGenerator(project, dataClass);
         classGenerator.generate(NewCLICommandAction.ACTION_NAME, true);
     }
 
     private void generateCLICommandDiXmlRegistration() {
         final CLICommandXmlData cliCommandXmlData = this.initializeCLICommandDIXmlData();
-        final CLICommandDiXmlGenerator diGenerator = new CLICommandDiXmlGenerator(project, cliCommandXmlData);
+        final CLICommandDiXmlGenerator diGenerator =
+                new CLICommandDiXmlGenerator(project, cliCommandXmlData);
         diGenerator.generate(NewCLICommandAction.ACTION_NAME);
     }
 

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

@@ -26,7 +26,9 @@ public class NewCLICommandValidator {
      * @return NewCLICommandValidator
      */
     public static NewCLICommandValidator getInstance() {
-        if (null != INSTANCE) return INSTANCE;//NOPMD
+        if (null != INSTANCE) { //NOPMD
+            return INSTANCE;
+        }
         INSTANCE = new NewCLICommandValidator();
 
         return INSTANCE;

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

@@ -30,7 +30,7 @@ public class CLICommandClassGenerator extends FileGenerator {
     /**
      * Generates new CLI Command PHP Class based on provided data.
      *
-     * @param project             Project
+     * @param project      Project
      * @param phpClassData CLICommandClassData
      */
     public CLICommandClassGenerator(

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

@@ -96,7 +96,7 @@ public PsiFile generate(final String actionName) {
     }
 
     @Override
-    final protected void fillAttributes(final Properties attributes) {
+    protected final void fillAttributes(final Properties attributes) {
         if (!this.isDeclared) {
             attributes.setProperty("CLI_COMMAND_INTERFACE", ModuleDiXml.CLI_COMMAND_INTERFACE);
         }

src/com/magento/idea/magento2plugin/magento/files/CLICommandTemplate.java

@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.magento.files;
 
 import com.intellij.lang.Language;

testData/actions/generation/generator/CLICommandClassGenerator/generateCLICommandClass/TestCLICommandPHPClass.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Foo\Bar\Console;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class TestCLICommandPHPClass extends Command
+{
+    /**
+     * @inheritDoc
+     */
+    protected function configure()
+    {
+        $this->setName('bar:test-command');
+        $this->setDescription('This is the test command');
+        parent::configure();
+    }
+
+    /**
+     * CLI command description
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     *
+     * @return void
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): void
+    {
+        // todo: implement CLI command logic here
+    }
+}