test map

Author: brenoroosevelt

composer.json

@@ -27,24 +27,25 @@
             "BrenoRoosevelt\\": "src/"
         },
         "files": [
-            "src/CallbackArgs.php",
-            "src/IndexOf.php",
-            "src/None.php",
-            "src/Contains.php",
+            "src/Add.php",
             "src/All.php",
             "src/AtLeast.php",
             "src/AtMost.php",
+            "src/CallbackArgs.php",
+            "src/Contains.php",
+            "src/DotNotation.php",
             "src/Exactly.php",
-            "src/Add.php",
-            "src/Set.php",
-            "src/Pipe.php",
+            "src/Expand.php",
             "src/First.php",
             "src/Flatten.php",
-            "src/Expand.php",
-            "src/DotNotation.php",
+            "src/IndexOf.php",
+            "src/Map.php",
+            "src/None.php",
+            "src/Pipe.php",
+            "src/Pull.php",
             "src/Remove.php",
             "src/RemoveKey.php",
-            "src/Pull.php",
+            "src/Set.php",
             "src/Some.php",
             "src/array_functions.php"
         ]

src/Map.php

@@ -0,0 +1,36 @@
+<?php
+declare(strict_types=1);
+
+namespace BrenoRoosevelt;
+
+/**
+ * Maps collection elements using a callback function
+ *
+ * @param iterable $items The collection
+ * @param callable $callback The callback
+ * @param int $mode [optional] <p>
+ * Flag determining what arguments are sent to <i>callback</i>:
+ * </p><ul>
+ * <li>
+ * <b>CALLBACK_USE_VALUE</b> - <b>default</b> pass value as the only argument
+ * </li>
+ * <li>
+ * <b>CALLBACK_USE_KEY</b> - pass key as the only argument
+ * to <i>callback</i> instead of the value</span>
+ * </li>
+ * <li>
+ * <b>CALLBACK_USE_BOTH</b> - pass both value and key as
+ * arguments to <i>callback</i></span>
+ * </li>
+ * </ul>
+ * @return array Mapped values
+ */
+function map(iterable $items, callable $callback, int $mode = CALLBACK_USE_VALUE): array
+{
+    $result = [];
+    foreach ($items as $key => $value) {
+        $result[$key] = call_user_func_array($callback, __args($mode, $key, $value));
+    }
+
+    return $result;
+}

src/array_functions.php

@@ -3,16 +3,6 @@
 
 namespace BrenoRoosevelt;
 
-function map(iterable $items, callable $callback, int $mode = CALLBACK_USE_VALUE): array
-{
-    $result = [];
-    foreach ($items as $key => $value) {
-        $result[$key] = call_user_func_array($callback, __args($mode, $key, $value));
-    }
-
-    return $result;
-}
-
 function accept(iterable $items, callable $callback, int $mode = CALLBACK_USE_VALUE): array
 {
     $result = [];

tests/MapTest.php

@@ -0,0 +1,30 @@
+<?php
+declare(strict_types=1);
+
+namespace BrenoRoosevelt\Tests;
+
+use PHPUnit\Framework\TestCase;
+use function BrenoRoosevelt\map;
+use const BrenoRoosevelt\CALLBACK_USE_BOTH;
+use const BrenoRoosevelt\CALLBACK_USE_KEY;
+
+class MapTest extends TestCase
+{
+    public function testMapValue()
+    {
+        $elements = [1, 2, 3];
+        $this->assertEquals([2, 4, 6], map($elements, fn($v) => $v * 2));
+    }
+
+    public function testMapKey()
+    {
+        $elements = [1, 2, 3];
+        $this->assertEquals([0, 2, 4], map($elements, fn($k) => $k * 2, CALLBACK_USE_KEY));
+    }
+
+    public function testMapBoth()
+    {
+        $elements = [1, 2, 3];
+        $this->assertEquals([1, 3, 5], map($elements, fn($v, $k) => $v + $k, CALLBACK_USE_BOTH));
+    }
+}