replace single colon syntax also for service router loader

symfony · Tobion · Feb 8, 2018 · Feb 8, 2018 · Feb 8, 2018 · Feb 8, 2018
commit 067a0d8a4054627874ea173d49a986fc427ec742
diff --git a/src/Symfony/Bundle/FrameworkBundle/Kernel/MicroKernelTrait.php b/src/Symfony/Bundle/FrameworkBundle/Kernel/MicroKernelTrait.php
@@ -64,7 +64,7 @@ public function registerContainerConfiguration(LoaderInterface $loader)
        $loader->load(function (ContainerBuilder $container) use ($loader) {
            $container->loadFromExtension('framework', array(
                'router' => array(
-                    'resource' => 'kernel:loadRoutes',
+                    'resource' => 'kernel::loadRoutes',
                    'type' => 'service',
                ),
            ));

diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json
@@ -27,7 +27,7 @@
        "symfony/polyfill-mbstring": "~1.0",
        "symfony/filesystem": "~3.4|~4.0",
        "symfony/finder": "~3.4|~4.0",
-        "symfony/routing": "^3.4.5|^4.0.5"
+        "symfony/routing": "^4.1"
    },
    "require-dev": {
        "doctrine/cache": "~1.0",

diff --git a/src/Symfony/Component/Routing/Loader/ObjectRouteLoader.php b/src/Symfony/Component/Routing/Loader/ObjectRouteLoader.php
@@ -44,9 +44,17 @@ abstract protected function getServiceObject($id);
     */
    public function load($resource, $type = null)
    {
-        $parts = explode(':', $resource);
+        if (1 === substr_count($resource, ':')) {
+            $resource = str_replace(':', '::', $resource);
+            @trigger_error(sprintf(
+                'Referencing service route loaders with a single colon is deprecated since version 4.1 and will be removed in 5.0. Use %s instead.',
+                $resource
+            ), E_USER_DEPRECATED);
+        }
+
+        $parts = explode('::', $resource);
        if (2 != count($parts)) {
-            throw new \InvalidArgumentException(sprintf('Invalid resource "%s" passed to the "service" route loader: use the format "service_name:methodName"', $resource));
+            throw new \InvalidArgumentException(sprintf('Invalid resource "%s" passed to the "service" route loader: use the format "service::method"', $resource));
        }

        $serviceString = $parts[0];
@@ -58,7 +66,7 @@ public function load($resource, $type = null)
            throw new \LogicException(sprintf('%s:getServiceObject() must return an object: %s returned', get_class($this), gettype($loaderObject)));
        }

-        if (!method_exists($loaderObject, $method)) {
+        if (!is_callable(array($loaderObject, $method))) {
            throw new \BadMethodCallException(sprintf('Method "%s" not found on "%s" when importing routing resource "%s"', $method, get_class($loaderObject), $resource));
        }


diff --git a/src/Symfony/Component/Routing/Tests/Loader/ObjectRouteLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/ObjectRouteLoaderTest.php
@@ -18,7 +18,11 @@

 class ObjectRouteLoaderTest extends TestCase
 {
-    public function testLoadCallsServiceAndReturnsCollection()
+    /**
+     * @group legacy
+     * @expectedDeprecation Referencing service route loaders with a single colon is deprecated since version 4.1 and will be removed in 5.0. Use my_route_provider_service::loadRoutes instead.
+     */
+    public function testLoadCallsServiceAndReturnsCollectionWithLegacyNotation()
    {
        $loader = new ObjectRouteLoaderForTest();

@@ -40,6 +44,28 @@ public function testLoadCallsServiceAndReturnsCollection()
        $this->assertNotEmpty($actualRoutes->getResources());
    }

+    public function testLoadCallsServiceAndReturnsCollection()
+    {
+        $loader = new ObjectRouteLoaderForTest();
+
+        // create a basic collection that will be returned
+        $collection = new RouteCollection();
+        $collection->add('foo', new Route('/foo'));
+
+        $loader->loaderMap = array(
+            'my_route_provider_service' => new RouteService($collection),
+        );
+
+        $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 \InvalidArgumentException
     * @dataProvider getBadResourceStrings
@@ -54,7 +80,6 @@ public function getBadResourceStrings()
    {
        return array(
            array('Foo'),
-            array('Bar::baz'),
            array('Foo:Bar:baz'),
        );
    }
@@ -66,7 +91,7 @@ public function testExceptionOnNoObjectReturned()
    {
        $loader = new ObjectRouteLoaderForTest();
        $loader->loaderMap = array('my_service' => 'NOT_AN_OBJECT');
-        $loader->load('my_service:method');
+        $loader->load('my_service::method');
    }

    /**
@@ -76,7 +101,7 @@ public function testExceptionOnBadMethod()
    {
        $loader = new ObjectRouteLoaderForTest();
        $loader->loaderMap = array('my_service' => new \stdClass());
-        $loader->load('my_service:method');
+        $loader->load('my_service::method');
    }

    /**
@@ -93,7 +118,7 @@ public function testExceptionOnMethodNotReturningCollection()

        $loader = new ObjectRouteLoaderForTest();
        $loader->loaderMap = array('my_service' => $service);
-        $loader->load('my_service:loadRoutes');
+        $loader->load('my_service::loadRoutes');
    }
 }