provide class name completion in xml service ids #967; goto definition does not support services with FQCN xml ids shortcuts #952

Haehnchen · Haehnchen · commit be29e0280bfd · 2017-07-06T17:26:03.000+02:00
diff --git a/src/fr/adrienbrault/idea/symfony2plugin/codeInsight/GotoCompletionProvider.java b/src/fr/adrienbrault/idea/symfony2plugin/codeInsight/GotoCompletionProvider.java
@@ -1,9 +1,13 @@
 package fr.adrienbrault.idea.symfony2plugin.codeInsight;
 
+import com.intellij.codeInsight.lookup.LookupElement;
 import com.intellij.openapi.project.Project;
 import com.intellij.psi.PsiElement;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Collection;
+import java.util.Collections;
+
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
  */
@@ -25,8 +29,15 @@ protected PsiElement getElement() {
         return this.element;
     }
 
+    @NotNull
+    @Override
+    public Collection<LookupElement> getLookupElements() {
+        return Collections.emptyList();
+    }
+
+    @NotNull
     @Override
-    public void getLookupElements(@NotNull GotoCompletionProviderLookupArguments arguments) {
-        // empty for compatibility
+    public Collection<PsiElement> getPsiTargets(PsiElement element) {
+        return Collections.emptyList();
     }
 }
diff --git a/src/fr/adrienbrault/idea/symfony2plugin/codeInsight/GotoCompletionProviderInterfaceEx.java b/src/fr/adrienbrault/idea/symfony2plugin/codeInsight/GotoCompletionProviderInterfaceEx.java
@@ -10,5 +10,5 @@ public interface GotoCompletionProviderInterfaceEx extends GotoCompletionProvide
      * Extended lookup element implementation
      * allowing resultSet modification
      */
-    void getLookupElements(@NotNull GotoCompletionProviderLookupArguments arguments);
+    default void getLookupElements(@NotNull GotoCompletionProviderLookupArguments arguments) {}
 }
diff --git a/src/fr/adrienbrault/idea/symfony2plugin/completion/xml/XmlGotoCompletionRegistrar.java b/src/fr/adrienbrault/idea/symfony2plugin/completion/xml/XmlGotoCompletionRegistrar.java
@@ -15,16 +15,14 @@
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import fr.adrienbrault.idea.symfony2plugin.Symfony2Icons;
 import fr.adrienbrault.idea.symfony2plugin.TwigHelper;
-import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionContributor;
-import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionProvider;
-import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionRegistrar;
-import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionRegistrarParameter;
+import fr.adrienbrault.idea.symfony2plugin.codeInsight.*;
 import fr.adrienbrault.idea.symfony2plugin.codeInsight.utils.GotoCompletionUtil;
 import fr.adrienbrault.idea.symfony2plugin.completion.DecoratedServiceCompletionProvider;
 import fr.adrienbrault.idea.symfony2plugin.config.xml.XmlHelper;
 import fr.adrienbrault.idea.symfony2plugin.routing.RouteGotoCompletionProvider;
 import fr.adrienbrault.idea.symfony2plugin.templating.TemplateGotoCompletionRegistrar;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
+import fr.adrienbrault.idea.symfony2plugin.util.completion.PhpClassCompletionProvider;
 import fr.adrienbrault.idea.symfony2plugin.util.dict.ServiceUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.resource.FileResourceUtil;
 import org.apache.commons.lang.StringUtils;
@@ -148,11 +146,8 @@ private ServiceIdCompletionProvider(PsiElement element) {
             super(element);
         }
 
-        @NotNull
         @Override
-        public Collection<LookupElement> getLookupElements() {
-            Collection<LookupElement> lookupElements = new ArrayList<>();
-
+        public void getLookupElements(@NotNull GotoCompletionProviderLookupArguments arguments) {
             // find class name of service tag
             PsiElement xmlToken = this.getElement();
             if(xmlToken instanceof XmlToken) {
@@ -163,23 +158,28 @@ public Collection<LookupElement> getLookupElements() {
                         PsiElement xmlTag = xmlAttribute.getParent();
                         if(xmlTag instanceof XmlTag) {
                             String aClass = ((XmlTag) xmlTag).getAttributeValue("class");
-                            if(aClass != null && StringUtils.isNotBlank(aClass)) {
-                                lookupElements.add(LookupElementBuilder.create(
-                                    ServiceUtil.getServiceNameForClass(getProject(), aClass)).withIcon(Symfony2Icons.SERVICE)
+                            if(aClass == null) {
+                                // <service id="Foo\Bar"/>
+
+                                PhpClassCompletionProvider.addClassCompletion(
+                                    arguments.getParameters(),
+                                    arguments.getResultSet(),
+                                    getElement(),
+                                    false
                                 );
+                            } else if(StringUtils.isNotBlank(aClass)) {
+                                // <service id="foo.bar" class="Foo\Bar"/>
+
+                                LookupElementBuilder lookupElement = LookupElementBuilder
+                                    .create(ServiceUtil.getServiceNameForClass(getProject(), aClass))
+                                    .withIcon(Symfony2Icons.SERVICE);
+
+                                arguments.getResultSet().addElement(lookupElement);
                             }
                         }
                     }
                 }
             }
-
-            return lookupElements;
-        }
-
-        @NotNull
-        @Override
-        public Collection<PsiElement> getPsiTargets(PsiElement element) {
-            return Collections.emptyList();
         }
     }
 
diff --git a/src/fr/adrienbrault/idea/symfony2plugin/config/xml/XmlReferenceContributor.java b/src/fr/adrienbrault/idea/symfony2plugin/config/xml/XmlReferenceContributor.java
@@ -2,9 +2,7 @@
 
 import com.intellij.patterns.XmlPatterns;
 import com.intellij.psi.*;
-import com.intellij.psi.xml.XmlAttributeValue;
-import com.intellij.psi.xml.XmlText;
-import com.intellij.psi.xml.XmlToken;
+import com.intellij.psi.xml.*;
 import com.intellij.util.ProcessingContext;
 import com.intellij.util.containers.ContainerUtil;
 import com.jetbrains.php.lang.psi.elements.Method;
@@ -19,6 +17,7 @@
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
 import fr.adrienbrault.idea.symfony2plugin.util.dict.ServiceUtil;
+import fr.adrienbrault.idea.symfony2plugin.util.yaml.YamlHelper;
 import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
 
@@ -74,6 +73,13 @@ public PsiReference[] getReferencesByElement(@NotNull PsiElement psiElement, @No
             new ClassPsiReferenceProvider()
         );
 
+        // Symfoyn 3.3 shortcut
+        // <service id="Class\Name">
+        registrar.registerReferenceProvider(
+            XmlHelper.getAttributePattern("id"),
+            new ClassAsIdPsiReferenceProvider()
+        );
+
         // <parameter key="fos_user.user_manager.class">FOS\UserBundle\Doctrine\UserManager</parameter>
         registrar.registerReferenceProvider(
             XmlHelper.getParameterClassValuePattern(),
@@ -259,8 +265,38 @@ public PsiReference[] getReferencesByElement(@NotNull PsiElement psiElement, @No
                 return new PsiReference[0];
             }
 
-            return new PsiReference[]{ new ServiceIdReference(
-                (XmlAttributeValue) psiElement)
+            return new PsiReference[] {
+                new ServiceIdReference((XmlAttributeValue) psiElement)
+            };
+        }
+    }
+
+    /**
+     * Shortcut for service tag without class attribute
+     *
+     * <service id="Foobar\Foobar"/>
+     */
+    private static class ClassAsIdPsiReferenceProvider extends PsiReferenceProvider {
+        @NotNull
+        @Override
+        public PsiReference[] getReferencesByElement(@NotNull PsiElement psiElement, @NotNull ProcessingContext processingContext) {
+            if(!Symfony2ProjectComponent.isEnabled(psiElement) || !(psiElement instanceof XmlAttributeValue)) {
+                return new PsiReference[0];
+            }
+
+            PsiElement parent = psiElement.getParent();
+            if(!(parent instanceof XmlAttribute) && YamlHelper.isClassServiceId(parent.getText())) {
+                return new PsiReference[0];
+            }
+
+            // invalidate on class attribute
+            PsiElement xmlTag = parent.getParent();
+            if(!(xmlTag instanceof XmlTag) || ((XmlTag) xmlTag).getAttribute("class") != null) {
+                return new PsiReference[0];
+            }
+
+            return new PsiReference[] {
+                new ServiceIdWithoutParameterReference((XmlAttributeValue) psiElement)
             };
         }
     }
@@ -355,6 +391,33 @@ public Object[] getVariants() {
 
     }
 
+    /**
+     * <service id="Foobar\Foo"/>
+     */
+    private static class ServiceIdWithoutParameterReference extends PsiPolyVariantReferenceBase<PsiElement> {
+
+        @NotNull
+        private final XmlAttributeValue psiElement;
+
+        private ServiceIdWithoutParameterReference(@NotNull XmlAttributeValue psiElement) {
+            super(psiElement);
+            this.psiElement = psiElement;
+        }
+
+        @NotNull
+        @Override
+        public ResolveResult[] multiResolve(boolean b) {
+            String value = this.psiElement.getValue();
+            return PsiElementResolveResult.createResults(ServiceUtil.getServiceClassTargets(getElement().getProject(), value));
+        }
+
+        @NotNull
+        @Override
+        public Object[] getVariants() {
+            return new Object[0];
+        }
+    }
+
     /**
      * <factory class="FooBar" method="cre<caret>ate"/>
      */
diff --git a/tests/fr/adrienbrault/idea/symfony2plugin/tests/completion/xml/XmlGotoCompletionRegistrarTest.java b/tests/fr/adrienbrault/idea/symfony2plugin/tests/completion/xml/XmlGotoCompletionRegistrarTest.java
@@ -54,6 +54,20 @@ public void testIdInsideServiceTagShouldCompleteWithClassName() {
         );
     }
 
+    public void testIdInsideServiceTagMustCompleteWithClassNameOnShortcut() {
+        assertCompletionContains(
+            XmlFileType.INSTANCE,
+            "<services><service id=\"<caret>\"/></services>",
+            "Foobar"
+        );
+
+        assertCompletionContains(
+            XmlFileType.INSTANCE,
+            "<services><service id=\"Foo\\<caret>\"/></services>",
+            "Foo\\Bar"
+        );
+    }
+
     public void testThatServiceFactoryMethodAttributeProvidesCompletion() {
         assertCompletionContains(XmlFileType.INSTANCE, "" +
                 "<?xml version=\"1.0\"?>\n" +
diff --git a/tests/fr/adrienbrault/idea/symfony2plugin/tests/config/xml/XmlReferenceContributorTest.java b/tests/fr/adrienbrault/idea/symfony2plugin/tests/config/xml/XmlReferenceContributorTest.java
@@ -121,4 +121,16 @@ public void testEnvironmentParameter() {
             PlatformPatterns.psiElement()
         );
     }
+
+    public void testServiceIdAsClassReferences() {
+        assertReferenceMatchOnParent(XmlFileType.INSTANCE, "" +
+                "<?xml version=\"1.0\"?>\n" +
+                "<container>\n" +
+                "    <services>\n" +
+                "        <service id=\"Foo\\<caret>Bar\"/>\n" +
+                "    </services>\n" +
+                "</container>\n",
+            PlatformPatterns.psiElement(PhpClass.class).withName("Bar")
+        );
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,5 @@ public interface GotoCompletionProviderInterfaceEx extends GotoCompletionProvide`
`10`	`10`	`* Extended lookup element implementation`
`11`	`11`	`* allowing resultSet modification`
`12`	`12`	`*/`
`13`		`- void getLookupElements(@NotNull GotoCompletionProviderLookupArguments arguments);`
	`13`	`+ default void getLookupElements(@NotNull GotoCompletionProviderLookupArguments arguments) {}`
`14`	`14`	`}`