Updating ObjectRouteLoader to use a service_id:methodName format

symfony · weaverryan · Sep 9, 2015 · Sep 9, 2015 · Sep 9, 2015 · Sep 10, 2015
commit 6b0a5c6785a9fbb610130cf7e4c3f59a373f553d
diff --git a/src/Symfony/Component/Routing/Loader/DependencyInjection/ServiceRouterLoader.php b/src/Symfony/Component/Routing/Loader/DependencyInjection/ServiceRouterLoader.php
@@ -34,7 +34,7 @@ public function __construct(ContainerInterface $container)
         $this->container = $container;
     }
 
-    protected function getRouteLoaderService($id)
+    protected function getServiceObject($id)
     {
         return $this->container->get($id);
     }

diff --git a/src/Symfony/Component/Routing/Loader/ObjectRouteLoader.php b/src/Symfony/Component/Routing/Loader/ObjectRouteLoader.php
@@ -22,26 +22,56 @@
  */
 abstract class ObjectRouteLoader extends Loader
 {
+    /**
+     * Returns the object that the method will be called on to load routes.
+     *
+     * For example, if your application uses a service container,
+     * the $id may be a service id.
+     *
+     * @param string $id
+     *
+     * @return object
+     */
+    abstract protected function getServiceObject($id);
+
     /**
      * Calls the service that will load the routes.
      *
-     * @param string      $resource The name of the service to load
+     * @param mixed       $resource Some value that will resolve to a callable
      * @param string|null $type     The resource type
      *
      * @return RouteCollection
      */
     public function load($resource, $type = null)
     {
-        $routeLoader = $this->getRouteLoaderService($resource);
+        $parts = explode(':', $resource);
+        if (count($parts) != 2) {
+            throw new \InvalidArgumentException(sprintf('Invalid resource "%s" passed to the "service" route loader: use the format "service_name:methodName"', $resource));
+        }
+
+        $serviceString = $parts[0];
+        $method = $parts[1];
+
+        $loaderObject = $this->getServiceObject($serviceString);
+
+        if (!is_object($loaderObject)) {
+            throw new \LogicException(sprintf('%s:getServiceObject() must return an object: %s returned', get_class($this), $loaderObject));
+        }
 
-        if (!$routeLoader instanceof RouteLoaderInterface) {
-            throw new \LogicException(sprintf('Service "%s" must implement RouteLoaderInterface.', $resource));
+        if (!method_exists($loaderObject, $method)) {
+            throw new \BadMethodCallException(sprintf('Method "%s" not found on "%s" when importing routing resource "%s"', $method, get_class($loaderObject), $resource));
         }
 
-        $routeCollection = $routeLoader->getRouteCollection($this);
+        $routeCollection = call_user_func(array($loaderObject, $method), $this);
+
+        if (!$routeCollection instanceof RouteCollection) {
+            $type = is_object($routeCollection) ? get_class($routeCollection) : gettype($routeCollection);
+
+            throw new \LogicException(sprintf('The %s::%s method must return a RouteCollection: %s returned', get_class($loaderObject), $method, $type));
+        }
 
         // make the service file tracked so that if it changes, the cache rebuilds
-        $this->addClassResource(new \ReflectionClass($routeLoader), $routeCollection);
+        $this->addClassResource(new \ReflectionClass($loaderObject), $routeCollection);
 
         return $routeCollection;
     }
@@ -56,18 +86,6 @@ public function supports($resource, $type = null)
         return 'service' === $type;
     }
 
-    /**
-     * Returns a RouteLoaderInterface object matching the id.
-     *
-     * For example, if your application uses a service container,
-     * the $id may be a service id.
-     *
-     * @param string $id
-     *
-     * @return RouteLoaderInterface
-     */
-    abstract protected function getRouteLoaderService($id);
-
     private function addClassResource(\ReflectionClass $class, RouteCollection $collection)
     {
         do {

diff --git a/src/Symfony/Component/Routing/Loader/RouteLoaderInterface.php b/src/Symfony/Component/Routing/Loader/RouteLoaderInterface.php
diff --git a/src/Symfony/Component/Routing/Tests/Loader/ObjectRouteLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/ObjectRouteLoaderTest.php
@@ -19,53 +19,97 @@ class ObjectRouteLoaderTest extends \PHPUnit_Framework_TestCase
 {
     public function testLoadCallsServiceAndReturnsCollection()
     {
-        $routeLoader = $this->getMock('Symfony\Component\Routing\Loader\RouteLoaderInterface');
-        $serviceRouteLoader = new ObjectRouteLoaderForTest();
-
-        $serviceRouteLoader->loaderMap = array(
-            'my_route_provider_service' => $routeLoader,
-        );
+        $loader = new ObjectRouteLoaderForTest();
 
         // create a basic collection that will be returned
-        $routes = new RouteCollection();
-        $routes->add('foo', new Route('/foo'));
+        $collection = new RouteCollection();
+        $collection->add('foo', new Route('/foo'));
 
-        $routeLoader
-            ->expects($this->any())
-            ->method('getRouteCollection')
-            // the loader itself is passed
-            ->with($serviceRouteLoader)
-            ->will($this->returnValue($routes));
+        // create some callable object
+        $service = $this->getMockBuilder('stdClass')
+            ->setMethods(array('loadRoutes'))
+            ->getMock();
+        $service->expects($this->once())
+            ->method('loadRoutes')
+            ->with($loader)
+            ->will($this->returnValue($collection));
 
-        $actualRoutes = $serviceRouteLoader->load('my_route_provider_service', 'service');
+        $loader->loaderMap = array(
+            'my_route_provider_service' => $service,
+        );
 
-        $this->assertSame($routes, $actualRoutes);
+        $actualRoutes = $loader->load(
+            'my_route_provider_service:loadRoutes',
+            'service'
+        );
+
+        $this->assertSame($collection, $actualRoutes);
         // the service file should be listed as a resource
         $this->assertNotEmpty($actualRoutes->getResources());
     }
 
     /**
-     * @expectedException \LogicException
+     * @expectedException \InvalidArgumentException
+     * @dataProvider getBadResourceStrings
      */
-    public function testExceptionOnInterfaceNotImplemented()
+    public function testExceptionWithoutSyntax($resourceString)
     {
-        // anything that doesn't implement the interface
-        $routeLoader = new \stdClass();
+        $loader = new ObjectRouteLoaderForTest();
+        $loader->load($resourceString);
+    }
 
-        $serviceRouteLoader = new ObjectRouteLoaderForTest();
-        $serviceRouteLoader->loaderMap = array(
-            'any_service_name' => $routeLoader,
+    public function getBadResourceStrings()
+    {
+        return array(
+            array('Foo'),
+            array('Bar::baz'),
+            array('Foo:Bar:baz'),
         );
+    }
+
+    /**
+     * @expectedException \LogicException
+     */
+    public function testExceptionOnNoObjectReturned()
+    {
+        $loader = new ObjectRouteLoaderForTest();
+        $loader->loaderMap = array('my_service' => 'NOT_AN_OBJECT');
+        $loader->load('my_service:method');
+    }
+
+    /**
+     * @expectedException \BadMethodCallException
+     */
+    public function testExceptionOnBadMethod()
+    {
+        $loader = new ObjectRouteLoaderForTest();
+        $loader->loaderMap = array('my_service' => new \stdClass());
+        $loader->load('my_service:method');
+    }
+
+    /**
+     * @expectedException \LogicException
+     */
+    public function testExceptionOnMethodNotReturningCollection()
+    {
+        $service = $this->getMockBuilder('stdClass')
+            ->setMethods(array('loadRoutes'))
+            ->getMock();
+        $service->expects($this->once())
+            ->method('loadRoutes')
+            ->will($this->returnValue('NOT_A_COLLECTION'));
 
-        $serviceRouteLoader->load('any_service_name', 'service');
+        $loader = new ObjectRouteLoaderForTest();
+        $loader->loaderMap = array('my_service' => $service);
+        $loader->load('my_service:loadRoutes');
     }
 }
 
 class ObjectRouteLoaderForTest extends ObjectRouteLoader
 {
     public $loaderMap = array();
 
-    protected function getRouteLoaderService($id)
+    protected function getServiceObject($id)
     {
         return isset($this->loaderMap[$id]) ? $this->loaderMap[$id] : null;
     }