add interface-string

Author: smoench

src/TypeResolver.php

@@ -22,6 +22,7 @@
 use phpDocumentor\Reflection\Types\Context;
 use phpDocumentor\Reflection\Types\Expression;
 use phpDocumentor\Reflection\Types\Integer;
+use phpDocumentor\Reflection\Types\InterfaceString;
 use phpDocumentor\Reflection\Types\Intersection;
 use phpDocumentor\Reflection\Types\Iterable_;
 use phpDocumentor\Reflection\Types\Nullable;
@@ -71,6 +72,7 @@ final class TypeResolver
     private $keywords = [
         'string' => Types\String_::class,
         'class-string' => Types\ClassString::class,
+        'interface-string' => Types\InterfaceString::class,
         'html-escaped-string' => PseudoTypes\HtmlEscapedString::class,
         'lowercase-string' => PseudoTypes\LowercaseString::class,
         'non-empty-lowercase-string' => PseudoTypes\NonEmptyLowercaseString::class,
@@ -246,6 +248,8 @@ private function parseTypes(ArrayIterator $tokens, Context $context, int $parser
                 if ($classType !== null) {
                     if ((string) $classType === 'class-string') {
                         $types[] = $this->resolveClassString($tokens, $context);
+                    } elseif ((string) $classType === 'interface-string') {
+                        $types[] = $this->resolveInterfaceString($tokens, $context);
                     } else {
                         $types[] = $this->resolveCollection($tokens, $classType, $context);
                     }
@@ -455,6 +459,39 @@ private function resolveClassString(ArrayIterator $tokens, Context $context) : T
         return new ClassString($classType->getFqsen());
     }
 
+    /**
+     * Resolves class string
+     *
+     * @param ArrayIterator<int, (string|null)> $tokens
+     */
+    private function resolveInterfaceString(ArrayIterator $tokens, Context $context) : Type
+    {
+        $tokens->next();
+
+        $classType = $this->parseTypes($tokens, $context, self::PARSER_IN_COLLECTION_EXPRESSION);
+
+        if (!$classType instanceof Object_ || $classType->getFqsen() === null) {
+            throw new RuntimeException(
+                $classType . ' is not a interface string'
+            );
+        }
+
+        $token = $tokens->current();
+        if ($token !== '>') {
+            if (empty($token)) {
+                throw new RuntimeException(
+                    'interface-string: ">" is missing'
+                );
+            }
+
+            throw new RuntimeException(
+                'Unexpected character "' . $token . '", ">" is missing'
+            );
+        }
+
+        return new InterfaceString($classType->getFqsen());
+    }
+
     /**
      * Resolves the collection values and keys
      *

src/Types/InterfaceString.php

@@ -0,0 +1,56 @@
+<?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\Fqsen;
+use phpDocumentor\Reflection\Type;
+
+/**
+ * Value Object representing the type 'string'.
+ *
+ * @psalm-immutable
+ */
+final class InterfaceString implements Type
+{
+    /** @var Fqsen|null */
+    private $fqsen;
+
+    /**
+     * Initializes this representation of a class string with the given Fqsen.
+     */
+    public function __construct(?Fqsen $fqsen = null)
+    {
+        $this->fqsen = $fqsen;
+    }
+
+    /**
+     * Returns the FQSEN associated with this object.
+     */
+    public function getFqsen() : ?Fqsen
+    {
+        return $this->fqsen;
+    }
+
+    /**
+     * Returns a rendered output of the Type as it would be used in a DocBlock.
+     */
+    public function __toString() : string
+    {
+        if ($this->fqsen === null) {
+            return 'interface-string';
+        }
+
+        return 'interface-string<' . (string) $this->fqsen . '>';
+    }
+}

tests/unit/TypeResolverTest.php

@@ -20,6 +20,7 @@
 use phpDocumentor\Reflection\Types\Context;
 use phpDocumentor\Reflection\Types\Expression;
 use phpDocumentor\Reflection\Types\Integer;
+use phpDocumentor\Reflection\Types\InterfaceString;
 use phpDocumentor\Reflection\Types\Intersection;
 use phpDocumentor\Reflection\Types\Iterable_;
 use phpDocumentor\Reflection\Types\Null_;
@@ -79,6 +80,30 @@ public function testResolvingClassStrings(string $classString, bool $throwsExcep
         $this->assertInstanceOf(ClassString::class, $resolvedType);
     }
 
+    /**
+     * @uses         \phpDocumentor\Reflection\Types\Context
+     * @uses         \phpDocumentor\Reflection\Types\Object_
+     * @uses         \phpDocumentor\Reflection\Types\String_
+     *
+     * @covers ::__construct
+     * @covers ::resolve
+     * @covers ::<private>
+     *
+     * @dataProvider provideInterfaceStrings
+     */
+    public function testResolvingInterfaceStrings(string $interfaceString, bool $throwsException) : void
+    {
+        $fixture = new TypeResolver();
+
+        if ($throwsException) {
+            $this->expectException('RuntimeException');
+        }
+
+        $resolvedType = $fixture->resolve($interfaceString, new Context(''));
+
+        $this->assertInstanceOf(InterfaceString::class, $resolvedType);
+    }
+
     /**
      * @uses         \phpDocumentor\Reflection\Types\Context
      * @uses         \phpDocumentor\Reflection\Types\Object_
@@ -748,6 +773,20 @@ public function provideClassStrings() : array
         ];
     }
 
+    /**
+     * Returns a list of interface string types and whether they throw an exception.
+     *
+     * @return (string|bool)[][]
+     */
+    public function provideInterfaceStrings() : array
+    {
+        return [
+            ['interface-string<\phpDocumentor\Reflection>', false],
+            ['interface-string<\phpDocumentor\Reflection\DocBlock>', false],
+            ['interface-string<string>', true],
+        ];
+    }
+
     /**
      * Provides a list of FQSENs to test the resolution patterns with.
      *

tests/unit/Types/ClassStringTest.php

@@ -36,7 +36,7 @@ public function testClassStringStringifyCorrectly(ClassString $array, string $ex
     public function provideClassStrings() : array
     {
         return [
-            'generic clss string' => [new ClassString(), 'class-string'],
+            'generic class string' => [new ClassString(), 'class-string'],
             'typed class string' => [new ClassString(new Fqsen('\Foo\Bar')), 'class-string<\Foo\Bar>'],
         ];
     }

tests/unit/Types/InterfaceStringTest.php

@@ -0,0 +1,43 @@
+<?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\Fqsen;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @coversDefaultClass \phpDocumentor\Reflection\Types\InterfaceString
+ */
+class InterfaceStringTest extends TestCase
+{
+    /**
+     * @dataProvider provideInterfaceStrings
+     * @covers ::__toString
+     */
+    public function testInterfaceStringStringifyCorrectly(InterfaceString $array, string $expectedString) : void
+    {
+        $this->assertSame($expectedString, (string) $array);
+    }
+
+    /**
+     * @return mixed[]
+     */
+    public function provideInterfaceStrings() : array
+    {
+        return [
+            'generic interface string' => [new InterfaceString(), 'interface-string'],
+            'typed interface string' => [new InterfaceString(new Fqsen('\Foo\Bar')), 'interface-string<\Foo\Bar>'],
+        ];
+    }
+}