Merge pull request #1946 from Haehnchen/feature/resources-testcases

provide testcases for resources resolving

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/util/resource/FileResourceUtil.java

@@ -19,7 +19,10 @@
 import com.jetbrains.php.PhpIcons;
 import fr.adrienbrault.idea.symfony2plugin.stubs.cache.FileIndexCaches;
 import fr.adrienbrault.idea.symfony2plugin.stubs.indexes.FileResourcesIndex;
-import fr.adrienbrault.idea.symfony2plugin.util.*;
+import fr.adrienbrault.idea.symfony2plugin.util.FileResourceVisitorUtil;
+import fr.adrienbrault.idea.symfony2plugin.util.PhpIndexUtil;
+import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
+import fr.adrienbrault.idea.symfony2plugin.util.SymfonyBundleUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.dict.SymfonyBundle;
 import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
@@ -181,25 +184,20 @@ public static RelatedItemLineMarkerInfo<PsiElement> getFileImplementsLineMarker(
         }
 
         String bundleLocateName = FileResourceUtil.getBundleLocateName(project, virtualFile);
-        if(bundleLocateName != null) {
-            if(FileResourceUtil.getFileResourceRefers(project, bundleLocateName).size() == 0) {
-                return null;
-            }
-
+        if(bundleLocateName != null && FileResourceUtil.getFileResourceRefers(project, bundleLocateName).size() > 0) {
             NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder.create(PhpIcons.IMPLEMENTS)
                 .setTargets(NotNullLazyValue.lazy(new FileResourceBundleNotNullLazyValue(project, bundleLocateName)))
                 .setTooltipText("Navigate to resource");
 
             return builder.createLineMarkerInfo(psiFile);
-        } else {
-            if (hasFileResources(project, psiFile)) {
-                NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder.create(PhpIcons.IMPLEMENTS);
-                builder.setTargets(NotNullLazyValue.lazy(new FileResourceNotNullLazyValue(project, virtualFile)));
+        }
 
-                builder.setTooltipText("Navigate to resource");
+        if (hasFileResources(project, psiFile)) {
+            NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder.create(PhpIcons.IMPLEMENTS)
+                .setTargets(NotNullLazyValue.lazy(new FileResourceNotNullLazyValue(project, virtualFile)))
+                .setTooltipText("Navigate to resource");
 
-                return builder.createLineMarkerInfo(psiFile);
-            }
+            return builder.createLineMarkerInfo(psiFile);
         }
 
         return null;

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/resource/FileResourceUtilTest.java

@@ -1,13 +1,17 @@
 package fr.adrienbrault.idea.symfony2plugin.tests.util.resource;
 
 import com.intellij.openapi.util.Pair;
+import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiFile;
 import com.intellij.util.containers.ContainerUtil;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
+import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
 import fr.adrienbrault.idea.symfony2plugin.util.resource.FileResourceUtil;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Collection;
+
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
  *
@@ -17,26 +21,22 @@ public class FileResourceUtilTest extends SymfonyLightCodeInsightFixtureTestCase
 
     public void setUp() throws Exception {
         super.setUp();
-
-        myFixture.copyFileToProject("classes.php");
-        myFixture.configureByText("target.xml", "" +
-                "<routes>\n" +
-                "    <import resource=\"@FooBundle/foo.xml\" />\n" +
-                "</routes>"
-        );
     }
 
     public String getTestDataPath() {
         return "src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/resource/fixtures";
     }
 
     public void testGetFileResourceRefers() {
-        PsiFile psiFile = myFixture.configureByText("foo.xml", "foo");
+        createBundleScopeProject();
 
+        PsiFile psiFile = myFixture.configureByText("foo.xml", "foo");
         assertNotNull(ContainerUtil.find(FileResourceUtil.getFileResourceRefers(getProject(), psiFile.getVirtualFile()), virtualFile -> virtualFile.getName().equals("target.xml")));
     }
 
     public void testGetFileResourceTargetsInBundleDirectory() {
+        createBundleScopeProject();
+
         for (String s : new String[]{"@FooBundle/Controller", "@FooBundle\\Controller", "@FooBundle/Controller/", "@FooBundle//Controller", "@FooBundle\\Controller\\"}) {
             assertNotNull(ContainerUtil.find(FileResourceUtil.getFileResourceTargetsInBundleDirectory(getProject(), s), psiElement ->
                 psiElement instanceof PhpClass && "\\FooBundle\\Controller\\FooController".equals(((PhpClass) psiElement).getFQN())
@@ -65,4 +65,37 @@ public void testGetGlobalPatternDirectory() {
         assertEquals("src/", globalPatternDirectory.getFirst());
         assertNull(globalPatternDirectory.getSecond());
     }
+
+    public void testFileResources() {
+        VirtualFile services = myFixture.copyFileToProject("services.xml", "config/services.xml");
+        VirtualFile virtualFile = myFixture.copyFileToProject("classes.php", "src/Test.php");
+
+        assertTrue(FileResourceUtil.hasFileResources(getProject(), PsiElementUtils.virtualFileToPsiFile(getProject(), virtualFile)));
+
+        Collection<Pair<VirtualFile, String>> fileResources = FileResourceUtil.getFileResources(getProject(), virtualFile);
+        assertTrue(fileResources.stream().anyMatch(pair -> pair.getFirst().getPath().equals(services.getPath())));
+    }
+
+    public void testGetFileImplementsLineMarker() {
+        myFixture.copyFileToProject("services.xml", "config/services.xml");
+        VirtualFile virtualFile = myFixture.copyFileToProject("classes.php", "src/Test.php");
+        assertNotNull(FileResourceUtil.getFileImplementsLineMarker(PsiElementUtils.virtualFileToPsiFile(getProject(), virtualFile)));
+    }
+
+    public void testGetFileImplementsLineMarkerForBundle() {
+        createBundleScopeProject();
+
+        myFixture.copyFileToProject("services.xml", "config/services.xml");
+        VirtualFile virtualFile = myFixture.copyFileToProject("classes.php", "src/Test.php");
+        assertNotNull(FileResourceUtil.getFileImplementsLineMarker(PsiElementUtils.virtualFileToPsiFile(getProject(), virtualFile)));
+    }
+
+    private void createBundleScopeProject() {
+        myFixture.copyFileToProject("classes.php");
+        myFixture.configureByText("target.xml", "" +
+            "<routes>\n" +
+            "    <import resource=\"@FooBundle/foo.xml\" />\n" +
+            "</routes>"
+        );
+    }
 }

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/resource/fixtures/services.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<routes xmlns="http://symfony.com/schema/routing"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://symfony.com/schema/routing
+        https://symfony.com/schema/routing/routing-1.0.xsd">
+
+    <import resource="../src/Test.php" type="annotation"/>
+    <import resource="../src/*Controller.php" type="annotation"/>
+</routes>