[TypeInfo] Add ArrayShapeType::$sealed

mtarld · mtarld · commit 62a0dab8f214 · 2025-03-15T14:18:18.000+01:00
diff --git a/src/Symfony/Component/TypeInfo/CHANGELOG.md b/src/Symfony/Component/TypeInfo/CHANGELOG.md
@@ -11,6 +11,7 @@ CHANGELOG
  * Add type alias support in `TypeContext` and `StringTypeResolver`
  * Add `CollectionType::mergeCollectionValueTypes()` method
  * Add `ArrayShapeType` to represent the exact shape of an array
+ * Add `ArrayShapeType::$sealed` to represent array shape with extra keys
 
 7.2
 ---
diff --git a/src/Symfony/Component/TypeInfo/Tests/Type/ArrayShapeTypeTest.php b/src/Symfony/Component/TypeInfo/Tests/Type/ArrayShapeTypeTest.php
@@ -76,6 +76,10 @@ public function testAccepts()
 
         $this->assertTrue($type->accepts(['foo' => true]));
         $this->assertTrue($type->accepts(['foo' => true, 'bar' => 'string']));
+
+        $type = new ArrayShapeType(['foo' => ['type' => Type::bool()]], sealed: false);
+
+        $this->assertTrue($type->accepts(['foo' => true, 'other' => 'string']));
     }
 
     public function testToString()
@@ -94,5 +98,10 @@ public function testToString()
             'bar' => ['type' => Type::string(), 'optional' => true],
         ]);
         $this->assertSame("array{'bar'?: string, 'foo': bool}", (string) $type);
+
+        $type = new ArrayShapeType([
+            'foo' => ['type' => Type::bool()],
+        ], sealed: false);
+        $this->assertSame("array{'foo': bool, ...}", (string) $type);
     }
 }
diff --git a/src/Symfony/Component/TypeInfo/Tests/TypeResolver/StringTypeResolverTest.php b/src/Symfony/Component/TypeInfo/Tests/TypeResolver/StringTypeResolverTest.php
@@ -76,6 +76,7 @@ public static function resolveDataProvider(): iterable
         // array shape
         yield [Type::arrayShape(['foo' => Type::true(), 1 => Type::false()]), 'array{foo: true, 1: false}'];
         yield [Type::arrayShape(['foo' => ['type' => Type::bool(), 'optional' => true]]), 'array{foo?: bool}'];
+        yield [Type::arrayShape(['foo' => Type::bool()], sealed: false), 'array{foo: bool, ...}'];
 
         // object shape
         yield [Type::object(), 'object{foo: true, bar: false}'];
diff --git a/src/Symfony/Component/TypeInfo/Type/ArrayShapeType.php b/src/Symfony/Component/TypeInfo/Type/ArrayShapeType.php
@@ -31,8 +31,10 @@ final class ArrayShapeType extends CollectionType
     /**
      * @param array<array{type: Type, optional: bool}> $shape
      */
-    public function __construct(array $shape)
-    {
+    public function __construct(
+        array $shape,
+        private readonly bool $sealed = true,
+    ) {
         $keyTypes = [];
         $valueTypes = [];
 
@@ -66,6 +68,11 @@ public function getShape(): array
         return $this->shape;
     }
 
+    public function isSealed(): bool
+    {
+        return $this->sealed;
+    }
+
     public function accepts(mixed $value): bool
     {
         if (!\is_array($value)) {
@@ -81,7 +88,7 @@ public function accepts(mixed $value): bool
         foreach ($value as $key => $itemValue) {
             $valueType = $this->shape[$key]['type'] ?? false;
             if (!$valueType) {
-                return false;
+                return !$this->sealed;
             }
 
             if (!$valueType->accepts($itemValue)) {
@@ -105,6 +112,10 @@ public function __toString(): string
             $items[] = \sprintf('%s: %s', $itemKey, $value['type']);
         }
 
+        if (!$this->sealed) {
+            $items[] = '...';
+        }
+
         return \sprintf('array{%s}', implode(', ', $items));
     }
 }
diff --git a/src/Symfony/Component/TypeInfo/TypeFactoryTrait.php b/src/Symfony/Component/TypeInfo/TypeFactoryTrait.php
@@ -198,13 +198,13 @@ public static function dict(?Type $value = null): CollectionType
     /**
      * @param array<array{type: Type, optional?: bool}|Type> $shape
      */
-    public static function arrayShape(array $shape): ArrayShapeType
+    public static function arrayShape(array $shape, bool $sealed = true): ArrayShapeType
     {
         return new ArrayShapeType(array_map(static function (array|Type $item): array {
             return $item instanceof Type
                 ? ['type' => $item, 'optional' => false]
                 : ['type' => $item['type'], 'optional' => $item['optional'] ?? false];
-        }, $shape));
+        }, $shape), $sealed);
     }
 
     /**
diff --git a/src/Symfony/Component/TypeInfo/TypeResolver/StringTypeResolver.php b/src/Symfony/Component/TypeInfo/TypeResolver/StringTypeResolver.php
@@ -110,7 +110,7 @@ private function getTypeFromNode(TypeNode $node, ?TypeContext $typeContext): Typ
                 ];
             }
 
-            return Type::arrayShape($shape);
+            return Type::arrayShape($shape, $node->sealed);
         }
 
         if ($node instanceof ObjectShapeNode) {

Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,10 @@ public function testAccepts()`
`76`	`76`
`77`	`77`	`$this->assertTrue($type->accepts(['foo' => true]));`
`78`	`78`	`$this->assertTrue($type->accepts(['foo' => true, 'bar' => 'string']));`
	`79`	`+`
	`80`	`+ $type = new ArrayShapeType(['foo' => ['type' => Type::bool()]], sealed: false);`
	`81`	`+`
	`82`	`+ $this->assertTrue($type->accepts(['foo' => true, 'other' => 'string']));`
`79`	`83`	`}`
`80`	`84`
`81`	`85`	`public function testToString()`
`@@ -94,5 +98,10 @@ public function testToString()`
`94`	`98`	`'bar' => ['type' => Type::string(), 'optional' => true],`
`95`	`99`	`]);`
`96`	`100`	`$this->assertSame("array{'bar'?: string, 'foo': bool}", (string) $type);`
	`101`	`+`
	`102`	`+ $type = new ArrayShapeType([`
	`103`	`+ 'foo' => ['type' => Type::bool()],`
	`104`	`+ ], sealed: false);`
	`105`	`+ $this->assertSame("array{'foo': bool, ...}", (string) $type);`
`97`	`106`	`}`
`98`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ private function getTypeFromNode(TypeNode $node, ?TypeContext $typeContext): Typ`
`110`	`110`	`];`
`111`	`111`	`}`
`112`	`112`
`113`		`- return Type::arrayShape($shape);`
	`113`	`+ return Type::arrayShape($shape, $node->sealed);`
`114`	`114`	`}`
`115`	`115`
`116`	`116`	`if ($node instanceof ObjectShapeNode) {`