Merge pull request #663 from phpDocumentor/feature/async-accessors

Add async visibility support

Author: jaapio

composer.json

@@ -5,21 +5,27 @@
     "homepage": "http://www.phpdoc.org",
     "license": "MIT",
     "autoload": {
+        "files": [
+            "src/php-parser/Modifiers.php"
+        ],
         "psr-4": {
             "phpDocumentor\\": "src/phpDocumentor"
         }
     },
     "autoload-dev": {
         "psr-4": {
             "phpDocumentor\\": [
-                "tests/integration/",
                 "tests/unit/phpDocumentor",
                 "tests/bench/"
+            ],
+            "phpDocumentor\\Reflection\\": [
+                "tests/integration"
             ]
         }
     },
     "require": {
         "php": "8.1.*|8.2.*|8.3.*|8.4.*",
+        "composer-runtime-api": "^2",
         "nikic/php-parser": "~4.18 || ^5.0",
         "phpdocumentor/reflection-common": "^2.1",
         "phpdocumentor/reflection-docblock": "^5",
@@ -30,6 +36,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

@@ -2,7 +2,6 @@ parameters:
     paths:
       - src
 
-    checkGenericClassInNonGenericObjectType: false
     level: max
     ignoreErrors:
 

phpstan.neon

@@ -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,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpParser;
+
+use Composer\InstalledVersions;
+
+use function strpos;
+
+if (strpos(InstalledVersions::getVersion('nikic/php-parser') ?? '', '4') === 0) {
+    /**
+     * Modifiers used (as a bit mask) by various flags subnodes, for example on classes, functions,
+     * properties and constants.
+     */
+    final class Modifiers
+    {
+        public const PUBLIC = 1;
+        public const PROTECTED = 2;
+        public const PRIVATE = 4;
+        public const STATIC = 8;
+        public const ABSTRACT = 16;
+        public const FINAL = 32;
+        public const READONLY = 64;
+        public const PUBLIC_SET = 128;
+        public const PROTECTED_SET = 256;
+        public const PRIVATE_SET = 512;
+
+        public const VISIBILITY_SET_MASK = self::PUBLIC_SET | self::PROTECTED_SET | self::PRIVATE_SET;
+    }
+}

src/php-parser/Modifiers.php

@@ -34,6 +34,7 @@
 
 final class ElementNameResolver extends NodeVisitorAbstract
 {
+    /** @var SplDoublyLinkedList<Node\Identifier|string|null> */
     private SplDoublyLinkedList $parts;
 
     public function __construct()

src/phpDocumentor/Reflection/NodeVisitor/ElementNameResolver.php

@@ -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

@@ -8,15 +8,16 @@
 use phpDocumentor\Reflection\DocBlockFactoryInterface;
 use phpDocumentor\Reflection\Fqsen;
 use phpDocumentor\Reflection\Location;
+use phpDocumentor\Reflection\Php\AsyncVisibility;
 use phpDocumentor\Reflection\Php\Class_ as ClassElement;
 use phpDocumentor\Reflection\Php\Factory\Reducer\Reducer;
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
 use phpDocumentor\Reflection\Php\Property;
 use phpDocumentor\Reflection\Php\StrategyContainer;
 use phpDocumentor\Reflection\Php\Visibility;
+use PhpParser\Modifiers;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Param;
-use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 use Webmozart\Assert\Assert;
@@ -91,11 +92,36 @@ private function promoteParameterToProperty(ContextStack $context, StrategyConta
 
     private function buildPropertyVisibilty(int $flags): Visibility
     {
-        if ((bool) ($flags & Class_::MODIFIER_PRIVATE) === true) {
+        if ((bool) ($flags & Modifiers::VISIBILITY_SET_MASK) !== false) {
+            return new AsyncVisibility(
+                $this->buildReadVisibility($flags),
+                $this->buildWriteVisibility($flags),
+            );
+        }
+
+        return $this->buildReadVisibility($flags);
+    }
+
+    private function buildReadVisibility(int $flags): Visibility
+    {
+        if ((bool) ($flags & Modifiers::PRIVATE) === true) {
+            return new Visibility(Visibility::PRIVATE_);
+        }
+
+        if ((bool) ($flags & Modifiers::PROTECTED) === true) {
+            return new Visibility(Visibility::PROTECTED_);
+        }
+
+        return new Visibility(Visibility::PUBLIC_);
+    }
+
+    private function buildWriteVisibility(int $flags): Visibility
+    {
+        if ((bool) ($flags & Modifiers::PRIVATE_SET) === true) {
             return new Visibility(Visibility::PRIVATE_);
         }
 
-        if ((bool) ($flags & Class_::MODIFIER_PROTECTED) === true) {
+        if ((bool) ($flags & Modifiers::PROTECTED_SET) === true) {
             return new Visibility(Visibility::PROTECTED_);
         }
 
@@ -104,6 +130,6 @@ private function buildPropertyVisibilty(int $flags): Visibility
 
     private function readOnly(int $flags): bool
     {
-        return (bool) ($flags & Class_::MODIFIER_READONLY) === true;
+        return (bool) ($flags & Modifiers::READONLY) === true;
     }
 }

src/phpDocumentor/Reflection/Php/Factory/ConstructorPromotion.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_);
+    }
 }