[Config] Code review changes

jschaedl · jschaedl · commit d4d7328bb581 · 2019-04-28T11:38:42.000+02:00
- added class and methods docs
- fixed code style
- finalzed tests
diff --git a/src/Symfony/Component/Config/Definition/Builder/NodeFinder.php b/src/Symfony/Component/Config/Definition/Builder/NodeFinder.php
@@ -12,45 +12,44 @@
 namespace Symfony\Component\Config\Definition\Builder;
 
 /**
+ * This class finds nodes in a node tree.
+ *
  * @author Jan Schädlich <jan.schaedlich@sensiolabs.de>
  */
 class NodeFinder
 {
-    public function find(string $nodePath, NodeDefinition $rootNode)
+    /**
+     * Finds a node defined by $nodePath within the given $rootNode.
+     *
+     * @param string         $nodePath The path of the node to find. e.g "doctrine.orm.mappings"
+     * @param NodeDefinition $rootNode
+     *
+     * @return NodeDefinition
+     */
+    public function find($nodePath, NodeDefinition $rootNode)
     {
         if (!$rootNode instanceof ArrayNodeDefinition) {
             if ($nodePath !== $rootNode->getName()) {
-                throw new \RuntimeException(
-                    sprintf(
-                        'Node with name "%s" does not exist in the given root node "%s"!',
-                        $nodePath,
-                        $rootNode->getName()
-                    )
-                );
+                throw new \RuntimeException(sprintf('Node with name "%s" does not exist in the given root node "%s"!', $nodePath, $rootNode->getName()));
             }
 
             return $rootNode;
         }
 
         $explodedNodePaths = explode('.', $nodePath);
 
-        if (!array_key_exists($explodedNodePaths[0], $rootNode->getChildNodeDefinitions())) {
-            throw new \RuntimeException(
-                sprintf(
-                    'Node with name "%s" does not exist in the given root node "%s"!',
-                    $explodedNodePaths[0],
-                    $rootNode->getName()
-                )
-            );
+        if (!\array_key_exists($explodedNodePaths[0], $rootNode->getChildNodeDefinitions())) {
+            throw new \RuntimeException(sprintf('Node with name "%s" does not exist in the given root node "%s"!', $explodedNodePaths[0], $rootNode->getName()));
         }
 
         $node = $rootNode->getChildNodeDefinitions()[$explodedNodePaths[0]];
 
-        if (1 === count($explodedNodePaths)) {
+        if (1 === \count($explodedNodePaths)) {
             return $node;
         }
 
         array_shift($explodedNodePaths);
+
         return $this->find(implode('.', $explodedNodePaths), $node);
     }
 }
diff --git a/src/Symfony/Component/Config/Tests/Definition/Builder/NodeFinderTest.php b/src/Symfony/Component/Config/Tests/Definition/Builder/NodeFinderTest.php
@@ -14,18 +14,16 @@
 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\NodeFinder;
 use Symfony\Component\Config\Definition\Builder\ScalarNodeDefinition;
-use Symfony\Component\Config\Definition\Builder\TreeBuilder;
-use Symfony\Component\Config\Tests\Fixtures\Builder\NodeBuilder as CustomNodeBuilder;
-use Symfony\Component\Config\Tests\Fixtures\Builder\VariableNodeDefinition;
 
 /**
  * @author Jan Schädlich <jan.schaedlich@sensiolabs.de>
  */
 class NodeFinderTest extends TestCase
 {
-    public function testOne()
+    public function testItShouldFindRootNode()
     {
         $rootNode = new ScalarNodeDefinition('root');
 
@@ -35,7 +33,34 @@ public function testOne()
         $this->assertSame('root', $foundNode->getName());
     }
 
-    public function testTwo()
+    public function testItShouldThrowExceptionIfNodeDoesNotExistInScalarRootNode()
+    {
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage('Node with name "child" does not exist in the given root node "root"!');
+
+        $rootNode = new ScalarNodeDefinition('root');
+
+        $nodeFinder = new NodeFinder();
+        $nodeFinder->find('child', $rootNode);
+    }
+
+    public function testItShouldThrowExceptionIfNodeDoesNotExistInArrayRootNode()
+    {
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage('Node with name "child" does not exist in the given root node "root"!');
+
+        $rootNode = new ArrayNodeDefinition('root');
+        $rootNode
+            ->children()
+                ->arrayNode('social_media_channels')->end()
+            ->end()
+        ;
+
+        $nodeFinder = new NodeFinder();
+        $nodeFinder->find('child', $rootNode);
+    }
+
+    public function testItShouldHandleComplexConfigurationProbably()
     {
         $rootNode = new ArrayNodeDefinition('root');
         $rootNode
@@ -58,22 +83,32 @@ public function testTwo()
         $nodeFinder = new NodeFinder();
 
         $socialMediaChannelsNode = $nodeFinder->find('social_media_channels', $rootNode);
-        $this->assertSame('social_media_channels', $socialMediaChannelsNode->getName());
-        $this->assertInstanceOf(ArrayNodeDefinition::class, $socialMediaChannelsNode);
-
         $socialMediaChannelsEnableNode = $nodeFinder->find('social_media_channels.enable', $rootNode);
-        $this->assertSame('enable', $socialMediaChannelsEnableNode->getName());
-        $this->assertInstanceOf(BooleanNodeDefinition::class, $socialMediaChannelsEnableNode);
-
 
+        $twitterNode = $nodeFinder->find('social_media_channels.twitter', $rootNode);
+        $facebookNode = $nodeFinder->find('social_media_channels.facebook', $rootNode);
+        $instagramNode = $nodeFinder->find('social_media_channels.instagram', $rootNode);
+        $instagramEnableNode = $nodeFinder->find('social_media_channels.instagram.enable', $rootNode);
+        $instagramAccountsNode = $nodeFinder->find('social_media_channels.instagram.accounts', $rootNode);
 
-        $this->assertSame('twitter', $nodeFinder->find('social_media_channels.twitter', $rootNode)->getName());
-        $this->assertSame('facebook', $nodeFinder->find('social_media_channels.facebook', $rootNode)->getName());
+        $this->assertNode($socialMediaChannelsNode, 'social_media_channels', ArrayNodeDefinition::class);
+        $this->assertNode($socialMediaChannelsEnableNode, 'enable', BooleanNodeDefinition::class);
 
-        $this->assertSame('instagram', $nodeFinder->find('social_media_channels.instagram', $rootNode)->getName());
-        $this->assertSame('enable', $nodeFinder->find('social_media_channels.instagram.enable', $rootNode)->getName());
-        $this->assertSame('accounts', $nodeFinder->find('social_media_channels.instagram.accounts', $rootNode)->getName());
+        $this->assertNode($twitterNode, 'twitter', ArrayNodeDefinition::class);
+        $this->assertNode($facebookNode, 'facebook', ArrayNodeDefinition::class);
+        $this->assertNode($instagramNode, 'instagram', ArrayNodeDefinition::class);
+        $this->assertNode($instagramEnableNode, 'enable', BooleanNodeDefinition::class);
+        $this->assertNode($instagramAccountsNode, 'accounts', ArrayNodeDefinition::class);
     }
 
-
+    /**
+     * @param NodeDefinition $actualNode
+     * @param string         $expectedName
+     * @param string         $expectedType
+     */
+    private function assertNode(NodeDefinition $actualNode, $expectedName, $expectedType)
+    {
+        $this->assertSame($expectedName, $actualNode->getName());
+        $this->assertInstanceOf($expectedType, $actualNode);
+    }
 }
