Merge pull request #1 from symfony-cmf/dev

Experimental builder chain idea

Author: dantleech

.travis.yml

@@ -6,7 +6,8 @@ php:
 
 env:
   - SYMFONY_VERSION=2.1.*
-  - SYMFONY_VERSION=dev-master
+  - SYMFONY_VERSION=2.2.*
+  - SYMFONY_VERSION=2.3.*
 
 before_script:
   - composer install --dev

AutoRoute/AutoRouteManager.php

@@ -7,43 +7,20 @@
 use Symfony\Cmf\Bundle\RoutingAutoRouteBundle\Document\AutoRoute;
 use Symfony\Cmf\Bundle\CoreBundle\Slugifier\SlugifierInterface;
 use PHPCR\Util\NodeHelper;
+use Doctrine\Common\Util\ClassUtils;
 
 /**
  * This class is concerned with the automatic creation of route objects.
  *
  * @author Daniel Leech <[email protected]>
- * @author Sjoerd Peters <[email protected]>
  */
 class AutoRouteManager
 {
-    protected $dm;
-    protected $phpcrSession;
-    protected $mapping;
-    protected $defaultPath;
-    protected $slugifier;
+    protected $bucf;
 
-    /**
-     * @TODO: Should defaultPath be contained in a service to
-     *        enable this property to be modified at runtime?
-     * @TODO: Replace Slugifier with TransformerFactory or similar.
-     *
-     * @param DocumentManager    $dm          PHPCR-ODM Document Manager
-     * @param array              $mapping     Class => configuration mapping
-     * @param SlugifierInterface $slugifier   Slugifier
-     * @param string             $defaultPath Default base path for new routes
-     */
-    public function __construct(
-        DocumentManager $dm,
-        array $mapping,
-        SlugifierInterface $slugifier,
-        $defaultPath
-    )
+    public function __construct(BuilderUnitChainFactory $bucf)
     {
-        $this->dm = $dm;
-        $this->mapping = $mapping;
-        $this->slugifier = $slugifier;
-        $this->defaultPath = $defaultPath;
-        $this->phpcrSession = $dm->getPhpcrSession();
+        $this->bucf = $bucf;
     }
 
     /**
@@ -58,18 +35,13 @@ public function __construct(
      */
     public function updateAutoRouteForDocument($document)
     {
-        $metadata = $this->getMetadata($document);
-        $autoRoute = $this->getAutoRouteForDocument($document);
-
-        $autoRouteName = $this->getRouteName($document);
-        $autoRoute->setName($autoRouteName);
-
-        $autoRouteParent = $this->getParentRoute($document);
-        $autoRoute->setParent($autoRouteParent);
+        $context = new BuilderContext;
+        $context->setObject($document);
 
-        $this->dm->persist($autoRoute);
+        $builderUnitChain = $this->bucf->getChain(ClassUtils::getClass($document));
+        $builderUnitChain->executeChain($context);
 
-        return $autoRoute;
+        return $context;
     }
 
     /**
@@ -83,12 +55,7 @@ public function updateAutoRouteForDocument($document)
      */
     public function removeAutoRoutesForDocument($document)
     {
-        $autoRoutes = $this->fetchAutoRoutesForDocument($document);
-        foreach ($autoRoutes as $autoRoute) {
-            $this->dm->remove($autoRoute);
-        }
-
-        return $autoRoutes;
+        throw new \Exception('Implement me??');
     }
 
     /**
@@ -100,158 +67,6 @@ public function removeAutoRoutesForDocument($document)
      */
     public function isAutoRouteable($document)
     {
-        foreach ($this->mapping as $classFqn => $metadata) {
-            if ($document instanceof $classFqn) {
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Generate a route name based on the designated route name method in
-     * the given mapped document.
-     *
-     * Here we use the slugifier service given to this class to normalize
-     * the title.
-     *
-     * @param object Mapped document
-     *
-     * @return string
-     */
-    protected function getRouteName($document)
-    {
-        $metadata = $this->getMetadata($document);
-
-        $routeNameMethod = $metadata['route_method_name'];
-        $routeName = $document->$routeNameMethod();
-        $routeName = $this->slugifier->slugify($routeName);
-
-        return $routeName;
-    }
-
-    /**
-     * Return the parent route for the generated AutoRoute.
-     *
-     * Currently we check to see if a base route path has been specified
-     * in the given mapped document, if not we fall back to the global default.
-     *
-     * @TODO: Enable dynamic parents (e.g. name-of-my-blog/my-post)
-     *
-     * @param object Get parent route of this mapped document.
-     *
-     * @return Route
-     */
-    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) {
-            throw new \Exception(sprintf(
-                'Could not find default route parent at path "%s"',
-                $defaultPath
-            ));
-        }
-
-        return $parent;
-    }
-
-    /**
-     * Convenience method for retrieving Metadata.
-     */
-    protected function getMetadata($document)
-    {
-        foreach ($this->mapping as $classFqn => $metadata) {
-            if ($document instanceof $classFqn) {
-                return $metadata;
-            }
-        }
-    }
-
-    /**
-     * Return the existing or a new AutoRoute for the given document.
-     *
-     * @throws \Exception If we have more than one
-     *
-     * @param object $document Mapped document that needs an AutoRoute
-     *
-     * @return AutoRoute
-     */
-    protected function getAutoRouteForDocument($document)
-    {
-        $autoRoutes = array();
-
-        if ($this->isDocumentPersisted($document)) {
-            $autoRoutes = $this->fetchAutoRoutesForDocument($document);
-        }
-
-        $locale = null; 
-
-        if ($locale) {
-            // filter non-matching locales, note that we could do this with the QueryBuilder
-            // but currently searching array values is not supported by jackalope-doctrine-dbal.
-            array_filter($res, function ($route) use ($locale) {
-                if ($route->getDefault('_locale') != $locale) {
-                    return false;
-                }
-
-                return true;
-            });
-        }
-
-        if (count($autoRoutes) > 1) {
-            throw new Exception\MoreThanOneAutoRoute($document);
-        } elseif (count($autoRoutes) == 1) {
-            $autoRoute = $autoRoutes->first();
-        } else {
-            $autoRoute = new AutoRoute;
-            $autoRoute->setRouteContent($document);
-        }
-
-        return $autoRoute;
-    }
-
-    /**
-     * Fetch all the automatic routes for the given document
-     *
-     * @param object $document Mapped document
-     *
-     * @return array
-     */
-    public function fetchAutoRoutesForDocument($document)
-    {
-        $routes = $this->dm->getReferrers($document, null, 'routeContent');
-        $routes = $routes->filter(function ($route) {
-            if ($route instanceof AutoRoute) {
-                return true;
-            }
-
-            return false;
-        });
-
-        return $routes;
-    }
-
-    public function getDefaultPath()
-    {
-        return $this->defaultPath;
-    }
-
-    protected function isDocumentPersisted($document)
-    {
-        $metadata = $this->dm->getClassMetadata(get_class($document));
-        $id = $metadata->getIdentifierValue($document);
-
-        return $this->phpcrSession->nodeExists($id);
+        return $this->bucf->hasMapping(ClassUtils::getClass($document));
     }
 }

AutoRoute/Builder.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingAutoRouteBundle\AutoRoute;
+
+use PHPCR\SessionInterface as PhpcrSession;
+
+/**
+ * This class uses the actions defined builder units construct
+ * a path.
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+class Builder implements BuilderInterface
+{
+    protected $phpcrSession;
+
+    public function __construct(PhpcrSession $phpcrSession)
+    {
+        $this->phpcrSession = $phpcrSession;
+    }
+
+    public function build(BuilderUnitInterface $builderUnit, BuilderContext $context)
+    {
+        $builderUnit->pathAction($context);
+
+        $exists = $this->phpcrSession->nodeExists($context->getPath()); 
+
+        if ($exists) {
+            // todo: check to see if the existing node references 
+            //       this content... i.e. allow updates to pass.
+            
+            $builderUnit->existsAction($context);
+        } else {
+            $builderUnit->notExistsAction($context);
+        }
+    }
+}

AutoRoute/BuilderContext.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingAutoRouteBundle\AutoRoute;
+
+use Symfony\Cmf\Bundle\RoutingExtraBundle\Document\Route;
+
+/**
+ * @author Daniel Leech <[email protected]>
+ */
+class BuilderContext
+{
+    protected $pathStack = array();
+    protected $routeStack = array();
+
+    protected $isLastBuilder = false;
+
+    public function addPath($part)
+    {
+        $this->pathStack[] = $part;
+    }
+
+    public function getLastPath()
+    {
+        return end($this->pathStack);
+    }
+
+    public function replaceLastPath($path)
+    {
+        array_pop($this->pathStack);
+        $this->pathStack[] = $path;
+    }
+
+    public function getPathStack()
+    {
+        return $this->pathStack;
+    }
+
+    public function addRoute($route)
+    {
+        $this->routeStack[]= $route;
+    }
+
+    public function getRouteStack()
+    {
+        return $this->routeStack;
+    }
+
+    public function getLastRoute()
+    {
+        return end($this->routeStack);
+    }
+
+    public function getPath()
+    {
+        return implode('/', $this->pathStack);
+    }
+
+    public function isLastBuilder($isLastBuilder = null)
+    {
+        if (null === $isLastBuilder) {
+            return $this->isLastBuilder;
+        }
+
+        $this->isLastBuilder = $isLastBuilder;
+    }
+
+    public function setObject($object)
+    {
+        $this->object = $object;
+    }
+
+    public function getObject()
+    {
+        return $this->object;
+    }
+}

AutoRoute/BuilderInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Symfony\Cmf\Bundle\RoutingAutoRouteBundle\AutoRoute;
+
+/**
+ * @author Daniel Leech <[email protected]>
+ */
+interface BuilderInterface
+{
+    public function build(BuilderUnitInterface $builderUnit, BuilderContext $context);
+}
+