Merge pull request #53 from symfony-cmf/bundle_standards

Updated to bundle stadnards

Author: dantleech

AutoRoute/AutoRouteStack.php

@@ -12,7 +12,7 @@
 
 namespace Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute;
 
-use Symfony\Cmf\Bundle\RoutingAutoBundle\Document\AutoRoute;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute;
 
 /**
  * Special sub class for AutoRoutes.

AutoRoute/RouteMaker/AutoRouteMaker.php

@@ -14,7 +14,7 @@
 
 use Doctrine\ODM\PHPCR\DocumentManager;
 use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\RouteMakerInterface;
-use Symfony\Cmf\Bundle\RoutingAutoBundle\Document\AutoRoute;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute;
 use Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\RouteStack;
 
 /**

CHANGELOG.md

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+* **2013-01-25**: Upgraded to the CMF bundle standards.
+                    - Changed namespace of AutoRoute document
+                    - Changed namespace of AutoRouteListener
+
 * **2013-12-08**: Major configuration format changes.
                   See the documentation: http://symfony.com/doc/current/cmf/bundles/routing_auto.html
 

CmfRoutingAutoBundle.php

@@ -15,12 +15,39 @@
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Cmf\Bundle\RoutingAutoBundle\DependencyInjection\Compiler\AutoRoutePass;
+use Doctrine\Bundle\PHPCRBundle\DependencyInjection\Compiler\DoctrinePhpcrMappingsPass;
 
 class CmfRoutingAutoBundle extends Bundle
 {
     public function build(ContainerBuilder $container)
     {
         parent::build($container);
         $container->addCompilerPass(new AutoRoutePass());
+        $this->buildPhpcrCompilerPass($container);
     }
+
+    /**
+     * Creates and registers compiler passes for PHPCR-ODM mapping if both the
+     * phpcr-odm and the phpcr-bundle are present.
+     *
+     * @param ContainerBuilder $container
+     */
+    private function buildPhpcrCompilerPass(ContainerBuilder $container)
+    {
+        if (!class_exists('Doctrine\Bundle\PHPCRBundle\DependencyInjection\Compiler\DoctrinePhpcrMappingsPass')
+            || !class_exists('Doctrine\ODM\PHPCR\Version')
+        ) {
+            return;
+        }
+
+        $container->addCompilerPass(
+            DoctrinePhpcrMappingsPass::createXmlMappingDriver(
+                array(
+                    realpath(__DIR__.'/Resources/config/doctrine-model') => 'Symfony\Cmf\Bundle\RoutingAutoBundle\Model',
+                ),
+                array('cmf_routing_auto.persistence.phpcr.manager_name')
+            )
+        );
+    }
+
 }

EventListener/AutoRouteListener.php renamed to Doctrine/Phpcr/AutoRouteListener.php

@@ -10,12 +10,12 @@
  */
 
 
-namespace Symfony\Cmf\Bundle\RoutingAutoBundle\EventListener;
+namespace Symfony\Cmf\Bundle\RoutingAutoBundle\Doctrine\Phpcr;
 
 use Doctrine\Common\Persistence\Event\ManagerEventArgs;
 use Doctrine\ODM\PHPCR\DocumentManager;
 use Symfony\Component\DependencyInjection\ContainerInterface;
-use Symfony\Cmf\Bundle\RoutingAutoBundle\Document\AutoRoute;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute;
 
 /**
  * Doctrine PHPCR ODM listener for maintaining automatic routes.

Document/AutoRoute.php renamed to Model/AutoRoute.php

@@ -10,7 +10,7 @@
  */
 
 
-namespace Symfony\Cmf\Bundle\RoutingAutoBundle\Document;
+namespace Symfony\Cmf\Bundle\RoutingAutoBundle\Model;
 
 use Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\Route;
 

README.md

@@ -1,67 +1,43 @@
-# [WIP] Symfony CMF Routing Auto Route Bundle [![Build Status](https://secure.travis-ci.org/symfony-cmf/RoutingAutoBundle.png)](http://travis-ci.org/symfony-cmf/RoutingAutoBundle)
+# Symfony CMF Routing Auto Bundle
 
-This bundle automatically creates and manages routes for configured persisted
-document classes.
-
-*WARNING*: This bundle is still experimental. It works, but there may be some
-as-yet unknown issues. The API, however, should not change too much in the
-future.
+[![Build Status](https://secure.travis-ci.org/symfony-cmf/RoutingAutoBundle.png)](http://travis-ci.org/symfony-cmf/RoutingAutoBundle)
+[![Latest Stable Version](https://poser.pugx.org/symfony-cmf/routing-auto-bundle/version.png)](https://packagist.org/packages/symfony-cmf/routing-auto-bundle)
+[![Total Downloads](https://poser.pugx.org/symfony-cmf/routing-auto-bundle/d/total.png)](https://packagist.org/packages/symfony-cmf/routing-auto-bundle)
 
-See the [official documentation](http://symfony.com/doc/master/cmf/bundles/routing_auto/index.html)
+This bundle is part of the [Symfony Content Management Framework (CMF)](http://cmf.symfony.com/)
+and licensed under the [MIT License](LICENSE).
 
-## Example configuration
 
-The following is the current functional test configuration:
+This bundle automatically creates and manages routes for configured persisted
+document classes.
 
-    symfony_cmf_routing_auto:
+## Requirements 
 
-        auto_route_mapping:
+* Symfony 2.2.x
+* See also the `require` section of [composer.json](composer.json)
 
-            ##
-            # e.g. /cms/auto-route/blog/my-blogs-title
-            Symfony\Cmf\Bundle\RoutingAutoBundle\Tests\Functional\app\Document\Blog:
+## Documentation
 
-                # generate or use path components leading up to the final part of the path
-                content_path:
-                    base:
-                        provider:
-                            name: specified
-                            path: /test/auto-route/blog
-                        exists_action:
-                            strategy: use
-                        not_exists_action:
-                            strategy: create
-                            patcher: generic
+For the install guide and reference, see:
 
-                content_name:
-                    provider:
-                        name: from_object_method
-                        method: getTitle
-                    exists_action:
-                        strategy: auto_increment
-                        pattern: -%d
-                    not_exists_action:
-                        strategy: create
+* [RoutingAuto documentation](http://symfony.com/doc/master/cmf/bundles/routing_auto/index.html)
 
-## Restrictions:
+See also:
 
- * Only documents stored with PHPCR-ODM are supported.
- * You must have the RoutingBundle installed.
+* [Creating a basic CMS (with RoutingAuto)](http://symfony.com/doc/master/cmf/cookbook/creating_a_cms/index.html)
+* [All Symfony CMF documentation](http://symfony.com/doc/master/cmf/index.html) - complete Symfony CMF reference
+* [Symfony CMF Website](http://cmf.symfony.com/) - introduction, live demo, support and community links
 
-## Installation
+## Contributing
 
-Add a requirement for ``symfony-cmf/routing-auto-bundle`` to your
-composer.json and instantiate the bundle in your AppKernel.php
+Pull requests are welcome. Please see our
+[CONTRIBUTING](https://github.com/symfony-cmf/symfony-cmf/blob/master/CONTRIBUTING.md)
+guide.
 
-    new Symfony\Cmf\Bundle\RoutingAutoBundle\CmfRoutingAutoBundle()
+Unit and/or functional tests exist for this bundle. See the
+[Testing documentation](http://symfony.com/doc/master/cmf/components/testing.html)
+for a guide to running the tests.
 
+Thanks to
+[everyone who has contributed](https://github.com/symfony-cmf/RoutingAutoBundle/contributors) already.
 ## Running the tests
-
-To initialize the test environment run the initialization script (you only need
-to do this once):
-
-    ./Tests/Functional/init_travis.sh
-
-Then run all the tests with:
-
-    phpunit -c phpunit.xml.dist

Resources/config/auto_route.xml

@@ -5,7 +5,7 @@
 
     <parameters>
 
-        <parameter key="cmf_routing_auto.phpcrodm_auto_route_listener_class">Symfony\Cmf\Bundle\RoutingAutoBundle\EventListener\AutoRouteListener</parameter>
+        <parameter key="cmf_routing_auto.phpcrodm_auto_route_listener_class">Symfony\Cmf\Bundle\RoutingAutoBundle\Doctrine\Phpcr\AutoRouteListener</parameter>
         <parameter key="cmf_routing_auto.auto_route_manager_class">Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\AutoRouteManager</parameter>
         <parameter key="cmf_routing_auto.factory_class">Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\Factory</parameter>
         <parameter key="cmf_routing_auto.route_stack_builder_class">Symfony\Cmf\Bundle\RoutingAutoBundle\AutoRoute\RouteStack\Builder</parameter>

Resources/config/doctrine/AutoRoute.phpcr.xml renamed to Resources/config/doctrine-model/AutoRoute.phpcr.xml

@@ -1,7 +1,7 @@
 <doctrine-mapping xmlns="http://doctrine-project.org/schemas/phpcr/doctrine-mapping"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
-      <document name="Symfony\Cmf\Bundle\RoutingAutoBundle\Document\AutoRoute"/>
+      <document name="Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute"/>
 
 </doctrine-mapping>
 

Tests/Functional/EventListener/AutoRouteListenerTest.php

@@ -16,7 +16,7 @@
 use Symfony\Cmf\Bundle\RoutingAutoBundle\Tests\Resources\Document\Blog;
 use Symfony\Cmf\Bundle\RoutingAutoBundle\Tests\Resources\Document\Post;
 use Symfony\Cmf\Bundle\RoutingAutoBundle\Tests\Resources\Document\Article;
-use Symfony\Cmf\Bundle\RoutingAutoBundle\Document\AutoRoute;
+use Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute;
 
 class AutoRouteListenerTest extends BaseTestCase
 {
@@ -52,7 +52,7 @@ public function testPersistBlog()
         $routes = $this->getDm()->getReferrers($blog);
 
         $this->assertCount(1, $routes);
-        $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Document\AutoRoute', $routes[0]);
+        $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute', $routes[0]);
         $this->assertEquals('unit-testing-blog', $routes[0]->getName());
     }
 
@@ -84,7 +84,7 @@ public function testUpdateRenameBlog($withPosts = false)
         $routes = $blog->routes;
 
         $this->assertCount(1, $routes);
-        $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Document\AutoRoute', $routes[0]);
+        $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute', $routes[0]);
 
         $this->assertEquals('foobar', $routes[0]->getName());
         $this->assertEquals('/test/auto-route/blog/foobar', $routes[0]->getId());
@@ -117,7 +117,7 @@ public function testUpdatePostNotChangingTitle()
         $routes = $post->routes;
 
         $this->assertCount(1, $routes);
-        $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Document\AutoRoute', $routes[0]);
+        $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute', $routes[0]);
 
         $this->assertEquals('this-is-a-post-title', $routes[0]->getName());
     }
@@ -148,7 +148,7 @@ public function testPersistPost()
         $routes = $this->getDm()->getReferrers($post);
 
         $this->assertCount(1, $routes);
-        $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Document\AutoRoute', $routes[0]);
+        $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute', $routes[0]);
         $this->assertEquals('this-is-a-post-title', $routes[0]->getName());
     }
 
@@ -165,7 +165,7 @@ public function testUpdatePost()
         $routes = $this->getDm()->getReferrers($post);
 
         $this->assertCount(1, $routes);
-        $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Document\AutoRoute', $routes[0]);
+        $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute', $routes[0]);
         $this->assertEquals('this-is-different', $routes[0]->getName());
     }
 
@@ -211,7 +211,7 @@ public function testMultilangArticle($data, $expectedPaths)
             $route = $this->getDm()->find(null, $expectedPath);
 
             $this->assertNotNull($route);
-            $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Document\AutoRoute', $route);
+            $this->assertInstanceOf('Symfony\Cmf\Bundle\RoutingAutoBundle\Model\AutoRoute', $route);
 
             $content = $route->getContent();