Functional\match() to Functional\matching() (#224)

lstrojny · web-flow · commit 52fc803322cc · 2020-08-06T12:55:34.000+02:00
diff --git a/composer.json b/composer.json
@@ -73,7 +73,7 @@
             "src/Functional/LessThanOrEqual.php",
             "src/Functional/LexicographicCompare.php",
             "src/Functional/Map.php",
-            "src/Functional/Match.php",
+            "src/Functional/Matching.php",
             "src/Functional/Maximum.php",
             "src/Functional/Memoize.php",
             "src/Functional/Minimum.php",
diff --git a/src/Functional/Functional.php b/src/Functional/Functional.php
@@ -254,10 +254,16 @@ final class Functional
     const map = '\Functional\map';
 
     /**
-     * @see \Functional\match
+     * @see \Functional\matching
+     * @deprecated
      */
     const match = '\Functional\match';
 
+    /**
+     * @see \Functional\matching
+     */
+    const matching = '\Functional\matching';
+
     /**
      * @see \Functional\maximum
      */
diff --git a/src/Functional/Matching.php b/src/Functional/Matching.php
@@ -16,14 +16,16 @@
 use function Functional\tail;
 use function Functional\if_else;
 
+use const PHP_VERSION_ID;
+
 /**
  * Performs an operation checking for the given conditions
  *
  * @param array $conditions the conditions to check against
  *
  * @return callable|null the function that calls the callable of the first truthy condition
  */
-function match(array $conditions)
+function matching(array $conditions)
 {
     MatchException::assert($conditions, __FUNCTION__);
 
@@ -34,6 +36,19 @@ function match(array $conditions)
 
         list($if, $then) = head($conditions);
 
-        return if_else($if, $then, match(tail($conditions)))($value);
+        return if_else($if, $then, matching(tail($conditions)))($value);
     };
 }
+
+
+if (PHP_VERSION_ID < 80000) {
+    eval(<<<'ALIAS'
+namespace Functional;
+
+function match(array $conditions) {
+    trigger_error('Functional\match() is will be unavailable with PHP 8. Use Functional\matching() instead', E_USER_DEPRECATED);
+    return matching($conditions);
+}
+ALIAS
+    );
+}
diff --git a/tests/Functional/MatchTest.php b/tests/Functional/MatchTest.php
diff --git a/tests/Functional/MatchingTest.php b/tests/Functional/MatchingTest.php
@@ -0,0 +1,111 @@
+<?php
+
+/**
+ * @package   Functional-php
+ * @author    Lars Strojny <lstrojny@php.net>
+ * @copyright 2011-2017 Lars Strojny
+ * @license   https://opensource.org/licenses/MIT MIT
+ * @link      https://github.com/lstrojny/functional-php
+ */
+
+namespace Functional\Tests;
+
+use PHPUnit\Framework\Error\Deprecated;
+
+use function Functional\matching;
+use function Functional\match;
+use function Functional\equal;
+use function Functional\const_function;
+
+use const PHP_VERSION_ID;
+
+class MatchingTest extends AbstractTestCase
+{
+    public function testMatching()
+    {
+        $test = matching(
+            [
+                [equal('foo'), const_function('is foo')],
+                [equal('bar'), const_function('is bar')],
+                [equal('baz'), const_function('is baz')],
+                [
+                    const_function(true),
+                    function ($x) {
+                        return 'default is ' . $x;
+                    }
+                ],
+            ]
+        );
+
+        self::assertEquals('is foo', $test('foo'));
+        self::assertEquals('is bar', $test('bar'));
+        self::assertEquals('is baz', $test('baz'));
+        self::assertEquals('default is qux', $test('qux'));
+    }
+
+    public function testNothingMatching()
+    {
+        $test = matching(
+            [
+                [equal('foo'), const_function('is foo')],
+                [equal('bar'), const_function('is bar')],
+            ]
+        );
+
+        self::assertNull($test('baz'));
+    }
+
+    public function testMatchingConditionIsArray()
+    {
+        $this->expectArgumentError('Functional\matching() expects condition at key 1 to be array, string given');
+
+        matching(
+            [
+                [const_function(null), const_function(null)],
+                '',
+            ]
+        );
+    }
+
+    public function testMatchingConditionLength()
+    {
+        $this->expectArgumentError(
+            'Functional\matching() expects size of condition at key 1 to be greater than or equals to 2, 1 given'
+        );
+
+        matching(
+            [
+                [const_function(''), const_function('')],
+                [''],
+            ]
+        );
+    }
+
+    public function testMatchingConditionCallables()
+    {
+        $this->expectException(\Functional\Exceptions\InvalidArgumentException::class);
+        $this->expectExceptionMessage(
+            'Functional\matching() expects first two items of condition at key 1 to be callables'
+        );
+
+        matching(
+            [
+                [const_function(null), const_function(null)],
+                [const_function(null), ''],
+            ]
+        );
+    }
+
+    public function testDeprecatedAlias()
+    {
+        if (PHP_VERSION_ID >= 80000) {
+            self::markTestSkipped('Only works with PHP <8.0');
+        }
+
+        $this->expectException(
+            Deprecated::class,
+            'Functional\match() is deprecated as it is incompatible with PHP 8. Use Functional\matching() instead'
+        );
+        match([]);
+    }
+}
