add description to division diagram.

smeghead · smeghead · commit 07046a425650 · 2023-03-12T23:02:47.000+09:00
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,7 @@
-FROM php:8.1-cli
+FROM plantuml/plantuml
 
-RUN apt-get update && apt-get install -y zip git plantuml fonts-noto-cjk && apt-get clean && rm -rf /var/lib/apt/lists/*
+RUN apt-get update && apt-get install -y php8.1-cli php-xml composer fonts-noto-cjk && apt-get clean && rm -rf /var/lib/apt/lists/*
+RUN echo '#!/bin/sh' > /usr/bin/plantuml && echo 'java -jar /opt/plantuml.jar "$@"' >> /usr/bin/plantuml && chmod +x /usr/bin/plantuml
 
 COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
+ENTRYPOINT []
diff --git a/dogfood-model.png b/dogfood-model.png
diff --git a/dogfood-package.png b/dogfood-package.png
diff --git a/dogfood.png b/dogfood.png
diff --git a/output-division.png b/output-division.png
diff --git a/src/DiagramElement/Entry.php b/src/DiagramElement/Entry.php
@@ -78,6 +78,10 @@ public function dumpDivisions($level = 0): array
         if ($meta === 'enum') {
             $lines[] = sprintf('%scard %s %s [', $indent, $this->class->getClassType()->getName(), DivisionColor::nextColor());
             $lines[] = sprintf('%s  %s', $indent, $this->class->getClassType()->getName());
+            $description = $this->class->getDescription();
+            if (!empty($description)) {
+                $lines[] = sprintf('%s  <b>%s</b>', $indent, $description);
+            }
             $lines[] = sprintf('%s  ====', $indent);
             $cases = $this->class->getEnumCases();
             $lines[] = implode(sprintf("\r\n%s  ----\r\n", $indent), array_map(function (PhpEnumCase $x) use($indent) {
diff --git a/src/Php/Doc/PhpDocComment.php b/src/Php/Doc/PhpDocComment.php
@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Smeghead\PhpClassDiagram\Php\Doc;
+
+use PhpParser\Node\Stmt;
+
+class PhpDocComment
+{
+    private string $text = '';
+    public function __construct(Stmt $stmt)
+    {
+        $doc = $stmt->getDocComment();
+        if (!empty($doc)) {
+            $str = $doc->getText();
+            $str = preg_replace('/\/\*\*?\s*(.*)\s*\*\//s', '$1', $str);
+            $str = preg_replace('/^\s*\**\s*/m', '', $str);
+            $this->text = trim($str);
+        }
+    }
+
+    public function getText(): string
+    {
+        return $this->text;
+    }
+
+    public function getDescription(): string
+    {
+        $str = $this->text;
+        $str = str_replace(["\r\n", "\r", "\n"], "\n", $str);
+        $lines = explode("\n", $str);
+        return array_shift($lines);
+    }
+
+    public function getVarTypeName(): string {
+        if (preg_match('/\@var\s+(\S+)\s.*/', $this->text . ' ', $matches)) {
+            return $matches[1];
+        }
+        return '';
+    }
+
+    public function getParamTypeName(string $paramName): string {
+        if (preg_match(sprintf('/\@param\s+(\S+)\s+\$%s.*/', $paramName), $this->text . ' ', $matches)) {
+            return $matches[1];
+        }
+        return '';
+    }
+
+    public function getReturnTypeName(): string {
+        if (preg_match('/\@return\s+(\S+)\s+/', $this->text . ' ', $matches)) {
+            return $matches[1];
+        }
+        return '';
+    }
+}
diff --git a/src/Php/PhpClass.php b/src/Php/PhpClass.php
@@ -22,6 +22,7 @@
     GroupUse,
     Use_,
 };
+use Smeghead\PhpClassDiagram\Php\Doc\PhpDocComment;
 
 class PhpClass
 {
@@ -244,4 +245,9 @@ public function getEnumCases(): array
         }
         return $cases;
     }
+
+    public function getDescription(): string {
+        $doc = new PhpDocComment($this->syntax);
+        return $doc->getDescription();
+    }
 }
diff --git a/src/Php/PhpEnumCase.php b/src/Php/PhpEnumCase.php
@@ -8,16 +8,17 @@
 use PhpParser\Node\Stmt\{
     EnumCase,
 };
+use Smeghead\PhpClassDiagram\Php\Doc\PhpDocComment;
 
 class PhpEnumCase
 {
     protected string $name;
-    protected ?Doc $doc;
+    protected PhpDocComment $doc;
 
     public function __construct(EnumCase $e)
     {
         $this->name = $e->name->name;
-        $this->doc = $e->getDocComment();
+        $this->doc = new PhpDocComment($e);
     }
 
     public function getName(): string
@@ -27,15 +28,7 @@ public function getName(): string
 
     public function getDocString(): string
     {
-        if (empty($this->doc)) {
-            return '';
-        }
-        $str = $this->doc->getText();
-        $str = preg_replace('/\/\*\*?\s*(.*)\s*\*\//s', '$1', $str);
-        $str = preg_replace('/^\s*\**\s*/', '', $str);
-        $str = str_replace(["\r\n", "\r", "\n"], "\n", $str);
-        $lines = explode("\n", $str);
-        return trim(array_shift($lines));
+        return $this->doc->getDescription();
     }
 
 }
diff --git a/src/Php/PhpMethod.php b/src/Php/PhpMethod.php
@@ -23,13 +23,13 @@ class PhpMethod
 
     public function __construct(ClassMethod $method, PhpClass $class)
     {
-        $docString = '';
-        $doc = $method->getDocComment();
-        if (!empty($doc)) {
-            $docString = $doc->getText();
-        }
-        $params = array_map(function (Param $x) use ($class, $docString) {
-            $type = PhpTypeExpression::buildByMethodParam($x, $class->getNamespace(), $docString, $x->var->name, $class->getUses());
+        // $docString = '';
+        // $doc = $method->getDocComment();
+        // if (!empty($doc)) {
+        //     $docString = $doc->getText();
+        // }
+        $params = array_map(function (Param $x) use ($class, $method) {
+            $type = PhpTypeExpression::buildByMethodParam($x, $class->getNamespace(), $method, $x->var->name, $class->getUses());
             return new PhpMethodParameter($x->var->name, $type);
         }, $method->getParams());
         $this->name = $method->name->toString();
diff --git a/src/Php/PhpTypeExpression.php b/src/Php/PhpTypeExpression.php
@@ -9,9 +9,11 @@
 use PhpParser\Node\Name;
 use PhpParser\Node\Name\FullyQualified;
 use PhpParser\Node\NullableType;
+use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Property;
 use PhpParser\Node\UnionType;
 use PhpParser\NodeAbstract;
+use Smeghead\PhpClassDiagram\Php\Doc\PhpDocComment;
 
 class PhpTypeExpression
 {
@@ -69,37 +71,32 @@ public static function buildByVar(
         array $currentNamespace,
         array $uses
     ): self {
-        $doc = $stmt->getDocComment();
-        $typeString = '';
-        if ($doc instanceof Doc) {
-            $docString = $doc->getText();
-            if (preg_match(sprintf('/@%s\s+(\S+)(\b|\s).*/', 'var'), $docString, $matches)) {
-                $typeString = $matches[1];
-            }
-        }
+        $doc = new PhpDocComment($stmt);
+        $typeString = $doc->getVarTypeName();
         return new self($stmt, self::VAR, $currentNamespace, $typeString, $uses);
     }
 
     /**
      * @param NodeAbstract $stmt
      * @param string[] $currentNamespace
-     * @param string $docString
+     * @param ClassMethod $method
      * @param PhpType[] $uses
      * @return self
      */
     public static function buildByMethodParam(
         NodeAbstract $stmt,
         array $currentNamespace,
-        string $docString,
+        ClassMethod $method,
         string $paramName,
         array $uses
     ): self {
-        $typeString = '';
-        if (!empty($docString)) {
-            if (preg_match(sprintf('/@%s\s+(\S+)(\b|\s)\s*\$%s.*/', 'param', $paramName), $docString, $matches)) {
-                $typeString = $matches[1];
-            }
-        }
+        $doc = new PhpDocComment($method);
+        $typeString = $doc->getParamTypeName($paramName);
+        // if (!empty($docString)) {
+        //     if (preg_match(sprintf('/@%s\s+(\S+)(\b|\s)\s*\$%s.*/', 'param', $paramName), $docString, $matches)) {
+        //         $typeString = $matches[1];
+        //     }
+        // }
         return new self($stmt, self::PARAM, $currentNamespace, $typeString, $uses);
     }
 
diff --git a/test/PhpDocCommentTest.php b/test/PhpDocCommentTest.php
@@ -0,0 +1,123 @@
+<?php declare(strict_types=1);
+
+use PhpParser\ParserFactory;
+use PHPUnit\Framework\TestCase;
+use Smeghead\PhpClassDiagram\Php\Doc\PhpDocComment;
+use Smeghead\PhpClassDiagram\Php\PhpType;
+use Smeghead\PhpClassDiagram\Php\PhpTypeExpression;
+
+final class PhpDocCommentTest extends TestCase {
+    private $fixtureDir;
+    public function setUp(): void {
+        $this->fixtureDir = sprintf('%s/fixtures', __DIR__);
+    }
+
+    public function testDocString(): void {
+        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+        $filename = sprintf('%s/enum/TestEnum.php', $this->fixtureDir);
+        try {
+            $ast = $parser->parse(file_get_contents($filename));
+        } catch (Error $error) {
+            throw new \Exception("Parse error: {$error->getMessage()} file: {$filename}\n");
+        }
+
+        // var_dump($ast[0]->stmts[0]);
+        $enum = $ast[0]->stmts[0];
+        $doc = new PhpDocComment($enum);
+
+        $this->assertSame('スート', $doc->getText(), 'comment string');
+    }
+    public function test_enum_getDescription(): void {
+        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+        $filename = sprintf('%s/enum/TestEnum.php', $this->fixtureDir);
+        try {
+            $ast = $parser->parse(file_get_contents($filename));
+        } catch (Error $error) {
+            throw new \Exception("Parse error: {$error->getMessage()} file: {$filename}\n");
+        }
+
+        // var_dump($ast[0]->stmts[0]);
+        $enum = $ast[0]->stmts[0];
+        $doc = new PhpDocComment($enum);
+
+        $this->assertSame('スート', $doc->getDescription(), 'description');
+    }
+
+    public function testDocStringMultiLines(): void {
+        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+        $filename = sprintf('%s/enum/TestEnum.php', $this->fixtureDir);
+        try {
+            $ast = $parser->parse(file_get_contents($filename));
+        } catch (Error $error) {
+            throw new \Exception("Parse error: {$error->getMessage()} file: {$filename}\n");
+        }
+
+        // var_dump($ast[0]->stmts[0]);
+        $enumCase = $ast[0]->stmts[0]->stmts[3];
+        $doc = new PhpDocComment($enumCase);
+
+        $this->assertSame("スペード\n説明コメント", $doc->getText(), 'multiline comment string');
+    }
+
+    public function test_getDescription(): void {
+        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+        $filename = sprintf('%s/enum/TestEnum.php', $this->fixtureDir);
+        try {
+            $ast = $parser->parse(file_get_contents($filename));
+        } catch (Error $error) {
+            throw new \Exception("Parse error: {$error->getMessage()} file: {$filename}\n");
+        }
+
+        // var_dump($ast[0]->stmts[0]);
+        $enumCase = $ast[0]->stmts[0]->stmts[3];
+        $doc = new PhpDocComment($enumCase);
+
+        $this->assertSame("スペード", $doc->getDescription(), 'description string');
+    }
+
+    public function test_getVarType(): void {
+        $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");
+        }
+
+        // var_dump($ast[0]->stmts[1]->stmts[0]);
+        $var = $ast[0]->stmts[1]->stmts[0];
+        $doc = new PhpDocComment($var);
+
+        $this->assertSame("Name", $doc->getVarTypeName(), 'var type name.');
+    }
+    public function test_getParamType(): void {
+        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+        $filename = sprintf('%s/php8/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");
+        }
+
+        // var_dump($ast[0]->stmts[2]->stmts[10]);
+        $method = $ast[0]->stmts[2]->stmts[10];
+        $doc = new PhpDocComment($method);
+
+        $this->assertSame("string|int", $doc->getParamTypeName('param1'), 'param type name.');
+    }
+    public function test_getReturnType(): void {
+        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
+        $filename = sprintf('%s/php8/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");
+        }
+
+        // var_dump($ast[0]->stmts[2]->stmts[10]);
+        $method = $ast[0]->stmts[2]->stmts[10];
+        $doc = new PhpDocComment($method);
+
+        $this->assertSame("int|null", $doc->getReturnTypeName(), 'return type name.');
+    }
+}
diff --git a/test/PhpTypeExpressionTest.php b/test/PhpTypeExpressionTest.php
@@ -177,10 +177,9 @@ public function testMethodParameterInt(): void {
         } catch (Error $error) {
             throw new \Exception("Parse error: {$error->getMessage()} file: {$filename}\n");
         }
-        $doc = $ast[0]->stmts[2]->stmts[10]->getDocComment();
-        $docString = $doc->getText();
+        $method = $ast[0]->stmts[2]->stmts[10];
         $param = $ast[0]->stmts[2]->stmts[10]->getParams()[0];
-        $expression = PhpTypeExpression::buildByMethodParam($param, ['hoge', 'fuga', 'product'], $docString, 'paramint', []);
+        $expression = PhpTypeExpression::buildByMethodParam($param, ['hoge', 'fuga', 'product'], $method, 'paramint', []);
         $types = $expression->getTypes();
 
         $this->assertSame([], $types[0]->getNamespace(), 'namespace');
@@ -197,10 +196,9 @@ public function testMethodParameterPrice(): void {
             throw new \Exception("Parse error: {$error->getMessage()} file: {$filename}\n");
         }
         // var_dump($ast[0]->stmts[1]->stmts[8]);die();
-        $doc = $ast[0]->stmts[2]->stmts[10]->getDocComment();
-        $docString = $doc->getText();
+        $method = $ast[0]->stmts[2]->stmts[10];
         $param = $ast[0]->stmts[2]->stmts[10]->getParams()[1];
-        $expression = PhpTypeExpression::buildByMethodParam($param, ['hoge', 'fuga', 'product'], $docString, 'paramint', []);
+        $expression = PhpTypeExpression::buildByMethodParam($param, ['hoge', 'fuga', 'product'], $method, 'paramint', []);
         $types = $expression->getTypes();
 
         $this->assertSame(['hoge', 'fuga', 'product'], $types[0]->getNamespace(), 'namespace');
@@ -217,10 +215,9 @@ public function testMethodParameterDocString(): void {
             throw new \Exception("Parse error: {$error->getMessage()} file: {$filename}\n");
         }
         // var_dump($ast[0]->stmts[1]->stmts[8]);die();
-        $doc = $ast[0]->stmts[2]->stmts[10]->getDocComment();
-        $docString = $doc->getText();
+        $method = $ast[0]->stmts[2]->stmts[10];
         $param = $ast[0]->stmts[2]->stmts[10]->getParams()[2];
-        $expression = PhpTypeExpression::buildByMethodParam($param, ['hoge', 'fuga', 'product'], $docString, 'param1', []);
+        $expression = PhpTypeExpression::buildByMethodParam($param, ['hoge', 'fuga', 'product'], $method, 'param1', []);
         $types = $expression->getTypes();
 
         $this->assertSame([], $types[0]->getNamespace(), 'namespace');
@@ -294,10 +291,11 @@ public function testMethodParameterTag(): void {
             throw new \Exception("Parse error: {$error->getMessage()} file: {$filename}\n");
         }
         // var_dump($ast[0]->stmts[1]->stmts[8]);die();
-        $docString = '';
+        $method = $ast[0]->stmts[2]->stmts[13];
+        // $docString = '';
         $param = $ast[0]->stmts[2]->stmts[13]->getParams()[0];
         $uses = [new PhpType(['hoge', 'fuga', 'product', 'tag'], '', 'Tag')];
-        $expression = PhpTypeExpression::buildByMethodParam($param, ['hoge', 'fuga', 'product'], $docString, 'paramint', $uses);
+        $expression = PhpTypeExpression::buildByMethodParam($param, ['hoge', 'fuga', 'product'], $method, 'paramint', $uses);
         $types = $expression->getTypes();
 
         $this->assertSame(['hoge', 'fuga', 'product', 'tag'], $types[0]->getNamespace(), 'namespace');
diff --git a/test/fixtures/enum/Sub/Status.php b/test/fixtures/enum/Sub/Status.php
@@ -1,6 +1,7 @@
 <?php
 namespace Hoge\TestEnum\Sub;
 
+/** ゲームのステータス */
 enum Status {
     /** プレイヤーのターン */
     case Player;
diff --git a/test/fixtures/php8/product/Product.php b/test/fixtures/php8/product/Product.php

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@`
`22`	`22`	`GroupUse,`
`23`	`23`	`Use_,`
`24`	`24`	`};`
	`25`	`+use Smeghead\PhpClassDiagram\Php\Doc\PhpDocComment;`
`25`	`26`
`26`	`27`	`class PhpClass`
`27`	`28`	`{`
`@@ -244,4 +245,9 @@ public function getEnumCases(): array`
`244`	`245`	`}`
`245`	`246`	`return $cases;`
`246`	`247`	`}`
	`248`	`+`
	`249`	`+ public function getDescription(): string {`
	`250`	`+ $doc = new PhpDocComment($this->syntax);`
	`251`	`+ return $doc->getDescription();`
	`252`	`+ }`
`247`	`253`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,16 +8,17 @@`
`8`	`8`	`use PhpParser\Node\Stmt\{`
`9`	`9`	`EnumCase,`
`10`	`10`	`};`
	`11`	`+use Smeghead\PhpClassDiagram\Php\Doc\PhpDocComment;`
`11`	`12`
`12`	`13`	`class PhpEnumCase`
`13`	`14`	`{`
`14`	`15`	`protected string $name;`
`15`		`- protected ?Doc $doc;`
	`16`	`+ protected PhpDocComment $doc;`
`16`	`17`
`17`	`18`	`public function __construct(EnumCase $e)`
`18`	`19`	`{`
`19`	`20`	`$this->name = $e->name->name;`
`20`		`- $this->doc = $e->getDocComment();`
	`21`	`+ $this->doc = new PhpDocComment($e);`
`21`	`22`	`}`
`22`	`23`
`23`	`24`	`public function getName(): string`
`@@ -27,15 +28,7 @@ public function getName(): string`
`27`	`28`
`28`	`29`	`public function getDocString(): string`
`29`	`30`	`{`
`30`		`- if (empty($this->doc)) {`
`31`		`- return '';`
`32`		`- }`
`33`		`- $str = $this->doc->getText();`
`34`		`- $str = preg_replace('/\/\\?\s(.)\s\\//s', '$1', $str);`
`35`		`- $str = preg_replace('/^\s\\s/', '', $str);`
`36`		`- $str = str_replace(["\r\n", "\r", "\n"], "\n", $str);`
`37`		`- $lines = explode("\n", $str);`
`38`		`- return trim(array_shift($lines));`
	`31`	`+ return $this->doc->getDescription();`
`39`	`32`	`}`
`40`	`33`
`41`	`34`	`}`