Merge pull request #275 from mspirkov/add-resource-pseudo-types

Add support for `open-resource` and `closed-resource`

Author: jaapio

src/PseudoTypes/ClosedResource.php

@@ -0,0 +1,36 @@
+<?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\Resource_;
+
+/**
+ * Value Object representing the type 'closed-resource'.
+ *
+ * @psalm-immutable
+ */
+final class ClosedResource extends Resource_ implements PseudoType
+{
+    public function underlyingType(): Type
+    {
+        return new Resource_();
+    }
+
+    public function __toString(): string
+    {
+        return 'closed-resource';
+    }
+}

src/PseudoTypes/OpenResource.php

@@ -0,0 +1,36 @@
+<?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\Resource_;
+
+/**
+ * Value Object representing the type 'open-resource'.
+ *
+ * @psalm-immutable
+ */
+final class OpenResource extends Resource_ implements PseudoType
+{
+    public function underlyingType(): Type
+    {
+        return new Resource_();
+    }
+
+    public function __toString(): string
+    {
+        return 'open-resource';
+    }
+}

src/TypeResolver.php

@@ -20,6 +20,7 @@
 use phpDocumentor\Reflection\PseudoTypes\ArrayShapeItem;
 use phpDocumentor\Reflection\PseudoTypes\CallableString;
 use phpDocumentor\Reflection\PseudoTypes\ClassString;
+use phpDocumentor\Reflection\PseudoTypes\ClosedResource;
 use phpDocumentor\Reflection\PseudoTypes\Conditional;
 use phpDocumentor\Reflection\PseudoTypes\ConditionalForParameter;
 use phpDocumentor\Reflection\PseudoTypes\ConstExpression;
@@ -56,6 +57,7 @@
 use phpDocumentor\Reflection\PseudoTypes\ObjectShape;
 use phpDocumentor\Reflection\PseudoTypes\ObjectShapeItem;
 use phpDocumentor\Reflection\PseudoTypes\OffsetAccess;
+use phpDocumentor\Reflection\PseudoTypes\OpenResource;
 use phpDocumentor\Reflection\PseudoTypes\PositiveInteger;
 use phpDocumentor\Reflection\PseudoTypes\PrivatePropertiesOf;
 use phpDocumentor\Reflection\PseudoTypes\PropertiesOf;
@@ -170,6 +172,8 @@ final class TypeResolver
         'array-key' => ArrayKey::class,
         'non-empty-array' => NonEmptyArray::class,
         'resource' => Resource_::class,
+        'open-resource' => OpenResource::class,
+        'closed-resource' => ClosedResource::class,
         'void' => Void_::class,
         'null' => Null_::class,
         'scalar' => Scalar::class,

src/Types/Resource_.php

@@ -20,7 +20,7 @@
  *
  * @psalm-immutable
  */
-final class Resource_ implements Type
+class Resource_ implements Type
 {
     /**
      * Returns a rendered output of the Type as it would be used in a DocBlock.

tests/unit/PseudoTypes/ClosedResourceTest.php

@@ -0,0 +1,32 @@
+<?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\Resource_;
+use PHPUnit\Framework\TestCase;
+
+final class ClosedResourceTest extends TestCase
+{
+    public function testCreate(): void
+    {
+        $type = new ClosedResource();
+
+        $this->assertEquals(new Resource_(), $type->underlyingType());
+    }
+
+    public function testToString(): void
+    {
+        $this->assertSame('closed-resource', (string) (new ClosedResource()));
+    }
+}

tests/unit/PseudoTypes/OpenResourceTest.php

@@ -0,0 +1,32 @@
+<?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\Resource_;
+use PHPUnit\Framework\TestCase;
+
+final class OpenResourceTest extends TestCase
+{
+    public function testCreate(): void
+    {
+        $type = new OpenResource();
+
+        $this->assertEquals(new Resource_(), $type->underlyingType());
+    }
+
+    public function testToString(): void
+    {
+        $this->assertSame('open-resource', (string) (new OpenResource()));
+    }
+}

tests/unit/TypeResolverTest.php

@@ -20,6 +20,7 @@
 use phpDocumentor\Reflection\PseudoTypes\ArrayShapeItem;
 use phpDocumentor\Reflection\PseudoTypes\CallableString;
 use phpDocumentor\Reflection\PseudoTypes\ClassString;
+use phpDocumentor\Reflection\PseudoTypes\ClosedResource;
 use phpDocumentor\Reflection\PseudoTypes\Conditional;
 use phpDocumentor\Reflection\PseudoTypes\ConditionalForParameter;
 use phpDocumentor\Reflection\PseudoTypes\ConstExpression;
@@ -56,6 +57,7 @@
 use phpDocumentor\Reflection\PseudoTypes\ObjectShape;
 use phpDocumentor\Reflection\PseudoTypes\ObjectShapeItem;
 use phpDocumentor\Reflection\PseudoTypes\OffsetAccess;
+use phpDocumentor\Reflection\PseudoTypes\OpenResource;
 use phpDocumentor\Reflection\PseudoTypes\PositiveInteger;
 use phpDocumentor\Reflection\PseudoTypes\PrivatePropertiesOf;
 use phpDocumentor\Reflection\PseudoTypes\PropertiesOf;
@@ -663,6 +665,8 @@ public function provideKeywords(): array
             ['false', Boolean::class],
             ['false', False_::class],
             ['resource', Resource_::class],
+            ['open-resource', OpenResource::class],
+            ['closed-resource', ClosedResource::class],
             ['null', Null_::class],
             ['callable', Callable_::class],
             ['callable-string', CallableString::class],