fixed and refactored YamlFileLoader in the same sense as the XmlFileLoader
some nonsesense configs were not validated correctly like an imported resource with a pattern key. added tests for such things too.
This commit is contained in:
parent
392d785d91
commit
237bbd0578
@ -21,13 +21,14 @@ use Symfony\Component\Config\Loader\FileLoader;
|
|||||||
* YamlFileLoader loads Yaml routing files.
|
* YamlFileLoader loads Yaml routing files.
|
||||||
*
|
*
|
||||||
* @author Fabien Potencier <fabien@symfony.com>
|
* @author Fabien Potencier <fabien@symfony.com>
|
||||||
|
* @author Tobias Schultze <http://tobion.de>
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
class YamlFileLoader extends FileLoader
|
class YamlFileLoader extends FileLoader
|
||||||
{
|
{
|
||||||
private static $availableKeys = array(
|
private static $availableKeys = array(
|
||||||
'type', 'resource', 'prefix', 'pattern', 'options', 'defaults', 'requirements', 'hostname_pattern',
|
'resource', 'type', 'prefix', 'pattern', 'hostname_pattern', 'defaults', 'requirements', 'options',
|
||||||
);
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -38,7 +39,7 @@ class YamlFileLoader extends FileLoader
|
|||||||
*
|
*
|
||||||
* @return RouteCollection A RouteCollection instance
|
* @return RouteCollection A RouteCollection instance
|
||||||
*
|
*
|
||||||
* @throws \InvalidArgumentException When route can't be parsed
|
* @throws \InvalidArgumentException When a route can't be parsed because YAML is invalid
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
@ -53,38 +54,19 @@ class YamlFileLoader extends FileLoader
|
|||||||
|
|
||||||
// empty file
|
// empty file
|
||||||
if (null === $config) {
|
if (null === $config) {
|
||||||
$config = array();
|
return $collection;
|
||||||
}
|
}
|
||||||
|
|
||||||
// not an array
|
// not an array
|
||||||
if (!is_array($config)) {
|
if (!is_array($config)) {
|
||||||
throw new \InvalidArgumentException(sprintf('The file "%s" must contain a YAML array.', $file));
|
throw new \InvalidArgumentException(sprintf('The file "%s" must contain a YAML array.', $path));
|
||||||
}
|
}
|
||||||
|
|
||||||
foreach ($config as $name => $config) {
|
foreach ($config as $name => $config) {
|
||||||
$config = $this->normalizeRouteConfig($config);
|
$this->validate($config, $name, $path);
|
||||||
|
|
||||||
if (isset($config['resource'])) {
|
if (isset($config['resource'])) {
|
||||||
$type = isset($config['type']) ? $config['type'] : null;
|
$this->parseImport($collection, $config, $path, $file);
|
||||||
$prefix = isset($config['prefix']) ? $config['prefix'] : '';
|
|
||||||
$defaults = isset($config['defaults']) ? $config['defaults'] : array();
|
|
||||||
$requirements = isset($config['requirements']) ? $config['requirements'] : array();
|
|
||||||
$options = isset($config['options']) ? $config['options'] : array();
|
|
||||||
$hostnamePattern = isset($config['hostname_pattern']) ? $config['hostname_pattern'] : null;
|
|
||||||
|
|
||||||
$this->setCurrentDir(dirname($path));
|
|
||||||
|
|
||||||
$subCollection = $this->import($config['resource'], $type, false, $file);
|
|
||||||
/* @var $subCollection RouteCollection */
|
|
||||||
$subCollection->addPrefix($prefix);
|
|
||||||
if (null !== $hostnamePattern) {
|
|
||||||
$subCollection->setHostnamePattern($hostnamePattern);
|
|
||||||
}
|
|
||||||
$subCollection->addDefaults($defaults);
|
|
||||||
$subCollection->addRequirements($requirements);
|
|
||||||
$subCollection->addOptions($options);
|
|
||||||
|
|
||||||
$collection->addCollection($subCollection);
|
|
||||||
} else {
|
} else {
|
||||||
$this->parseRoute($collection, $name, $config, $path);
|
$this->parseRoute($collection, $name, $config, $path);
|
||||||
}
|
}
|
||||||
@ -109,46 +91,90 @@ class YamlFileLoader extends FileLoader
|
|||||||
* @param RouteCollection $collection A RouteCollection instance
|
* @param RouteCollection $collection A RouteCollection instance
|
||||||
* @param string $name Route name
|
* @param string $name Route name
|
||||||
* @param array $config Route definition
|
* @param array $config Route definition
|
||||||
* @param string $file A Yaml file path
|
* @param string $path Full path of the YAML file being processed
|
||||||
*
|
|
||||||
* @throws \InvalidArgumentException When config pattern is not defined for the given route
|
|
||||||
*/
|
*/
|
||||||
protected function parseRoute(RouteCollection $collection, $name, $config, $file)
|
protected function parseRoute(RouteCollection $collection, $name, array $config, $path)
|
||||||
{
|
{
|
||||||
$defaults = isset($config['defaults']) ? $config['defaults'] : array();
|
$defaults = isset($config['defaults']) ? $config['defaults'] : array();
|
||||||
$requirements = isset($config['requirements']) ? $config['requirements'] : array();
|
$requirements = isset($config['requirements']) ? $config['requirements'] : array();
|
||||||
$options = isset($config['options']) ? $config['options'] : array();
|
$options = isset($config['options']) ? $config['options'] : array();
|
||||||
$hostnamePattern = isset($config['hostname_pattern']) ? $config['hostname_pattern'] : null;
|
$hostnamePattern = isset($config['hostname_pattern']) ? $config['hostname_pattern'] : null;
|
||||||
|
|
||||||
if (!isset($config['pattern'])) {
|
|
||||||
throw new \InvalidArgumentException(sprintf('You must define a "pattern" for the "%s" route.', $name));
|
|
||||||
}
|
|
||||||
|
|
||||||
$route = new Route($config['pattern'], $defaults, $requirements, $options, $hostnamePattern);
|
$route = new Route($config['pattern'], $defaults, $requirements, $options, $hostnamePattern);
|
||||||
|
|
||||||
$collection->add($name, $route);
|
$collection->add($name, $route);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Normalize route configuration.
|
* Parses an import and adds the routes in the resource to the RouteCollection.
|
||||||
*
|
*
|
||||||
* @param array $config A resource config
|
* @param RouteCollection $collection A RouteCollection instance
|
||||||
*
|
* @param array $config Route definition
|
||||||
* @return array
|
* @param string $path Full path of the YAML file being processed
|
||||||
*
|
* @param string $file Loaded file name
|
||||||
* @throws \InvalidArgumentException if one of the provided config keys is not supported
|
|
||||||
*/
|
*/
|
||||||
private function normalizeRouteConfig(array $config)
|
protected function parseImport(RouteCollection $collection, array $config, $path, $file)
|
||||||
{
|
{
|
||||||
foreach ($config as $key => $value) {
|
$type = isset($config['type']) ? $config['type'] : null;
|
||||||
if (!in_array($key, self::$availableKeys)) {
|
$prefix = isset($config['prefix']) ? $config['prefix'] : '';
|
||||||
throw new \InvalidArgumentException(sprintf(
|
$defaults = isset($config['defaults']) ? $config['defaults'] : array();
|
||||||
'Yaml routing loader does not support given key: "%s". Expected one of the (%s).',
|
$requirements = isset($config['requirements']) ? $config['requirements'] : array();
|
||||||
$key, implode(', ', self::$availableKeys)
|
$options = isset($config['options']) ? $config['options'] : array();
|
||||||
));
|
$hostnamePattern = isset($config['hostname_pattern']) ? $config['hostname_pattern'] : null;
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return $config;
|
$this->setCurrentDir(dirname($path));
|
||||||
|
|
||||||
|
$subCollection = $this->import($config['resource'], $type, false, $file);
|
||||||
|
/* @var $subCollection RouteCollection */
|
||||||
|
$subCollection->addPrefix($prefix);
|
||||||
|
if (null !== $hostnamePattern) {
|
||||||
|
$subCollection->setHostnamePattern($hostnamePattern);
|
||||||
|
}
|
||||||
|
$subCollection->addDefaults($defaults);
|
||||||
|
$subCollection->addRequirements($requirements);
|
||||||
|
$subCollection->addOptions($options);
|
||||||
|
|
||||||
|
$collection->addCollection($subCollection);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates the route configuration.
|
||||||
|
*
|
||||||
|
* @param array $config A resource config
|
||||||
|
* @param string $name The config key
|
||||||
|
* @param string $path The loaded file path
|
||||||
|
*
|
||||||
|
* @throws \InvalidArgumentException If one of the provided config keys is not supported,
|
||||||
|
* something is missing or the combination is nonesense
|
||||||
|
*/
|
||||||
|
protected function validate($config, $name, $path)
|
||||||
|
{
|
||||||
|
if (!is_array($config)) {
|
||||||
|
throw new \InvalidArgumentException(sprintf('The definition of "%s" in "%s" must be a YAML array.', $name, $path));
|
||||||
|
}
|
||||||
|
if ($extraKeys = array_diff(array_keys($config), self::$availableKeys)) {
|
||||||
|
throw new \InvalidArgumentException(sprintf(
|
||||||
|
'The routing file "%s" contains unsupport keys for "%s": "%s". Expected one of: "%s".',
|
||||||
|
$path, $name, implode('", "', $extraKeys), implode('", "', self::$availableKeys)
|
||||||
|
));
|
||||||
|
}
|
||||||
|
if (isset($config['resource']) && isset($config['pattern'])) {
|
||||||
|
throw new \InvalidArgumentException(sprintf(
|
||||||
|
'The routing file "%s" must not specify both the "resource" key and the "pattern" key for "%s". Choose between an import and a route definition.',
|
||||||
|
$path, $name
|
||||||
|
));
|
||||||
|
}
|
||||||
|
if (!isset($config['resource']) && isset($config['type'])) {
|
||||||
|
throw new \InvalidArgumentException(sprintf(
|
||||||
|
'The "type" key for the route definition "%s" in "%s" is unsupported. It is only available for imports in combination with the "resource" key.',
|
||||||
|
$name, $path
|
||||||
|
));
|
||||||
|
}
|
||||||
|
if (!isset($config['resource']) && !isset($config['pattern'])) {
|
||||||
|
throw new \InvalidArgumentException(sprintf(
|
||||||
|
'You must define a "pattern" for the route "%s" in file "%s".',
|
||||||
|
$name, $path
|
||||||
|
));
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -0,0 +1,3 @@
|
|||||||
|
blog_show:
|
||||||
|
resource: validpattern.yml
|
||||||
|
pattern: /test
|
@ -0,0 +1,3 @@
|
|||||||
|
blog_show:
|
||||||
|
pattern: /blog/{slug}
|
||||||
|
type: custom
|
@ -0,0 +1 @@
|
|||||||
|
route: string
|
@ -50,29 +50,17 @@ class YamlFileLoaderTest extends \PHPUnit_Framework_TestCase
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @expectedException \InvalidArgumentException
|
* @expectedException \InvalidArgumentException
|
||||||
|
* @dataProvider getPathsToInvalidFiles
|
||||||
*/
|
*/
|
||||||
public function testLoadThrowsExceptionIfNotAnArray()
|
public function testLoadThrowsExceptionWithInvalidFile($filePath)
|
||||||
{
|
{
|
||||||
$loader = new YamlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures')));
|
$loader = new YamlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures')));
|
||||||
$loader->load('nonvalid.yml');
|
$loader->load($filePath);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
public function getPathsToInvalidFiles()
|
||||||
* @expectedException \InvalidArgumentException
|
|
||||||
*/
|
|
||||||
public function testLoadThrowsExceptionIfArrayHasUnsupportedKeys()
|
|
||||||
{
|
{
|
||||||
$loader = new YamlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures')));
|
return array(array('nonvalid.yml'), array('nonvalid2.yml'), array('incomplete.yml'), array('nonvalidkeys.yml'), array('nonesense_resource_plus_path.yml'), array('nonesense_type_without_resource.yml'));
|
||||||
$loader->load('nonvalidkeys.yml');
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @expectedException \InvalidArgumentException
|
|
||||||
*/
|
|
||||||
public function testLoadThrowsExceptionWhenIncomplete()
|
|
||||||
{
|
|
||||||
$loader = new YamlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures')));
|
|
||||||
$loader->load('incomplete.yml');
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public function testLoadSpecialRouteName()
|
public function testLoadSpecialRouteName()
|
||||||
@ -117,13 +105,4 @@ class YamlFileLoaderTest extends \PHPUnit_Framework_TestCase
|
|||||||
$this->assertEquals('bar', $routes['blog_show']->getOption('foo'));
|
$this->assertEquals('bar', $routes['blog_show']->getOption('foo'));
|
||||||
$this->assertEquals('{locale}.example.com', $routes['blog_show']->getHostnamePattern());
|
$this->assertEquals('{locale}.example.com', $routes['blog_show']->getHostnamePattern());
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @expectedException \InvalidArgumentException
|
|
||||||
*/
|
|
||||||
public function testParseRouteThrowsExceptionWithMissingPattern()
|
|
||||||
{
|
|
||||||
$loader = new YamlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures')));
|
|
||||||
$loader->load('incomplete.yml');
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user