add doctrine metadata support for target-entity and target-document #319

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/doctrine/metadata/DoctrineMetadataPattern.java

@@ -3,12 +3,16 @@
 import com.intellij.patterns.PlatformPatterns;
 import com.intellij.patterns.XmlAttributeValuePattern;
 import com.intellij.patterns.XmlPatterns;
+import org.intellij.lang.annotations.RegExp;
 
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
  */
 public class DoctrineMetadataPattern {
 
+    @RegExp
+    private static final String DOCTRINE_MAPPING = "doctrine-[\\w+-]*-*mapping";
+
     /**
      * <doctrine-mapping|doctrine-*-mapping>
      *   <entity name="Class\Name"/>
@@ -26,7 +30,7 @@ public static XmlAttributeValuePattern getXmlModelClass() {
                 .withParent(XmlPatterns
                     .xmlTag().withName(PlatformPatterns.string().oneOf("document", "entity"))
                     .withParent(XmlPatterns
-                        .xmlTag().withName(PlatformPatterns.string().matches("doctrine-[\\w+-]*-*mapping"))
+                        .xmlTag().withName(PlatformPatterns.string().matches(DOCTRINE_MAPPING))
                     )
                 )
             );
@@ -46,7 +50,47 @@ public static XmlAttributeValuePattern getXmlRepositoryClass() {
                 .withParent(XmlPatterns
                     .xmlTag().withName(PlatformPatterns.string().oneOf("document", "entity"))
                     .withParent(XmlPatterns
-                        .xmlTag().withName(PlatformPatterns.string().matches("doctrine-[\\w+-]*-*mapping"))
+                        .xmlTag().withName(PlatformPatterns.string().matches(DOCTRINE_MAPPING))
+                    )
+                )
+            );
+    }
+
+    /**
+     * <reference-one target-document="Foo"/>
+     * <reference-many target-document="Foo"/>
+     * <embed-many target-document="Foo"/>
+     * <embed-one target-document="Foo"/>
+     */
+    public static XmlAttributeValuePattern getXmlTargetDocumentClass() {
+        return XmlPatterns
+            .xmlAttributeValue()
+            .withParent(XmlPatterns
+                .xmlAttribute("target-document")
+                .withParent(XmlPatterns
+                    .xmlTag().withName(PlatformPatterns.string().oneOf("reference-one", "reference-many", "embed-many", "embed-one"))
+                    .withParent(XmlPatterns
+                        .xmlTag().withName(PlatformPatterns.string().matches(DOCTRINE_MAPPING))
+                    )
+                )
+            );
+    }
+
+    /**
+     * <one-to-one target-entity="Foo">
+     * <one-to-many target-entity="Foo">
+     * <many-to-one target-entity="Foo">
+     * <many-to-many target-entity="Foo">
+     */
+    public static XmlAttributeValuePattern getXmlTargetEntityClass() {
+        return XmlPatterns
+            .xmlAttributeValue()
+            .withParent(XmlPatterns
+                .xmlAttribute("target-entity")
+                .withParent(XmlPatterns
+                    .xmlTag().withName(PlatformPatterns.string().oneOf("one-to-one", "one-to-many", "many-to-one", "many-to-many"))
+                    .withParent(XmlPatterns
+                         .xmlTag().withName(PlatformPatterns.string().matches(DOCTRINE_MAPPING))
                     )
                 )
             );

src/fr/adrienbrault/idea/symfony2plugin/doctrine/metadata/DoctrineXmlGotoCompletionRegistrar.java

@@ -29,7 +29,9 @@ public void register(GotoCompletionRegistrarParameter registrar) {
 
         registrar.register(XmlPatterns.psiElement().withParent(PlatformPatterns.or(
             DoctrineMetadataPattern.getXmlModelClass(),
-            DoctrineMetadataPattern.getXmlRepositoryClass()
+            DoctrineMetadataPattern.getXmlRepositoryClass(),
+            DoctrineMetadataPattern.getXmlTargetDocumentClass(),
+            DoctrineMetadataPattern.getXmlTargetEntityClass()
         )), new GotoCompletionContributor() {
             @Nullable
             @Override

tests/fr/adrienbrault/idea/symfony2plugin/tests/doctrine/metadata/DoctrineXmlGotoCompletionRegistrarTest.java

@@ -3,6 +3,7 @@
 import com.intellij.ide.highlighter.XmlFileType;
 import com.intellij.patterns.PlatformPatterns;
 import com.jetbrains.php.lang.psi.elements.PhpClass;
+import fr.adrienbrault.idea.symfony2plugin.doctrine.metadata.DoctrineMetadataPattern;
 import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
 
 import java.io.File;
@@ -65,4 +66,42 @@ public void testDocumentRepositoryClassNavigation() {
             PlatformPatterns.psiElement(PhpClass.class)
         );
     }
+
+    /**
+     * @see DoctrineMetadataPattern#getXmlTargetDocumentClass()
+     */
+    public void testTargetDocumentNavigation() {
+        for(String s : new String[] {"reference-one", "reference-many", "embed-many", "embed-one"}) {
+            assertNavigationMatch(
+                XmlFileType.INSTANCE,
+                "<doctrine-mapping><" + s + " target-document=\"Foo\\Bar\\Ns<caret>\\BarRepo\"/></doctrine-mapping>",
+                PlatformPatterns.psiElement(PhpClass.class)
+            );
+
+            assertNavigationMatch(
+                XmlFileType.INSTANCE,
+                "<doctrine-foo-mapping><" + s + " target-document=\"Foo\\Bar\\Ns<caret>\\BarRepo\"/></doctrine-foo-mapping>",
+                PlatformPatterns.psiElement(PhpClass.class)
+            );
+        }
+    }
+
+    /**
+     * @see DoctrineMetadataPattern#getXmlTargetEntityClass()
+     */
+    public void testTargetEntityNavigation() {
+        for(String s : new String[] {"one-to-one", "one-to-many", "many-to-one", "many-to-many"}) {
+            assertNavigationMatch(
+                XmlFileType.INSTANCE,
+                "<doctrine-mapping><" + s + " target-entity=\"Foo\\Bar\\Ns<caret>\\BarRepo\"/></doctrine-mapping>",
+                PlatformPatterns.psiElement(PhpClass.class)
+            );
+
+            assertNavigationMatch(
+                XmlFileType.INSTANCE,
+                "<doctrine-foo-mapping><" + s + " target-entity=\"Foo\\Bar\\Ns<caret>\\BarRepo\"/></doctrine-mapping>",
+                PlatformPatterns.psiElement(PhpClass.class)
+            );
+        }
+    }
 }