refactor: Replace static sortNodes method with instance method in Nodes class for improved encapsulation

Author: tasuku43

src/ClassDiagramRenderer/ClassDiagram.php

@@ -4,6 +4,7 @@
 namespace Tasuku43\MermaidClassDiagram\ClassDiagramRenderer;
 
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Node;
+use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Nodes;
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Relationship\Dependency;
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Relationship\Composition;
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Relationship\Inheritance;
@@ -13,22 +14,19 @@
 
 class ClassDiagram
 {
-    /**
-     * @var Node[]
-     */
-    private array $nodes;
+    private Nodes $nodes;
 
     private Relationships $relationships;
 
     public function __construct()
     {
-        $this->nodes = [];
+        $this->nodes = Nodes::empty();
         $this->relationships = Relationships::empty();
     }
 
     public function addNode(Node $node): self
     {
-        $this->nodes[] = $node;
+        $this->nodes->add($node);
 
         return $this;
     }
@@ -44,12 +42,13 @@ public function addRelationships(Relationship ...$relationships): self
 
     public function render(RenderOptions $options = null): string
     {
-        Node::sortNodes($this->nodes);
+        $this->nodes->sort();
+        $nodes = $this->nodes->getAllNodes();
         $this->relationships->sort();
 
         $output = "classDiagram\n";
 
-        foreach ($this->nodes as $node) {
+        foreach ($nodes as $node) {
             $output .= "    " . $node->render() . "\n";
         }
 

src/ClassDiagramRenderer/Node/Node.php

@@ -131,11 +131,4 @@ private function collectTraitRelations(Node $traitNode, array &$visited, array &
             $this->collectTraitRelations($nestedTrait, $visited, $compositionsOut, $dependenciesOut);
         }
     }
-
-    public static function sortNodes(array &$nodes): void
-    {
-        usort($nodes, function (Node $a, Node $b) {
-            return strcmp($a->nodeName(), $b->nodeName());
-        });
-    }
 }

src/ClassDiagramRenderer/Node/Nodes.php

@@ -31,6 +31,12 @@ public function findByName(string $nodeName): ?Node
         return $this->nodes[$nodeName] ?? null;
     }
 
+    public function sort(): void
+    {
+        // Keys are node names; sort by key keeps deterministic order
+        ksort($this->nodes);
+    }
+
     /**
      * @return Node[]
      */

tests/ClassDiagramRenderer/ClassDiagramBuilderTest.php

@@ -42,6 +42,8 @@ class AbstractController {
     }
     class AuditLogger {
     }
+    class AuditTarget {
+    }
     class RepositoryAwareTrait {
         <<trait>>
     }
@@ -61,6 +63,7 @@ class UserStatus {
     }
 
     RepositoryAwareTrait *-- AuditLogger: composition
+    RepositoryAwareTrait ..> AuditTarget: dependency
     RepositoryAwareTrait ..> User: dependency
     RepositoryAwareTrait *-- UserRepositoryInterface: composition
     User *-- UserStatus: composition
@@ -70,6 +73,7 @@ class UserStatus {
     UserRepositoryInterface <|.. UserRepository: realization
     UserRepositoryInterface ..> User: dependency
     UserService *-- AuditLogger: composition
+    UserService ..> AuditTarget: dependency
     UserService ..> InvalidArgumentException: dependency
     UserService ..> User: dependency
     UserService *-- UserRepositoryInterface: composition
@@ -115,6 +119,8 @@ class AbstractController {
     }
     class AuditLogger {
     }
+    class AuditTarget {
+    }
     class RepositoryAwareTrait {
         <<trait>>
     }

tests/ClassDiagramRenderer/Node/NodeTest.php

@@ -84,24 +84,6 @@ public function testDepend(): void
         $this->assertInstanceOf(Dependency::class, $relationships[0]);
     }
 
-    /**
-     * Test the sortNodes static method
-     */
-    public function testSortNodes(): void
-    {
-        $nodeC = $this->createMockNode('C');
-        $nodeA = $this->createMockNode('A');
-        $nodeB = $this->createMockNode('B');
-        
-        $nodes = [$nodeC, $nodeA, $nodeB];
-        
-        Node::sortNodes($nodes);
-        
-        $this->assertEquals('A', $nodes[0]->nodeName());
-        $this->assertEquals('B', $nodes[1]->nodeName());
-        $this->assertEquals('C', $nodes[2]->nodeName());
-    }
-    
     /**
      * Test multiple relationships
      */

tests/ClassDiagramRenderer/Node/NodesTest.php

@@ -5,10 +5,41 @@
 
 use PHPUnit\Framework\TestCase;
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Class_;
+use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Node;
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Nodes;
 
 class NodesTest extends TestCase
 {
+    public function testSort(): void
+    {
+        $nodes = Nodes::empty();
+
+        $c = $this->mockNode('C');
+        $a = $this->mockNode('A');
+        $b = $this->mockNode('B');
+
+        // Add out of order
+        $nodes->add($c)->add($a)->add($b);
+
+        // Sort by name
+        $nodes->sort();
+        $sorted = array_values($nodes->getAllNodes());
+
+        $this->assertSame('A', $sorted[0]->nodeName());
+        $this->assertSame('B', $sorted[1]->nodeName());
+        $this->assertSame('C', $sorted[2]->nodeName());
+    }
+
+    private function mockNode(string $name): Node
+    {
+        return new class($name) extends Node {
+            public function render(): string
+            {
+                return "class {$this->name} {}";
+            }
+        };
+    }
+
     /**
      * Test the add and getAllNodes methods
      */