[Routing] Exposed "compiler_class" and "utf8" options in configuration

Jules Pietri · Jules Pietri · commit c97a98df8747 · 2019-03-10T18:03:48.000+01:00
diff --git a/src/Symfony/Component/Routing/CHANGELOG.md b/src/Symfony/Component/Routing/CHANGELOG.md
@@ -10,6 +10,7 @@ CHANGELOG
  * deprecated `generator_base_class`, `generator_cache_class`, `matcher_base_class` and `matcher_cache_class` router options
  * deprecated implementing `Serializable` for `Route` and `CompiledRoute`; if you serialize them, please
    ensure your unserialization logic can recover from a failure related to an updated serialization format
+ * exposed `compiler_class` and `utf8` Route options in configuration loaders and configurators
 
 4.2.0
 -----
diff --git a/src/Symfony/Component/Routing/Loader/Configurator/Traits/RouteTrait.php b/src/Symfony/Component/Routing/Loader/Configurator/Traits/RouteTrait.php
@@ -57,6 +57,30 @@ final public function options(array $options)
         return $this;
     }
 
+    /**
+     * Defines the compiler class used to compiled the Route.
+     *
+     * @return $this
+     */
+    final public function compilerClass(string $class)
+    {
+        $this->route->addOptions(['compiler_class' => $class]);
+
+        return $this;
+    }
+
+    /**
+     * Whether paths should accept utf8 encoding.
+     *
+     * @return $this
+     */
+    final public function utf8(bool $utf8 = true)
+    {
+        $this->route->addOptions(['utf8' => $utf8]);
+
+        return $this;
+    }
+
     /**
      * Sets the condition.
      *
diff --git a/src/Symfony/Component/Routing/Loader/XmlFileLoader.php b/src/Symfony/Component/Routing/Loader/XmlFileLoader.php
@@ -311,6 +311,12 @@ private function parseConfigs(\DOMElement $node, $path)
 
             $defaults['_controller'] = $controller;
         }
+        if ($node->hasAttribute('compiler-class')) {
+            $options['compiler_class'] = trim($node->getAttribute('compiler-class'));
+        }
+        if ($node->hasAttribute('utf8')) {
+            $options['utf8'] = XmlUtils::phpize($node->getAttribute('utf8'));
+        }
 
         return [$defaults, $requirements, $options, $condition, $paths, $prefixes];
     }
diff --git a/src/Symfony/Component/Routing/Loader/YamlFileLoader.php b/src/Symfony/Component/Routing/Loader/YamlFileLoader.php
@@ -28,7 +28,7 @@
 class YamlFileLoader extends FileLoader
 {
     private static $availableKeys = [
-        'resource', 'type', 'prefix', 'path', 'host', 'schemes', 'methods', 'defaults', 'requirements', 'options', 'condition', 'controller', 'name_prefix', 'trailing_slash_on_root',
+        'resource', 'type', 'prefix', 'path', 'host', 'schemes', 'methods', 'defaults', 'requirements', 'options', 'condition', 'controller', 'name_prefix', 'trailing_slash_on_root', 'compiler_class', 'utf8',
     ];
     private $yamlParser;
 
@@ -125,6 +125,13 @@ protected function parseRoute(RouteCollection $collection, $name, array $config,
         if (isset($config['controller'])) {
             $defaults['_controller'] = $config['controller'];
         }
+        if (isset($config['compiler_class'])) {
+            $options['compiler_class'] = $config['compiler_class'];
+        }
+        if (isset($config['utf8'])) {
+            $options['utf8'] = $config['utf8'];
+        }
+        unset($config['controller'], $config['compiler_class'], $config['utf8']);
 
         if (\is_array($config['path'])) {
             $route = new Route('', $defaults, $requirements, $options, $host, $schemes, $methods, $condition);
@@ -166,6 +173,13 @@ protected function parseImport(RouteCollection $collection, array $config, $path
         if (isset($config['controller'])) {
             $defaults['_controller'] = $config['controller'];
         }
+        if (isset($config['compiler_class'])) {
+            $options['compiler_class'] = $config['compiler_class'];
+        }
+        if (isset($config['utf8'])) {
+            $options['utf8'] = $config['utf8'];
+        }
+        unset($config['controller'], $config['compiler_class'], $config['utf8']);
 
         $this->setCurrentDir(\dirname($path));
 
diff --git a/src/Symfony/Component/Routing/Loader/schema/routing/routing-1.0.xsd b/src/Symfony/Component/Routing/Loader/schema/routing/routing-1.0.xsd
@@ -52,6 +52,8 @@
     <xsd:attribute name="schemes" type="xsd:string" />
     <xsd:attribute name="methods" type="xsd:string" />
     <xsd:attribute name="controller" type="xsd:string" />
+    <xsd:attribute name="compiler-class" type="xsd:string" />
+    <xsd:attribute name="utf8" type="xsd:boolean" />
   </xsd:complexType>
 
   <xsd:complexType name="import">
@@ -68,6 +70,8 @@
     <xsd:attribute name="methods" type="xsd:string" />
     <xsd:attribute name="controller" type="xsd:string" />
     <xsd:attribute name="trailing-slash-on-root" type="xsd:boolean" />
+    <xsd:attribute name="compiler-class" type="xsd:string" />
+    <xsd:attribute name="uft8" type="xsd:boolean" />
   </xsd:complexType>
 
   <xsd:complexType name="default" mixed="true">
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/custom_compiler_class.php b/src/Symfony/Component/Routing/Tests/Fixtures/custom_compiler_class.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Symfony\Component\Routing\Loader\Configurator;
+
+use Symfony\Component\Routing\Tests\Fixtures\CustomRouteCompiler;
+
+return function (RoutingConfigurator $routes) {
+    $routes
+        ->add('some_route', '/')
+        ->add('custom_compiled_route', '/custom-compilation')->compilerClass(CustomRouteCompiler::class)
+    ;
+};
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/custom_compiler_class.xml b/src/Symfony/Component/Routing/Tests/Fixtures/custom_compiler_class.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<routes xmlns="http://symfony.com/schema/routing"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://symfony.com/schema/routing">
+
+    <route id="some_route" path="/" />
+    <route id="custom_compiled_route" path="/custom-compilation" compiler-class="Symfony\Component\Routing\Tests\Fixtures\CustomRouteCompiler"/>
+</routes>
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/custom_compiler_class.yml b/src/Symfony/Component/Routing/Tests/Fixtures/custom_compiler_class.yml
@@ -0,0 +1,6 @@
+some_route:
+    path: /
+
+custom_compiled_route:
+    path: /custom-compilation
+    compiler_class: 'Symfony\Component\Routing\Tests\Fixtures\CustomRouteCompiler'
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/localized/utf8.php b/src/Symfony/Component/Routing/Tests/Fixtures/localized/utf8.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Symfony\Component\Routing\Loader\Configurator;
+
+return function (RoutingConfigurator $routes) {
+    $routes
+        ->add('some_route', '/')
+        ->add('some_utf8_route', '/utf8')->utf8()
+    ;
+};
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/localized/utf8.xml b/src/Symfony/Component/Routing/Tests/Fixtures/localized/utf8.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<routes xmlns="http://symfony.com/schema/routing"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://symfony.com/schema/routing">
+
+    <route id="some_route" path="/" />
+    <route id="some_utf8_route" path="/utf8" utf8="true"/>
+</routes>
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/localized/utf8.yml b/src/Symfony/Component/Routing/Tests/Fixtures/localized/utf8.yml
@@ -0,0 +1,6 @@
+some_route:
+    path: /
+
+some_utf8_route:
+    path: /utf8
+    utf8: true
diff --git a/src/Symfony/Component/Routing/Tests/Loader/PhpFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/PhpFileLoaderTest.php
@@ -17,6 +17,7 @@
 use Symfony\Component\Routing\Loader\PhpFileLoader;
 use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;
+use Symfony\Component\Routing\Tests\Fixtures\CustomRouteCompiler;
 
 class PhpFileLoaderTest extends TestCase
 {
@@ -84,6 +85,42 @@ public function testThatDefiningVariableInConfigFileHasNoSideEffects()
         );
     }
 
+    public function testLoadingCustomCompiledRoute()
+    {
+        $loader = new PhpFileLoader(new FileLocator([__DIR__.'/../Fixtures']));
+        $routes = $loader->load('custom_compiler_class.php');
+
+        $this->assertCount(2, $routes);
+
+        $expectedRoutes = new RouteCollection();
+        $expectedRoutes->add('some_route', new Route('/'));
+
+        $expectedRoutes->add('custom_compiled_route', $route = new Route('/custom-compilation'));
+        $route->setOption('compiler_class', CustomRouteCompiler::class);
+
+        $expectedRoutes->addResource(new FileResource(__DIR__.'/../Fixtures/custom_compiler_class.php'));
+
+        $this->assertEquals($expectedRoutes, $routes);
+    }
+
+    public function testLoadingUtf8Route()
+    {
+        $loader = new PhpFileLoader(new FileLocator([__DIR__.'/../Fixtures/localized']));
+        $routes = $loader->load('utf8.php');
+
+        $this->assertCount(2, $routes);
+
+        $expectedRoutes = new RouteCollection();
+        $expectedRoutes->add('some_route', new Route('/'));
+
+        $expectedRoutes->add('some_utf8_route', $route = new Route('/utf8'));
+        $route->setOption('utf8', true);
+
+        $expectedRoutes->addResource(new FileResource(__DIR__.'/../Fixtures/localized/utf8.php'));
+
+        $this->assertEquals($expectedRoutes, $routes);
+    }
+
     public function testRoutingConfigurator()
     {
         $locator = new FileLocator([__DIR__.'/../Fixtures']);
diff --git a/src/Symfony/Component/Routing/Tests/Loader/XmlFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/XmlFileLoaderTest.php
@@ -13,7 +13,11 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Config\FileLocator;
+use Symfony\Component\Config\Resource\FileResource;
 use Symfony\Component\Routing\Loader\XmlFileLoader;
+use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\RouteCollection;
+use Symfony\Component\Routing\Tests\Fixtures\CustomRouteCompiler;
 use Symfony\Component\Routing\Tests\Fixtures\CustomXmlFileLoader;
 
 class XmlFileLoaderTest extends TestCase
@@ -83,6 +87,42 @@ public function testLoadWithImport()
         }
     }
 
+    public function testLoadingCustomCompiledRoute()
+    {
+        $loader = new XmlFileLoader(new FileLocator([__DIR__.'/../Fixtures']));
+        $routes = $loader->load('custom_compiler_class.xml');
+
+        $this->assertCount(2, $routes);
+
+        $expectedRoutes = new RouteCollection();
+        $expectedRoutes->add('some_route', new Route('/'));
+
+        $expectedRoutes->add('custom_compiled_route', $route = new Route('/custom-compilation'));
+        $route->setOption('compiler_class', CustomRouteCompiler::class);
+
+        $expectedRoutes->addResource(new FileResource(__DIR__.'/../Fixtures/custom_compiler_class.xml'));
+
+        $this->assertEquals($expectedRoutes, $routes);
+    }
+
+    public function testLoadingUtf8Route()
+    {
+        $loader = new XmlFileLoader(new FileLocator([__DIR__.'/../Fixtures/localized']));
+        $routes = $loader->load('utf8.xml');
+
+        $this->assertCount(2, $routes);
+
+        $expectedRoutes = new RouteCollection();
+        $expectedRoutes->add('some_route', new Route('/'));
+
+        $expectedRoutes->add('some_utf8_route', $route = new Route('/utf8'));
+        $route->setOption('utf8', true);
+
+        $expectedRoutes->addResource(new FileResource(__DIR__.'/../Fixtures/localized/utf8.xml'));
+
+        $this->assertEquals($expectedRoutes, $routes);
+    }
+
     public function testLoadLocalized()
     {
         $loader = new XmlFileLoader(new FileLocator([__DIR__.'/../Fixtures']));
diff --git a/src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php
@@ -15,6 +15,9 @@
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\Config\Resource\FileResource;
 use Symfony\Component\Routing\Loader\YamlFileLoader;
+use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\RouteCollection;
+use Symfony\Component\Routing\Tests\Fixtures\CustomRouteCompiler;
 
 class YamlFileLoaderTest extends TestCase
 {
@@ -222,6 +225,42 @@ public function testRemoteSourcesAreNotAccepted()
         $loader->load('http://remote.com/here.yml');
     }
 
+    public function testLoadingCustomCompiledRoute()
+    {
+        $loader = new YamlFileLoader(new FileLocator([__DIR__.'/../Fixtures']));
+        $routes = $loader->load('custom_compiler_class.yml');
+
+        $this->assertCount(2, $routes);
+
+        $expectedRoutes = new RouteCollection();
+        $expectedRoutes->add('some_route', new Route('/'));
+
+        $expectedRoutes->add('custom_compiled_route', $route = new Route('/custom-compilation'));
+        $route->setOption('compiler_class', CustomRouteCompiler::class);
+
+        $expectedRoutes->addResource(new FileResource(__DIR__.'/../Fixtures/custom_compiler_class.yml'));
+
+        $this->assertEquals($expectedRoutes, $routes);
+    }
+
+    public function testLoadingUtf8Route()
+    {
+        $loader = new YamlFileLoader(new FileLocator([__DIR__.'/../Fixtures/localized']));
+        $routes = $loader->load('utf8.yml');
+
+        $this->assertCount(2, $routes);
+
+        $expectedRoutes = new RouteCollection();
+        $expectedRoutes->add('some_route', new Route('/'));
+
+        $expectedRoutes->add('some_utf8_route', $route = new Route('/utf8'));
+        $route->setOption('utf8', true);
+
+        $expectedRoutes->addResource(new FileResource(__DIR__.'/../Fixtures/localized/utf8.yml'));
+
+        $this->assertEquals($expectedRoutes, $routes);
+    }
+
     public function testLoadingLocalizedRoute()
     {
         $loader = new YamlFileLoader(new FileLocator([__DIR__.'/../Fixtures/localized']));

Original file line number	Diff line number	Diff line change
`@@ -311,6 +311,12 @@ private function parseConfigs(\DOMElement $node, $path)`
`311`	`311`
`312`	`312`	`$defaults['_controller'] = $controller;`
`313`	`313`	`}`
	`314`	`+ if ($node->hasAttribute('compiler-class')) {`
	`315`	`+ $options['compiler_class'] = trim($node->getAttribute('compiler-class'));`
	`316`	`+ }`
	`317`	`+ if ($node->hasAttribute('utf8')) {`
	`318`	`+ $options['utf8'] = XmlUtils::phpize($node->getAttribute('utf8'));`
	`319`	`+ }`
`314`	`320`
`315`	`321`	`return [$defaults, $requirements, $options, $condition, $paths, $prefixes];`
`316`	`322`	`}`