Merge pull request #206 from phpDocumentor/feature/non-empty-array

Add support for non-empty-array notation
phpDocumentor · Mar 22, 2024 · f237fbd · f237fbd
2 parents 153ae66 + 6f50ece
commit f237fbd
Show file tree

Hide file tree

Showing 5 changed files with 108 additions and 1 deletion.
diff --git a/src/PseudoTypes/NonEmptyArray.php b/src/PseudoTypes/NonEmptyArray.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link      http://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\PseudoTypes;
+
+use phpDocumentor\Reflection\PseudoType;
+use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\Array_;
+use phpDocumentor\Reflection\Types\Mixed_;
+
+/**
+ * Value Object representing the type 'non-empty-array'.
+ *
+ * @psalm-immutable
+ */
+final class NonEmptyArray extends Array_ implements PseudoType
+{
+    public function underlyingType(): Type
+    {
+        return new Array_($this->valueType, $this->keyType);
+    }
+
+    /**
+     * Returns a rendered output of the Type as it would be used in a DocBlock.
+     */
+    public function __toString(): string
+    {
+        if ($this->keyType) {
+            return 'non-empty-array<' . $this->keyType . ',' . $this->valueType . '>';
+        }
+
+        if ($this->valueType instanceof Mixed_) {
+            return 'non-empty-array';
+        }
+
+        return 'non-empty-array<' . $this->valueType . '>';
+    }
+}
diff --git a/src/PseudoTypes/NonEmptyList.php b/src/PseudoTypes/NonEmptyList.php
@@ -28,7 +28,7 @@ final class NonEmptyList extends Array_ implements PseudoType
 {
     public function underlyingType(): Type
     {
-        return new Array_();
+        return new Array_($this->valueType, $this->keyType);
     }
 
     public function __construct(?Type $valueType = null)

diff --git a/src/TypeResolver.php b/src/TypeResolver.php
@@ -28,6 +28,7 @@
 use phpDocumentor\Reflection\PseudoTypes\LiteralString;
 use phpDocumentor\Reflection\PseudoTypes\LowercaseString;
 use phpDocumentor\Reflection\PseudoTypes\NegativeInteger;
+use phpDocumentor\Reflection\PseudoTypes\NonEmptyArray;
 use phpDocumentor\Reflection\PseudoTypes\NonEmptyList;
 use phpDocumentor\Reflection\PseudoTypes\NonEmptyLowercaseString;
 use phpDocumentor\Reflection\PseudoTypes\NonEmptyString;
@@ -139,6 +140,7 @@ final class TypeResolver
         'mixed' => Mixed_::class,
         'array' => Array_::class,
         'array-key' => ArrayKey::class,
+        'non-empty-array' => NonEmptyArray::class,
         'resource' => Resource_::class,
         'void' => Void_::class,
         'null' => Null_::class,

diff --git a/tests/unit/PseudoTypes/NonEmptyArrayTest.php b/tests/unit/PseudoTypes/NonEmptyArrayTest.php
@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link      http://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\PseudoTypes;
+
+use phpDocumentor\Reflection\Types\Compound;
+use phpDocumentor\Reflection\Types\Integer;
+use phpDocumentor\Reflection\Types\Mixed_;
+use phpDocumentor\Reflection\Types\String_;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @coversDefaultClass \phpDocumentor\Reflection\PseudoTypes\NonEmptyArray
+ */
+class NonEmptyArrayTest extends TestCase
+{
+    /**
+     * @dataProvider provideArrays
+     * @covers ::__toString
+     */
+    public function testArrayStringifyCorrectly(NonEmptyArray $array, string $expectedString): void
+    {
+        $this->assertSame($expectedString, (string) $array);
+    }
+
+    /**
+     * @return mixed[]
+     */
+    public function provideArrays(): array
+    {
+        return [
+            'simple non-empty-array' => [new NonEmptyArray(), 'non-empty-array'],
+            'non-empty-array of mixed' => [new NonEmptyArray(new Mixed_()), 'non-empty-array'],
+            'non-empty-array of single type' => [new NonEmptyArray(new String_()), 'non-empty-array<string>'],
+            'non-empty-array of compound type' =>
+                [
+                    new NonEmptyArray(
+                        new Compound([new Integer(), new String_()]),
+                        new String_()
+                    ),
+                    'non-empty-array<string,int|string>',
+                ],
+        ];
+    }
+}
diff --git a/tests/unit/TypeResolverTest.php b/tests/unit/TypeResolverTest.php
@@ -26,6 +26,7 @@
 use phpDocumentor\Reflection\PseudoTypes\LiteralString;
 use phpDocumentor\Reflection\PseudoTypes\LowercaseString;
 use phpDocumentor\Reflection\PseudoTypes\NegativeInteger;
+use phpDocumentor\Reflection\PseudoTypes\NonEmptyArray;
 use phpDocumentor\Reflection\PseudoTypes\NonEmptyList;
 use phpDocumentor\Reflection\PseudoTypes\NonEmptyLowercaseString;
 use phpDocumentor\Reflection\PseudoTypes\NonEmptyString;
@@ -789,6 +790,7 @@ public function provideKeywords(): array
             ['literal-string', LiteralString::class],
             ['list', List_::class],
             ['non-empty-list', NonEmptyList::class],
+            ['non-empty-array', NonEmptyArray::class],
         ];
     }