implement twig block name workaround; need to strip block tag content on prefixmatcher #563, #390, #460

Author: Haehnchen

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

@@ -729,24 +729,47 @@ public static ElementPattern<PsiElement> getCompletablePattern() {
             .withLanguage(TwigLanguage.INSTANCE);
     }
 
+    /**
+     * {% block 'foo' %}
+     * {% block "foo" %}
+     * {% block foo %}
+     */
     public static ElementPattern<PsiElement> getBlockTagPattern() {
         //noinspection unchecked
-        return PlatformPatterns
-            .psiElement(TwigTokenTypes.IDENTIFIER)
-            .withParent(
-                PlatformPatterns.psiElement(TwigElementTypes.BLOCK_TAG)
-            )
+        return PlatformPatterns.or(
+
+            // {% block "foo" %}
+            PlatformPatterns
+            .psiElement(TwigTokenTypes.STRING_TEXT)
             .afterLeafSkipping(
                 PlatformPatterns.or(
-                    PlatformPatterns.psiElement(TwigTokenTypes.LBRACE),
                     PlatformPatterns.psiElement(PsiWhiteSpace.class),
                     PlatformPatterns.psiElement(TwigTokenTypes.WHITE_SPACE),
                     PlatformPatterns.psiElement(TwigTokenTypes.SINGLE_QUOTE),
                     PlatformPatterns.psiElement(TwigTokenTypes.DOUBLE_QUOTE)
                 ),
-                PlatformPatterns.psiElement(TwigTokenTypes.TAG_NAME).withText("block")
+                PlatformPatterns.psiElement(TwigTokenTypes.TAG_NAME)
             )
-            .withLanguage(TwigLanguage.INSTANCE);
+            .withParent(
+                PlatformPatterns.psiElement(TwigBlockTag.class)
+            )
+            .withLanguage(TwigLanguage.INSTANCE),
+
+            // {% block foo %}
+            PlatformPatterns
+                .psiElement(TwigTokenTypes.IDENTIFIER)
+                .afterLeafSkipping(
+                    PlatformPatterns.or(
+                        PlatformPatterns.psiElement(PsiWhiteSpace.class),
+                        PlatformPatterns.psiElement(TwigTokenTypes.WHITE_SPACE)
+                    ),
+                    PlatformPatterns.psiElement(TwigTokenTypes.TAG_NAME)
+                )
+                .withParent(
+                    PlatformPatterns.psiElement(TwigBlockTag.class)
+                )
+                .withLanguage(TwigLanguage.INSTANCE)
+        );
     }
 
     /**

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

@@ -3,7 +3,6 @@
 import com.intellij.codeInsight.completion.*;
 import com.intellij.codeInsight.lookup.LookupElementBuilder;
 import com.intellij.openapi.project.Project;
-import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.patterns.PlatformPatterns;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
@@ -605,24 +604,35 @@ public void addCompletions(@NotNull CompletionParameters parameters,
         }
     }
 
-
     class BlockCompletionProvider extends CompletionProvider<CompletionParameters> {
         public void addCompletions(@NotNull CompletionParameters parameters, ProcessingContext context, @NotNull CompletionResultSet resultSet) {
 
             if(!Symfony2ProjectComponent.isEnabled(parameters.getPosition())) {
                 return;
             }
 
-            Map<String, VirtualFile> twigFilesByName = TwigHelper.getTwigFilesByName(parameters.getPosition().getProject());
-            List<TwigBlock> blocks = new TwigBlockParser(twigFilesByName).walk(parameters.getPosition().getContainingFile());
-            List<String> uniqueList = new ArrayList<String>();
+            // wtf: need to prefix the block tag itself. remove this behavior and strip for new Matcher
+            // Find first Identifier "b" char or fallback to empty:
+            // "{% block b", "{% block"
+            String blockNamePrefix = resultSet.getPrefixMatcher().getPrefix();
+            int spacePos = blockNamePrefix.lastIndexOf(' ');
+            blockNamePrefix = spacePos > 0 ? blockNamePrefix.substring(spacePos + 1) : "";
+            CompletionResultSet myResultSet = resultSet.withPrefixMatcher(blockNamePrefix);
+
+            // collect blocks in all related files
+            List<TwigBlock> blocks = new TwigBlockParser(
+                TwigHelper.getTwigFilesByName(parameters.getPosition().getProject())
+            ).walk(parameters.getPosition().getContainingFile());
+
+            Set<String> uniqueList = new HashSet<String>();
             for (TwigBlock block : blocks) {
-                if(!uniqueList.contains(block.getName())) {
-                    uniqueList.add(block.getName());
-                    resultSet.addElement(new TwigBlockLookupElement(block));
+                if(uniqueList.contains(block.getName())) {
+                    continue;
                 }
-            }
 
+                uniqueList.add(block.getName());
+                myResultSet.addElement(new TwigBlockLookupElement(block));
+            }
         }
     }
 

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

@@ -124,6 +124,25 @@ public void testIncludeTagNonAllowedTags() {
         assertSize(0, getIncludeTemplates("{% import 'foo.html.twig' %}", TwigElementTypes.IMPORT_TAG));
     }
 
+    /**
+     * @see TwigHelper#getBlockTagPattern
+     */
+    public void testGetBlockTagPattern() {
+        String[] blocks = {
+            "{% block 'a<caret>a' %}",
+            "{% block \"a<caret>a\" %}",
+            "{% block a<caret>a %}"
+        };
+
+        for (String s : blocks) {
+            myFixture.configureByText(TwigFileType.INSTANCE, s);
+
+            assertTrue(TwigHelper.getBlockTagPattern().accepts(
+                myFixture.getFile().findElementAt(myFixture.getCaretOffset()))
+            );
+        }
+    }
+
     private void assertEqual(Collection<String> c, String... values) {
         if(!StringUtils.join(c, ",").equals(StringUtils.join(Arrays.asList(values), ","))) {
             fail(String.format("Fail that '%s' is equal '%s'", StringUtils.join(c, ","), StringUtils.join(Arrays.asList(values), ",")));

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

@@ -0,0 +1,53 @@
+package fr.adrienbrault.idea.symfony2plugin.tests.templating;
+
+import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.vfs.VfsUtil;
+import com.intellij.openapi.vfs.VirtualFile;
+import com.jetbrains.twig.TwigFileType;
+import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
+
+import java.io.IOException;
+
+/**
+ * @author Daniel Espendiller <daniel@espendiller.net>
+ * @see com.jetbrains.twig.completion.TwigCompletionContributor
+ */
+public class TwigTemplateCompletionContributorTest extends SymfonyLightCodeInsightFixtureTestCase {
+
+    public void setUp() throws Exception {
+        super.setUp();
+    }
+
+    /**
+     * @see fr.adrienbrault.idea.symfony2plugin.templating.TwigTemplateCompletionContributor
+     */
+    public void testBlockCompletion() {
+        if(System.getenv("PHPSTORM_ENV") != null) return;
+
+        try {
+            createDummyFiles(
+                "app/Resources/views/block.html.twig"
+            );
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+
+        // build pseudo file with block
+        final VirtualFile relativeFile = VfsUtil.findRelativeFile(getProject().getBaseDir(), "app/Resources/views/block.html.twig".split("/"));
+        ApplicationManager.getApplication().runWriteAction(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    relativeFile.setBinaryContent("{% block foo %}{% endblock %}".getBytes());
+                } catch (IOException e) {
+                    e.printStackTrace();
+                }
+                relativeFile.refresh(false, false);
+            }
+        });
+
+        assertCompletionContains(TwigFileType.INSTANCE, "{% extends '::block.html.twig' %}{% block <caret> %}", "foo");
+        assertCompletionContains(TwigFileType.INSTANCE, "{% extends '::block.html.twig' %}{% block \"<caret>\" %}", "foo");
+        assertCompletionContains(TwigFileType.INSTANCE, "{% extends '::block.html.twig' %}{% block '<caret>' %}", "foo");
+    }
+}