Add async visibility support

The async visibility class reflects the async accessors on properties.

Author: jaapio

composer.json

@@ -12,9 +12,11 @@
     "autoload-dev": {
         "psr-4": {
             "phpDocumentor\\": [
-                "tests/integration/",
                 "tests/unit/phpDocumentor",
                 "tests/bench/"
+            ],
+            "phpDocumentor\\Reflection\\": [
+                "tests/integration"
             ]
         }
     },
@@ -30,6 +32,7 @@
     "require-dev": {
         "dealerdirect/phpcodesniffer-composer-installer": "^1.0",
         "doctrine/coding-standard": "^13.0",
+        "eliashaeussler/phpunit-attributes": "^1.7",
         "mikey179/vfsstream": "~1.2",
         "mockery/mockery": "~1.6.0",
         "phpspec/prophecy-phpunit": "^2.0",

composer.lock

@@ -1,5 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" colors="true" bootstrap="vendor/autoload.php" beStrictAboutOutputDuringTests="true" beStrictAboutChangesToGlobalState="true" cacheDirectory=".phpunit.cache" requireCoverageMetadata="true" beStrictAboutCoverageMetadata="false">
+  <extensions>
+    <bootstrap class="EliasHaeussler\PHPUnitAttributes\PHPUnitAttributesExtension" />
+  </extensions>
   <coverage>
     <report>
       <clover outputFile="build/logs/clover.xml"/>

phpunit.xml.dist

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Reflection\Php;
+
+final class AsyncVisibility extends Visibility
+{
+    public function __construct(
+        private Visibility $readVisibility,
+        private Visibility $writeVisibility,
+    ) {
+        parent::__construct((string) $readVisibility);
+    }
+
+    public function getReadVisibility(): Visibility
+    {
+        return $this->readVisibility;
+    }
+
+    public function getWriteVisibility(): Visibility
+    {
+        return $this->writeVisibility;
+    }
+}

src/phpDocumentor/Reflection/Php/AsyncVisibility.php

@@ -15,6 +15,7 @@
 
 use phpDocumentor\Reflection\DocBlockFactoryInterface;
 use phpDocumentor\Reflection\Location;
+use phpDocumentor\Reflection\Php\AsyncVisibility;
 use phpDocumentor\Reflection\Php\Class_;
 use phpDocumentor\Reflection\Php\Factory\Reducer\Reducer;
 use phpDocumentor\Reflection\Php\Property as PropertyDescriptor;
@@ -107,6 +108,21 @@ protected function doCreate(
      * Converts the visibility of the property to a valid Visibility object.
      */
     private function buildVisibility(PropertyIterator $node): Visibility
+    {
+        if ($node->isAsync() === false) {
+            return $this->buildReadVisibility($node);
+        }
+
+        $readVisibility = $this->buildReadVisibility($node);
+        $writeVisibility = $this->buildWriteVisibility($node);
+
+        return new AsyncVisibility(
+            $readVisibility,
+            $writeVisibility,
+        );
+    }
+
+    private function buildReadVisibility(PropertyIterator $node): Visibility
     {
         if ($node->isPrivate()) {
             return new Visibility(Visibility::PRIVATE_);
@@ -118,4 +134,17 @@ private function buildVisibility(PropertyIterator $node): Visibility
 
         return new Visibility(Visibility::PUBLIC_);
     }
+
+    private function buildWriteVisibility(PropertyIterator $node): Visibility
+    {
+        if ($node->isPrivateSet()) {
+            return new Visibility(Visibility::PRIVATE_);
+        }
+
+        if ($node->isProtectedSet()) {
+            return new Visibility(Visibility::PROTECTED_);
+        }
+
+        return new Visibility(Visibility::PUBLIC_);
+    }
 }

src/phpDocumentor/Reflection/Php/Factory/Property.php

@@ -22,6 +22,8 @@
 use PhpParser\Node\Name;
 use PhpParser\Node\Stmt\Property as PropertyNode;
 
+use function method_exists;
+
 /**
  * This class acts like a combination of a PropertyNode and PropertyProperty to
  * be able to create property descriptors using a normal strategy.
@@ -48,6 +50,20 @@ public function isPublic(): bool
         return $this->property->isPublic();
     }
 
+    /**
+     * Returns async accessor value for current property.
+     *
+     * This method will return the same value as {@see self::isPublic()} when your phpparser version is < 5.2
+     */
+    public function isPublicSet(): bool
+    {
+        if ($this->isAsync() === false) {
+            return $this->isPublic();
+        }
+
+        return $this->property->isPublic();
+    }
+
     /**
      * returns true when the current property is protected.
      */
@@ -56,6 +72,20 @@ public function isProtected(): bool
         return $this->property->isProtected();
     }
 
+    /**
+     * Returns async accessor value for current property.
+     *
+     * This method will return the same value as {@see self::isProtected()} when your phpparser version is < 5.2
+     */
+    public function isProtectedSet(): bool
+    {
+        if ($this->isAsync() === false) {
+            return $this->isProtected();
+        }
+
+        return $this->property->isProtectedSet();
+    }
+
     /**
      * returns true when the current property is private.
      */
@@ -64,6 +94,34 @@ public function isPrivate(): bool
         return $this->property->isPrivate();
     }
 
+    /**
+     * Returns async accessor value for current property.
+     *
+     * This method will return the same value as {@see self::isPrivate()} when your phpparser version is < 5.2
+     */
+    public function isPrivateSet(): bool
+    {
+        if ($this->isAsync() === false) {
+            return $this->isPrivate();
+        }
+
+        return $this->property->isPrivateSet();
+    }
+
+    /**
+     * Returns true when current property has async accessors.
+     *
+     * This method will always return false when your phpparser version is < 5.2
+     */
+    public function isAsync(): bool
+    {
+        if (method_exists($this->property, 'isPrivateSet') === false) {
+            return false;
+        }
+
+        return $this->property->isPublicSet() || $this->property->isProtected() || $this->property->isPrivateSet();
+    }
+
     /**
      * returns true when the current property is static.
      */

src/phpDocumentor/Reflection/Php/Factory/PropertyIterator.php

@@ -22,7 +22,7 @@
 /**
  * Value object for visibility values of classes, properties, ect.
  */
-final class Visibility implements Stringable
+class Visibility implements Stringable
 {
     /**
      * constant for protected visibility

src/phpDocumentor/Reflection/Php/Visibility.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Reflection;
+
+use EliasHaeussler\PHPUnitAttributes\Attribute\RequiresPackage;
+use phpDocumentor\Reflection\File\LocalFile;
+use phpDocumentor\Reflection\Php\ProjectFactory;
+use PHPUnit\Framework\TestCase;
+
+/** @coversNothing */
+#[RequiresPackage('nikic/php-parser', '>= 5.2')]
+final class AsyncAccessorTest extends TestCase
+{
+    public function testAsyncAccessor(): void
+    {
+        $file = __DIR__ . '/data/PHP84/AsyncAccessor.php';
+        $projectFactory = ProjectFactory::createInstance();
+        $project = $projectFactory->create('My project', [new LocalFile($file)]);
+
+        $class = $project->getFiles()[$file]->getClasses()['\AsyncAccessor'];
+
+        self::assertEquals(
+            'public',
+            $class->getProperties()['\AsyncAccessor::$pizza']->getVisibility()->getReadVisibility(),
+        );
+        self::assertEquals(
+            'private',
+            $class->getProperties()['\AsyncAccessor::$pizza']->getVisibility()->getWriteVisibility(),
+        );
+    }
+
+    public function testAsyncPropertyPromotion(): void
+    {
+        $file = __DIR__ . '/data/PHP84/AsyncPropertyPromotion.php';
+        $projectFactory = ProjectFactory::createInstance();
+        $project = $projectFactory->create('My project', [new LocalFile($file)]);
+
+        $class = $project->getFiles()[$file]->getClasses()['\AsyncPropertyPromotion'];
+
+        self::assertEquals(
+            'public',
+            $class->getProperties()['\AsyncPropertyPromotion::$pizza']->getVisibility()->getReadVisibility(),
+        );
+        self::assertEquals(
+            'protected',
+            $class->getProperties()['\AsyncPropertyPromotion::$pizza']->getVisibility()->getWriteVisibility(),
+        );
+    }
+}

tests/integration/AsyncAccessorTest.php

@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+class AsyncAccessor
+{
+    private(set) \Pizza $pizza;
+}

tests/integration/data/PHP84/AsyncAccessor.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+class AsyncPropertyPromotion
+{
+    public function __construct(
+        protected(set) Pizza $pizza,
+    ) {}
+}