Merge pull request #447 from drpayyne/issue-443

coderimus · web-flow · commit b240fac5c022 · 2021-01-05T12:57:46.000+02:00
Issue 443
diff --git a/resources/fileTemplates/internal/Magento Preference Class.php.ft b/resources/fileTemplates/internal/Magento Preference Class.php.ft
@@ -9,6 +9,6 @@ namespace ${NAMESPACE};
 use ${USE};
 #end
 
-class ${NAME} #if (${EXTENDS})extends ${EXTENDS}#end {
+#if (${INTERFACE})interface#else class#end ${NAME} #if (${EXTENDS})extends ${EXTENDS}#end {
 
 }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/OverrideClassByAPreferenceAction.java b/src/com/magento/idea/magento2plugin/actions/generation/OverrideClassByAPreferenceAction.java
@@ -22,6 +22,7 @@
 public class OverrideClassByAPreferenceAction extends DumbAwareAction {
     public static final String ACTION_NAME = "Override this class by a new Preference";
     public static final String ACTION_DESCRIPTION = "Create a new Magento 2 Preference";
+    public static final String INTERFACE_ACTION = "Override this interface by a new Preference";
     private final GetFirstClassOfFile getFirstClassOfFile;
     private PhpClass targetClass;
 
@@ -44,6 +45,9 @@ public void update(final AnActionEvent event) {
             targetClass = phpClass;
             if (psiFile instanceof PhpFile && phpClass != null) {
                 this.setStatus(event, true);
+                if (phpClass.isInterface()) {
+                    event.getPresentation().setText(INTERFACE_ACTION);
+                }
             } else  {
                 this.setStatus(event, false);
             }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/data/PreferenceFileData.java b/src/com/magento/idea/magento2plugin/actions/generation/data/PreferenceFileData.java
@@ -2,27 +2,33 @@
  * 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;
 
 public class PreferenceFileData {
-    private String preferenceDirectory;
-    private String preferenceClassName;
-    private String preferenceModule;
-    private PhpClass targetClass;
-    private String preferenceFqn;
-    private String namespace;
-    private boolean inheritClass;
+    private final String preferenceDirectory;
+    private final String preferenceClassName;
+    private final String preferenceModule;
+    private final PhpClass targetClass;
+    private final String preferenceFqn;
+    private final String namespace;
+    private final boolean inheritClass;
+    private final boolean isAnInterface;
 
+    /**
+     * Constructor.
+     */
     public PreferenceFileData(
-            String preferenceDirectory,
-            String preferenceClassName,
-            String preferenceModule,
-            PhpClass targetClass,
-            String preferenceFqn,
-            String namespace,
-            boolean inheritClass
+            final String preferenceDirectory,
+            final String preferenceClassName,
+            final String preferenceModule,
+            final PhpClass targetClass,
+            final String preferenceFqn,
+            final String namespace,
+            final boolean inheritClass,
+            final boolean isAnInterface
     ) {
         this.preferenceDirectory = preferenceDirectory;
         this.preferenceClassName = preferenceClassName;
@@ -31,6 +37,7 @@ public PreferenceFileData(
         this.preferenceFqn = preferenceFqn;
         this.namespace = namespace;
         this.inheritClass = inheritClass;
+        this.isAnInterface = isAnInterface;
     }
 
     public String getPreferenceClassName() {
@@ -60,4 +67,8 @@ public String getNamespace() {
     public boolean isInheritClass() {
         return inheritClass;
     }
+
+    public boolean isInterface() {
+        return isAnInterface;
+    }
 }
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/dialog/OverrideClassByAPreferenceDialog.java b/src/com/magento/idea/magento2plugin/actions/generation/dialog/OverrideClassByAPreferenceDialog.java
@@ -48,6 +48,7 @@ public class OverrideClassByAPreferenceDialog extends AbstractDialog { //NOPMD
     @NotNull
     private final Project project;
     private final PhpClass targetClass;
+    private boolean isInterface;
     private JPanel contentPane;
     private JButton buttonOK;
     private JButton buttonCancel;
@@ -98,6 +99,7 @@ public OverrideClassByAPreferenceDialog(
         this.targetClass = targetClass;
         this.validatorBundle = new ValidatorBundle();
         this.commonBundle = new CommonBundle();
+        this.isInterface = false;
 
         setContentPane(contentPane);
         setModal(true);
@@ -108,6 +110,9 @@ public OverrideClassByAPreferenceDialog(
             inheritClass.setVisible(false);
             inheritClassLabel.setVisible(false);
         }
+        if (targetClass.isInterface()) {
+            this.isInterface = true;
+        }
         suggestPreferenceClassName(targetClass);
         suggestPreferenceDirectory(targetClass);
 
@@ -188,7 +193,8 @@ protected void onOK() {
                 targetClass,
                 getPreferenceClassFqn(),
                 getNamespace(),
-                isInheritClass()
+                isInheritClass(),
+                isInterface
         ), project).generate(OverrideClassByAPreferenceAction.ACTION_NAME, true);
 
         this.setVisible(false);
diff --git a/src/com/magento/idea/magento2plugin/actions/generation/generator/PreferenceClassGenerator.java b/src/com/magento/idea/magento2plugin/actions/generation/generator/PreferenceClassGenerator.java
@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.actions.generation.generator;
 
 import com.intellij.openapi.project.Project;
@@ -13,26 +14,32 @@
 import com.magento.idea.magento2plugin.actions.generation.generator.util.DirectoryGenerator;
 import com.magento.idea.magento2plugin.actions.generation.generator.util.FileFromTemplateGenerator;
 import com.magento.idea.magento2plugin.bundles.CommonBundle;
+import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
 import com.magento.idea.magento2plugin.indexes.ModuleIndex;
 import com.magento.idea.magento2plugin.magento.files.PhpPreference;
+import com.magento.idea.magento2plugin.magento.packages.File;
 import com.magento.idea.magento2plugin.util.GetFirstClassOfFile;
 import com.magento.idea.magento2plugin.util.GetPhpClassByFQN;
-import com.magento.idea.magento2plugin.bundles.ValidatorBundle;
-import org.jetbrains.annotations.NotNull;
-import javax.swing.*;
-import com.magento.idea.magento2plugin.magento.packages.File;
 import java.util.Properties;
+import javax.swing.JOptionPane;
+import org.jetbrains.annotations.NotNull;
 
 public class PreferenceClassGenerator extends FileGenerator {
-    private PreferenceFileData preferenceFileData;
-    private Project project;
-    private ValidatorBundle validatorBundle;
-    private CommonBundle commonBundle;
+    private final PreferenceFileData preferenceFileData;
+    private final Project project;
+    private final ValidatorBundle validatorBundle;
+    private final CommonBundle commonBundle;
     private final DirectoryGenerator directoryGenerator;
     private final FileFromTemplateGenerator fileFromTemplateGenerator;
     private final GetFirstClassOfFile getFirstClassOfFile;
 
-    public PreferenceClassGenerator(@NotNull PreferenceFileData preferenceFileData, Project project) {
+    /**
+     * Constructor.
+     */
+    public PreferenceClassGenerator(
+            @NotNull final PreferenceFileData preferenceFileData,
+            final Project project
+    ) {
         super(project);
         this.directoryGenerator = DirectoryGenerator.getInstance();
         this.fileFromTemplateGenerator = FileFromTemplateGenerator.getInstance(project);
@@ -43,46 +50,70 @@ public PreferenceClassGenerator(@NotNull PreferenceFileData preferenceFileData,
         this.commonBundle = new CommonBundle();
     }
 
-    public PsiFile generate(String actionName) {
-        PhpClass pluginClass = GetPhpClassByFQN.getInstance(project).execute(preferenceFileData.getPreferenceFqn());
+
+    @Override
+    public PsiFile generate(final String actionName) {
+        PhpClass pluginClass = GetPhpClassByFQN.getInstance(project).execute(
+                preferenceFileData.getPreferenceFqn()
+        );
 
         if (pluginClass == null) {
             pluginClass = createPluginClass(actionName);
         }
 
         if (pluginClass == null) {
-            String errorMessage = validatorBundle.message("validator.file.cantBeCreated", "Preference Class");
-            JOptionPane.showMessageDialog(null, errorMessage, commonBundle.message("common.error"), JOptionPane.ERROR_MESSAGE);
+            final String errorMessage = validatorBundle.message(
+                    "validator.file.cantBeCreated",
+                    "Preference Class"
+            );
+            JOptionPane.showMessageDialog(
+                    null,
+                    errorMessage,
+                    commonBundle.message("common.error"),
+                    JOptionPane.ERROR_MESSAGE
+            );
 
             return null;
         }
 
         return pluginClass.getContainingFile();
     }
 
-    private PhpClass createPluginClass(String actionName) {
-        PsiDirectory parentDirectory = ModuleIndex.getInstance(project).getModuleDirectoryByModuleName(getPreferenceModule());
-        String[] pluginDirectories = preferenceFileData.getPreferenceDirectory().split(File.separator);
-        for (String pluginDirectory: pluginDirectories) {
-            parentDirectory = directoryGenerator.findOrCreateSubdirectory(parentDirectory, pluginDirectory);
+    private PhpClass createPluginClass(final String actionName) {
+        PsiDirectory parentDirectory = ModuleIndex.getInstance(project)
+                .getModuleDirectoryByModuleName(getPreferenceModule());
+        final String[] pluginDirectories = preferenceFileData.getPreferenceDirectory()
+                .split(File.separator);
+        for (final String pluginDirectory: pluginDirectories) {
+            parentDirectory = directoryGenerator
+                    .findOrCreateSubdirectory(parentDirectory, pluginDirectory);
         }
 
-        Properties attributes = getAttributes();
-        PsiFile pluginFile = fileFromTemplateGenerator.generate(PhpPreference.getInstance(preferenceFileData.getPreferenceClassName()), attributes, parentDirectory, actionName);
+        final Properties attributes = getAttributes();
+        final PsiFile pluginFile = fileFromTemplateGenerator.generate(
+                PhpPreference.getInstance(preferenceFileData.getPreferenceClassName()),
+                attributes,
+                parentDirectory,
+                actionName
+        );
         if (pluginFile == null) {
             return null;
         }
         return getFirstClassOfFile.execute((PhpFile) pluginFile);
     }
 
-    protected void fillAttributes(Properties attributes) {
-        String preferenceClassName = preferenceFileData.getPreferenceClassName();
+    @Override
+    protected void fillAttributes(final Properties attributes) {
+        final String preferenceClassName = preferenceFileData.getPreferenceClassName();
         attributes.setProperty("NAME", preferenceClassName);
         attributes.setProperty("NAMESPACE", preferenceFileData.getNamespace());
+        if (preferenceFileData.isInterface()) {
+            attributes.setProperty("INTERFACE", "interface");
+        }
         if (!preferenceFileData.isInheritClass()) {
             return;
         }
-        String parentClassName = preferenceFileData.getTargetClass().getName();
+        final String parentClassName = preferenceFileData.getTargetClass().getName();
         if (!parentClassName.equals(preferenceClassName)) {
             attributes.setProperty("USE", preferenceFileData.getTargetClass().getPresentableFQN());
             attributes.setProperty("EXTENDS", parentClassName);
diff --git a/testData/actions/generation/generator/PreferenceClassGenerator/generatePreferenceInterfaceFile/InterfaceOverride.php b/testData/actions/generation/generator/PreferenceClassGenerator/generatePreferenceInterfaceFile/InterfaceOverride.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Foo\Bar\Model;
+
+interface InterfaceOverride
+{
+
+}
diff --git a/tests/com/magento/idea/magento2plugin/actions/generation/generator/PreferenceClassGeneratorTest.java b/tests/com/magento/idea/magento2plugin/actions/generation/generator/PreferenceClassGeneratorTest.java
@@ -26,6 +26,7 @@ public void testGeneratePreferenceClassFile() {
                 "SimpleModelOneOverride",
                 "Foo\\Bar\\Model\\Override\\SimpleModelOneOverride",
                 "Foo\\Bar\\Model\\Override",
+                false,
                 false
         );
         final String filePath = this.getFixturePath("SimpleModelOneOverride.php");
@@ -38,6 +39,29 @@ public void testGeneratePreferenceClassFile() {
         );
     }
 
+    /**
+     * Test preference class file generation.
+     */
+    public void testGeneratePreferenceInterfaceFile() {
+        final PsiFile preferenceClassFile = createPreferenceClassFile(
+                TARGET_MODEL_ONE_CLASS_FQN,
+                "Model",
+                "InterfaceOverride",
+                "Foo\\Bar\\Model\\InterfaceOverride",
+                "Foo\\Bar\\Model",
+                false,
+                true
+        );
+        final String filePath = this.getFixturePath("InterfaceOverride.php");
+        final PsiFile expectedFile = myFixture.configureByFile(filePath);
+
+        assertGeneratedFileIsCorrect(
+                expectedFile,
+                "src/app/code/Foo/Bar/Model",
+                preferenceClassFile
+        );
+    }
+
     /**
      * Test preference class file generation with inheritance.
      */
@@ -48,7 +72,8 @@ public void testGeneratePreferenceClassFileWithInheritance() {
                 "SimpleModelTwoOverride",
                 "Foo\\Bar\\Model\\Override\\SimpleModelTwoOverride",
                 "Foo\\Bar\\Model\\Override",
-                true
+                true,
+                false
         );
         final String filePath = this.getFixturePath("SimpleModelTwoOverride.php");
         final PsiFile expectedFile = myFixture.configureByFile(filePath);
@@ -77,7 +102,8 @@ private PsiFile createPreferenceClassFile(
             final String preferenceClassName,
             final String preferenceFqn,
             final String namespace,
-            final Boolean inheritClass
+            final Boolean inheritClass,
+            final Boolean isInterface
     ) {
         final Project project = myFixture.getProject();
         final PhpClass targetClass = GetPhpClassByFQN.getInstance(project).execute(targetClassFnq);
@@ -88,7 +114,8 @@ private PsiFile createPreferenceClassFile(
                 targetClass,
                 preferenceFqn,
                 namespace,
-                inheritClass
+                inheritClass,
+                isInterface
         );
         final PreferenceClassGenerator preferenceClassGenerator = new PreferenceClassGenerator(
                 preferenceFileData,

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,6 @@ namespace ${NAMESPACE};`
`9`	`9`	`use ${USE};`
`10`	`10`	`#end`
`11`	`11`
`12`		`-class ${NAME} #if (${EXTENDS})extends ${EXTENDS}#end {`
	`12`	`+#if (${INTERFACE})interface#else class#end ${NAME} #if (${EXTENDS})extends ${EXTENDS}#end {`
`13`	`13`
`14`	`14`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,8 @@ @@
 +<?php
++
 +namespace Foo\Bar\Model;
++
 +interface InterfaceOverride
 +{
++
 +}