phpactor · bart-jaskulski · Oct 11, 2024 · Oct 14, 2024 · Nov 1, 2024 · Nov 1, 2024
diff --git a/composer.json b/composer.json
@@ -27,7 +27,8 @@
         "jetbrains/phpstorm-stubs": "dev-master",
         "phpactor/tolerant-php-parser": "dev-main",
         "phpactor/map-resolver": "^1.5.0",
-        "webmozart/assert": "^1.11"
+        "webmozart/assert": "^1.11",
+        "phpstan/phpdoc-parser": "^2"
     },
     "require-dev": {
         "dantleech/what-changed": "~0.4",

diff --git a/composer.lock b/composer.lock
diff --git a/lib/CodeTransform/Tests/Adapter/WorseReflection/Refactor/WorseGenerateAccessorTest.php b/lib/CodeTransform/Tests/Adapter/WorseReflection/Refactor/WorseGenerateAccessorTest.php
@@ -79,6 +79,12 @@ public function provideExtractAccessor(): Generator
             'get',
             false,
         ];
+        yield 'synthetic types in phpdoc' => [
+            'generateAccessor9.test',
+            $propertyName,
+            'get',
+            false,
+        ];
     }
 
     public function testNonProperty(): void

diff --git a/lib/CodeTransform/Tests/Adapter/WorseReflection/Refactor/WorseGenerateMutatorTest.php b/lib/CodeTransform/Tests/Adapter/WorseReflection/Refactor/WorseGenerateMutatorTest.php
@@ -91,6 +91,10 @@ public function provideExtractMutator(): Generator
             false,
             true,
         ];
+        yield 'synthetic types' => [
+            'generateMutator10.test',
+            $propertyName,
+        ];
     }
 
     public function testNonProperty(): void

diff --git a/lib/CodeTransform/Tests/Adapter/WorseReflection/Refactor/fixtures/generateAccessor9.test b/lib/CodeTransform/Tests/Adapter/WorseReflection/Refactor/fixtures/generateAccessor9.test
@@ -0,0 +1,21 @@
+// File: source
+<?php
+
+class generateMethod
+{
+    /** @var non-empty-string */
+    pr<>ivate $method;
+}
+// File: expected
+<?php
+
+class generateMethod
+{
+    /** @var non-empty-string */
+    private $method;
+
+    public function getmethod(): string
+    {
+        return $this->method;
+    }
+}
diff --git a/lib/CodeTransform/Tests/Adapter/WorseReflection/Refactor/fixtures/generateMutator10.test b/lib/CodeTransform/Tests/Adapter/WorseReflection/Refactor/fixtures/generateMutator10.test
@@ -0,0 +1,22 @@
+// File: source
+
+<?php
+
+class generateMethod
+{
+    /** @var non-empty-string */
+    pr<>ivate $method;
+}
+// File: expected
+<?php
+
+class generateMethod
+{
+    /** @var non-empty-string */
+    private $method;
+
+    public function method(string $method): void
+    {
+        $this->method = $method;
+    }
+}
diff --git a/...ension/LanguageServerCompletion/Tests/Integration/expected/member_docblock10.md b/...ension/LanguageServerCompletion/Tests/Integration/expected/member_docblock10.md
@@ -1,9 +1,9 @@
 Computes the intersection of arrays using a callback function on the keys for comparison
 
-- **$array**: *array* <p>       Initial array for comparison of the arrays.       </p>
-- **$array2**: *array* <p>       First array to compare keys against.       </p>
-- **$key_compare_func**: *callable* <p>       User supplied callback function to do the comparison.       </p>
--  ...$rest [optional]
+- **$array**: *array* <p> Initial array for comparison of the arrays. </p>
+- **$array2**: *array* <p> First array to compare keys against. </p>
+- **$key_compare_func**: *callable* <p> User supplied callback function to do the comparison. </p>
+- ...$rest [optional]
 
-**Return** *array*: the values of array1 whose keys exist       in all the arguments.
+**Return** *array*: the values of array1 whose keys exist in all the arguments.
 
diff --git a/lib/Extension/WorseReflection/WorseReflectionExtension.php b/lib/Extension/WorseReflection/WorseReflectionExtension.php
@@ -45,6 +45,7 @@ class WorseReflectionExtension implements Extension
     const TAG_FRAME_WALKER = 'worse_reflection.frame_walker';
     const TAG_MEMBER_PROVIDER = 'worse_reflection.member_provider';
     const PARAM_ENABLE_CACHE = 'worse_reflection.enable_cache';
+    const PARAM_PHPDOC_PARSER = 'worse_reflection.phpdoc_parser';
     const PARAM_STUB_DIR = 'worse_reflection.stub_dir';
     const PARAM_STUB_CACHE_DIR = 'worse_reflection.cache_dir';
     const PARAM_CACHE_LIFETIME = 'worse_reflection.cache_lifetime';
@@ -60,6 +61,7 @@ public function configure(Resolver $schema): void
         $schema->setDefaults([
             self::PARAM_IMPORT_GLOBALS => false,
             self::PARAM_ENABLE_CACHE => true,
+            self::PARAM_PHPDOC_PARSER => 'native',
             self::PARAM_CACHE_LIFETIME => 1.0,
             self::PARAM_ENABLE_CONTEXT_LOCATION => true,
             self::PARAM_STUB_CACHE_DIR => '%cache%/worse-reflection',
@@ -68,6 +70,7 @@ public function configure(Resolver $schema): void
         ]);
         $schema->setDescriptions([
             self::PARAM_ENABLE_CACHE => 'If reflection caching should be enabled',
+            self::PARAM_PHPDOC_PARSER => 'Which PHPDoc parser to use: "native" or "phpstan"',
             self::PARAM_CACHE_LIFETIME => 'If caching is enabled, limit the amount of time a cache entry can stay alive',
             self::PARAM_UNDEFINED_VAR_LEVENSHTEIN => 'Levenshtein distance to use when suggesting corrections for variable names',
             self::PARAM_ENABLE_CONTEXT_LOCATION => <<<'EOT'
@@ -111,6 +114,10 @@ private function registerReflection(ContainerBuilder $container): void
                 $builder->withCacheForDocument($container->get(CacheForDocument::class));
             }
 
+            if ($container->parameter(self::PARAM_PHPDOC_PARSER)->string() === 'phpstan') {
+                $builder->enablePHPStanDocblockParser();
+            }
+
             foreach ($container->getServiceIdsForTag(self::TAG_SOURCE_LOCATOR) as $serviceId => $attrs) {
                 $builder->addLocator($container->get($serviceId), $attrs['priority'] ?? 0);
             }

diff --git a/lib/WorseReflection/Bridge/PHPStan/DocblockParser/PHPStanDocblockParserFactory.php b/lib/WorseReflection/Bridge/PHPStan/DocblockParser/PHPStanDocblockParserFactory.php
@@ -0,0 +1,73 @@
+<?php
+
+namespace Phpactor\WorseReflection\Bridge\PHPStan\DocblockParser;
+
+use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode;
+use PHPStan\PhpDocParser\Lexer\Lexer;
+use PHPStan\PhpDocParser\ParserConfig;
+use PHPStan\PhpDocParser\Parser\ConstExprParser;
+use PHPStan\PhpDocParser\Parser\ParserException;
+use PHPStan\PhpDocParser\Parser\PhpDocParser;
+use PHPStan\PhpDocParser\Parser\TokenIterator;
+use PHPStan\PhpDocParser\Parser\TypeParser;
+use Phpactor\WorseReflection\Core\DocBlock\DocBlock;
+use Phpactor\WorseReflection\Core\DocBlock\DocBlockFactory;
+use Phpactor\WorseReflection\Core\DocBlock\PlainDocblock;
+use Phpactor\WorseReflection\Core\Reflection\ReflectionScope;
+use Phpactor\WorseReflection\Reflector;
+
+class PHPStanDocblockParserFactory implements DocBlockFactory
+{
+    private PhpDocParser $parser;
+
+    private Lexer $lexer;
+
+    public function __construct(
+        private Reflector $reflector,
+        ?Lexer $lexer = null,
+        ?PhpDocParser $parser = null,
+    ) {
+        $config = new ParserConfig(usedAttributes: ['lines' => true, 'indexes' => true]);
+        $this->lexer = $lexer ?? new Lexer($config);
+        $constExprParser = new ConstExprParser($config);
+        $typeParser = new TypeParser($config, $constExprParser);
+        $this->parser = $parser ?? new PhpDocParser($config, $typeParser, $constExprParser);
+    }
+
+    public function create(string $docblock, ReflectionScope $scope): DocBlock
+    {
+        $docblock = $this->sanitizeDocblock($docblock);
+        $node = new PhpDocNode([]);
+        try {
+            $tokens = $this->lexer->tokenize($docblock);
+            $docblockBeginnings = array_filter(
+                $tokens,
+                /** @param array{string, int, int} $token */
+                static fn (array $token) => $token[1] === Lexer::TOKEN_OPEN_PHPDOC
+            );
+            // _force_ phpstan to iterate all docblocks found in current fragment
+            foreach ($docblockBeginnings as $i => $docblockBeginning) {
+                $iterator = new TokenIterator($tokens, $i);
+                array_push($node->children, ...$this->parser->parse($iterator)->children);
+            }
+        } catch (ParserException) {
+            return new PlainDocblock($docblock);
+        }
+
+        return new PHPStanParsedDocblock(
+            $node,
+            new PHPStanTypeConverter($this->reflector, $scope),
+            $docblock
+        );
+    }
+
+    /**
+     * phpstan/docblock-parser is pretty strict about the doc it parses -- any short comments or
+     * excessive new lines lead to parser exception, so try to get rid of them before parsing.
+     */
+    private function sanitizeDocblock(string $docblock): string
+    {
+        $docblock = preg_replace('~\h*\/\/.*~', '', $docblock) ?? $docblock;
+        return trim($docblock);
+    }
+}