Issue #12: Consistency in constructor arguments.

Author: drupol

spec/drupol/phptree/Node/KeyValueNodeSpec.php

@@ -24,15 +24,16 @@ public function it_can_be_set_with_a_key_and_value()
 
     public function it_can_throw_an_error_when_capacity_is_invalid()
     {
-        $this->beConstructedWith(-5);
+        $this->beConstructedWith('key', 'value', -5);
 
         $this
             ->capacity()
-            ->shouldReturn(0);
+            ->shouldReturn(-5);
     }
 
     public function it_is_initializable()
     {
+        $this->beConstructedWith('key', 'value');
         $this->shouldHaveType(KeyValueNode::class);
     }
 }

spec/drupol/phptree/Node/NaryNodeSpec.php

@@ -68,19 +68,19 @@ public function it_can_have_children()
 
     public function it_can_throw_an_error_when_capacity_is_invalid()
     {
-        $this->beConstructedWith(-5);
+        $this->beConstructedWith(null);
 
         $this
             ->capacity()
-            ->shouldReturn(-5);
+            ->shouldBeNull();
 
         $this->shouldThrow(\Exception::class)
             ->during('add', [new NaryNode()]);
     }
 
     public function it_can_use_a_different_traverser()
     {
-        $this->beConstructedWith(2, null, new PreOrder());
+        $this->beConstructedWith(2, new PreOrder());
 
         $this->getTraverser()->shouldBeAnInstanceOf(PreOrder::class);
     }

spec/drupol/phptree/Node/TrieNodeSpec.php

@@ -11,7 +11,7 @@ class TrieNodeSpec extends NodeObjectBehavior
 {
     public function it_can_add_node()
     {
-        $this->beConstructedWith('root', 'root');
+        $this->beConstructedWith('key', 'value');
 
         $nodes = [
             1000,
@@ -42,6 +42,7 @@ public function it_can_add_node()
 
     public function it_is_initializable()
     {
+        $this->beConstructedWith('key', 'value');
         $this->shouldHaveType(TrieNode::class);
     }
 }

src/Node/KeyValueNode.php

@@ -4,6 +4,8 @@
 
 namespace drupol\phptree\Node;
 
+use drupol\phptree\Traverser\TraverserInterface;
+
 /**
  * Class KeyValueNode.
  */
@@ -14,12 +16,18 @@ class KeyValueNode extends ValueNode implements KeyValueNodeInterface
      *
      * @param null|mixed $key
      * @param null|mixed $value
-     * @param int $capacity
+     * @param null|int $capacity
+     * @param null|\drupol\phptree\Traverser\TraverserInterface $traverser
      * @param null|\drupol\phptree\Node\NodeInterface $parent
      */
-    public function __construct($key = null, $value = null, int $capacity = 0, NodeInterface $parent = null)
-    {
-        parent::__construct($value, $capacity, $parent);
+    public function __construct(
+        $key,
+        $value,
+        ?int $capacity = 0,
+        ?TraverserInterface $traverser = null,
+        ?NodeInterface $parent = null
+    ) {
+        parent::__construct($value, $capacity, $traverser, $parent);
 
         $this->storage()->set('key', $key);
     }

src/Node/NaryNode.php

@@ -15,23 +15,30 @@ class NaryNode extends Node implements NaryNodeInterface
     /**
      * NaryNode constructor.
      *
-     * @param int $capacity
-     *   The maximum children a node can have
-     * @param null|\drupol\phptree\Node\NodeInterface $parent
-     *   The parent
+     * @param null|int $capacity
+     *   The maximum children a node can have. Null for no children,
+     *   if 0 then any number of children is allowed.
      * @param null|\drupol\phptree\Traverser\TraverserInterface $traverser
-     *   The traverser
+     *   The traverser.
+     * @param null|\drupol\phptree\Node\NodeInterface $parent
+     *   The parent.
      */
-    public function __construct(int $capacity = 0, NodeInterface $parent = null, TraverserInterface $traverser = null)
-    {
+    public function __construct(
+        ?int $capacity = 0,
+        ?TraverserInterface $traverser = null,
+        ?NodeInterface $parent = null
+    ) {
         parent::__construct($parent);
 
         $this->storage()->set(
             'capacity',
             $capacity
         );
 
-        $this->storage()->set('traverser', $traverser ?? new BreadthFirst());
+        $this->storage()->set(
+            'traverser',
+            $traverser ?? new BreadthFirst()
+        );
     }
 
     /**
@@ -65,7 +72,7 @@ public function add(NodeInterface ...$nodes): NodeInterface
     /**
      * {@inheritdoc}
      */
-    public function capacity(): int
+    public function capacity(): ?int
     {
         return $this->storage()->get('capacity');
     }
@@ -115,7 +122,7 @@ protected function findFirstAvailableNode(NodeInterface $tree): ?NodeInterface
 
             $capacity = $candidate->capacity();
 
-            if (0 > $capacity) {
+            if (null === $capacity) {
                 continue;
             }
 

src/Node/NaryNodeInterface.php

@@ -14,10 +14,10 @@ interface NaryNodeInterface extends NodeInterface
     /**
      * Get the node capacity.
      *
-     * @return int
-     *   The node capacity
+     * @return null|int
+     *   The node capacity or null if no children is allowed.
      */
-    public function capacity(): int;
+    public function capacity(): ?int;
 
     /**
      * Get the traverser in use.

src/Node/TrieNode.php

@@ -41,13 +41,13 @@ public function add(NodeInterface ...$nodes): NodeInterface
     /**
      * @param \drupol\phptree\Node\ValueNodeInterface $node
      *
+     * @throws \Exception
+     *
      * @return \drupol\phptree\Node\NodeInterface|\drupol\phptree\Node\ValueNodeInterface
      */
     private function append(ValueNodeInterface $node)
     {
-        /** @var \drupol\phptree\Node\ValueNodeInterface $child */
         foreach ($this->children() as $child) {
-            /** @var \drupol\phptree\Node\ValueNodeInterface $node */
             if ($node->getValue() === $child->getValue()) {
                 return $child;
             }

src/Node/ValueNode.php

@@ -4,6 +4,8 @@
 
 namespace drupol\phptree\Node;
 
+use drupol\phptree\Traverser\TraverserInterface;
+
 /**
  * Class ValueNode.
  */
@@ -13,12 +15,17 @@ class ValueNode extends NaryNode implements ValueNodeInterface
      * ValueNode constructor.
      *
      * @param null|mixed $value
-     * @param int $capacity
+     * @param null|int $capacity
+     * @param null|\drupol\phptree\Traverser\TraverserInterface $traverser
      * @param null|\drupol\phptree\Node\NodeInterface $parent
      */
-    public function __construct($value, int $capacity = 0, NodeInterface $parent = null)
-    {
-        parent::__construct($capacity, $parent);
+    public function __construct(
+        $value,
+        ?int $capacity = 0,
+        ?TraverserInterface $traverser = null,
+        ?NodeInterface $parent = null
+    ) {
+        parent::__construct($capacity, $traverser, $parent);
 
         $this->storage()->set('value', $value);
     }