Merge pull request #5 from symfony-cmf/dev

Fixes some bugs

Author: dantleech

AutoRoute/Exception/CannotModifyClosedRouteStackException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\Exception;
+
+/**
+ * @author Daniel Leech <[email protected]>
+ */
+class CannotModifyClosedRouteStackException extends \RuntimeException
+{
+}

AutoRoute/Exception/InvalidPathElementException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\Exception;
+
+/**
+ * @author Daniel Leech <[email protected]>
+ */
+class InvalidPathElementException extends \RuntimeException
+{
+}

AutoRoute/PathNotExists/ThrowException.php

@@ -23,7 +23,7 @@ public function init(array $options)
 
     public function execute(RouteStack $routeStack)
     {
-        throw new CouldNotFindRouteException($routeStack->getFullPath());
+        throw new CouldNotFindRouteException('/'.$routeStack->getFullPath());
     }
 }
 

AutoRoute/PathProvider/ContentDateTimeProvider.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\PathProvider;
+
+use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\PathProviderInterface;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\Exception\MissingOptionException;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\RouteStack;
+use Symfony\Cmf\Bundle\CoreBundle\Slugifier\SlugifierInterface;
+
+/**
+ * Provides path elements by determining them from
+ * a DateTime object provided by a designated method on
+ * the content object..
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+class ContentDateTimeProvider extends ContentMethodProvider
+{
+    protected $dateFormat;
+
+    public function init(array $options)
+    {
+        parent::init($options);
+
+        $options = array_merge(array(
+            'date_format' => 'Y-m-d'
+        ), $options);
+
+        $this->dateFormat = $options['date_format'];
+    }
+
+    public function providePath(RouteStack $routeStack)
+    {
+        $object = $routeStack->getContext()->getContent();
+        $method = $this->method;
+
+        if (!method_exists($object, $method)) {
+            throw new \BadMethodCallException(sprintf('Method "%s" does not exist on class "%s"', $method, get_class($object)));
+        }
+
+        $date = $object->$method();
+
+        if (!$date instanceof \DateTime) {
+            throw new \RuntimeException(sprintf('Method %s:%s must return an instance of DateTime.'));
+        }
+
+        $string = $date->format($this->dateFormat);
+        $pathElements = $this->normalizePathElements($string);
+
+        $routeStack->addPathElements($pathElements);
+    }
+}

AutoRoute/PathProvider/FromObjectMethodProvider.php renamed to AutoRoute/PathProvider/ContentMethodProvider.php

@@ -8,9 +8,22 @@
 use Symfony\Cmf\Bundle\CoreBundle\Slugifier\SlugifierInterface;
 
 /**
+ * Provides path elements by determining them from
+ * the return value of a method on the Content object.
+ *
+ * The path elements returned by the designated method can
+ * either be a string of path elements delimited by the path
+ * separator "/" or an array of path elements:
+ *
+ *  - a/full/path
+ *  - array('a', 'full', 'path')
+ *
+ * Each element will be automatically slugified unless the
+ * slugify option is explicitly set to false.
+ *
  * @author Daniel Leech <[email protected]>
  */
-class FromObjectMethodProvider implements PathProviderInterface
+class ContentMethodProvider implements PathProviderInterface
 {
     protected $method;
     protected $slugifier;
@@ -46,6 +59,15 @@ public function providePath(RouteStack $routeStack)
 
         $pathElements = $object->$method();
 
+        $pathElements = $this->normalizePathElements($pathElements);
+
+
+        // @todo: Validate the validator service.
+        $routeStack->addPathElements($pathElements);
+    }
+
+    protected function normalizePathElements($pathElements)
+    {
         if (is_string($pathElements)) {
             if (substr($pathElements, 0, 1) == '/') {
                 throw new \RuntimeException('Path must not be absolute.');
@@ -70,7 +92,6 @@ public function providePath(RouteStack $routeStack)
             });
         }
 
-        // @todo: Validate the validator service.
-        $routeStack->addPathElements($pathElements);
+        return $pathElements;
     }
 }

AutoRoute/PathProvider/ContentObjectProvider.php

@@ -0,0 +1,116 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\PathProvider;
+
+use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\PathProviderInterface;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\Exception\MissingOptionException;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\Exception\CouldNotFindRouteException;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\RouteStack;
+use Symfony\Cmf\Bundle\CoreBundle\Slugifier\SlugifierInterface;
+use Doctrine\ODM\PHPCR\DocumentManager;
+use Symfony\Cmf\Bundle\RoutingExtraBundle\Document\Route;
+use Doctrine\Common\Collections\ArrayCollection;
+
+/**
+ * Provides path elements by determining them from
+ * the existing routes of a PHPCR-ODM document returned
+ * by a designated method on the Content document.
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+class ContentObjectProvider implements PathProviderInterface
+{
+    protected $method;
+    protected $dm;
+
+    public function __construct(DocumentManager $dm)
+    {
+        $this->dm = $dm;
+    }
+
+    public function init(array $options)
+    {
+        if (!isset($options['method'])) {
+            throw new MissingOptionException(__CLASS__, 'method');
+        }
+
+        $this->method = $options['method'];
+    }
+
+    public function providePath(RouteStack $routeStack)
+    {
+        $context = $routeStack->getContext();
+
+        if (count($context->getRouteStacks()) > 0) {
+            throw new \RuntimeException(
+                'ContentObjectProvider must belong to the first builder unit - adding '.
+                'the full route path of an existing object would not make any sense otherwise.'
+            );
+        }
+
+        $contentObject = $context->getContent();
+        $method = $this->method;
+
+        if (!method_exists($contentObject, $method)) {
+            throw new \BadMethodCallException(sprintf('Method "%s" does not exist on class "%s"', $method, get_class($contentObject)));
+        }
+
+        $object = $contentObject->$method();
+
+        $routeFilter = function ($referrer) use ($object) {
+            if ($referrer instanceof Route && $referrer->getRouteContent() === $object) {
+                return true;
+            }
+
+            return false;
+        };
+
+        $referringRoutes = new ArrayCollection;
+
+        if ($this->documentIsPersisted($object)) {
+            // check to see existing routes
+            $referrers = $this->dm->getReferrers($object);
+            $referringRoutes = $referrers->filter($routeFilter);
+        }
+
+        // Now check to see if there are any scheduled routes
+        // I think this should be handled by the ODM ...
+        
+        $uow = $this->dm->getUnitOfWork();
+        $scheduledInserts = $uow->getScheduledInserts();
+        $scheduledRoutes = array_filter($scheduledInserts, $routeFilter);
+        $routes = array_merge($referringRoutes->toArray(), array_values($scheduledRoutes));
+
+        if (count($routes) > 1) {
+            throw new \RuntimeException(
+                'Multiple referring routes (i.e. translations) not supported yet.'
+            );
+        }
+
+        if (empty($routes)) {
+            throw new CouldNotFindRouteException(sprintf(
+                'Could not find route for object "%s" provided by %s:%s',
+                get_class($object),
+                get_class($contentObject),
+                $method
+            ));
+        }
+
+        $route = current($routes);
+        $id = $route->getId();
+
+        // get rid of the first path separator (We do have one right ...)
+        $id = substr($id, 1);
+
+        $pathElements = explode('/', $id);
+        $routeStack->addPathElements($pathElements);
+    }
+
+    protected function documentIsPersisted($document)
+    {
+        $metadata = $this->dm->getClassMetadata(get_class($document));
+        $id = $metadata->getIdentifierValue($document);
+        $phpcrSession = $this->dm->getPhpcrSession();
+        return $phpcrSession->nodeExists($id);
+    }
+}

AutoRoute/RoutePatcher/GenericPatcher.php

@@ -25,12 +25,13 @@ public function patch(RouteStack $routeStack)
         $paths = $routeStack->getFullPaths();
 
         foreach ($paths as $path) {
-            $doc = $this->dm->find(null, $path);
+            $absPath = '/'.$path;
+            $doc = $this->dm->find(null, $absPath);
 
             if (null === $doc) {
                 $doc = new Generic;
                 $meta = $this->dm->getClassMetadata(get_class($doc));
-                $meta->setIdentifierValue($doc, $path);
+                $meta->setIdentifierValue($doc, $absPath);
             }
 
             $routeStack->addRoute($doc);

AutoRoute/RouteStack.php

@@ -13,6 +13,7 @@ class RouteStack
     protected $pathElements;
     protected $routes = array();
     protected $context;
+    protected $existingRoute;
 
     protected $closed = false;
 
@@ -44,10 +45,20 @@ public function addPathElements(array $pathElements)
     public function addPathElement($pathElement)
     {
         if (!$pathElement) {
-            throw new \RuntimeException('Empty path element passed to addPAthElement');
+            throw new Exception\InvalidPathElementException('Empty path element passed to addPAthElement');
         }
+
+        if (false !== strpos($pathElement, '/')) {
+            throw new Exception\InvalidPathElementException(sprintf(
+                'Path elements must not contain the path separator "/", given "%s"',
+                $pathElement
+            ));
+        }
+
         if (true === $this->closed) {
-            throw new \RuntimeException('Cannot add path elements to a closed route stack.');
+            throw new Exception\CannotModifyClosedRouteStackException(
+                'Cannot add path elements to a closed route stack.'
+            );
         }
 
         $this->pathElements[] = $pathElement;
@@ -105,7 +116,7 @@ public function getFullPaths()
         $paths = $this->getPaths();
 
         array_walk($paths, function (&$path) use ($parentPath) {
-            $path = $parentPath.'/'.$path;
+            $path = $parentPath ? $parentPath.'/'.$path : $path;
         });
 
         return $paths;
@@ -179,6 +190,13 @@ public function addRoute($route)
         $this->routes[] = $route;
     }
 
+    public function addRoutes($routes)
+    {
+        foreach ($routes as $route) {
+            $this->addRoute($route);
+        }
+    }
+
     /**
      * Close the stack. Closing a stack will check to see if
      * the number of path elements matches the number of routes and

AutoRoute/RouteStack/Builder.php

@@ -2,9 +2,9 @@
 
 namespace Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\RouteStack;
 
-use PHPCR\SessionInterface as PhpcrSession;
 use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\BuilderContext;
 use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\RouteStack;
+use Doctrine\ODM\PHPCR\DocumentManager;
 
 /**
  * This class is responsible for building and closing
@@ -14,20 +14,22 @@
  */
 class Builder
 {
-    protected $phpcrSession;
+    protected $dm;
 
-    public function __construct(PhpcrSession $phpcrSession) 
+    public function __construct(DocumentManager $dm) 
     {
-        $this->phpcrSession = $phpcrSession;
+        $this->dm = $dm;
     }
 
     public function build(RouteStack $routeStack, BuilderUnitInterface $rsbu)
     {
         $rsbu->pathAction($routeStack);
+        $fullPath = $routeStack->getFullPath();
+        $absPath = '/'.$fullPath;
 
-        $exists = $this->phpcrSession->nodeExists('/'.$routeStack->getFullPath()); 
+        $existingRoute = $this->dm->find(null, $absPath); 
 
-        if ($exists) {
+        if ($existingRoute) {
             $rsbu->existsAction($routeStack);
         } else {
             $rsbu->notExistsAction($routeStack);

Resources/config/auto_route.xml

@@ -43,7 +43,7 @@
         </service>
 
         <service id="symfony_cmf_routing_auto.route_stack_builder" class="%symfony_cmf_routing_auto.route_stack_builder_class%">
-            <argument type="service" id="doctrine_phpcr.default_session"/>
+            <argument type="service" id="doctrine_phpcr.odm.default_document_manager"/>
         </service>
 
         <service id="symfony_cmf_routing_auto.route_patcher" class="%symfony_cmf_routing_auto.route_patcher_class%">