Add NaryNode tree.

Author: drupol

.php_cs.dist

@@ -20,6 +20,7 @@ return PhpCsFixer\Config::create()
         'declare_equal_normalize' => [
           'space' => 'single',
         ],
+        'declare_strict_types' => TRUE,
         'include' => TRUE,
         'is_null' => TRUE,
         'linebreak_after_opening_tag' => TRUE,

composer.json

@@ -19,6 +19,7 @@
         "apigen/apigen": "dev-master",
         "drupol/phpspec-annotation": "^1.0",
         "friendsofphp/php-cs-fixer": "^2.13",
+        "graphp/graphviz": "^0.2.1",
         "infection/infection": "^0.11.2",
         "jakub-onderka/php-parallel-lint": "^1.0",
         "leanphp/phpspec-code-coverage": "^4",

grumphp.yml.dist

@@ -31,11 +31,6 @@ parameters:
       end_point: ~
       timeout: ~
       run_always: false
-    composer_require_checker:
-      composer_file: 'composer.json'
-      config_file: ~
-      ignore_parse_errors: false
-      triggered_by: ['composer.json', 'composer.lock', '*.php']
     infection:
-      min_msi: 90
-      min_covered_msi: 90
+      min_msi: 80
+      min_covered_msi: 80

spec/drupol/phptree/Node/KeyValueNodeSpec.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace spec\drupol\phptree\Node;
 
 use drupol\phptree\Node\KeyValueNode;
@@ -25,4 +27,13 @@ public function it_can_be_set_with_a_key_and_value()
             ->getValue()
             ->shouldReturn('root');
     }
+
+    public function it_can_throw_an_error_when_capacity_is_invalid()
+    {
+        $this->beConstructedWith(-5);
+
+        $this
+            ->capacity()
+            ->shouldReturn(0);
+    }
 }

spec/drupol/phptree/Node/NaryNodeSpec.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace spec\drupol\phptree\Node;
+
+use drupol\phptree\Node\NaryNode;
+use PhpSpec\ObjectBehavior;
+
+class NaryNodeSpec extends ObjectBehavior
+{
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(NaryNode::class);
+    }
+
+    public function it_can_get_the_capacity()
+    {
+        $this
+            ->capacity()
+            ->shouldReturn(0);
+    }
+
+    public function it_can_get_the_capacity_when_using_a_custom_capacity()
+    {
+        $this->beConstructedWith(3);
+
+        $this
+            ->capacity()
+            ->shouldReturn(3);
+    }
+
+    public function it_can_throw_an_error_when_capacity_is_invalid()
+    {
+        $this->beConstructedWith(-5);
+
+        $this
+            ->capacity()
+            ->shouldReturn(0);
+    }
+
+    public function it_can_be_counted()
+    {
+        $this->beConstructedWith(2);
+
+        foreach (\range('A', 'Z') as $value) {
+            $node = new NaryNode(2);
+
+            $this->add($node);
+        }
+
+        $this
+            ->count()
+            ->shouldReturn(26);
+    }
+}

spec/drupol/phptree/Node/NodeSpec.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace spec\drupol\phptree\Node;
 
 use drupol\phptree\Node\Node;

spec/drupol/phptree/Node/ValueNodeSpec.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace spec\drupol\phptree\Node;
 
 use drupol\phptree\Node\ValueNode;

spec/drupol/phptree/Visitor/BreadthFirstVisitorSpec.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace spec\drupol\phptree\Visitor;
 
 use drupol\phptree\Node\Node;

spec/drupol/phptree/Visitor/PostOrderVisitorSpec.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace spec\drupol\phptree\Visitor;
 
 use drupol\phptree\Node\Node;

spec/drupol/phptree/Visitor/PreOrderVisitorSpec.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace spec\drupol\phptree\Visitor;
 
 use drupol\phptree\Node\Node;

src/Node/KeyValueNode.php

@@ -21,11 +21,12 @@ class KeyValueNode extends ValueNode implements KeyValueNodeInterface
      *
      * @param mixed|null $key
      * @param mixed|null $value
+     * @param int $capacity
      * @param \drupol\phptree\Node\NodeInterface|NULL $parent
      */
-    public function __construct($key = null, $value = null, NodeInterface $parent = null)
+    public function __construct($key = null, $value = null, int $capacity = 0, NodeInterface $parent = null)
     {
-        parent::__construct($value, $parent);
+        parent::__construct($value, $capacity, $parent);
 
         $this->key = $key;
     }

src/Node/NaryNode.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace drupol\phptree\Node;
+
+use drupol\phptree\Visitor\BreadthFirstVisitor;
+
+/**
+ * Class NaryNode
+ */
+class NaryNode extends Node
+{
+    /**
+     * @var int
+     */
+    private $capacity;
+
+    /**
+     * Node constructor.
+     *
+     * @param int $capacity
+     * @param \drupol\phptree\Node\NodeInterface|NULL $parent
+     */
+    public function __construct(int $capacity = 0, NodeInterface $parent = null)
+    {
+        parent::__construct($parent);
+
+        if ($capacity < 0) {
+            $capacity = 0;
+        }
+
+        $this->capacity = $capacity;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function capacity(): int
+    {
+        return $this->capacity;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function add(NodeInterface ...$nodes): NodeInterface
+    {
+        foreach ($nodes as $node) {
+            $capacity = $this->capacity();
+
+            if (0 === $capacity || $this->degree() < $capacity) {
+                parent::add($node);
+
+                continue;
+            }
+
+            // @todo Find a way to get rid of this.
+            $visitor = new BreadthFirstVisitor();
+
+            foreach ($visitor->traverse($this) as $node_visited) {
+                if ($node_visited->degree() >= $capacity) {
+                    continue;
+                }
+
+                $node_visited->add($node);
+
+                break;
+            }
+        }
+
+        return $this;
+    }
+}

src/Node/NaryNodeInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace drupol\phptree\Node;
+
+/**
+ * Class NaryNode
+ */
+interface NaryNodeInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function capacity(): int;
+}

src/Node/NodeInterface.php

@@ -53,7 +53,7 @@ public function remove(NodeInterface ...$node): NodeInterface;
     /**
      * Get the children.
      *
-     * @return NodeInterface[]
+     * @return \drupol\phptree\Node\NodeInterface[]
      *   The children.
      */
     public function children(): array;

src/Node/ValueNode.php

@@ -7,7 +7,7 @@
 /**
  * Class ValueNode
  */
-class ValueNode extends Node implements ValueNodeInterface
+class ValueNode extends NaryNode implements ValueNodeInterface
 {
     /**
      * @var string|mixed|null
@@ -18,11 +18,12 @@ class ValueNode extends Node implements ValueNodeInterface
      * KeyValueNode constructor.
      *
      * @param mixed|null $value
+     * @param int $capacity
      * @param \drupol\phptree\Node\NodeInterface|NULL $parent
      */
-    public function __construct($value = null, NodeInterface $parent = null)
+    public function __construct($value = null, int $capacity = 0, NodeInterface $parent = null)
     {
-        parent::__construct($parent);
+        parent::__construct($capacity, $parent);
 
         $this->value = $value;
     }

src/Visitor/AbstractVisitor.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace drupol\phptree\Visitor;
 
 use drupol\phptree\Node\NodeInterface;

src/Visitor/BreadthFirstVisitor.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace drupol\phptree\Visitor;
 
 use drupol\phptree\Node\NodeInterface;

src/Visitor/PostOrderVisitor.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace drupol\phptree\Visitor;
 
 use drupol\phptree\Node\NodeInterface;

src/Visitor/PreOrderVisitor.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace drupol\phptree\Visitor;
 
 use drupol\phptree\Node\NodeInterface;

src/Visitor/VisitorInterface.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types = 1);
+
 namespace drupol\phptree\Visitor;
 
 use drupol\phptree\Node\NodeInterface;