Add completion for twig tags of Twig_TokenParserInterface::getTag implementations #457

Author: Haehnchen

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

@@ -343,6 +343,36 @@ public static ElementPattern<PsiElement> getPrintBlockFunctionPattern(String...
             .withLanguage(TwigLanguage.INSTANCE);
     }
 
+    /**
+     * Twig tag pattern with some hack
+     * because we have invalid psi elements after STATEMENT_BLOCK_START
+     *
+     * {% <carpet> %}
+     */
+    public static ElementPattern<PsiElement> getTagTokenParserPattern() {
+        //noinspection unchecked
+        return PlatformPatterns
+            .psiElement()
+            .afterLeafSkipping(
+                PlatformPatterns.or(
+                    PlatformPatterns.psiElement(PsiWhiteSpace.class),
+                    PlatformPatterns.psiElement(TwigTokenTypes.WHITE_SPACE)
+                ),
+                PlatformPatterns.or(
+                    PlatformPatterns.psiElement(TwigTokenTypes.STATEMENT_BLOCK_START),
+                    PlatformPatterns.psiElement(PsiErrorElement.class)
+                )
+            )
+            .beforeLeafSkipping(
+                PlatformPatterns.or(
+                    PlatformPatterns.psiElement(PsiWhiteSpace.class),
+                    PlatformPatterns.psiElement(TwigTokenTypes.WHITE_SPACE)
+                ),
+                PlatformPatterns.psiElement(TwigTokenTypes.STATEMENT_BLOCK_END)
+            )
+            .withLanguage(TwigLanguage.INSTANCE);
+    }
+
     /**
      * {% embed "vertical_boxes_skeleton.twig" %}
      */

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

@@ -9,19 +9,14 @@
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiManager;
 import com.intellij.psi.PsiWhiteSpace;
+import com.intellij.psi.util.PsiTreeUtil;
 import com.intellij.util.ProcessingContext;
 import com.jetbrains.php.PhpIcons;
 import com.jetbrains.php.PhpIndex;
-import com.jetbrains.php.completion.PhpLookupElement;
-import com.jetbrains.php.completion.PhpVariantsUtil;
-import com.jetbrains.php.completion.insert.PhpReferenceInsertHandler;
-import com.jetbrains.php.lang.psi.elements.Field;
-import com.jetbrains.php.lang.psi.elements.Method;
-import com.jetbrains.php.lang.psi.elements.PhpClass;
-import com.jetbrains.php.lang.psi.elements.PhpNamedElement;
-import com.jetbrains.php.lang.psi.stubs.indexes.PhpClassIndex;
+import com.jetbrains.php.lang.psi.elements.*;
 import com.jetbrains.twig.TwigLanguage;
 import com.jetbrains.twig.TwigTokenTypes;
+import fr.adrienbrault.idea.symfony2plugin.Symfony2Icons;
 import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
 import fr.adrienbrault.idea.symfony2plugin.TwigHelper;
 import fr.adrienbrault.idea.symfony2plugin.asset.dic.AssetDirectoryReader;
@@ -48,6 +43,7 @@
 import fr.adrienbrault.idea.symfony2plugin.util.controller.ControllerCompletionProvider;
 import fr.adrienbrault.idea.symfony2plugin.util.service.ServiceXmlParserFactory;
 import icons.TwigIcons;
+import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.*;
@@ -362,6 +358,12 @@ public void addCompletions(@NotNull CompletionParameters parameters,
             new FormThemeCompletionProvider()
         );
 
+        // {% <carpet> %}
+        extend(CompletionType.BASIC,
+            TwigHelper.getTagTokenParserPattern(),
+            new TagTokenParserCompletionProvider()
+        );
+
         // {% constant('FOO') %}
         extend(
             CompletionType.BASIC,
@@ -429,6 +431,47 @@ public void addCompletions(@NotNull CompletionParameters parameters,
 
     }
 
+    /**
+     * Parse all classes that implements Twig_TokenParserInterface::getTag
+     * and provide completion on string
+     */
+    private static class TagTokenParserCompletionProvider extends CompletionProvider<CompletionParameters> {
+        @Override
+        protected void addCompletions(@NotNull CompletionParameters parameters, ProcessingContext processingContext, @NotNull CompletionResultSet resultSet) {
+
+            if(!Symfony2ProjectComponent.isEnabled(parameters.getPosition())) {
+                return;
+            }
+
+            Collection<PhpClass> allSubclasses = PhpIndex.getInstance(parameters.getPosition().getProject()).getAllSubclasses("\\Twig_TokenParserInterface");
+            for (PhpClass allSubclass : allSubclasses) {
+
+                // we dont want to see test extension like "§"
+                if(allSubclass.getName().endsWith("Test") || allSubclass.getContainingFile().getVirtualFile().getNameWithoutExtension().endsWith("Test")) {
+                    continue;
+                }
+
+                Method getTag = allSubclass.findMethodByName("getTag");
+                if(getTag == null) {
+                    continue;
+                }
+
+                // get string return value
+                PhpReturn childrenOfType = PsiTreeUtil.findChildOfType(getTag, PhpReturn.class);
+                if(childrenOfType != null) {
+                    PhpPsiElement returnValue = childrenOfType.getFirstPsiChild();
+                    if(returnValue instanceof StringLiteralExpression) {
+                        String contents = ((StringLiteralExpression) returnValue).getContents();
+                        if(StringUtils.isNotBlank(contents)) {
+                            resultSet.addElement(LookupElementBuilder.create(contents).withIcon(Symfony2Icons.SYMFONY));
+                        }
+                    }
+                }
+            }
+
+        }
+    }
+
     private class FormThemeCompletionProvider extends CompletionProvider<CompletionParameters> {
 
         @Override

tests/fr/adrienbrault/idea/symfony2plugin/tests/SymfonyLightCodeInsightFixtureTestCase.java

@@ -13,6 +13,7 @@
 
 import java.util.Arrays;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Set;
 
 public abstract class SymfonyLightCodeInsightFixtureTestCase extends LightCodeInsightFixtureTestCase {
@@ -28,7 +29,12 @@ public void assertCompletionContains(LanguageFileType languageFileType, String c
         myFixture.configureByText(languageFileType, configureByText);
         myFixture.completeBasic();
 
-        assertTrue(myFixture.getLookupElementStrings().containsAll(Arrays.asList(lookupStrings)));
+        List<String> lookupElements = myFixture.getLookupElementStrings();
+        for (String s : Arrays.asList(lookupStrings)) {
+            if(!lookupElements.contains(s)) {
+                fail(String.format("failed that completion contains %s in %s", s, lookupElements.toString()));
+            }
+        }
     }
 
     public void assertCompletionNotContains(LanguageFileType languageFileType, String configureByText, String... lookupStrings) {

tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/TwigFilterCompletionContributorTest.java

@@ -41,4 +41,12 @@ public void testTwigExtensionLookupElementPresentable() {
         assertCompletionLookupTailEquals(TwigFileType.INSTANCE, "{{ 'test'|<caret> }}", "contextWithoutEnvironment", "()");
     }
 
+
+    /**
+     * @see fr.adrienbrault.idea.symfony2plugin.templating.TwigTemplateCompletionContributor.TagTokenParserCompletionProvider
+     */
+    public void testTagTokenParserCompletionProvider() {
+        assertCompletionContains(TwigFileType.INSTANCE, "{% <caret> %}", "foo_tag");
+    }
+
 }

tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/fixtures/TwigFilterExtension.php

@@ -8,6 +8,13 @@ class Twig_SimpleFilter {}
     class SqlFormatter {
         public function format() {}
     }
+
+    interface Twig_TokenParserInterface {}
+
+    class FooTokenParser implements Twig_TokenParserInterface
+    {
+        public function getTag() { return 'foo_tag'; }
+    }
 }
 
 namespace Doctrine\Bundle\DoctrineBundle\Twig;