fix pattern for Yaml method "calls" #755 also implement named services support

Haehnchen · Haehnchen · commit 79f5e28a6ade · 2017-04-16T16:30:45.000+02:00
diff --git a/src/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlCompletionContributor.java b/src/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlCompletionContributor.java
@@ -11,6 +11,7 @@
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.util.PsiTreeUtil;
+import com.intellij.util.Consumer;
 import com.intellij.util.ProcessingContext;
 import com.jetbrains.php.completion.PhpLookupElement;
 import com.jetbrains.php.lang.psi.elements.Method;
@@ -199,9 +200,12 @@ public void addCompletions(@NotNull CompletionParameters parameters,
             YamlElementPatternHelper.getSingleLineScalarKey("alias")
         ), new FormAliasCompletionProvider());
 
-        extend(CompletionType.BASIC, StandardPatterns.and(
-            YamlElementPatternHelper.getInsideKeyValue("calls")
-        ), new ServiceCallsMethodCompletion());
+        // - [ setContainer, [ @service_container ] ]
+        extend(
+            CompletionType.BASIC,
+            YamlElementPatternHelper.getInsideKeyValue("calls"),
+            new ServiceCallsMethodCompletion()
+        );
 
         extend(CompletionType.BASIC, StandardPatterns.and(
             YamlElementPatternHelper.getInsideKeyValue("tags"),
@@ -380,27 +384,23 @@ protected void addCompletions(@NotNull CompletionParameters completionParameters
     private class ServiceCallsMethodCompletion extends CompletionProvider<CompletionParameters> {
 
         protected void addCompletions(@NotNull CompletionParameters completionParameters, ProcessingContext processingContext, @NotNull CompletionResultSet completionResultSet) {
-
             if(!Symfony2ProjectComponent.isEnabled(completionParameters.getPosition())) {
                 return;
             }
 
-            // TODO: move this to pattern; filters match on parameter array
             // - [ setContainer, [ @service_container ] ]
             PsiElement psiElement = completionParameters.getPosition();
-            if(psiElement.getParent() == null || !(psiElement.getParent().getContext() instanceof YAMLSequence)) {
-                return;
-            }
 
-            YAMLKeyValue callYamlKeyValue = PsiTreeUtil.getParentOfType(psiElement, YAMLKeyValue.class);
-            if(callYamlKeyValue == null) {
-                return;
+            PsiElement yamlScalar = psiElement.getParent();
+            if(yamlScalar instanceof YAMLScalar) {
+                YamlHelper.visitServiceCall((YAMLScalar) yamlScalar, clazz -> {
+                    PhpClass phpClass = ServiceUtil.getResolvedClassDefinition(psiElement.getProject(), clazz);
+                    if(phpClass != null) {
+                        PhpElementsUtil.addClassPublicMethodCompletion(completionResultSet, phpClass);
+                    }
+                });
             }
-
-            addYamlClassMethods(callYamlKeyValue.getContext(), completionResultSet, "class");
-
         }
-
     }
 
     private static void addYamlClassMethods(@Nullable PsiElement psiElement, CompletionResultSet completionResultSet, String classTag) {
diff --git a/src/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlGoToKnownDeclarationHandler.java b/src/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlGoToKnownDeclarationHandler.java
@@ -8,6 +8,7 @@
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.util.PsiTreeUtil;
+import com.intellij.util.Consumer;
 import com.jetbrains.php.lang.psi.elements.Method;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
@@ -191,31 +192,19 @@ private void getClassGoto(PsiElement psiElement, List<PsiElement> results) {
     }
 
     private void getMethodGoto(PsiElement psiElement, List<PsiElement> results) {
-
-        YAMLCompoundValue yamlCompoundValue = PsiTreeUtil.getParentOfType(psiElement, YAMLCompoundValue.class);
-        if(yamlCompoundValue == null) {
-            return;
-        }
-
-        yamlCompoundValue = PsiTreeUtil.getParentOfType(yamlCompoundValue, YAMLCompoundValue.class);
-        if(yamlCompoundValue == null) {
-            return;
-        }
-
-        YAMLKeyValue classKeyValue = PsiElementUtils.getChildrenOfType(yamlCompoundValue, PlatformPatterns.psiElement(YAMLKeyValue.class).withName("class"));
-        if(classKeyValue == null) {
-            return;
-        }
-
-        PhpClass phpClass = ServiceUtil.getResolvedClassDefinition(psiElement.getProject(), classKeyValue.getValueText());
-        if(phpClass != null) {
-            for(Method method: PhpElementsUtil.getClassPublicMethod(phpClass)) {
-                if(method.getName().equals(PsiElementUtils.trimQuote(psiElement.getText()))) {
-                    results.add(method);
+        PsiElement parent = psiElement.getParent();
+        if(parent instanceof YAMLScalar) {
+            YamlHelper.visitServiceCall((YAMLScalar) parent, clazz -> {
+                PhpClass phpClass = ServiceUtil.getResolvedClassDefinition(psiElement.getProject(),clazz);
+                if(phpClass != null) {
+                    for(Method method: PhpElementsUtil.getClassPublicMethod(phpClass)) {
+                        if(method.getName().equals(PsiElementUtils.trimQuote(psiElement.getText()))) {
+                            results.add(method);
+                        }
+                    }
                 }
-            }
+            });
         }
-
     }
 
     private void getTagMethodGoto(PsiElement psiElement, List<PsiElement> results) {
diff --git a/src/fr/adrienbrault/idea/symfony2plugin/config/yaml/inspection/EventMethodCallInspection.java b/src/fr/adrienbrault/idea/symfony2plugin/config/yaml/inspection/EventMethodCallInspection.java
@@ -12,6 +12,7 @@
 import com.intellij.psi.PsiRecursiveElementWalkingVisitor;
 import com.intellij.psi.util.PsiTreeUtil;
 import com.intellij.psi.xml.XmlFile;
+import com.intellij.util.Consumer;
 import com.jetbrains.php.lang.parser.PhpElementTypes;
 import com.jetbrains.php.lang.psi.PhpFile;
 import com.jetbrains.php.lang.psi.elements.Method;
@@ -141,37 +142,14 @@ private void annotateCallMethod(@NotNull final PsiElement psiElement, @NotNull P
     }
 
     private void visitYamlMethod(PsiElement psiElement, ProblemsHolder holder, ContainerCollectionResolver.LazyServiceCollector collector) {
-        if(!YamlElementPatternHelper.getInsideKeyValue("calls").accepts(psiElement)){
-            return;
-        }
-
-        PsiElement parent = psiElement.getParent();
-        if(!(parent instanceof YAMLScalar)) {
-            return;
-        }
-
-        PsiElement yamlSeq = parent.getContext();
-        if(!(yamlSeq instanceof YAMLSequenceItem)) {
-            return;
-        }
-
-        PsiElement context = yamlSeq.getContext();
-        if(!(context instanceof YAMLSequence)) {
-            return;
-        }
-
-        YAMLKeyValue callYamlKeyValue = PsiTreeUtil.getParentOfType(psiElement, YAMLKeyValue.class);
-        if(callYamlKeyValue == null) {
-            return;
-        }
-
-        YAMLKeyValue classKeyValue = YamlHelper.getYamlKeyValue(callYamlKeyValue.getContext(), "class");
-        if(classKeyValue == null) {
-            return;
+        if(YamlElementPatternHelper.getInsideKeyValue("calls").accepts(psiElement)) {
+            PsiElement parent = psiElement.getParent();
+            if ((parent instanceof YAMLScalar)) {
+                YamlHelper.visitServiceCall((YAMLScalar) parent, s ->
+                    registerMethodProblem(psiElement, holder, YamlHelper.trimSpecialSyntaxServiceName(s), collector)
+                );
+            }
         }
-
-        registerMethodProblem(psiElement, holder, getServiceName(classKeyValue.getValue()), collector);
-
     }
 
     private void registerMethodProblem(final @NotNull PsiElement psiElement, @NotNull ProblemsHolder holder, @NotNull String classKeyValue, ContainerCollectionResolver.LazyServiceCollector collector) {
@@ -285,6 +263,5 @@ public void visitElement(PsiElement element) {
                 }
             }
         }
-
     }
 }
diff --git a/src/fr/adrienbrault/idea/symfony2plugin/util/yaml/YamlHelper.java b/src/fr/adrienbrault/idea/symfony2plugin/util/yaml/YamlHelper.java
@@ -14,6 +14,7 @@
 import com.intellij.util.ObjectUtils;
 import com.intellij.util.Processor;
 import com.intellij.util.containers.ContainerUtil;
+import com.jetbrains.php.refactoring.PhpNameUtil;
 import fr.adrienbrault.idea.symfony2plugin.dic.tags.yaml.StaticAttributeResolver;
 import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
 import fr.adrienbrault.idea.symfony2plugin.util.yaml.visitor.YamlServiceTag;
@@ -923,4 +924,52 @@ public static boolean isClassServiceId(@NotNull String serviceId) {
 
         return false;
     }
+
+    /**
+     * service_name:
+     *   class: FOOBAR
+     *   calls:
+     *      - [onF<caret>oobar, []]
+     *
+     * FOOBAR:
+     *   calls:
+     *      - [onF<caret>oobar, []]
+     */
+    public static void visitServiceCall(@NotNull YAMLScalar yamlScalar, @NotNull Consumer<String> consumer) {
+        PsiElement yamlSeq = yamlScalar.getContext();
+        if(yamlSeq instanceof YAMLSequenceItem) {
+            PsiElement context = yamlSeq.getContext();
+            if(context instanceof YAMLSequence) {
+                PsiElement yamlSequenceItem = context.getParent();
+                if(yamlSequenceItem instanceof YAMLSequenceItem) {
+                    PsiElement yamlSeq1 = yamlSequenceItem.getParent();
+                    if(yamlSeq1 instanceof YAMLSequence) {
+                        PsiElement callYamlKeyValue = yamlSeq1.getParent();
+                        if(callYamlKeyValue instanceof YAMLKeyValue) {
+                            YAMLKeyValue classKeyValue = YamlHelper.getYamlKeyValue(callYamlKeyValue.getContext(), "class");
+                            if(classKeyValue != null) {
+                                // "class" key found use this as valid class name
+                                String valueText = classKeyValue.getValueText();
+                                if(StringUtils.isNotBlank(valueText)) {
+                                    consumer.consume(valueText);
+                                }
+                            } else {
+                                // named services; key is our class name
+                                PsiElement yamlMapping = callYamlKeyValue.getParent();
+                                if(yamlMapping instanceof YAMLMapping) {
+                                    PsiElement parent = yamlMapping.getParent();
+                                    if(parent instanceof YAMLKeyValue) {
+                                        String keyText = ((YAMLKeyValue) parent).getKeyText();
+                                        if(!keyText.contains(".") && PhpNameUtil.isValidNamespaceFullName(keyText)) {
+                                            consumer.consume(keyText);
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
 }
diff --git a/tests/fr/adrienbrault/idea/symfony2plugin/tests/config/yaml/YamlCompletionContributorTest.java b/tests/fr/adrienbrault/idea/symfony2plugin/tests/config/yaml/YamlCompletionContributorTest.java
@@ -1,7 +1,10 @@
 package fr.adrienbrault.idea.symfony2plugin.tests.config.yaml;
 
+import com.intellij.patterns.PlatformPatterns;
 import com.jetbrains.php.lang.PhpFileType;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
 import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
+import org.jetbrains.yaml.YAMLFileType;
 
 import java.io.File;
 
@@ -19,6 +22,7 @@ public void setUp() throws Exception {
         myFixture.configureByText("config_foo.yml", "");
         myFixture.configureByFile("YamlCompletionContributor.php");
         myFixture.configureByFile("tagged.services.xml");
+        myFixture.configureByFile("classes.php");
     }
 
     public String getTestDataPath() {
@@ -201,4 +205,24 @@ public void testParameterCompletionInsertHandler() {
                 "    foo: [\"%foo_parameter%\"]"
         );
     }
+
+    public void testThatMethodOfClassAreCompleted() {
+        assertCompletionContains(YAMLFileType.YML, "" +
+            "services:\n" +
+            "    foobar:\n" +
+            "       class: Foo\\Bar\n" +
+            "       calls:\n" +
+            "           - [ <caret> ]\n",
+            "setBar"
+        );
+
+        assertCompletionContains(YAMLFileType.YML, "" +
+                "services:\n" +
+                "    foobar:\n" +
+                "       class: Foo\\Bar\n" +
+                "       calls:\n" +
+                "           - [ '<caret>' ]\n",
+            "setBar"
+        );
+    }
 }
diff --git a/tests/fr/adrienbrault/idea/symfony2plugin/tests/config/yaml/YamlGoToKnownDeclarationHandlerTest.java b/tests/fr/adrienbrault/idea/symfony2plugin/tests/config/yaml/YamlGoToKnownDeclarationHandlerTest.java
@@ -82,4 +82,15 @@ public void testNavigateToClassServiceAsKeyForSymfony33() {
             PlatformPatterns.psiElement(PhpClass.class)
         );
     }
+
+    public void testNavigateForCallsMethodIsProvided() {
+        assertNavigationMatch("services.yml", "" +
+            "services:\n" +
+            "    foobar:\n" +
+            "       class: Foo\\Bar\n" +
+            "       calls:\n" +
+            "           - [ set<caret>Bar, [@foo]]\n" +
+            PlatformPatterns.psiElement(PhpClass.class)
+        );
+    }
 }
diff --git a/tests/fr/adrienbrault/idea/symfony2plugin/tests/config/yaml/fixtures/classes.php b/tests/fr/adrienbrault/idea/symfony2plugin/tests/config/yaml/fixtures/classes.php
@@ -12,6 +12,7 @@ class MyDateTime
     class Bar
     {
         function __construct($i, $z) { }
+        function setBar() {}
     }
 
     class Apple
diff --git a/tests/fr/adrienbrault/idea/symfony2plugin/tests/util/yaml/YamlHelperLightTest.java b/tests/fr/adrienbrault/idea/symfony2plugin/tests/util/yaml/YamlHelperLightTest.java
@@ -1,6 +1,7 @@
 package fr.adrienbrault.idea.symfony2plugin.tests.util.yaml;
 
 import com.intellij.psi.PsiElement;
+import com.intellij.util.Consumer;
 import com.intellij.util.Function;
 import com.intellij.util.containers.ContainerUtil;
 import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
@@ -14,10 +15,12 @@
 import org.jetbrains.yaml.psi.YAMLCompoundValue;
 import org.jetbrains.yaml.psi.YAMLFile;
 import org.jetbrains.yaml.psi.YAMLKeyValue;
+import org.jetbrains.yaml.psi.YAMLScalar;
 import org.jetbrains.yaml.psi.impl.YAMLArrayImpl;
 import org.jetbrains.yaml.psi.impl.YAMLHashImpl;
 
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.List;
 import java.util.Set;
 
@@ -375,6 +378,45 @@ public void testInsertKeyValueWithMissingMainKeyInRoot() {
         );
     }
 
+    /**
+     * @see fr.adrienbrault.idea.symfony2plugin.util.yaml.YamlHelper#visitServiceCall
+     */
+    public void testVisitServiceCall() {
+        myFixture.configureByText(YAMLFileType.YML, "services:\n" +
+            "    foobar:\n" +
+            "       class: Foo\\Bar\n" +
+            "       calls:\n" +
+            "           - [ '<caret>' ]\n"
+        );
+
+        PsiElement psiElement = myFixture.getFile().findElementAt(myFixture.getCaretOffset());
+        YAMLScalar parent = (YAMLScalar) psiElement.getParent();
+
+        Collection<String> values = new ArrayList<>();
+        YamlHelper.visitServiceCall(parent, values::add);
+
+        assertContainsElements(values, "Foo\\Bar");
+    }
+
+    /**
+     * @see fr.adrienbrault.idea.symfony2plugin.util.yaml.YamlHelper#visitServiceCall
+     */
+    public void testVisitServiceCallForNamedServices() {
+        myFixture.configureByText(YAMLFileType.YML, "services:\n" +
+            "    Foo\\Bar:\n" +
+            "       calls:\n" +
+            "           - [ '<caret>' ]\n"
+        );
+
+        PsiElement psiElement = myFixture.getFile().findElementAt(myFixture.getCaretOffset());
+        YAMLScalar parent = (YAMLScalar) psiElement.getParent();
+
+        Collection<String> values = new ArrayList<>();
+        YamlHelper.visitServiceCall(parent, values::add);
+
+        assertContainsElements(values, "Foo\\Bar");
+    }
+
     private static class ListYamlTagVisitor implements YamlTagVisitor {
 
         private List<YamlServiceTag> items = new ArrayList<YamlServiceTag>();

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ class MyDateTime`
`12`	`12`	`class Bar`
`13`	`13`	`{`
`14`	`14`	`function __construct($i, $z) { }`
	`15`	`+ function setBar() {}`
`15`	`16`	`}`
`16`	`17`
`17`	`18`	`class Apple`