add name resolving for template file in a overwritten context of "bundle" or "app" #437

Author: Haehnchen

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

@@ -273,7 +273,7 @@ private static Collection<PsiFile> getTemplateOverwrites(@NotNull Project projec
 
         // find parent bundles
         for (SymfonyBundle symfonyBundle : new SymfonyBundleUtil(project).getBundles()) {
-            String parentBundle = PhpElementsUtil.getMethodReturnAsString(symfonyBundle.getPhpClass(), "getParent");
+            String parentBundle = symfonyBundle.getParentBundleName();
             if(parentBundle != null && bundle.equals(parentBundle)) {
                 relativeFile = symfonyBundle.getRelative(String.format("Resources/views/%s", templatePath.substring(i + 7)));
                 if(relativeFile != null) {

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

@@ -363,6 +363,11 @@ public static Map<String, VirtualFile> getTemplateName(TwigFile twigFile, Map<St
             }
         }
 
+        String templateNameByOverwrite = getTemplateNameByOverwrite(twigFile.getProject(), twigFile.getVirtualFile());
+        if(templateNameByOverwrite != null) {
+            map.put(templateNameByOverwrite, twigFile.getVirtualFile());
+        }
+
         return map;
     }
 
@@ -612,4 +617,49 @@ public static String buildStringFromTwigCreateContainer(@NotNull Project project
 
     }
 
+    /**
+     * Gets a template name from "app" or bundle getParent overwrite
+     *
+     * app/Resources/AcmeBlogBundle/views/Blog/index.html.twig
+     * src/Acme/UserBundle/Resources/views/index.html.twig
+     */
+    @Nullable
+    public static String getTemplateNameByOverwrite(@NotNull Project project, @NotNull VirtualFile virtualFile) {
+
+        String relativePath = VfsUtil.getRelativePath(virtualFile, project.getBaseDir());
+        if(relativePath == null) {
+            return null;
+        }
+
+        // app/Resources/AcmeBlogBundle/views/Blog/index.html.twig
+        Matcher matcher = Pattern.compile("app/Resources/([^/]*Bundle)/views/(.*)$").matcher(relativePath);
+        if (matcher.find()) {
+            return TwigHelper.normalizeTemplateName(matcher.group(1) + ":" + matcher.group(2));
+        }
+
+        // src/Acme/UserBundle/Resources/views/index.html.twig
+        SymfonyBundleUtil symfonyBundleUtil = new SymfonyBundleUtil(project);
+        SymfonyBundle containingBundle = symfonyBundleUtil.getContainingBundle(virtualFile);
+        if(containingBundle == null) {
+            return null;
+        }
+
+        String relative = containingBundle.getRelative(virtualFile);
+        if(relative == null) {
+            return null;
+        }
+
+        if(!relative.startsWith("Resources/views/")) {
+            return null;
+        }
+
+        String parentBundleName = containingBundle.getParentBundleName();
+        if(parentBundleName == null) {
+            return null;
+        }
+
+        return TwigHelper.normalizeTemplateName(containingBundle.getName() + ":" + relative.substring("Resources/views/".length(), relative.length()));
+    }
+
+
 }

src/fr/adrienbrault/idea/symfony2plugin/util/SymfonyBundleUtil.java

@@ -1,11 +1,13 @@
 package fr.adrienbrault.idea.symfony2plugin.util;
 
 import com.intellij.openapi.project.Project;
+import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiDirectory;
 import com.intellij.psi.PsiFile;
 import com.jetbrains.php.PhpIndex;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import fr.adrienbrault.idea.symfony2plugin.util.dict.SymfonyBundle;
+import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.Collection;
@@ -96,6 +98,18 @@ public SymfonyBundle getContainingBundle(PsiFile psiFile) {
         return null;
     }
 
+    @Nullable
+    public SymfonyBundle getContainingBundle(@NotNull VirtualFile virtualFile) {
+
+        for(SymfonyBundle bundle : this.getBundles()) {
+            if(bundle.isInBundle(virtualFile)) {
+                return bundle;
+            }
+        }
+
+        return null;
+    }
+
     @Nullable
     public SymfonyBundle getContainingBundle(PsiDirectory directory) {
 

src/fr/adrienbrault/idea/symfony2plugin/util/dict/SymfonyBundle.java

@@ -7,6 +7,7 @@
 import com.intellij.psi.search.GlobalSearchScope;
 import com.intellij.psi.search.GlobalSearchScopes;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
+import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
 import org.jetbrains.annotations.Nullable;
 
 public class SymfonyBundle {
@@ -171,4 +172,9 @@ public boolean isTestBundle() {
         return directory.getVirtualFile().toString().contains("/Tests/");
     }
 
+    @Nullable
+    public String getParentBundleName() {
+        return PhpElementsUtil.getMethodReturnAsString(this.getPhpClass(), "getParent");
+    }
+
 }

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

@@ -0,0 +1,55 @@
+package fr.adrienbrault.idea.symfony2plugin.tests.templating.util;
+
+import com.intellij.openapi.vfs.VfsUtil;
+import com.jetbrains.twig.TwigFileType;
+import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil;
+import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
+import java.io.File;
+
+public class TwigUtilIntegrationTest extends SymfonyLightCodeInsightFixtureTestCase {
+
+    public void setUp() throws Exception {
+        super.setUp();
+
+        createDummyFiles(
+            "app/Resources/TwigUtilIntegrationBundle/views/layout.html.twig",
+            "app/Resources/TwigUtilIntegrationBundle/views/Foo/layout.html.twig",
+            "app/Resources/TwigUtilIntegrationBundle/views/Foo/Bar/layout.html.twig"
+        );
+    }
+
+    protected String getTestDataPath() {
+        return new File(this.getClass().getResource("fixtures").getFile()).getAbsolutePath();
+    }
+
+    /**
+     * @see fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil#getTemplateNameByOverwrite
+     */
+    public void testTemplateOverwriteNameGeneration() {
+        assertEquals(
+            "TwigUtilIntegrationBundle:layout.html.twig",
+            TwigUtil.getTemplateNameByOverwrite(getProject(), VfsUtil.findRelativeFile(getProject().getBaseDir(), "app/Resources/TwigUtilIntegrationBundle/views/layout.html.twig".split("/")))
+        );
+
+        assertEquals(
+            "TwigUtilIntegrationBundle:Foo/layout.html.twig",
+            TwigUtil.getTemplateNameByOverwrite(getProject(), VfsUtil.findRelativeFile(getProject().getBaseDir(), "app/Resources/TwigUtilIntegrationBundle/views/Foo/layout.html.twig".split("/")))
+        );
+
+        assertEquals(
+            "TwigUtilIntegrationBundle:Foo/Bar/layout.html.twig",
+            TwigUtil.getTemplateNameByOverwrite(getProject(), VfsUtil.findRelativeFile(getProject().getBaseDir(), "app/Resources/TwigUtilIntegrationBundle/views/Foo/Bar/layout.html.twig".split("/")))
+        );
+    }
+
+    /**
+     * @see fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil#getTemplateNameByOverwrite
+     * @see fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil#getTemplateName
+     */
+    public void testTemplateOverwriteNavigation() {
+        assertNavigationContainsFile(TwigFileType.INSTANCE, "{% extends '<caret>TwigUtilIntegrationBundle:layout.html.twig' %}", "/views/layout.html.twig");
+        assertNavigationContainsFile(TwigFileType.INSTANCE, "{% extends '<caret>TwigUtilIntegrationBundle:Foo/layout.html.twig' %}", "/views/Foo/layout.html.twig");
+        assertNavigationContainsFile(TwigFileType.INSTANCE, "{% extends '<caret>TwigUtilIntegrationBundle:Foo/Bar/layout.html.twig' %}", "/views/Foo/Bar/layout.html.twig");
+    }
+
+}