completion for variables of template rendering #1052

Author: Haehnchen

META-INF/plugin.xml

@@ -582,6 +582,7 @@
         <GotoCompletionRegistrar implementation="fr.adrienbrault.idea.symfony2plugin.security.VoterGotoCompletionRegistrar"/>
         <GotoCompletionRegistrar implementation="fr.adrienbrault.idea.symfony2plugin.translation.TranslationPlaceholderGotoCompletionRegistrar"/>
         <GotoCompletionRegistrar implementation="fr.adrienbrault.idea.symfony2plugin.dic.TaggedParameterGotoCompletionRegistrar"/>
+        <GotoCompletionRegistrar implementation="fr.adrienbrault.idea.symfony2plugin.templating.RenderParameterGotoCompletionRegistrar"/>
 
         <TwigNamespaceExtension implementation="fr.adrienbrault.idea.symfony2plugin.templating.path.JsonFileIndexTwigNamespaces"/>
         <TwigNamespaceExtension implementation="fr.adrienbrault.idea.symfony2plugin.templating.path.ConfigAddPathTwigNamespaces"/>

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

@@ -271,15 +271,11 @@ public static String normalizeTemplateName(String templateName) {
      * @param templateName path known, should not be normalized
      * @return target files
      */
-    public static PsiFile[] getTemplatePsiElements(Project project, String templateName) {
-
-
+    public static PsiFile[] getTemplatePsiElements(@NotNull Project project, @NotNull String templateName) {
         String normalizedTemplateName = normalizeTemplateName(templateName);
 
         Collection<PsiFile> psiFiles = new HashSet<>();
-
         for (TwigPath twigPath : getTwigNamespaces(project)) {
-
             if(!twigPath.isEnabled()) {
                 continue;
             }
@@ -392,7 +388,7 @@ private static Collection<PsiFile> getTemplateOverwrites(@NotNull Project projec
         return PsiElementUtils.convertVirtualFilesToPsiFiles(project, files);
     }
 
-    private static void addFileInsideTwigPath(Project project, String templatePath, Collection<PsiFile> psiFiles, TwigPath twigPath) {
+    private static void addFileInsideTwigPath(@NotNull Project project, @NotNull String templatePath, @NotNull Collection<PsiFile> psiFiles, @NotNull TwigPath twigPath) {
         String[] split = templatePath.split("/");
         VirtualFile virtualFile = VfsUtil.findRelativeFile(twigPath.getDirectory(project), split);
         if(virtualFile != null) {

src/fr/adrienbrault/idea/symfony2plugin/templating/RenderParameterGotoCompletionRegistrar.java

@@ -0,0 +1,83 @@
+package fr.adrienbrault.idea.symfony2plugin.templating;
+
+import com.intellij.codeInsight.lookup.LookupElement;
+import com.intellij.codeInsight.lookup.LookupElementBuilder;
+import com.intellij.patterns.PlatformPatterns;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiFile;
+import com.jetbrains.php.lang.psi.elements.ArrayCreationExpression;
+import com.jetbrains.php.lang.psi.elements.StringLiteralExpression;
+import com.jetbrains.twig.TwigFile;
+import fr.adrienbrault.idea.symfony2plugin.TwigHelper;
+import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionProvider;
+import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionRegistrar;
+import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionRegistrarParameter;
+import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil;
+import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
+import icons.TwigIcons;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+
+/**
+ * render('foo.html.twig', ['fo<caret>obar' => 'foobar'])
+ *
+ * @author Daniel Espendiller <daniel@espendiller.net>
+ */
+public class RenderParameterGotoCompletionRegistrar implements GotoCompletionRegistrar {
+    @Override
+    public void register(GotoCompletionRegistrarParameter registrar) {
+        registrar.register(
+            PlatformPatterns.psiElement(),
+            MyGotoCompletionProvider::new
+        );
+    }
+
+    private static class MyGotoCompletionProvider extends GotoCompletionProvider {
+        private MyGotoCompletionProvider(PsiElement psiElement) {
+            super(psiElement);
+        }
+
+        @NotNull
+        @Override
+        public Collection<LookupElement> getLookupElements() {
+            PsiElement parent = getElement().getParent();
+            if(!(parent instanceof StringLiteralExpression)) {
+                return Collections.emptyList();
+            }
+
+            ArrayCreationExpression arrayCreationElement = PhpElementsUtil.getCompletableArrayCreationElement(parent);
+            if(arrayCreationElement == null) {
+                return Collections.emptyList();
+            }
+
+            PsiElement prevSibling = arrayCreationElement.getPrevPsiSibling();
+            if(prevSibling == null) {
+                return Collections.emptyList();
+            }
+
+            String stringValue = PhpElementsUtil.getStringValue(prevSibling);
+            if(stringValue == null || !stringValue.toLowerCase().endsWith(".twig")) {
+                return Collections.emptyList();
+            }
+
+            Collection<LookupElement> elements = new ArrayList<>();
+
+            for (PsiFile psiFile : TwigHelper.getTemplatePsiElements(getProject(), stringValue)) {
+                if(!(psiFile instanceof TwigFile)) {
+                    continue;
+                }
+
+                TwigUtil.visitTemplateVariables((TwigFile) psiFile, pair ->
+                    elements.add(LookupElementBuilder.create(pair.getFirst())
+                        .withIcon(TwigIcons.TwigFileIcon)
+                        .withTypeText(stringValue, true)
+                ));
+            }
+
+            return elements;
+        }
+    }
+}

src/fr/adrienbrault/idea/symfony2plugin/templating/path/TwigPath.java

@@ -86,12 +86,22 @@ public String getRelativePath(Project project) {
     }
 
     @Nullable
-    public VirtualFile getDirectory(Project project) {
+    public VirtualFile getDirectory(@NotNull Project project) {
         String relativePath = this.getRelativePath(project);
         if(relativePath == null) {
             return null;
         }
 
+        //LocalFileSystem.getInstance().
+        //VirtualFile fileByPath = LocalFileSystem.getInstance().findFileByPath("ide-twig.json");
+        //VfsUtilCore.getRelativeLocation()
+        //BuildProperties.getProjectBuildFileName()
+        //VirtualFile baseDir = project.getBaseDir();
+
+        //VirtualFile[] children = baseDir.getChildren();
+
+        //VirtualFile fileByRelativePath = baseDir.findFileByRelativePath(relativePath);
+
         return VfsUtil.findRelativeFile(relativePath, project.getBaseDir());
     }
 

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

@@ -1384,6 +1384,19 @@ public static void visitTokenParsers(@NotNull Project project, @NotNull Consumer
         }
     }
 
+    /**
+     * Visit all template variables which are completion in Twig rendering call as array
+     */
+    public static void visitTemplateVariables(@NotNull TwigFile twigFile, @NotNull Consumer<Pair<String, PsiElement>> consumer) {
+        for (TwigSet twigSet : TwigUtil.getSetDeclaration(twigFile)) {
+            consumer.consume(Pair.create(twigSet.getName(), null));
+        }
+
+        for (String variable : TwigTypeResolveUtil.findFileVariableDocBlock(twigFile).keySet()) {
+            consumer.consume(Pair.create(variable, null));
+        }
+    }
+
     public static class DomainScope {
         @NotNull
         private final String defaultDomain;

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

@@ -245,6 +245,27 @@ public static MethodReference getMethodReferenceWithFirstStringParameter(PsiElem
         return (MethodReference) parameterList.getContext();
     }
 
+    @Nullable
+    public static MethodReference getFunctionReferenceWithFirstStringParameter(@NotNull PsiElement psiElement) {
+        if(!PlatformPatterns.psiElement()
+            .withParent(StringLiteralExpression.class).inside(ParameterList.class)
+            .withLanguage(PhpLanguage.INSTANCE).accepts(psiElement)) {
+
+            return null;
+        }
+
+        ParameterList parameterList = PsiTreeUtil.getParentOfType(psiElement, ParameterList.class);
+        if (parameterList == null) {
+            return null;
+        }
+
+        if (!(parameterList.getContext() instanceof FunctionReference)) {
+            return null;
+        }
+
+        return (MethodReference) parameterList.getContext();
+    }
+
     public static String trimQuote(String text) {
         return text.replaceAll("^\"|\"$|\'|\'$", "");
     }

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

@@ -16,6 +16,7 @@ public static String getRelativeProjectPath(@NotNull Project project, @NotNull V
         if(ApplicationManager.getApplication().isUnitTestMode()) {
             return virtualFile.getPath();
         }
+
         return VfsUtil.getRelativePath(virtualFile, project.getBaseDir());
     }
 }

tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/RenderParameterGotoCompletionRegistrarTest.java

@@ -0,0 +1,35 @@
+package fr.adrienbrault.idea.symfony2plugin.tests.templating;
+
+import com.intellij.openapi.vfs.VirtualFile;
+import com.jetbrains.php.lang.PhpFileType;
+import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
+
+import java.io.File;
+
+/**
+ * @author Daniel Espendiller <daniel@espendiller.net>
+ * @see fr.adrienbrault.idea.symfony2plugin.templating.RenderParameterGotoCompletionRegistrar
+ */
+public class RenderParameterGotoCompletionRegistrarTest extends SymfonyLightCodeInsightFixtureTestCase {
+    public void setUp() throws Exception {
+        super.setUp();
+
+        myFixture.copyFileToProject("ide-twig.json", "ide-twig.json");
+        VirtualFile virtualFile = myFixture.copyFileToProject("RenderParameterGotoCompletionRegistrar.html.twig", "res/foobar.html.twig");
+
+        System.out.println(virtualFile.getPath());
+        System.out.println(virtualFile);
+    }
+
+    public String getTestDataPath() {
+        return new File(this.getClass().getResource("fixtures").getFile()).getAbsolutePath();
+    }
+
+    public void testFoo() {
+        assertCompletionContains(
+            PhpFileType.INSTANCE,
+            "<?php foo('foobar.html.twig', ['<caret>']);",
+            "foobar"
+        );
+    }
+}

tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/fixtures/RenderParameterGotoCompletionRegistrar.html.twig

@@ -0,0 +1 @@
+{{ foobar }}

tests/fr/adrienbrault/idea/symfony2plugin/tests/templating/fixtures/ide-twig.json

@@ -0,0 +1,7 @@
+{
+  "namespaces": [
+    {
+      "path": "res"
+    }
+  ]
+}