Add ary function which ignores arguments over the supplied number (#215)

someonewithpc · web-flow · commit f9659458c468 · 2020-06-09T16:16:59.000+02:00
* Add `ary`, a function which ignores arguments over the supplied number Added function which defines a function of an arbitry number of arguments and calls the provided callable with only the given number of arguments As suggested by @lstrojny, using the name `ary`, like in https://lodash.com/docs/4.17.15#ary * Added test for `ary` function * Fixed errors spit by vendor/bin/phpcs * Fix implementation and tests
diff --git a/composer.json b/composer.json
@@ -25,6 +25,7 @@
     "autoload": {
         "psr-4": {"Functional\\": "src/Functional"},
         "files": [
+            "src/Functional/Ary.php",
             "src/Functional/Average.php",
             "src/Functional/ButLast.php",
             "src/Functional/Capture.php",
diff --git a/docs/functional-php.md b/docs/functional-php.md
@@ -356,6 +356,26 @@ $partiallyAppliedSubtractor = partial_right($subtractor, 10);
 $partiallyAppliedSubtractor(20); // -> 10
 ```
 
+## ary()
+
+`Functional\ary` (as in arity) takes a `callable` and a count and calls the `callable` with 
+that many arguments using `take_left` if positive, or `take_right` if negative. 
+Throws if passed 0.
+
+For example:
+
+```php
+use function Functional\ary;
+use function Functional\map;
+
+# This fails because map calls it's callable with the element, 
+# index and the whole collection
+# map($array, 'ucfirst');
+
+# Using `ary`
+map($array, ary('ucfirst', 1')); # Passes only the first argument to `ucfirst`
+```
+
 ## partial_any()
 
 There is a third function in the family called `partial_any`. Unlike its siblings it doesn’t automatically merge but it
diff --git a/src/Functional/Ary.php b/src/Functional/Ary.php
@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * @package   Functional-php
+ * @author    Hugo Sales <hugo@fc.up.pt>
+ * @copyright 2020 Hugo Sales
+ * @license   https://opensource.org/licenses/MIT MIT
+ * @link      https://github.com/lstrojny/functional-php
+ */
+
+namespace Functional;
+
+use Functional\Exceptions\InvalidArgumentException;
+use Traversable;
+
+/**
+ * Call $func with only abs($count) arguments, taken either from the
+ * left or right depending on the sign
+ */
+function ary(callable $func, int $count): callable
+{
+    InvalidArgumentException::assertNonZeroInteger($count, __FUNCTION__);
+
+    return function (...$args) use ($func, $count) {
+        if ($count > 0) {
+            return $func(...take_left($args, $count));
+        } else if ($count < 0) {
+            return $func(...take_right($args, -$count));
+        }
+    };
+}
diff --git a/src/Functional/Exceptions/InvalidArgumentException.php b/src/Functional/Exceptions/InvalidArgumentException.php
@@ -280,6 +280,13 @@ private static function assertCollectionAlike($collection, $className, $callee,
         }
     }
 
+    public static function assertNonZeroInteger($value, $callee)
+    {
+        if (!\is_int($value) || $value == 0) {
+            throw new static(\sprintf('%s expected parameter %d to be non-zero', $callee, $value));
+        }
+    }
+
     private static function getType($value)
     {
         return \is_object($value) ? \get_class($value) : \gettype($value);
diff --git a/src/Functional/Functional.php b/src/Functional/Functional.php
@@ -12,6 +12,12 @@
 
 final class Functional
 {
+
+    /**
+     * @see \Function\ary
+     */
+    const ary = '\Functional\ary';
+
     /**
      * @see \Functional\average
      */
diff --git a/tests/Functional/AryTest.php b/tests/Functional/AryTest.php
@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * @package   Functional-php
+ * @author    Hugo Sales <hugo@fc.up.pt>
+ * @copyright 2020 Hugo Sales
+ * @license   https://opensource.org/licenses/MIT MIT
+ * @link      https://github.com/lstrojny/functional-php
+ */
+
+namespace Functional\Tests;
+
+use function Functional\ary;
+use Functional\Exceptions\InvalidArgumentException;
+
+class AryTest extends AbstractTestCase
+{
+
+    public function test()
+    {
+        $f = function ($a = 0, $b = 0, $c = 0) {
+            return $a + $b + $c;
+        };
+
+        $this->assertSame(5, $f(5));
+        $this->assertSame(5, ary($f, 1)(5));
+        $this->assertSame(5, ary($f, 1)(5));
+        $this->assertSame(6, ary($f, -1)(6));
+        $this->assertSame(7, ary($f, 2)(5, 2));
+    }
+
+    public function testException()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $f = function ($a = 0, $b = 0, $c = 0) {
+            return $a + $b + $c;
+        };
+
+        ary($f, 0)(5);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -280,6 +280,13 @@ private static function assertCollectionAlike($collection, $className, $callee,`
`280`	`280`	`}`
`281`	`281`	`}`
`282`	`282`
	`283`	`+ public static function assertNonZeroInteger($value, $callee)`
	`284`	`+ {`
	`285`	`+ if (!\is_int($value) \|\| $value == 0) {`
	`286`	`+ throw new static(\sprintf('%s expected parameter %d to be non-zero', $callee, $value));`
	`287`	`+ }`
	`288`	`+ }`
	`289`	`+`
`283`	`290`	`private static function getType($value)`
`284`	`291`	`{`
`285`	`292`	`return \is_object($value) ? \get_class($value) : \gettype($value);`