Add parameter completion and navigation support for PHP array service configurations

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/config/php/PhpArrayGotoCompletionRegistrar.java

@@ -1,20 +1,30 @@
 package fr.adrienbrault.idea.symfony2plugin.config.php;
 
+import com.intellij.codeInsight.lookup.LookupElement;
 import com.intellij.patterns.PlatformPatterns;
 import com.intellij.psi.PsiElement;
 import com.jetbrains.php.lang.PhpLanguage;
 import com.jetbrains.php.lang.psi.elements.StringLiteralExpression;
 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.utils.GotoCompletionUtil;
 import fr.adrienbrault.idea.symfony2plugin.completion.DecoratedServiceCompletionProvider;
+import fr.adrienbrault.idea.symfony2plugin.config.component.parser.ParameterLookupPercentElement;
+import fr.adrienbrault.idea.symfony2plugin.dic.ContainerParameter;
+import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
+import fr.adrienbrault.idea.symfony2plugin.util.dict.ServiceUtil;
+import fr.adrienbrault.idea.symfony2plugin.util.yaml.YamlHelper;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+
 /**
- * Registers service-id completion for PHP array `decorates` and `parent` values, eg:
- * `'decorates' => 'mailer'`
- * `'parent' => 'app.abstract_mailer'`
+ * Registers completion/navigation for PHP array service config values.
  */
 public class PhpArrayGotoCompletionRegistrar implements GotoCompletionRegistrar {
     @Override
@@ -34,6 +44,27 @@ public void register(@NotNull GotoCompletionRegistrarParameter registrar) {
                 return new DecoratesParentContributor(stringLiteralExpression);
             }
         );
+
+        registrar.register(
+            PlatformPatterns.psiElement().withParent(StringLiteralExpression.class).withLanguage(PhpLanguage.INSTANCE),
+            psiElement -> {
+                if (!(psiElement.getParent() instanceof StringLiteralExpression stringLiteralExpression)) {
+                    return null;
+                }
+
+                PhpArrayServiceUtil.ServiceConfigPath keyPath = PhpArrayServiceUtil.getKeyPath(stringLiteralExpression);
+                if (keyPath == null || !keyPath.isArgument()) {
+                    return null;
+                }
+
+                String contents = stringLiteralExpression.getContents();
+                if (!contents.isBlank() && !contents.startsWith("%")) {
+                    return null;
+                }
+
+                return new ParameterArgumentContributor(stringLiteralExpression);
+            }
+        );
     }
 
     private static class DecoratesParentContributor extends DecoratedServiceCompletionProvider {
@@ -53,4 +84,33 @@ public String findIdForElement(@NotNull PsiElement psiElement) {
             return PhpArrayServiceUtil.getServiceId(psiElement);
         }
     }
+
+    private static class ParameterArgumentContributor extends GotoCompletionProvider {
+        private ParameterArgumentContributor(@NotNull StringLiteralExpression element) {
+            super(element);
+        }
+
+        @NotNull
+        @Override
+        public Collection<LookupElement> getLookupElements() {
+            List<LookupElement> results = new ArrayList<>();
+
+            for (ContainerParameter containerParameter : ContainerCollectionResolver.getParameters(getProject()).values()) {
+                results.add(new ParameterLookupPercentElement(containerParameter));
+            }
+
+            return results;
+        }
+
+        @NotNull
+        @Override
+        public Collection<PsiElement> getPsiTargets(PsiElement element) {
+            String parameterName = GotoCompletionUtil.getStringLiteralValue(element);
+            if (parameterName == null || !YamlHelper.isValidParameterName(parameterName)) {
+                return Collections.emptyList();
+            }
+
+            return ServiceUtil.getServiceClassTargets(element.getProject(), parameterName);
+        }
+    }
 }

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/config/php/PhpArrayGotoCompletionRegistrarTest.java

@@ -12,6 +12,7 @@ public void setUp() throws Exception {
         super.setUp();
         myFixture.addFileToProject("src/Service/Mailer.php", "<?php\nnamespace App\\Service;\nclass Mailer {}\n");
         myFixture.addFileToProject("src/Service/DecoratingMailer.php", "<?php\nnamespace App\\Service;\nclass DecoratingMailer extends Mailer {}\n");
+        myFixture.addFileToProject("config/parameters.yaml", "parameters:\n    mailer.transport: smtp\n");
         myFixture.addFileToProject("config/php_array_targets.php", "<?php\nnamespace Symfony\\Component\\DependencyInjection\\Loader\\Configurator;\nreturn App::config([\n    'services' => [\n        'app.mailer' => ['class' => \\App\\Service\\Mailer::class],\n    ],\n]);\n");
     }
 
@@ -65,4 +66,66 @@ public void testDecoratesCompletionPrioritizesMatchingService() {
             lookupElement -> "app.mailer".equals(lookupElement.getItemText()) && lookupElement.isItemTextBold()
         );
     }
+
+    public void testArgumentsParameterCompletion() {
+        assertCompletionContains(
+            PhpFileType.INSTANCE,
+            "<?php\n" +
+                "namespace Symfony\\Component\\DependencyInjection\\Loader\\Configurator;\n" +
+                "return [\n" +
+                "    'services' => [\n" +
+                "        'app.foo' => [\n" +
+                "            'arguments' => ['%<caret>'],\n" +
+                "        ],\n" +
+                "    ],\n" +
+                "];",
+            "%mailer.transport%"
+        );
+    }
+
+    public void testCallsArgumentParameterCompletion() {
+        assertCompletionContains(
+            PhpFileType.INSTANCE,
+            "<?php\n" +
+                "namespace Symfony\\Component\\DependencyInjection\\Loader\\Configurator;\n" +
+                "return [\n" +
+                "    'services' => [\n" +
+                "        'app.foo' => [\n" +
+                "            'calls' => [['setTransport', ['%<caret>']]],\n" +
+                "        ],\n" +
+                "    ],\n" +
+                "];",
+            "%mailer.transport%"
+        );
+    }
+
+    public void testArgumentsParameterNavigation() {
+        assertNavigationMatch(
+            PhpFileType.INSTANCE,
+            "<?php\n" +
+                "namespace Symfony\\Component\\DependencyInjection\\Loader\\Configurator;\n" +
+                "return [\n" +
+                "    'services' => [\n" +
+                "        'app.foo' => [\n" +
+                "            'arguments' => ['%mailer.trans<caret>port%'],\n" +
+                "        ],\n" +
+                "    ],\n" +
+                "];"
+        );
+    }
+
+    public void testCallsArgumentParameterNavigation() {
+        assertNavigationMatch(
+            PhpFileType.INSTANCE,
+            "<?php\n" +
+                "namespace Symfony\\Component\\DependencyInjection\\Loader\\Configurator;\n" +
+                "return [\n" +
+                "    'services' => [\n" +
+                "        'app.foo' => [\n" +
+                "            'calls' => [['setTransport', ['%mailer.trans<caret>port%']]],\n" +
+                "        ],\n" +
+                "    ],\n" +
+                "];"
+        );
+    }
 }