Merge pull request #1932 from Haehnchen/feature/resource-namespace

Haehnchen · web-flow · commit 78e99b8f530a · 2022-05-13T15:48:42.000+02:00
provide navigation for "resource" and "exclude" of yaml files
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlCompletionContributor.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlCompletionContributor.java
@@ -239,7 +239,7 @@ public void addCompletions(@NotNull CompletionParameters parameters,
         // tags: [ foobar ]
         extend(
             CompletionType.BASIC,
-            YamlElementPatternHelper.getTagsAsSequencePattern(),
+            YamlElementPatternHelper.getSequenceValueWithArrayKeyPattern("tags"),
             new TagNameCompletionProvider()
         );
 
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlElementPatternHelper.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlElementPatternHelper.java
@@ -710,12 +710,12 @@ public static PsiElementPattern.Capture<PsiElement> getRootConfigKeyPattern() {
     /**
      * tags: [ foobar ]
      */
-    public static PsiElementPattern.Capture<PsiElement> getTagsAsSequencePattern() {
+    public static PsiElementPattern.Capture<PsiElement> getSequenceValueWithArrayKeyPattern(@NotNull String... keys) {
         return PlatformPatterns.psiElement().withParent(
             PlatformPatterns.psiElement(YAMLScalar.class).withParent(
                 PlatformPatterns.psiElement(YAMLSequenceItem.class).withParent(
                     PlatformPatterns.psiElement(YAMLSequence.class).withParent(
-                        PlatformPatterns.psiElement(YAMLKeyValue.class).withName("tags")
+                        PlatformPatterns.psiElement(YAMLKeyValue.class).withName(keys)
                     )
                 )
             )
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlGoToDeclarationHandler.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlGoToDeclarationHandler.java
@@ -3,11 +3,12 @@
 import com.intellij.codeInsight.navigation.actions.GotoDeclarationHandler;
 import com.intellij.openapi.actionSystem.DataContext;
 import com.intellij.openapi.editor.Editor;
-import com.intellij.openapi.project.Project;
+import com.intellij.openapi.vfs.VfsUtil;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.patterns.PlatformPatterns;
 import com.intellij.patterns.PsiElementPattern;
 import com.intellij.patterns.StandardPatterns;
+import com.intellij.psi.PsiDirectory;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.tree.IElementType;
@@ -25,18 +26,23 @@
 import fr.adrienbrault.idea.symfony2plugin.stubs.ServiceIndexUtil;
 import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
-import fr.adrienbrault.idea.symfony2plugin.util.PhpIndexUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
 import fr.adrienbrault.idea.symfony2plugin.util.dict.ServiceUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.resource.FileResourceUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.yaml.YamlHelper;
+import kotlin.Pair;
 import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.yaml.YAMLTokenTypes;
 import org.jetbrains.yaml.psi.*;
 
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.*;
+import java.nio.file.attribute.BasicFileAttributes;
 import java.util.*;
+import java.util.stream.Collectors;
 
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
@@ -136,7 +142,7 @@ public PsiElement[] getGotoDeclarationTargets(PsiElement psiElement, int i, Edit
         }
 
         // tags: [ name: foobar ]
-        if(YamlElementPatternHelper.getTagsAsSequencePattern().accepts(psiElement)) {
+        if(YamlElementPatternHelper.getSequenceValueWithArrayKeyPattern("tags").accepts(psiElement)) {
             targets.addAll(getTagClassesGoto(psiElement));
         }
 
@@ -183,7 +189,17 @@ public PsiElement[] getGotoDeclarationTargets(PsiElement psiElement, int i, Edit
             targets.addAll(getClassesForServiceKey(psiElement));
         }
 
-        return targets.toArray(new PsiElement[targets.size()]);
+        // resource: '../src/'
+        // exclude:
+        //    - '../src/DependencyInjection/'
+        if (StandardPatterns.or(
+            YamlElementPatternHelper.getSingleLineScalarKey("exclude", "resource"),
+            YamlElementPatternHelper.getSequenceValueWithArrayKeyPattern("exclude", "resource")
+        ).accepts(psiElement)) {
+            targets.addAll(attachGlobResources(psiElement));
+        }
+
+        return targets.toArray(new PsiElement[0]);
     }
 
     private Collection<? extends PsiElement> namedDefaultBindArgumentGoto(@NotNull PsiElement psiElement, @NotNull String parameterName) {
@@ -449,6 +465,38 @@ private Collection<PsiElement> attachResourceBundleGoto(@NotNull PsiElement psiE
 
     }
 
+    @NotNull
+    private Collection<PsiElement> attachGlobResources(@NotNull PsiElement psiElement) {
+        String resource = PsiElementUtils.trimQuote(psiElement.getText());
+        if (StringUtils.isBlank(resource)) {
+            return Collections.emptyList();
+        }
+
+        PsiFile containingFile = psiElement.getContainingFile();
+        if (containingFile == null) {
+            return Collections.emptyList();
+        }
+
+        VirtualFile virtualFile = containingFile.getVirtualFile();
+        if (virtualFile == null) {
+            return Collections.emptyList();
+        }
+
+        PsiElement quotedText = psiElement.getParent();
+        if (!(quotedText instanceof YAMLQuotedText)) {
+            return Collections.emptyList();
+        }
+
+        String name = YamlHelper.getServiceKeyFromResourceFromStringOrArray((YAMLQuotedText) quotedText);
+        if (name == null) {
+            return Collections.emptyList();
+        }
+
+        return new HashSet<>(
+            ServiceContainerUtil.getPhpClassFromResources(psiElement.getProject(), name, virtualFile, List.of(resource), Collections.emptyList())
+        );
+    }
+
     @NotNull
     private Collection<PsiElement> attachResourceOnPathGoto(@NotNull PsiElement psiElement) {
         String text = PsiElementUtils.trimQuote(psiElement.getText());
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/util/yaml/YamlHelper.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/util/yaml/YamlHelper.java
@@ -1366,4 +1366,54 @@ public static boolean isElementAfterEol(PsiElement psiElement) {
         }
         return PsiElementUtils.getPrevSiblingOfType(psiElement, PlatformPatterns.psiElement(YAMLTokenTypes.EOL)) != null;
     }
+
+    /**
+     * App\\:
+     *   resource: 'foobar_2'
+     * App\\:
+     *   resource: ['foobar_2', 'foobar_3']
+     */
+    @Nullable
+    public static String getServiceKeyFromResourceFromStringOrArray(@NotNull YAMLQuotedText yamlQuotedText) {
+        PsiElement yamlSequence = yamlQuotedText.getParent();
+        if (yamlSequence == null) {
+            return null;
+        }
+
+        YAMLKeyValue serviceKeyValue = null;
+        if (yamlSequence instanceof YAMLSequenceItem) {
+            PsiElement yamlArray = yamlSequence.getParent();
+            if (yamlArray instanceof YAMLSequence) {
+                PsiElement yamlKeyValueResource = yamlArray.getParent();
+                if (yamlKeyValueResource instanceof YAMLKeyValue) {
+                    PsiElement mapping = yamlKeyValueResource.getParent();
+                    if (mapping instanceof YAMLMapping) {
+                        PsiElement serviceKeyValueElement = mapping.getParent();
+                        if (serviceKeyValueElement instanceof YAMLKeyValue) {
+                            serviceKeyValue = (YAMLKeyValue) serviceKeyValueElement;
+                        }
+                    }
+                }
+            }
+        } else {
+            PsiElement yamlKeyValueResource = yamlSequence.getParent();
+            if (yamlKeyValueResource != null) {
+                PsiElement serviceKeyValueElement = yamlKeyValueResource.getParent();
+                if (serviceKeyValueElement instanceof YAMLKeyValue) {
+                    serviceKeyValue = (YAMLKeyValue) serviceKeyValueElement;
+                }
+            }
+        }
+
+        if (serviceKeyValue == null) {
+            return null;
+        }
+
+        String name = serviceKeyValue.getName();
+        if (StringUtils.isBlank(name)) {
+            return null;
+        }
+
+        return name;
+    }
 }
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/resource/FileResourceUtilTest.java b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/resource/FileResourceUtilTest.java
@@ -5,6 +5,7 @@
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
 import fr.adrienbrault.idea.symfony2plugin.util.resource.FileResourceUtil;
+import kotlin.Pair;
 
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/yaml/YamlHelperLightTest.java b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/yaml/YamlHelperLightTest.java
@@ -13,10 +13,7 @@
 import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.yaml.YAMLFileType;
-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.*;
 import org.jetbrains.yaml.psi.impl.YAMLHashImpl;
 
 import java.util.ArrayList;
@@ -590,6 +587,24 @@ public void testGetTaggedServices() {
         assertTrue(taggedServices2.stream().anyMatch(yamlKeyValue -> "foobar2".equals(yamlKeyValue.getKey().getText())));
     }
 
+    public void testGetServiceKeyFromResourceFromStringOrArray() {
+        YAMLQuotedText fromText = YamlPsiElementFactory.createFromText(getProject(), YAMLQuotedText.class,
+            "services:\n" +
+                "   App\\:\n" +
+                "       resource: 'foobar'"
+        );
+
+        assertEquals("App\\", YamlHelper.getServiceKeyFromResourceFromStringOrArray(fromText));
+
+        fromText = YamlPsiElementFactory.createFromText(getProject(), YAMLQuotedText.class,
+            "services:\n" +
+                "   App\\:\n" +
+                "       resource: ['foobar_2', 'foobar_3']"
+        );
+
+        assertEquals("App\\", YamlHelper.getServiceKeyFromResourceFromStringOrArray(fromText));
+    }
+
     private int getIndentForTextContent(@NotNull String content) {
         return YamlHelper.getIndentSpaceForFile((YAMLFile) YamlPsiElementFactory.createDummyFile(
             getProject(),

Original file line number	Diff line number	Diff line change
`@@ -710,12 +710,12 @@ public static PsiElementPattern.Capture<PsiElement> getRootConfigKeyPattern() {`
`710`	`710`	`/**`
`711`	`711`	`* tags: [ foobar ]`
`712`	`712`	`*/`
`713`		`- public static PsiElementPattern.Capture<PsiElement> getTagsAsSequencePattern() {`
	`713`	`+ public static PsiElementPattern.Capture<PsiElement> getSequenceValueWithArrayKeyPattern(@NotNull String... keys) {`
`714`	`714`	`return PlatformPatterns.psiElement().withParent(`
`715`	`715`	`PlatformPatterns.psiElement(YAMLScalar.class).withParent(`
`716`	`716`	`PlatformPatterns.psiElement(YAMLSequenceItem.class).withParent(`
`717`	`717`	`PlatformPatterns.psiElement(YAMLSequence.class).withParent(`
`718`		`- PlatformPatterns.psiElement(YAMLKeyValue.class).withName("tags")`
	`718`	`+ PlatformPatterns.psiElement(YAMLKeyValue.class).withName(keys)`
`719`	`719`	`)`
`720`	`720`	`)`
`721`	`721`	`)`