Merge pull request #57 from symfony-cmf/issue-56

Allow parent class mapping

Author: dantleech

AutoRoute/Factory.php

@@ -121,8 +121,7 @@ public function getContentNameBuilderUnit($classFqn)
      */
     public function hasMapping($classFqn)
     {
-        // @todo: Do we need to support inheritance?
-        return isset($this->mapping[$classFqn]);
+        return null !== $this->getMapping($classFqn, false);
     }
 
     /**
@@ -164,15 +163,21 @@ protected function generateBuilderUnit($config)
         return $builderUnit;
     }
 
-    protected function getMapping($classFqn)
+    protected function getMapping($classFqn, $throw = true)
     {
-        if (!isset($this->mapping[$classFqn])) {
-            throw new Exception\ClassNotMappedException($classFqn);
-        }
+        $classFqns = class_parents($classFqn);
+        $classFqns[] = $classFqn;
+        $classFqns = array_reverse($classFqns);
 
-        $mapping = $this->mapping[$classFqn];
+        foreach ($classFqns as $classFqn) {
+            if (isset($this->mapping[$classFqn])) {
+                return $this->mapping[$classFqn];
+            }
+        }
 
-        return $mapping;
+        if ($throw) {
+            throw new Exception\ClassNotMappedException($classFqn);
+        }
     }
 
     private function validateMapping($classFqn, $mapping)

AutoRoute/PathProvider/LocaleProvider.php

@@ -32,9 +32,10 @@ public function providePath(RouteStack $routeStack)
         $locale = $context->getLocale();
 
         if (!$locale) {
-            throw new \RuntimeException(
-                'LocaleProvider requires that a locale is set on the BuilderContext'
-            );
+            throw new \RuntimeException(sprintf(
+                'LocaleProvider requires that a locale is set on the BuilderContext for "%s"',
+                get_class($context->getContent())
+            ));
         }
 
         $routeStack->addPathElements(array($locale));

Tests/Functional/EventListener/AutoRouteListenerTest.php

@@ -16,6 +16,7 @@
 use Symfony\Cmf\Bundle\RoutingAutoBundle\Tests\Resources\Document\Post;
 use Symfony\Cmf\Bundle\RoutingAutoBundle\Tests\Resources\Document\Article;
 use Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\Tests\Resources\Document\ConcreteContent;
 
 class AutoRouteListenerTest extends BaseTestCase
 {
@@ -221,4 +222,22 @@ public function testMultilangArticle($data, $expectedPaths)
             $this->assertEquals('Hello everybody!', $content->title);
         }
     }
+
+    /**
+     * Ensure that we can map parent classes: #56
+     */
+    public function testParentClassMapping()
+    {
+        $content = new ConcreteContent();
+        $content->path = '/test/content';
+        $content->title = 'Hello';
+        $this->getDm()->persist($content);
+        $this->getDm()->flush();
+
+        $this->getDm()->refresh($content);
+
+        $routes = $content->routes;
+
+        $this->assertCount(1, $routes);
+    }
 }

Tests/Resources/Document/AbstractContent.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2013 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+
+namespace Symfony\Cmf\Bundle\RoutingAutoBundle\Tests\Resources\Document;
+
+use Doctrine\ODM\PHPCR\Mapping\Annotations as PHPCR;
+use Symfony\Cmf\Bundle\RoutingBundle\Mapping\Annotations as CMFRouting;
+
+/**
+ * @PHPCR\Document(referenceable=true)
+ */
+class AbstractContent
+{
+    /**
+     * @PHPCR\Id()
+     */
+    public $path;
+
+    /**
+     * @PHPCR\Referrers(
+     *   referringDocument="Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\Route",
+     *   referencedBy="content"
+     * )
+     */
+    public $routes;
+
+    /**
+     * @PHPCR\String()
+     */
+    public $title;
+
+    public function getTitle()
+    {
+        return $this->title;
+    }
+}

Tests/Resources/Document/ConcreteContent.php

@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2013 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+
+namespace Symfony\Cmf\Bundle\RoutingAutoBundle\Tests\Resources\Document;
+
+use Doctrine\ODM\PHPCR\Mapping\Annotations as PHPCR;
+use Symfony\Cmf\Bundle\RoutingBundle\Mapping\Annotations as CMFRouting;
+
+/**
+ * @PHPCR\Document()
+ */
+class ConcreteContent extends AbstractContent
+{
+}

Tests/Resources/app/config/routingautoroute.yml

@@ -64,6 +64,7 @@ cmf_routing_auto:
                 exists_action: [ auto_increment, { pattern: -%d } ]
                 not_exists_action: [ create ]
 
+        # Article document for multilang tests
         Symfony\Cmf\Bundle\RoutingAutoBundle\Tests\Resources\Document\Article:
 
             content_path:
@@ -80,3 +81,17 @@ cmf_routing_auto:
                 provider: [ content_method, { method: getTitle } ]
                 exists_action: [ auto_increment, { pattern: -%d } ]
                 not_exists_action: create
+
+        # AbstractContent for ensuring that parent class mapping works
+        Symfony\Cmf\Bundle\RoutingAutoBundle\Tests\Resources\Document\AbstractContent:
+
+            content_path:
+                path_units:
+                    base:
+                        provider: [ specified, { path: test/auto-route/articles } ]
+                        exists_action: use
+                        not_exists_action: create
+            content_name:
+                provider: [ content_method, { method: getTitle } ]
+                exists_action: [ auto_increment, { pattern: -%d } ]
+                not_exists_action: create

Tests/Unit/AutoRoute/FactoryTest.php

@@ -60,7 +60,7 @@ public function setUp()
      */
     public function testClassNotMappedException()
     {
-        $this->bucf->getRouteStackBuilderUnitChain('FooBar');
+        $this->bucf->getRouteStackBuilderUnitChain('stdClass');
     }
 
     public function provideTestGetChain()
@@ -130,7 +130,7 @@ public function testGetChain($config, $assertOptions)
                 ->with($assertOptions);
         }
 
-        $this->bucf->registerMapping('FooBar/Class', $config);
-        $this->bucf->getRouteStackBuilderUnitChain('FooBar/Class');
+        $this->bucf->registerMapping('stdClass', $config);
+        $this->bucf->getRouteStackBuilderUnitChain('stdClass');
     }
 }

Tests/Unit/AutoRoute/PathProvider/LocaleProviderTest.php

@@ -30,12 +30,17 @@ public function setUp()
 
     /**
      * @expectedException RuntimeException
+     * @expectedExceptionMessage LocaleProvider requires that a locale is set on the BuilderContext for "stdClass"
      */
     public function testProvidePathNoLocale()
     {
         $this->routeStack->expects($this->once())
             ->method('getContext')
             ->will($this->returnValue($this->builderContext));
+
+        $this->builderContext->expects($this->once())
+            ->method('getContent')
+            ->will($this->returnValue(new \stdClass));
         $this->provider->providePath($this->routeStack);
     }