Merge pull request #1439 from Haehnchen/feature/twig-paths-relative-support

provide relative path support for Twig paths configuration via yaml

Author: Haehnchen

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

@@ -1897,31 +1897,42 @@ public static Collection<Pair<String, String>> getTwigPathFromYamlConfigResolved
         Collection<Pair<String, String>> paths = new ArrayList<>();
 
         for (Pair<String, String> pair : getTwigPathFromYamlConfig(yamlFile)) {
-            String second = pair.getSecond();
+            // normalize path; just to be error prune
+            String namespacePath = pair.getSecond().replace("\\", "/").replaceAll("/+", "/");
+            String namespace = pair.getFirst();
 
-            if(second.startsWith("%kernel.root_dir%")) {
+            if(namespacePath.startsWith("%kernel.root_dir%")) {
                 // %kernel.root_dir%/../app
                 // %kernel.root_dir%/foo
                 for (VirtualFile appDir : FilesystemUtil.getAppDirectories(yamlFile.getProject())) {
-                    String path = StringUtils.stripStart(second.substring("%kernel.root_dir%".length()), "/");
+                    String path = StringUtils.stripStart(namespacePath.substring("%kernel.root_dir%".length()), "/");
 
                     VirtualFile relativeFile = VfsUtil.findRelativeFile(appDir, path.split("/"));
                     if(relativeFile != null) {
                         String relativePath = VfsUtil.getRelativePath(relativeFile, baseDir, '/');
                         if(relativePath != null) {
-                            paths.add(Pair.create(pair.getFirst(), relativePath));
+                            paths.add(Pair.create(namespace, relativePath));
                         }
                     }
                 }
-            } else if(second.startsWith("%kernel.project_dir%")) {
+            } else if(namespacePath.startsWith("%kernel.project_dir%")) {
                 // '%kernel.root_dir%/test'
-                String path = StringUtils.stripStart(second.substring("%kernel.project_dir%".length()), "/");
+                String path = StringUtils.stripStart(namespacePath.substring("%kernel.project_dir%".length()), "/");
 
-                VirtualFile relativeFile = VfsUtil.findRelativeFile(yamlFile.getProject().getBaseDir(), path.split("/"));
+                VirtualFile relativeFile = VfsUtil.findRelativeFile(baseDir, path.split("/"));
                 if(relativeFile != null) {
                     String relativePath = VfsUtil.getRelativePath(relativeFile, baseDir, '/');
                     if(relativePath != null) {
-                        paths.add(Pair.create(pair.getFirst(), relativePath));
+                        paths.add(Pair.create(namespace, relativePath));
+                    }
+                }
+            } else if(!namespacePath.startsWith("/") && !namespacePath.startsWith("\\")) {
+                // 'test/foo'
+                VirtualFile relativeFile = VfsUtil.findRelativeFile(baseDir, namespacePath.split("/"));
+                if(relativeFile != null) {
+                    String relativePath = VfsUtil.getRelativePath(relativeFile, baseDir, '/');
+                    if(relativePath != null) {
+                        paths.add(Pair.create(namespace, relativePath));
                     }
                 }
             }

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

@@ -14,10 +14,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.yaml.psi.YAMLFile;
 
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.List;
+import java.util.*;
 
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
@@ -183,29 +180,41 @@ public void testGetTemplateTargetOnOffset() {
      * @see TwigUtil#getTwigPathFromYamlConfigResolved
      */
     public void testGetTwigPathFromYamlConfigResolved() {
-        createFile("app/test/foo.yaml");
+        createFile("app/test/foo.html.twig");
+        createFile("app/template/foo.html.twig");
 
         PsiFile dummyFile = YamlPsiElementFactory.createDummyFile(getProject(), "" +
             "twig:\n" +
             "   paths:\n" +
             "       '%kernel.root_dir%/test': foo\n" +
             "       '%kernel.project_dir%/app/test': project\n" +
-            "       '%kernel.root_dir%/../app': app\n"
+            "       '%kernel.root_dir%/../app': app\n" +
+            "       'app/template': MY_PREFIX\n" +
+            "       'app///\\\\\\template': MY_PREFIX_1\n"
         );
 
         Collection<Pair<String, String>> paths = TwigUtil.getTwigPathFromYamlConfigResolved((YAMLFile) dummyFile);
 
         assertNotNull(
-            paths.stream().filter(pair -> "foo".equals(pair.getFirst()) && "app/test".equals(pair.getSecond())).findFirst()
+            paths.stream().filter(pair -> "foo".equals(pair.getFirst()) && "app/test".equals(pair.getSecond())).findFirst().get()
         );
 
         assertNotNull(
-            paths.stream().filter(pair -> "project".equals(pair.getFirst()) && "app/test".equals(pair.getSecond())).findFirst()
+            paths.stream().filter(pair -> "project".equals(pair.getFirst()) && "app/test".equals(pair.getSecond())).findFirst().get()
         );
 
         assertNotNull(
-            paths.stream().filter(pair -> "app".equals(pair.getFirst()) && "app".equals(pair.getSecond())).findFirst()
+            paths.stream().filter(pair -> "app".equals(pair.getFirst()) && "app".equals(pair.getSecond())).findFirst().get()
         );
+
+        assertNotNull(
+            paths.stream().filter(pair -> "MY_PREFIX".equals(pair.getFirst()) && "app/template".equals(pair.getSecond())).findFirst().get()
+        );
+
+        Pair<String, String> myPrefix1 = paths.stream().filter(pair -> "MY_PREFIX_1".equals(pair.getFirst())).findAny().get();
+
+        assertEquals("MY_PREFIX_1", myPrefix1.getFirst());
+        assertEquals("app/template", myPrefix1.getSecond());
     }
 
     private void assertIsDirectoryAtOffset(@NotNull String templateName, int offset, @NotNull String directory) {