Merge pull request #1515 from Haehnchen/feature/annotation-constraint-message

support constraint message navigation and completion in annotations

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/translation/annotation/ConstraintMessageAnnotationReferences.java

@@ -0,0 +1,58 @@
+package fr.adrienbrault.idea.symfony2plugin.translation.annotation;
+
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiReference;
+import com.jetbrains.php.lang.psi.elements.StringLiteralExpression;
+import de.espend.idea.php.annotation.extension.PhpAnnotationCompletionProvider;
+import de.espend.idea.php.annotation.extension.PhpAnnotationReferenceProvider;
+import de.espend.idea.php.annotation.extension.parameter.AnnotationCompletionProviderParameter;
+import de.espend.idea.php.annotation.extension.parameter.AnnotationPropertyParameter;
+import de.espend.idea.php.annotation.extension.parameter.PhpAnnotationReferenceProviderParameter;
+import fr.adrienbrault.idea.symfony2plugin.Symfony2ProjectComponent;
+import fr.adrienbrault.idea.symfony2plugin.translation.TranslationReference;
+import fr.adrienbrault.idea.symfony2plugin.translation.dict.TranslationUtil;
+import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Support "@FooConstraint(message="sss")"
+ *
+ * @author Daniel Espendiller <[email protected]>
+ */
+public class ConstraintMessageAnnotationReferences implements PhpAnnotationReferenceProvider, PhpAnnotationCompletionProvider {
+    @Nullable
+    @Override
+    public PsiReference[] getPropertyReferences(AnnotationPropertyParameter parameter, PhpAnnotationReferenceProviderParameter phpAnnotationReferenceProviderParameter) {
+        if (!Symfony2ProjectComponent.isEnabled(parameter.getProject()) || !PhpElementsUtil.isInstanceOf(parameter.getPhpClass(), "\\Symfony\\Component\\Validator\\Constraint")) {
+            return new PsiReference[0];
+        }
+
+        String propertyName = parameter.getPropertyName();
+        if (propertyName == null || !propertyName.startsWith("message")) {
+            return new PsiReference[0];
+        }
+
+        PsiElement element = parameter.getElement();
+        if (!(element instanceof StringLiteralExpression)) {
+            return new PsiReference[0];
+        }
+
+        return new PsiReference[] { new TranslationReference((StringLiteralExpression) element, "validators")};
+    }
+
+    @Override
+    public void getPropertyValueCompletions(AnnotationPropertyParameter parameter, AnnotationCompletionProviderParameter annotationCompletionProviderParameter) {
+        if (!Symfony2ProjectComponent.isEnabled(parameter.getProject()) || !PhpElementsUtil.isInstanceOf(parameter.getPhpClass(), "\\Symfony\\Component\\Validator\\Constraint")) {
+            return;
+        }
+
+        String propertyName = parameter.getPropertyName();
+        if (propertyName == null || !propertyName.startsWith("message")) {
+            return;
+        }
+
+        annotationCompletionProviderParameter
+            .getResult()
+            .addAllElements(TranslationUtil.getTranslationLookupElementsOnDomain(parameter.getProject(), "validators"));
+    }
+}

src/main/resources/META-INF/plugin.xml

@@ -634,6 +634,10 @@
 
         <!-- @IsGranted -->
         <PhpAnnotationReferenceProvider implementation="fr.adrienbrault.idea.symfony2plugin.security.IsGrantedAnnotationReferences"/>
+
+        <!-- @FooConstraint(message="sss") -->
+        <PhpAnnotationReferenceProvider implementation="fr.adrienbrault.idea.symfony2plugin.translation.annotation.ConstraintMessageAnnotationReferences"/>
+        <PhpAnnotationCompletionProvider implementation="fr.adrienbrault.idea.symfony2plugin.translation.annotation.ConstraintMessageAnnotationReferences"/>
     </extensions>
 
     <extensions defaultExtensionNs="de.espend.idea.php.toolbox.extension">

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/translation/annotation/ConstraintMessageAnnotationReferencesTest.java

@@ -0,0 +1,77 @@
+package fr.adrienbrault.idea.symfony2plugin.tests.translation.annotation;
+
+import com.intellij.patterns.PlatformPatterns;
+import com.jetbrains.php.lang.PhpFileType;
+import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
+import fr.adrienbrault.idea.symfony2plugin.translation.annotation.ConstraintMessageAnnotationReferences;
+
+/**
+ * @author Daniel Espendiller <[email protected]>
+ * @see ConstraintMessageAnnotationReferences
+ */
+public class ConstraintMessageAnnotationReferencesTest extends SymfonyLightCodeInsightFixtureTestCase {
+
+    public void setUp() throws Exception {
+        super.setUp();
+
+        myFixture.copyFileToProject("classes.php");
+        myFixture.copyFileToProject("validators.de.yml", "Resources/translations/validators.de.yml");
+    }
+
+    public String getTestDataPath() {
+        return "src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/translation/annotation/fixtures";
+    }
+
+    public void testThatCompletionIsGivenForConstraintMessageInAnnotation() {
+        assertCompletionContains(PhpFileType.INSTANCE, "<?php\n" +
+            "\n" +
+            "use Symfony\\Component\\Validator\\Constraints as Assert;\n" +
+            "\n" +
+            "/**\n" +
+            " * @Assert\\Email(message=\"symfony<caret>\")\n" +
+            " */\n" +
+            "class Foo\n" +
+            "{\n" +
+            "}",
+            "symfony_great"
+        );
+
+        assertCompletionContains(PhpFileType.INSTANCE, "<?php\n" +
+                "\n" +
+                "use Symfony\\Component\\Validator\\Constraints as Assert;\n" +
+                "\n" +
+                "/**\n" +
+                " * @Assert\\Email(messages=\"symfony<caret>\")\n" +
+                " */\n" +
+                "class Foo\n" +
+                "{\n" +
+                "}",
+            "symfony_great"
+        );
+    }
+
+    public void testThatNavigationIsGivenForConstraintMessageInAnnotation() {
+        assertReferenceMatchOnParent(PhpFileType.INSTANCE, "<?php\n" +
+                "\n" +
+                "use Symfony\\Component\\Validator\\Constraints as Assert;\n" +
+                "\n" +
+                "/**\n" +
+                " * @Assert\\Email(message=\"symfony<caret>_great\")\n" +
+                " */\n" +
+                "class Foo {}\n",
+            PlatformPatterns.psiElement()
+        );
+
+        assertReferenceMatchOnParent(PhpFileType.INSTANCE, "<?php\n" +
+                "\n" +
+                "use Symfony\\Component\\Validator\\Constraints as Assert;\n" +
+                "\n" +
+                "/**\n" +
+                " * @Assert\\Email(messages=\"symfony<caret>_great\")\n" +
+                " */\n" +
+                "class Foo {}\n",
+            PlatformPatterns.psiElement()
+        );
+    }
+}
+

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/translation/annotation/fixtures/classes.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Symfony\Component\Validator
+{
+    abstract class Constraint
+    {
+        public function __construct($options = null)
+        {
+        }
+    }
+}
+
+namespace Symfony\Component\Validator\Constraints
+{
+    use Symfony\Component\Validator\Constraint;
+
+    class Email extends Constraint
+    {
+        public $message = 'This value is not a valid email address.';
+    }
+}

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/translation/annotation/fixtures/validators.de.yml

@@ -0,0 +1 @@
+symfony_great: 'YAML Symfony2 is really great'