add twig path configuration parser of yaml files #654

Author: Haehnchen

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

@@ -46,6 +46,8 @@
 import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.jetbrains.yaml.YAMLUtil;
+import org.jetbrains.yaml.psi.*;
 
 import java.io.File;
 import java.util.*;
@@ -1804,4 +1806,48 @@ public static Pair<PsiFile[], Boolean> findScopedFile(@NotNull PsiElement psiEle
 
         return Pair.create(new PsiFile[] {psiElement.getContainingFile()}, false);
     }
+
+    /**
+     * Collects Twig path in given yaml configuration
+     *
+     * twig:
+     *  paths:
+     *   "%kernel.root_dir%/../src/vendor/bundle/Resources/views": core
+     */
+    @NotNull
+    public static Collection<Pair<String, String>> getTwigPathFromYamlConfig(@NotNull YAMLFile yamlFile) {
+        YAMLKeyValue yamlKeyValue = YAMLUtil.getQualifiedKeyInFile(yamlFile, "twig", "paths");
+        if(yamlKeyValue == null) {
+            return Collections.emptyList();
+        }
+
+        YAMLValue value = yamlKeyValue.getValue();
+        if(!(value instanceof YAMLMapping)) {
+            return Collections.emptyList();
+        }
+
+        Collection<Pair<String, String>> pair = new ArrayList<>();
+
+        for (YAMLPsiElement element : value.getYAMLElements()) {
+            if(!(element instanceof YAMLKeyValue)) {
+                continue;
+            }
+
+            String keyText = ((YAMLKeyValue) element).getKeyText();
+            if(StringUtils.isBlank(keyText)) {
+                continue;
+            }
+
+            String valueText = ((YAMLKeyValue) element).getValueText();
+
+            // normalize null value
+            if(valueText.equals("~")) {
+                valueText = "";
+            }
+
+            pair.add(Pair.create(valueText, keyText));
+        }
+
+        return pair;
+    }
 }

tests/fr/adrienbrault/idea/symfony2plugin/tests/TwigHelperLightTest.java

@@ -1,8 +1,12 @@
 package fr.adrienbrault.idea.symfony2plugin.tests;
 
+import com.intellij.openapi.util.Condition;
+import com.intellij.openapi.util.Pair;
 import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiFile;
 import com.intellij.psi.PsiFileFactory;
 import com.intellij.psi.tree.IElementType;
+import com.intellij.util.containers.ContainerUtil;
 import com.jetbrains.twig.TwigFile;
 import com.jetbrains.twig.TwigFileType;
 import com.jetbrains.twig.elements.TwigElementFactory;
@@ -11,8 +15,11 @@
 import com.jetbrains.twig.elements.TwigTagWithFileReference;
 import fr.adrienbrault.idea.symfony2plugin.TwigHelper;
 import fr.adrienbrault.idea.symfony2plugin.templating.dict.TwigBlock;
+import fr.adrienbrault.idea.symfony2plugin.util.yaml.YamlPsiElementFactory;
 import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.yaml.YAMLFileType;
+import org.jetbrains.yaml.psi.YAMLFile;
 
 import java.util.*;
 
@@ -124,6 +131,45 @@ public void testIncludeTagNonAllowedTags() {
         assertSize(0, getIncludeTemplates("{% import 'foo.html.twig' %}", TwigElementTypes.IMPORT_TAG));
     }
 
+    /**
+     * @see TwigHelper#getTwigPathFromYamlConfig
+     */
+    public void testGetTwigPathFromYamlConfig() {
+        String content = "twig:\n" +
+            "    paths:\n" +
+            "        \"%kernel.root_dir%/../src/views\": core\n" +
+            "        \"%kernel.root_dir%/../src/views2\": 'core2'\n" +
+            "        \"%kernel.root_dir%/../src/views3\": \"core3\"\n" +
+            "        \"%kernel.root_dir%/../src/views4\": ~\n" +
+            "        \"%kernel.root_dir%/../src/views5\": \n"
+            ;
+
+        YAMLFile fileFromText = (YAMLFile) PsiFileFactory.getInstance(getProject())
+            .createFileFromText("DUMMY__." + YAMLFileType.YML.getDefaultExtension(), YAMLFileType.YML, content, System.currentTimeMillis(), false);
+
+        Collection<Pair<String, String>> map = TwigHelper.getTwigPathFromYamlConfig(fileFromText);
+
+        assertNotNull(ContainerUtil.find(map, pair ->
+            pair.getFirst().equals("core") && pair.getSecond().equals("%kernel.root_dir%/../src/views")
+        ));
+
+        assertNotNull(ContainerUtil.find(map, pair ->
+            pair.getFirst().equals("core2") && pair.getSecond().equals("%kernel.root_dir%/../src/views2")
+        ));
+
+        assertNotNull(ContainerUtil.find(map, pair ->
+            pair.getFirst().equals("core3") && pair.getSecond().equals("%kernel.root_dir%/../src/views3")
+        ));
+
+        assertNotNull(ContainerUtil.find(map, pair ->
+            pair.getFirst().equals("") && pair.getSecond().equals("%kernel.root_dir%/../src/views4")
+        ));
+
+        assertNotNull(ContainerUtil.find(map, pair ->
+            pair.getFirst().equals("") && pair.getSecond().equals("%kernel.root_dir%/../src/views5")
+        ));
+    }
+
     /**
      * @see TwigHelper#getBlockTagPattern
      */