Merge pull request #1100 from Haehnchen/feature/1048-form-data-class-set-default

[Form] Calling setDefault for data class does not associates form with binded class #1048

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/form/FormTypeReferenceContributor.java

@@ -18,6 +18,10 @@
 import fr.adrienbrault.idea.symfony2plugin.util.PsiElementUtils;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Objects;
+
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
  */
@@ -160,13 +164,27 @@ public PsiReference[] getReferencesByElement(@NotNull PsiElement psiElement, @No
                         return new PsiReference[0];
                     }
 
+                    Collection<String> classes = new ArrayList<>();
+
+                    // $resolver->setDefaults(['data_class' => User::class]);
                     PsiElement className = PhpElementsUtil.getArrayKeyValueInsideSignaturePsi(psiElement, FormOptionsUtil.FORM_OPTION_METHODS, "setDefaults", "data_class");
-                    if(className == null) {
-                        return new PsiReference[0];
+                    if(className != null) {
+                        String stringValue = PhpElementsUtil.getStringValue(className);
+                        if(stringValue != null) {
+                            classes.add(stringValue);
+                        }
                     }
 
-                    PhpClass phpClass = PhpElementsUtil.resolvePhpClassOnPsiElement(className);
-                    if (phpClass == null) {
+                    // $resolver->setDefault('data_class', User::class);
+                    classes.addAll(FormOptionsUtil.getMethodReferenceStringParameter(psiElement, FormOptionsUtil.FORM_OPTION_METHODS, "setDefault", "data_class"));
+
+                    // find first class
+                    PhpClass phpClass = classes.stream()
+                        .map(clazz -> PhpElementsUtil.getClassInterface(psiElement.getProject(), clazz))
+                        .filter(Objects::nonNull).findFirst()
+                        .orElse(null);
+
+                    if(phpClass == null) {
                         return new PsiReference[0];
                     }
 

src/fr/adrienbrault/idea/symfony2plugin/form/util/FormOptionsUtil.java

@@ -426,4 +426,49 @@ public static String getTranslationFromScope(@NotNull ArrayCreationExpression ar
 
         return translationDomain;
     }
+
+    /**
+     * Find methodReferences in scope by its name and method scope and give string value of matching parameter
+     *
+     * $resolver->setDefault('data_class', User::class);
+     */
+    @NotNull
+    public static Collection<String> getMethodReferenceStringParameter(@NotNull PsiElement scope, String[] scopeMethods, @NotNull String methodName, @NotNull String key) {
+        PhpClass phpClass = PsiTreeUtil.getParentOfType(scope, PhpClass.class);
+        if(phpClass == null) {
+            return Collections.emptyList();
+        }
+
+        Collection<String> values = new HashSet<>();
+
+        for (String scopeMethod : scopeMethods) {
+            Method method = phpClass.findMethodByName(scopeMethod);
+
+            if(method == null) {
+                continue;
+            }
+
+            for (MethodReference methodReference : PsiTreeUtil.collectElementsOfType(method, MethodReference.class)) {
+                if(!methodName.equals(methodReference.getName())) {
+                    continue;
+                }
+
+                // our key to find
+                String argument = PhpElementsUtil.getMethodReferenceStringValueParameter(methodReference, 0);
+                if(!key.equals(argument)) {
+                    continue;
+                }
+
+                // resolve value
+                String value = PhpElementsUtil.getMethodReferenceStringValueParameter(methodReference, 1);
+                if(StringUtils.isBlank(value)) {
+                    continue;
+                }
+
+                values.add(value);
+            }
+        }
+
+        return values;
+    }
 }

src/fr/adrienbrault/idea/symfony2plugin/util/PhpElementsUtil.java

@@ -537,34 +537,30 @@ static public String getArrayKeyValueInsideSignature(PsiElement psiElementInside
     }
 
     @Nullable
-    static public PsiElement getArrayKeyValueInsideSignaturePsi(Project project, String signature, String methodName, String keyName) {
-
+    static private PsiElement getArrayKeyValueInsideSignaturePsi(Project project, String signature, String methodName, String keyName) {
         PsiElement psiElement = PhpElementsUtil.getPsiElementsBySignatureSingle(project, signature);
+
         if(psiElement == null) {
             return null;
         }
 
         for(MethodReference methodReference: PsiTreeUtil.findChildrenOfType(psiElement, MethodReference.class)) {
-
             if(PhpElementsUtil.isEqualMethodReferenceName(methodReference, methodName)) {
                 PsiElement[] parameters = methodReference.getParameters();
                 if(parameters.length > 0 && parameters[0] instanceof ArrayCreationExpression) {
                     return PhpElementsUtil.getArrayValue((ArrayCreationExpression) parameters[0], keyName);
                 }
-
             }
         }
 
         return null;
     }
 
-
     public static Method[] getImplementedMethods(@NotNull Method method) {
         ArrayList<Method> items = getImplementedMethods(method.getContainingClass(), method, new ArrayList<>());
         return items.toArray(new Method[items.size()]);
     }
 
-
     private static ArrayList<Method> getImplementedMethods(@Nullable PhpClass phpClass, @NotNull Method method, ArrayList<Method> implementedMethods) {
         if (phpClass == null) {
             return implementedMethods;
@@ -1057,33 +1053,6 @@ public static String getMethodParameterTypeHint(@NotNull Method method) {
         return classReference.getFQN();
     }
 
-    /**
-     * "DateTime", DateTime::class
-     */
-    @Nullable
-    public static PhpClass resolvePhpClassOnPsiElement(@NotNull PsiElement psiElement) {
-
-        String dataClass = null;
-        if(psiElement instanceof ClassConstantReference) {
-            PsiElement lastChild = psiElement.getLastChild();
-            // @TODO: FOO::class find PhpElementTyp: toString provides "class"
-            if("class".equals(lastChild.getText())) {
-                PhpExpression classReference = ((ClassConstantReference) psiElement).getClassReference();
-                if(classReference instanceof PhpReference) {
-                    dataClass = ((PhpReference) classReference).getFQN();
-                }
-            }
-        } else {
-            dataClass = getStringValue(psiElement);
-        }
-
-        if(dataClass == null) {
-            return null;
-        }
-
-        return getClassInterface(psiElement.getProject(), dataClass);
-    }
-
     /**
      * Find first variable declaration in parent scope of a given variable:
      *
@@ -1473,18 +1442,37 @@ public static Method[] getMultiResolvedMethod(@NotNull PsiReference psiReference
         return new Method[0];
     }
 
+    /**
+     * Get first string value of MethodReference; Not index access allowed!
+     * see getMethodReferenceStringValueParameter for resolving value in detail
+     */
     @Nullable
-    public static String getFirstArgumentStringValue(@NotNull MethodReference e) {
+    public static String getFirstArgumentStringValue(@NotNull MethodReference methodReference) {
         String stringValue = null;
 
-        PsiElement[] parameters = e.getParameters();
+        PsiElement[] parameters = methodReference.getParameters();
         if (parameters.length > 0 && parameters[0] instanceof StringLiteralExpression) {
             stringValue = ((StringLiteralExpression) parameters[0]).getContents();
         }
 
         return stringValue;
     }
 
+    /**
+     * Get resolved string value
+     *
+     * $f->foo('index_0', 'index_1');
+     */
+    @Nullable
+    public static String getMethodReferenceStringValueParameter(@NotNull MethodReference methodReference, int parameter) {
+        PsiElement[] parameters = methodReference.getParameters();
+        if (parameters.length > parameter) {
+            return getStringValue(parameters[parameter]);
+        }
+
+        return null;
+    }
+
     /**
      * Visit and collect all variables in given scope
      */

tests/fr/adrienbrault/idea/symfony2plugin/tests/form/FormTypeReferenceContributorTest.java

@@ -94,6 +94,24 @@ public void testDataClassPropertyCompletion() {
         );
     }
 
+    public void testDataClassPropertyCompletionForSetDefault() {
+        assertCompletionContains(PhpFileType.INSTANCE, "<?php\n" +
+                "\n" +
+                "class FormType\n" +
+                "{\n" +
+                "    protected $foo = 'DateTime';\n" +
+                "    public function buildForm(\\Symfony\\Component\\Form\\FormBuilderInterface $builder, array $options) {\n" +
+                "        $builder->add('<caret>');\n" +
+                "    }\n" +
+                "    public function setDefaultOptions(OptionsResolverInterface $resolver)\n" +
+                "    {\n" +
+                "        $resolver->setDefault('data_class', \\Form\\DataClass\\Model::class);\n" +
+                "    }\n" +
+                "}",
+            "fooBar"
+        );
+    }
+
     public void testDataClassWithPublicPropertyCompletion() {
         assertCompletionContains(PhpFileType.INSTANCE, "<?php\n" +
                 "\n" +

tests/fr/adrienbrault/idea/symfony2plugin/tests/form/util/FormOptionsUtilTest.java

@@ -4,6 +4,7 @@
 import com.intellij.util.containers.ContainerUtil;
 import com.jetbrains.php.lang.PhpFileType;
 import com.jetbrains.php.lang.psi.PhpPsiElementFactory;
+import com.jetbrains.php.lang.psi.elements.MethodReference;
 import com.jetbrains.php.lang.psi.elements.StringLiteralExpression;
 import fr.adrienbrault.idea.symfony2plugin.form.dict.FormClass;
 import fr.adrienbrault.idea.symfony2plugin.form.dict.FormClassEnum;
@@ -109,4 +110,13 @@ public void testGetFormExtensionsKeysTargets() {
         Collection<PsiElement> formExtensionsKeysTargets = FormOptionsUtil.getFormExtensionsKeysTargets(contents, "Options\\Bar\\Foobar");
         assertTrue(formExtensionsKeysTargets.size() > 0);
     }
+
+
+    /**
+     * @see FormOptionsUtil#getMethodReferenceStringParameter
+     */
+    public void testGetMethodReferenceStringParameter() {
+        MethodReference methodReference = PhpPsiElementFactory.createFromText(getProject(), MethodReference.class, "<?php class Foobar { function foo() { $this->bar('test', 'my_value'); } };\n");
+        assertContainsElements(FormOptionsUtil.getMethodReferenceStringParameter(methodReference, new String[] {"foo"}, "bar", "test"), "my_value");
+    }
 }

tests/fr/adrienbrault/idea/symfony2plugin/tests/util/PhpElementsUtilTest.java

@@ -5,7 +5,6 @@
 import com.jetbrains.php.lang.PhpFileType;
 import com.jetbrains.php.lang.psi.PhpPsiElementFactory;
 import com.jetbrains.php.lang.psi.elements.ArrayCreationExpression;
-import com.jetbrains.php.lang.psi.elements.Method;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
 import com.jetbrains.php.lang.psi.elements.Variable;
 import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;