Support for generating many to many association in mermaid-class-diag…

…ram-from-csharp (#132)

Added support for merging two one to many composition into one many to many association in class diagrams

.vscode/settings.json

@@ -1,3 +1,24 @@
 {
-  "sarif-viewer.connectToGithubCodeScanning": "off"
+	"sarif-viewer.connectToGithubCodeScanning": "off",
+	"explorer.fileNesting.enabled": true,
+	"explorer.fileNesting.patterns": {
+		// shows *.feature.cs files as nested items
+		"*.feature": "${capture}.feature.cs"
+	},
+	"files.exclude": {
+		// excludes compilation result
+		"**/obj/": true,
+		"**/bin/": true
+	},
+	"cucumber.glue": [
+		// sets the location of the step definition classes
+		"src/develop/DryGen.*/Steps/**/*.cs"
+	],
+	"cucumber.features": [
+		// sets the location of the feature files
+		"src/develop/DryGen.*/Features/**/*.feature"
+  ],
+"dotnet.automaticallySyncWithActiveItem": true,
+"csharp.preview.improvedLaunchExperience": true,
+"dotnet.automaticallyCreateSolutionInWorkspace": false
 }

docs/templates/releasenotes/yyyy-MM-dd-v-x.y.z.md

@@ -0,0 +1,15 @@
+.!.!.replace-token-for-release-notes-header.!.!.
+> [!IMPORTANT]
+> In v 2.x .Net 6 and .Net 7 will no longer be supported, since they're no longer supported by Microsoft.
+
+### Improvements in this version
+## Prerelease 2
+- Added support for generating many to many association in `mermaid-class-diagram-from-csharp`.
+## Prerelease 1 (2024-10-29)
+- Fixed an issue where  `mermaid-er-diagram-from-efcore` would fail when an input assebly referenced Asp.Net Core. 
+   - Ie the .csproj file contained `<Project Sdk="Microsoft.NET.Sdk.Web">` or `<FrameworkReference Include="Microsoft.AspNetCore.App|All">` or referenced such an assembly.
+- Added support for generating many to many relations in `mermaid-er-diagram-from-efcore`.
+- Switched to [docfx](https://dotnet.github.io/docfx/) for generating  the documentation. 
+   - docfx uses .Net, so Ruby is no longer needed in the development toolchain
+
+Have fun!

src/DryGen.Core/AssemblyLoadException.cs

@@ -1,24 +1,10 @@
 using System;
-#if (NET6_0)
-using System.Diagnostics.CodeAnalysis;
-using System.Runtime.Serialization;
-#endif
-
 namespace DryGen.Core;
 
-#if (NET6_0)
-[Serializable]
-#endif
 public sealed class AssemblyLoadException : Exception
 {
     public AssemblyLoadException(string? message) : base(message)
     {
     }
 
-#if (NET6_0)
-	[ExcludeFromCodeCoverage]
-    private AssemblyLoadException(SerializationInfo info, StreamingContext context) : base(info, context)
-    {
-    }
-#endif
 }

src/DryGen.Core/InvalidContentException.cs

@@ -1,24 +1,10 @@
 using System;
-#if (NET6_0)
-using System.Diagnostics.CodeAnalysis;
-using System.Runtime.Serialization;
-#endif
 
 namespace DryGen.Core;
 
-#if (NET6_0)
-[Serializable]
-#endif
 public sealed class InvalidContentException : Exception
 {
     public InvalidContentException(string? message) : base(message)
     {
     }
-
-#if (NET6_0)
-	[ExcludeFromCodeCoverage]
-    private InvalidContentException(SerializationInfo info, StreamingContext context) : base(info, context)
-    {
-    }
-#endif
 }

src/DryGen.Core/TypeLoadException.cs

@@ -1,24 +1,11 @@
 using System;
-#if (NET6_0)
-using System.Diagnostics.CodeAnalysis;
-using System.Runtime.Serialization;
-#endif
 
 namespace DryGen.Core;
 
-#if (NET6_0)
-[Serializable]
-#endif
 public sealed class TypeLoadException : Exception
 {
     public TypeLoadException(string? message) : base(message)
     {
     }
 
-#if (NET6_0)
-	[ExcludeFromCodeCoverage]
-    private TypeLoadException(SerializationInfo info, StreamingContext context) : base(info, context)
-    {
-    }
-#endif
 }

src/DryGen.Core/TypeMemberException.cs

@@ -1,24 +1,10 @@
 using System;
-#if (NET6_0)
-using System.Diagnostics.CodeAnalysis;
-using System.Runtime.Serialization;
-#endif
 
 namespace DryGen.Core;
 
-#if (NET6_0)
-[Serializable]
-#endif
 public sealed class TypeMemberException : Exception
 {
     public TypeMemberException(string? message) : base(message)
     {
     }
-
-#if (NET6_0)
-	[ExcludeFromCodeCoverage]
-    private TypeMemberException(SerializationInfo info, StreamingContext context) : base(info, context)
-    {
-    }
-#endif
 }

src/DryGen.MermaidFromCSharp/ClassDiagram/ClassDiagramClass.cs

@@ -72,6 +72,10 @@ public void AddRelationship(
         relationships.Add(relationShip);
     }
 
+    public void RemoveRelationship(ClassDiagramRelationship relationship) {
+        relationships?.Remove(relationship);
+    }
+
     public void RemoveBidirectionalRelationshipDuplicates()
     {
         relationships.RemoveAll(r =>
@@ -80,6 +84,25 @@ public void RemoveBidirectionalRelationshipDuplicates()
                 r.To.Relationships.Any(x => x.To == this && x.RelationsshipType == ClassDiagramRelationshipType.Aggregation));
     }
 
+    public void MergeTwoOneToManyIntoOneMayToMany()
+    {
+        bool wasModified;
+        do
+        {
+            // Must use an outer loop since a self referencing many to many will modify the relationships collection and the enumeration will crash
+            wasModified = false;
+            foreach (var relationship in relationships.Where(x => x.RelationsshipType == ClassDiagramRelationshipType.Composition && !x.IsBidirectional)) {
+                var backRelationship = relationship.To.Relationships.FirstOrDefault(x => x.To == this && x.RelationsshipType == ClassDiagramRelationshipType.Composition && x != relationship);
+                if (backRelationship == null) {
+                    continue;
+                }
+                relationship.MergeAsManyToManyWith(backRelationship);
+                wasModified = true;
+                break;
+            }
+        } while (wasModified);
+    }
+
     internal void PromoteMethodToExtendedClass(ClassDiagramMethod method, ClassDiagramClass classDiagramClass)
     {
         methods.Remove(method);

src/DryGen.MermaidFromCSharp/ClassDiagram/ClassDiagramGenerator.cs

@@ -66,6 +66,10 @@ private void GenerateClassDiagramStructure(IEnumerable<ClassDiagramClass> classD
         {
             classDiagramClass.RemoveBidirectionalRelationshipDuplicates();
         }
+        foreach (var classDiagramClass in classDiagramClasses)
+        {
+            classDiagramClass.MergeTwoOneToManyIntoOneMayToMany();
+        }
     }
 
     private static ClassDiagramClass[] ConvertExtensionMethodsToInstanceMethodsOnKnownTypes(IEnumerable<ClassDiagramClass> classDiagramClasses)

src/DryGen.MermaidFromCSharp/ClassDiagram/ClassDiagramRelationship.cs

@@ -27,4 +27,11 @@ public ClassDiagramRelationship(
     public string Label { get; set; }
     public string PropertyName { get; }
     public bool IsBidirectional { get; set; }
+
+    public void MergeAsManyToManyWith(ClassDiagramRelationship backRelationship) {
+        FromCardinality = ClassDiagramRelationshipCardinality.ZeroOrMore;
+        RelationsshipType = ClassDiagramRelationshipType.Association;
+        IsBidirectional = true;
+        To.RemoveRelationship(backRelationship);  
+    }
 }

src/DryGen/OptionsException.cs

@@ -1,25 +1,10 @@
 using System;
 
-#if (NET6_0)
-using System.Diagnostics.CodeAnalysis;
-using System.Runtime.Serialization;
-#endif
-
 namespace DryGen;
 
-#if (NET6_0)
-[Serializable]
-#endif
 public sealed class OptionsException : Exception
 {
     public OptionsException(string message) : base(message)
     {
     }
-
-#if (NET6_0)
-    [ExcludeFromCodeCoverage]
-    private OptionsException(SerializationInfo info, StreamingContext context) : base(info, context)
-    {
-    }
-#endif
 }

src/develop/DryGen.ITests/reqnroll.json

@@ -5,7 +5,7 @@
     "enabled": true,
     "filepath": ".specflow.livingdoc.data.json"
   },
-  "stepAssemblies": [
+  "bindingAssemblies": [
     {
       "assembly": "DryGen.DevUtils"
     }

src/develop/DryGen.UTests/Features/Mermaid/FromCSharpAndEfCore/ClassDiagram/GeneratingRelationships.feature

@@ -634,16 +634,42 @@ Scenario: Generates ER relations with labels when the property name and type nam
 		
 		"""
 
-Scenario: Generates self referencing many to many relationship. WIP
+Scenario: Generates many to many relationship
+	Given this C# source code
+		"""
+		using System.Collections.Generic;
+		namespace Test
+		{
+			public class MyClassOne
+			{
+				public ICollection<MyClassTwo> AssociatedTo { get; } = [];
+			}
+			public class MyClassTwo
+			{
+				public ICollection<MyClassOne> AssociatedFrom { get; } = [];
+			}
+		}
+		"""
+	When I generate a Class diagram
+	Then I should get this generated representation
+		"""
+		classDiagram
+			class MyClassOne
+			class MyClassTwo
+			MyClassOne "*" <--> "*" MyClassTwo : associated to
+
+		"""
+
+Scenario: Generates self referencing many to many relationship.
 	Given this C# source code
 		"""
 		using System.Collections.Generic;
 		namespace Test
 		{
 			public class MyClass
 			{
-				public ICollection<MyClass> MyClassesOne { get; } = [];
-				public ICollection<MyClass> MyClassesTwo { get; } = [];
+				public ICollection<MyClass> AssociatedTo { get; } = [];
+				public ICollection<MyClass> AssociatedFrom { get; } = [];
 			}
 		}
 		"""
@@ -652,8 +678,6 @@ Scenario: Generates self referencing many to many relationship. WIP
 		"""
 		classDiagram
 			class MyClass
-			MyClass *-- "*" MyClass : my classes one
-			MyClass *-- "*" MyClass : my classes two
+			MyClass "*" <--> "*" MyClass : associated to
 
 		"""
-

src/develop/DryGen.UTests/reqnroll.json

@@ -4,7 +4,7 @@
     "enabled": true,
     "filepath": ".specflow.livingdoc.data.json"
   },
-  "stepAssemblies": [
+  "bindingAssemblies": [
     {
       "assembly": "DryGen.DevUtils"
     }