Add Collection.invokeMap function

pierredup · pierredup · commit b8e7abf45b96 · 2018-03-26T20:47:51.000+02:00
diff --git a/src/Collection/invokeMap.php b/src/Collection/invokeMap.php
@@ -0,0 +1,51 @@
+<?php
+
+// No 'declare(strict_types=1)' here as the invoked method needs to use weak-type
+
+/*
+ * This file is part of the SolidWorx Lodash-PHP project.
+ *
+ * @author     Pierre du Plessis <open-source@solidworx.co>
+ * @copyright  Copyright (c) 2017
+ */
+
+namespace _;
+
+use function _\internal\baseInvoke;
+use function _\internal\baseRest;
+
+/**
+ * Invokes the method at `path` of each element in `collection`, returning
+ * an array of the results of each invoked method. Any additional arguments
+ * are provided to each invoked method. If `path` is a function, it's invoked
+ * for, and `this` bound to, each element in `collection`.
+ *
+ * @category Collection
+ *
+ * @param iterable              $collection The collection to iterate over.
+ * @param array|callable|string $path       The path of the method to invoke or the function invoked per iteration.
+ * @param array                 $args       The arguments to invoke each method with.
+ *
+ * @return array the array of results.
+ * @example
+ * <code>
+ * invokeMap([[5, 1, 7], [3, 2, 1]], function($result) { sort($result); return $result;})
+ * // => [[1, 5, 7], [1, 2, 3]]
+ *
+ * invokeMap([123, 456], 'str_split')
+ * // => [['1', '2', '3'], ['4', '5', '6']]
+ * </code>
+ */
+function invokeMap(iterable $collection, $path, array $args = []): array
+{
+    return baseRest(function ($collection, $path, $args) {
+        $isFunc = \is_callable($path);
+        $result = [];
+
+        each($collection, function ($value) use (&$result, $isFunc, $path, $args) {
+            $result[] = $isFunc ? $path($value, ...$args) : baseInvoke($value, $path, $args);
+        });
+
+        return $result;
+    })($collection, $path, $args);
+}
diff --git a/src/internal/baseInvoke.php b/src/internal/baseInvoke.php
@@ -0,0 +1,23 @@
+<?php
+
+// No 'declare(strict_types=1)' here as the invoked method needs to use weak-type{
+
+/*
+ * This file is part of the SolidWorx Lodash-PHP project.
+ *
+ * @author     Pierre du Plessis <open-source@solidworx.co>
+ * @copyright  Copyright (c) 2018
+ */
+
+namespace _\internal;
+
+use function _\last;
+
+function baseInvoke($object, $path, $args)
+{
+    $path = castPath($path, $object);
+    $object = parent($object, $path);
+    $func = null === $object ? $object : [$object, toKey(last($path))];
+
+    return null === $func ? null : $func($object, ...$args);
+}
diff --git a/src/internal/parent.php b/src/internal/parent.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the SolidWorx Lodash-PHP project.
+ *
+ * @author     Pierre du Plessis <open-source@solidworx.co>
+ * @copyright  Copyright (c) 2018
+ */
+
+namespace _\internal;
+
+use function _\{slice, get};
+
+function parent($object, $path)
+{
+    return count($path) < 2 ? $object : get($object, slice($path, 0, -1));
+}
diff --git a/tests/Collection/InvokeMapTest.php b/tests/Collection/InvokeMapTest.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the SolidWorx Lodash-PHP project.
+ *
+ * @author     Pierre du Plessis <open-source@solidworx.co>
+ * @copyright  Copyright (c) 2017
+ */
+
+use function _\invokeMap;
+use PHPUnit\Framework\TestCase;
+
+class InvokeMapTest extends TestCase
+{
+    public function testInvokeMap()
+    {
+        $this->assertSame([[1, 5, 7], [1, 2, 3]], invokeMap([[5, 1, 7], [3, 2, 1]], function($result) { sort($result); return $result;}));
+        $this->assertSame([['1', '2', '3'], ['4', '5', '6']], invokeMap([123, 456], 'str_split'));
+
+        $users = [
+            new class () {
+                public function getCount() { return 12; }
+            },
+            new class () {
+                public function getCount() { return 24; }
+            }
+        ];
+
+        $this->assertEquals([12, 24], invokeMap($users, 'getCount'));
+    }
+}
