Merge pull request #48 from smeghead/bug-doc-comment-parse

fix Type Description like `array<int, string>` don't berecoganized.

Author: smeghead

CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+### Features
+
+ * introduced PHPStan in Develop environment.
+
+### Bug fix
+
+ * fix Type Description like `array<int, string>` don't berecoganized.
+
 ## v1.1.0 (2023-04-24)
 
 

composer.json

@@ -9,7 +9,8 @@
     "require": {
         "php" : ">=8.0",
         "symfony/finder": "^5.3",
-        "nikic/php-parser": "^4.13"
+        "nikic/php-parser": "^4.13",
+        "phpstan/phpdoc-parser": "^1.23"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",

dogfood-package.png

@@ -2,4 +2,3 @@ parameters:
 	level: 6
 	paths:
 		- src
-		- tests

dogfood.png

@@ -9,12 +9,12 @@
 
 class PackageRelations
 {
-    /** @var array<string, \Smeghead\PhpClassDiagram\Php\PhpType[]> */
+    /** @var array<string, array<int, PhpType>> */
     private array $uses;
     private Package $rootPackage;
 
     /**
-     * @param array<string, \Smeghead\PhpClassDiagram\Php\PhpType[]> $uses
+     * @param array<string, array<int, PhpType>> $uses
      * @param Package $rootPackage
      */
     public function __construct(array $uses, Package $rootPackage)

phpstan.neon

@@ -5,6 +5,13 @@
 namespace Smeghead\PhpClassDiagram\Php\Doc;
 
 use PhpParser\Node\Stmt;
+use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode;
+use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode;
+use PHPStan\PhpDocParser\Lexer\Lexer;
+use PHPStan\PhpDocParser\Parser\ConstExprParser;
+use PHPStan\PhpDocParser\Parser\PhpDocParser;
+use PHPStan\PhpDocParser\Parser\TokenIterator;
+use PHPStan\PhpDocParser\Parser\TypeParser;
 
 class PhpDocComment
 {
@@ -36,23 +43,56 @@ public function getDescription(): string
     }
 
     public function getVarTypeName(): string {
-        if (preg_match('/\@var\s+(\S+)\s.*/', $this->text . ' ', $matches)) {
-            return $matches[1];
+        $phpDocNode = $this->getParseResult();
+        $vars = $phpDocNode->getVarTagValues();
+        if (count($vars) > 0) {
+            if ( ! empty($vars[0]->type)) {
+                return $this->convertUnionExpression($vars[0]->type->__toString());
+            }
         }
         return '';
     }
 
     public function getParamTypeName(string $paramName): string {
-        if (preg_match(sprintf('/\@param\s+(\S+)\s+\$%s.*/', $paramName), $this->text . ' ', $matches)) {
-            return $matches[1];
+        $phpDocNode = $this->getParseResult();
+        $paramTags = array_filter($phpDocNode->getParamTagValues(), function(ParamTagValueNode $node) use ($paramName) {
+            return $node->parameterName === sprintf('$%s', $paramName);
+        }); // ParamTagValueNode[]
+        if (count($paramTags) > 0) {
+            if ( ! empty($paramTags[0]->type)) {
+                return $this->convertUnionExpression($paramTags[0]->type->__toString());
+            }
         }
         return '';
     }
 
     public function getReturnTypeName(): string {
-        if (preg_match('/\@return\s+(\S+)\s+/', $this->text . ' ', $matches)) {
-            return $matches[1];
+        $phpDocNode = $this->getParseResult();
+        $returns = $phpDocNode->getReturnTagValues();
+        if (count($returns) > 0) {
+            if ( ! empty($returns[0]->type)) {
+                return $this->convertUnionExpression($returns[0]->type->__toString());
+            }
         }
         return '';
     }
+
+    private function getParseResult(): PhpDocNode
+    {
+        $lexer = new Lexer();
+        $constExprParser = new ConstExprParser();
+        $typeParser = new TypeParser($constExprParser);
+        $phpDocParser = new PhpDocParser($typeParser, $constExprParser);
+        $tokens = new TokenIterator($lexer->tokenize('/** ' . $this->text . ' */'));
+        return $phpDocParser->parse($tokens); // PhpDocNode
+    }
+
+    private function convertUnionExpression(string $difinition): string
+    {
+        $difinition = preg_replace('/^\((.*)\)$/', '$1', $difinition);
+        $typeStrings = array_map(function(string $x){
+            return trim($x);
+        }, explode('|', $difinition));
+        return implode('|', $typeStrings);
+    }
 }

src/DiagramElement/PackageRelations.php

@@ -46,7 +46,11 @@ private function __construct(NodeAbstract $stmt, string $targetType, array $curr
 
         $type = $stmt->{$targetType === self::RETURN_TYPE ? 'returnType' : 'type'};
         if (!empty($docString)) {
-            foreach (explode('|', $docString) as $typeString) {
+            $docString = preg_replace('/^\((.*)\)$/', '$1', $docString);
+            $typeStrings = array_map(function(string $x){
+                return trim($x);
+            }, explode('|', $docString));
+            foreach ($typeStrings as $typeString) {
                 $this->types[] = $this->parseType($type, $currentNamespace, $typeString);
             }
         } else if ($type instanceof UnionType) {

src/Php/Doc/PhpDocComment.php

@@ -456,4 +456,84 @@ public function testMethodReturnObjectArray(): void
         $this->assertSame('Tag[]', $types[0]->getName(), 'name');
         $this->assertSame(false, $types[0]->getNullable(), 'nullable');
     }
+    public function testVarArrayAlternative(): void
+    {
+        // /** @var array<int, Tag> 付与されたタグ一覧 */
+        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+        $filename = sprintf('%s/phpdoc/product/Product.php', $this->fixtureDir);
+        try {
+            $ast = $parser->parse(file_get_contents($filename));
+        } catch (Error $error) {
+            throw new \Exception("Parse error: {$error->getMessage()} file: {$filename}\n");
+        }
+        $finder = new NodeFinder();
+        $target = $finder->findFirst($ast, function(Node $node){
+            return $node instanceof Property && $node->props[0]->name->toString() === 'alternativeTags';
+        });
+        $expression = PhpTypeExpression::buildByVar($target, ['hoge', 'fuga', 'product'], []);
+        $types = $expression->getTypes();
+
+        $this->assertSame(['hoge', 'fuga', 'product'], $types[0]->getNamespace(), 'namespace');
+        $this->assertSame('array<int, Tag>', $types[0]->getName(), 'name');
+        $this->assertSame(false, $types[0]->getNullable(), 'nullable');
+
+    }
+    public function testMethodParameterAltaernativeTag(): void
+    {
+        // /**
+        //  * @param array<int, Tag> $tags tags
+        //  * @return array<int, Tag> tags
+        //  */
+        // public function arrayTags(array $tags): array
+        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+        $filename = sprintf('%s/phpdoc/product/Product.php', $this->fixtureDir);
+        try {
+            $ast = $parser->parse(file_get_contents($filename));
+        } catch (Error $error) {
+            throw new \Exception("Parse error: {$error->getMessage()} file: {$filename}\n");
+        }
+        $finder = new NodeFinder();
+        $method = $finder->findFirst($ast, function(Node $node){
+            return $node instanceof ClassMethod && $node->name->toString() === 'arrayTags';
+        });
+        $param = $finder->findFirst($method, function (Node $node) {
+            return $node instanceof Param && $node->var->name === 'tags';
+        });
+        $uses = [new PhpType(['hoge', 'fuga', 'product'], '', 'Tag')];
+        $expression = PhpTypeExpression::buildByMethodParam($param, ['hoge', 'fuga', 'product'], $method, 'tags', $uses);
+        $types = $expression->getTypes();
+
+        $this->assertSame(['hoge', 'fuga', 'product'], $types[0]->getNamespace(), 'namespace');
+        $this->assertSame('array<int, Tag>', $types[0]->getName(), 'name');
+        $this->assertSame(false, $types[0]->getNullable(), 'nullable');
+    }
+    public function testMethodReturnAltaernativeTag(): void
+    {
+        // /**
+        //  * @param array<int, Tag> $tags tags
+        //  * @return array<int, Tag> tags
+        //  */
+        // public function arrayTags(array $tags): array
+        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+        $filename = sprintf('%s/phpdoc/product/Product.php', $this->fixtureDir);
+        try {
+            $ast = $parser->parse(file_get_contents($filename));
+        } catch (Error $error) {
+            throw new \Exception("Parse error: {$error->getMessage()} file: {$filename}\n");
+        }
+        $finder = new NodeFinder();
+        $method = $finder->findFirst($ast, function(Node $node){
+            return $node instanceof ClassMethod && $node->name->toString() === 'arrayTags';
+        });
+        $param = $finder->findFirst($method, function (Node $node) {
+            return $node instanceof Param && $node->var->name === 'tags';
+        });
+        $uses = [new PhpType(['hoge', 'fuga', 'product'], '', 'Tag')];
+        $expression = PhpTypeExpression::buildByMethodReturn($method, ['hoge', 'fuga', 'product'], $uses);
+        $types = $expression->getTypes();
+
+        $this->assertSame(['hoge', 'fuga', 'product'], $types[0]->getNamespace(), 'namespace');
+        $this->assertSame('array<int, Tag>', $types[0]->getName(), 'name');
+        $this->assertSame(false, $types[0]->getNullable(), 'nullable');
+    }
 }

src/Php/PhpTypeExpression.php

@@ -22,4 +22,13 @@ class Product {
 
     /** @var array<int, Tag> 付与されたタグ一覧 */
     private array $alternativeTags;
+
+    /**
+     * @param array<int, Tag> $tags tags
+     * @return array<int, Tag> tags
+     */
+    public function arrayTags(array $tags): array
+    {
+        return $tags;
+    }
 }