Merge pull request #13 from mediact/feature/APD-1542

Add support for keys that contain the separator

composer.json

@@ -42,14 +42,11 @@
             "/phpcs.xml",
             "/phpstan.neon",
             "/tests",
-            "/example"
+            "/example",
+            "/grumphp.yml",
+            "/pdepend.xml"
         ]
     },
-    "extra": {
-        "grumphp": {
-            "config-default-path": "vendor/mediact/testing-suite/config/default/grumphp.yml"
-        }
-    },
     "config": {
         "sort-packages": true
     }

example/branching.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl
@@ -20,5 +21,5 @@
 );
 
 foreach ($container->branch('categories.*') as $category) {
-    var_dump($category->get('name'));
+    print_r($category->get('name'));
 }

grumphp.yml

@@ -0,0 +1,2 @@
+imports:
+  - resource: 'vendor/mediact/testing-suite/config/default/grumphp.yml'

pdepend.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<symfony:container xmlns:symfony="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="http://pdepend.org/schema/dic/pdepend"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <config>
+        <cache>
+            <driver>memory</driver>
+        </cache>
+    </config>
+</symfony:container>

src/DataContainer.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl
@@ -15,6 +16,8 @@
 class DataContainer implements IterableDataContainerInterface
 {
     use ReplaceByPatternTrait;
+    use PathParserTrait;
+    use KeyQuoterTrait;
 
     /** @var array */
     private $data;
@@ -24,7 +27,7 @@ class DataContainer implements IterableDataContainerInterface
      *
      * @param array $data
      */
-    public function __construct(iterable $data = [])
+    final public function __construct(iterable $data = [])
     {
         $this->data = $data instanceof Traversable
             ? iterator_to_array($data)
@@ -126,7 +129,7 @@ public function glob(string $pattern): array
             ? [$pattern]
             : $this->findArrayPathsByPatterns(
                 $this->data,
-                explode(static::SEPARATOR, $pattern),
+                $this->parsePath($pattern),
                 ''
             );
     }
@@ -169,11 +172,11 @@ function ($match) use ($pattern, $replacement) {
     public function branch(string $pattern): array
     {
         return array_map(
-            function (array $data) : DataContainerInterface {
+            function (array $data): DataContainerInterface {
                 return new static($data);
             },
             array_map(
-                function (string $path) : array {
+                function (string $path): array {
                     return (array) $this->get($path, []);
                 },
                 $this->glob($pattern)
@@ -235,25 +238,6 @@ public function move(string $pattern, string $replacement)
         }
     }
 
-    /**
-     * Parse a path into an array.
-     *
-     * @param string $path
-     *
-     * @return array
-     */
-    private function parsePath(string $path): array
-    {
-        return array_map(
-            function (string $key) {
-                return ctype_digit($key)
-                    ? intval($key)
-                    : $key;
-            },
-            array_filter(explode(static::SEPARATOR, $path), 'strlen')
-        );
-    }
-
     /**
      * Get reference to a data node, create it if it does not exist.
      *
@@ -265,9 +249,10 @@ private function &getNodeReference(array $keys): array
     {
         $current =& $this->data;
 
-        while (count($keys)) {
+        while (!empty($keys)) {
             $key = array_shift($keys);
-            if (!array_key_exists($key, $current)
+            if (
+                !array_key_exists($key, $current)
                 || !is_array($current[$key])
             ) {
                 $current[$key] = [];
@@ -303,8 +288,7 @@ function ($key) use ($pattern) {
 
         $paths = [];
         foreach ($matchingKeys as $key) {
-            $path = $prefix . $key;
-
+            $path = $prefix . $this->quoteKey($key);
             if (count($patterns) === 0) {
                 $paths[] = $path;
                 continue;

src/DataContainerDecoratorTrait.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

src/DataContainerFactory.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

src/DataContainerFactoryInterface.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

src/DataContainerFilterChain.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl
@@ -37,7 +38,7 @@ function (
                 DataContainerFilterInterface $filter
             ) use (
                 $container
-            ) : bool {
+            ): bool {
                 return $carry && $filter($container);
             },
             true

src/DataContainerFilterInterface.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

src/DataContainerInterface.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl
@@ -16,7 +17,9 @@ interface DataContainerInterface extends IteratorAggregate
     /**
      * The separator used in paths.
      */
-    const SEPARATOR = '.';
+    public const SEPARATOR = '.';
+    public const ENCLOSURE = '"';
+    public const ESCAPE    = '\\';
 
     /**
      * Check whether a path exists.

src/DataContainerIterator.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

src/DataContainerIteratorAggregateTrait.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

src/DataContainerIteratorInterface.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

src/IterableDataContainerInterface.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

src/KeyQuoterTrait.php

@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * Copyright MediaCT. All rights reserved.
+ * https://www.mediact.nl
+ */
+
+namespace Mediact\DataContainer;
+
+trait KeyQuoterTrait
+{
+    /**
+     * Quote a key.
+     *
+     * @param string $key
+     *
+     * @return string
+     */
+    private function quoteKey(string $key): string
+    {
+        return strpos($key, DataContainerInterface::SEPARATOR) !== false
+            ? sprintf(
+                '%s%s%s',
+                DataContainerInterface::ENCLOSURE,
+                str_replace(
+                    DataContainerInterface::ENCLOSURE,
+                    DataContainerInterface::ENCLOSURE . DataContainerInterface::ENCLOSURE,
+                    $key
+                ),
+                DataContainerInterface::ENCLOSURE
+            )
+            : $key;
+    }
+}

src/PathParserTrait.php

@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * Copyright MediaCT. All rights reserved.
+ * https://www.mediact.nl
+ */
+
+namespace Mediact\DataContainer;
+
+trait PathParserTrait
+{
+    /**
+     * Parse a path.
+     *
+     * @param string $path
+     *
+     * @return array
+     */
+    private function parsePath(string $path): array
+    {
+        return array_map(
+            function (string $key) {
+                return ctype_digit($key)
+                    ? intval($key)
+                    : $key;
+            },
+            array_values(
+                array_filter(
+                    str_getcsv(
+                        $path,
+                        DataContainerInterface::SEPARATOR,
+                        DataContainerInterface::ENCLOSURE,
+                        DataContainerInterface::ESCAPE
+                    ),
+                    'strlen'
+                )
+            )
+        );
+    }
+}

src/PatternReplacer.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

src/PatternReplacerInterface.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

src/ReplaceByPatternTrait.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

tests/DataContainerDecoratorTraitTest.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

tests/DataContainerFactoryTest.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

tests/DataContainerFilterChainTest.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

tests/DataContainerIteratorAggregateTraitTest.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl

tests/DataContainerIteratorTest.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright MediaCT. All rights reserved.
  * https://www.mediact.nl