describe text from DocComment in division-diagram options.

Author: smeghead

src/DiagramElement/Entry.php

@@ -8,6 +8,7 @@
 use Smeghead\PhpClassDiagram\Php\{
     PhpClass,
     PhpAccessModifier,
+    PhpEnumCase,
     PhpMethodParameter,
 };
 
@@ -73,12 +74,16 @@ public function dumpDivisions($level = 0): array
         $lines = [];
         $meta = $this->class->getClassType()->getMetaName();
         if ($meta === 'enum') {
-            $lines[] = sprintf('%scard %s [', $indent, $this->class->getClassType()->getName());
+            $lines[] = sprintf('%scard %s #ccffcc [', $indent, $this->class->getClassType()->getName());
             $lines[] = sprintf('%s  %s', $indent, $this->class->getClassType()->getName());
             $lines[] = sprintf('%s  ====', $indent);
             $cases = $this->class->getEnumCases();
-            $lines[] = implode(sprintf("\r\n%s  ----\r\n", $indent), array_map(function (string $x) use($indent) {
-                return sprintf('%s  %s', $indent, $x);
+            $lines[] = implode(sprintf("\r\n%s  ----\r\n", $indent), array_map(function (PhpEnumCase $x) use($indent) {
+                $doc = $x->getDocString();
+                if (empty($doc)) {
+                    return sprintf('%s  %s', $indent, $x->getName());
+                }
+                return sprintf("%s  %s\n%s  <b>%s</b>", $indent, $x->getName(), $indent, $doc);
             }, $cases));
             $lines[] = sprintf('%s]', $indent);
         }

src/Php/PhpClass.php

@@ -228,6 +228,9 @@ public function getExtends(): array
         return $extends;
     }
 
+    /**
+     * @return PhpEnumCase[] list of enum options.
+     */
     public function getEnumCases(): array
     {
         if ( ! $this->syntax instanceof Enum_) {
@@ -236,7 +239,7 @@ public function getEnumCases(): array
         $cases = [];
         foreach ($this->syntax->stmts as $stmt) {
             if ($stmt instanceof EnumCase) {
-                $cases[] = $stmt->name->name;
+                $cases[] = new PhpEnumCase($stmt);
             }
         }
         return $cases;

src/Php/PhpEnumCase.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Smeghead\PhpClassDiagram\Php;
+
+use PhpParser\Comment\Doc;
+use PhpParser\Node\Stmt\{
+    EnumCase,
+};
+
+class PhpEnumCase
+{
+    protected string $name;
+    protected ?Doc $doc;
+
+    public function __construct(EnumCase $e)
+    {
+        $this->name = $e->name->name;
+        $this->doc = $e->getDocComment();
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    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));
+    }
+
+}

test/PhpReflectionTest.php

@@ -2,6 +2,7 @@
 use PHPUnit\Framework\TestCase;
 
 use Smeghead\PhpClassDiagram\Config\Options;
+use Smeghead\PhpClassDiagram\Php\PhpEnumCase;
 use Smeghead\PhpClassDiagram\Php\PhpReader;
 
 final class PhpReflectionTest extends TestCase {
@@ -311,6 +312,8 @@ public function testEnum(): void {
         $data = $parsed[0]->getInfo();
         $this->assertSame('Suit', $data->getClassType()->getName(), '1st class type name.');
         $this->assertSame(['Hoge', 'TestEnum'], $data->getClassType()->getNamespace(), '1st namespace name.');
-        $this->assertSame(['Hearts', 'Diamonds', 'Clubs', 'Spades'], $data->getEnumCases(), 'enum cases.');
+        $enums = $data->getEnumCases();
+        $this->assertSame(['Hearts', 'Diamonds', 'Clubs', 'Spades'], array_map(function(PhpEnumCase $e){return $e->getName();}, $enums), 'enum cases.');
+        $this->assertSame(['ハート', 'ダイヤ', 'クローバー', 'スペード'], array_map(function(PhpEnumCase $e){return $e->getDocString();}, $enums), 'enum cases.');
     }
 }

test/fixtures/enum/TestEnum.php

@@ -1,11 +1,19 @@
 <?php
 namespace Hoge\TestEnum;
 
+/** スート */
 enum Suit
 {
+    /** ハート */
     case Hearts;
+    /** ダイヤ */
     case Diamonds;
+    /** クローバー */
     case Clubs;
+    /**
+     * スペード
+     * 説明コメント
+     */
     case Spades;
 }