dont annotate missing twig template in interpolated or concatenated strings #488

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/TwigHelper.java

@@ -63,7 +63,7 @@ public class TwigHelper {
     /**
      * ([) "FOO", 'FOO' (])
      */
-    private static final ElementPattern<PsiElement> STRING_WRAP_PATTERN = PlatformPatterns.or(
+    public static final ElementPattern<PsiElement> STRING_WRAP_PATTERN = PlatformPatterns.or(
         PlatformPatterns.psiElement(PsiWhiteSpace.class),
         PlatformPatterns.psiElement(TwigTokenTypes.WHITE_SPACE),
         PlatformPatterns.psiElement(TwigTokenTypes.DOUBLE_QUOTE),

src/fr/adrienbrault/idea/symfony2plugin/templating/TwigAnnotator.java

@@ -138,7 +138,7 @@ private void annotateRoute(@NotNull final PsiElement element, @NotNull Annotatio
 
     private void annotateTemplate(@NotNull final PsiElement element, @NotNull AnnotationHolder holder) {
 
-        if(!(TwigHelper.getTemplateFileReferenceTagPattern().accepts(element) || TwigHelper.getPrintBlockFunctionPattern("include", "source").accepts(element))) {
+        if(!(TwigHelper.getTemplateFileReferenceTagPattern().accepts(element) || TwigHelper.getPrintBlockFunctionPattern("include", "source").accepts(element)) || !TwigUtil.isValidTemplateString(element)) {
             return;
         }
 

src/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigUtil.java

@@ -4,10 +4,7 @@
 import com.intellij.openapi.vfs.VfsUtil;
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.patterns.PlatformPatterns;
-import com.intellij.psi.PsiElement;
-import com.intellij.psi.PsiFile;
-import com.intellij.psi.PsiManager;
-import com.intellij.psi.PsiRecursiveElementWalkingVisitor;
+import com.intellij.psi.*;
 import com.intellij.psi.search.GlobalSearchScope;
 import com.intellij.psi.util.PsiElementFilter;
 import com.intellij.psi.util.PsiTreeUtil;
@@ -20,6 +17,7 @@
 import com.jetbrains.php.lang.psi.elements.*;
 import com.jetbrains.twig.TwigFile;
 import com.jetbrains.twig.TwigFileType;
+import com.jetbrains.twig.TwigTokenTypes;
 import com.jetbrains.twig.elements.TwigBlockTag;
 import com.jetbrains.twig.elements.TwigCompositeElement;
 import com.jetbrains.twig.elements.TwigElementTypes;
@@ -648,5 +646,31 @@ public static String getTemplateNameByOverwrite(@NotNull Project project, @NotNu
         return TwigHelper.normalizeTemplateName(containingBundle.getName() + ":" + relative.substring("Resources/views/".length(), relative.length()));
     }
 
+    /**
+     * {% include "foo/#{segment.typeKey}.html.twig" with {'segment': segment} %}
+     * {% include "foo/#{1 + 2}.html.twig" %}
+     * {% include "foo/" ~ segment.typeKey ~ ".html.twig" %}
+     */
+    public static boolean isValidTemplateString(@NotNull PsiElement element) {
+        String templateName = element.getText();
+
+        if(templateName.matches(".*#\\{.*\\}.*")) {
+            return false;
+        }
 
+        if(PlatformPatterns.psiElement()
+            .afterLeafSkipping(
+                TwigHelper.STRING_WRAP_PATTERN,
+                PlatformPatterns.psiElement(TwigTokenTypes.CONCAT)
+            ).accepts(element) ||
+            PlatformPatterns.psiElement().beforeLeafSkipping(
+                TwigHelper.STRING_WRAP_PATTERN,
+                PlatformPatterns.psiElement(TwigTokenTypes.CONCAT)
+            ).accepts(element)) {
+
+            return false;
+        };
+
+        return true;
+    }
 }

tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/util/TwigUtilIntegrationTest.java

@@ -1,9 +1,16 @@
 package fr.adrienbrault.idea.symfony2plugin.tests.templating.util;
 
 import com.intellij.openapi.vfs.VfsUtil;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiRecursiveElementVisitor;
+import com.intellij.psi.tree.IElementType;
 import com.jetbrains.twig.TwigFileType;
+import com.jetbrains.twig.TwigTokenTypes;
+import com.jetbrains.twig.elements.TwigElementFactory;
+import com.jetbrains.twig.elements.TwigElementTypes;
 import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil;
 import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
+import org.jetbrains.annotations.NotNull;
 
 public class TwigUtilIntegrationTest extends SymfonyLightCodeInsightFixtureTestCase {
 
@@ -57,4 +64,37 @@ public void testTemplateOverwriteNavigation() {
         assertNavigationContainsFile(TwigFileType.INSTANCE, "{% extends '<caret>TwigUtilIntegrationBundle:Foo/Bar/layout.html.twig' %}", "/views/Foo/Bar/layout.html.twig");
     }
 
+    /**
+     * @see fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil#isValidTemplateString
+     */
+    public void testIsValidTemplateString() {
+        assertFalse(TwigUtil.isValidTemplateString(createPsiElementAndFindString("{% include \"foo/#{segment.typeKey}.html.twig\" %}", TwigElementTypes.INCLUDE_TAG)));
+        assertFalse(TwigUtil.isValidTemplateString(createPsiElementAndFindString("{% include \"foo/#{1 + 2}.html.twig\" %}", TwigElementTypes.INCLUDE_TAG)));
+        assertFalse(TwigUtil.isValidTemplateString(createPsiElementAndFindString("{% include ~ \"foo.html.twig\" ~ %}", TwigElementTypes.INCLUDE_TAG)));
+        assertFalse(TwigUtil.isValidTemplateString(createPsiElementAndFindString("{% include \"foo.html.twig\" ~ %}", TwigElementTypes.INCLUDE_TAG)));
+        assertFalse(TwigUtil.isValidTemplateString(createPsiElementAndFindString("{% include ~ \"foo.html.twig\" %}", TwigElementTypes.INCLUDE_TAG)));
+
+        assertTrue(TwigUtil.isValidTemplateString(createPsiElementAndFindString("{% include \"foo.html.twig\" %}", TwigElementTypes.INCLUDE_TAG)));
+    }
+
+    private PsiElement createPsiElementAndFindString(@NotNull String content, @NotNull IElementType type) {
+        PsiElement psiElement = TwigElementFactory.createPsiElement(getProject(), content, type);
+        if(psiElement == null) {
+            fail();
+        }
+
+        final PsiElement[] string = {null};
+        psiElement.acceptChildren(new PsiRecursiveElementVisitor() {
+            @Override
+            public void visitElement(PsiElement element) {
+                if (string[0] == null && element.getNode().getElementType() == TwigTokenTypes.STRING_TEXT) {
+                    string[0] = element;
+                }
+                super.visitElement(element);
+            }
+        });
+
+        return string[0];
+    }
+
 }