-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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 | ||
* | ||
* @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'); | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
<?php | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. licence header is missing There was a problem hiding this comment. Choose a reason for hiding this commentThe 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); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 ? There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
||
$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) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. use {@inheritdoc} There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
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'); | ||
} | ||
} |
There was a problem hiding this comment.
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