Fixed template, form and adjusted business logic of the observer dialog

Author: Vitaliy Boyko

resources/fileTemplates/code/Magento Observer Execute Method.php.ft

@@ -2,7 +2,6 @@
 * Observer for ${EVENT_NAME}
 *
 * @param Observer $observer
-* @throws \Magento\Framework\Validator\Exception
 * @return void
 */
 public function execute(Observer $observer)

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

@@ -23,7 +23,7 @@
 import com.magento.idea.magento2plugin.project.Settings;
 
 public class CreateAPluginAction extends DumbAwareAction {
-    public static String ACTION_NAME = "Create A Plugin...";
+    public static String ACTION_NAME = "Create a Plugin...";
     public static String ACTION_DESCRIPTION = "Create a new Magento 2 plugin for the class";
     private final IsPluginAllowedForMethod isPluginAllowed;
     private final GetFirstClassOfFile getFirstClassOfFile;

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

@@ -25,7 +25,8 @@
 public class CreateAnObserverAction extends DumbAwareAction {
     public static final String ACTION_NAME = "Create a Magento Observer...";
     static final String ACTION_DESCRIPTION = "Create a new Magento 2 Observer for the event";
-    static final String SIGNATURE = "#M#C\\Magento\\Framework\\Event\\ManagerInterface.dispatch|#M#M#C\\Magento\\Framework\\App\\Action\\Context.getEventManager.dispatch";
+    static final String SIGNATURE_INTERFACE = "#M#C\\Magento\\Framework\\Event\\ManagerInterface.dispatch";
+    static final String SIGNATURE_CONTEXT = "#M#M#C\\Magento\\Framework\\App\\Action\\Context.getEventManager.dispatch";
     public String targetEvent;
 
     public CreateAnObserverAction() {
@@ -56,13 +57,6 @@ public void update(AnActionEvent event) {
             return;
         }
 
-        if (isDispatchMethodClicked(element)) {
-            //@TODO implement fetching from the dispatch method
-            //this.setStatus(event, true);
-            //targetEvent = fetchTargetEventName(element);
-            //return;
-        }
-
         this.setStatus(event, false);
     }
 
@@ -82,12 +76,9 @@ private PsiElement getElement(@NotNull AnActionEvent event) {
 
     private boolean isObserverEventNameClicked(@NotNull PsiElement element) {
         if (checkIsElementStringLiteral(element)) {
-            //@TODO check if quotes are clicked
-
             if (checkIsParametersList(element.getParent().getParent()) &&
                     checkIsMethodReference(element.getParent().getParent().getParent()) &&
-                    checkIsEventDispatchMethod((MethodReference) element.getParent().getParent().getParent()))
-            {
+                    checkIsEventDispatchMethod((MethodReference) element.getParent().getParent().getParent())) {
                 return true;
             }
         }
@@ -109,7 +100,7 @@ private boolean checkIsMethodReference(@NotNull PsiElement element) {
     }
 
     private boolean checkIsEventDispatchMethod(MethodReference element) {
-        return element.getSignature().equals(SIGNATURE);
+        return element.getSignature().equals(SIGNATURE_INTERFACE) || element.getSignature().equals(SIGNATURE_CONTEXT);
     }
 
     private boolean checkIsElementStringLiteral(@NotNull PsiElement element) {
@@ -126,34 +117,6 @@ private boolean checkIsElementStringLiteral(@NotNull PsiElement element) {
         return true;
     }
 
-    private boolean checkIsElementMethodReference(@NotNull PsiElement element) {
-        ASTNode astNode = element.getNode();
-        if (astNode == null) {
-            return false;
-        }
-        IElementType elementType = astNode.getElementType();
-        if (elementType != PhpTokenTypes.IDENTIFIER) {
-            return false;
-        }
-
-        return true;
-    }
-
-    private boolean isDispatchMethodClicked(@NotNull PsiElement element) {
-        if (checkIsElementMethodReference(element) &&
-                checkIsMethodReference(element.getParent()) &&
-                checkIsEventDispatchMethod((MethodReference) element.getParent())) {
-            return true;
-        }
-
-        return false;
-    }
-
-    private String fetchTargetEventName(@NotNull PsiElement element) {
-        //@TODO implement fetching event name from the dispatch method
-        return null;
-    }
-
     private void setStatus(AnActionEvent event, boolean status) {
         event.getPresentation().setVisible(status);
         event.getPresentation().setEnabled(status);

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

@@ -19,7 +19,7 @@
 import org.jetbrains.annotations.NotNull;
 
 public class OverrideClassByAPreferenceAction extends DumbAwareAction {
-    public static String ACTION_NAME = "Override Class By A Preference...";
+    public static String ACTION_NAME = "Override Class By a Preference...";
     public static String ACTION_DESCRIPTION = "Create a new Magento 2 preference for the class";
     private final GetFirstClassOfFile getFirstClassOfFile;
     private PhpClass targetClass;

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

@@ -7,7 +7,7 @@
     </constraints>
     <properties>
       <minimumSize width="400" height="350"/>
-      <preferredSize width="400" height="350"/>
+      <preferredSize width="450" height="250"/>
       <requestFocusEnabled value="true"/>
     </properties>
     <border type="none"/>

src/com/magento/idea/magento2plugin/actions/generation/dialog/CreateAnObserverDialog.form

@@ -16,8 +16,6 @@
 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.actions.generation.util.CodeStyleSettings;
-import com.magento.idea.magento2plugin.actions.generation.util.CollectInsertedMethods;
-import com.magento.idea.magento2plugin.actions.generation.util.FillTextBufferWithPluginMethods;
 import com.magento.idea.magento2plugin.indexes.ModuleIndex;
 import com.magento.idea.magento2plugin.magento.files.Observer;
 import com.magento.idea.magento2plugin.magento.packages.MagentoPhpClass;
@@ -31,8 +29,6 @@ public class ObserverClassGenerator extends FileGenerator {
     private final DirectoryGenerator directoryGenerator;
     private final FileFromTemplateGenerator fileFromTemplateGenerator;
     private final GetFirstClassOfFile getFirstClassOfFile;
-    private final FillTextBufferWithPluginMethods fillTextBuffer;
-    private final CollectInsertedMethods collectInsertedMethods;
     private ObserverFileData observerFileData;
     private Project project;
 
@@ -44,14 +40,10 @@ public ObserverClassGenerator(ObserverFileData observerFileData, Project project
         this.directoryGenerator = DirectoryGenerator.getInstance();
         this.fileFromTemplateGenerator = FileFromTemplateGenerator.getInstance(project);
         this.getFirstClassOfFile = GetFirstClassOfFile.getInstance();
-        this.fillTextBuffer = FillTextBufferWithPluginMethods.getInstance();
-        this.collectInsertedMethods = CollectInsertedMethods.getInstance();
     }
 
     @Override
     public PsiFile generate(String actionName) {
-
-
         WriteCommandAction.runWriteCommandAction(project, () -> {
             PhpClass observerClass = GetPhpClassByFQN.getInstance(project).execute(
                     observerFileData.getObserverClassFqn()