[Functional] deprecate cond and condLazy. Option::when and Option::unless have been added.

Author: whsv26

src/Fp/Collections/ArrayList.php

@@ -146,9 +146,10 @@ public function toArrayList(): ArrayList
      */
     public function toNonEmptyArrayList(): Option
     {
-        return Option::cond(
+        $that = $this;
+        return Option::when(
             $this->isNonEmpty(),
-            new NonEmptyArrayList($this)
+            fn() => new NonEmptyArrayList($that)
         );
     }
 

src/Fp/Collections/LinkedList.php

@@ -144,9 +144,9 @@ public function toNonEmptyArrayList(): Option
     {
         $arrayList = $this->toArrayList();
 
-        return Option::cond(
+        return Option::when(
             $arrayList->isNonEmpty(),
-            new NonEmptyArrayList($arrayList)
+            fn() => new NonEmptyArrayList($arrayList)
         );
     }
 

src/Fp/Collections/NonEmptyArrayList.php

@@ -54,7 +54,7 @@ public static function collect(iterable $source): Option
     {
         $arrayList = ArrayList::collect($source);
 
-        return Option::condLazy(
+        return Option::when(
             $arrayList->isNonEmpty(),
             fn() => new self($arrayList)
         );

src/Fp/Collections/NonEmptyHashMap.php

@@ -92,7 +92,7 @@ public static function collectPairs(iterable $source): Option
 
         $isEmpty = empty($hashTable->table);
 
-        return Option::condLazy(!$isEmpty, fn() => new HashMap($hashTable))
+        return Option::when(!$isEmpty, fn() => new HashMap($hashTable))
             ->map(fn(HashMap $map) => new self($map));
     }
 

src/Fp/Collections/NonEmptyHashSet.php

@@ -48,7 +48,7 @@ public function __construct(private HashSet $set)
     public static function collect(iterable $source): Option
     {
         $hashset = HashSet::collect($source);
-        return Option::condLazy(!$hashset->isEmpty(), fn() => new self($hashset));
+        return Option::when(!$hashset->isEmpty(), fn() => new self($hashset));
     }
 
     /**

src/Fp/Functional/Option/Option.php

@@ -617,6 +617,8 @@ public function toRight(callable $left): Either
     }
 
     /**
+     * @deprecated use {@see Option::when}
+     *
      * Fabric method.
      *
      * ```php
@@ -640,6 +642,8 @@ public static function cond(bool $condition, mixed $some): Option
     }
 
     /**
+     * @deprecated use {@see Option::when}
+     *
      * Fabric method.
      *
      * ```php
@@ -665,6 +669,56 @@ public static function condLazy(bool $condition, callable $some): Option
             : self::none();
     }
 
+    /**
+     * Fabric method.
+     *
+     * ```php
+     * >>> Option::when(true, fn() => 1);
+     * => Some(1)
+     *
+     * >>> Option::when(false, fn() => 1);
+     * => None
+     * ```
+     *
+     * Create {@see Some} from value if given condition is true
+     * Create {@see None} if given condition is false
+     *
+     * @psalm-pure
+     * @psalm-template AI
+     * @psalm-param pure-callable(): AI $callback
+     * @psalm-return Option<AI>
+     */
+    public static function when(bool $condition, callable $callback): Option
+    {
+        return $condition
+            ? self::some($callback())
+            : self::none();
+    }
+
+    /**
+     * Fabric method.
+     *
+     * ```php
+     * >>> Option::unless(false, fn() => 1);
+     * => Some(1)
+     *
+     * >>> Option::unless(true, fn() => 1);
+     * => None
+     * ```
+     *
+     * Create {@see Some} from value if given condition is false
+     * Create {@see None} if given condition is true
+     *
+     * @psalm-pure
+     * @psalm-template AI
+     * @psalm-param pure-callable(): AI $callback
+     * @psalm-return Option<AI>
+     */
+    public static function unless(bool $condition, callable $callback): Option
+    {
+        return self::when(!$condition, $callback);
+    }
+
     /**
      * Convert optional value to ArrayList collection
      * via transformation function $callback.

src/Fp/Functions/Collection/At.php

@@ -30,7 +30,7 @@ function at(iterable $collection, int|string $key): Option
 {
     return Option::some($collection)
         ->filter(fn($coll) => is_array($coll))
-        ->flatMap(fn(array $coll) => Option::condLazy(array_key_exists($key, $coll), fn() => $coll[$key]))
+        ->flatMap(fn(array $coll) => Option::when(array_key_exists($key, $coll), fn() => $coll[$key]))
         ->orElse(fn() => AtOperation::of($collection)($key));
 }
 

src/Fp/Streams/Stream.php

@@ -667,9 +667,9 @@ public function toNonEmptyArrayList(): Option
     {
         $arrayList = $this->leaf(ArrayList::collect($this->emitter));
 
-        return Option::cond(
+        return Option::when(
             $arrayList->isNonEmpty(),
-            new NonEmptyArrayList($arrayList)
+            fn() => new NonEmptyArrayList($arrayList)
         );
     }
 

tests/Runtime/Classes/Option/OptionTest.php

@@ -187,6 +187,15 @@ public function testCond(): void
         $this->assertNull(Option::cond(false, 'some')->get());
     }
 
+    public function testWhenAndUnless(): void
+    {
+        $this->assertEquals('some', Option::when(true, fn() => 'some')->get());
+        $this->assertNull(Option::when(false, fn() => throw new Error())->get());
+
+        $this->assertEquals('some', Option::unless(false, fn() => 'some')->get());
+        $this->assertNull(Option::unless(true, fn() => throw new Error())->get());
+    }
+
     public function testTap(): void
     {
         $this->assertEquals(1, Option::some(1)->tap(fn($e) => $e)->get());