Merge pull request #280 from dylanngo95/212-issues

Vitaliy · web-flow · commit a5f150fc7ec7 · 2020-10-12T17:19:18.000+03:00
[212]_add reference navigation and completion for crontab.xml
diff --git a/src/com/magento/idea/magento2plugin/completion/provider/PhpJobMethodCompletionContributor.java b/src/com/magento/idea/magento2plugin/completion/provider/PhpJobMethodCompletionContributor.java
@@ -0,0 +1,42 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.completion.provider;
+
+import com.intellij.codeInsight.completion.CompletionParameters;
+import com.intellij.codeInsight.completion.CompletionProvider;
+import com.intellij.codeInsight.completion.CompletionResultSet;
+import com.intellij.codeInsight.lookup.LookupElementBuilder;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.xml.XmlElement;
+import com.intellij.util.ProcessingContext;
+import com.jetbrains.php.lang.psi.elements.Method;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.magento.idea.magento2plugin.indexes.DiIndex;
+import org.jetbrains.annotations.NotNull;
+
+public class PhpJobMethodCompletionContributor extends CompletionProvider<CompletionParameters> {
+
+    @Override
+    protected void addCompletions(@NotNull final CompletionParameters parameters,
+                                  final ProcessingContext context,
+                                  @NotNull final CompletionResultSet result) {
+        final PsiElement position = parameters.getPosition().getOriginalElement();
+        if (position == null) {
+            return;
+        }
+
+        final PhpClass phpClass = DiIndex.getPhpClassOfJobMethod((XmlElement) position);
+        if (phpClass != null) {
+            for (final Method method : phpClass.getMethods()) {
+                result.addElement(
+                        LookupElementBuilder
+                                .create(method.getName())
+                                .withIcon(method.getIcon())
+                );
+            }
+        }
+    }
+}
diff --git a/src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java b/src/com/magento/idea/magento2plugin/completion/xml/XmlCompletionContributor.java
@@ -62,7 +62,6 @@ public XmlCompletionContributor() {
                         .inside(XmlPatterns.xmlAttribute().withName(CommonXml.ATTR_CLASS)),
                 new PhpClassCompletionProvider()
         );
-
         // <preference for="completion">
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
                         .inside(XmlPatterns.xmlAttribute().withName(ModuleDiXml.PREFERENCE_ATTR_FOR)),
@@ -129,12 +128,20 @@ public XmlCompletionContributor() {
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
             .inside(XmlPatterns.xmlAttribute().withName(ModuleEventsXml.INSTANCE_ATTRIBUTE)
                 .withParent(XmlPatterns.xmlTag().withName(ModuleEventsXml.OBSERVER_TAG)
-                    .withParent(XmlPatterns.xmlTag().withName(ModuleEventsXml.EVENT_TAG))
                 )
             ).inFile(xmlFile().withName(string().matches(ModuleEventsXml.FILE_NAME))),
             new PhpClassCompletionProvider()
         );
 
+        // <job instance="class">
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+            .inside(XmlPatterns.xmlAttribute().withName(CommonXml.ATTR_INSTANCE)
+                .withParent(XmlPatterns.xmlTag().withName(CrontabXmlTemplate.CRON_JOB_TAG)
+                )
+            ).inFile(xmlFile().withName(string().matches(CrontabXmlTemplate.FILE_NAME))),
+            new PhpClassCompletionProvider()
+        );
+
         // <source_model>php class completion</source_model> in system.xml files.
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_DATA_CHARACTERS)
             .inside(XmlPatterns.xmlTag().withName(ModuleSystemXml.XML_TAG_SOURCE_MODEL)
@@ -182,6 +189,14 @@ public XmlCompletionContributor() {
             new PhpServiceMethodCompletionContributor()
         );
 
+        // <job method="methodName"/>
+        extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
+                .inside(XmlPatterns.xmlAttribute().withName("method")
+                    .withParent(XmlPatterns.xmlTag().withName("job"))
+                ).inFile(xmlFile().withName(string().endsWith("crontab.xml"))),
+            new PhpJobMethodCompletionContributor()
+        );
+
         extend(CompletionType.BASIC, psiElement(XmlTokenType.XML_ATTRIBUTE_VALUE_TOKEN)
             .inside(XmlPatterns.xmlAttribute().withName("name")
                 .withParent(XmlPatterns.xmlTag().withName("referenceContainer"))
diff --git a/src/com/magento/idea/magento2plugin/indexes/DiIndex.java b/src/com/magento/idea/magento2plugin/indexes/DiIndex.java
@@ -2,6 +2,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 package com.magento.idea.magento2plugin.indexes;
 
 import com.intellij.codeInsight.completion.PrefixMatcher;
@@ -12,19 +13,24 @@
 import com.intellij.psi.PsiReference;
 import com.intellij.psi.search.GlobalSearchScope;
 import com.intellij.psi.util.PsiTreeUtil;
-import com.intellij.psi.xml.*;
+// CHECKSTYLE IGNORE check FOR NEXT 1 LINES
+import com.intellij.psi.xml.*;//NOPMD
 import com.intellij.util.indexing.FileBasedIndex;
 import com.jetbrains.php.PhpIndex;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.magento.idea.magento2plugin.stubs.indexes.VirtualTypeIndex;
 import com.magento.idea.magento2plugin.util.xml.XmlPsiTreeUtil;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
-
+// CHECKSTYLE IGNORE check FOR NEXT 1 LINES
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
+/**
+ * TODO: enable style checks after decomposition.
+ */
+@SuppressWarnings({"PMD", "checkstyle:all"})
 public class DiIndex {
 
     private static DiIndex INSTANCE;
@@ -34,6 +40,12 @@ public class DiIndex {
     private DiIndex() {
     }
 
+    /**
+     * Get Instance.
+     *
+     * @param project
+     * @return DiIndex
+     */
     public static DiIndex getInstance(final Project project) {
         if (null == INSTANCE) {
             INSTANCE = new DiIndex();
@@ -42,6 +54,12 @@ public static DiIndex getInstance(final Project project) {
         return INSTANCE;
     }
 
+    /**
+     * Get Php Class Of Argument.
+     *
+     * @param psiArgumentValueElement
+     * @return PhpClass
+     */
     @Nullable
     public PhpClass getPhpClassOfArgument(XmlElement psiArgumentValueElement) {
 
@@ -66,6 +84,12 @@ public PhpClass getPhpClassOfArgument(XmlElement psiArgumentValueElement) {
         return null;
     }
 
+    /**
+     * Get Php Class Of Service Method.
+     *
+     * @param psiMethodValueElement
+     * @return PhpClass
+     */
     @Nullable
     public static PhpClass getPhpClassOfServiceMethod(XmlElement psiMethodValueElement) {
         XmlTag serviceTag = PsiTreeUtil.getParentOfType(psiMethodValueElement, XmlTag.class);
@@ -95,6 +119,48 @@ public static PhpClass getPhpClassOfServiceMethod(XmlElement psiMethodValueEleme
         return null;
     }
 
+    /**
+     * Get Php Class Of Job Method.
+     *
+     * @param psiMethodValueElement
+     * @return PhpClass
+     */
+    @Nullable
+    public static PhpClass getPhpClassOfJobMethod(XmlElement psiMethodValueElement) {
+        XmlTag serviceTag = PsiTreeUtil.getParentOfType(psiMethodValueElement, XmlTag.class);
+        if (serviceTag == null) {
+            return null;
+        }
+
+        XmlAttribute attribute = serviceTag.getAttribute("instance");
+        if (attribute == null) {
+            return null;
+        }
+
+        XmlAttributeValue valueElement = attribute.getValueElement();
+        if (valueElement == null) {
+            return null;
+        }
+
+        for (PsiReference reference : valueElement.getReferences()) {
+            if (reference != null) {
+                PsiElement element = reference.resolve();
+                if (element instanceof PhpClass) {
+                    return (PhpClass) element;
+                }
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Get Virtual Type Elements.
+     *
+     * @param name
+     * @param scope
+     * @return Collection<PsiElement>
+     */
     public Collection<PsiElement> getVirtualTypeElements(final String name, final GlobalSearchScope scope) {
         Collection<PsiElement> result = new ArrayList<>();
 
@@ -112,6 +178,13 @@ public Collection<PsiElement> getVirtualTypeElements(final String name, final Gl
         return result;
     }
 
+    /**
+     * Get All Virtual Type Element Names.
+     *
+     * @param prefixMatcher
+     * @param scope
+     * @return Collection<String>
+     */
     public Collection<String> getAllVirtualTypeElementNames(PrefixMatcher prefixMatcher, final GlobalSearchScope scope) {
         Collection<String> keys =
                 FileBasedIndex.getInstance().getAllKeys(VirtualTypeIndex.KEY, project);
@@ -120,6 +193,12 @@ public Collection<String> getAllVirtualTypeElementNames(PrefixMatcher prefixMatc
         return keys;
     }
 
+    /**
+     * Get Top Type Of Virtual Type.
+     *
+     * @param name
+     * @return String
+     */
     @NotNull
     private String getTopTypeOfVirtualType(@NotNull String name) {
         List<String> values;
diff --git a/src/com/magento/idea/magento2plugin/magento/files/CommonXml.java b/src/com/magento/idea/magento2plugin/magento/files/CommonXml.java
@@ -11,5 +11,6 @@ public class CommonXml {
     public static String INIT_PARAMETER = "init_parameter";
     public static String OBJECT = "object";
     public static String ATTR_CLASS = "class";
+    public static String ATTR_INSTANCE = "instance";
     public static String ATTRIBUTE_ARGUMENTS = "arguments";
 }
diff --git a/src/com/magento/idea/magento2plugin/reference/provider/PhpJobMethodReferenceProvider.java b/src/com/magento/idea/magento2plugin/reference/provider/PhpJobMethodReferenceProvider.java
@@ -0,0 +1,50 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.reference.provider;
+
+import com.intellij.openapi.util.text.StringUtil;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiReference;
+import com.intellij.psi.PsiReferenceProvider;
+import com.intellij.psi.xml.XmlElement;
+import com.intellij.util.ProcessingContext;
+import com.jetbrains.php.lang.psi.elements.Method;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.magento.idea.magento2plugin.indexes.DiIndex;
+import com.magento.idea.magento2plugin.reference.xml.PolyVariantReferenceBase;
+// CHECKSTYLE IGNORE check FOR NEXT 1 LINES
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * TODO: enable style checks after decomposition.
+ */
+@SuppressWarnings({"PMD", "checkstyle:all"})
+public class PhpJobMethodReferenceProvider extends PsiReferenceProvider {
+
+    @NotNull
+    @Override
+    public PsiReference[] getReferencesByElement(@NotNull PsiElement element, @NotNull ProcessingContext context) {
+        if (!(element instanceof XmlElement)) {
+            return PsiReference.EMPTY_ARRAY;
+        }
+
+        List<PsiReference> psiReferences = new ArrayList<>();
+
+        String methodName = StringUtil.unquoteString(element.getText());
+
+        PhpClass phpClass = DiIndex.getPhpClassOfJobMethod((XmlElement) element);
+        if (phpClass != null) {
+            Collection<Method> methods = phpClass.getMethods();
+            methods.removeIf(m -> !m.getName().equalsIgnoreCase(methodName));
+            psiReferences.add(new PolyVariantReferenceBase(element, methods));
+        }
+
+        return psiReferences.toArray(new PsiReference[psiReferences.size()]);
+    }
+}
diff --git a/src/com/magento/idea/magento2plugin/reference/xml/XmlReferenceContributor.java b/src/com/magento/idea/magento2plugin/reference/xml/XmlReferenceContributor.java
@@ -87,6 +87,16 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
             new PhpServiceMethodReferenceProvider()
         );
 
+        // <job method="methodName"/>
+        registrar.registerReferenceProvider(
+                XmlPatterns.xmlAttributeValue().withParent(
+                        XmlPatterns.xmlAttribute().withName("method").withParent(
+                                XmlPatterns.xmlTag().withName("job")
+                        )
+                ).inFile(xmlFile().withName(string().endsWith("crontab.xml"))),
+                new PhpJobMethodReferenceProvider()
+        );
+
         registrar.registerReferenceProvider(
             XmlPatterns.xmlAttributeValue().withParent(
                 XmlPatterns.xmlAttribute().withName("name").withParent(

Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,6 @@ public class CommonXml {`
`11`	`11`	`public static String INIT_PARAMETER = "init_parameter";`
`12`	`12`	`public static String OBJECT = "object";`
`13`	`13`	`public static String ATTR_CLASS = "class";`
	`14`	`+ public static String ATTR_INSTANCE = "instance";`
`14`	`15`	`public static String ATTRIBUTE_ARGUMENTS = "arguments";`
`15`	`16`	`}`