visit parent blocks for Twig variables #1035

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigTypeResolveUtil.java

@@ -169,22 +169,27 @@ public static Collection<TwigTypeContainer> resolveTwigMethodName(@NotNull PsiEl
      *
      * "@var foo \Foo"
      */
-    private static Map<String, String> findInlineStatementVariableDocBlock(PsiElement psiInsideBlock, final IElementType parentStatement) {
-        PsiElement twigCompositeElement = PsiTreeUtil.findFirstParent(psiInsideBlock, psiElement -> {
-            if (psiElement instanceof TwigCompositeElement) {
-                if (PlatformPatterns.psiElement(parentStatement).accepts(psiElement)) {
-                    return true;
-                }
-            }
-            return false;
-        });
+    private static Map<String, String> findInlineStatementVariableDocBlock(@NotNull PsiElement psiInsideBlock, @NotNull IElementType parentStatement, boolean nextParent) {
+        PsiElement twigCompositeElement = PsiTreeUtil.findFirstParent(psiInsideBlock, psiElement ->
+            PlatformPatterns.psiElement(parentStatement).accepts(psiElement)
+        );
 
         Map<String, String> variables = new HashMap<>();
         if(twigCompositeElement == null) {
             return variables;
         }
 
-        return getInlineCommentDocsVars(twigCompositeElement);
+        Map<String, String> inlineCommentDocsVars = getInlineCommentDocsVars(twigCompositeElement);
+
+        // visit parent elements for extending scope
+        if(nextParent) {
+            PsiElement parent = twigCompositeElement.getParent();
+            if(parent != null) {
+                inlineCommentDocsVars.putAll(findInlineStatementVariableDocBlock(twigCompositeElement.getParent(), parentStatement, true));
+            }
+        }
+
+        return inlineCommentDocsVars;
     }
 
     /**
@@ -237,7 +242,6 @@ public static Map<String, PsiVariable> collectScopeVariables(@NotNull PsiElement
 
     @NotNull
     public static Map<String, PsiVariable> collectScopeVariables(@NotNull PsiElement psiElement, @NotNull Set<VirtualFile> visitedFiles) {
-
         Map<String, Set<String>> globalVars = new HashMap<>();
         Map<String, PsiVariable> controllerVars = new HashMap<>();
 
@@ -255,9 +259,9 @@ public static Map<String, PsiVariable> collectScopeVariables(@NotNull PsiElement
         }
 
         // globals first
-        globalVars.putAll(convertHashMapToTypeSet(findInlineStatementVariableDocBlock(psiElement, TwigElementTypes.BLOCK_STATEMENT)));
-        globalVars.putAll(convertHashMapToTypeSet(findInlineStatementVariableDocBlock(psiElement, TwigElementTypes.MACRO_STATEMENT)));
-        globalVars.putAll(convertHashMapToTypeSet(findInlineStatementVariableDocBlock(psiElement, TwigElementTypes.FOR_STATEMENT)));
+        globalVars.putAll(convertHashMapToTypeSet(findInlineStatementVariableDocBlock(psiElement, TwigElementTypes.BLOCK_STATEMENT, true)));
+        globalVars.putAll(convertHashMapToTypeSet(findInlineStatementVariableDocBlock(psiElement, TwigElementTypes.MACRO_STATEMENT, false)));
+        globalVars.putAll(convertHashMapToTypeSet(findInlineStatementVariableDocBlock(psiElement, TwigElementTypes.FOR_STATEMENT, false)));
 
         for(Map.Entry<String, Set<String>> entry: globalVars.entrySet()) {
             Set<String> types = entry.getValue();

tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/util/TwigTypeResolveUtilTest.java

@@ -1,12 +1,15 @@
 package fr.adrienbrault.idea.symfony2plugin.tests.templating.util;
 
+import com.intellij.psi.PsiElement;
 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.TwigFileType;
 import com.jetbrains.twig.TwigLanguage;
 import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigTypeResolveUtil;
+import fr.adrienbrault.idea.symfony2plugin.templating.variable.dict.PsiVariable;
 import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
 import org.jetbrains.annotations.NotNull;
 
@@ -56,6 +59,31 @@ public void testReqExForInlineDocVariables() {
         assertMatches("{# foo_1 \\AppBundle\\Entity\\MeterValueDTO #}", TwigTypeResolveUtil.DOC_TYPE_PATTERN_SINGLE);
     }
 
+    /**
+     * @see TwigTypeResolveUtil#collectScopeVariables
+     */
+    public void testCollectScopeVariables() {
+        myFixture.configureByText(TwigFileType.INSTANCE,
+            "{# @var b \\Foo\\Bar #}" +
+                "{% block one %}\n" +
+                "    {# @var a \\Foo\\Bar #}\n" +
+                "\n" +
+                "    {% block two %}\n" +
+                "        {% block two %}\n" +
+                "            {{ <caret> }}\n" +
+                "        {% endblock %}\n" +
+                "    {% endblock %}\n" +
+                "{% endblock %}"
+        );
+
+        PsiElement psiElement = myFixture.getFile().findElementAt(myFixture.getCaretOffset());
+
+        Map<String, PsiVariable> stringPsiVariableMap = TwigTypeResolveUtil.collectScopeVariables(psiElement);
+
+        assertContainsElements(stringPsiVariableMap.get("a").getTypes(), "\\Foo\\Bar");
+        assertContainsElements(stringPsiVariableMap.get("b").getTypes(), "\\Foo\\Bar");
+    }
+
     private void assertMatches(@NotNull String content, @NotNull String... regularExpressions) {
         for (String regularExpression : regularExpressions) {
             if(content.matches(regularExpression)) {

tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/util/fixtures/TwigTypeResolveUtil.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Foo
+{
+    interface Bar
+    {
+        public function getFoobar();
+    }
+}