Lots of refactoring.

Author: dantleech

AutoRoute/AutoRouteManager.php

@@ -36,7 +36,7 @@ public function __construct(BuilderUnitChainFactory $bucf)
     public function updateAutoRouteForDocument($document)
     {
         $context = new BuilderContext;
-        $context->setObject($document);
+        $context->setContent($document);
 
         $builderUnitChain = $this->bucf->getChain(ClassUtils::getClass($document));
         $builderUnitChain->executeChain($context);

AutoRoute/BuilderContext.php

@@ -5,40 +5,75 @@
 use Symfony\Cmf\Bundle\RoutingExtraBundle\Document\Route;
 
 /**
- * @todo: Should this be renamed to RouteStack?
- *
- *        A route stack would have all of route components l
  * @author Daniel Leech <[email protected]>
  */
 class BuilderContext
 {
     protected $routeStacks = array();
-    protected $object;
+    protected $stagedRouteStack;
+    protected $content;
 
-    public function addRouteStack($routeStack)
+    public function getRouteNodes()
     {
-        if (!$routeStack->isClosed()) {
-            throw new \RuntimeException('Cannot add closed route stack to context');
+        $routes = array();
+        foreach ($this->routeStacks as $routeStack) {
+            $routes = array_merge($routes, $routeStack->getRouteNodes());
         }
+    }
 
-        $this->routeStacks[] = $routeStack;
+    public function stageRouteStack(RouteStack $routeStack)
+    {
+        $this->stagedRouteStack = $routeStack;
     }
 
-    public function getRouteNodes()
+    public function commitRouteStack()
     {
-        $routes = array();
+        if (null === $this->stagedRouteStack) {
+            throw new \RuntimeException(
+                'Cannot commit route stack when there is no route stack to commit '.
+                '(use stageRouteStack to stage)'
+            );
+        }
+
+        if (false === $this->stagedRouteStack->isClosed()) {
+            throw new \RuntimeException(
+                'Staged route stack is not closed, cannot commit.'
+            );
+        }
+
+        $this->routeStacks[] = $this->stagedRouteStack;
+        $this->stagedRouteStack = null;
+    }
+
+    public function getRouteStacks()
+    {
+        return $this->routeStacks;
+    }
+
+    public function getStagedPath()
+    {
+        if (null === $this->stagedRouteStack) {
+            throw new \RuntimeException('Cannot get staged path when no route stack has been staged (routeStack is null)');
+        }
+
+        $path = array();
+
         foreach ($this->routeStacks as $routeStack) {
-            $routes = array_merge($routes, $routeStack->getRouteNodes());
+            $path[] = $routeStack->getPath();
         }
+
+        $path[] = $this->stagedRouteStack->getPath();
+
+        return '/'.implode('/', $path);
     }
 
-    public function setObject($object)
+    public function setContent($content)
     {
-        $this->object = $object;
+        $this->content = $content;
     }
 
-    public function getObject()
+    public function getContent()
     {
-        return $this->object;
+        return $this->content;
     }
 }

AutoRoute/PathActionInterface.php

@@ -14,5 +14,5 @@ interface PathActionInterface
      */
     public function init(array $options);
 
-    public function execute(BuilderContext $builderContext);
+    public function execute(RouteStack $stack, BuilderContext $builderContext);
 }

AutoRoute/PathExists/AutoIncrementPath.php

@@ -4,7 +4,7 @@
 
 use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\PathActionInterface;
 use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\BuilderContext;
-use Symfony\Component\Routing\Exception\RouteNotFoundException;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\RouteStack;
 use Doctrine\ODM\PHPCR\DocumentManager;
 use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\RouteMakerInterface;
 
@@ -26,17 +26,18 @@ public function init(array $options)
     {
     }
 
-    public function execute(BuilderContext $context)
+    public function execute(RouteStack $routeStack, BuilderContext $context)
     {
         $inc = 1;
 
-        $path = $context->getLastPath();
+        $path = $context->getStagedPath();
 
         do {
             $newPath = sprintf('%s-%d', $path, $inc++);
         } while (null !== $this->dm->find(null, $newPath));
 
-        $context->replaceLastPath($newPath);
-        $this->routeMaker->makeRoutes($context);
+        $stack->replaceLastPathElement($newPath);
+
+        $this->routeMaker->makeRoutes($routeStack);
     }
 }

AutoRoute/PathExists/UsePath.php

@@ -4,6 +4,7 @@
 
 use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\PathActionInterface;
 use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\BuilderContext;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\RouteStack;
 use Doctrine\ODM\PHPCR\DocumentManager;
 
 /**
@@ -22,7 +23,7 @@ public function init(array $options)
     {
     }
 
-    public function execute(BuilderContext $context)
+    public function execute(RouteStack $routeStack, BuilderContext $context)
     {
         $path = $context->getPath();
         $route = $this->dm->find(null, $path);
@@ -35,6 +36,6 @@ public function execute(BuilderContext $context)
             ));
         }
 
-        $context->addRoute($route);
+        $stack->addRoute($route);
     }
 }

AutoRoute/PathProviderInterface.php

@@ -17,5 +17,5 @@ public function init(array $options);
      *
      * @return string
      */
-    public function providePath(BuilderContext $builderContext);
+    public function providePath(RouteStack $routeStack, BuilderContext $builderContext);
 }

AutoRoute/RouteStack.php

@@ -8,7 +8,7 @@
 class RouteStack
 {
     protected $pathElements;
-    protected $routeNodes = array();
+    protected $routes = array();
 
     protected $closed = false;
 
@@ -45,39 +45,44 @@ public function getPaths()
         return $paths;
     }
 
-    public function addRouteNode($routeNode)
+    public function getPath()
+    {
+        return implode('/', $this->pathElements);
+    }
+
+    public function addRoute($route)
     {
         if (true === $this->closed) {
             throw new \RuntimeException('Cannot add path elements to a closed route stack.');
         }
 
-        $this->routeNodes[] = $routeNode;
+        $this->routes[] = $route;
     }
 
     public function close()
     {
-        if (count($this->routeNodes) != count($this->pathElements)) {
+        if (count($this->routes) != count($this->pathElements)) {
             throw new \RuntimeException(sprintf(
                 'Attempting to close route stack but the number of path elements (%d) '.
                 'does not match number of route elements (%d). Registered path elements: "%s"',
                 count($this->pathElements),
-                count($this->routeNodes),
+                count($this->routes),
                 implode(',', $this->pathElements)
             ));
         }
 
         $this->closed = true;
     }
 
-    public function getRouteNodes()
+    public function getRoutes()
     {
         if (false === $this->closed) {
             throw new \RuntimeException(
                 'You must close the route stack before retrieving the route nodes.'
             );
         }
 
-        return $this->routeNodes;
+        return $this->routes;
     }
 
     public function isClosed()

AutoRoute/RouteStackBuilder.php

@@ -2,37 +2,35 @@
 
 namespace Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute;
 
+use PHPCR\SessionInterface as PhpcrSession;
+
 /**
+ * This class is responsible for building and closing
+ * a RouteStack from a given RouteStackBuilderUnit.
+ *
  * @author Daniel Leech <[email protected]>
  */
-class BuilderUnit implements BuilderUnitInterface
+class RouteStackBuilder
 {
-    protected $pathProvider;
-    protected $existsAction;
-    protected $notExistsAction;
-
-    public function __construct(
-        PathProviderInterface $pathProvider, 
-        PathActionInterface $existsAction, 
-        PathActionInterface $notExistsAction
-    ) {
-        $this->pathProvider = $pathProvider;
-        $this->existsAction = $existsAction;
-        $this->notExistsAction = $notExistsAction;
-    }
+    protected $phpcrSession;
 
-    public function pathAction(BuilderContext $context)
+    public function __construct(PhpcrSession $phpcrSession) 
     {
-        $this->pathProvider->providePath($context);
+        $this->phpcrSession = $phpcrSession;
     }
 
-    public function existsAction(BuilderContext $context)
+    public function build(RouteStack $routeStack, RouteStackBuilderUnitInterface $rsbu, BuilderContext $context)
     {
-        $this->existsAction->execute($context);
-    }
+        $rsbu->pathAction($routeStack, $context);
 
-    public function notExistsAction(BuilderContext $context)
-    {
-        $this->notExistsAction->execute($context);
+        $exists = $this->phpcrSession->nodeExists($context->getStagedPath()); 
+
+        if ($exists) {
+            $rsbu->existsAction($routeStack, $context);
+        } else {
+            $rsbu->notExistsAction($routeStack, $context);
+        }
+
+        $routeStack->close();
     }
 }

AutoRoute/RouteStackBuilderUnit.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute;
+
+use PHPCR\SessionInterface as PhpcrSession;
+
+/**
+ * Represents a route stack builder /unit/.
+ *
+ * The unit is a collection of classes required to
+ * build and close a RouteStack.
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+class RouteStackBuilderUnit implements RouteStackBuilderUnitInterface
+{
+    protected $pathProvider;
+    protected $existsAction;
+    protected $notExistsAction;
+
+    public function __construct(
+        PathProviderInterface $pathProvider, 
+        PathActionInterface $existsAction, 
+        PathActionInterface $notExistsAction
+    ) {
+        $this->pathProvider = $pathProvider;
+        $this->existsAction = $existsAction;
+        $this->notExistsAction = $notExistsAction;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function pathAction(RouteStack $routeStack, BuilderContext $context)
+    {
+        $this->pathProvider->providePath($routeStack, $context);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function existsAction(RouteStack $routeStack, BuilderContext $context)
+    {
+        $this->existsAction->execute($routeStack, $context);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function notExistsAction(RouteStack $routeStack, BuilderContext $context)
+    {
+        $this->notExistsAction->execute($routeStack, $context);
+    }
+}

AutoRoute/RouteStackBuilderUnitChain.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute;
+
+use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\Builder;
+
+/**
+ * This class is responsible for aggregating route stack
+ * builder units and executing them sequentially.
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+class RouteStackBuilderUnitChain
+{
+    protected $chain;
+    protected $builder;
+
+    public function __construct(RouteStackBuilder $builder)
+    {
+        $this->builder = $builder;
+    }
+
+    public function addRouteStackBuilderUnit($name, RouteStackBuilderUnitInterface $unit)
+    {
+        $this->chain[$name] = $unit;
+    }
+
+    public function executeChain(BuilderContext $context)
+    {
+        foreach ($this->chain as $name => $builderUnit) {
+            $routeStack = new RouteStack;
+            $this->builder->build($routeStack, $builderUnit, $context);
+        }
+    }
+}