Merge pull request #41 from smeghead/support-pacakge-name-and-class-name-are-equal

support package name and class name are equal. className make alias.

Author: smeghead

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+### Bug fix
+
+ * Fixed. #40 If the namespace name and class name are the same, the class will not be displayed
+
 ## v0.3.1 (2023-02-24)
 
 ### Features

README.md

@@ -124,20 +124,21 @@ To execute `php-class-diagram` will print PlantUML script.
 $ vendor/bin/php-class-diagram test/fixtures/no-namespace
 @startuml class-diagram
   package product as product {
-    class product.Price {
+    class "Price" as product_Price {
       -price : int
     }
-    class product.Name {
+    class "Name" as product_Name {
       -name : string
     }
-    class product.Product {
+    class "Product" as product_Product {
       -name : Name
       -price : Price
       +method1(param1)
     }
   }
-  product.Product ..> product.Name
-  product.Product ..> product.Price
+  product_Product ..> product_Name
+  product_Product ..> product_Price
+  product_Product ..> product_Product
 @enduml
 ```
 

dogfood-model.png

@@ -8,8 +8,8 @@ class ArrowDependency extends Arrow {
 
     public function toString(PhpClass $toClass): string {
         if (strpos($this->getTo()->getName(), '[]') === false) {
-            return sprintf('  %s %s %s', $this->getFrom()->getLogicalName(), $this->figure, $toClass->getLogicalName());
+            return sprintf('  %s %s %s', $this->getFrom()->getClassNameAlias(), $this->figure, $toClass->getClassNameAlias());
         }
-        return sprintf('  %s "1" %s "*" %s', $this->getFrom()->getLogicalName(), $this->figure, str_replace('[]', '', $toClass->getLogicalName()));
+        return sprintf('  %s "1" %s "*" %s', $this->getFrom()->getClassNameAlias(), $this->figure, str_replace('[]', '', $toClass->getClassNameAlias()));
     }
 }

dogfood.png

@@ -7,6 +7,6 @@ class ArrowInheritance extends Arrow {
     protected string $figure = '<|--';
 
     public function toString(PhpClass $toClass): string {
-        return sprintf('  %s %s %s', $toClass->getLogicalName(), $this->figure, $this->getFrom()->getLogicalName());
+        return sprintf('  %s %s %s', $toClass->getClassNameAlias(), $this->figure, $this->getFrom()->getClassNameAlias());
     }
 }

output.png

@@ -37,7 +37,7 @@ public function dump($level = 0): array {
         // $meta = $this->class->getClassType()->getMeta() === 'Stmt_Interface' ? 'interface' : 'class';
         $meta = $this->class->getClassType()->getMetaName();
         if ($this->options->classProperties() || $this->options->classMethods()) {
-            $lines[] = sprintf('%s%s %s {', $indent, $meta, $this->class->getLogicalName());
+            $lines[] = sprintf('%s%s "%s" as %s {', $indent, $meta, $this->class->getClassType()->getName(), $this->class->getClassNameAlias());
             if ($this->options->classProperties()) {
                 foreach ($this->class->getProperties() as $p) {
                     $lines[] = sprintf('  %s%s%s : %s', $indent, $this->modifier($p->getAccessModifier()), $p->getName(), $p->getType()->getName());
@@ -53,7 +53,7 @@ public function dump($level = 0): array {
             }
             $lines[] = sprintf('%s}', $indent);
         } else {
-            $lines[] = sprintf('%s%s %s', $indent, $meta, $this->class->getLogicalName());
+            $lines[] = sprintf('%s%s "%s" as %s', $indent, $meta, $this->class->getClassType()->getName(), $this->class->getClassNameAlias());
         }
         return $lines;
     }

src/DiagramElement/ArrowDependency.php

@@ -56,6 +56,14 @@ public function getLogicalName(): string {
         return implode('.', $parts);
     }
 
+    /**
+     * return className alias in class-diagram.
+     * @return string className alias
+     */
+    public function getClassNameAlias(): string {
+        return str_replace(['.', '[', ']'], '_', $this->getLogicalName());
+    }
+
     public function getClassType(): PhpType {
         $namespace = [];
         foreach ($this->full as $stmt) {

src/DiagramElement/ArrowInheritance.php

@@ -309,12 +309,12 @@ public function testDump(): void {
         $expected =<<<EOS
 @startuml class-diagram
   package product as product {
-    class product.Product
-    class product.Price
-    class product.Name
+    class "Product" as product_Product
+    class "Price" as product_Price
+    class "Name" as product_Name
   }
-  product.Product ..> product.Name
-  product.Product ..> product.Price
+  product_Product ..> product_Name
+  product_Product ..> product_Price
 @enduml
 EOS;
         $this->assertSame($expected, implode(PHP_EOL, $rel->dump()), 'output PlantUML script.');
@@ -334,14 +334,14 @@ public function testDump2(): void {
         $expected =<<<EOS
 @startuml class-diagram
   package product as product {
-    class product.Product
-    class product.Price
+    class "Product" as product_Product
+    class "Price" as product_Price
     package utility as product.utility {
-      class product.Name
+      class "Name" as product_Name
     }
   }
-  product.Product ..> product.Name
-  product.Product ..> product.Price
+  product_Product ..> product_Name
+  product_Product ..> product_Price
 @enduml
 EOS;
         $this->assertSame($expected, implode(PHP_EOL, $rel->dump()), 'output PlantUML script.');
@@ -360,7 +360,7 @@ public function testDump3(): void {
         $expected =<<<EOS
 @startuml class-diagram
   package product as product {
-    interface product.Interface_
+    interface "Interface_" as product_Interface_
   }
 @enduml
 EOS;
@@ -379,7 +379,7 @@ public function testDump4(): void {
         $expected =<<<EOS
 @startuml class-diagram
   package product as product {
-    interface product.Interface_ {
+    interface "Interface_" as product_Interface_ {
       -name : string
     }
   }
@@ -399,7 +399,7 @@ public function testDump5(): void {
         $expected =<<<EOS
 @startuml class-diagram
   package product as product {
-    interface product.Interface_ {
+    interface "Interface_" as product_Interface_ {
       -method1(param1)
     }
   }
@@ -420,14 +420,14 @@ public function testDump6(): void {
         $expected =<<<EOS
 @startuml class-diagram
   package product as product {
-    interface product.Interface_ {
+    interface "Interface_" as product_Interface_ {
       -method1(param1)
     }
-    class product.Implement_ {
+    class "Implement_" as product_Implement_ {
       -method1(param1)
     }
   }
-  product.Interface_ <|-- product.Implement_
+  product_Interface_ <|-- product_Implement_
 @enduml
 EOS;
         $this->assertSame($expected, implode(PHP_EOL, $rel->dump()), 'output PlantUML script.');
@@ -447,11 +447,11 @@ public function testDump7(): void {
         $expected =<<<EOS
 @startuml class-diagram
   package product as product {
-    class product.Product
-    class product.Price
-    class product.Name
+    class "Product" as product_Product
+    class "Price" as product_Price
+    class "Name" as product_Name
   }
-  product.Product ..> product.Name
+  product_Product ..> product_Name
 @enduml
 EOS;
         $this->assertSame($expected, implode(PHP_EOL, $rel->dump()), 'output PlantUML script.');