provide service completion and references for xml alias attribute #996

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/completion/xml/XmlGotoCompletionRegistrar.java

@@ -19,7 +19,9 @@
 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.dic.ServiceCompletionProvider;
 import fr.adrienbrault.idea.symfony2plugin.routing.RouteGotoCompletionProvider;
+import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
 import fr.adrienbrault.idea.symfony2plugin.templating.TemplateGotoCompletionRegistrar;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.completion.PhpClassCompletionProvider;
@@ -54,6 +56,12 @@ public void register(GotoCompletionRegistrarParameter registrar) {
             ServiceIdCompletionProvider::new
         );
 
+        // <service alias="<caret>"/>
+        registrar.register(
+            XmlPatterns.psiElement().withParent(XmlHelper.getServiceAliasPattern()),
+            ServiceAliasCompletionProvider::new
+        );
+
         // <factory class="AppBundle\Trivago\ConfigFactory" method="create"/>
         // <factory service="foo" method="create"/>
         registrar.register(
@@ -141,6 +149,10 @@ public Collection<PsiElement> getPsiTargets(PsiElement element) {
         }
     }
 
+    /**
+     * <service id="Foo\Bar"/>
+     * <service id="<caret>" class="MyFoo\Foo\Apple"/>
+     */
     private static class ServiceIdCompletionProvider extends GotoCompletionProvider {
         private ServiceIdCompletionProvider(PsiElement element) {
             super(element);
@@ -183,6 +195,22 @@ public void getLookupElements(@NotNull GotoCompletionProviderLookupArguments arg
         }
     }
 
+    /**
+     * <service alias="<caret>"/>
+     */
+    private static class ServiceAliasCompletionProvider extends GotoCompletionProvider {
+        private ServiceAliasCompletionProvider(PsiElement element) {
+            super(element);
+        }
+
+        @Override
+        public void getLookupElements(@NotNull GotoCompletionProviderLookupArguments arguments) {
+            arguments.getResultSet().addAllElements(
+                ServiceCompletionProvider.getLookupElements(null, ContainerCollectionResolver.getServices(getProject()).values()).getLookupElements()
+            );
+        }
+    }
+
     private static class ServiceFactoryMethodCompletionProvider extends GotoCompletionProvider {
         ServiceFactoryMethodCompletionProvider(PsiElement element) {
             super(element);

src/fr/adrienbrault/idea/symfony2plugin/config/xml/XmlHelper.java

@@ -134,6 +134,22 @@ public static XmlAttributeValuePattern getArgumentServiceIdPattern() {
             ).inFile(XmlHelper.getXmlFilePattern());
     }
 
+    /**
+     * <service alias="Foobar" />
+     */
+    public static XmlAttributeValuePattern getServiceAliasPattern() {
+        return XmlPatterns
+            .xmlAttributeValue()
+            .withParent(XmlPatterns
+                .xmlAttribute("alias")
+                .withParent(
+                    XmlPatterns.xmlTag().withName("service")
+                )
+            ).inside(
+                XmlHelper.getInsideTagPattern("services")
+            ).inFile(XmlHelper.getXmlFilePattern());
+    }
+
     /**
      * Possible service id completion on not ready type="service" argument
      *

src/fr/adrienbrault/idea/symfony2plugin/config/xml/XmlReferenceContributor.java

@@ -1,5 +1,6 @@
 package fr.adrienbrault.idea.symfony2plugin.config.xml;
 
+import com.intellij.patterns.PlatformPatterns;
 import com.intellij.patterns.XmlPatterns;
 import com.intellij.psi.*;
 import com.intellij.psi.xml.*;
@@ -33,8 +34,9 @@ public class XmlReferenceContributor extends PsiReferenceContributor {
     public void registerReferenceProviders(PsiReferenceRegistrar registrar) {
 
         // <argument type="service" id="service_container" />
+        // <service alias="Foobar" />
         registrar.registerReferenceProvider(
-            XmlHelper.getArgumentServiceIdPattern(),
+            PlatformPatterns.or(XmlHelper.getArgumentServiceIdPattern(), XmlHelper.getServiceAliasPattern()),
             new ServiceReferenceProvider()
         );
 

src/fr/adrienbrault/idea/symfony2plugin/config/xml/inspection/XmlServiceArgumentInspection.java

@@ -38,7 +38,7 @@ private static class MyPsiElementVisitor extends PsiElementVisitor {
         private final ProblemsHolder holder;
         private ContainerCollectionResolver.LazyServiceCollector lazyServiceCollector;
 
-        public MyPsiElementVisitor(@NotNull ProblemsHolder holder) {
+        MyPsiElementVisitor(@NotNull ProblemsHolder holder) {
             this.holder = holder;
         }
 

src/fr/adrienbrault/idea/symfony2plugin/intentions/yaml/YamlServiceArgumentInspection.java

@@ -27,7 +27,7 @@ public class YamlServiceArgumentInspection extends LocalInspectionTool {
     public static final String[] INVALID_KEYS = new String[]{
         "parent", "factory_class", "factory_service",
         "factory_method", "abstract", "factory",
-        "resource", "exclude"
+        "resource", "exclude", "alias"
     };
 
     @NotNull

tests/fr/adrienbrault/idea/symfony2plugin/tests/SymfonyLightCodeInsightFixtureTestCase.java

@@ -638,8 +638,8 @@ private void assertReferences(@NotNull ElementPattern<?> pattern, PsiElement psi
             }
 
             // multiResolve support
-            if(element instanceof PsiPolyVariantReference) {
-                for (ResolveResult resolveResult : ((PsiPolyVariantReference) element).multiResolve(true)) {
+            if(reference instanceof PsiPolyVariantReference) {
+                for (ResolveResult resolveResult : ((PsiPolyVariantReference) reference).multiResolve(true)) {
                     if (pattern.accepts(resolveResult.getElement())) {
                         return;
                     }

tests/fr/adrienbrault/idea/symfony2plugin/tests/action/ServiceActionUtilTest.java

@@ -21,6 +21,14 @@ public void testThatAutowireForServiceBlocksInspect() {
         assertFalse(ServiceActionUtil.isValidXmlParameterInspectionService(xmlTag));
     }
 
+    public void testThatAliasAttributeBlocksInspect() {
+        XmlTag xmlTag = createServiceXmlTag(
+            "<services><serv<caret>ice id=\"Foobar\" alias=\"Test\"/></services>"
+        );
+
+        assertFalse(ServiceActionUtil.isValidXmlParameterInspectionService(xmlTag));
+    }
+
     public void testThatDefaultValueIsOverwriteInService() {
         XmlTag xmlTag = createServiceXmlTag(
             "    <services>\n" +

tests/fr/adrienbrault/idea/symfony2plugin/tests/completion/xml/XmlGotoCompletionRegistrarTest.java

@@ -68,6 +68,14 @@ public void testIdInsideServiceTagMustCompleteWithClassNameOnShortcut() {
         );
     }
 
+    public void testThatServiceAliasAttributeMustProvideCompletion() {
+        assertCompletionContains(
+            XmlFileType.INSTANCE,
+            "<services><service alias=\"<caret>\"></services>",
+            "foo.bar_factory"
+        );
+    }
+
     public void testThatServiceFactoryMethodAttributeProvidesCompletion() {
         assertCompletionContains(XmlFileType.INSTANCE, "" +
                 "<?xml version=\"1.0\"?>\n" +