Merge pull request #2 from jtreher/add-custom-tag-support

Adds support for custom tags
jtreher · Oct 28, 2021 · e7dd90b · e7dd90b
2 parents ee12d5e + d1be5a0
commit e7dd90b
Show file tree

Hide file tree

Showing 17 changed files with 360 additions and 120 deletions.
diff --git a/src/C4Sharp.Sample.Orders/PackageByLayerDiagram.cs b/src/C4Sharp.Sample.Orders/PackageByLayerDiagram.cs
@@ -14,8 +14,8 @@ public class PackageByLayerDiagram
             ShowLegend = false,
             Structures = new Structure[]
             {
-                WebLayer,
-                ServiceLayer,
+                WebLayer(),
+                ServiceLayer(),
                 DataLayer,
             },
             Relationships = new[]
@@ -25,26 +25,41 @@ public class PackageByLayerDiagram
             }
         };
 
-        private static ContainerBoundary WebLayer => new("WebLayer", "web")
+        private static ContainerBoundary WebLayer()
         {
-            Components = new[]
+            var ordersController = OrdersController;
+            ordersController.AddTag(Tag.Deprecated);
+
+            return new("WebLayer", "web")
             {
-                OrdersController
+                Components = new[]
+            {
+               ordersController
             },
-        };
+            };
+        }
 
-        private static ContainerBoundary ServiceLayer => new("ServiceLayer", "service")
+        private static ContainerBoundary ServiceLayer()
         {
-            Components = new[]
-            {
-                IOrdersService,
-                OrdersService
-            },
-            Relationships = new []
+            var iOrdersService = IOrdersService;
+            iOrdersService.AddTag(Tag.Planned);
+
+            var ordersService = OrdersService;
+            ordersService.AddTag(Tag.InProgress);
+
+            return new("ServiceLayer", "service")
             {
-                (IOrdersService < OrdersService)["implements"],
-            }
-        };
+                Components = new[]
+                {
+                    iOrdersService,
+                    ordersService
+                },
+                Relationships = new[]
+                {
+                    (IOrdersService < OrdersService)["implements"],
+                }
+            };
+        }
 
         private static ContainerBoundary DataLayer => new("DataLayer", "data")
         {
@@ -53,10 +68,10 @@ public class PackageByLayerDiagram
                 IOrdersRepository,
                 OrdersRepository
             },
-            Relationships = new []
+            Relationships = new[]
             {
                 (IOrdersRepository < OrdersRepository)["implements"],
-            }            
+            }
         };
     }
 }
diff --git a/src/C4Sharp.Sample.Orders/Structures.cs b/src/C4Sharp.Sample.Orders/Structures.cs
@@ -10,33 +10,33 @@ public static class Structures
             description: "Orders controller",
             technology: "Asp.net REST API"
         );
-        
+
         public static Component IOrdersService => new(
             alias: nameof(IOrdersService),
             label: nameof(IOrdersService),
             description: "Orders service interface",
             technology: "C# Interface"
-        );    
-        
+        );
+
         public static Component OrdersService => new(
             alias: nameof(OrdersService),
             label: nameof(OrdersService),
             description: "Orders service concret",
             technology: "C# class"
-        );   
-        
+        );
+
         public static Component IOrdersRepository => new(
             alias: nameof(IOrdersRepository),
             label: nameof(IOrdersRepository),
             description: "Orders repository interface",
             technology: "C# interface"
-        );    
-        
+        );
+
         public static Component OrdersRepository => new(
             alias: nameof(OrdersRepository),
             label: nameof(OrdersRepository),
             description: "Orders repository",
             technology: "C# class / Dapper Framework"
-        );         
+        );
     }
 }
diff --git a/src/C4Sharp.Sample/Diagrams/ComponentDiagramBuilder.cs b/src/C4Sharp.Sample/Diagrams/ComponentDiagramBuilder.cs
@@ -5,10 +5,10 @@
 
 namespace C4Sharp.Sample.Diagrams
 {
-    using static Systems;    
-    using static Components;    
-    using static Containers;    
-    
+    using static Systems;
+    using static Components;
+    using static Containers;
+
     public static class ComponentDiagramBuilder
     {
         public static ComponentDiagram Build()
@@ -38,7 +38,7 @@ public static ComponentDiagram Build()
 
         private static ContainerBoundary Boundary()
         {
-            return new ("c1", "API Application")
+            return new("c1", "API Application")
             {
                 Components = new[]
                 {

diff --git a/src/C4Sharp/C4Sharp.csproj b/src/C4Sharp/C4Sharp.csproj
@@ -1,7 +1,8 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
         <TargetFramework>netstandard2.1</TargetFramework>
+        <LangVersion>9.0</LangVersion>
         <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
         <Title>C4Sharp - simple .NET superset of C4-PlantUML</Title>
         <Authors>yanjustino, leisiamedeiros</Authors>
@@ -10,7 +11,7 @@
         <PackageIcon>icon.png</PackageIcon>
         <RepositoryUrl>https://github.com/8T4/c4sharp</RepositoryUrl>
         <RepositoryType>git</RepositoryType>
-        <PackageTags>c4, diagrams</PackageTags>
+        <Package>c4, diagrams</Package>
         <PackageVersion>2.2.1</PackageVersion>
         <PackageIconUrl>https://github.com/8T4/c4sharp/blob/main/LICENSE</PackageIconUrl>
         <PublishRepositoryUrl>true</PublishRepositoryUrl>
@@ -20,6 +21,7 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
+        <PackageReference Include="System.Drawing.Common" Version="5.0.2" />
     </ItemGroup>
 
     <ItemGroup>

diff --git a/src/C4Sharp/Models/Component.cs b/src/C4Sharp/Models/Component.cs
@@ -23,10 +23,12 @@ public sealed class Component : Structure
         /// <param name="label"></param>
         /// <param name="description"></param>
         /// <param name="technology"></param>
-        public Component(string alias, string label, string description, string technology) 
+        /// <param name="tags">Optional</param>
+        public Component(string alias, string label, string description, string technology, params Tag[] tags)
             : base(alias, label, description, Boundary.Internal)
         {
             Technology = technology;
+            AddTag(tags);
         }
 
         /// <summary>
@@ -37,10 +39,12 @@ public Component(string alias, string label, string description, string technolo
         /// <param name="description"></param>
         /// <param name="technology"></param>
         /// <param name="link"></param>
-        public Component(string alias, string label, string description, string technology, string link)
+        /// <param name="tags">Optional</param>
+        public Component(string alias, string label, string description, string technology, string link, params Tag[] tags)
             : base(alias, label, description, link)
         {
             Technology = technology;
+            AddTag(tags);
         }
 
         /// <summary>
@@ -51,10 +55,12 @@ public Component(string alias, string label, string description, string technolo
         /// <param name="description"></param>
         /// <param name="technology"></param>
         /// <param name="boundary"></param>
-        public Component(string alias, string label, string description, string technology, Boundary boundary) 
+        /// <param name="tags">Optional</param>
+        public Component(string alias, string label, string description, string technology, Boundary boundary, params Tag[] tags)
             : base(alias, label, description, boundary)
         {
             Technology = technology;
+            AddTag(tags);
         }
 
         /// <summary>
@@ -66,10 +72,12 @@ public Component(string alias, string label, string description, string technolo
         /// <param name="technology"></param>
         /// <param name="link"></param>
         /// <param name="boundary"></param>
-        public Component(string alias, string label, string description, string technology, string link, Boundary boundary)
+        /// <param name="tags">Optional</param>
+        public Component(string alias, string label, string description, string technology, string link, Boundary boundary, params Tag[] tags)
             : base(alias, label, description, link, boundary)
         {
             Technology = technology;
+            AddTag(tags);
         }
     }
 }
diff --git a/src/C4Sharp/Models/Container.cs b/src/C4Sharp/Models/Container.cs
@@ -1,6 +1,6 @@
-using System.Collections.Generic;
-using C4Sharp.Extensions;
+using C4Sharp.Extensions;
 using C4Sharp.Models.Relationships;
+using System.Collections.Generic;
 
 namespace C4Sharp.Models
 {
@@ -17,25 +17,27 @@ namespace C4Sharp.Models
     /// </summary>
     public sealed class Container : Structure
     {
-        private readonly Dictionary<int, Container> _instances = 
+        private readonly Dictionary<int, Container> _instances =
             new Dictionary<int, Container>();
 
         public string Technology { get; }
         public ContainerType ContainerType { get; }
         public Container this[int index] => this.NewInstance(index);
-        
+
         /// <summary>
         /// Constructor
         /// </summary>
         /// <param name="alias">Should  be unique</param>
         /// <param name="type"></param>
         /// <param name="description"></param>
         /// <param name="technology"></param>
-        public Container(string alias, ContainerType type, string description, string technology) 
+        /// <param name="tags">Optional</param>
+        public Container(string alias, ContainerType type, string description, string technology, params Tag[] tags)
             : base(alias, type.GetDescription(), description, Boundary.Internal)
         {
             Technology = technology;
             ContainerType = type;
+            AddTag(tags);
         }
 
         /// <summary>
@@ -46,11 +48,13 @@ public Container(string alias, ContainerType type, string description, string te
         /// <param name="description"></param>
         /// <param name="technology"></param>
         /// <param name="link"></param>
-        public Container(string alias, ContainerType type, string description, string technology, string link)
+        /// <param name="tags">Optional</param>
+        public Container(string alias, ContainerType type, string description, string technology, string link, params Tag[] tags)
             : base(alias, type.GetDescription(), description, link)
         {
             Technology = technology;
             ContainerType = type;
+            AddTag(tags);
         }
 
         /// <summary>
@@ -61,11 +65,13 @@ public Container(string alias, ContainerType type, string description, string te
         /// <param name="description"></param>
         /// <param name="technology"></param>
         /// <param name="boundary"></param>
-        public Container(string alias, ContainerType type, string description, string technology, Boundary boundary) 
+        /// <param name="tags">Optional</param>
+        public Container(string alias, ContainerType type, string description, string technology, Boundary boundary, params Tag[] tags)
             : base(alias, type.GetDescription(), description, boundary)
         {
             Technology = technology;
             ContainerType = type;
+            AddTag(tags);
         }
 
         /// <summary>
@@ -77,25 +83,29 @@ public Container(string alias, ContainerType type, string description, string te
         /// <param name="description"></param>
         /// <param name="technology"></param>
         /// <param name="boundary"></param>
-        public Container(string alias, ContainerType type, string label, string description, string technology, Boundary boundary) 
+        /// <param name="tags">Optional</param>
+        public Container(string alias, ContainerType type, string label, string description, string technology, Boundary boundary, params Tag[] tags)
             : base(alias, label, description, boundary)
         {
             Technology = technology;
             ContainerType = type;
-        }          
-
+            AddTag(tags);
+        }
+
         /// <summary>
         /// Constructor
         /// </summary>
         /// <param name="alias">Should  be unique</param>
         /// <param name="label"></param>
         /// <param name="description"></param>
         /// <param name="technology"></param>
-        public Container(string alias, string label, string description, string technology) 
+        /// <param name="tags">Optional</param>
+        public Container(string alias, string label, string description, string technology, params Tag[] tags)
             : base(alias, label, description, Boundary.Internal)
         {
             Technology = technology;
             ContainerType = ContainerType.None;
+            AddTag(tags);
         }
 
         /// <summary>
@@ -106,11 +116,13 @@ public Container(string alias, string label, string description, string technolo
         /// <param name="description"></param>
         /// <param name="technology"></param>
         /// <param name="link"></param>
-        public Container(string alias, string label, string description, string technology, string link)
+        /// <param name="tags">Optional</param>
+        public Container(string alias, string label, string description, string technology, string link, params Tag[] tags)
             : base(alias, label, description, link)
         {
             Technology = technology;
             ContainerType = ContainerType.None;
+            AddTag(tags);
         }
 
         /// <summary>
@@ -121,11 +133,13 @@ public Container(string alias, string label, string description, string technolo
         /// <param name="description"></param>
         /// <param name="technology"></param>
         /// <param name="boundary"></param>
-        public Container(string alias, string label, string description, string technology, Boundary boundary) 
+        /// <param name="tags">Optional</param>
+        public Container(string alias, string label, string description, string technology, Boundary boundary, params Tag[] tags)
             : base(alias, label, description, boundary)
         {
             Technology = technology;
             ContainerType = ContainerType.None;
+            AddTag(tags);
         }
 
         /// <summary>
@@ -137,11 +151,13 @@ public Container(string alias, string label, string description, string technolo
         /// <param name="technology"></param>
         /// <param name="link"></param>
         /// <param name="boundary"></param>
-        public Container(string alias, string label, string description, string technology, string link, Boundary boundary)
+        /// <param name="tags">Optional</param>
+        public Container(string alias, string label, string description, string technology, string link, Boundary boundary, params Tag[] tags)
             : base(alias, label, description, link, boundary)
         {
             Technology = technology;
             ContainerType = ContainerType.None;
+            AddTag(tags);
         }
 
         /// <summary>
@@ -154,11 +170,13 @@ public Container(string alias, string label, string description, string technolo
         /// <param name="technology"></param>
         /// <param name="link"></param>
         /// <param name="boundary"></param>
-        public Container(string alias, ContainerType type, string label, string description, string technology, string link, Boundary boundary)
+        /// <param name="tags">Optional</param>
+        public Container(string alias, ContainerType type, string label, string description, string technology, string link, Boundary boundary, params Tag[] tags)
             : base(alias, label, description, link, boundary)
         {
             Technology = technology;
             ContainerType = type;
+            AddTag(tags);
         }
 
         /// <summary>