Merge pull request #113 from phpDocumentor/add-pseudo-type-support-and-use-true-and-false

Add true and false as PseudoTypes

Author: jaapio

Makefile

@@ -19,14 +19,14 @@ phpcs:
 phpcbf:
 	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phpcs-ga:latest phpcbf
 
-
 .PHONY: phpstan
 phpstan:
 	docker run -it --rm -v${PWD}:/opt/project -w /opt/project phpdoc/phpstan-ga:latest analyse src --no-progress --configuration phpstan.neon
 
-.PHONY: psaml
+.PHONY: psalm
 psalm:
 	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.2 tools/psalm
+
 .PHONY: test
 test:
 	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.2 tools/phpunit

phpcs.xml.dist

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <ruleset name="phpDocumentor">
- <description>The coding standard for phpDocumentor.</description>
+    <description>The coding standard for phpDocumentor.</description>
 
     <file>src</file>
     <file>tests/unit</file>
@@ -13,4 +13,9 @@
     <rule ref="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming.SuperfluousPrefix">
         <exclude-pattern>*/src/*/Abstract*.php</exclude-pattern>
     </rule>
+
+    <rule ref="PSR1.Files.SideEffects.FoundWithSymbols">
+        <exclude-pattern>*/src/PseudoTypes/False_.php</exclude-pattern>
+        <exclude-pattern>*/src/PseudoTypes/True_.php</exclude-pattern>
+    </rule>
 </ruleset>

src/PseudoType.php

@@ -0,0 +1,19 @@
+<?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;
+
+interface PseudoType extends Type
+{
+    public function underlyingType() : Type;
+}

src/PseudoTypes/False_.php

@@ -0,0 +1,39 @@
+<?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 https://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\PseudoTypes;
+
+use phpDocumentor\Reflection\PseudoType;
+use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\Boolean;
+use function class_alias;
+
+/**
+ * Value Object representing the PseudoType 'False', which is a Boolean type.
+ *
+ * @psalm-immutable
+ */
+final class False_ extends Boolean implements PseudoType
+{
+    public function underlyingType() : Type
+    {
+        return new Boolean();
+    }
+
+    public function __toString() : string
+    {
+        return 'false';
+    }
+}
+
+class_alias('\phpDocumentor\Reflection\PseudoTypes\False_', 'phpDocumentor\Reflection\Types\False_', false);

src/PseudoTypes/True_.php

@@ -0,0 +1,39 @@
+<?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 https://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection\PseudoTypes;
+
+use phpDocumentor\Reflection\PseudoType;
+use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\Types\Boolean;
+use function class_alias;
+
+/**
+ * Value Object representing the PseudoType 'False', which is a Boolean type.
+ *
+ * @psalm-immutable
+ */
+final class True_ extends Boolean implements PseudoType
+{
+    public function underlyingType() : Type
+    {
+        return new Boolean();
+    }
+
+    public function __toString() : string
+    {
+        return 'true';
+    }
+}
+
+class_alias('\phpDocumentor\Reflection\PseudoTypes\True_', 'phpDocumentor\Reflection\Types\True_', false);

src/TypeResolver.php

@@ -87,8 +87,8 @@ final class TypeResolver
         'scalar' => Types\Scalar::class,
         'callback' => Types\Callable_::class,
         'callable' => Types\Callable_::class,
-        'false' => Types\False_::class,
-        'true' => Types\True_::class,
+        'false' => PseudoTypes\False_::class,
+        'true' => PseudoTypes\True_::class,
         'self' => Types\Self_::class,
         '$this' => Types\This::class,
         'static' => Types\Static_::class,

src/Types/False_.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\Boolean;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @coversDefaultClass \phpDocumentor\Reflection\PseudoTypes\False_
+ */
+final class FalseTest extends TestCase
+{
+    /**
+     * @covers ::underlyingType
+     */
+    public function testExposesUnderlyingType() : void
+    {
+        $false = new False_();
+
+        $this->assertInstanceOf(Boolean::class, $false->underlyingType());
+    }
+
+    /**
+     * @covers ::__toString
+     */
+    public function testFalseStringifyCorrectly() : void
+    {
+        $false = new False_();
+
+        $this->assertSame('false', (string) $false);
+    }
+
+    /**
+     * @covers \phpDocumentor\Reflection\PseudoTypes\False_
+     */
+    public function testCanBeInstantiatedUsingDeprecatedFqsen() : void
+    {
+        $false = new \phpDocumentor\Reflection\Types\False_();
+
+        $this->assertSame('false', (string) $false);
+        $this->assertInstanceOf(False_::class, $false);
+        $this->assertInstanceOf(\phpDocumentor\Reflection\Types\False_::class, $false);
+    }
+}

src/Types/True_.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\Boolean;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @coversDefaultClass \phpDocumentor\Reflection\PseudoTypes\True_
+ */
+class TrueTest extends TestCase
+{
+    /**
+     * @covers ::underlyingType
+     */
+    public function testExposesUnderlyingType() : void
+    {
+        $true = new True_();
+
+        $this->assertInstanceOf(Boolean::class, $true->underlyingType());
+    }
+
+    /**
+     * @covers ::__toString
+     */
+    public function testTrueStringifyCorrectly() : void
+    {
+        $true = new True_();
+
+        $this->assertSame('true', (string) $true);
+    }
+
+    /**
+     * @covers \phpDocumentor\Reflection\PseudoTypes\True_
+     */
+    public function testCanBeInstantiatedUsingDeprecatedFqsen() : void
+    {
+        $true = new \phpDocumentor\Reflection\Types\True_();
+
+        $this->assertSame('true', (string) $true);
+        $this->assertInstanceOf(True_::class, $true);
+        $this->assertInstanceOf(\phpDocumentor\Reflection\Types\True_::class, $true);
+    }
+}

tests/unit/PseudoTypes/FalseTest.php

@@ -705,9 +705,9 @@ public function provideKeywords() : array
             ['bool', Types\Boolean::class],
             ['boolean', Types\Boolean::class],
             ['true', Types\Boolean::class],
-            ['true', Types\True_::class],
+            ['true', PseudoTypes\True_::class],
             ['false', Types\Boolean::class],
-            ['false', Types\False_::class],
+            ['false', PseudoTypes\False_::class],
             ['resource', Types\Resource_::class],
             ['null', Types\Null_::class],
             ['callable', Types\Callable_::class],

tests/unit/PseudoTypes/TrueTest.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 PHPUnit\Framework\TestCase;
+
+/**
+ * @coversDefaultClass \phpDocumentor\Reflection\Types\Boolean
+ */
+final class BooleanTest extends TestCase
+{
+    /**
+     * @covers ::__toString
+     */
+    public function testBooleanStringifyCorrectly() : void
+    {
+        $type = new Boolean();
+
+        $this->assertSame('bool', (string) $type);
+    }
+}