improvement template name resolving for overwrites: support parent bundle and app resources #437

Author: Haehnchen

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

@@ -228,8 +228,61 @@ public static PsiFile[] getTemplatePsiElements(Project project, String templateN
 
         }
 
+        psiFiles.addAll(getTemplateOverwrites(project, normalizedTemplateName));
+
         return psiFiles.toArray(new PsiFile[psiFiles.size()]);
+    }
+
+    /**
+     * Collects overwritten templates
+     *
+     * app/Resources/MyUserBundle/views/layout.html.twig
+     * src/Acme/UserBundle/Resources/views/layout.html.twig <- getParent = MyUserBundle
+     */
+    private static Collection<PsiFile> getTemplateOverwrites(@NotNull Project project, @NotNull String normalizedTemplateName) {
+
+        // Bundle overwrite:
+        if(normalizedTemplateName.startsWith(":") || normalizedTemplateName.startsWith("@")) {
+            return Collections.emptyList();
+        }
+
+        String templatePath = StringUtils.strip(normalizedTemplateName.replace(":", "/").replace("//", "/"), "/");
+
+        int i = templatePath.indexOf("Bundle/");
+        if( i == -1) {
+            return Collections.emptyList();
+        }
+
+        Collection<VirtualFile> files = new HashSet<VirtualFile>();
+
+        String bundle = templatePath.substring(0, i + 6);
+
+        // invalid Bundle in path condition
+        if(bundle.contains("/")) {
+            return Collections.emptyList();
+        }
+
+        VirtualFile relativeFile = VfsUtil.findRelativeFile(
+            project.getBaseDir(),
+            String.format("app/Resources/%s/views/%s", bundle, templatePath.substring(i + 7)).split("/")
+        );
+
+        if(relativeFile != null) {
+            files.add(relativeFile);
+        }
+
+        // find parent bundles
+        for (SymfonyBundle symfonyBundle : new SymfonyBundleUtil(project).getBundles()) {
+            String parentBundle = PhpElementsUtil.getMethodReturnAsString(symfonyBundle.getPhpClass(), "getParent");
+            if(parentBundle != null && bundle.equals(parentBundle)) {
+                relativeFile = symfonyBundle.getRelative(String.format("Resources/views/%s", templatePath.substring(i + 7)));
+                if(relativeFile != null) {
+                    files.add(relativeFile);
+                }
+            }
+        }
 
+        return PsiElementUtils.convertVirtualFilesToPsiFiles(project, files);
     }
 
     private static void addFileInsideTwigPath(Project project, String templatePath, Collection<PsiFile> psiFiles, TwigPath twigPath) {

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

@@ -332,6 +332,42 @@ static public PsiElementPattern.Capture<StringLiteralExpression> getMethodReturn
             .withLanguage(PhpLanguage.INSTANCE);
     }
 
+    /**
+     * Find a string return value of a method context "function() { return 'foo'}"
+     * First match wins
+     */
+    @Nullable
+    static public String getMethodReturnAsString(@NotNull PhpClass phpClass, @NotNull String methodName) {
+
+        Method method = phpClass.findMethodByName(methodName);
+        if(method == null) {
+            return null;
+        }
+
+        final Set<String> values = new HashSet<String>();
+        method.acceptChildren(new PsiRecursiveElementWalkingVisitor() {
+            @Override
+            public void visitElement(PsiElement element) {
+
+                if(PhpElementsUtil.getMethodReturnPattern().accepts(element)) {
+                    String value = PhpElementsUtil.getStringValue(element);
+                    if(value != null && StringUtils.isNotBlank(value)) {
+                        values.add(value);
+                    }
+                }
+
+                super.visitElement(element);
+            }
+        });
+
+        if(values.size() == 0) {
+            return null;
+        }
+
+        // we support only first item
+        return values.iterator().next();
+    }
+
     @Nullable
     static public PhpClass getClass(Project project, String className) {
         return getClass(PhpIndex.getInstance(project), className);

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

@@ -18,6 +18,7 @@
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.HashSet;
 import java.util.List;
 
 /**
@@ -327,4 +328,25 @@ public static String getStringBeforeCursor(StringLiteralExpression literal, int
         return content.length() >= cursorOffsetClean ? content.substring(0, cursorOffsetClean) : null;
     }
 
+    @NotNull
+    public static Collection<PsiFile> convertVirtualFilesToPsiFiles(@NotNull Project project, @NotNull Collection<VirtualFile> files) {
+
+        Collection<PsiFile> psiFiles = new HashSet<PsiFile>();
+
+        PsiManager psiManager = null;
+        for (VirtualFile file : files) {
+
+            if(psiManager == null) {
+                psiManager = PsiManager.getInstance(project);
+            }
+
+            PsiFile psiFile = psiManager.findFile(file);
+            if(psiFile != null) {
+                psiFiles.add(psiFile);
+            }
+        }
+
+        return psiFiles;
+    }
+
 }