cleanup: provide testcases for resources resolving

Author: Haehnchen

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

@@ -10,7 +10,6 @@
 import com.intellij.psi.PsiDirectory;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiFile;
-import com.intellij.psi.PsiManager;
 import com.intellij.psi.search.GlobalSearchScope;
 import com.intellij.psi.util.CachedValueProvider;
 import com.intellij.psi.util.CachedValuesManager;
@@ -48,31 +47,6 @@ public class FileResourceUtil {
      */
     private static final String[] GLOB_DETECTION_CHARS = {"*", "?", "{", "["};
 
-    /**
-     * Search for files refers to given file
-     */
-    @NotNull
-    public static Collection<VirtualFile> getFileResourceRefers(@NotNull Project project, @NotNull VirtualFile virtualFile) {
-        String bundleLocateName = getBundleLocateName(project, virtualFile);
-        if(bundleLocateName == null) {
-            return Collections.emptyList();
-        }
-
-        return getFileResourceRefers(project, bundleLocateName);
-    }
-
-    /**
-     * Search for files refers to given file
-     */
-    @NotNull
-    private static Collection<VirtualFile> getFileResourceRefers(@NotNull Project project, @NotNull String bundleLocateName) {
-        return FileBasedIndex.getInstance().getContainingFiles(
-            FileResourcesIndex.KEY,
-            bundleLocateName,
-            GlobalSearchScope.allScope(project)
-        );
-    }
-
     /**
      * Search for files refers to given file
      */
@@ -217,43 +191,6 @@ public static Collection<Pair<VirtualFile, String>> getFileResources(@NotNull Pr
         return files;
     }
 
-    @Nullable
-    public static String getBundleLocateName(@NotNull Project project, @NotNull VirtualFile virtualFile) {
-        SymfonyBundle containingBundle = new SymfonyBundleUtil(project).getContainingBundle(virtualFile);
-        if(containingBundle == null) {
-            return null;
-        }
-
-        String relativePath = containingBundle.getRelativePath(virtualFile);
-        if(relativePath == null) {
-            return null;
-        }
-
-        return "@" + containingBundle.getName() + "/" + relativePath;
-    }
-
-    /**
-     * Search for line definition of "@FooBundle/foo.xml"
-     */
-    @NotNull
-    private static Collection<PsiElement> getBundleLocateStringDefinitions(@NotNull Project project, final @NotNull String bundleFileName) {
-        final Collection<PsiElement> psiElements = new HashSet<>();
-        for (VirtualFile refVirtualFile : getFileResourceRefers(project, bundleFileName)) {
-            PsiFile psiFile = PsiManager.getInstance(project).findFile(refVirtualFile);
-            if(psiFile == null) {
-                continue;
-            }
-
-            FileResourceVisitorUtil.visitFile(psiFile, consumer -> {
-                if (bundleFileName.equals(consumer.getResource())) {
-                    psiElements.add(consumer.getPsiElement());
-                }
-            });
-        }
-
-        return psiElements;
-    }
-
     @Nullable
     public static RelatedItemLineMarkerInfo<PsiElement> getFileImplementsLineMarker(@NotNull PsiFile psiFile) {
         final Project project = psiFile.getProject();
@@ -263,15 +200,6 @@ public static RelatedItemLineMarkerInfo<PsiElement> getFileImplementsLineMarker(
             return null;
         }
 
-        String bundleLocateName = FileResourceUtil.getBundleLocateName(project, virtualFile);
-        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);
-        }
-
         if (hasFileResources(project, psiFile)) {
             NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder.create(PhpIcons.IMPLEMENTS)
                 .setTargets(NotNullLazyValue.lazy(new FileResourceNotNullLazyValue(project, virtualFile)))
@@ -288,69 +216,22 @@ public static RelatedItemLineMarkerInfo<PsiElement> getFileImplementsLineMarker(
      */
     @Nullable
     public static RelatedItemLineMarkerInfo<PsiElement> getFileImplementsLineMarkerInFolderScope(@NotNull PsiFile psiFile) {
-        VirtualFile virtualFile = psiFile.getVirtualFile();
-        if(virtualFile == null) {
-            return null;
-        }
-
-        final Project project = psiFile.getProject();
-        String bundleLocateName = FileResourceUtil.getBundleLocateName(project, virtualFile);
-        if(bundleLocateName == null) {
+        if (!hasFileResources(psiFile.getProject(), psiFile)) {
             return null;
         }
 
-        Set<String> names = new HashSet<>();
-        names.add(bundleLocateName);
-
-        // strip filename
-        int i = bundleLocateName.lastIndexOf("/");
-        if(i > 0) {
-            names.add(bundleLocateName.substring(0, i));
-        }
-
-        int targets = 0;
-        for (String name : names) {
-            targets += FileResourceUtil.getFileResourceRefers(project, name).size();
-        }
-
-        if(targets == 0) {
+        VirtualFile virtualFile = psiFile.getVirtualFile();
+        if (virtualFile == null) {
             return null;
         }
 
         NavigationGutterIconBuilder<PsiElement> builder = NavigationGutterIconBuilder.create(PlatformIcons.ANNOTATION_TYPE_ICON)
-            .setTargets(NotNullLazyValue.lazy(new FileResourceBundleNotNullLazyValue(project, names)))
+            .setTargets(NotNullLazyValue.lazy(new FileResourceNotNullLazyValue(psiFile.getProject(), virtualFile)))
             .setTooltipText("Symfony: <a href=\"https://symfony.com/doc/current/routing.html#creating-routes-as-annotations\">Annotation Routing</a>");
 
         return builder.createLineMarkerInfo(psiFile);
     }
 
-    private static class FileResourceBundleNotNullLazyValue implements Supplier<Collection<? extends PsiElement>> {
-
-        private final Collection<String> resources;
-        private final Project project;
-
-        public FileResourceBundleNotNullLazyValue(@NotNull Project project, @NotNull Collection<String> resource) {
-            this.resources = resource;
-            this.project = project;
-        }
-
-        public FileResourceBundleNotNullLazyValue(@NotNull Project project, @NotNull String resource) {
-            this.resources = Collections.singleton(resource);
-            this.project = project;
-        }
-
-        @Override
-        public Collection<? extends PsiElement> get() {
-            Collection<PsiElement> psiElements = new HashSet<>();
-
-            for (String resource : this.resources) {
-                psiElements.addAll(getBundleLocateStringDefinitions(project, resource));
-            }
-
-            return psiElements;
-        }
-    }
-
     /**
      * Gives targets to files on Bundle locate syntax. "@FooBundle/.../foo.yml"
      */
@@ -474,7 +355,7 @@ private static class FileResourceNotNullLazyValue implements Supplier<Collection
         private final Project project;
         private final VirtualFile virtualFile;
 
-        public FileResourceNotNullLazyValue(Project project, VirtualFile virtualFile) {
+        public FileResourceNotNullLazyValue(@NotNull Project project, @NotNull VirtualFile virtualFile) {
             this.project = project;
             this.virtualFile = virtualFile;
         }

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

@@ -28,13 +28,6 @@ public String getTestDataPath() {
         return "src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/resource/fixtures";
     }
 
-    public void testGetFileResourceRefers() {
-        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();