Merge pull request #1414 from Haehnchen/feature/token-deprecated

provide deprecated inspection for Twig token tags on PhpClass

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/inspection/TwigExtensionDeprecatedInspection.java

@@ -0,0 +1,92 @@
+package fr.adrienbrault.idea.symfony2plugin.templating.inspection;
+
+import com.intellij.codeInspection.LocalInspectionTool;
+import com.intellij.codeInspection.ProblemHighlightType;
+import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiElementVisitor;
+import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment;
+import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag;
+import com.jetbrains.php.lang.psi.elements.PhpClass;
+import com.jetbrains.twig.TwigTokenTypes;
+import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
+import fr.adrienbrault.idea.symfony2plugin.templating.util.TwigUtil;
+import org.apache.commons.lang.StringUtils;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * {% ta<caret>g %}
+ *
+ * @author Daniel Espendiller <[email protected]>
+ */
+public class TwigExtensionDeprecatedInspection extends LocalInspectionTool {
+
+    @NotNull
+    public PsiElementVisitor buildVisitor(final @NotNull ProblemsHolder holder, boolean isOnTheFly) {
+        if (!Symfony2ProjectComponent.isEnabled(holder.getProject())) {
+            return super.buildVisitor(holder, isOnTheFly);
+        }
+
+        return new PsiElementVisitor() {
+            @Override
+            public void visitElement(PsiElement element) {
+                // {% tag %}
+                if (element.getNode().getElementType() == TwigTokenTypes.TAG_NAME) {
+                    visitTagTokenName(element);
+                }
+
+                super.visitElement(element);
+            }
+
+            private void visitTagTokenName(PsiElement element) {
+                String tagName = element.getText();
+                if (StringUtils.isNotBlank(tagName)) {
+                    // prevent adding multiple "deprecated" message, as we have alias classes
+                    final boolean[] hasDeprecated = {false};
+
+                    TwigUtil.visitTokenParsers(holder.getProject(), triple -> {
+                        if (hasDeprecated[0]) {
+                            return;
+                        }
+
+                        String currentTagName = triple.getFirst();
+                        if(tagName.equalsIgnoreCase(currentTagName) || (tagName.toLowerCase().startsWith("end") && currentTagName.equalsIgnoreCase(tagName.substring(3)))) {
+                            PhpClass phpClass = triple.getThird().getContainingClass();
+                            if (phpClass != null && phpClass.isDeprecated()) {
+                                String classDeprecatedMessage = getClassDeprecatedMessage(phpClass);
+
+                                String message = classDeprecatedMessage != null
+                                    ? classDeprecatedMessage
+                                    : "Deprecated Tag usage";
+
+                                hasDeprecated[0] = true;
+
+                                // "Deprecated" highlight is not visible, so we are going here for weak warning
+                                // WEAK_WARNING would be match; but not really visible
+                                holder.registerProblem(element.getParent(), message, ProblemHighlightType.GENERIC_ERROR_OR_WARNING);
+                            }
+                        }
+                    });
+                }
+            }
+
+            @Nullable
+            private String getClassDeprecatedMessage(@NotNull PhpClass phpClass) {
+                if (phpClass.isDeprecated()) {
+                    PhpDocComment docComment = phpClass.getDocComment();
+                    if (docComment != null) {
+                        for (PhpDocTag deprecatedTag : docComment.getTagElementsByName("@deprecated")) {
+                            String tagValue = deprecatedTag.getTagValue();
+                            if (StringUtils.isNotBlank(tagValue)) {
+                                return StringUtils.abbreviate("Deprecated: " + tagValue, 100);
+                            }
+                        }
+                    }
+                }
+
+                return null;
+            }
+        };
+    }
+}

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

@@ -61,6 +61,7 @@
 import fr.adrienbrault.idea.symfony2plugin.util.service.ServiceXmlParserFactory;
 import fr.adrienbrault.idea.symfony2plugin.util.yaml.YamlHelper;
 import icons.TwigIcons;
+import kotlin.Triple;
 import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -2515,7 +2516,7 @@ public static DomainScope getTwigFileDomainScope(@NotNull PsiElement psiElement)
      * Visit Twig TokenParser
      * eg. {% my_token %}
      */
-    public static void visitTokenParsers(@NotNull Project project, @NotNull Consumer<Pair<String, PsiElement>> consumer) {
+    public static void visitTokenParsers(@NotNull Project project, @NotNull Consumer<Triple<String, PsiElement, Method>> consumer) {
         Set<PhpClass> allSubclasses = new HashSet<>();
 
         PhpIndex phpIndex = PhpIndex.getInstance(project);
@@ -2542,7 +2543,7 @@ public static void visitTokenParsers(@NotNull Project project, @NotNull Consumer
                 if(returnValue instanceof StringLiteralExpression) {
                     String contents = ((StringLiteralExpression) returnValue).getContents();
                     if(StringUtils.isNotBlank(contents)) {
-                        consumer.consume(Pair.create(contents, returnValue));
+                        consumer.consume(new Triple<>(contents, returnValue, getTag));
                     }
                 }
             }

src/main/resources/META-INF/plugin.xml

@@ -339,6 +339,12 @@
                          language="Twig"
                          implementationClass="fr.adrienbrault.idea.symfony2plugin.templating.inspection.TwigVariableDeprecatedInspection"/>
 
+        <localInspection groupPath="Symfony" shortName="TwigExtensionDeprecatedInspection" displayName="Deprecated Twig Extension"
+                         groupName="Twig"
+                         enabledByDefault="true" level="WARNING"
+                         language="Twig"
+                         implementationClass="fr.adrienbrault.idea.symfony2plugin.templating.inspection.TwigExtensionDeprecatedInspection"/>
+
         <localInspection groupPath="Symfony" shortName="YamlQuotedEscapedInspection" displayName="Quoted issues"
                          groupName="Yaml"
                          enabledByDefault="true" level="WARNING"

src/main/resources/inspectionDescriptions/TwigExtensionDeprecatedInspection.html

@@ -0,0 +1,7 @@
+<html>
+<body>
+<p>Detect Twig token tags which are marked as deprecated via PhpClass</p>
+<!-- tooltip end -->
+<p>Deprecation inspection for Twig token tags</p>
+</body>
+</html>

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/inspection/TwigExtensionDeprecatedInspectionTest.java

@@ -0,0 +1,32 @@
+package fr.adrienbrault.idea.symfony2plugin.tests.templating.inspection;
+
+import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
+
+/**
+ * @author Daniel Espendiller <[email protected]>
+ * @see fr.adrienbrault.idea.symfony2plugin.templating.inspection.TwigExtensionDeprecatedInspection
+ */
+public class TwigExtensionDeprecatedInspectionTest extends SymfonyLightCodeInsightFixtureTestCase {
+    public void setUp() throws Exception {
+        super.setUp();
+        myFixture.copyFileToProject("TwigExtensionDeprecatedInspection.php");
+    }
+
+    public String getTestDataPath() {
+        return "src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/inspection/fixtures";
+    }
+
+    public void testThatDeprecatedTwigTokenProvidesDeprecatedMessageFromPhpClass() {
+        assertLocalInspectionContains(
+            "test.html.twig",
+                "{% spac<caret>eless % }",
+            "Deprecated: Foobar deprecated message"
+        );
+
+        assertLocalInspectionContains(
+            "test.html.twig",
+            "{% endspac<caret>eless % }",
+            "Deprecated: Foobar deprecated message"
+        );
+    }
+}

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/templating/inspection/fixtures/TwigExtensionDeprecatedInspection.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Twig\TokenParser {
+    interface TokenParserInterface {}
+
+    /**
+     * @deprecated Foobar deprecated message
+     */
+    class SpacelessTokenParser implements TokenParserInterface
+    {
+        public function getTag()
+        {
+            return 'spaceless';
+        }
+    }
+}