Update documentation and code coverage.

Author: drupol

spec/drupol/phptree/tests/Exporter/ValueGraphSpec.php

@@ -6,6 +6,7 @@
 
 use drupol\phptree\Node\ValueNode;
 use drupol\phptree\tests\Exporter\ValueGraph;
+use Fhaculty\Graph\Vertex;
 use PhpSpec\ObjectBehavior;
 
 class ValueGraphSpec extends ObjectBehavior
@@ -21,6 +22,13 @@ public function it_can_be_extended()
 
         $this
             ->export($tree)
-            ->shouldReturnAnInstanceOf(\Fhaculty\Graph\Graph::class);
+            ->getVertex('root')
+            ->shouldReturnAnInstanceOf(Vertex::class);
+
+        $this
+            ->export($tree)
+            ->getVertex('root')
+            ->getAttribute('value')
+            ->shouldReturn('root');
     }
 }

src/Exporter/Graph.php

@@ -17,11 +17,15 @@
 class Graph implements ExporterInterface
 {
     /**
+     * The graph.
+     *
      * @var \Fhaculty\Graph\Graph
      */
     private $graph;
 
     /**
+     * The traverser.
+     *
      * @var \drupol\phptree\Traverser\TraverserInterface
      */
     private $traverser;

src/Node/KeyValueNodeInterface.php

@@ -10,10 +10,10 @@
 interface KeyValueNodeInterface extends ValueNodeInterface
 {
     /**
-     * Get the node key.
+     * Get the key property.
      *
      * @return string|mixed|int|null
-     *   The key value.
+     *   The key property.
      */
     public function getKey();
 }

src/Node/NaryNode.php

@@ -7,11 +7,13 @@
 use drupol\phptree\Traverser\BreadthFirst;
 
 /**
- * Class NaryNode
+ * Class NaryNode.
  */
 class NaryNode extends Node
 {
     /**
+     * The capacity of a node, the maximum children a node can have.
+     *
      * @var int
      */
     private $capacity;
@@ -20,7 +22,9 @@ class NaryNode extends Node
      * NaryNode constructor.
      *
      * @param int $capacity
+     *   The maximum children a node can have.
      * @param \drupol\phptree\Node\NodeInterface|null $parent
+     *   The parent.
      */
     public function __construct(int $capacity = 0, NodeInterface $parent = null)
     {

src/Node/NaryNodeInterface.php

@@ -5,12 +5,15 @@
 namespace drupol\phptree\Node;
 
 /**
- * Class NaryNode
+ * Interface NaryNodeInterface
  */
 interface NaryNodeInterface
 {
     /**
-     * {@inheritdoc}
+     * Get the node capacity.
+     *
+     * @return int
+     *   The node capacity.
      */
     public function capacity(): int;
 }

src/Node/ValueNode.php

@@ -10,6 +10,8 @@
 class ValueNode extends NaryNode implements ValueNodeInterface
 {
     /**
+     * The value property.
+     *
      * @var string|mixed|null
      */
     private $value;

src/Node/ValueNodeInterface.php

@@ -10,10 +10,10 @@
 interface ValueNodeInterface extends NodeInterface
 {
     /**
-     * Get the node value.
+     * Get the value property.
      *
      * @return string|mixed|null
-     *   The node value.
+     *   The value property.
      */
     public function getValue();
 }

tests/src/Exporter/ValueGraph.php

@@ -18,7 +18,13 @@ class ValueGraph extends Graph
      */
     protected function createVertex(NodeInterface $node): Vertex
     {
-        return parent::createVertex($node);
+        $vertex = parent::createVertex($node);
+
+        if (\method_exists($node, 'getValue')) {
+            $vertex->setAttribute('value', $node->getValue());
+        }
+
+        return $vertex;
     }
 
     /**