fix: Use FQN as identifiers in DOT Digraph

- Nodes were not using FQN as identifiers, then some nodes where overwritten, when definition names matched - Fixed by using FQN instead
MontealegreLuis · Sep 2, 2021 · b654a36 · b654a36
1 parent b2a73ea
commit b654a36
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 11 deletions.
diff --git a/src/Graphviz/ObjectHashIdentifier.php b/src/Graphviz/ObjectHashIdentifier.php
@@ -10,15 +10,14 @@
 use PhUml\Code\WithName;
 
 /**
- * Both `ClassDefinition` and `InterfaceDefinition` objects identifiers are generated using the
- * function `spl_object_hash`
+ * Both `ClassDefinition` and `InterfaceDefinition` objects identifiers are generated using their Fully Qualified Name
  */
 trait ObjectHashIdentifier
 {
     use WithName;
 
     public function identifier(): string
     {
-        return (string) $this->name();
+        return $this->name->fullName();
     }
 }
diff --git a/tests/src/Fakes/WithDotLanguageAssertions.php b/tests/src/Fakes/WithDotLanguageAssertions.php
@@ -16,8 +16,9 @@ trait WithDotLanguageAssertions
 {
     public function assertNode(Definition $definition, string $dotLanguage): void
     {
+        $identifier = str_replace('\\', '\\\\', $definition->identifier());
         $this->assertMatchesRegularExpression(
-            "/\"{$definition->identifier()}\" \\[label=<(?:.)+{$definition->name()}(?:.)+> shape=plaintext color=\"#[0-9a-f]{6}\"\\]/",
+            "/\"{$identifier}\" \\[label=<(?:.)+{$definition->name()}(?:.)+> shape=plaintext color=\"#[0-9a-f]{6}\"\\]/",
             $dotLanguage,
             "Definition {$definition->name()} with identifier {$definition->identifier()} cannot be found"
         );
@@ -28,8 +29,10 @@ public function assertInheritance(
         Definition $parent,
         string $dotLanguage
     ): void {
+        $parentIdentifier = str_replace('\\', '\\\\', $parent->identifier());
+        $identifier = str_replace('\\', '\\\\', $definition->identifier());
         $this->assertMatchesRegularExpression(
-            "/\"{$parent->identifier()}\" -> \"{$definition->identifier()}\" \\[dir=back arrowtail=empty style=solid color=\"#[0-9a-f]{6}\"\\]/",
+            "/\"{$parentIdentifier}\" -> \"{$identifier}\" \\[dir=back arrowtail=empty style=solid color=\"#[0-9a-f]{6}\"\\]/",
             $dotLanguage,
             "{$definition->name()} identified by {$definition->identifier()} does not inherits {$parent->name()} identified by {$parent->identifier()}"
         );
@@ -40,8 +43,10 @@ public function assertImplementation(
         InterfaceDefinition $interface,
         string $dotLanguage
     ): void {
+        $interfaceIdentifier = str_replace('\\', '\\\\', $interface->identifier());
+        $identifier = str_replace('\\', '\\\\', $class->identifier());
         $this->assertMatchesRegularExpression(
-            "/\"{$interface->identifier()}\" -> \"{$class->identifier()}\" \\[dir=back arrowtail=empty style=dashed color=\"#[0-9a-f]{6}\"\\]/",
+            "/\"{$interfaceIdentifier}\" -> \"{$identifier}\" \\[dir=back arrowtail=empty style=dashed color=\"#[0-9a-f]{6}\"\\]/",
             $dotLanguage,
             "{$class->name()} does not implements {$interface->name()}"
         );

diff --git a/tests/unit/Generators/GenerateDotFileTest.php b/tests/unit/Generators/GenerateDotFileTest.php
@@ -29,8 +29,8 @@ function it_creates_the_dot_file_of_a_directory()
 
         $digraph = $this->processor->process($codebase);
 
-        $this->assertNode(A::classNamed('plBase'), $digraph->value());
-        $this->assertNode(A::classNamed('plPhuml'), $digraph->value());
+        $this->assertNode(A::classNamed('phuml\plBase'), $digraph->value());
+        $this->assertNode(A::classNamed('phuml\plPhuml'), $digraph->value());
     }
 
     /** @test */
@@ -42,14 +42,14 @@ function it_creates_the_dot_file_of_a_directory_using_a_recursive_finder()
 
         $digraph = $this->processor->process($codebase);
 
-        $base = A::classNamed('plBase');
+        $base = A::classNamed('phuml\plBase');
         $tokenParser = A::classNamed('plStructureTokenparserGenerator');
         $attribute = A::classNamed('plPhpAttribute');
         $class = A::classNamed('plPhpClass');
         $function = A::classNamed('plPhpFunction');
         $parameter = A::classNamed('plPhpFunctionParameter');
         $interface = A::classNamed('plPhpInterface');
-        $uml = A::classNamed('plPhuml');
+        $uml = A::classNamed('phuml\plPhuml');
         $dotProcessor = A::classNamed('plDotProcessor');
         $graphvizProcessor = A::classNamed('plGraphvizProcessor');
         $styleName = A::classNamed('plStyleName');
@@ -60,7 +60,7 @@ function it_creates_the_dot_file_of_a_directory_using_a_recursive_finder()
         $statisticsProcessor = A::classNamed('plStatisticsProcessor');
         $structureGenerator = A::classNamed('plStructureGenerator');
         $externalCommand = A::classNamed('plExternalCommandProcessor');
-        $processor = A::classNamed('plProcessor');
+        $processor = A::classNamed('phuml\interfaces\plProcessor');
         $style = A::classNamed('plGraphvizProcessorStyle');
         $this->assertNode($base, $digraph->value());
         $this->assertNode($structureGenerator, $digraph->value());