Merge pull request #1558 from Haehnchen/feature/resources-array

Haehnchen · web-flow · commit 564bdfa34f56 · 2020-12-05T09:55:06.000+01:00
support arrays for "resource" and "exclude" on autowrite which is use on Symfony &gt;= 5 as default instead of global pattern
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlGoToDeclarationHandler.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/config/yaml/YamlGoToDeclarationHandler.java
@@ -514,9 +514,9 @@ public static Collection<PsiElement> getClassesForServiceKey(@NotNull YAMLKeyVal
         //   resource: '....'
         //   exclude: '....'
         if (valueText.endsWith("\\")) {
-            String resource = YamlHelper.getYamlKeyValueAsString(yamlKeyValue, "resource");
-            if (resource != null) {
-                String exclude = YamlHelper.getYamlKeyValueAsString(yamlKeyValue, "exclude");
+            Collection<String> resource = YamlHelper.getYamlKeyValueStringOrArray(yamlKeyValue, "resource");
+            if (!resource.isEmpty()) {
+                Collection<String> exclude = YamlHelper.getYamlKeyValueStringOrArray(yamlKeyValue, "exclude");
                 targets.addAll(getPhpClassFromResources(yamlKeyValue.getProject(), valueText, yamlKeyValue.getContainingFile().getVirtualFile(), resource, exclude));
             }
         }
@@ -527,7 +527,7 @@ public static Collection<PsiElement> getClassesForServiceKey(@NotNull YAMLKeyVal
     }
 
     @NotNull
-    private static 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 Collection<String> resource, @NotNull Collection<String> exclude) {
         Collection<PhpClass> phpClasses = new HashSet<>();
 
         for (PhpClass phpClass : PhpIndexUtil.getPhpClassInsideNamespace(project, "\\" + StringUtils.strip(namespace, "\\"))) {
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/attribute/value/AttributeValueAbstract.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/attribute/value/AttributeValueAbstract.java
@@ -59,4 +59,10 @@ public String getString(@NotNull String key, @Nullable String defaultValue) {
     public PsiElement getPsiElement() {
         return this.psiElement;
     }
+
+    @NotNull
+    @Override
+    public Collection<String> getStringArray(@NotNull String key) {
+        return Collections.emptyList();
+    }
 }
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/attribute/value/AttributeValueInterface.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/attribute/value/AttributeValueInterface.java
@@ -14,6 +14,9 @@ public interface AttributeValueInterface {
     @Nullable
     String getString(@NotNull String key);
 
+    @NotNull
+    Collection<String> getStringArray(@NotNull String key);
+
     @Nullable
     Boolean getBoolean(@NotNull String key);
 
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/attribute/value/DummyAttributeValue.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/attribute/value/DummyAttributeValue.java
@@ -25,6 +25,12 @@ public String getString(@NotNull String key) {
         return null;
     }
 
+    @NotNull
+    @Override
+    public Collection<String> getStringArray(@NotNull String key) {
+        return Collections.emptySet();
+    }
+
     @Nullable
     @Override
     public Boolean getBoolean(@NotNull String key) {
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/attribute/value/XmlTagAttributeValue.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/attribute/value/XmlTagAttributeValue.java
@@ -7,6 +7,7 @@
 
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.stream.Collectors;
 
 /**
@@ -21,6 +22,16 @@ public XmlTagAttributeValue(@NotNull XmlTag xmlTag) {
         this.xmlTag = xmlTag;
     }
 
+    @NotNull
+    @Override
+    public Collection<String> getStringArray(@NotNull String key) {
+        String string = getString(key);
+
+        return string != null
+            ? Collections.singleton(string)
+            : Collections.emptyList();
+    }
+
     @Nullable
     @Override
     public String getString(@NotNull String key) {
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/attribute/value/YamlKeyValueAttributeValue.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/attribute/value/YamlKeyValueAttributeValue.java
@@ -37,4 +37,10 @@ public String getString(@NotNull String key) {
     public Collection<String> getTags() {
         return YamlHelper.collectServiceTags(yamlKeyValue);
     }
+
+    @NotNull
+    @Override
+    public Collection<String> getStringArray(@NotNull String key) {
+        return YamlHelper.getYamlKeyValueStringOrArray(yamlKeyValue, key);
+    }
 }
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/container/ImmutableDecoratorService.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/container/ImmutableDecoratorService.java
@@ -79,15 +79,15 @@ public String getDecorationInnerName() {
         return service.getDecorationInnerName();
     }
 
-    @Nullable
+    @NotNull
     @Override
-    public String getResource() {
+    public Collection<String> getResource() {
         return service.getResource();
     }
 
-    @Nullable
+    @NotNull
     @Override
-    public String getExclude() {
+    public Collection<String> getExclude() {
         return service.getExclude();
     }
 
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/container/SerializableService.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/container/SerializableService.java
@@ -56,13 +56,13 @@ public class SerializableService implements ServiceSerializable {
     @Nullable
     private String parent;
 
-    @Nullable
+    @NotNull
     @SerializedName("resource")
-    private String resource;
+    private Collection<String> resource = new HashSet<>();
 
-    @Nullable
+    @NotNull
     @SerializedName("exclude")
-    private String exclude;
+    private Collection<String> exclude = new HashSet<>();
 
     @NotNull
     @SerializedName("tags")
@@ -183,15 +183,15 @@ public SerializableService setDecorationInnerName(@Nullable String decorationInn
         return this;
     }
 
-    @Nullable
+    @NotNull
     @Override
-    public String getResource() {
+    public Collection<String> getResource() {
         return this.resource;
     }
 
-    @Nullable
+    @NotNull
     @Override
-    public String getExclude() {
+    public Collection<String> getExclude() {
         return this.exclude;
     }
 
@@ -206,12 +206,12 @@ public SerializableService setTags(@NotNull Collection<String> tags) {
         return this;
     }
 
-    public SerializableService setResource(@Nullable String resource) {
+    public SerializableService setResource(@NotNull Collection<String> resource) {
         this.resource = resource;
         return this;
     }
 
-    public SerializableService setExclude(@Nullable String exclude) {
+    public SerializableService setExclude(@NotNull Collection<String> exclude) {
         this.exclude = exclude;
         return this;
     }
@@ -231,8 +231,8 @@ public int hashCode() {
             .append(this.decorates)
             .append(this.decorationInnerName)
             .append(this.parent)
-            .append(this.resource)
-            .append(this.exclude)
+            .append(new HashSet<>(this.resource))
+            .append(new HashSet<>(this.exclude))
             .append(new HashSet<>(this.tags))
             .toHashCode()
         ;
@@ -244,7 +244,6 @@ public boolean equals(Object obj) {
             Objects.equals(((SerializableService) obj).id, this.id) &&
             Objects.equals(((SerializableService) obj).className, this.className) &&
             Objects.equals(((SerializableService) obj).isPublic, this.isPublic) &&
-            Objects.equals(((SerializableService) obj).isDeprecated, this.isDeprecated) &&
             Objects.equals(((SerializableService) obj).isLazy, this.isLazy) &&
             Objects.equals(((SerializableService) obj).isAbstract, this.isAbstract) &&
             Objects.equals(((SerializableService) obj).isAutowire, this.isAutowire) &&
@@ -253,8 +252,8 @@ public boolean equals(Object obj) {
             Objects.equals(((SerializableService) obj).decorates, this.decorates) &&
             Objects.equals(((SerializableService) obj).decorationInnerName, this.decorationInnerName) &&
             Objects.equals(((SerializableService) obj).parent, this.parent) &&
-            Objects.equals(((SerializableService) obj).resource, this.resource) &&
-            Objects.equals(((SerializableService) obj).exclude, this.exclude) &&
+            Objects.equals(new HashSet<>(((SerializableService) obj).resource), new HashSet<>(this.resource)) &&
+            Objects.equals(new HashSet<>(((SerializableService) obj).exclude), new HashSet<>(this.exclude)) &&
             Objects.equals(new HashSet<>(((SerializableService) obj).tags), new HashSet<>(this.tags))
         ;
     }
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/container/ServiceInterface.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/container/ServiceInterface.java
@@ -38,11 +38,11 @@ public interface ServiceInterface {
     @Nullable
     String getDecorationInnerName();
 
-    @Nullable
-    String getResource();
+    @NotNull
+    Collection<String> getResource();
 
-    @Nullable
-    String getExclude();
+    @NotNull
+    Collection<String> getExclude();
 
     @NotNull
     Collection<String> getTags();
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/container/XmlService.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/container/XmlService.java
@@ -7,6 +7,7 @@
 import org.w3c.dom.NodeList;
 
 import java.util.Collection;
+import java.util.Collections;
 import java.util.HashSet;
 
 /**
@@ -94,16 +95,16 @@ public String getDecorationInnerName() {
         return null;
     }
 
-    @Nullable
+    @NotNull
     @Override
-    public String getResource() {
-        return null;
+    public Collection<String> getResource() {
+        return Collections.emptyList();
     }
 
-    @Nullable
+    @NotNull
     @Override
-    public String getExclude() {
-        return null;
+    public Collection<String> getExclude() {
+        return Collections.emptyList();
     }
 
     @NotNull
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/container/util/ServiceContainerUtil.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/dic/container/util/ServiceContainerUtil.java
@@ -183,8 +183,8 @@ private static SerializableService createService(@NotNull ServiceConsumer servic
             .setIsAutowire(attributes.getBoolean("autowire", serviceConsumer.getDefaults().isAutowire()))
             .setIsLazy(attributes.getBoolean("lazy"))
             .setIsPublic(attributes.getBoolean("public", serviceConsumer.getDefaults().isPublic()))
-            .setResource(attributes.getString("resource"))
-            .setExclude(attributes.getString("exclude"))
+            .setResource(attributes.getStringArray("resource"))
+            .setExclude(attributes.getStringArray("exclude"))
             .setTags(attributes.getTags());
     }
 
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/stubs/ServiceIndexUtil.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/stubs/ServiceIndexUtil.java
@@ -168,43 +168,54 @@ public static ClassServiceDefinitionTargetLazyValue findServiceDefinitionsLazy(@
      * "..src/Foo/{Foo,Foobar.php}"
      *
      */
-    public static boolean matchesResourcesGlob(@NotNull VirtualFile serviceFileAsBase, @NotNull VirtualFile phpClassFile, @NotNull String resource, @Nullable String exclude) {
-        String replace = resource.replace("\\\\", "/");
-
-        VirtualFile serviceFile = serviceFileAsBase.getParent();
-        String[] split = replace.split("/");
-        String[] replacePathParts = split;
-        for (String s : split) {
-            if (s.equals("..")) {
-                replacePathParts = Arrays.copyOfRange(replacePathParts, 1, replacePathParts.length);
-                serviceFile = serviceFile.getParent();
-            } else {
-                break;
+    public static boolean matchesResourcesGlob(@NotNull VirtualFile serviceFileAsBase, @NotNull VirtualFile phpClassFile, @NotNull Collection<String> resources, @NotNull Collection<String> excludes) {
+        for (String resource : resources) {
+            String replace = resource.replace("\\\\", "/");
+
+            VirtualFile serviceFile = serviceFileAsBase.getParent();
+            String[] split = replace.split("/");
+            String[] replacePathParts = split;
+            for (String s : split) {
+                if (s.equals("..")) {
+                    replacePathParts = Arrays.copyOfRange(replacePathParts, 1, replacePathParts.length);
+                    serviceFile = serviceFile.getParent();
+                } else {
+                    break;
+                }
             }
-        }
 
-        if (serviceFile == null) {
-            return false;
-        }
+            if (serviceFile == null) {
+                return false;
+            }
 
-        // ending one wildcard must be *
-        // "src/*" => "src/**"
-        String path = (serviceFile.getPath() + "/" + StringUtils.join(replacePathParts, "/"))
-            .replaceAll("[^*]([*])$", "**");
+            // ending one wildcard must be *
+            // "src/*" => "src/**"
+            String path = (serviceFile.getPath() + "/" + StringUtils.join(replacePathParts, "/"))
+                .replaceAll("[^*]([*])$", "**");
 
-        // force "**" at the end
-        if (!path.endsWith("*")) {
-            path += "**";
-        }
+            // force "**" at the end
+            if (!path.endsWith("*")) {
+                path += "**";
+            }
 
-        String phpClassPath = phpClassFile.getPath();
+            String phpClassPath = phpClassFile.getPath();
 
-        if (exclude == null) {
-            return isMatchingGlobResource(path, phpClassPath);
+            boolean matchingGlobResource = isMatchingGlobResource(path, phpClassPath);
+            if (!matchingGlobResource) {
+                continue;
+            }
+
+            // direct match; skip it
+            if (excludes.isEmpty()) {
+                return true;
+            }
+
+            if (!matchesResourcesGlob(serviceFileAsBase, phpClassFile, excludes, Collections.emptyList())) {
+                return true;
+            }
         }
 
-        return isMatchingGlobResource(path, phpClassPath)
-            && !matchesResourcesGlob(serviceFileAsBase, phpClassFile, exclude, null);
+        return false;
     }
 
     @Nullable
@@ -244,8 +255,8 @@ public static Pair<ClassServiceDefinitionTargetLazyValue, Collection<ContainerSe
                 continue;
             }
 
-            String resource = service.getResource();
-            if (resource == null) {
+            Collection<String> resources = service.getResource();
+            if (resources.isEmpty()) {
                 continue;
             }
 
@@ -261,7 +272,7 @@ public static Pair<ClassServiceDefinitionTargetLazyValue, Collection<ContainerSe
                     continue;
                 }
 
-                if (matchesResourcesGlob(virtualFile, phpClassFile, resource, service.getExclude())) {
+                if (matchesResourcesGlob(virtualFile, phpClassFile, resources, service.getExclude())) {
                     namespaceServices.add(containerService);
                     namespaceTargets.add(s);
                 }
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/stubs/indexes/ServicesDefinitionStubIndex.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/stubs/indexes/ServicesDefinitionStubIndex.java
@@ -85,7 +85,7 @@ public boolean dependsOnFileContent() {
 
     @Override
     public int getVersion() {
-        return 6;
+        return 7;
     }
 
     public static boolean isValidForIndex(FileContent inputData, PsiFile psiFile) {
diff --git a/src/main/java/fr/adrienbrault/idea/symfony2plugin/util/yaml/YamlHelper.java b/src/main/java/fr/adrienbrault/idea/symfony2plugin/util/yaml/YamlHelper.java
@@ -351,6 +351,33 @@ public static String getYamlKeyValueAsString(@NotNull YAMLKeyValue yamlKeyValue,
         return getYamlKeyValueAsString(yamlKeyValue, keyName, false);
     }
 
+    /**
+     *  foo:
+     *     class: "name"
+     *
+     *  class:
+     *   - "name"
+     *   - "test"
+     */
+    @NotNull
+    public static Collection<String> getYamlKeyValueStringOrArray(@NotNull YAMLKeyValue yamlKeyValue, @NotNull String keyName) {
+        YAMLKeyValue childrenKeyValue = getYamlKeyValue(yamlKeyValue, keyName);
+        if (childrenKeyValue == null) {
+            return Collections.emptyList();
+        }
+
+        // class: [test]
+        // class:
+        //  - "test"
+        YAMLValue value = childrenKeyValue.getValue();
+        if(value instanceof YAMLSequence) {
+          return getYamlArrayValuesAsString((YAMLSequence) value);
+        }
+
+        // class: "test"
+        return Collections.singletonList(getYamlKeyValueAsString(yamlKeyValue, keyName));
+    }
+
     @Nullable
     public static String getYamlKeyValueAsString(@NotNull YAMLKeyValue yamlKeyValue, @NotNull String keyName, boolean ignoreCase) {
 
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/container/util/ServiceContainerUtilTest.java b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/container/util/ServiceContainerUtilTest.java
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/container/util/fixtures/services5.yml b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/dic/container/util/fixtures/services5.yml
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/stubs/indexes/ServicesDefinitionStubIndexTest.java b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/stubs/indexes/ServicesDefinitionStubIndexTest.java
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/dict/ServiceUtilTempProjectTest.java b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/dict/ServiceUtilTempProjectTest.java
diff --git a/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/yaml/YamlHelperLightTest.java b/src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/util/yaml/YamlHelperLightTest.java

Original file line number	Diff line number	Diff line change
`@@ -514,9 +514,9 @@ public static Collection<PsiElement> getClassesForServiceKey(@NotNull YAMLKeyVal`
`514`	`514`	`// resource: '....'`
`515`	`515`	`// exclude: '....'`
`516`	`516`	`if (valueText.endsWith("\\")) {`
`517`		`- String resource = YamlHelper.getYamlKeyValueAsString(yamlKeyValue, "resource");`
`518`		`- if (resource != null) {`
`519`		`- String exclude = YamlHelper.getYamlKeyValueAsString(yamlKeyValue, "exclude");`
	`517`	`+ Collection<String> resource = YamlHelper.getYamlKeyValueStringOrArray(yamlKeyValue, "resource");`
	`518`	`+ if (!resource.isEmpty()) {`
	`519`	`+ Collection<String> exclude = YamlHelper.getYamlKeyValueStringOrArray(yamlKeyValue, "exclude");`
`520`	`520`	`targets.addAll(getPhpClassFromResources(yamlKeyValue.getProject(), valueText, yamlKeyValue.getContainingFile().getVirtualFile(), resource, exclude));`
`521`	`521`	`}`
`522`	`522`	`}`
`@@ -527,7 +527,7 @@ public static Collection<PsiElement> getClassesForServiceKey(@NotNull YAMLKeyVal`
`527`	`527`	`}`
`528`	`528`
`529`	`529`	`@NotNull`
`530`		`- private static Collection<PhpClass> getPhpClassFromResources(@NotNull Project project, @NotNull String namespace, @NotNull VirtualFile source, @NotNull String resource, @Nullable String exclude) {`
	`530`	`+ private static Collection<PhpClass> getPhpClassFromResources(@NotNull Project project, @NotNull String namespace, @NotNull VirtualFile source, @NotNull Collection<String> resource, @NotNull Collection<String> exclude) {`
`531`	`531`	`Collection<PhpClass> phpClasses = new HashSet<>();`
`532`	`532`
`533`	`533`	`for (PhpClass phpClass : PhpIndexUtil.getPhpClassInsideNamespace(project, "\\" + StringUtils.strip(namespace, "\\"))) {`
Original file line number	Diff line number	Diff line change
`@@ -59,4 +59,10 @@ public String getString(@NotNull String key, @Nullable String defaultValue) {`
`59`	`59`	`public PsiElement getPsiElement() {`
`60`	`60`	`return this.psiElement;`
`61`	`61`	`}`
	`62`	`+`
	`63`	`+ @NotNull`
	`64`	`+ @Override`
	`65`	`+ public Collection<String> getStringArray(@NotNull String key) {`
	`66`	`+ return Collections.emptyList();`
	`67`	`+ }`
`62`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,4 +37,10 @@ public String getString(@NotNull String key) {`
`37`	`37`	`public Collection<String> getTags() {`
`38`	`38`	`return YamlHelper.collectServiceTags(yamlKeyValue);`
`39`	`39`	`}`
	`40`	`+`
	`41`	`+ @NotNull`
	`42`	`+ @Override`
	`43`	`+ public Collection<String> getStringArray(@NotNull String key) {`
	`44`	`+ return YamlHelper.getYamlKeyValueStringOrArray(yamlKeyValue, key);`
	`45`	`+ }`
`40`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,15 +79,15 @@ public String getDecorationInnerName() {`
`79`	`79`	`return service.getDecorationInnerName();`
`80`	`80`	`}`
`81`	`81`
`82`		`- @Nullable`
	`82`	`+ @NotNull`
`83`	`83`	`@Override`
`84`		`- public String getResource() {`
	`84`	`+ public Collection<String> getResource() {`
`85`	`85`	`return service.getResource();`
`86`	`86`	`}`
`87`	`87`
`88`		`- @Nullable`
	`88`	`+ @NotNull`
`89`	`89`	`@Override`
`90`		`- public String getExclude() {`
	`90`	`+ public Collection<String> getExclude() {`
`91`	`91`	`return service.getExclude();`
`92`	`92`	`}`
`93`	`93`