Add support for never-return

Author: mspirkov

src/PseudoTypes/NeverReturn.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\Never_;
+
+/**
+ * Value Object representing the type 'never-return'.
+ *
+ * @psalm-immutable
+ */
+final class NeverReturn extends Never_ implements PseudoType
+{
+    public function underlyingType(): Type
+    {
+        return new Never_();
+    }
+
+    public function __toString(): string
+    {
+        return 'never-return';
+    }
+}

src/TypeResolver.php

@@ -40,6 +40,7 @@
 use phpDocumentor\Reflection\PseudoTypes\LiteralString;
 use phpDocumentor\Reflection\PseudoTypes\LowercaseString;
 use phpDocumentor\Reflection\PseudoTypes\NegativeInteger;
+use phpDocumentor\Reflection\PseudoTypes\NeverReturn;
 use phpDocumentor\Reflection\PseudoTypes\NonEmptyArray;
 use phpDocumentor\Reflection\PseudoTypes\NonEmptyList;
 use phpDocumentor\Reflection\PseudoTypes\NonEmptyLowercaseString;
@@ -182,6 +183,7 @@ final class TypeResolver
         'parent' => Parent_::class,
         'iterable' => Iterable_::class,
         'never' => Never_::class,
+        'never-return' => NeverReturn::class,
         'list' => List_::class,
         'non-empty-list' => NonEmptyList::class,
         'non-falsy-string' => NonFalsyString::class,

src/Types/Never_.php

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

tests/unit/PseudoTypes/NeverReturnTest.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\Never_;
+use PHPUnit\Framework\TestCase;
+
+final class NeverReturnTest extends TestCase
+{
+    public function testCreate(): void
+    {
+        $type = new NeverReturn();
+
+        $this->assertEquals(new Never_(), $type->underlyingType());
+    }
+
+    public function testToString(): void
+    {
+        $this->assertSame('never-return', (string) (new NeverReturn()));
+    }
+}

tests/unit/TypeResolverTest.php

@@ -40,6 +40,7 @@
 use phpDocumentor\Reflection\PseudoTypes\LiteralString;
 use phpDocumentor\Reflection\PseudoTypes\LowercaseString;
 use phpDocumentor\Reflection\PseudoTypes\NegativeInteger;
+use phpDocumentor\Reflection\PseudoTypes\NeverReturn;
 use phpDocumentor\Reflection\PseudoTypes\NonEmptyArray;
 use phpDocumentor\Reflection\PseudoTypes\NonEmptyList;
 use phpDocumentor\Reflection\PseudoTypes\NonEmptyLowercaseString;
@@ -676,6 +677,7 @@ public function provideKeywords(): array
             ['parent', Parent_::class],
             ['iterable', Iterable_::class],
             ['never', Never_::class],
+            ['never-return', NeverReturn::class],
             ['literal-string', LiteralString::class],
             ['list', List_::class],
             ['non-empty-list', NonEmptyList::class],