Merge pull request #1514 from Haehnchen/feature/linemarker-resource

provide linemarker for yaml service resource

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlGoToDeclarationHandler.java

@@ -492,35 +492,42 @@ private Collection<PsiElement> getEventGoto(@NotNull PsiElement psiElement) {
      * services:
      *   My<caret>Class: ~
      */
-    private Collection<PsiElement> getClassesForServiceKey(@NotNull PsiElement psiElement) {
+    private static Collection<PsiElement> getClassesForServiceKey(@NotNull PsiElement psiElement) {
         PsiElement parent = psiElement.getParent();
         if(parent instanceof YAMLKeyValue) {
-            String valueText = ((YAMLKeyValue) parent).getKeyText();
-            if (StringUtils.isNotBlank(valueText)) {
-                Collection<PsiElement> targets = new HashSet<>();
-
-                // My<caret>Class\:
-                //   resource: '....'
-                //   exclude: '....'
-                if (valueText.endsWith("\\")) {
-                    String resource = YamlHelper.getYamlKeyValueAsString((YAMLKeyValue) parent, "resource");
-                    if (resource != null) {
-                        String exclude = YamlHelper.getYamlKeyValueAsString((YAMLKeyValue) parent, "exclude");
-                        targets.addAll(getPhpClassFromResources(psiElement.getProject(), valueText, psiElement.getContainingFile().getVirtualFile(), resource, exclude));
-                    }
-                }
+            return getClassesForServiceKey((YAMLKeyValue) parent);
+        }
+
+        return Collections.emptyList();
+    }
+
+    @NotNull
+    public static Collection<PsiElement> getClassesForServiceKey(@NotNull YAMLKeyValue yamlKeyValue) {
+        String valueText = yamlKeyValue.getKeyText();
+        if (StringUtils.isBlank(valueText)) {
+            return Collections.emptyList();
+        }
 
-                targets.addAll(PhpElementsUtil.getClassesInterface(psiElement.getProject(), valueText));
+        Collection<PsiElement> targets = new HashSet<>();
 
-                return targets;
+        // My<caret>Class\:
+        //   resource: '....'
+        //   exclude: '....'
+        if (valueText.endsWith("\\")) {
+            String resource = YamlHelper.getYamlKeyValueAsString(yamlKeyValue, "resource");
+            if (resource != null) {
+                String exclude = YamlHelper.getYamlKeyValueAsString(yamlKeyValue, "exclude");
+                targets.addAll(getPhpClassFromResources(yamlKeyValue.getProject(), valueText, yamlKeyValue.getContainingFile().getVirtualFile(), resource, exclude));
             }
         }
 
-        return Collections.emptyList();
+        targets.addAll(PhpElementsUtil.getClassesInterface(yamlKeyValue.getProject(), valueText));
+
+        return targets;
     }
 
     @NotNull
-    private Collection<PhpClass> getPhpClassFromResources(@NotNull Project project, @NotNull String namespace, @NotNull VirtualFile source, @NotNull String resource, @Nullable String exclude) {
+    private static Collection<PhpClass> getPhpClassFromResources(@NotNull Project project, @NotNull String namespace, @NotNull VirtualFile source, @NotNull String resource, @Nullable String exclude) {
         Collection<PhpClass> phpClasses = new HashSet<>();
 
         for (PhpClass phpClass : PhpIndexUtil.getPhpClassInsideNamespace(project, "\\" + StringUtils.strip(namespace, "\\"))) {

src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/linemarker/YamlLineMarkerProvider.java

@@ -3,9 +3,12 @@
 import com.intellij.codeInsight.daemon.LineMarkerInfo;
 import com.intellij.codeInsight.daemon.LineMarkerProvider;
 import com.intellij.codeInsight.navigation.NavigationGutterIconBuilder;
+import com.intellij.icons.AllIcons;
+import com.intellij.openapi.util.NotNullLazyValue;
 import com.intellij.psi.PsiElement;
 import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
 import fr.adrienbrault.idea.symfony2plugin.config.yaml.YamlElementPatternHelper;
+import fr.adrienbrault.idea.symfony2plugin.config.yaml.YamlGoToDeclarationHandler;
 import fr.adrienbrault.idea.symfony2plugin.util.dict.ServiceUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.yaml.YamlHelper;
 import org.apache.commons.lang.StringUtils;
@@ -52,7 +55,30 @@ public void collectSlowLineMarkers(@NotNull List<PsiElement> psiElements, @NotNu
 
             // services -> service_name
             visitServiceId(psiElement, (YAMLKeyValue) yamlKeyValue, result, lazyDecoratedServices);
+
+            // services:
+            //    App\:
+            //        resource: '../src/*'
+            visitServiceIdForResources(psiElement, (YAMLKeyValue) yamlKeyValue, result);
+        }
+    }
+
+    private void visitServiceIdForResources(PsiElement leafTarget, YAMLKeyValue yamlKeyValue, @NotNull Collection<LineMarkerInfo> result) {
+        String resource = YamlHelper.getYamlKeyValueAsString(yamlKeyValue, "resource");
+        if (resource == null) {
+            return;
         }
+
+        result.add(NavigationGutterIconBuilder.create(AllIcons.Modules.SourceRoot)
+            .setTargets(new NotNullLazyValue<Collection<? extends PsiElement>>() {
+                @NotNull
+                @Override
+                protected Collection<? extends PsiElement> compute() {
+                    return YamlGoToDeclarationHandler.getClassesForServiceKey(yamlKeyValue);
+                }
+            })
+            .setTooltipText("Navigate to class")
+            .createLineMarkerInfo(leafTarget));
     }
 
     private void visitServiceId(@NotNull PsiElement leafTarget, @NotNull YAMLKeyValue yamlKeyValue, @NotNull Collection<LineMarkerInfo> result, @NotNull LazyDecoratedParentServiceValues lazyDecoratedServices) {
@@ -63,13 +89,13 @@ private void visitServiceId(@NotNull PsiElement leafTarget, @NotNull YAMLKeyValu
 
         // decorates: foobar
         String decorates = YamlHelper.getYamlKeyValueAsString(yamlKeyValue, "decorates");
-        if(decorates != null && StringUtils.isNotBlank(decorates)) {
+        if(StringUtils.isNotBlank(decorates)) {
             result.add(ServiceUtil.getLineMarkerForDecoratesServiceId(leafTarget, ServiceUtil.ServiceLineMarker.DECORATE, decorates));
         }
 
         // parent: foobar
         String parent = YamlHelper.getYamlKeyValueAsString(yamlKeyValue, "parent");
-        if(parent != null && StringUtils.isNotBlank(parent)) {
+        if(StringUtils.isNotBlank(parent)) {
             result.add(ServiceUtil.getLineMarkerForDecoratesServiceId(leafTarget, ServiceUtil.ServiceLineMarker.PARENT, parent));
         }
 

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/linemarker/YamlLineMarkerProviderTest.java

@@ -64,6 +64,15 @@ public void testThatParentProvidesOverwriteMarker() {
         );
     }
 
+    public void testThatServiceResourceIsHavingLinemarker() {
+        assertLineMarker(createYamlFile("" +
+                "services:\n" +
+                "    App\\Controller\\:\n" +
+                "        resource: '../src/Controller'\n"),
+            new LineMarker.ToolTipEqualsAssert("Navigate to class")
+        );
+    }
+
     @NotNull
     private PsiElement createYamlFile(@NotNull String content) {
         return PsiFileFactory.getInstance(getProject()).createFileFromText("DUMMY__." + YAMLFileType.YML.getDefaultExtension(), YAMLFileType.YML, content);