service argument inspection must respect _default configuration #948

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/action/ServiceActionUtil.java

@@ -24,6 +24,7 @@
 import fr.adrienbrault.idea.symfony2plugin.action.ui.SymfonyCreateService;
 import fr.adrienbrault.idea.symfony2plugin.dic.ContainerService;
 import fr.adrienbrault.idea.symfony2plugin.dic.container.util.ServiceContainerUtil;
+import fr.adrienbrault.idea.symfony2plugin.intentions.yaml.YamlServiceArgumentInspection;
 import fr.adrienbrault.idea.symfony2plugin.stubs.ContainerCollectionResolver;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.SymfonyBundleUtil;
@@ -48,9 +49,13 @@ public class ServiceActionUtil {
     /**
      * Attributes which we should not support in missing arguments constructors for server definition
      */
-    public static final String[] INVALID_ARGUMENT_ATTRIBUTES = new String[]{
-        "parent", "factory-class", "factory-service", "abstract", "autowire"
-    };
+    public static final String[] INVALID_ARGUMENT_ATTRIBUTES = getInvalidArgumentAttributes();
+
+    private static String[] getInvalidArgumentAttributes() {
+        return Arrays.stream(YamlServiceArgumentInspection.INVALID_KEYS)
+            .map(s -> s.replace("_", "-"))
+            .toArray(String[]::new);
+    }
 
     public static void buildFile(AnActionEvent event, final Project project, String templatePath) {
         String extension = templatePath.endsWith(".yml") ? "yml" : "xml" ;
@@ -382,8 +387,19 @@ public static boolean isValidXmlParameterInspectionService(@NotNull XmlTag xmlTa
 
         // <service><factory/></service>
         // symfony2 >= 2.6
-        for (XmlTag tag : xmlTag.getSubTags()) {
-            if("factory".equals(tag.getName())) {
+        if(xmlTag.findSubTags("factory").length > 0) {
+            return false;
+        }
+
+        // <services><defaults/></services>
+        PsiElement parent = xmlTag.getParent();
+        if(!(parent instanceof XmlTag) || !"services".equals(((XmlTag) parent).getName())) {
+            return true;
+        }
+
+        // <defaults autowire="true" />
+        for (XmlTag defaults : ((XmlTag) parent).findSubTags("defaults")) {
+            if("true".equalsIgnoreCase(defaults.getAttributeValue("autowire"))) {
                 return false;
             }
         }

src/fr/adrienbrault/idea/symfony2plugin/intentions/yaml/YamlServiceArgumentInspection.java

@@ -14,6 +14,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.yaml.psi.YAMLFile;
 import org.jetbrains.yaml.psi.YAMLKeyValue;
+import org.jetbrains.yaml.psi.YAMLMapping;
 
 import java.util.List;
 import java.util.Set;
@@ -23,7 +24,11 @@
  */
 public class YamlServiceArgumentInspection extends LocalInspectionTool {
 
-    public static final String[] INVALID_KEYS = new String[]{"parent", "factory_class", "factory_service", "factory_method", "abstract", "factory", "autowire"};
+    public static final String[] INVALID_KEYS = new String[]{
+        "parent", "factory_class", "factory_service",
+        "factory_method", "abstract", "factory",
+        "autowire", "resource", "exclude"
+    };
 
     @NotNull
     public PsiElementVisitor buildVisitor(final @NotNull ProblemsHolder holder, boolean isOnTheFly) {
@@ -68,8 +73,9 @@ public void visitFile(PsiFile file) {
         }
 
         private boolean isValidService(ServiceActionUtil.ServiceYamlContainer serviceYamlContainer) {
+            YAMLKeyValue serviceKey = serviceYamlContainer.getServiceKey();
 
-            Set<String> keySet = YamlHelper.getKeySet(serviceYamlContainer.getServiceKey());
+            Set<String> keySet = YamlHelper.getKeySet(serviceKey);
             if(keySet == null) {
                 return true;
             }
@@ -80,6 +86,19 @@ private boolean isValidService(ServiceActionUtil.ServiceYamlContainer serviceYam
                 }
             }
 
+            // find file scope defaults
+            // defaults: [autowire: true]
+            YAMLMapping key = serviceKey.getParentMapping();
+            if(key != null) {
+                YAMLKeyValue defaults = YamlHelper.getYamlKeyValue(key, "_defaults");
+                if(defaults != null) {
+                    Boolean autowire = YamlHelper.getYamlKeyValueAsBoolean(defaults, "autowire");
+                    if(autowire != null && autowire) {
+                        return false;
+                    }
+                }
+            }
+
             return true;
         }
 

tests/fr/adrienbrault/idea/symfony2plugin/tests/config/xml/inspection/XmlServiceArgumentInspectionTest.java

@@ -61,6 +61,22 @@ public void testThatNotSupportServiceAttributeNotProvidesInspection() {
         }
     }
 
+    public void testThatServiceResourceMustNotProvideInspection() {
+        assertLocalInspectionNotContains(
+            "services.xml",
+            createContainer("<serv<caret>ice resource=\"foo\" class=\"Foo\\Bar\"/>"),
+            "Missing argument"
+        );
+    }
+
+    public void testThatServiceFactoryServiceMustNotProvideInspection() {
+        assertLocalInspectionNotContains(
+            "services.xml",
+            createContainer("<serv<caret>ice factory-service=\"foo\" class=\"Foo\\Bar\"/>"),
+            "Missing argument"
+        );
+    }
+
     public void testThatFactoryServiceOfSymfony26NotProvidesInspection() {
         for (String s : ServiceActionUtil.INVALID_ARGUMENT_ATTRIBUTES) {
             assertLocalInspectionNotContains(
@@ -71,6 +87,20 @@ public void testThatFactoryServiceOfSymfony26NotProvidesInspection() {
         }
     }
 
+    public void testThatDefaultValueMustNotProvideInspection() {
+        assertLocalInspectionNotContains(
+            "services.xml",
+            createContainer("<defaults autowire=\"true\" /><serv<caret>ice class=\"Foo\\Bar\"/>"),
+            "Missing argument"
+        );
+
+        assertLocalInspectionContains(
+            "services.xml",
+            createContainer("<defaults autowire=\"false\" /><serv<caret>ice class=\"Foo\\Bar\"/>"),
+            "Missing argument"
+        );
+    }
+
     private String createContainer(String serviceDefinition) {
         return "<container><services>" + serviceDefinition + "</services></container>";
     }

tests/fr/adrienbrault/idea/symfony2plugin/tests/config/yaml/YamlServiceArgumentInspectionTest.java

@@ -56,4 +56,25 @@ public void testThatNotSupportServiceAttributeNotProvidesInspection() {
         }
     }
 
+    public void testThatDefaultsWithAutoWireMustStopInspection() {
+        assertLocalInspectionNotContains("services.yml", "" +
+                "services:\n" +
+                "  _defaults:\n" +
+                "    autowire: true\n" +
+                "" +
+                "  f<caret>oo:\n" +
+                "    class: \\Foo\\Bar\n",
+            "Missing argument"
+        );
+
+        assertLocalInspectionContains("services.yml", "" +
+                "services:\n" +
+                "  _defaults:\n" +
+                "    autowire: false\n" +
+                "" +
+                "  f<caret>oo:\n" +
+                "    class: \\Foo\\Bar\n",
+            "Missing argument"
+        );
+    }
 }