Merge pull request #1904 from Haehnchen/feature/1366-twig-extensions

#1366 mark TwigExtension classes as used code, if any implementation exists

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/codeInsight/SymfonyImplicitUsageProvider.java

@@ -13,13 +13,17 @@
 import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Arrays;
 import java.util.Collection;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
  */
 public class SymfonyImplicitUsageProvider implements ImplicitUsageProvider {
-    private static final String[] ROUTE_ANNOTATIONS = new String[]{
+    private static final String[] ROUTE_ANNOTATIONS = new String[] {
         "\\Symfony\\Component\\Routing\\Annotation\\Route",
         "\\Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Route"
     };
@@ -33,7 +37,32 @@ public boolean isImplicitUsage(@NotNull PsiElement element) {
             return isRouteClass((PhpClass) element)
                 || isCommandAndService((PhpClass) element)
                 || isSubscribedEvent((PhpClass) element)
-                || isVoter((PhpClass) element);
+                || isVoter((PhpClass) element)
+                || isTwigExtension((PhpClass) element);
+        }
+
+        return false;
+    }
+
+    private boolean isTwigExtension(PhpClass phpClass) {
+        if ((PhpElementsUtil.isInstanceOf(phpClass, "\\Twig\\Extension\\ExtensionInterface") || PhpElementsUtil.isInstanceOf(phpClass,"\\Twig_ExtensionInterface")) && ServiceUtil.isPhpClassAService(phpClass)) {
+            Set<String> methods = new HashSet<>();
+
+            Collection<PhpClass> phpClasses = new HashSet<>() {{
+                addAll(PhpElementsUtil.getClassesInterface(phpClass.getProject(), "\\Twig\\Extension\\ExtensionInterface"));
+                addAll(PhpElementsUtil.getClassesInterface(phpClass.getProject(), "\\Twig_ExtensionInterface"));
+            }};
+
+            for (PhpClass aClass : phpClasses) {
+                methods.addAll(aClass.getMethods()
+                    .stream()
+                    .filter(method -> !method.isStatic() && method.getAccess() == PhpModifier.Access.PUBLIC).map(PhpNamedElement::getName)
+                    .collect(Collectors.toSet())
+                );
+            }
+
+            return Arrays.stream(phpClass.getOwnMethods())
+                .anyMatch(ownMethod -> ownMethod.getAccess() == PhpModifier.Access.PUBLIC && methods.contains(ownMethod.getName()));
         }
 
         return false;

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/codeInsight/SymfonyImplicitUsageProviderTest.java

@@ -191,6 +191,34 @@ public void testEventSubscriberGetSubscribedEventsArray() {
         assertTrue(new SymfonyImplicitUsageProvider().isImplicitUsage(phpClass));
     }
 
+    public void testTwigExtensionRegisteredAsServiceWithFunctionMethodImplementedIsMarkedUsed() {
+        PsiFile psiFile = myFixture.configureByText(PhpFileType.INSTANCE, "<?php\n" +
+            "\n" +
+            "namespace App\\TwigExtension;\n" +
+            "\n" +
+            "class MyTwigExtension implements \\Twig\\Extension\\ExtensionInterface\n" +
+            "{\n" +
+            "    public function getFilters() {}\n" +
+            "}"
+        );
+
+        PhpClass firstClassFromFile = PhpElementsUtil.getFirstClassFromFile((PhpFile) psiFile.getContainingFile());
+        assertTrue(new SymfonyImplicitUsageProvider().isImplicitUsage(firstClassFromFile));
+
+        PsiFile psiFile2 = myFixture.configureByText(PhpFileType.INSTANCE, "<?php\n" +
+            "\n" +
+            "namespace App\\TwigExtension;\n" +
+            "\n" +
+            "class MyTwigExtension implements \\Twig\\Extension\\ExtensionInterface\n" +
+            "{\n" +
+            "    public function getFoobar() {}\n" +
+            "}"
+        );
+
+        PhpClass firstClassFromFile2 = PhpElementsUtil.getFirstClassFromFile((PhpFile) psiFile2.getContainingFile());
+        assertFalse(new SymfonyImplicitUsageProvider().isImplicitUsage(firstClassFromFile2));
+    }
+
     private PhpClass createPhpControllerClassWithRouteContent(@NotNull String content) {
         return createPhpControllerClassWithRouteContent("\\App\\Controller\\FooController", content);
     }

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/codeInsight/fixtures/classes.php

@@ -29,4 +29,13 @@ interface VoterInterface
     {
         public function vote(TokenInterface $token, $subject, array $attributes);
     }
+}
+
+namespace Twig\Extension
+{
+    interface ExtensionInterface
+    {
+        public function getFilters();
+        public function getFunctions();
+    }
 }

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/codeInsight/fixtures/services.yml

@@ -9,4 +9,7 @@ services:
     class: App\Command\FooCommand
 
   foo_command.my_foobar_voter:
-    class: App\Voter\MyFoobarVoter
+    class: App\Voter\MyFoobarVoter
+
+  foo_command.twig_extension:
+    class: App\TwigExtension\MyTwigExtension