Merge pull request #2354 from Haehnchen/feature/twig-variables-filter

fix Twig filter pattern to support wrapped TwigVariableReference since PhpStorm 2024.1
Haehnchen · Apr 20, 2024 · ad5ce2c · ad5ce2c
2 parents 512a8b1 + c8a38f7
commit ad5ce2c
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 16 deletions.
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/TwigPattern.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/TwigPattern.java
@@ -1167,8 +1167,19 @@ public static ElementPattern<PsiElement> getForTagVariablePattern() {
 
     /**
      * {{ 'test'|<caret> }}
+     * {% for user in users|de<caret> %}
      */
     public static ElementPattern<PsiElement> getFilterPattern() {
+        return PlatformPatterns.or(
+            getFilterAsIdentifierPattern(),
+            getFilterAsVariableReferencePattern()
+        );
+    }
+
+    /**
+     * {{ 'test'|<caret> }}
+     */
+    private static ElementPattern<PsiElement> getFilterAsIdentifierPattern() {
         return PlatformPatterns.psiElement()
             .afterLeafSkipping(
                 PlatformPatterns.or(
@@ -1180,6 +1191,23 @@ public static ElementPattern<PsiElement> getFilterPattern() {
             .withLanguage(TwigLanguage.INSTANCE);
     }
 
+    /**
+     * Since PhpStorm 2024.1 value can be nested inside TwigVariableReference element
+     *
+     * {% for user in users|de<caret> %}
+     */
+    private static ElementPattern<PsiElement> getFilterAsVariableReferencePattern() {
+        return PlatformPatterns.psiElement()
+            .withParent(PlatformPatterns.psiElement(TwigVariableReference.class).afterLeafSkipping(
+                PlatformPatterns.or(
+                    PlatformPatterns.psiElement(PsiWhiteSpace.class),
+                    PlatformPatterns.psiElement(TwigTokenTypes.WHITE_SPACE)
+                ),
+                PlatformPatterns.psiElement().withElementType(TwigTokenTypes.FILTER)
+            ))
+            .withLanguage(TwigLanguage.INSTANCE);
+    }
+
     /**
      * {% apply <caret> %}foobar{% endapply %}
      */

diff --git a/...ava/fr/adrienbrault/idea/symfony2plugin/templating/TwigTemplateCompletionContributor.java b/...ava/fr/adrienbrault/idea/symfony2plugin/templating/TwigTemplateCompletionContributor.java
@@ -13,7 +13,6 @@
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiReference;
-import com.intellij.psi.PsiWhiteSpace;
 import com.intellij.psi.util.PsiTreeUtil;
 import com.intellij.util.PlatformIcons;
 import com.intellij.util.ProcessingContext;
@@ -562,24 +561,15 @@ private boolean isCompletionStartingRegexMatch(@RegExp String fullText, @NotNull
 
     private static class FilterCompletionProvider extends CompletionProvider<CompletionParameters> {
         public void addCompletions(@NotNull CompletionParameters parameters, @NotNull ProcessingContext context, @NotNull CompletionResultSet resultSet) {
-            if(!Symfony2ProjectComponent.isEnabled(parameters.getPosition())) {
+            if (!Symfony2ProjectComponent.isEnabled(parameters.getPosition())) {
                 return;
             }
 
-            // move this stuff to pattern fixed event stopping by phpstorm
-            PsiElement currElement = parameters.getPosition().getOriginalElement();
-            PsiElement prevElement = currElement.getPrevSibling();
-            if (((prevElement instanceof PsiWhiteSpace))) prevElement = prevElement.getPrevSibling();
-
-            if ((prevElement != null) && (prevElement.getNode().getElementType() == TwigTokenTypes.FILTER)) {
-                Project project = parameters.getPosition().getProject();
-
-                for(Map.Entry<String, TwigExtension> entry : TwigExtensionParser.getFilters(project).entrySet()) {
-                    TwigExtension twigExtension = entry.getValue();
-                    resultSet.addElement(new TwigExtensionLookupElement(currElement.getProject(), entry.getKey(), twigExtension));
-
-                    resultSet.addAllElements(getTypesFilters(project, entry.getKey(), entry.getValue()));
-                }
+            Project project = parameters.getPosition().getProject();
+            for (Map.Entry<String, TwigExtension> entry : TwigExtensionParser.getFilters(project).entrySet()) {
+                TwigExtension twigExtension = entry.getValue();
+                resultSet.addElement(new TwigExtensionLookupElement(project, entry.getKey(), twigExtension));
+                resultSet.addAllElements(getTypesFilters(project, entry.getKey(), entry.getValue()));
             }
         }
     }

diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/TwigPatternTest.java b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/TwigPatternTest.java
@@ -465,4 +465,12 @@ public void testGetForTagInVariablePattern() {
         PsiElement elementAt4 = findElementAt(TwigFileType.INSTANCE, "{% for key, user in <caret>|test('test') %}");
         assertTrue(TwigPattern.getForTagInVariablePattern().accepts(elementAt4));
     }
+
+    public void testGetFilterPattern() {
+        PsiElement elementAt = findElementAt(TwigFileType.INSTANCE, "{{ 'f<caret>oo'|tr<caret>ans }}");
+        assertTrue(TwigPattern.getFilterPattern().accepts(elementAt));
+
+        PsiElement elementAt2 = findElementAt(TwigFileType.INSTANCE, "{% for user in foo|tr<caret>a %}").getParent();
+        assertTrue(TwigPattern.getFilterPattern().accepts(elementAt2));
+    }
 }