Skip to content

[DependencyInjection] [Routing] [Config] Recursive directory loading #13246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
<parameter key="routing.loader.xml.class">Symfony\Component\Routing\Loader\XmlFileLoader</parameter>
<parameter key="routing.loader.yml.class">Symfony\Component\Routing\Loader\YamlFileLoader</parameter>
<parameter key="routing.loader.php.class">Symfony\Component\Routing\Loader\PhpFileLoader</parameter>
<parameter key="routing.loader.directory.class">Symfony\Component\Routing\Loader\DirectoryLoader</parameter>
<parameter key="router.options.generator_class">Symfony\Component\Routing\Generator\UrlGenerator</parameter>
<parameter key="router.options.generator_base_class">Symfony\Component\Routing\Generator\UrlGenerator</parameter>
<parameter key="router.options.generator_dumper_class">Symfony\Component\Routing\Generator\Dumper\PhpGeneratorDumper</parameter>
Expand Down Expand Up @@ -45,6 +46,11 @@
<argument type="service" id="file_locator" />
</service>

<service id="routing.loader.directory" class="%routing.loader.directory.class%" public="false">
<tag name="routing.loader" />
<argument type="service" id="file_locator" />
</service>

<service id="routing.loader" class="%routing.loader.class%">
<tag name="monolog.logger" channel="router" />
<argument type="service" id="controller_name_converter" />
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
],
"require": {
"php": ">=5.3.9",
"symfony/dependency-injection" : "~2.6,>=2.6.2",
"symfony/dependency-injection" : "~2.7,>=2.6.2",
"symfony/config" : "~2.4",
"symfony/event-dispatcher": "~2.5|~3.0.0",
"symfony/http-foundation": "~2.4.9|~2.5,>=2.5.4|~3.0.0",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\DependencyInjection\Loader;

use Symfony\Component\Config\Resource\DirectoryResource;

/**
* DirectoryLoader is a recursive loader to go through directories
*
* @author Sebastien Lavoie <seb@wemakecustom.com>
*/
class DirectoryLoader extends FileLoader
{
/**
* {@inheritdoc}
*/
public function load($file, $type = null)
{
$file = rtrim($file, '/');
$path = $this->locator->locate($file);
$this->container->addResource(new DirectoryResource($path));

foreach (scandir($path) as $dir) {
if ($dir[0] !== '.') {
if (is_dir($path.'/'.$dir)) {
$dir .= '/'; // append / to allow recursion
}

$this->setCurrentDir($path);

$this->import($dir, null, false, $path);
}
}
}

/**
* {@inheritdoc}
*/
public function supports($resource, $type = null)
{
if ('directory' === $type) {
return true;
}

if (null === $type) {
return preg_match('/\/$/', $resource) === 1;
}

return false;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
imports:
- { resource: ../recurse/ }
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[parameters]
ini = ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
parameters:
yaml: yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<?php

$container->setParameter('php', 'php');
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\DependencyInjection\Tests\Loader;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
use Symfony\Component\DependencyInjection\Loader\IniFileLoader;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
use Symfony\Component\DependencyInjection\Loader\DirectoryLoader;
use Symfony\Component\Config\Loader\LoaderResolver;
use Symfony\Component\Config\FileLocator;

class DirectoryLoaderTest extends \PHPUnit_Framework_TestCase
{
private static $fixturesPath;

private $container;
private $loader;

public static function setUpBeforeClass()
{
self::$fixturesPath = realpath(__DIR__.'/../Fixtures/');
}

protected function setUp()
{
$locator = new FileLocator(self::$fixturesPath);
$this->container = new ContainerBuilder();
$this->loader = new DirectoryLoader($this->container, $locator);
$resolver = new LoaderResolver(array(
new PhpFileLoader($this->container, $locator),
new IniFileLoader($this->container, $locator),
new YamlFileLoader($this->container, $locator),
$this->loader,
));
$this->loader->setResolver($resolver);
}

public function testDirectoryCanBeLoadedRecursively()
{
$this->loader->load('directory/');
$this->assertEquals(array('ini' => 'ini', 'yaml' => 'yaml', 'php' => 'php'), $this->container->getParameterBag()->all(), '->load() takes a single directory');
}

public function testImports()
{
$this->loader->resolve('directory/import/import.yml')->load('directory/import/import.yml');
$this->assertEquals(array('ini' => 'ini', 'yaml' => 'yaml'), $this->container->getParameterBag()->all(), '->load() takes a single file that imports a directory');
}

/**
* @covers Symfony\Component\DependencyInjection\Loader\DirectoryLoader::__construct
* @covers Symfony\Component\DependencyInjection\Loader\DirectoryLoader::load
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't use @covers in Symfony

*
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The file "foo" does not exist (in:
*/
public function testExceptionIsRaisedWhenDirectoryDoesNotExist()
{
$this->loader->load('foo/');
}

/**
* @covers Symfony\Component\DependencyInjection\Loader\DirectoryLoader::supports
*/
public function testSupports()
{
$loader = new DirectoryLoader(new ContainerBuilder(), new FileLocator());

$this->assertTrue($loader->supports('directory/'), '->supports("directory/") returns true');
$this->assertTrue($loader->supports('directory/', 'directory'), '->supports("directory/", "directory") returns true');
$this->assertFalse($loader->supports('directory'), '->supports("directory") returns false');
$this->assertTrue($loader->supports('directory', 'directory'), '->supports("directory", "directory") returns true');
$this->assertFalse($loader->supports('directory', 'foo'), '->supports("directory, "foo") returns false');
}
}
4 changes: 3 additions & 1 deletion src/Symfony/Component/HttpKernel/Kernel.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
use Symfony\Component\DependencyInjection\Loader\IniFileLoader;
use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
use Symfony\Component\DependencyInjection\Loader\DirectoryLoader;
use Symfony\Component\DependencyInjection\Loader\ClosureLoader;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
Expand Down Expand Up @@ -251,7 +252,7 @@ public function getBundle($name, $first = true)
}

/**
* {@inheritDoc}
* {@inheritdoc}
*
* @throws \RuntimeException if a custom resource is hidden by a resource in a derived bundle
*/
Expand Down Expand Up @@ -716,6 +717,7 @@ protected function getContainerLoader(ContainerInterface $container)
new YamlFileLoader($container, $locator),
new IniFileLoader($container, $locator),
new PhpFileLoader($container, $locator),
new DirectoryLoader($container, $locator),
new ClosureLoader($container),
));

Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/HttpKernel/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"symfony/expression-language": "~2.4|~3.0.0",
"symfony/finder": "~2.0,>=2.0.5|~3.0.0",
"symfony/process": "~2.0,>=2.0.5|~3.0.0",
"symfony/routing": "~2.2|~3.0.0",
"symfony/routing": "~2.7|~3.0.0",
"symfony/stopwatch": "~2.3|~3.0.0",
"symfony/templating": "~2.2|~3.0.0",
"symfony/translation": "~2.0,>=2.0.5|~3.0.0",
Expand Down
58 changes: 58 additions & 0 deletions src/Symfony/Component/Routing/Loader/DirectoryLoader.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<?php

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

licence header is missing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\Routing\Loader;

use Symfony\Component\Config\Loader\FileLoader;
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Config\Resource\DirectoryResource;

class DirectoryLoader extends FileLoader
{
/**
* {@inheritdoc}
*/
public function load($file, $type = null)
{
$path = $this->locator->locate($file);

$collection = new RouteCollection();
$collection->addResource(new DirectoryResource($path));

foreach (scandir($path) as $dir) {
if ($dir[0] !== '.') {
$this->setCurrentDir($path);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't you need to add the trailing / to allow recursion, as done in the DI component ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I will change it for consistency, but actually no, the Routing DirectoryLoader only activates (and always activates) when the type is set to directory.

$subPath = $path.'/'.$dir;
$subType = null;

if (is_dir($subPath)) {
$subPath .= '/';
$subType = 'directory';
}

$subCollection = $this->import($subPath, $subType, false, $path);
$collection->addCollection($subCollection);
}
}

return $collection;
}

/**
* {@inheritdoc}
*/
public function supports($resource, $type = null)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use {@inheritdoc}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

{
// only when type is forced to directory, not to conflict with AnnotationLoader

return 'directory' === $type;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
route1:
path: /route/1
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
route2:
path: /route/2
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
route3:
path: /route/3
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
_directory:
resource: "../directory"
type: directory
74 changes: 74 additions & 0 deletions src/Symfony/Component/Routing/Tests/Loader/DirectoryLoaderTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\Routing\Tests\Loader;

use Symfony\Component\Routing\Loader\DirectoryLoader;
use Symfony\Component\Routing\Loader\YamlFileLoader;
use Symfony\Component\Routing\Loader\AnnotationFileLoader;
use Symfony\Component\Config\Loader\LoaderResolver;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Routing\RouteCollection;

class DirectoryLoaderTest extends AbstractAnnotationLoaderTest
{
private $loader;
private $reader;

protected function setUp()
{
parent::setUp();

$locator = new FileLocator();
$this->reader = $this->getReader();
$this->loader = new DirectoryLoader($locator);
$resolver = new LoaderResolver(array(
new YamlFileLoader($locator),
new AnnotationFileLoader($locator, $this->getClassLoader($this->reader)),
$this->loader,
));
$this->loader->setResolver($resolver);
}

public function testLoadDirectory()
{
$collection = $this->loader->load(__DIR__.'/../Fixtures/directory', 'directory');
$this->verifyCollection($collection);
}

public function testImportDirectory()
{
$collection = $this->loader->load(__DIR__.'/../Fixtures/directory_import', 'directory');
$this->verifyCollection($collection);
}

private function verifyCollection(RouteCollection $collection)
{
$routes = $collection->all();

$this->assertCount(3, $routes, 'Three routes are loaded');
$this->assertContainsOnly('Symfony\Component\Routing\Route', $routes);

for ($i = 1; $i <= 3; $i++) {
$this->assertSame('/route/'.$i, $routes["route".$i]->getPath());
}
}

public function testSupports()
{
$fixturesDir = __DIR__.'/../Fixtures';

$this->assertFalse($this->loader->supports($fixturesDir), '->supports(*) returns false');

$this->assertTrue($this->loader->supports($fixturesDir, 'directory'), '->supports(*, "directory") returns true');
$this->assertFalse($this->loader->supports($fixturesDir, 'foo'), '->supports(*, "foo") returns false');
}
}