Subscriber now poerted over from RoutingExtra PR

dantleech · dantleech · commit 4323bfc2c795 · 2013-03-09T08:45:31.000Z
diff --git a/AutoRoute/AutoRouteManager.php b/AutoRoute/AutoRouteManager.php
@@ -6,6 +6,7 @@
 use Metadata\MetadataFactoryInterface;
 use Symfony\Cmf\Bundle\RoutingAutoRouteBundle\Document\AutoRoute;
 use Symfony\Cmf\Bundle\CoreBundle\Slugifier\SlugifierInterface;
+use PHPCR\Util\NodeHelper;
 
 /**
  * This class is concerned with the automatic creation of route objects.
@@ -16,12 +17,11 @@
 class AutoRouteManager
 {
     protected $dm;
+    protected $phpcrSession;
     protected $mapping;
     protected $defaultPath;
     protected $slugifier;
 
-    protected $metadata;
-
     /**
      * @TODO: Should defaultPath be contained in a service to
      *        enable this property to be modified at runtime?
@@ -43,6 +43,7 @@ public function __construct(
         $this->mapping = $mapping;
         $this->slugifier = $slugifier;
         $this->defaultPath = $defaultPath;
+        $this->phpcrSession = $dm->getPhpcrSession();
     }
 
     /**
@@ -99,9 +100,13 @@ public function removeAutoRoutesForDocument($document)
      */
     public function isAutoRouteable($document)
     {
-        $metadata = $this->metadataFactory->getMetadataForClass(get_class($document));
+        foreach ($this->mapping as $classFqn => $metadata) {
+            if ($document instanceof $classFqn) {
+                return true;
+            }
+        }
 
-        return $metadata->autoRouteable == 1 ? true : false;
+        return false;
     }
 
     /**
@@ -142,6 +147,13 @@ protected function getParentRoute($document)
     {
         $metadata = $this->getMetadata($document);
         $defaultPath = $metadata['base_path'] ? : $this->defaultPath;
+
+        if ($metadata['base_path_auto_create']) {
+            if (!$this->phpcrSession->nodeExists($defaultPath)) {
+                NodeHelper::createPath($this->phpcrSession, $defaultPath);
+            }
+        }
+
         $parent = $this->dm->find(null, $defaultPath);
 
         if (!$parent) {
@@ -183,7 +195,6 @@ protected function getAutoRouteForDocument($document)
             $autoRoutes = $this->fetchAutoRoutesForDocument($document);
         }
 
-        // @TODO: get locale from ODM
         $locale = null; 
 
         if ($locale) {
@@ -241,6 +252,6 @@ protected function isDocumentPersisted($document)
         $metadata = $this->dm->getClassMetadata(get_class($document));
         $id = $metadata->getIdentifierValue($document);
 
-        return $this->dm->getPhpcrSession()->nodeExists($id);
+        return $this->phpcrSession->nodeExists($id);
     }
 }
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -17,14 +17,15 @@ public function getConfigTreeBuilder()
         $treeBuilder = new TreeBuilder();
         $treeBuilder->root('symfony_cmf_routing_auto_route')
             ->children()
-            ->scalarNode('basepath')
+            ->scalarNode('base_path')
                 ->defaultValue('/cms/auto-routes')
             ->end()
             ->arrayNode('auto_route_by_class')
                 ->useAttributeAsKey('class')
                 ->prototype('array')
                     ->children()
                     ->scalarNode('base_path')->end()
+                    ->booleanNode('base_path_auto_create')->defaultValue(true)->end()
                     ->scalarNode('route_method_name')->end()
                 ->end()
             ->end();
diff --git a/DependencyInjection/SymfonyCmfRoutingAutoRouteExtension.php b/DependencyInjection/SymfonyCmfRoutingAutoRouteExtension.php
@@ -25,7 +25,7 @@ public function load(array $configs, ContainerBuilder $container)
         $config = $processor->processConfiguration($configuration, $configs);
 
         $keys = array(
-            'basepath',
+            'base_path',
             'auto_route_by_class'
         );
 
diff --git a/Document/AutoRoute.php b/Document/AutoRoute.php
@@ -2,7 +2,6 @@
 
 namespace Symfony\Cmf\Bundle\RoutingAutoRouteBundle\Document;
 
-use Doctrine\Common\Collections\Collection;
 use Symfony\Cmf\Bundle\RoutingExtraBundle\Document\Route;
 
 /**
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 This bundle automatically creates and manages routes for given persisted document classes.
 
-User stories:
+Use cases:
 
  * Blog posts: To be able to view a blog posts, blog posts must have a route which 
                is appended to that of its parent, the blog.
diff --git a/Resources/config/auto_route.xml b/Resources/config/auto_route.xml
@@ -15,7 +15,7 @@
             id="symfony_cmf_routing_auto_route.slugifier" 
             class="Symfony\Cmf\Bundle\CoreBundle\Slugifier\CallbackSlugifier"
             >
-            <argument>URLify::filter</argument>
+            <argument>Ferrandini\Urlizer::urlize</argument>
         </service>
 
         <service
@@ -27,6 +27,11 @@
             <argument type="service" id="symfony_cmf_routing_auto_route.slugifier"/>
             <argument>%symfony_cmf_routing_auto_route.basepath%</argument>
         </service>
+
+        <service id="symfony_cmf_routing_auto_route.phpcrodm_auto_route_subscriber" class="%symfony_cmf_routing_auto_route.phpcrodm_auto_route_subscriber_class%">
+            <argument type="service" id="service_container"/>
+            <tag name="doctrine_phpcr.event_subscriber"/>
+        </service>
     </services>
 </container>
 
diff --git a/Tests/Functional/BaseTestCase.php b/Tests/Functional/BaseTestCase.php
@@ -8,11 +8,6 @@
 
 class BaseTestCase extends WebTestCase
 {
-    /**
-     * @var \Doctrine\ODM\PHPCR\DocumentManager
-     */
-    protected $dm;
-
     static protected function createKernel(array $options = array())
     {
         return new AppKernel(
@@ -25,25 +20,24 @@ public function getContainer()
         return self::$kernel->getContainer();
     }
 
+    public function getDm()
+    {
+        return $this->getContainer()->get('doctrine_phpcr.odm.document_manager');
+    }
+
     public function setUp(array $options = array(), $routebase = null)
     {
         self::$kernel = self::createKernel($options);
         self::$kernel->init();
         self::$kernel->boot();
 
-        $this->dm = $this->getContainer()->get('doctrine_phpcr.odm.document_manager');
-
-        if (null == $routebase) {
-            return;
-        }
-
         $session = $this->getContainer()->get('doctrine_phpcr.session');
 
-        if ($session->nodeExists("/test/$routebase")) {
-            $session->getNode("/test/$routebase")->remove();
+        if ($session->nodeExists('/test')) {
+            $session->getNode('/test')->remove();
         }
 
-        if (! $session->nodeExists('/test')) {
+        if (!$session->nodeExists('/test')) {
             $session->getRootNode()->addNode('test', 'nt:unstructured');
         }
 
diff --git a/Tests/Functional/Subscriber/AutoRouteSubscriberTest.php b/Tests/Functional/Subscriber/AutoRouteSubscriberTest.php
@@ -0,0 +1,83 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingAutoRouteBundle\Tests\Functional\Subscriber;
+
+use Symfony\Cmf\Bundle\RoutingAutoRouteBundle\Tests\Functional\app\Document\Post;
+use Symfony\Cmf\Bundle\RoutingAutoRouteBundle\Tests\Functional\BaseTestCase;
+
+class AutoRouteSubscriberTest extends BaseTestCase
+{
+    public function setUp()
+    {
+        parent::setUp();
+        $this->manager = $this->getContainer()->get('symfony_cmf_routing_auto_route.auto_route_manager');
+    }
+
+    protected function createPost()
+    {
+        $post = new Post;
+        $post->path = '/test/test-post';
+        $post->title = 'Unit testing blog post';
+
+        $this->getDm()->persist($post);
+        $this->getDm()->flush();
+        $this->getDm()->clear();
+    }
+
+    public function testPersist()
+    {
+        $this->createPost();
+
+        $route = $this->getDm()->find(null, '/test/auto-route/posts/unit-testing-blog-post');
+
+        $this->assertNotNull($route);
+
+        // make sure auto-route has been persisted
+        $post = $this->getDm()->find(null, '/test/test-post');
+        $routes = $this->getDm()->getReferrers($post);
+
+        $this->assertCount(1, $routes);
+        $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoRouteBundle\Document\AutoRoute', $routes[0]);
+        $this->assertEquals('unit-testing-blog-post', $routes[0]->getName());
+    }
+
+    public function testUpdate()
+    {
+        $this->createPost();
+
+        $post = $this->getDm()->find(null, '/test/test-post');
+        // test update
+        $post->title = 'Foobar';
+        $this->getDm()->persist($post);
+        $this->getDm()->flush();
+
+        // make sure auto-route has been persisted
+        $post = $this->getDm()->find(null, '/test/test-post');
+        $routes = $post->routes;
+
+        $this->assertCount(1, $routes);
+        $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoRouteBundle\Document\AutoRoute', $routes[0]);
+
+        $this->getDm()->refresh($routes[0]);
+
+        $this->assertEquals('foobar', $routes[0]->getName());
+        $this->assertEquals('/test/auto-route/posts/foobar', $routes[0]->getId());
+
+    }
+
+    public function testRemove()
+    {
+        $this->createPost();
+        $post = $this->getDm()->find(null, '/test/test-post');
+
+        // test removing
+        $this->getDm()->remove($post);
+
+        $this->getDm()->flush();
+
+        $baseRoute = $this->getDm()->find(null, '/test/auto-route/posts');
+        $routes = $this->getDm()->getChildren($baseRoute);
+        $this->assertCount(0, $routes);
+    }
+}
+
diff --git a/Tests/Functional/app/AppKernel.php b/Tests/Functional/app/AppKernel.php
@@ -34,6 +34,7 @@ public function registerBundles()
             new \Symfony\Bundle\MonologBundle\MonologBundle(),
             new \Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),
             new \Doctrine\Bundle\PHPCRBundle\DoctrinePHPCRBundle(),
+            new \Symfony\Cmf\Bundle\RoutingExtraBundle\SymfonyCmfRoutingExtraBundle(),
             new \Symfony\Cmf\Bundle\RoutingAutoRouteBundle\SymfonyCmfRoutingAutoRouteBundle(),
         );
     }
diff --git a/Tests/Functional/app/Document/Post.php b/Tests/Functional/app/Document/Post.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Symfony\Cmf\Bundle\RoutingExtraBundle\Tests\Functional\Testdoc;
+namespace Symfony\Cmf\Bundle\RoutingAutoRouteBundle\Tests\Functional\app\Document;
 
 use Doctrine\ODM\PHPCR\Mapping\Annotations as PHPCR;
 use Symfony\Cmf\Bundle\RoutingExtraBundle\Mapping\Annotations as CMFRouting;
@@ -18,7 +18,10 @@ class Post
     public $path;
 
     /**
-     * @PHPCR\Referrers(filter="routeContent")
+     * @PHPCR\Referrers(
+     *   referringDocument="Symfony\Cmf\Bundle\RoutingExtraBundle\Document\Route", 
+     *   referencedBy="routeContent"
+     * )
      */
     public $routes;
 
diff --git a/Tests/Functional/app/config/parameters.yml b/Tests/Functional/app/config/parameters.yml
@@ -0,0 +1,14 @@
+parameters:
+    phpcr_backend:
+        #type: jackrabbit
+        #url: http://localhost:8080/server/
+        type: doctrinedbal
+        connection: doctrine.dbal.default_connection
+    phpcr_workspace: default
+    phpcr_user: admin
+    phpcr_pass: admin
+
+    database_driver: pdo_sqlite
+    database_path: '%kernel.root_dir%/cache/app.sqlite'
+
+    locale: en
diff --git a/Tests/Functional/app/config/phpcrodm.yml b/Tests/Functional/app/config/phpcrodm.yml
@@ -11,7 +11,7 @@ doctrine_phpcr:
         mappings:
             test:
                 type: annotation
-                prefix: Symfony\Cmf\Bundle\RoutingExtraBundle\Tests\Functional\app\Document
+                prefix: Symfony\Cmf\Bundle\RoutingAutoRouteBundle\Tests\Functional\app\Document
                 dir: %kernel.root_dir%/Document
                 is_bundle: false
         auto_generate_proxy_classes: %kernel.debug%
diff --git a/Tests/Functional/app/config/routingautoroute.yml b/Tests/Functional/app/config/routingautoroute.yml
@@ -1,5 +1,6 @@
 symfony_cmf_routing_auto_route:
     auto_route_by_class:
-        Symfony\Cmf\Bundle\AutoRouteBundle\Tests\Functional\app\Document\Post:
-             base_path: /test/posts/test-post
+        Symfony\Cmf\Bundle\RoutingAutoRouteBundle\Tests\Functional\app\Document\Post:
+             base_path: /test/auto-route/posts
+             base_path_auto_create: true
              route_method_name: getTitle
diff --git a/Tests/Functional/app/console b/Tests/Functional/app/console
@@ -0,0 +1,15 @@
+#!/usr/bin/env php
+<?php
+
+require_once __DIR__.'/../../bootstrap.php';
+require_once __DIR__.'/AppKernel.php';
+
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Component\Console\Input\ArgvInput;
+
+use Symfony\Cmf\Bundle\RoutingAutoRouteBundle\Tests\Functional\AppKernel;
+
+$kernel = new AppKernel('default.yml');
+$application = new Application($kernel);
+$application->run();
+
diff --git a/composer.json b/composer.json
@@ -13,7 +13,8 @@
         "symfony/framework-bundle": ">=2.1.7,<2.3-dev",
         "jackalope/jackalope-jackrabbit": "1.*",
         "symfony-cmf/routing-extra-bundle": "dev-master",
-        "symfony-cmf/core-bundle": "dev-master"
+        "symfony-cmf/core-bundle": "dev-master",
+        "aferrandini/urlizer": "dev-master"
     },
     "require-dev": {
         "symfony/class-loader": ">=2.1,<2.3-dev",
diff --git a/composer.lock b/composer.lock

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ public function registerBundles()`
`34`	`34`	`new \Symfony\Bundle\MonologBundle\MonologBundle(),`
`35`	`35`	`new \Doctrine\Bundle\DoctrineBundle\DoctrineBundle(),`
`36`	`36`	`new \Doctrine\Bundle\PHPCRBundle\DoctrinePHPCRBundle(),`
	`37`	`+ new \Symfony\Cmf\Bundle\RoutingExtraBundle\SymfonyCmfRoutingExtraBundle(),`
`37`	`38`	`new \Symfony\Cmf\Bundle\RoutingAutoRouteBundle\SymfonyCmfRoutingAutoRouteBundle(),`
`38`	`39`	`);`
`39`	`40`	`}`