feat: Introduce TraitRenderMode for improved trait handling in relationships and nodes

Author: tasuku43

src/ClassDiagramRenderer/ClassDiagram.php

@@ -5,9 +5,9 @@
 
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Node;
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Nodes;
+use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\RenderOptions\RenderOptions;
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Relationship\Relationship;
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Relationship\Relationships;
-use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\RenderOptions\RenderOptions;
 
 class ClassDiagram
 {
@@ -37,7 +37,7 @@ public function addRelationships(Relationship ...$relationships): self
         return $this;
     }
 
-    public function render(RenderOptions $options = null): string
+    public function render(RenderOptions $options): string
     {
         $nodes        = $this->nodes->filter($options)->sort()->getAll();
         $relationships = $this->relationships->filter($options)->sort()->getAll();

src/ClassDiagramRenderer/Node/Nodes.php

@@ -3,6 +3,7 @@
 
 namespace Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node;
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\RenderOptions\RenderOptions;
+use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\TraitRenderMode;
 
 class Nodes
 {
@@ -44,7 +45,7 @@ public function filter(RenderOptions $options): self
     {
         $filtered = new self();
         foreach ($this->nodes as $node) {
-            if (!$options->includeTraits && $node instanceof Trait_) {
+            if (!$options->traitRenderMode->isWithTraits() && $node instanceof Trait_) {
                 continue;
             }
             $filtered->add($node);

src/ClassDiagramRenderer/Node/Relationship/Relationships.php

@@ -5,6 +5,7 @@
 
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\Node\Trait_;
 use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\RenderOptions\RenderOptions;
+use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\TraitRenderMode;
 
 class Relationships
 {
@@ -47,7 +48,7 @@ public function sort(): self
     public function filter(RenderOptions $options): self
     {
         $filtered = array_filter($this->relationships, function (Relationship $relationship) use ($options) {
-            if (!$options->includeTraits && ($relationship->from instanceof Trait_ || $relationship->to instanceof Trait_)) {
+            if (!$options->traitRenderMode->isWithTraits() && ($relationship->from instanceof Trait_ || $relationship->to instanceof Trait_)) {
                 return false;
             }
             if ($relationship instanceof Dependency && !$options->includeDependencies) {

src/ClassDiagramRenderer/RenderOptions/RenderOptions.php

@@ -3,19 +3,21 @@
 
 namespace Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\RenderOptions;
 
+use Tasuku43\MermaidClassDiagram\ClassDiagramRenderer\TraitRenderMode;
+
 class RenderOptions
 {
     public function __construct(
         public bool $includeDependencies,
         public bool $includeCompositions,
         public bool $includeInheritances,
         public bool $includeRealizations,
-        public bool $includeTraits = false,
+        public TraitRenderMode $traitRenderMode = TraitRenderMode::Flatten,
     ) {
     }
 
     public static function default(): self
     {
-        return new self(true, true, true, true, false);
+        return new self(true, true, true, true, TraitRenderMode::Flatten);
     }
 }

src/ClassDiagramRenderer/TraitRenderMode.php

@@ -0,0 +1,23 @@
+<?php
+declare(strict_types=1);
+
+namespace Tasuku43\MermaidClassDiagram\ClassDiagramRenderer;
+
+enum TraitRenderMode
+{
+    // Render trait nodes and trait use relationships
+    case WithTraits;
+
+    // Hide trait nodes and use lines; flatten trait deps to using classes
+    case Flatten;
+
+    public function isWithTraits(): bool
+    {
+        return $this === self::WithTraits;
+    }
+
+    public function isFlatten(): bool
+    {
+        return $this === self::Flatten;
+    }
+}