Merge pull request #2 from drupol/text-converter-importer

Implements a simple text converter and importer.

README.md

@@ -24,7 +24,9 @@ It also provides [4 trees traversals algorithm](https://en.wikipedia.org/wiki/Tr
 * Pre order
 * Breadth first
 
-And it provides 1 converter for the [graphp/graphp](https://github.com/graphp/graph) library.
+And it provides Exporters and Importers for:
+* Graph: Export a tree into a graph using the [graphp/graphp](https://github.com/graphp/graph) library.
+* Text: Export a tree into a simple string.
 
 ## Documentation
 
@@ -51,7 +53,7 @@ API documentation is automatically generated with [APIGen](https://github.com/Ap
 declare(strict_types = 1);
 
 use Graphp\GraphViz\GraphViz;
-use drupol\phptree\Converter\Graph;
+use drupol\phptree\Exporter\Graph;
 use drupol\phptree\Node\ValueNode;
 
 include './vendor/autoload.php';
@@ -66,9 +68,9 @@ foreach (\range('A', 'Z') as $v) {
 $tree->add(...$nodes);
 
 $graphViz = new GraphViz();
-$converter = new Graph();
+$exporter = new Graph();
 
-$graphViz->display($converter->convert($tree));
+$graphViz->display($exporter->export($tree));
 ```
 
 ## Code quality, tests and benchmarks

benchmarks/AbstractBench.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace drupol\phptree\benchmarks;
+
+abstract class AbstractBench
+{
+    /**
+     * @return array
+     */
+    public function getData()
+    {
+        return \range(1, 100);
+    }
+}

benchmarks/DrupolPhpTreeBench.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace drupol\phptree\benchmarks;
+
+use drupol\phptree\Node\ValueNode;
+use PhpBench\Benchmark\Metadata\Annotations\BeforeMethods;
+
+/**
+ * @Groups({"drupol/phptree"})
+ * @BeforeMethods({"initObject"})
+ */
+class DrupolPhpTreeBench extends AbstractBench
+{
+    /**
+     * @var \drupol\phptree\Node\NodeInterface
+     */
+    private $tree;
+
+    /**
+     * Init the object.
+     */
+    public function initObject()
+    {
+    }
+
+    /**
+     * @Revs({1, 100, 1000})
+     * @Iterations(5)
+     * @Warmup(10)
+     */
+    public function benchHash()
+    {
+        $this->tree = new ValueNode();
+
+        foreach ($this->getData() as $value) {
+            $this->tree->add(new ValueNode($value));
+        }
+    }
+}

composer.json

@@ -45,7 +45,8 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "drupol\\phptree\\tests\\": "tests/src/"
+            "drupol\\phptree\\tests\\": "tests/src/",
+            "drupol\\phptree\\benchmarks\\": "benchmarks/"
         }
     },
     "config": {

spec/drupol/phptree/Converter/GraphSpec.php → spec/drupol/phptree/Exporter/GraphSpec.php

@@ -2,9 +2,9 @@
 
 declare(strict_types = 1);
 
-namespace spec\drupol\phptree\Converter;
+namespace spec\drupol\phptree\Exporter;
 
-use drupol\phptree\Converter\Graph;
+use drupol\phptree\Exporter\Graph;
 use drupol\phptree\Node\Node;
 use drupol\phptree\Node\ValueNode;
 use drupol\phptree\Traverser\BreadthFirst;
@@ -27,7 +27,7 @@ public function it_can_generate_a_graph()
             ->add($child1, $child2, $child3);
 
         $this
-            ->convert($root)
+            ->export($root)
             ->shouldReturnAnInstanceOf(\Fhaculty\Graph\Graph::class);
 
         $this

spec/drupol/phptree/Exporter/TextSpec.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace spec\drupol\phptree\Exporter;
+
+use drupol\phptree\Exporter\Text;
+use drupol\phptree\Node\ValueNode;
+use PhpSpec\ObjectBehavior;
+
+class TextSpec extends ObjectBehavior
+{
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(Text::class);
+    }
+
+    public function it_can_export_to_text()
+    {
+        $tree = new ValueNode('root', 2);
+
+        $this
+            ->export($tree)
+            ->shouldReturn('[root]');
+
+        $nodes = [];
+        foreach (\range('A', 'J') as $value) {
+            $nodes[$value] = new ValueNode($value);
+        }
+
+        $tree->add(...\array_values($nodes));
+
+        $this
+            ->export($tree)
+            ->shouldReturn('[root [A [C [G] [H]] [D [I] [J]]] [B [E] [F]]]');
+    }
+}

spec/drupol/phptree/Importer/TextSpec.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace spec\drupol\phptree\Importer;
+
+use drupol\phptree\Importer\Text;
+use drupol\phptree\Node\ValueNode;
+use drupol\phptree\Node\ValueNodeInterface;
+use PhpSpec\ObjectBehavior;
+
+class TextSpec extends ObjectBehavior
+{
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(Text::class);
+    }
+
+    public function it_can_import()
+    {
+        $string = '[root [A [C [G] [H]] [D [I] [J]]] [B [E] [F]]]';
+
+        $tree = new ValueNode('root', 2);
+
+        $nodes = [];
+        foreach (\range('A', 'J') as $value) {
+            $nodes[$value] = new ValueNode($value);
+        }
+
+        $tree->add(...\array_values($nodes));
+
+        $this
+            ->import($string)
+            ->shouldImplement(ValueNodeInterface::class);
+
+        $this
+            ->import($string)
+            ->count()
+            ->shouldReturn(10);
+
+        $this
+            ->import($string)
+            ->isRoot()
+            ->shouldReturn(TRUE);
+    }
+}

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

@@ -2,10 +2,10 @@
 
 declare(strict_types = 1);
 
-namespace spec\drupol\phptree\tests\Converter;
+namespace spec\drupol\phptree\tests\Exporter;
 
 use drupol\phptree\Node\ValueNode;
-use drupol\phptree\tests\Converter\ValueGraph;
+use drupol\phptree\tests\Exporter\ValueGraph;
 use PhpSpec\ObjectBehavior;
 
 class ValueGraphSpec extends ObjectBehavior
@@ -20,7 +20,7 @@ public function it_can_be_extended()
         $tree = new ValueNode('root');
 
         $this
-            ->convert($tree)
+            ->export($tree)
             ->shouldReturnAnInstanceOf(\Fhaculty\Graph\Graph::class);
     }
 }

src/Exporter/ExporterInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace drupol\phptree\Exporter;
+
+use drupol\phptree\Node\ValueNodeInterface;
+
+/**
+ * Interface ExporterInterface
+ */
+interface ExporterInterface
+{
+    /**
+     * Export a node into something.
+     *
+     * @param \drupol\phptree\Node\ValueNodeInterface $node
+     *   The node.
+     *
+     * @return mixed
+     *   The node exported.
+     */
+    public function export(ValueNodeInterface $node);
+}

src/Converter/Graph.php → src/Exporter/Graph.php

@@ -2,9 +2,10 @@
 
 declare(strict_types = 1);
 
-namespace drupol\phptree\Converter;
+namespace drupol\phptree\Exporter;
 
 use drupol\phptree\Node\NodeInterface;
+use drupol\phptree\Node\ValueNodeInterface;
 use drupol\phptree\Traverser\BreadthFirst;
 use drupol\phptree\Traverser\TraverserInterface;
 use Fhaculty\Graph\Graph as OriginalGraph;
@@ -13,7 +14,7 @@
 /**
  * Class Graph
  */
-class Graph implements ConverterInterface
+class Graph implements ExporterInterface
 {
     /**
      * @var \Fhaculty\Graph\Graph
@@ -54,11 +55,15 @@ public function getTraverser(): TraverserInterface
     }
 
     /**
-     * @param \drupol\phptree\Node\NodeInterface $node
+     * Export a node into a Graph.
+     *
+     * @param \drupol\phptree\Node\ValueNodeInterface $node
+     *   The node.
      *
      * @return \Fhaculty\Graph\Graph
+     *   The graph.
      */
-    public function convert(NodeInterface $node): OriginalGraph
+    public function export(ValueNodeInterface $node): OriginalGraph
     {
         foreach ($this->getTraverser()->traverse($node) as $node_visited) {
             /** @var int $vertexId */

src/Exporter/Text.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace drupol\phptree\Exporter;
+
+use drupol\phptree\Node\ValueNodeInterface;
+
+/**
+ * Class Text
+ */
+class Text implements ExporterInterface
+{
+    /**
+     * Export the node in a string.
+     *
+     * @param \drupol\phptree\Node\ValueNodeInterface $node
+     *   The node.
+     *
+     * @return string
+     *   The string.
+     */
+    public function export(ValueNodeInterface $node): string
+    {
+        $children = [];
+        /** @var ValueNodeInterface $child */
+        foreach ($node->children() as $child) {
+            $children[] = $this->export($child);
+        }
+
+        return [] === $children ?
+            \sprintf('[%s]', $node->getValue()):
+            \sprintf('[%s %s]', $node->getValue(), \implode(' ', $children));
+    }
+}

src/Importer/ImporterInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace drupol\phptree\Importer;
+
+use drupol\phptree\Node\NodeInterface;
+
+/**
+ * Interface ImporterInterface
+ */
+interface ImporterInterface
+{
+    /**
+     * Import data into a node.
+     *
+     * @param mixed $data
+     *   The data to import.
+     *
+     * @return NodeInterface
+     *   The new node.
+     */
+    public function import($data): NodeInterface;
+}