Merge branch '4.4'

* 4.4: (39 commits)
  [Console] Fix #33915, Detect dimensions using mode CON if vt100 is supported
  [PhpUnitBridge] Also search for composer.phar in git root folder
  [HttpKernel][DataCollectorInterface] Ease compatibility
  Add tests to ensure defaultLocale is properly passed to the URL generator
  [DependencyInjection] Fix broken references in tests
  [VarDumper] display the method we're in when dumping stack traces
  [HttpClient] Retry safe requests when then fail before the body arrives
  [Console] Rename some methods related to redraw frequency
  Avoid using of kernel after shutdown
  Simplify PHP CS Fixer configuration
  [PropertyInfo] Fixed type extraction for nullable collections of non-nullable elements
  [FrameworkBundle] [HttpKernel] fixed correct EOL and EOM month
  Fix CS
  [Serializer] Fix property name usage for denormalization
  Name test accordingly to the tested class
  Fix MockFileSessionStorageTest::sessionDir being used after it's unset
  [Security] Fix SwitchUserToken wrongly deauthenticated
  Supporting Bootstrap 4 custom switches
  Add new Form WeekType
  bumped Symfony version to 4.3.7
  ...

Author: nicolas-grekas

CHANGELOG.md

@@ -15,6 +15,7 @@ CHANGELOG
 
  * Deprecated `ServiceRouterLoader` in favor of `ContainerLoader`.
  * Deprecated `ObjectRouteLoader` in favor of `ObjectLoader`.
+ * Added a way to exclude patterns of resources from being imported by the `import()` method
 
 4.3.0
 -----

Loader/Configurator/RoutingConfigurator.php

@@ -33,11 +33,14 @@ public function __construct(RouteCollection $collection, PhpFileLoader $loader,
         $this->file = $file;
     }
 
-    final public function import($resource, string $type = null, bool $ignoreErrors = false): ImportConfigurator
+    /**
+     * @param string|string[]|null $exclude Glob patterns to exclude from the import
+     */
+    final public function import($resource, string $type = null, bool $ignoreErrors = false, $exclude = null): ImportConfigurator
     {
         $this->loader->setCurrentDir(\dirname($this->path));
-        $imported = $this->loader->import($resource, $type, $ignoreErrors, $this->file) ?: [];
 
+        $imported = $this->loader->import($resource, $type, $ignoreErrors, $this->file, $exclude) ?: [];
         if (!\is_array($imported)) {
             return new ImportConfigurator($this->collection, $imported);
         }

Loader/XmlFileLoader.php

@@ -163,10 +163,24 @@ protected function parseImport(RouteCollection $collection, \DOMElement $node, s
             throw new \InvalidArgumentException(sprintf('The <route> element in file "%s" must not have both a "prefix" attribute and <prefix> child nodes.', $path));
         }
 
+        $exclude = [];
+        foreach ($node->childNodes as $child) {
+            if ($child instanceof \DOMElement && $child->localName === $exclude && self::NAMESPACE_URI === $child->namespaceURI) {
+                $exclude[] = $child->nodeValue;
+            }
+        }
+
+        if ($node->hasAttribute('exclude')) {
+            if ($exclude) {
+                throw new \InvalidArgumentException('You cannot use both the attribute "exclude" and <exclude> tags at the same time.');
+            }
+            $exclude = [$node->getAttribute('exclude')];
+        }
+
         $this->setCurrentDir(\dirname($path));
 
         /** @var RouteCollection[] $imported */
-        $imported = $this->import($resource, ('' !== $type ? $type : null), false, $file) ?: [];
+        $imported = $this->import($resource, ('' !== $type ? $type : null), false, $file, $exclude) ?: [];
 
         if (!\is_array($imported)) {
             $imported = [$imported];

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', 'locale', 'format', 'utf8',
+        'resource', 'type', 'prefix', 'path', 'host', 'schemes', 'methods', 'defaults', 'requirements', 'options', 'condition', 'controller', 'name_prefix', 'trailing_slash_on_root', 'locale', 'format', 'utf8', 'exclude',
     ];
     private $yamlParser;
 
@@ -169,6 +169,7 @@ protected function parseImport(RouteCollection $collection, array $config, strin
         $schemes = isset($config['schemes']) ? $config['schemes'] : null;
         $methods = isset($config['methods']) ? $config['methods'] : null;
         $trailingSlashOnRoot = $config['trailing_slash_on_root'] ?? true;
+        $exclude = $config['exclude'] ?? null;
 
         if (isset($config['controller'])) {
             $defaults['_controller'] = $config['controller'];
@@ -185,7 +186,7 @@ protected function parseImport(RouteCollection $collection, array $config, strin
 
         $this->setCurrentDir(\dirname($path));
 
-        $imported = $this->import($config['resource'], $type, false, $file) ?: [];
+        $imported = $this->import($config['resource'], $type, false, $file, $exclude) ?: [];
 
         if (!\is_array($imported)) {
             $imported = [$imported];

Loader/schema/routing/routing-1.0.xsd

@@ -61,9 +61,11 @@
     <xsd:sequence maxOccurs="unbounded" minOccurs="0">
       <xsd:group ref="configs" minOccurs="0" maxOccurs="unbounded" />
       <xsd:element name="prefix" type="localized-path" minOccurs="0" maxOccurs="unbounded" />
+      <xsd:element name="exclude" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
     </xsd:sequence>
     <xsd:attribute name="resource" type="xsd:string" use="required" />
     <xsd:attribute name="type" type="xsd:string" />
+    <xsd:attribute name="exclude" type="xsd:string" />
     <xsd:attribute name="prefix" type="xsd:string" />
     <xsd:attribute name="name-prefix" type="xsd:string" />
     <xsd:attribute name="host" type="xsd:string" />

Router.php

@@ -325,7 +325,7 @@ function (ConfigCacheInterface $cache) {
                 }
             );
 
-            $this->generator = new $this->options['generator_class'](require $cache->getPath(), $this->context, $this->logger);
+            $this->generator = new $this->options['generator_class'](require $cache->getPath(), $this->context, $this->logger, $this->defaultLocale);
         }
 
         if ($this->generator instanceof ConfigurableRequirementsInterface) {

Tests/Loader/GlobFileLoaderTest.php

@@ -38,7 +38,7 @@ public function testLoadAddsTheGlobResourceToTheContainer()
 
 class GlobFileLoaderWithoutImport extends GlobFileLoader
 {
-    public function import($resource, string $type = null, bool $ignoreErrors = false, string $sourceResource = null)
+    public function import($resource, string $type = null, bool $ignoreErrors = false, string $sourceResource = null, $exclude = null)
     {
         return new RouteCollection();
     }

Tests/RouterTest.php

@@ -22,10 +22,26 @@ class RouterTest extends TestCase
 
     private $loader = null;
 
+    private $cacheDir;
+
     protected function setUp(): void
     {
         $this->loader = $this->getMockBuilder('Symfony\Component\Config\Loader\LoaderInterface')->getMock();
         $this->router = new Router($this->loader, 'routing.yml');
+
+        $this->cacheDir = sys_get_temp_dir().\DIRECTORY_SEPARATOR.uniqid('router_', true);
+    }
+
+    protected function tearDown(): void
+    {
+        if (is_dir($this->cacheDir)) {
+            array_map('unlink', glob($this->cacheDir.\DIRECTORY_SEPARATOR.'*'));
+            rmdir($this->cacheDir);
+        }
+
+        $this->loader = null;
+        $this->router = null;
+        $this->cacheDir = null;
     }
 
     public function testSetOptionsWithSupportedOptions()
@@ -132,4 +148,44 @@ public function testMatchRequestWithRequestMatcherInterface()
 
         $this->router->matchRequest(Request::create('/'));
     }
+
+    public function testDefaultLocaleIsPassedToGeneratorClass()
+    {
+        $this->loader->expects($this->once())
+            ->method('load')->with('routing.yml', null)
+            ->willReturn(new RouteCollection());
+
+        $router = new Router($this->loader, 'routing.yml', [
+            'cache_dir' => null,
+        ], null, null, 'hr');
+
+        $generator = $router->getGenerator();
+
+        $this->assertInstanceOf('Symfony\Component\Routing\Generator\UrlGeneratorInterface', $generator);
+
+        $p = new \ReflectionProperty($generator, 'defaultLocale');
+        $p->setAccessible(true);
+
+        $this->assertSame('hr', $p->getValue($generator));
+    }
+
+    public function testDefaultLocaleIsPassedToCompiledGeneratorCacheClass()
+    {
+        $this->loader->expects($this->once())
+            ->method('load')->with('routing.yml', null)
+            ->willReturn(new RouteCollection());
+
+        $router = new Router($this->loader, 'routing.yml', [
+            'cache_dir' => $this->cacheDir,
+        ], null, null, 'hr');
+
+        $generator = $router->getGenerator();
+
+        $this->assertInstanceOf('Symfony\Component\Routing\Generator\UrlGeneratorInterface', $generator);
+
+        $p = new \ReflectionProperty($generator, 'defaultLocale');
+        $p->setAccessible(true);
+
+        $this->assertSame('hr', $p->getValue($generator));
+    }
 }