index usages of twig files inside "Template" php attribute

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/util/PhpMethodVariableResolveUtil.java

@@ -15,6 +15,7 @@
 import fr.adrienbrault.idea.symfony2plugin.templating.variable.dict.PsiVariable;
 import fr.adrienbrault.idea.symfony2plugin.util.AnnotationBackportUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
+import fr.adrienbrault.idea.symfony2plugin.util.PhpPsiAttributesUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
 import kotlin.Triple;
 import org.apache.commons.lang.StringUtils;
@@ -244,6 +245,10 @@ public static void visitRenderTemplateFunctions(@NotNull Method method, @NotNull
             psiElementVisitor.visitPhpDocTag(phpDocTag);
         }
 
+        for (PhpAttributesList phpAttributesList : PsiTreeUtil.getChildrenOfTypeAsList(method, PhpAttributesList.class)) {
+            psiElementVisitor.visitPhpAttribute(phpAttributesList);
+        }
+
         method.accept(psiElementVisitor);
     }
 
@@ -271,10 +276,36 @@ public void visitElement(@NotNull PsiElement element) {
                 visitMethodReference((MethodReference) element);
             } else if(element instanceof PhpDocTag) {
                 visitPhpDocTag((PhpDocTag) element);
+            } else if(element instanceof PhpAttributesList) {
+                visitPhpAttribute((PhpAttributesList) element);
             }
             super.visitElement(element);
         }
 
+        private void visitPhpAttribute(@NotNull PhpAttributesList phpAttributesList) {
+            Collection<@NotNull PhpAttribute> attributes = phpAttributesList.getAttributes(TwigUtil.TEMPLATE_ANNOTATION_CLASS);
+            for (PhpAttribute attribute : attributes) {
+                if (attribute.getArguments().isEmpty()) {
+                    // #[@Template()]
+                    PsiElement parent = phpAttributesList.getParent();
+                    if (parent instanceof Method) {
+                        visitMethodForGuessing((Method) parent);
+                    }
+                } else {
+                    // [@Template("foobar.html.twig")]
+                    // #[@Template(template: "foobar.html.twig")]
+                    String template = PhpPsiAttributesUtil.getAttributeValueByNameAsStringWithDefaultParameterFallback(attribute, "template");
+                    if (StringUtils.isNotBlank(template)) {
+                        PsiElement parent = phpAttributesList.getParent();
+                        if (parent instanceof Method) {
+                            addTemplateWithScope(template, (Method) parent, null);
+
+                        }
+                    }
+                }
+            }
+        }
+
         private void visitMethodReference(@NotNull MethodReference methodReference) {
             String methodName = methodReference.getName();
             if (methodName == null) {
@@ -409,23 +440,7 @@ private void visitPhpDocTag(@NotNull PhpDocTag phpDocTag) {
                 // App\Controller\MyNiceController::myAction => my_nice/my.html.twig
                 Method methodScope = AnnotationBackportUtil.getMethodScope(phpDocTag);
                 if(methodScope != null) {
-                    PhpClass phpClass = methodScope.getContainingClass();
-                    if (phpClass != null) {
-                        // App\Controller\  "MyNice"  Controller
-                        Matcher matcher = Pattern.compile("Controller\\\\(.+)Controller$", Pattern.MULTILINE).matcher(StringUtils.stripStart(phpClass.getFQN(), "\\"));
-                        if(matcher.find()){
-                            String group = underscore(matcher.group(1).replace("\\", "/"));
-                            String name = methodScope.getName();
-
-                            // __invoke is using controller as template name
-                            if (name.equals("__invoke")) {
-                                addTemplateWithScope(group + ".html.twig", methodScope, null);
-                            } else {
-                                String action = name.endsWith("Action") ? name.substring(0, name.length() - "Action".length()) : name;
-                                addTemplateWithScope(group + "/" + underscore(action) + ".html.twig", methodScope, null);
-                            }
-                        }
-                    }
+                    visitMethodForGuessing(methodScope);
                 }
             } else if(template.endsWith(".twig")) {
                 Method methodScope = AnnotationBackportUtil.getMethodScope(phpDocTag);
@@ -435,6 +450,26 @@ private void visitPhpDocTag(@NotNull PhpDocTag phpDocTag) {
             }
         }
 
+        private void visitMethodForGuessing(@NotNull Method methodScope) {
+            PhpClass phpClass = methodScope.getContainingClass();
+            if (phpClass != null) {
+                // App\Controller\  "MyNice"  Controller
+                Matcher matcher = Pattern.compile("Controller\\\\(.+)Controller$", Pattern.MULTILINE).matcher(StringUtils.stripStart(phpClass.getFQN(), "\\"));
+                if(matcher.find()){
+                    String group = underscore(matcher.group(1).replace("\\", "/"));
+                    String name = methodScope.getName();
+
+                    // __invoke is using controller as template name
+                    if (name.equals("__invoke")) {
+                        addTemplateWithScope(group + ".html.twig", methodScope, null);
+                    } else {
+                        String action = name.endsWith("Action") ? name.substring(0, name.length() - "Action".length()) : name;
+                        addTemplateWithScope(group + "/" + underscore(action) + ".html.twig", methodScope, null);
+                    }
+                }
+            }
+        }
+
         private void addTemplateWithScope(@NotNull String contents, @NotNull PhpNamedElement scope, @Nullable FunctionReference functionReference) {
             String s = TwigUtil.normalizeTemplateName(contents);
             consumer.accept(new Triple<>(s, scope, functionReference));

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/stubs/indexes/PhpTwigTemplateUsageStubIndexTest.java

@@ -130,6 +130,65 @@ public void testEmptyTemplateAnnotationIndexUsingTemplateGuesser() {
         );
     }
 
+
+    public void testThatDefaultTemplatePropertyPhpAttributeIsIndexed() {
+        myFixture.configureByText(PhpFileType.INSTANCE, "<?php\n" +
+            "use Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Template;" +
+            "class Foobar\n" +
+            "{" +
+            "#[Template(\"foo-php-attribute-default.html.twig\")]\n" +
+            "public function foobar() {}" +
+            "}\n"
+        );
+
+        assertIndexContains(
+            PhpTwigTemplateUsageStubIndex.KEY,
+            "foo-php-attribute-default.html.twig"
+        );
+
+        assertIndexContainsKeyWithValue(PhpTwigTemplateUsageStubIndex.KEY, "foo-php-attribute-default.html.twig", value ->
+            "foo-php-attribute-default.html.twig".equals(value.getTemplate()) && value.getScopes().contains("Foobar.foobar")
+        );
+    }
+
+    public void testThatDefaultTemplatePropertyPhpAttributeTemplateIsIndexed() {
+        myFixture.configureByText(PhpFileType.INSTANCE, "<?php\n" +
+            "use Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Template;" +
+            "class Foobar\n" +
+            "{" +
+            "#[Template(template: \"foo-php-attribute-template.html.twig\")]\n" +
+            "public function foobar() {}" +
+            "}\n"
+        );
+
+        assertIndexContains(
+            PhpTwigTemplateUsageStubIndex.KEY,
+            "foo-php-attribute-template.html.twig"
+        );
+
+        assertIndexContainsKeyWithValue(PhpTwigTemplateUsageStubIndex.KEY, "foo-php-attribute-template.html.twig", value ->
+            "foo-php-attribute-template.html.twig".equals(value.getTemplate()) && value.getScopes().contains("Foobar.foobar")
+        );
+    }
+
+    public void testEmptyTemplatePhpAttributeIndexUsingTemplateGuesser() {
+        myFixture.configureByText(PhpFileType.INSTANCE, "<?php\n" +
+            "namespace App\\Controller;" +
+            "" +
+            "use Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Template;" +
+            "class MyNiceFoobarController\n" +
+            "{" +
+            "#[Template()]\n" +
+            "public function foobarWhatAction() {}" +
+            "}\n"
+        );
+
+        assertIndexContains(
+            PhpTwigTemplateUsageStubIndex.KEY,
+            "my_nice_foobar/foobar_what.html.twig"
+        );
+    }
+
     public void testEmptyTemplateAnnotationIndexUsingInvokeTemplateGuesser() {
         myFixture.configureByText(PhpFileType.INSTANCE, "<?php\n" +
             "namespace App\\Controller;" +