Merge pull request #35 from smeghead/external-package-hierarchy

smeghead · web-flow · commit 073e0b7872f7 · 2023-02-23T22:19:31.000+09:00
External package hierarchy
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 /vendor/
 *.phar
 *.un~
-composer.lock
+composer.lock
+.vscode
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG
 
+### Features
+
+ * Fixed so that the external package of the package relationship diagram is displayed hierarchically.
+
 ### Bug fix
 
  * Method's Parameter Dependencies added to arrows.
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/src/DiagramElement/ExternalPackage/PackageHierarchy.php b/src/DiagramElement/ExternalPackage/PackageHierarchy.php
@@ -0,0 +1,76 @@
+<?php declare(strict_types=1);
+namespace Smeghead\PhpClassDiagram\DiagramElement\ExternalPackage;
+
+class PackageHierarchy {
+    /**
+     * @var string[] external packages.
+     */
+    private array $externalPackages;
+
+    private PackageNode $root;
+
+    /**
+     * @param string[] $externalPackages external package list
+     */
+    public function __construct(array $externalPackages) {
+        $this->externalPackages = $externalPackages;
+        $this->root = new PackageNode('root');
+        foreach ($externalPackages as $p) {
+            $this->root->register(explode('.', $p));
+        }
+    }
+
+    public function dump(): string {
+        $elements = [];
+        foreach ($this->root->getChildren() as $c) {
+            $elements[] = $c->dump(1);
+        }
+        return implode("\n", $elements);
+    }
+}
+
+class PackageNode {
+    private string $name;
+    /** @var PackageNode[] children */
+    private array $children = [];
+
+    public function __construct(string $name) {
+        $this->name = $name;
+    }
+
+    /**
+     * @return PackageNode[]
+     */
+    public function getChildren(): array {
+        return $this->children;
+    }
+
+    /**
+     * @param string[] $packages
+     */
+    public function register(array $packages): void {
+        if (count($packages) === 0) {
+            return;
+        }
+        $next = array_shift($packages);
+        foreach ($this->children as $c) {
+            if ($c->name === $next) {
+                $c->register($packages);
+                return;
+            }
+        }
+        $new = new PackageNode($next);
+        $new->register($packages);
+        $this->children[] = $new;
+    }
+
+    public function dump(int $indent): string {
+        $lines = [];
+        $lines[] = sprintf('%spackage %s as %s #DDDDDD {', str_repeat('  ', $indent), $this->name, $this->name);
+        foreach ($this->children as $c) {
+            $lines[] = $c->dump($indent + 1);
+        }
+        $lines[] = sprintf('%s}', str_repeat('  ', $indent));
+        return implode("\n", $lines);
+    }
+}
diff --git a/src/DiagramElement/Package.php b/src/DiagramElement/Package.php
@@ -6,6 +6,7 @@
 class Package {
     private Options $options;
 
+    /** @var string[]  */
     public array $parents;
     public string $name;
     public string $package = '';
@@ -28,7 +29,7 @@ public function getLogicalName(): string {
     public function addEntry(array $paths, Entry $entry): string {
         if (count($paths) === 0) {
             if (empty($this->package)) {
-                $this->package = implode('.', $entry->getClass()->getClassType()->getNamespace());
+                $this->package = implode('.', $entry->getClass()->getNamespace());
             }
             $this->entries[] = $entry;
             return $this->package;
@@ -85,12 +86,22 @@ public function dump($level = 0): array {
     public function dumpPackages($level = 1): array {
         $indent = str_repeat('  ', $level);
         $lines = [];
-        $lines[] = sprintf(
-            '%spackage %s as %s {',
-            $indent,
-            $this->name === 'ROOT' ? (empty($this->package) ? 'ROOT': $this->package) : $this->name,
-            $this->getLogicalName()
-        );
+        $target = empty($this->package) ? $this->getLogicalName() : $this->package;
+        $targetElements = explode('.', $target);
+        if ($level > 1) {
+            $lines[] = sprintf(
+                '%spackage %s {',
+                $indent,
+                end($targetElements)
+            );
+        } else {
+            $lines[] = sprintf(
+                '%spackage %s as %s {',
+                $indent,
+                $target,
+                end($targetElements)
+            );
+        }
         foreach ($this->children as $n) {
             $lines = array_merge($lines, $n->dumpPackages($level + 1));
         }
@@ -131,7 +142,8 @@ public function getUses($acc): array {
         foreach ($this->entries as $e) {
             $uses = array_merge($uses, $e->getClass()->getUses());
         }
-        $acc[$this->package] = $uses;
+        $package = empty($this->package) ? sprintf('%s.%s', implode('.', $this->parents), $this->name) : $this->package;
+        $acc[$package] = $uses;
         foreach ($this->children as $n) {
             $acc = array_merge($acc, $n->getUses($acc));
         }
@@ -148,4 +160,31 @@ public function getTargetPackages($acc = []) {
         }
         return $acc;
     }
+
+    public function findPackage(string $package): ?Package {
+        return $this->recFindPackage($package);
+    }
+
+    public function is(string $package): bool {
+        $segments = $this->parents;
+        $segments[] = $this->name;
+        return implode('.', $segments) === $package;
+    }
+
+    /**
+     * @param string $package パッケージの表記(例: hoge.fuga)
+     * @return ?Package
+     */
+    private function recFindPackage(string $package): ?Package {
+        if ($this->is($package)) {
+            return $this;
+        }
+        foreach ($this->children as $c) {
+            $p = $c->recFindPackage($package);
+            if ( ! empty($p)) {
+                return $p;
+            }
+        }
+        return null;
+    }
 }
diff --git a/src/DiagramElement/PackageArrow.php b/src/DiagramElement/PackageArrow.php
@@ -29,6 +29,8 @@ public function toString(): string {
         $format = $this->bothSideArrow
             ? '  %s <-[#red,plain,thickness=4]-> %s'
             : '  %s --> %s';
-        return sprintf($format, $this->from, $this->to);
+        $fromElements = explode('.', $this->from);
+        $toElements = explode('.', $this->to);
+        return sprintf($format, end($fromElements), end($toElements));
     }
 }
diff --git a/src/DiagramElement/PackageRelations.php b/src/DiagramElement/PackageRelations.php
@@ -1,45 +1,58 @@
 <?php declare(strict_types=1);
 namespace Smeghead\PhpClassDiagram\DiagramElement;
 
+use Smeghead\PhpClassDiagram\DiagramElement\ExternalPackage\PackageHierarchy;
+use Smeghead\PhpClassDiagram\Php\PhpType;
+
 class PackageRelations {
-    /** @var \Smeghead\PhpClassDiagram\Php\PhpType[] */
+    /** @var array<string, \Smeghead\PhpClassDiagram\Php\PhpType[]> */
     private array $uses;
-    /** @var \Smeghead\PhpClassDiagram\Php\PhpType[] */
-    private array $targetPackages;
+    private Package $rootPackage;
 
-    public function __construct(array $uses, array $targetPackages) {
+    /**
+     * @param array<string, \Smeghead\PhpClassDiagram\Php\PhpType[]> $uses
+     * @param Package $rootPackage
+     */
+    public function __construct(array $uses, Package $rootPackage) {
         $this->uses = $uses;
-        $this->targetPackages = $targetPackages;
+        $this->rootPackage = $rootPackage;
     }
 
-    private function displayPackage($package) {
-        if (in_array($package, array_keys($this->targetPackages))) {
-            return $this->targetPackages[$package]; // 解析対象のpackageはディレクトリ名で表示
-        } else {
-            return $package; //外部のpackageはpackage表示
+    private function displayPackage(string $package): string {
+        $p = $this->rootPackage->findPackage($package);
+        if ( ! empty($p)) {
+            if (empty($p->package)) {
+                return $p->getLogicalName();
+            }
         }
+        return $package; //外部のpackageはpackage表示
     }
     
     public function getArrows(): array {
         $lines = [];
         $all = [];
         $packageRelations = [];
         foreach ($this->uses as $namespace => $us) {
-            $packages = array_unique(array_map(function($x){
+            $packageNames = array_unique(array_map(function(PhpType $x){
                 return implode('.', $x->getNamespace());
             }, $us));
             // 対象となっているpackage以外のpackageは、即席で定義する必要がある。
-            $all = array_unique(array_merge($all, $packages));
-            $packageRelations[$namespace] = array_map(function($x) {
-                return $this->displayPackage($x, $this->targetPackages);
-            }, $packages);
+            $all = array_unique(array_merge($all, $packageNames));
+            $packageRelations[$namespace] = array_map(function(string $x) {
+                return $this->displayPackage($x);
+            }, $packageNames);
         }
-        foreach (array_diff($all, array_keys($this->targetPackages)) as $external) {
-            $lines[] = sprintf('  package %s', $external); 
+        $externals = array_diff($all, array_keys($this->rootPackage->getTargetPackages()));
+        if (count($externals) > 0) {
+            $externalPackage = new PackageHierarchy($externals);
+            $lines[] = $externalPackage->dump();
         }
         $arrows = [];
         foreach ($packageRelations as $package => $dependencies) {
-            $package = $this->displayPackage($package, $this->targetPackages);
+            $package = $this->displayPackage($package);
+            if (empty($package)) {
+                continue;
+            }
             foreach ($dependencies as $d) {
                 if (empty($d)) {
                     continue;
diff --git a/src/DiagramElement/Relation.php b/src/DiagramElement/Relation.php
@@ -52,8 +52,7 @@ public function dumpPackages(): array {
         $lines = array_merge($lines, $this->options->headers());
         $lines = array_merge($lines, $this->package->dumpPackages());
         $uses = $this->getUses();
-        $targetPackages = $this->package->getTargetPackages();
-        $packageRelations = new PackageRelations($uses, $targetPackages);
+        $packageRelations = new PackageRelations($uses, $this->package);
         $lines = array_merge($lines, $packageRelations->getArrows());
         $lines[] = '@enduml';
 
diff --git a/test/PackageHierarchyTest.php b/test/PackageHierarchyTest.php
@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+
+use PhpParser\ParserFactory;
+use PHPUnit\Framework\TestCase;
+use Smeghead\PhpClassDiagram\DiagramElement\ExternalPackage\PackageHierarchy;
+
+final class PackageHierarchyTest extends TestCase {
+    public function setUp(): void {
+    }
+
+    public function testEmptyExternalPackages(): void {
+        $externals = [];
+
+        $sut = new PackageHierarchy($externals);
+
+        $this->assertSame('', $sut->dump(), 'empty string');
+
+    }
+
+    public function testOnlyExternalPackage(): void {
+        $externals = [
+            'External.One',
+        ];
+
+        $sut = new PackageHierarchy($externals);
+
+        $expected = <<<EOC
+  package External as External #DDDDDD {
+    package One as One #DDDDDD {
+    }
+  }
+EOC;
+        $this->assertSame($expected, $sut->dump(), 'empty string');
+
+    }
+
+
+}
diff --git a/test/PackageTest.php b/test/PackageTest.php
@@ -471,10 +471,11 @@ public function testDumpPackage1(): void {
         $expected =<<<EOS
 @startuml package-related-diagram
   package ROOT as ROOT {
-    package product as product {
+    package product {
     }
   }
-  package PhpParse
+  package PhpParse as PhpParse #DDDDDD {
+  }
   product --> PhpParse
 @enduml
 EOS;
@@ -492,13 +493,13 @@ public function testDumpPackage_bothSideArrows(): void {
         $rel = new Relation($entries, $options);
         $expected =<<<EOS
 @startuml package-related-diagram
-  package hoge.fuga as ROOT {
-    package product as product {
-      package utility as product.utility {
+  package hoge.fuga as fuga {
+    package product {
+      package utility {
       }
     }
   }
-  product <-[#red,plain,thickness=4]-> product.utility
+  product <-[#red,plain,thickness=4]-> utility
 @enduml
 EOS;
         $this->assertSame($expected, implode(PHP_EOL, $rel->dumpPackages()), 'output PlantUML script.');
diff --git a/test/PhpTypeExpressionTest.php b/test/PhpTypeExpressionTest.php
@@ -177,7 +177,6 @@ public function testMethodParameterInt(): void {
         } catch (Error $error) {
             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();
         $param = $ast[0]->stmts[2]->stmts[10]->getParams()[0];
diff --git a/test/dummy/PhpClassDummy.php b/test/dummy/PhpClassDummy.php
@@ -13,6 +13,8 @@
  * Dummy Class for tests.
  */
 class PhpClassDummy extends PhpClass {
+    private stdClass $data;
+    
     public function __construct(string $directory, string $filename, string $data) {
         $dirs = preg_split('/[\\\\\/]/', $filename);
         array_pop($dirs);
@@ -53,6 +55,10 @@ public function getProperties(): array {
         return $props;
     }
 
+    public function getNamespace(): array {
+        return $this->data->type->namespace;
+    }
+
     /**
      * @return PhpProperty[] プロパティ一覧
      */

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ public function toString(): string {`
`29`	`29`	`$format = $this->bothSideArrow`
`30`	`30`	`? ' %s <-[#red,plain,thickness=4]-> %s'`
`31`	`31`	`: ' %s --> %s';`
`32`		`- return sprintf($format, $this->from, $this->to);`
	`32`	`+ $fromElements = explode('.', $this->from);`
	`33`	`+ $toElements = explode('.', $this->to);`
	`34`	`+ return sprintf($format, end($fromElements), end($toElements));`
`33`	`35`	`}`
`34`	`36`	`}`