test flatten, callback args

Author: brenoroosevelt

composer.json

@@ -27,12 +27,13 @@
             "BrenoRoosevelt\\": "src/"
         },
         "files": [
-            "src/Constants.php",
+            "src/CallbackArgs.php",
             "src/IndexOf.php",
             "src/Contains.php",
             "src/Add.php",
             "src/Set.php",
             "src/Pipe.php",
+            "src/Flatten.php",
             "src/DotNotation.php",
             "src/Remove.php",
             "src/array_functions.php"

src/Constants.php renamed to src/CallbackArgs.php

@@ -3,31 +3,6 @@
 
 namespace BrenoRoosevelt;
 
-/**
- * @param array $items
- * @param string|null $separator
- * @return array
- */
-function flatten(array $items, ?string $separator = null)
-{
-    $result = [];
-    $iterator = new \RecursiveIteratorIterator(new \RecursiveArrayIterator($items));
-    foreach ($iterator as $leafValue) {
-        $keys = [];
-        foreach (range(0, $iterator->getDepth()) as $depth) {
-            $keys[] = $iterator->getSubIterator($depth)->key();
-        }
-
-        if (! empty($separator)) {
-            $result[join($separator, $keys) ] = $leafValue;
-        } else {
-            $result[] = $leafValue;
-        }
-    }
-
-    return $result;
-}
-
 /**
  * @param array $items
  * @param string $separator

src/DotNotation.php

@@ -0,0 +1,29 @@
+<?php
+declare(strict_types=1);
+
+namespace BrenoRoosevelt;
+
+/**
+ * @param array $items
+ * @param string|null $separator
+ * @return array
+ */
+function flatten(array $items, ?string $separator = null)
+{
+    $result = [];
+    $iterator = new \RecursiveIteratorIterator(new \RecursiveArrayIterator($items));
+    foreach ($iterator as $leafValue) {
+        $keys = [];
+        foreach (range(0, $iterator->getDepth()) as $depth) {
+            $keys[] = $iterator->getSubIterator($depth)->key();
+        }
+
+        if (! empty($separator)) {
+            $result[join($separator, $keys) ] = $leafValue;
+        } else {
+            $result[] = $leafValue;
+        }
+    }
+
+    return $result;
+}

src/Flatten.php

@@ -0,0 +1,31 @@
+<?php
+declare(strict_types=1);
+
+namespace BrenoRoosevelt\Tests;
+
+use PHPUnit\Framework\TestCase;
+use function BrenoRoosevelt\__args;
+use const BrenoRoosevelt\CALLBACK_USE_BOTH;
+use const BrenoRoosevelt\CALLBACK_USE_KEY;
+use const BrenoRoosevelt\CALLBACK_USE_VALUE;
+
+class CallbackArgsTest extends TestCase
+{
+    public function testCallbackArgsUseValue()
+    {
+        $args = __args(CALLBACK_USE_VALUE, 1, 2);
+        $this->assertEquals([2], $args);
+    }
+
+    public function testCallbackArgsUseKey()
+    {
+        $args = __args(CALLBACK_USE_KEY, 1, 2);
+        $this->assertEquals([1], $args);
+    }
+
+    public function testCallbackArgsUseBoth()
+    {
+        $args = __args(CALLBACK_USE_BOTH, 1, 2);
+        $this->assertEquals([2, 1], $args);
+    }
+}

tests/CallbackArgsTest.php

@@ -0,0 +1,92 @@
+<?php
+declare(strict_types=1);
+
+namespace BrenoRoosevelt\Tests;
+
+use PHPUnit\Framework\TestCase;
+use function BrenoRoosevelt\flatten;
+
+class FlattenTest extends TestCase
+{
+    public function flattenProvider(): array
+    {
+        return [
+            'case_1' => [
+                ['a', 'b', 'c'],
+                null,
+                ['a', 'b', 'c'],
+            ],
+            'case_2' => [
+                ['a', ['b', ['c'], 'd']],
+                null,
+                ['a', 'b', 'c', 'd'],
+            ],
+            'case_3' => [
+                ['x' => 'a', 'y' => 'b', 'z' => 'c'],
+                null,
+                ['a', 'b', 'c']
+            ],
+            'case_4' => [
+                ['x' => 'a', 'y' => ['b', ['z' => 'c'], 'd']],
+                '.',
+                ['x' => 'a', 'y.0' => 'b', 'y.1.z' => 'c', 'y.2' => 'd']
+            ],
+            'case_5' => [
+                ['x' => 'a', 'y' => ['b', ['z' => 'c'], 'd']],
+                '\\',
+                ['x' => 'a', 'y\\0' => 'b', 'y\\1\\z' => 'c', 'y\\2' => 'd']
+            ],
+            'case_6' => [
+                [
+                    [
+                        'Post' => ['id' => '1', 'author_id' => '1', 'title' => '1st post'],
+                        'Author' => ['id' => '1', 'user' => 'spencer', 'password' => 'pwd'],
+                    ],
+                    [
+                        'Post' => ['id' => '2', 'author_id' => '3', 'title' => '2nd Post', 'body' => '2nd post body'],
+                        'Author' => ['id' => '3', 'user' => 'mary', 'password' => null],
+                    ],
+                ],
+                '.',
+                [
+                    '0.Post.id' => '1',
+                    '0.Post.author_id' => '1',
+                    '0.Post.title' => '1st post',
+                    '0.Author.id' => '1',
+                    '0.Author.user' => 'spencer',
+                    '0.Author.password' => 'pwd',
+                    '1.Post.id' => '2',
+                    '1.Post.author_id' => '3',
+                    '1.Post.title' => '2nd Post',
+                    '1.Post.body' => '2nd post body',
+                    '1.Author.id' => '3',
+                    '1.Author.user' => 'mary',
+                    '1.Author.password' => null,
+                ]
+            ],
+            'case_7' => [
+                [],
+                null,
+                []
+            ],
+            'case_8' => [
+                [],
+                '.',
+                []
+            ],
+        ];
+    }
+
+    /**
+     * @param array $items
+     * @param string|null $separator
+     * @param array $expected
+     * @return void
+     * @dataProvider flattenProvider
+     */
+    public function testFlatten(array $items, ?string $separator, array $expected): void
+    {
+        $result = flatten($items, $separator);
+        $this->assertEquals($expected, $result);
+    }
+}