Merge pull request #42 from smeghead/division-diagram

smeghead · web-flow · commit b2efaf578955 · 2023-03-11T23:39:38.000+09:00
Division diagram
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG
 
+### Features
+
+ * add division diagram option.
+
 ### Bug fix
 
  * Fixed so that unnamed external packages are not displayed in the package association diagram.
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 FROM php:8.1-cli
 
-RUN apt-get update && apt-get install -y zip git plantuml && apt-get clean && rm -rf /var/lib/apt/lists/*
+RUN apt-get update && apt-get install -y zip git plantuml fonts-noto-cjk && apt-get clean && rm -rf /var/lib/apt/lists/*
 
 COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
diff --git a/README.md b/README.md
@@ -208,6 +208,13 @@ If it finds packages that depend on each other, it will warn you with a thick re
 ![PlantUML output image.](output-package.png)
 
 
+### Division Diagram
+
+If you are using the Enum added in PHP8.1, you can output the division chart.
+Visualizing the divisions used in the program can be useful for research and design.
+
+![PlantUML output image.](output-division.png)
+
 ## Development
 
 ### Open shell
diff --git a/bin/php-class-diagram b/bin/php-class-diagram
@@ -14,6 +14,7 @@ $options = getopt('hv',[
     'version',
     'class-diagram',
     'package-diagram',
+    'division-diagram',
     'jig-diagram',
     'enable-class-properties',
     'disable-class-properties',
@@ -37,6 +38,7 @@ OPTIONS
   -v, --version                  show version.
       --class-diagram            output class diagram script. (default)
       --package-diagram          output package diagram script.
+      --division-diagram         output division diagram script.
       --jig-diagram              output class diagram and package diagram script.
       --enable-class-properties  describe properties in class diagram. (default)
       --disable-class-properties not describe properties in class diagram.
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/Config/Options.php b/src/Config/Options.php
@@ -15,6 +15,7 @@ class Options
     const DIAGRAM_CLASS = 'class';
     const DIAGRAM_PACKAGE = 'package';
     const DIAGRAM_JIG = 'jig';
+    const DIAGRAM_DIVSION = 'division';
 
     public function __construct(array $opt)
     {
@@ -43,6 +44,9 @@ public function diagram(): string
         if (isset($this->opt['jig-diagram'])) {
             return self::DIAGRAM_JIG;
         }
+        if (isset($this->opt['division-diagram'])) {
+            return self::DIAGRAM_DIVSION;
+        }
         // default
         return self::DIAGRAM_CLASS;
     }
diff --git a/src/DiagramElement/Division/DivisionColor.php b/src/DiagramElement/Division/DivisionColor.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Smeghead\PhpClassDiagram\DiagramElement\Division;
+
+class DivisionColor {
+    private static $gen;
+    public static function nextColor(): string {
+        if (empty(self::$gen)) {
+            self::$gen = generateDivisionColorGenerator();
+        }
+        self::$gen->next();
+        return self::$gen->current();
+    }
+}
+
+function generateDivisionColorGenerator(): \Generator
+{
+    $COLORS = [
+        '#ffffcc',
+        '#ccffcc',
+        '#ffcccc',
+        '#ccccff',
+        '#ccffff',
+        '#ffccff',
+    ];
+    while (true) {
+        foreach ($COLORS as $c) {
+            yield $c;
+        }
+    }
+}
diff --git a/src/DiagramElement/Entry.php b/src/DiagramElement/Entry.php
@@ -4,10 +4,13 @@
 
 namespace Smeghead\PhpClassDiagram\DiagramElement;
 
+use Generator;
 use Smeghead\PhpClassDiagram\Config\Options;
+use Smeghead\PhpClassDiagram\DiagramElement\Division\DivisionColor;
 use Smeghead\PhpClassDiagram\Php\{
     PhpClass,
     PhpAccessModifier,
+    PhpEnumCase,
     PhpMethodParameter,
 };
 
@@ -67,6 +70,28 @@ public function dump($level = 0): array
         return $lines;
     }
 
+    public function dumpDivisions($level = 0): array
+    {
+        $indent = str_repeat('  ', $level);
+        $lines = [];
+        $meta = $this->class->getClassType()->getMetaName();
+        if ($meta === 'enum') {
+            $lines[] = sprintf('%scard %s %s [', $indent, $this->class->getClassType()->getName(), DivisionColor::nextColor());
+            $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 (PhpEnumCase $x) use($indent) {
+                $doc = $x->getDocString();
+                if (empty($doc)) {
+                    return sprintf('%s  %s', $indent, $x->getName());
+                }
+                return sprintf("%s  %s\r\n%s  <b>%s</b>", $indent, $x->getName(), $indent, $doc);
+            }, $cases));
+            $lines[] = sprintf('%s]', $indent);
+        }
+        return $lines;
+    }
+
     private function modifier(PhpAccessModifier $modifier): string
     {
         $expressions = [];
diff --git a/src/DiagramElement/Package.php b/src/DiagramElement/Package.php
@@ -204,4 +204,28 @@ private function recFindPackage(string $package): ?Package
         }
         return null;
     }
+
+    public function dumpDivisions($level = 0): array
+    {
+        $indent = str_repeat('  ', $level);
+        $lines = [];
+        if ($this->name !== 'ROOT') {
+            $lines[] = sprintf(
+                '%spackage %s as %s {',
+                $indent,
+                $this->name,
+                $this->getLogicalName()
+            );
+        }
+        foreach ($this->entries as $e) {
+            $lines = array_merge($lines, $e->dumpDivisions($level + 1));
+        }
+        foreach ($this->children as $n) {
+            $lines = array_merge($lines, $n->dumpDivisions($level + 1));
+        }
+        if ($this->name !== 'ROOT') {
+            $lines[] = sprintf('%s}', $indent);
+        }
+        return $lines;
+    }
 }
diff --git a/src/DiagramElement/Relation.php b/src/DiagramElement/Relation.php
@@ -74,4 +74,17 @@ public function getUses(): array
     {
         return $this->package->getUses([]);
     }
+
+    public function dumpDivisions(): array
+    {
+        $lines = ['@startuml division-diagram'];
+        $lines = array_merge($lines, array_map(function ($x) {
+            return '  ' . $x;
+        }, $this->options->headers()));
+        $lines = array_merge($lines, $this->package->dumpDivisions());
+        $lines[] = '@enduml';
+
+        return $lines;
+    }
+
 }
diff --git a/src/Main.php b/src/Main.php
@@ -48,6 +48,9 @@ public function __construct(string $directory, Options $options)
                 echo implode("\r\n", $relation->dump()) . "\r\n";
                 echo implode("\r\n", $relation->dumpPackages()) . "\r\n";
                 break;
+            case OPTIONS::DIAGRAM_DIVSION:
+                echo implode("\r\n", $relation->dumpDivisions()) . "\r\n";
+                break;
             default:
                 throw new \Exception('invalid diagram.');
         }
diff --git a/src/Php/PhpClass.php b/src/Php/PhpClass.php
@@ -16,6 +16,8 @@
     Namespace_,
     ClassLike,
     ClassMethod,
+    Enum_,
+    EnumCase,
     Property,
     GroupUse,
     Use_,
@@ -225,4 +227,21 @@ public function getExtends(): array
         }
         return $extends;
     }
+
+    /**
+     * @return PhpEnumCase[] list of enum options.
+     */
+    public function getEnumCases(): array
+    {
+        if ( ! $this->syntax instanceof Enum_) {
+            return [];
+        }
+        $cases = [];
+        foreach ($this->syntax->stmts as $stmt) {
+            if ($stmt instanceof EnumCase) {
+                $cases[] = new PhpEnumCase($stmt);
+            }
+        }
+        return $cases;
+    }
 }
diff --git a/src/Php/PhpEnumCase.php b/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));
+    }
+
+}
diff --git a/test/OptionsTest.php b/test/OptionsTest.php
@@ -124,6 +124,15 @@ public function testDiagram2(): void {
 
         $this->assertSame(Options::DIAGRAM_PACKAGE, $options->diagram(), 'diagram is package.');
     }
+    public function testDiagram_division(): void {
+        $opt = [
+            'division-diagram' => true,
+        ];
+
+        $options = new Options($opt);
+
+        $this->assertSame(Options::DIAGRAM_DIVSION, $options->diagram(), 'diagram is division.');
+    }
     public function testDiagram3(): void {
         $opt = [
         ];
diff --git a/test/PhpReflectionTest.php b/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,5 +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.');
+        $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.');
     }
 }
diff --git a/test/fixtures/enum/Sub/Status.php b/test/fixtures/enum/Sub/Status.php
@@ -0,0 +1,28 @@
+<?php
+namespace Hoge\TestEnum\Sub;
+
+enum Status {
+    /** プレイヤーのターン */
+    case Player;
+    /** コンピュータのターン */
+    case Computer;
+    /** ゲーム終了 */
+    case GameSet;
+}
+
+enum MyExceptionCase {
+    case InvalidMethod;
+    case InvalidProperty;
+    case Timeout;
+}
+
+enum Size
+{
+    public static function getSmallest(): self
+    {
+        return self::Small;
+    }
+    case Small;
+    case Medium;
+    case Large;
+}
diff --git a/test/fixtures/enum/TestEnum.php b/test/fixtures/enum/TestEnum.php
@@ -1,11 +1,19 @@
 <?php
 namespace Hoge\TestEnum;
 
+/** スート */
 enum Suit
 {
+    /** ハート */
     case Hearts;
+    /** ダイヤ */
     case Diamonds;
+    /** クローバー */
     case Clubs;
+    /**
+     * スペード
+     * 説明コメント
+     */
     case Spades;
 }
 
diff --git a/update-dogfood-images.sh b/update-dogfood-images.sh
@@ -6,11 +6,14 @@ SCRIPT_DIR=$(cd $(dirname $0); pwd)
 $SCRIPT_DIR/bin/php-class-diagram \
 	--enable-class-properties \
 	--enable-class-methods $SCRIPT_DIR/src \
-	| plantuml -pipe -tpng > $SCRIPT_DIR/dogfood.png
+	| plantuml -charset utf-8 -pipe -tpng > $SCRIPT_DIR/dogfood.png
 $SCRIPT_DIR/bin/php-class-diagram \
 	--disable-class-properties \
 	--disable-class-methods $SCRIPT_DIR/src \
-	| plantuml -pipe -tpng > $SCRIPT_DIR/dogfood-model.png
+	| plantuml -charset utf-8 -pipe -tpng > $SCRIPT_DIR/dogfood-model.png
 $SCRIPT_DIR/bin/php-class-diagram \
 	--package-diagram $SCRIPT_DIR/src \
-	| plantuml -pipe -tpng > $SCRIPT_DIR/dogfood-package.png
+	| plantuml -charset utf-8 -pipe -tpng > $SCRIPT_DIR/dogfood-package.png
+$SCRIPT_DIR/bin/php-class-diagram \
+	--division-diagram $SCRIPT_DIR/test/fixtures/enum \
+	| plantuml -charset utf-8 -pipe -tpng > $SCRIPT_DIR/output-division.png

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ class Options`
`15`	`15`	`const DIAGRAM_CLASS = 'class';`
`16`	`16`	`const DIAGRAM_PACKAGE = 'package';`
`17`	`17`	`const DIAGRAM_JIG = 'jig';`
	`18`	`+ const DIAGRAM_DIVSION = 'division';`
`18`	`19`
`19`	`20`	`public function __construct(array $opt)`
`20`	`21`	`{`
`@@ -43,6 +44,9 @@ public function diagram(): string`
`43`	`44`	`if (isset($this->opt['jig-diagram'])) {`
`44`	`45`	`return self::DIAGRAM_JIG;`
`45`	`46`	`}`
	`47`	`+ if (isset($this->opt['division-diagram'])) {`
	`48`	`+ return self::DIAGRAM_DIVSION;`
	`49`	`+ }`
`46`	`50`	`// default`
`47`	`51`	`return self::DIAGRAM_CLASS;`
`48`	`52`	`}`