Add Function.ary function

pierredup · pierredup · commit 700e7661eb9a · 2018-12-10T23:41:44.000+02:00
diff --git a/src/Function/ary.php b/src/Function/ary.php
@@ -0,0 +1,38 @@
+<?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
+ */
+
+namespace _;
+
+/**
+ * Creates a function that invokes `func`, with up to `n` arguments,
+ * ignoring any additional arguments.
+ *
+ * @category Function
+ *
+ * @param callable $func The function to cap arguments for.
+ * @param int      $n    The arity cap.
+ *
+ * @return Callable Returns the new capped function.
+ *
+ * @example
+ * <code>
+ * map(['6', '8', '10'], ary('intval', 1));
+ * // => [6, 8, 10]
+ * </code>
+ */
+function ary(callable $func, int $n): callable
+{
+    return function (...$args) use ($func, $n) {
+        \array_splice($args, $n);
+
+        return $func(...$args);
+    };
+}
diff --git a/tests/Function/AryTest.php b/tests/Function/AryTest.php
@@ -0,0 +1,22 @@
+<?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 _\ary;
+use function _\map;
+use PHPUnit\Framework\TestCase;
+
+class AryTest extends TestCase
+{
+    public function testAry()
+    {
+        $this->assertSame([6, 8, 10], map(['6', '8', '10'], ary('intval', 1)));
+    }
+}
