support psalm scalar types

Author: smoench

src/TypeResolver.php

@@ -25,6 +25,7 @@
 use phpDocumentor\Reflection\Types\Intersection;
 use phpDocumentor\Reflection\Types\Iterable_;
 use phpDocumentor\Reflection\Types\Nullable;
+use phpDocumentor\Reflection\Types\NumericString;
 use phpDocumentor\Reflection\Types\Object_;
 use phpDocumentor\Reflection\Types\String_;
 use RuntimeException;
@@ -71,6 +72,7 @@ final class TypeResolver
     private $keywords = [
         'string' => Types\String_::class,
         'class-string' => Types\ClassString::class,
+        'trait-string' => Types\TraitString::class,
         'int' => Types\Integer::class,
         'integer' => Types\Integer::class,
         'bool' => Types\Boolean::class,
@@ -81,19 +83,22 @@ final class TypeResolver
         'object' => Object_::class,
         'mixed' => Types\Mixed_::class,
         'array' => Array_::class,
+        'array-key' => Types\ArrayKey::class,
         'resource' => Types\Resource_::class,
         'void' => Types\Void_::class,
         'null' => Types\Null_::class,
         'scalar' => Types\Scalar::class,
         'callback' => Types\Callable_::class,
         'callable' => Types\Callable_::class,
+        'callable-string' => Types\CallableString::class,
         'false' => Types\False_::class,
         'true' => Types\True_::class,
         'self' => Types\Self_::class,
         '$this' => Types\This::class,
         'static' => Types\Static_::class,
         'parent' => Types\Parent_::class,
         'iterable' => Iterable_::class,
+        'numeric-string' => NumericString::class,
     ];
 
     /**

src/Types/ArrayKey.php

@@ -0,0 +1,34 @@
+<?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\Types;
+
+/**
+ * Value Object representing a array-key Type.
+ *
+ * A array-key Type is the supertype (but not a union) of int and string.
+ *
+ * @psalm-immutable
+ */
+final class ArrayKey extends AggregatedType
+{
+    public function __construct()
+    {
+        parent::__construct([new String_(), new Integer()], '|');
+    }
+
+    public function __toString() : string
+    {
+        return 'array-key';
+    }
+}

src/Types/CallableString.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\Types;
+
+use phpDocumentor\Reflection\Type;
+
+/**
+ * Value Object representing the type 'string'.
+ *
+ * @psalm-immutable
+ */
+final class CallableString implements Type
+{
+    /**
+     * Returns a rendered output of the Type as it would be used in a DocBlock.
+     */
+    public function __toString() : string
+    {
+        return 'callable-string';
+    }
+}

src/Types/NumericString.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\Types;
+
+use phpDocumentor\Reflection\Type;
+
+/**
+ * Value Object representing the type 'string'.
+ *
+ * @psalm-immutable
+ */
+final class NumericString implements Type
+{
+    /**
+     * Returns a rendered output of the Type as it would be used in a DocBlock.
+     */
+    public function __toString() : string
+    {
+        return 'numeric-string';
+    }
+}

src/Types/TraitString.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\Types;
+
+use phpDocumentor\Reflection\Type;
+
+/**
+ * Value Object representing the type 'string'.
+ *
+ * @psalm-immutable
+ */
+final class TraitString implements Type
+{
+    /**
+     * Returns a rendered output of the Type as it would be used in a DocBlock.
+     */
+    public function __toString() : string
+    {
+        return 'trait-string';
+    }
+}

tests/unit/TypeResolverTest.php

@@ -23,6 +23,7 @@
 use phpDocumentor\Reflection\Types\Iterable_;
 use phpDocumentor\Reflection\Types\Null_;
 use phpDocumentor\Reflection\Types\Nullable;
+use phpDocumentor\Reflection\Types\NumericString;
 use phpDocumentor\Reflection\Types\Object_;
 use phpDocumentor\Reflection\Types\String_;
 use PHPUnit\Framework\TestCase;
@@ -697,6 +698,7 @@ public function provideKeywords() : array
         return [
             ['string', Types\String_::class],
             ['class-string', Types\ClassString::class],
+            ['trait-string', Types\TraitString::class],
             ['int', Types\Integer::class],
             ['integer', Types\Integer::class],
             ['float', Types\Float_::class],
@@ -710,8 +712,10 @@ public function provideKeywords() : array
             ['resource', Types\Resource_::class],
             ['null', Types\Null_::class],
             ['callable', Types\Callable_::class],
+            ['callable-string', Types\CallableString::class],
             ['callback', Types\Callable_::class],
             ['array', Array_::class],
+            ['array-key', Types\ArrayKey::class],
             ['scalar', Types\Scalar::class],
             ['object', Object_::class],
             ['mixed', Types\Mixed_::class],
@@ -721,6 +725,7 @@ public function provideKeywords() : array
             ['self', Types\Self_::class],
             ['parent', Types\Parent_::class],
             ['iterable', Iterable_::class],
+            ['numeric-string', NumericString::class],
         ];
     }
 

tests/unit/Types/ArrayKeyTest.php

@@ -0,0 +1,45 @@
+<?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\Types;
+
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @coversDefaultClass \phpDocumentor\Reflection\Types\ArrayKey
+ */
+final class ArrayKeyTest extends TestCase
+{
+    /**
+     * @covers ::__construct
+     * @covers ::__toString
+     */
+    public function testArrayKeyCanBeConstructedAndStringifiedCorrectly() : void
+    {
+        $this->assertSame('array-key', (string) (new ArrayKey()));
+    }
+
+    /**
+     * @uses ::__construct
+     *
+     * @covers ::getIterator
+     */
+    public function testArrayKeyCanBeIterated() : void
+    {
+        $types = [String_::class, Integer::class];
+
+        foreach (new ArrayKey() as $index => $type) {
+            $this->assertInstanceOf($types[$index], $type);
+        }
+    }
+}