add division diagram option.

Author: smeghead

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.

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.

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;
     }

src/DiagramElement/Entry.php

@@ -67,6 +67,24 @@ 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 [', $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);
+            }, $cases));
+            $lines[] = sprintf('%s]', $indent);
+        }
+        return $lines;
+    }
+
     private function modifier(PhpAccessModifier $modifier): string
     {
         $expressions = [];

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;
+    }
 }

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;
+    }
+
 }

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.');
         }

src/Php/PhpClass.php

@@ -16,6 +16,8 @@
     Namespace_,
     ClassLike,
     ClassMethod,
+    Enum_,
+    EnumCase,
     Property,
     GroupUse,
     Use_,
@@ -225,4 +227,18 @@ public function getExtends(): array
         }
         return $extends;
     }
+
+    public function getEnumCases(): array
+    {
+        if ( ! $this->syntax instanceof Enum_) {
+            return [];
+        }
+        $cases = [];
+        foreach ($this->syntax->stmts as $stmt) {
+            if ($stmt instanceof EnumCase) {
+                $cases[] = $stmt->name->name;
+            }
+        }
+        return $cases;
+    }
 }

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 = [
         ];

test/PhpReflectionTest.php

@@ -311,5 +311,6 @@ 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.');
     }
 }