Allowing prototype/PSR4 service loading ability to exclude, because glob doesn't support this
This commit is contained in:
parent
489fd0784b
commit
7d07f19459
@ -47,8 +47,9 @@ abstract class FileLoader extends BaseFileLoader
|
|||||||
* @param Definition $prototype A definition to use as template
|
* @param Definition $prototype A definition to use as template
|
||||||
* @param string $namespace The namespace prefix of classes in the scanned directory
|
* @param string $namespace The namespace prefix of classes in the scanned directory
|
||||||
* @param string $resource The directory to look for classes, glob-patterns allowed
|
* @param string $resource The directory to look for classes, glob-patterns allowed
|
||||||
|
* @param string $exclude A globed path of files to exclude
|
||||||
*/
|
*/
|
||||||
public function registerClasses(Definition $prototype, $namespace, $resource)
|
public function registerClasses(Definition $prototype, $namespace, $resource, $exclude = null)
|
||||||
{
|
{
|
||||||
if ('\\' !== substr($namespace, -1)) {
|
if ('\\' !== substr($namespace, -1)) {
|
||||||
throw new InvalidArgumentException(sprintf('Namespace prefix must end with a "\\": %s.', $namespace));
|
throw new InvalidArgumentException(sprintf('Namespace prefix must end with a "\\": %s.', $namespace));
|
||||||
@ -57,7 +58,7 @@ abstract class FileLoader extends BaseFileLoader
|
|||||||
throw new InvalidArgumentException(sprintf('Namespace is not a valid PSR-4 prefix: %s.', $namespace));
|
throw new InvalidArgumentException(sprintf('Namespace is not a valid PSR-4 prefix: %s.', $namespace));
|
||||||
}
|
}
|
||||||
|
|
||||||
$classes = $this->findClasses($namespace, $resource);
|
$classes = $this->findClasses($namespace, $resource, $exclude);
|
||||||
// prepare for deep cloning
|
// prepare for deep cloning
|
||||||
$prototype = serialize($prototype);
|
$prototype = serialize($prototype);
|
||||||
|
|
||||||
@ -84,9 +85,24 @@ abstract class FileLoader extends BaseFileLoader
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private function findClasses($namespace, $pattern)
|
private function findClasses($namespace, $pattern, $excludePattern)
|
||||||
{
|
{
|
||||||
$parameterBag = $this->container->getParameterBag();
|
$parameterBag = $this->container->getParameterBag();
|
||||||
|
|
||||||
|
$excludePaths = array();
|
||||||
|
$excludePrefix = null;
|
||||||
|
if ($excludePattern) {
|
||||||
|
$excludePattern = $parameterBag->unescapeValue($parameterBag->resolveValue($excludePattern));
|
||||||
|
foreach ($this->glob($excludePattern, true, $resource) as $path => $info) {
|
||||||
|
if (null === $excludePrefix) {
|
||||||
|
$excludePrefix = $resource->getPrefix();
|
||||||
|
}
|
||||||
|
|
||||||
|
// normalize Windows slashes
|
||||||
|
$excludePaths[str_replace('\\', '/', $path)] = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
$pattern = $parameterBag->unescapeValue($parameterBag->resolveValue($pattern));
|
$pattern = $parameterBag->unescapeValue($parameterBag->resolveValue($pattern));
|
||||||
$classes = array();
|
$classes = array();
|
||||||
$extRegexp = defined('HHVM_VERSION') ? '/\\.(?:php|hh)$/' : '/\\.php$/';
|
$extRegexp = defined('HHVM_VERSION') ? '/\\.(?:php|hh)$/' : '/\\.php$/';
|
||||||
@ -94,6 +110,14 @@ abstract class FileLoader extends BaseFileLoader
|
|||||||
foreach ($this->glob($pattern, true, $resource) as $path => $info) {
|
foreach ($this->glob($pattern, true, $resource) as $path => $info) {
|
||||||
if (null === $prefixLen) {
|
if (null === $prefixLen) {
|
||||||
$prefixLen = strlen($resource->getPrefix());
|
$prefixLen = strlen($resource->getPrefix());
|
||||||
|
|
||||||
|
if ($excludePrefix && strpos($excludePrefix, $resource->getPrefix()) !== 0) {
|
||||||
|
throw new InvalidArgumentException(sprintf('Invalid "exclude" pattern when importing classes for "%s": make sure your "exclude" pattern (%s) is a subset of the "resource" pattern (%s)', $namespace, $excludePattern, $pattern));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isset($excludePaths[str_replace('\\', '/', $path)])) {
|
||||||
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!preg_match($extRegexp, $path, $m) || !$info->isReadable()) {
|
if (!preg_match($extRegexp, $path, $m) || !$info->isReadable()) {
|
||||||
|
@ -143,7 +143,7 @@ class XmlFileLoader extends FileLoader
|
|||||||
foreach ($services as $service) {
|
foreach ($services as $service) {
|
||||||
if (null !== $definition = $this->parseDefinition($service, $file, $defaults)) {
|
if (null !== $definition = $this->parseDefinition($service, $file, $defaults)) {
|
||||||
if ('prototype' === $service->tagName) {
|
if ('prototype' === $service->tagName) {
|
||||||
$this->registerClasses($definition, (string) $service->getAttribute('namespace'), (string) $service->getAttribute('resource'));
|
$this->registerClasses($definition, (string) $service->getAttribute('namespace'), (string) $service->getAttribute('resource'), (string) $service->getAttribute('exclude'));
|
||||||
} else {
|
} else {
|
||||||
$this->setDefinition((string) $service->getAttribute('id'), $definition);
|
$this->setDefinition((string) $service->getAttribute('id'), $definition);
|
||||||
}
|
}
|
||||||
|
@ -61,6 +61,7 @@ class YamlFileLoader extends FileLoader
|
|||||||
|
|
||||||
private static $prototypeKeywords = array(
|
private static $prototypeKeywords = array(
|
||||||
'resource' => 'resource',
|
'resource' => 'resource',
|
||||||
|
'exclude' => 'exclude',
|
||||||
'parent' => 'parent',
|
'parent' => 'parent',
|
||||||
'shared' => 'shared',
|
'shared' => 'shared',
|
||||||
'lazy' => 'lazy',
|
'lazy' => 'lazy',
|
||||||
@ -528,7 +529,8 @@ class YamlFileLoader extends FileLoader
|
|||||||
if (!is_string($service['resource'])) {
|
if (!is_string($service['resource'])) {
|
||||||
throw new InvalidArgumentException(sprintf('A "resource" attribute must be of type string for service "%s" in %s. Check your YAML syntax.', $id, $file));
|
throw new InvalidArgumentException(sprintf('A "resource" attribute must be of type string for service "%s" in %s. Check your YAML syntax.', $id, $file));
|
||||||
}
|
}
|
||||||
$this->registerClasses($definition, $id, $service['resource']);
|
$exclude = isset($service['exclude']) ? $service['exclude'] : null;
|
||||||
|
$this->registerClasses($definition, $id, $service['resource'], $exclude);
|
||||||
} else {
|
} else {
|
||||||
$this->setDefinition($id, $definition);
|
$this->setDefinition($id, $definition);
|
||||||
}
|
}
|
||||||
|
@ -161,6 +161,7 @@
|
|||||||
</xsd:choice>
|
</xsd:choice>
|
||||||
<xsd:attribute name="namespace" type="xsd:string" use="required" />
|
<xsd:attribute name="namespace" type="xsd:string" use="required" />
|
||||||
<xsd:attribute name="resource" type="xsd:string" use="required" />
|
<xsd:attribute name="resource" type="xsd:string" use="required" />
|
||||||
|
<xsd:attribute name="exclude" type="xsd:string" />
|
||||||
<xsd:attribute name="shared" type="boolean" />
|
<xsd:attribute name="shared" type="boolean" />
|
||||||
<xsd:attribute name="public" type="boolean" />
|
<xsd:attribute name="public" type="boolean" />
|
||||||
<xsd:attribute name="lazy" type="boolean" />
|
<xsd:attribute name="lazy" type="boolean" />
|
||||||
|
@ -0,0 +1,7 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\OtherDir\AnotherSub;
|
||||||
|
|
||||||
|
class DeeperBaz
|
||||||
|
{
|
||||||
|
}
|
@ -0,0 +1,7 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\OtherDir;
|
||||||
|
|
||||||
|
class Baz
|
||||||
|
{
|
||||||
|
}
|
@ -1,6 +1,6 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
|
<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
|
||||||
<services>
|
<services>
|
||||||
<prototype namespace="Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\" resource="../Prototype/*" />
|
<prototype namespace="Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\" resource="../Prototype/*" exclude="../Prototype/{OtherDir}" />
|
||||||
</services>
|
</services>
|
||||||
</container>
|
</container>
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
services:
|
services:
|
||||||
Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\:
|
Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\:
|
||||||
resource: ../Prototype
|
resource: ../Prototype
|
||||||
|
exclude: '../Prototype/{OtherDir}'
|
||||||
|
@ -16,12 +16,15 @@ use Symfony\Component\Config\FileLocator;
|
|||||||
use Symfony\Component\Config\Loader\LoaderResolver;
|
use Symfony\Component\Config\Loader\LoaderResolver;
|
||||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||||||
use Symfony\Component\DependencyInjection\Definition;
|
use Symfony\Component\DependencyInjection\Definition;
|
||||||
|
use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
|
||||||
use Symfony\Component\DependencyInjection\Loader\FileLoader;
|
use Symfony\Component\DependencyInjection\Loader\FileLoader;
|
||||||
use Symfony\Component\DependencyInjection\Loader\IniFileLoader;
|
use Symfony\Component\DependencyInjection\Loader\IniFileLoader;
|
||||||
use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
|
use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
|
||||||
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
|
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
|
||||||
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
|
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
|
||||||
use Symfony\Component\DependencyInjection\Reference;
|
use Symfony\Component\DependencyInjection\Reference;
|
||||||
|
use Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\OtherDir\AnotherSub\DeeperBaz;
|
||||||
|
use Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\OtherDir\Baz;
|
||||||
use Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\Sub\Bar;
|
use Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\Sub\Bar;
|
||||||
|
|
||||||
class FileLoaderTest extends TestCase
|
class FileLoaderTest extends TestCase
|
||||||
@ -90,6 +93,26 @@ class FileLoaderTest extends TestCase
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function testRegisterClassesWithExclude()
|
||||||
|
{
|
||||||
|
$container = new ContainerBuilder();
|
||||||
|
$container->setParameter('other_dir', 'OtherDir');
|
||||||
|
$loader = new TestFileLoader($container, new FileLocator(self::$fixturesPath.'/Fixtures'));
|
||||||
|
|
||||||
|
$loader->registerClasses(
|
||||||
|
new Definition(),
|
||||||
|
'Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\\',
|
||||||
|
'Prototype/*',
|
||||||
|
// load everything, except OtherDir/AnotherSub & Foo.php
|
||||||
|
'Prototype/{%other_dir%/AnotherSub,Foo.php}'
|
||||||
|
);
|
||||||
|
|
||||||
|
$this->assertTrue($container->has(Bar::class));
|
||||||
|
$this->assertTrue($container->has(Baz::class));
|
||||||
|
$this->assertFalse($container->has(Foo::class));
|
||||||
|
$this->assertFalse($container->has(DeeperBaz::class));
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
|
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
|
||||||
* @expectedExceptionMessageRegExp /Expected to find class "Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\Prototype\\Bar" in file ".+" while importing services from resource "Prototype\/Sub\/\*", but it was not found\! Check the namespace prefix used with the resource/
|
* @expectedExceptionMessageRegExp /Expected to find class "Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\Prototype\\Bar" in file ".+" while importing services from resource "Prototype\/Sub\/\*", but it was not found\! Check the namespace prefix used with the resource/
|
||||||
@ -102,6 +125,35 @@ class FileLoaderTest extends TestCase
|
|||||||
// the Sub is missing from namespace prefix
|
// the Sub is missing from namespace prefix
|
||||||
$loader->registerClasses(new Definition(), 'Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\\', 'Prototype/Sub/*');
|
$loader->registerClasses(new Definition(), 'Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\\', 'Prototype/Sub/*');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @dataProvider getIncompatibleExcludeTests
|
||||||
|
*/
|
||||||
|
public function testRegisterClassesWithIncompatibleExclude($resourcePattern, $excludePattern)
|
||||||
|
{
|
||||||
|
$container = new ContainerBuilder();
|
||||||
|
$loader = new TestFileLoader($container, new FileLocator(self::$fixturesPath.'/Fixtures'));
|
||||||
|
|
||||||
|
try {
|
||||||
|
$loader->registerClasses(
|
||||||
|
new Definition(),
|
||||||
|
'Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\\',
|
||||||
|
$resourcePattern,
|
||||||
|
$excludePattern
|
||||||
|
);
|
||||||
|
} catch (InvalidArgumentException $e) {
|
||||||
|
$this->assertEquals(
|
||||||
|
sprintf('Invalid "exclude" pattern when importing classes for "Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype\": make sure your "exclude" pattern (%s) is a subset of the "resource" pattern (%s)', $excludePattern, $resourcePattern),
|
||||||
|
$e->getMessage()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getIncompatibleExcludeTests()
|
||||||
|
{
|
||||||
|
yield array('Prototype/*', 'yaml/*', false);
|
||||||
|
yield array('Prototype/OtherDir/*', 'Prototype/*', false);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class TestFileLoader extends FileLoader
|
class TestFileLoader extends FileLoader
|
||||||
|
Reference in New Issue
Block a user