improve Twig types support for inline type declaration {# @var Class variable #} and {# @var variable Class #} #1035

Haehnchen · Haehnchen · commit eb87b940a0e1 · 2017-12-18T19:44:06.000+01:00
diff --git a/src/fr/adrienbrault/idea/symfony2plugin/templating/TwigPattern.java b/src/fr/adrienbrault/idea/symfony2plugin/templating/TwigPattern.java
@@ -19,6 +19,9 @@
 import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.ArrayList;
+import java.util.Collection;
+
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
  */
@@ -872,10 +875,13 @@ public static ElementPattern<PsiElement> getTypeCompletionPattern() {
     }
 
     public static ElementPattern<PsiComment> getTwigTypeDocBlockPattern() {
-        return PlatformPatterns.or(
-            PlatformPatterns.psiComment().withText(PlatformPatterns.string().matches(TwigTypeResolveUtil.DEPRECATED_DOC_TYPE_PATTERN)).withLanguage(TwigLanguage.INSTANCE),
-            PlatformPatterns.psiComment().withText(PlatformPatterns.string().matches(TwigTypeResolveUtil.DOC_TYPE_PATTERN_SINGLE)).withLanguage(TwigLanguage.INSTANCE)
-        );
+        Collection<ElementPattern> patterns = new ArrayList<>();
+
+        for (String s : TwigTypeResolveUtil.DOC_TYPE_PATTERN_SINGLE) {
+            patterns.add(PlatformPatterns.psiComment().withText(PlatformPatterns.string().matches(s)).withLanguage(TwigLanguage.INSTANCE));
+        }
+
+        return PlatformPatterns.or(patterns.toArray(new ElementPattern[patterns.size()]));
     }
 
     /**
diff --git a/src/fr/adrienbrault/idea/symfony2plugin/templating/TwigTemplateGoToDeclarationHandler.java b/src/fr/adrienbrault/idea/symfony2plugin/templating/TwigTemplateGoToDeclarationHandler.java
@@ -344,6 +344,12 @@ private Collection<PsiElement> getConstantGoto(@NotNull PsiElement psiElement) {
         return targetPsiElements;
     }
 
+    /**
+     * Extract class from inline variables
+     *
+     * {# @var \AppBundle\Entity\Foo variable #}
+     * {# @var variable \AppBundle\Entity\Foo #}
+     */
     @NotNull
     private Collection<PhpClass> getVarClassGoto(@NotNull PsiElement psiElement) {
         String comment = psiElement.getText();
@@ -352,10 +358,10 @@ private Collection<PhpClass> getVarClassGoto(@NotNull PsiElement psiElement) {
             return Collections.emptyList();
         }
 
-        for(String pattern: new String[] {TwigTypeResolveUtil.DEPRECATED_DOC_TYPE_PATTERN, TwigTypeResolveUtil.DOC_TYPE_PATTERN_SINGLE}) {
+        for(String pattern: TwigTypeResolveUtil.DOC_TYPE_PATTERN_SINGLE) {
             Matcher matcher = Pattern.compile(pattern).matcher(comment);
             if (matcher.find()) {
-                String className = matcher.group(2);
+                String className = matcher.group("class");
                 if(StringUtils.isNotBlank(className)) {
                     return PhpElementsUtil.getClassesInterface(psiElement.getProject(), className);
                 }
diff --git a/src/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigTypeResolveUtil.java b/src/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigTypeResolveUtil.java
@@ -43,16 +43,35 @@
  */
 public class TwigTypeResolveUtil {
 
-    public static final String DEPRECATED_DOC_TYPE_PATTERN = "\\{#[\\s]+([\\w]+)[\\s]+([\\w\\\\\\[\\]]+)[\\s]+#}";
-    public static final String DOC_TYPE_PATTERN = "@var[\\s]+([\\w]+)[\\s]+([\\w\\\\\\[\\]]+)[\\s]*";
+    /**
+     * {# variable \AppBundle\Entity\Foo[] #}
+     */
+    public static final String DEPRECATED_DOC_TYPE_PATTERN = "\\{#[\\s]+(?<var>[\\w]+)[\\s]+(?<class>[\\w\\\\\\[\\]]+)[\\s]+#}";
+
+    /**
+     * {# @var variable \AppBundle\Entity\Foo[] #}
+     * {# @var variable \AppBundle\Entity\Foo #}
+     */
+    private static final String DOC_TYPE_PATTERN_CLASS_SECOND = "@var[\\s]+(?<var>[\\w]+)[\\s]+(?<class>[\\w\\\\\\[\\]]+)[\\s]*";
+
+    /**
+     * {# @var \AppBundle\Entity\Foo[] variable #}
+     * {# @var \AppBundle\Entity\Foo variable #}
+     */
+    private static final String DOC_TYPE_PATTERN_CLASS_FIRST = "@var[\\s]+(?<class>[\\w\\\\\\[\\]]+)[\\s]+(?<var>[\\w]+)[\\s]*";
 
     public static final Pattern[] INLINE_DOC_REGEX = {
-        Pattern.compile(DOC_TYPE_PATTERN, Pattern.MULTILINE),
+        Pattern.compile(DOC_TYPE_PATTERN_CLASS_SECOND, Pattern.MULTILINE),
+        Pattern.compile(DOC_TYPE_PATTERN_CLASS_FIRST, Pattern.MULTILINE),
         Pattern.compile(DEPRECATED_DOC_TYPE_PATTERN),
     };
 
     // for supporting completion and navigation of one line element
-    public static final String DOC_TYPE_PATTERN_SINGLE  = "\\{#[\\s]+@var[\\s]+([\\w]+)[\\s]+([\\w\\\\\\[\\]]+)[\\s]+#}";
+    public static final String[] DOC_TYPE_PATTERN_SINGLE  = new String[] {
+        "\\{#[\\s]+(?<var>[\\w]+)[\\s]+(?<class>[\\w\\\\\\[\\]]+)[\\s]+#}",
+        "\\{#[\\s]+"+ DOC_TYPE_PATTERN_CLASS_SECOND + "[\\s]+#}",
+        "\\{#[\\s]+"+ DOC_TYPE_PATTERN_CLASS_FIRST + "[\\s]+#}",
+    };
 
     private static String[] PROPERTY_SHORTCUTS = new String[] {"get", "is", "has"};
 
@@ -192,7 +211,7 @@ private static Map<String, String> getInlineCommentDocsVars(@NotNull PsiElement
             for (Pattern pattern : INLINE_DOC_REGEX) {
                 Matcher matcher = pattern.matcher(text);
                 while (matcher.find()) {
-                    variables.put(matcher.group(1), matcher.group(2));
+                    variables.put(matcher.group("var"), matcher.group("class"));
                 }
             }
         }
diff --git a/src/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigUtil.java b/src/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigUtil.java
@@ -2682,13 +2682,14 @@ private static void visitTemplateVariables(@NotNull PsiElement scope, @NotNull C
                 }
             } else if (psiElement instanceof PsiComment) {
                 // {# @var foobar Class #}
+                // {# @var Class foobar #}
                 String text = psiElement.getText();
 
                 if(StringUtils.isNotBlank(text)) {
                     for (Pattern pattern : TwigTypeResolveUtil.INLINE_DOC_REGEX) {
                         Matcher matcher = pattern.matcher(text);
                         while (matcher.find()) {
-                            consumer.consume(Pair.create(matcher.group(1), psiElement));
+                            consumer.consume(Pair.create(matcher.group("var"), psiElement));
                         }
                     }
                 }
diff --git a/tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/TwigTemplateGoToDeclarationHandlerTest.java b/tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/TwigTemplateGoToDeclarationHandlerTest.java
@@ -136,6 +136,7 @@ public void testSimpleTestNavigationToExtension() {
 
     public void testGetVarClassGoto() {
         assertNavigationMatch(TwigFileType.INSTANCE, "{# @var bar \\Date<caret>Time #}", PlatformPatterns.psiElement(PhpClass.class));
+        assertNavigationMatch(TwigFileType.INSTANCE, "{# @var \\Date<caret>Time bar #}", PlatformPatterns.psiElement(PhpClass.class));
     }
 
     public void testGetVarClassGotoDeprecated() {
diff --git a/tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/util/TwigTypeResolveUtilTest.java b/tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/util/TwigTypeResolveUtilTest.java
@@ -1,11 +1,17 @@
 package fr.adrienbrault.idea.symfony2plugin.tests.templating.util;
 
+import com.intellij.psi.PsiFile;
+import com.intellij.psi.PsiFileFactory;
 import com.jetbrains.php.lang.psi.PhpPsiElementFactory;
 import com.jetbrains.php.lang.psi.elements.Method;
+import com.jetbrains.twig.TwigFile;
+import com.jetbrains.twig.TwigLanguage;
 import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigTypeResolveUtil;
 import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Map;
+
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
  */
@@ -17,6 +23,49 @@ public void testThatTwigGetAttributeSupportShortcuts() {
         assertEquals("foo", TwigTypeResolveUtil.getPropertyShortcutMethodName(createMethod("isFoo")));
     }
 
+    /**
+     * @see TwigTypeResolveUtil#findFileVariableDocBlock
+     */
+    public void testFindFileVariableDocBlock() {
+        PsiFile fileFromText = PsiFileFactory.getInstance(getProject()).createFileFromText(TwigLanguage.INSTANCE, "" +
+            "{# @var foo_1 \\AppBundle\\Entity\\MeterValueDTO #}\n" +
+            "{# @var foo_2 \\AppBundle\\Entity\\MeterValueDTO[] #}\n" +
+            "{# @var \\AppBundle\\Entity\\MeterValueDTO foo_3 #}\n" +
+            "{# @var \\AppBundle\\Entity\\MeterValueDTO[] foo_4 #}\n" +
+            "" +
+            "{#\n" +
+            "@var \\AppBundle\\Entity\\MeterValueDTO foo_5\n" +
+            "@var foo_6 \\AppBundle\\Entity\\MeterValueDTO\n" +
+            "#}\n"
+        );
+
+        Map<String, String> fileVariableDocBlock = TwigTypeResolveUtil.findFileVariableDocBlock((TwigFile) fileFromText);
+
+        assertEquals("\\AppBundle\\Entity\\MeterValueDTO", fileVariableDocBlock.get("foo_1"));
+        assertEquals("\\AppBundle\\Entity\\MeterValueDTO[]", fileVariableDocBlock.get("foo_2"));
+        assertEquals("\\AppBundle\\Entity\\MeterValueDTO", fileVariableDocBlock.get("foo_3"));
+        assertEquals("\\AppBundle\\Entity\\MeterValueDTO[]", fileVariableDocBlock.get("foo_4"));
+
+        assertEquals("\\AppBundle\\Entity\\MeterValueDTO", fileVariableDocBlock.get("foo_5"));
+        assertEquals("\\AppBundle\\Entity\\MeterValueDTO", fileVariableDocBlock.get("foo_6"));
+    }
+
+    public void testReqExForInlineDocVariables() {
+        assertMatches("{# @var foo_1 \\AppBundle\\Entity\\MeterValueDTO #}", TwigTypeResolveUtil.DOC_TYPE_PATTERN_SINGLE);
+        assertMatches("{# @var \\AppBundle\\Entity\\MeterValueDTO foo_1 #}", TwigTypeResolveUtil.DOC_TYPE_PATTERN_SINGLE);
+        assertMatches("{# foo_1 \\AppBundle\\Entity\\MeterValueDTO #}", TwigTypeResolveUtil.DOC_TYPE_PATTERN_SINGLE);
+    }
+
+    private void assertMatches(@NotNull String content, @NotNull String... regularExpressions) {
+        for (String regularExpression : regularExpressions) {
+            if(content.matches(regularExpression)) {
+                return;
+            }
+        }
+
+        fail("invalid regular expression: " + content);
+    }
+
     @NotNull
     private Method createMethod(@NotNull String method) {
         return PhpPsiElementFactory.createFromText(
diff --git a/tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/util/TwigUtilTest.java b/tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/util/TwigUtilTest.java
@@ -491,6 +491,7 @@ public void testVisitTemplateVariables() {
 
         // file doc
         assertContainsElements(elementMap.keySet(), "inline_foo");
+        assertContainsElements(elementMap.keySet(), "inline_foo_2");
 
         // if
         assertContainsElements(elementMap.keySet(), "if_foo");
diff --git a/tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/util/fixtures/variables.html.twig b/tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/util/fixtures/variables.html.twig
@@ -17,6 +17,7 @@
 {% for foo in for_bar %}{% endfor %}
 
 {# @var inline_foo Class #}
+{# @var Class inline_foo_2 #}
 
 {% block my_block %}
     {% set my_block_set_foo = '' %}

Original file line number	Diff line number	Diff line change
`@@ -2682,13 +2682,14 @@ private static void visitTemplateVariables(@NotNull PsiElement scope, @NotNull C`
`2682`	`2682`	`}`
`2683`	`2683`	`} else if (psiElement instanceof PsiComment) {`
`2684`	`2684`	`// {# @var foobar Class #}`
	`2685`	`+ // {# @var Class foobar #}`
`2685`	`2686`	`String text = psiElement.getText();`
`2686`	`2687`
`2687`	`2688`	`if(StringUtils.isNotBlank(text)) {`
`2688`	`2689`	`for (Pattern pattern : TwigTypeResolveUtil.INLINE_DOC_REGEX) {`
`2689`	`2690`	`Matcher matcher = pattern.matcher(text);`
`2690`	`2691`	`while (matcher.find()) {`
`2691`		`- consumer.consume(Pair.create(matcher.group(1), psiElement));`
	`2692`	`+ consumer.consume(Pair.create(matcher.group("var"), psiElement));`
`2692`	`2693`	`}`
`2693`	`2694`	`}`
`2694`	`2695`	`}`
Original file line number	Diff line number	Diff line change
`@@ -136,6 +136,7 @@ public void testSimpleTestNavigationToExtension() {`
`136`	`136`
`137`	`137`	`public void testGetVarClassGoto() {`
`138`	`138`	`assertNavigationMatch(TwigFileType.INSTANCE, "{# @var bar \\Date<caret>Time #}", PlatformPatterns.psiElement(PhpClass.class));`
	`139`	`+ assertNavigationMatch(TwigFileType.INSTANCE, "{# @var \\Date<caret>Time bar #}", PlatformPatterns.psiElement(PhpClass.class));`
`139`	`140`	`}`
`140`	`141`
`141`	`142`	`public void testGetVarClassGotoDeprecated() {`