html href tags of twig files provides completion for routes with custom insertHandler including parameter

Author: Haehnchen

META-INF/plugin.xml

@@ -443,6 +443,7 @@
 
  <completion.contributor language="XML" implementationClass="fr.adrienbrault.idea.symfony2plugin.config.xml.XmlCompletionContributor"/>
  <completion.contributor language="Twig" implementationClass="fr.adrienbrault.idea.symfony2plugin.templating.TwigTemplateCompletionContributor"/>
+ <completion.contributor language="HTML" implementationClass="fr.adrienbrault.idea.symfony2plugin.templating.completion.TwigHtmlCompletionContributor"/>
  <completion.contributor language="yaml" implementationClass="fr.adrienbrault.idea.symfony2plugin.config.yaml.YamlCompletionContributor"/>
 
  <annotator language="PHP" implementationClass="fr.adrienbrault.idea.symfony2plugin.templating.PhpTemplateAnnotator"/>

src/fr/adrienbrault/idea/symfony2plugin/routing/RouteLookupElement.java

@@ -1,17 +1,23 @@
 package fr.adrienbrault.idea.symfony2plugin.routing;
 
+import com.intellij.codeInsight.completion.InsertHandler;
+import com.intellij.codeInsight.completion.InsertionContext;
 import com.intellij.codeInsight.lookup.LookupElement;
 import com.intellij.codeInsight.lookup.LookupElementPresentation;
 import fr.adrienbrault.idea.symfony2plugin.Symfony2Icons;
+import fr.adrienbrault.idea.symfony2plugin.asset.dic.AssetEnum;
+import fr.adrienbrault.idea.symfony2plugin.util.dict.ResourceFileInsertHandler;
 import org.jetbrains.annotations.NotNull;
 
 /**
  * @author Adrien Brault <adrien.brault@gmail.com>
+ * @author Daniel Espendiller <daniel@espendiller.net>
  */
-public class RouteLookupElement  extends LookupElement {
+public class RouteLookupElement extends LookupElement {
 
  final private Route route;
  private boolean isWeak = false;
+ private InsertHandler<RouteLookupElement> insertHandler;
 
  public RouteLookupElement(Route route) {
  this.route = route;
@@ -35,4 +41,20 @@ public void renderElement(LookupElementPresentation presentation) {
  presentation.setIcon(!this.isWeak ? Symfony2Icons.ROUTE : Symfony2Icons.ROUTE_WEAK);
  }
 
+ @Override
+ public void handleInsert(InsertionContext context) {
+ if(insertHandler != null) {
+ insertHandler.handleInsert(context, this);
+ }
+ super.handleInsert(context);
+ }
+
+ public void withInsertHandler(InsertHandler<RouteLookupElement> insertHandler) {
+ this.insertHandler = insertHandler;
+ }
+
+ public Route getRoute() {
+ return route;
+ }
+
 }

src/fr/adrienbrault/idea/symfony2plugin/templating/completion/TwigHtmlCompletionContributor.java

@@ -0,0 +1,43 @@
+package fr.adrienbrault.idea.symfony2plugin.templating.completion;
+
+import com.intellij.codeInsight.completion.*;
+import com.intellij.codeInsight.lookup.LookupElement;
+import com.intellij.util.ProcessingContext;
+import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
+import fr.adrienbrault.idea.symfony2plugin.routing.RouteHelper;
+import fr.adrienbrault.idea.symfony2plugin.routing.RouteLookupElement;
+import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigHtmlCompletionUtil;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.List;
+
+public class TwigHtmlCompletionContributor extends CompletionContributor {
+
+ public TwigHtmlCompletionContributor() {
+
+ // add completion for href and provide twig insert handler
+ // <a href="#">#</a>
+ // <a href="{{ path('', {'foo' : 'bar'}) }}">#</a>
+ extend(CompletionType.BASIC, TwigHtmlCompletionUtil.getHrefAttributePattern(), new CompletionProvider<CompletionParameters>() {
+ @Override
+ protected void addCompletions(@NotNull CompletionParameters parameters, ProcessingContext processingContext, @NotNull CompletionResultSet resultSet) {
+
+ if(!Symfony2ProjectComponent.isEnabled(parameters.getPosition())) {
+ return;
+ }
+
+ List<LookupElement> routesLookupElements = RouteHelper.getRoutesLookupElements(parameters.getPosition().getProject());
+ for(LookupElement element: routesLookupElements) {
+ if(element instanceof RouteLookupElement) {
+ ((RouteLookupElement) element).withInsertHandler(TwigPathFunctionInsertHandler.getInstance());
+ }
+ }
+
+ resultSet.addAllElements(routesLookupElements);
+
+ }
+ });
+
+ }
+
+}

src/fr/adrienbrault/idea/symfony2plugin/templating/completion/TwigPathFunctionInsertHandler.java

@@ -0,0 +1,43 @@
+package fr.adrienbrault.idea.symfony2plugin.templating.completion;
+
+import com.intellij.codeInsight.completion.InsertHandler;
+import com.intellij.codeInsight.completion.InsertionContext;
+import com.jetbrains.php.completion.insert.PhpInsertHandlerUtil;
+import fr.adrienbrault.idea.symfony2plugin.routing.RouteLookupElement;
+import org.apache.commons.lang.StringUtils;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+
+public class TwigPathFunctionInsertHandler implements InsertHandler<RouteLookupElement> {
+
+ private static final TwigPathFunctionInsertHandler instance = new TwigPathFunctionInsertHandler();
+
+ public void handleInsert(@NotNull InsertionContext context, @NotNull RouteLookupElement lookupElement) {
+ context.getDocument().insertString(context.getStartOffset(), "{{ path('");
+
+ StringBuilder stringBuilder = new StringBuilder();
+ stringBuilder.append("'");
+
+ Set<String> vars = lookupElement.getRoute().getVariables();
+ if(vars.size() > 0) {
+ List<String> items = new ArrayList<String>();
+ for(String var: vars) {
+ items.add(String.format("'%s': '%s'", var, "x"));
+ }
+ stringBuilder.append(", {");
+ stringBuilder.append(StringUtils.join(items, ", "));
+ stringBuilder.append("}");
+ }
+
+ stringBuilder.append(") }}");
+ PhpInsertHandlerUtil.insertStringAtCaret(context.getEditor(), stringBuilder.toString());
+ }
+
+ public static TwigPathFunctionInsertHandler getInstance(){
+ return instance;
+ }
+
+}

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

@@ -0,0 +1,23 @@
+package fr.adrienbrault.idea.symfony2plugin.templating.util;
+
+import com.intellij.patterns.PlatformPatterns;
+import com.intellij.patterns.PsiElementPattern;
+import com.intellij.patterns.XmlPatterns;
+import com.intellij.psi.PsiElement;
+
+public class TwigHtmlCompletionUtil {
+
+ public static PsiElementPattern.Capture<PsiElement> getHrefAttributePattern() {
+ return PlatformPatterns.psiElement()
+ .withParent(
+ XmlPatterns.xmlAttributeValue()
+ .withParent(XmlPatterns.xmlAttribute("href")
+ )
+ ).inFile(XmlPatterns.psiFile()
+ .withName(XmlPatterns
+ .string().endsWith(".twig")
+ )
+ );
+ }
+
+}