Merge pull request #2456 from Haehnchen/feature/twig-deprecated-options

Add support for Twig extension options "parser_callable" and deprecation markers

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/dict/TwigExtension.java

@@ -58,12 +58,16 @@ public String getSignature() {
     }
 
     @Nullable
-    String getOption(String key) {
+    public String getOption(String key) {
         return options.getOrDefault(key, null);
     }
 
     @NotNull
     public Collection<String> getTypes() {
         return types;
     }
+
+    public boolean isDeprecated() {
+        return options.containsKey("deprecated") || options.containsKey("deprecation_info");
+    }
 }

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

@@ -368,9 +368,11 @@ private static void visitNewExpression(@NotNull NewExpression element, @NotNull
 
                         Collection<String> typed = new HashSet<>();
                         Project project = method.getProject();
-                        for (PhpNamedElement phpNamedElement : PhpElementsUtil.getPsiElementsBySignature(project, signature)) {
-                            if (phpNamedElement instanceof Function) {
-                                typed.addAll(PhpElementsUtil.getClassFromPhpTypeSet(project, phpNamedElement.getType().getTypes()).stream().map(PhpNamedElement::getFQN).toList());
+                        if (signature != null) {
+                            for (PhpNamedElement phpNamedElement : PhpElementsUtil.getPsiElementsBySignature(project, signature)) {
+                                if (phpNamedElement instanceof Function) {
+                                    typed.addAll(PhpElementsUtil.getClassFromPhpTypeSet(project, phpNamedElement.getType().getTypes()).stream().map(PhpNamedElement::getFQN).toList());
+                                }
                             }
                         }
 
@@ -441,8 +443,17 @@ private static void visitNewExpression(@NotNull NewExpression element, @NotNull
     static private Map<String, String> getOptions(@NotNull ArrayCreationExpression arrayCreationExpression) {
         Map<String, String> options = new HashMap<>();
 
-        for (String optionTrue: new String[] {"needs_environment", "needs_context"}) {
+        for (String optionTrue: new String[] {"needs_environment", "needs_context", "parser_callable", "deprecation_info", "deprecated"}) {
             PhpPsiElement phpPsiElement = PhpElementsUtil.getArrayValue(arrayCreationExpression, optionTrue);
+            if (phpPsiElement == null) {
+                continue;
+            }
+
+            if (optionTrue.equals("deprecation_info") || optionTrue.equals("deprecated")) {
+                options.put(optionTrue, "true");
+                continue;
+            }
+
             if (phpPsiElement instanceof ConstantReference) {
                 String value = phpPsiElement.getName();
                 if (value != null && value.equalsIgnoreCase("true")) {
@@ -469,6 +480,13 @@ private static void visitNewExpression(@NotNull NewExpression element, @NotNull
                             signature = getCallableSignature(psiElement[1], method);
                         }
 
+                        if (signature == null && psiElement.length > 2 && psiElement[2] instanceof ArrayCreationExpression arrayCreationExpression) {
+                            PhpPsiElement phpPsiElement = PhpElementsUtil.getArrayValue(arrayCreationExpression, "parser_callable");
+                            if (phpPsiElement != null) {
+                                signature = getCallableSignature(phpPsiElement, method);
+                            }
+                        }
+
                         // creation options like: needs_environment
                         Map<String, String> options;
                         if (psiElement.length > 2 && psiElement[2] instanceof ArrayCreationExpression) {

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/util/TwigExtensionParserTest.java

@@ -22,29 +22,33 @@ public String getTestDataPath() {
     }
 
     public void testExtensionAreCollected() {
+        Map<String, TwigExtension> functions = TwigExtensionParser.getFunctions(getProject());
+        Map<String, TwigExtension> simpleTest = TwigExtensionParser.getSimpleTest(getProject());
+        Map<String, TwigExtension> filters = TwigExtensionParser.getFilters(getProject());
+
         assertEquals(
             "#M#C\\Twig\\Extensions.foobar",
-            TwigExtensionParser.getFilters(getProject()).get("trans").getSignature()
+            filters.get("trans").getSignature()
         );
 
         assertEquals(
             "#Fmax",
-            TwigExtensionParser.getFunctions(getProject()).get("max").getSignature()
+            functions.get("max").getSignature()
         );
 
         assertEquals(
             "SIMPLE_TEST",
-            TwigExtensionParser.getSimpleTest(getProject()).get("my_test").getType()
+            simpleTest.get("my_test").getType()
         );
 
         assertEquals(
             "#M#C\\My_Node_Test.compile",
-            TwigExtensionParser.getSimpleTest(getProject()).get("my_test").getSignature()
+            simpleTest.get("my_test").getSignature()
         );
 
         assertEquals(
             "#Ffoo_test",
-            TwigExtensionParser.getSimpleTest(getProject()).get("my_test_2").getSignature()
+            simpleTest.get("my_test_2").getSignature()
         );
 
         assertEquals(
@@ -59,62 +63,77 @@ public void testExtensionAreCollected() {
 
         assertEquals(
             "#M#C\\ClassInstance.getFoobar",
-            TwigExtensionParser.getFunctions(getProject()).get("class_instance_foobar").getSignature()
+            functions.get("class_instance_foobar").getSignature()
         );
 
         assertEquals(
             "#M#C\\Twig\\Extensions.getFoobar",
-            TwigExtensionParser.getFunctions(getProject()).get("class_php_callable_method_foobar").getSignature()
+            functions.get("class_php_callable_method_foobar").getSignature()
         );
 
         assertEquals(
             "#Fmax",
-            TwigExtensionParser.getFunctions(getProject()).get("class_php_callable_function_foobar").getSignature()
+            functions.get("class_php_callable_function_foobar").getSignature()
         );
 
         assertEquals(
             "#Fmax",
-            TwigExtensionParser.getFunctions(getProject()).get("conditional_return").getSignature()
+            functions.get("conditional_return").getSignature()
         );
 
         assertEquals(
             "#M#C\\App\\Twig\\AppExtension.formatProductNumberFilter",
-            TwigExtensionParser.getFilters(getProject()).get("product_number_filter").getSignature()
+            filters.get("product_number_filter").getSignature()
         );
 
         assertEquals(
             "#M#C\\App\\Twig\\AppExtension.formatProductNumberFunction",
-            TwigExtensionParser.getFunctions(getProject()).get("product_number_function").getSignature()
+            functions.get("product_number_function").getSignature()
         );
 
         assertEquals(
             "#M#C\\App\\Twig\\AppExtension.formatProductNumberTest",
-            TwigExtensionParser.getSimpleTest(getProject()).get("product_number_test").getSignature()
+            simpleTest.get("product_number_test").getSignature()
+        );
+
+        assertEquals(
+            "#M#C\\Twig\\Extensions.parseAttributeFunction",
+            functions.get("attribute_parser_callable").getSignature()
         );
     }
 
     public void testExtensionAreCollectedForDeprecated() {
+        Map<String, TwigExtension> functions = TwigExtensionParser.getFunctions(getProject());
+        Map<String, TwigExtension> filters = TwigExtensionParser.getFilters(getProject());
+
         assertEquals(
             "#M#C\\Symfony\\Bridge\\Twig\\Node\\FormEnctypeNode.compile",
-            TwigExtensionParser.getFunctions(getProject()).get("form_enctype").getSignature()
+            functions.get("form_enctype").getSignature()
         );
 
         assertEquals(
             "#M#C\\Twig\\Extensions.foobar",
-            TwigExtensionParser.getFunctions(getProject()).get("hwi_oauth_login_url").getSignature()
+            functions.get("hwi_oauth_login_url").getSignature()
         );
 
         assertEquals(
             "#M#C\\Twig\\Extensions.foobar",
-            TwigExtensionParser.getFilters(getProject()).get("doctrine_minify_query").getSignature()
+            filters.get("doctrine_minify_query").getSignature()
         );
 
         assertEquals(
             "#Ffoobar",
-            TwigExtensionParser.getFilters(getProject()).get("localizeddate").getSignature()
+            filters.get("localizeddate").getSignature()
         );
     }
 
+    public void testExtensionDeprecatedOptions() {
+        Map<String, TwigExtension> filters = TwigExtensionParser.getFilters(getProject());
+
+        assertTrue(filters.get("spaceless_deprecation_info").isDeprecated());
+        assertTrue(filters.get("spaceless_deprecation_deprecated").isDeprecated());
+    }
+
     public void testExtensionAreCollectedForVersion2() {
         assertEquals(
             "#M#C\\Twig\\Extensions.foobar",

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/util/fixtures/twig_extensions.php

@@ -65,6 +65,9 @@ class Twig_Function
 
 namespace Twig
 {
+    final class DeprecatedCallableInfo {}
+    class DefaultFilter {}
+
     // Twig 3.0
     class TwigFilter {}
     class TwigFunction {}
@@ -87,6 +90,9 @@ public function getFilters()
                 'localizeddate' => new \Twig_Filter_Function('foobar'),
                 new \Twig_Filter('trans_2', [$this, 'foobar']),
                 new TwigFilter('trans_3', [$this, 'foobar']),
+                new TwigFilter('default', [self::class, 'default'], ['node_class' => DefaultFilter::class]),
+                new TwigFilter('spaceless_deprecation_info', [self::class, 'spaceless'], ['is_safe' => ['html'], 'deprecation_info' => new \Twig\DeprecatedCallableInfo('twig/twig', '3.12')]),
+                new TwigFilter('spaceless_deprecation_deprecated', [self::class, 'spaceless'], ['is_safe' => ['html'], 'deprecated' => 12.12]),
             ];
         }
 
@@ -115,6 +121,7 @@ public function getFunctions()
                 new TwigFunction('class_instance_foobar', [\ClassInstance::class, 'getFoobar']),
                 new TwigFunction('class_php_callable_method_foobar', $this->getFoobar(...)),
                 new TwigFunction('class_php_callable_function_foobar', max(...)),
+                new TwigFunction('attribute_parser_callable', null, ['parser_callable' => [self::class, 'parseAttributeFunction']]),
             ];
         }