Skip to content

[Config] Introduce find method in ArrayNodeDefinition to ease configuration tree manipulation #31287

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 14, 2019
Merged

[Config] Introduce find method in ArrayNodeDefinition to ease configuration tree manipulation #31287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions src/Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,4 +523,26 @@ public function getChildNodeDefinitions()
{
return $this->children;
}

/**
* Finds a node defined by the given $nodePath.
*
* @param string $nodePath The path of the node to find. e.g "doctrine.orm.mappings"
*/
public function find(string $nodePath): NodeDefinition
{
$firstPathSegment = (false === $pathSeparatorPos = strpos($nodePath, $this->pathSeparator))
? $nodePath
: substr($nodePath, 0, $pathSeparatorPos);

if (null === $node = ($this->children[$firstPathSegment] ?? null)) {
throw new \RuntimeException(sprintf('Node with name "%s" does not exist in the current node "%s".', $firstPathSegment, $this->name));
}

if (false === $pathSeparatorPos) {
return $node;
}

return $node->find(substr($nodePath, $pathSeparatorPos + \strlen($this->pathSeparator)));
}
}
81 changes: 81 additions & 0 deletions src/Symfony/Component/Config/Tests/Definition/Builder/ArrayNodeDefinitionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

use PHPUnit\Framework\TestCase;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\BooleanNodeDefinition;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\Config\Definition\Builder\ScalarNodeDefinition;
use Symfony\Component\Config\Definition\Exception\InvalidDefinitionException;
use Symfony\Component\Config\Definition\Processor;
Expand Down Expand Up @@ -357,6 +359,85 @@ public function testCannotBeEmptyOnConcreteNode()
$node->getNode()->finalize([]);
}

public function testFindShouldThrowExceptionIfNodeDoesNotExistInRootNode()
{
$this->expectException(\RuntimeException::class);
$this->expectExceptionMessage('Node with name "child" does not exist in the current node "root".');

$rootNode = new ArrayNodeDefinition('root');
$rootNode
->children()
->arrayNode('social_media_channels')->end()
->end()
;

$rootNode->find('child');
}

public function testFindShouldHandleComplexConfigurationProperly()
{
$rootNode = new ArrayNodeDefinition('root');
$rootNode
->children()
->arrayNode('social_media_channels')
->children()
->booleanNode('enable')->end()
->arrayNode('twitter')->end()
->arrayNode('facebook')->end()
->arrayNode('instagram')
->children()
->booleanNode('enable')->end()
->arrayNode('accounts')->end()
->end()
->end()
->end()
->append(
$mailerNode = (new ArrayNodeDefinition('mailer'))
->children()
->booleanNode('enable')->end()
->arrayNode('transports')->end()
->end()
)
->end()
;

$this->assertNode('social_media_channels', ArrayNodeDefinition::class, $rootNode->find('social_media_channels'));
$this->assertNode('enable', BooleanNodeDefinition::class, $rootNode->find('social_media_channels.enable'));
$this->assertNode('twitter', ArrayNodeDefinition::class, $rootNode->find('social_media_channels.twitter'));
$this->assertNode('facebook', ArrayNodeDefinition::class, $rootNode->find('social_media_channels.facebook'));
$this->assertNode('instagram', ArrayNodeDefinition::class, $rootNode->find('social_media_channels.instagram'));
$this->assertNode('enable', BooleanNodeDefinition::class, $rootNode->find('social_media_channels.instagram.enable'));
$this->assertNode('accounts', ArrayNodeDefinition::class, $rootNode->find('social_media_channels.instagram.accounts'));

$this->assertNode('enable', BooleanNodeDefinition::class, $mailerNode->find('enable'));
$this->assertNode('transports', ArrayNodeDefinition::class, $mailerNode->find('transports'));
}

public function testFindShouldWorkProperlyForNonDefaultPathSeparator()
{
$rootNode = new ArrayNodeDefinition('root');
$rootNode
->setPathSeparator('.|')
->children()
->arrayNode('mailer.configuration')
->children()
->booleanNode('enable')->end()
->arrayNode('transports')->end()
->end()
->end()
;

$this->assertNode('mailer.configuration', ArrayNodeDefinition::class, $rootNode->find('mailer.configuration'));
$this->assertNode('enable', BooleanNodeDefinition::class, $rootNode->find('mailer.configuration.|enable'));
$this->assertNode('transports', ArrayNodeDefinition::class, $rootNode->find('mailer.configuration.|transports'));
}

protected function assertNode(string $expectedName, string $expectedType, NodeDefinition $actualNode): void
{
$this->assertInstanceOf($expectedType, $actualNode);
$this->assertSame($expectedName, $this->getField($actualNode, 'name'));
}

protected function getField($object, $field)
{
$reflection = new \ReflectionProperty($object, $field);
Expand Down