+ new tag, works with -dir: -addPackageTags

akravtsova · akravtsova · commit df40b748875c · 2024-12-12T15:51:55.000+06:00
diff --git a/README.md b/README.md
@@ -9,9 +9,10 @@ This is a generator to create a class-diagram of PlantUML from the C# source cod
 
 **README.md Version revision history**
 
-| Version | Commit                                                       | Comment                                                      |
-| ------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
-| 1.1     | [e73b4fe](https://github.com/pierre3/PlantUmlClassDiagramGenerator/commit/e73b4feed9cd261271eb990a9c859f53536e8d7c) | Add "-excludeUmlBeginEndTags" option |
+| Version | Commit                                                       | Comment                                                                                                      |
+|---------| ------------------------------------------------------------ |--------------------------------------------------------------------------------------------------------------|
+| 1.2     | [e73b4fe](https://github.com/pierre3/PlantUmlClassDiagramGenerator/commit/e73b4feed9cd261271eb990a9c859f53536e8d7c) | Add "-addPackageTags" option                                                                                 |
+| 1.1     | [e73b4fe](https://github.com/pierre3/PlantUmlClassDiagramGenerator/commit/e73b4feed9cd261271eb990a9c859f53536e8d7c) | Add "-excludeUmlBeginEndTags" option                                                                         |
 | 1.0     | [70bb820](https://github.com/pierre3/PlantUmlClassDiagramGenerator/commit/70bb8202f7f489aa2d85ce9c25c58121c8f63aed) | Because the README.md for other languages is not always updated at the same time, a version number is needed |
 
 ## Roslyn Source Generator
@@ -39,13 +40,14 @@ dotnet tool install --global PlantUmlClassDiagramGenerator
 Run the "puml-gen" command.
 
 ```bat
-puml-gen InputPath [OutputPath] [-dir] [-public | -ignore IgnoreAccessibilities] [-excludePaths ExcludePathList] [-createAssociation]
+puml-gen InputPath [OutputPath] [-dir] [-addPackageTags] [-public | -ignore IgnoreAccessibilities] [-excludePaths ExcludePathList] [-createAssociation]
 ```
 
 - InputPath: (Required) Sets a input source file or directory name.
 - OutputPath: (Optional) Sets a output file or directory name.  
   If you omit this option, plantuml files are outputted to same directory as the input files.
 - -dir: (Optional) Specify when InputPath and OutputPath are directory names.
+- -addPackageTags: (Optional) If there is "-dir" tag, then program adds "package" tags and puts all relations in the end of include.puml
 - -public: (Optional) If specified, only public accessibility members are output. 
 - -ignore: (Optional) Specify the accessibility of members to ignore, with a comma separated list.
 - -excludePaths: (Optional) Specify the exclude file and directory.   
diff --git a/src/PlantUmlClassDiagramGenerator.Library/ClassDiagramGenerator/ClassDiagramGenerator.cs b/src/PlantUmlClassDiagramGenerator.Library/ClassDiagramGenerator/ClassDiagramGenerator.cs
@@ -8,26 +8,28 @@
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using PlantUmlClassDiagramGenerator.Attributes;
 
-namespace PlantUmlClassDiagramGenerator.Library;
+namespace PlantUmlClassDiagramGenerator.Library.ClassDiagramGenerator;
 
 public class ClassDiagramGenerator(
     TextWriter writer,
     string indent,
     Accessibilities ignoreMemberAccessibilities = Accessibilities.None,
     bool createAssociation = true,
     bool attributeRequired = false,
-    bool excludeUmlBeginEndTags = false) : CSharpSyntaxWalker
+    bool excludeUmlBeginEndTags = false,
+    bool addPackageTags = false) : CSharpSyntaxWalker
 {
     private readonly HashSet<string> types = [];
     private readonly List<SyntaxNode> additionalTypeDeclarationNodes = [];
     private readonly Accessibilities ignoreMemberAccessibilities = ignoreMemberAccessibilities;
-    private readonly RelationshipCollection relationships = new();
+    public readonly RelationshipCollection relationships = new();
     private readonly TextWriter writer = writer;
     private readonly string indent = indent;
     private int nestingDepth = 0;
     private readonly bool createAssociation = createAssociation;
     private readonly bool attributeRequired = attributeRequired;
     private readonly bool excludeUmlBeginEndTags = excludeUmlBeginEndTags;
+    private readonly bool addPackageTags = addPackageTags;
     private readonly Dictionary<string, string> escapeDictionary = new()
     {
         {@"(?<before>[^{]){(?<after>{[^{])", "${before}&#123;${after}"},
@@ -45,7 +47,24 @@ public void GenerateInternal(SyntaxNode root)
     {
         Visit(root);
         GenerateAdditionalTypeDeclarations();
-        GenerateRelationships();
+        if (!this.addPackageTags)
+            GenerateRelationships();
+    }
+
+    public override void VisitFileScopedNamespaceDeclaration(FileScopedNamespaceDeclarationSyntax node)
+    {
+        if (this.addPackageTags)
+            VisitFileScopedNamespaceDeclaration(node, () => base.VisitFileScopedNamespaceDeclaration(node));
+        else
+            base.VisitFileScopedNamespaceDeclaration(node);
+    }
+    
+    public override void VisitNamespaceDeclaration(NamespaceDeclarationSyntax node)
+    {
+        if (this.addPackageTags)
+            VisitNamespaceDeclaration(node, () => base.VisitNamespaceDeclaration(node));
+        else
+            base.VisitNamespaceDeclaration(node);
     }
 
     public override void VisitInterfaceDeclaration(InterfaceDeclarationSyntax node)
@@ -371,7 +390,7 @@ private void WriteLine(string line)
     private bool SkipInnerTypeDeclaration(SyntaxNode node)
     {
         if (nestingDepth <= 0) return false;
-
+        if (nestingDepth == 1 && addPackageTags) return false;
         additionalTypeDeclarationNodes.Add(node);
         return true;
     }
@@ -411,6 +430,47 @@ private void GenerateRelationships()
             WriteLine(relationship.ToString());
         }
     }
+    
+    public static string[] GenerateRelationships(RelationshipCollection relationshipCollection)
+    {
+        List<string> strings = new List<string>();
+        foreach (var relationship in relationshipCollection)
+        {
+            strings.AddRange(relationshipCollection.Select(r => r.ToString()));
+        }
+
+        return strings.ToArray();
+    }
+    
+    private void VisitFileScopedNamespaceDeclaration(FileScopedNamespaceDeclarationSyntax node, Action visitBase)
+    {
+        if (attributeRequired && !node.AttributeLists.HasDiagramAttribute()) { return; }
+        if (node.AttributeLists.HasIgnoreAttribute()) { return; }
+        if (SkipInnerTypeDeclaration(node)) { return; }
+
+        var typeName = NamespaceNameText.From(node);
+
+        WriteLine($"package \"{typeName.Identifier}\" {{");
+        nestingDepth++;
+        visitBase();
+        nestingDepth--;
+        WriteLine("}");
+    }
+    
+    private void VisitNamespaceDeclaration(NamespaceDeclarationSyntax node, Action visitBase)
+    {
+        if (attributeRequired && !node.AttributeLists.HasDiagramAttribute()) { return; }
+        if (node.AttributeLists.HasIgnoreAttribute()) { return; }
+        if (SkipInnerTypeDeclaration(node)) { return; }
+
+        var typeName = NamespaceNameText.From(node);
+
+        WriteLine($"package \"{typeName.Identifier}\"{{");
+        nestingDepth++;
+        visitBase();
+        nestingDepth--;
+        WriteLine("}");
+    }
 
     private void VisitTypeDeclaration(TypeDeclarationSyntax node, Action visitBase)
     {
diff --git a/src/PlantUmlClassDiagramGenerator.Library/NamespaceNameText.cs b/src/PlantUmlClassDiagramGenerator.Library/NamespaceNameText.cs
@@ -0,0 +1,24 @@
+namespace PlantUmlClassDiagramGenerator.Library;
+
+using Microsoft.CodeAnalysis.CSharp.Syntax;
+
+public class NamespaceNameText
+{
+    public string Identifier { get; set; }
+    
+    public static NamespaceNameText From(FileScopedNamespaceDeclarationSyntax syntax)
+    {
+        return new NamespaceNameText
+        {
+            Identifier = syntax.Name.ToString()
+        };
+    }
+    
+    public static NamespaceNameText From(NamespaceDeclarationSyntax syntax)
+    {
+        return new NamespaceNameText
+        {
+            Identifier = syntax.Name.ToString()
+        };
+    }
+}
diff --git a/src/PlantUmlClassDiagramGenerator.Library/RelationshipCollection.cs b/src/PlantUmlClassDiagramGenerator.Library/RelationshipCollection.cs
@@ -1,5 +1,6 @@
 ﻿using System.Collections;
 using System.Collections.Generic;
+using System.Linq;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
 using PlantUmlClassDiagramGenerator.Attributes;
@@ -10,6 +11,14 @@ public class RelationshipCollection : IEnumerable<Relationship>
 {
     private readonly IList<Relationship> items = new List<Relationship>();
 
+    public void AddAll(RelationshipCollection collection)
+    {
+        foreach (var c in collection)
+        {
+            items.Add(c);
+        }
+    }
+
     public void AddInheritanceFrom(TypeDeclarationSyntax syntax)
     {
         if (syntax.BaseList == null) return;
diff --git a/src/PlantUmlClassDiagramGenerator/Program.cs b/src/PlantUmlClassDiagramGenerator/Program.cs
@@ -7,6 +7,7 @@
 using System.Text;
 using PlantUmlClassDiagramGenerator.Library;
 using System.Runtime.InteropServices;
+using PlantUmlClassDiagramGenerator.Library.ClassDiagramGenerator;
 
 namespace PlantUmlClassDiagramGenerator;
 
@@ -27,7 +28,8 @@ enum OptionType
         ["-createAssociation"] = OptionType.Switch,
         ["-allInOne"] = OptionType.Switch,
         ["-attributeRequired"] = OptionType.Switch,
-        ["-excludeUmlBeginEndTags"] = OptionType.Switch
+        ["-excludeUmlBeginEndTags"] = OptionType.Switch,
+        ["-addPackageTags"] = OptionType.Switch
     };
 
     static int Main(string[] args)
@@ -153,6 +155,7 @@ private static bool GeneratePlantUmlFromDir(Dictionary<string, string> parameter
 
         var error = false;
         var filesToProcess = ExcludeFileFilter.GetFilesToProcess(files, excludePaths, inputRoot);
+        RelationshipCollection relationships = new();
         foreach (var inputFile in filesToProcess)
         {
             Console.WriteLine($"Processing \"{inputFile}\"...");
@@ -177,8 +180,10 @@ private static bool GeneratePlantUmlFromDir(Dictionary<string, string> parameter
                         ignoreAcc,
                         parameters.ContainsKey("-createAssociation"),
                         parameters.ContainsKey("-attributeRequired"),
-                        excludeUmlBeginEndTags);
+                        excludeUmlBeginEndTags,
+                        parameters.ContainsKey("-addPackageTags"));
                     gen.Generate(root);
+                    relationships.AddAll(gen.relationships);
                 }
 
                 if (parameters.ContainsKey("-allInOne"))
@@ -205,6 +210,16 @@ private static bool GeneratePlantUmlFromDir(Dictionary<string, string> parameter
                 error = true;
             }
         }
+
+        if (parameters.ContainsKey("-addPackageTags"))
+        {
+            var lines = ClassDiagramGenerator.GenerateRelationships(relationships);
+            foreach (string line in lines.Distinct())
+            {
+                includeRefs.AppendLine(line);
+            }
+        }
+            
         if (!excludeUmlBeginEndTags) includeRefs.AppendLine("@enduml");
         File.WriteAllText(CombinePath(outputRoot, "include.puml"), includeRefs.ToString());
 
diff --git a/test/PlantUmlClassDiagramGeneratorTest/ClassDiagramGeneratorTest.cs b/test/PlantUmlClassDiagramGeneratorTest/ClassDiagramGeneratorTest.cs
@@ -3,6 +3,7 @@
 using System.Text;
 using System.IO;
 using PlantUmlClassDiagramGenerator.Library;
+using PlantUmlClassDiagramGenerator.Library.ClassDiagramGenerator;
 using Xunit;
 using Xunit.Abstractions;
 
