Feature/variadic union type improvemence

src/Psl/Type/literal_scalar.php

@@ -18,7 +18,7 @@
 function literal_scalar($value): TypeInterface
 {
     /** @psalm-suppress MissingThrowsDocblock */
-    union(union(string(), bool()), num())->assert($value);
+    union(string(), bool(), num())->assert($value);
 
     return new Internal\LiteralScalarType($value);
 }

src/Psl/Type/union.php

@@ -7,19 +7,26 @@
 use Psl;
 
 /**
- * @template Tl
- * @template Tr
+ * @template T
  *
- * @param TypeInterface<Tl> $left_type
- * @param TypeInterface<Tr> $right_type
+ * @param TypeInterface<T> $first
+ * @param TypeInterface<T> $second
+ * @param TypeInterface<T> ...$rest
  *
- * @throws Psl\Exception\InvariantViolationException If $left_type, or $right_type is optional.
+ * @throws Psl\Exception\InvariantViolationException If $first, $second or one of $rest is optional.
  *
- * @return TypeInterface<Tl|Tr>
+ * @return TypeInterface<T>
  */
 function union(
-    TypeInterface $left_type,
-    TypeInterface $right_type
+    TypeInterface $first,
+    TypeInterface $second,
+    TypeInterface ...$rest
 ): TypeInterface {
-    return new Internal\UnionType($left_type, $right_type);
+    $accumulated_type = new Internal\UnionType($first, $second);
+
+    foreach ($rest as $type) {
+        $accumulated_type = new Internal\UnionType($accumulated_type, $type);
+    }
+
+    return $accumulated_type;
 }

tests/static-analysis/Type/union.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+use Psl\Type;
+
+/**
+ * @psalm-suppress UnusedParam
+ *
+ * @param 'PENDING'|'PROCESSING'|'COMPLETED'|'ERROR' $state
+ */
+function takes_valid_state(string $state): void
+{
+}
+
+function test(): void
+{
+    /** @psalm-suppress MissingThrowsDocblock */
+    $old_school_codec = Type\union(
+        Type\literal_scalar('PENDING'),
+        Type\union(
+            Type\literal_scalar('PROCESSING'),
+            Type\union(
+                Type\literal_scalar('COMPLETED'),
+                Type\literal_scalar('ERROR'),
+            )
+        )
+    );
+
+    /** @psalm-suppress MissingThrowsDocblock */
+    $new_codec = Type\union(
+        Type\literal_scalar('PENDING'),
+        Type\literal_scalar('PROCESSING'),
+        Type\literal_scalar('COMPLETED'),
+        Type\literal_scalar('ERROR'),
+    );
+
+    /** @psalm-suppress MissingThrowsDocblock */
+    takes_valid_state($old_school_codec->assert('any'));
+
+    /** @psalm-suppress MissingThrowsDocblock */
+    takes_valid_state($new_codec->assert('any'));
+}

tests/unit/Type/UnionTypeTest.php

@@ -39,7 +39,7 @@ public function getToStringExamples(): iterable
     {
         yield [Type\union(Type\bool(), Type\string()), 'bool|string'];
         yield [Type\union(Type\bool(), Type\float()), 'bool|float'];
-        yield [Type\union(Type\bool(), Type\union(Type\float(), Type\int())), 'bool|float|int'];
+        yield [Type\union(Type\bool(), Type\float(), Type\int()), 'bool|float|int'];
         yield [Type\union(Type\bool(), Type\num()), 'bool|num'];
         yield [Type\union(Type\bool(), Type\array_key()), 'bool|array-key'];
         yield [
@@ -58,9 +58,20 @@ public function getToStringExamples(): iterable
                     Type\object(IndexAccessInterface::class),
                     Type\object(CollectionInterface::class)
                 ),
-                Type\bool()
+                Type\bool(),
+                Type\non_empty_string()
+            ),
+            '((Psl\Collection\IndexAccessInterface&Psl\Collection\CollectionInterface)|bool)|non-empty-string'
+        ];
+        yield [
+            Type\union(
+                Type\null(),
+                Type\vec(Type\positive_int()),
+                Type\literal_scalar('php'),
+                Type\literal_scalar('still'),
+                Type\literal_scalar('alive'),
             ),
-            '(Psl\Collection\IndexAccessInterface&Psl\Collection\CollectionInterface)|bool'
+            'null|list<positive-int>|"php"|"still"|"alive"'
         ];
     }
 }