Add tests for NodesFactory

Author: mvriel

src/phpDocumentor/Reflection/Php/NodesFactory.php

@@ -16,12 +16,14 @@
 use phpDocumentor\Reflection\NodeVisitor\ElementNameResolver;
 use PhpParser\Node;
 use PhpParser\NodeTraverser;
+use PhpParser\NodeTraverserInterface;
 use PhpParser\NodeVisitor\NameResolver;
 use PhpParser\Parser;
 use PhpParser\ParserFactory;
 
 /**
  * Factory to create a array of nodes from a provided file.
+ *
  * This factory will use PhpParser and NodeTraverser to do the real processing.
  */
 class NodesFactory
@@ -41,14 +43,12 @@ class NodesFactory
     private $traverser;
 
     /**
-     * Initializes the object.
-     *
-     * @param Parser        $parser    used to parse the code
+     * @param Parser $parser used to parse the code
      * @param NodeTraverser $traverser used to do some post processing on the nodes
      */
-    final public function __construct(Parser $parser, NodeTraverser $traverser)
+    final public function __construct(Parser $parser, NodeTraverserInterface $traverser)
     {
-        $this->parser    = $parser;
+        $this->parser = $parser;
         $this->traverser = $traverser;
     }
 
@@ -62,10 +62,11 @@ final public function __construct(Parser $parser, NodeTraverser $traverser)
      */
     public static function createInstance(int $kind = ParserFactory::PREFER_PHP7) : self
     {
-        $parser    = (new ParserFactory())->create($kind);
+        $parser = (new ParserFactory())->create($kind);
         $traverser = new NodeTraverser();
         $traverser->addVisitor(new NameResolver());
         $traverser->addVisitor(new ElementNameResolver());
+
         return new static($parser, $traverser);
     }
 
@@ -78,7 +79,6 @@ public static function createInstance(int $kind = ParserFactory::PREFER_PHP7) :
      */
     public function create(string $code) : array
     {
-        $stmt = $this->parser->parse($code);
-        return $this->traverser->traverse($stmt);
+        return $this->traverser->traverse($this->parser->parse($code));
     }
 }

tests/unit/phpDocumentor/Reflection/Php/NodesFactoryTest.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link http://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\Php;
+
+use phpDocumentor\Reflection\NodeVisitor\ElementNameResolver;
+use PhpParser\NodeTraverser;
+use PhpParser\NodeTraverserInterface;
+use PhpParser\NodeVisitor\NameResolver;
+use PhpParser\Parser;
+use PhpParser\ParserFactory;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @coversDefaultClass \phpDocumentor\Reflection\Php\NodesFactory
+ * @covers ::__construct
+ * @covers ::<private>
+ */
+final class NodesFactoryTest extends TestCase
+{
+    /**
+     * Tests that an instance of the NodesFactory can be made using its static factory method.
+     *
+     * Unfortunately, we cannot actually inspect whether all recommended items were instantiated, so I create an example
+     * NodesFactory containing what I expected and this test will verify that no regression took place.
+     *
+     * @covers ::createInstance
+     */
+    public function testThatAFactoryWithRecommendedComponentsCanBeInstantiated() : void
+    {
+        $factory = NodesFactory::createInstance();
+
+        $this->assertInstanceOf(NodesFactory::class, $factory);
+        $this->assertEquals($this->givenTheExpectedDefaultNodesFactory(), $factory);
+    }
+
+    /**
+     * @covers ::create
+     */
+    public function testThatCodeGetsConvertedIntoNodes()
+    {
+        $parser = $this->prophesize(Parser::class);
+        $parser->parse('this is my code')->willReturn(['parsed code']);
+
+        $nodeTraverser = $this->prophesize(NodeTraverserInterface::class);
+        $nodeTraverser->traverse(['parsed code'])->willReturn(['traversed code']);
+
+        $factory = new NodesFactory($parser->reveal(), $nodeTraverser->reveal());
+
+        $result = $factory->create('this is my code');
+
+        $this->assertSame(['traversed code'], $result);
+    }
+
+    private function givenTheExpectedDefaultNodesFactory() : NodesFactory
+    {
+        $parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
+        $traverser = new NodeTraverser();
+        $traverser->addVisitor(new NameResolver());
+        $traverser->addVisitor(new ElementNameResolver());
+
+        return new NodesFactory($parser, $traverser);
+    }
+}