#24: Sequence Diagrams: Added support for net6.0, net7.0, net8.0 targ…

…et frameworks
synergy-software · Jan 9, 2024 · b8ce810 · b8ce810
1 parent 660b55e
commit b8ce810
Show file tree

Hide file tree

Showing 10 changed files with 465 additions and 5 deletions.
diff --git a/Architecture/Synergy.Architecture.Annotations/Synergy.Architecture.Annotations.csproj b/Architecture/Synergy.Architecture.Annotations/Synergy.Architecture.Annotations.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFramework>net6.0</TargetFramework>
+        <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <IsPackable>true</IsPackable>

diff --git a/Architecture/Synergy.Architecture.Diagrams/Synergy.Architecture.Diagrams.csproj b/Architecture/Synergy.Architecture.Diagrams/Synergy.Architecture.Diagrams.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFramework>net6.0</TargetFramework>
+        <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <IsPackable>true</IsPackable>

diff --git a/Architecture/Synergy.Architecture.Tests/Architecture/Public/Api.cs b/Architecture/Synergy.Architecture.Tests/Architecture/Public/Api.cs
@@ -21,7 +21,7 @@ public async Task Generate(Type marker)
 
         // ASSERT
         await Verifier.Verify(publicApi, "md")
-                      .UseMethodName("of." + assembly.GetName()
-                                                      .Name);
+                      .UseMethodName("of." + assembly.GetName().Name)
+                      .UniqueForTargetFrameworkAndVersion();
     }
 }
diff --git a/...ergy.Architecture.Annotations.verified.md → ...tecture.Annotations.DotNet6_0.verified.md b/...ergy.Architecture.Annotations.verified.md → ...tecture.Annotations.DotNet6_0.verified.md
diff --git a/...chitecture/Public/Api.of.Synergy.Architecture.Annotations.DotNet7_0.verified.md b/...chitecture/Public/Api.of.Synergy.Architecture.Annotations.DotNet7_0.verified.md
@@ -0,0 +1,118 @@
+# Synergy.Architecture.Annotations
+
+## Diagrams.Sequence.SequenceDiagramActivationAttribute (attribute) : Attribute, SequenceDiagramElement, SequenceDiagramGroup
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Group: SequenceDiagramGroupType { get; set; }
+ - GroupHeader: string? { get; set; }
+ - Note: string? { get; set; }
+ - Type: Type [Nullable] { get; }
+ - ctor(
+     type: Type
+   )
+
+## Diagrams.Sequence.SequenceDiagramArchetype (enum) : IComparable, IFormattable, IConvertible
+ - Participant = 0
+ - Actor = 1
+ - Boundary = 2
+ - Control = 3
+ - Entity = 4
+ - Database = 5
+ - Collections = 6
+ - Queue = 7
+
+## Diagrams.Sequence.SequenceDiagramCallAttribute (attribute) : Attribute, SequenceDiagramElement, SequenceDiagramGroup
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Group: SequenceDiagramGroupType { get; set; }
+ - GroupHeader: string? { get; set; }
+ - Message: string? { get; set; }
+ - Method: string [Nullable] { get; }
+ - Note: string? { get; set; }
+ - Result: string? { get; set; }
+ - Type: Type [Nullable] { get; }
+ - ctor(
+     type: Type,
+     method: string
+   )
+
+## Diagrams.Sequence.SequenceDiagramDatabaseCallAttribute (attribute) : SequenceDiagramExternalCallAttribute, SequenceDiagramElement, SequenceDiagramGroup
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Group: SequenceDiagramGroupType { get; set; }
+ - GroupHeader: string? { get; set; }
+ - Method: string [Nullable] { get; }
+ - Note: string? { get; set; }
+ - Result: string { get; }
+ - Type: string [Nullable] { get; }
+ - ctor(
+     sql: string
+   )
+
+## Diagrams.Sequence.SequenceDiagramDeactivationAttribute (attribute) : Attribute, SequenceDiagramElement
+ - Note: string? [Nullable] { get; set; }
+ - Type: Type { get; }
+ - ctor(
+     type: Type
+   )
+
+## Diagrams.Sequence.SequenceDiagramElement (interface)
+
+## Diagrams.Sequence.SequenceDiagramElementAttribute (attribute) : Attribute, SequenceDiagramElement
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Colour: string? { get; set; }
+ - Note: string? { get; set; }
+ - ctor()
+
+## Diagrams.Sequence.SequenceDiagramExternalActivationAttribute (attribute) : Attribute, SequenceDiagramElement, SequenceDiagramGroup
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Constructor: string { get; }
+ - Group: SequenceDiagramGroupType { get; set; }
+ - GroupHeader: string? { get; set; }
+ - Note: string? { get; set; }
+ - Type: string [Nullable] { get; }
+ - ctor(
+     type: string,
+     constructor: string? [Nullable]
+   )
+
+## Diagrams.Sequence.SequenceDiagramExternalCallAttribute (attribute) : Attribute, SequenceDiagramElement, SequenceDiagramGroup
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Group: SequenceDiagramGroupType { get; set; }
+ - GroupHeader: string? { get; set; }
+ - Method: string [Nullable] { get; }
+ - Note: string? { get; set; }
+ - Result: string { get; }
+ - Type: string [Nullable] { get; }
+ - ctor(
+     type: string,
+     method: string,
+     result: string? [Nullable, Optional]
+   )
+
+## Diagrams.Sequence.SequenceDiagramGroup (interface)
+ - Group: SequenceDiagramGroupType { get; }
+ - GroupHeader: string { get; }
+
+## Diagrams.Sequence.SequenceDiagramGroupType (enum) : IComparable, IFormattable, IConvertible
+ - None = 0
+ - Alt = 1
+ - Else = 2
+ - Loop = 3
+ - Par = 4
+ - Break = 5
+ - Critical = 6
+ - Group = 7
+
+## Diagrams.Sequence.SequenceDiagramNoteAttribute (attribute) : Attribute, SequenceDiagramElement
+ - Note: string? { get; set; }
+ - ctor(
+     note: string
+   )
+
+## Diagrams.Sequence.SequenceDiagramSelfCallAttribute (attribute) : Attribute, SequenceDiagramElement, SequenceDiagramGroup
+ - Group: SequenceDiagramGroupType { get; set; }
+ - GroupHeader: string? { get; set; }
+ - Method: string [Nullable] { get; }
+ - Note: string? { get; set; }
+ - ctor(
+     method: string
+   )
+
diff --git a/...chitecture/Public/Api.of.Synergy.Architecture.Annotations.DotNet8_0.verified.md b/...chitecture/Public/Api.of.Synergy.Architecture.Annotations.DotNet8_0.verified.md
@@ -0,0 +1,118 @@
+# Synergy.Architecture.Annotations
+
+## Diagrams.Sequence.SequenceDiagramActivationAttribute (attribute) : Attribute, SequenceDiagramElement, SequenceDiagramGroup
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Group: SequenceDiagramGroupType { get; set; }
+ - GroupHeader: string? { get; set; }
+ - Note: string? { get; set; }
+ - Type: Type [Nullable] { get; }
+ - ctor(
+     type: Type
+   )
+
+## Diagrams.Sequence.SequenceDiagramArchetype (enum) : IComparable, ISpanFormattable, IFormattable, IConvertible
+ - Participant = 0
+ - Actor = 1
+ - Boundary = 2
+ - Control = 3
+ - Entity = 4
+ - Database = 5
+ - Collections = 6
+ - Queue = 7
+
+## Diagrams.Sequence.SequenceDiagramCallAttribute (attribute) : Attribute, SequenceDiagramElement, SequenceDiagramGroup
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Group: SequenceDiagramGroupType { get; set; }
+ - GroupHeader: string? { get; set; }
+ - Message: string? { get; set; }
+ - Method: string [Nullable] { get; }
+ - Note: string? { get; set; }
+ - Result: string? { get; set; }
+ - Type: Type [Nullable] { get; }
+ - ctor(
+     type: Type,
+     method: string
+   )
+
+## Diagrams.Sequence.SequenceDiagramDatabaseCallAttribute (attribute) : SequenceDiagramExternalCallAttribute, SequenceDiagramElement, SequenceDiagramGroup
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Group: SequenceDiagramGroupType { get; set; }
+ - GroupHeader: string? { get; set; }
+ - Method: string [Nullable] { get; }
+ - Note: string? { get; set; }
+ - Result: string { get; }
+ - Type: string [Nullable] { get; }
+ - ctor(
+     sql: string
+   )
+
+## Diagrams.Sequence.SequenceDiagramDeactivationAttribute (attribute) : Attribute, SequenceDiagramElement
+ - Note: string? [Nullable] { get; set; }
+ - Type: Type { get; }
+ - ctor(
+     type: Type
+   )
+
+## Diagrams.Sequence.SequenceDiagramElement (interface)
+
+## Diagrams.Sequence.SequenceDiagramElementAttribute (attribute) : Attribute, SequenceDiagramElement
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Colour: string? { get; set; }
+ - Note: string? { get; set; }
+ - ctor()
+
+## Diagrams.Sequence.SequenceDiagramExternalActivationAttribute (attribute) : Attribute, SequenceDiagramElement, SequenceDiagramGroup
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Constructor: string { get; }
+ - Group: SequenceDiagramGroupType { get; set; }
+ - GroupHeader: string? { get; set; }
+ - Note: string? { get; set; }
+ - Type: string [Nullable] { get; }
+ - ctor(
+     type: string,
+     constructor: string? [Nullable]
+   )
+
+## Diagrams.Sequence.SequenceDiagramExternalCallAttribute (attribute) : Attribute, SequenceDiagramElement, SequenceDiagramGroup
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Group: SequenceDiagramGroupType { get; set; }
+ - GroupHeader: string? { get; set; }
+ - Method: string [Nullable] { get; }
+ - Note: string? { get; set; }
+ - Result: string { get; }
+ - Type: string [Nullable] { get; }
+ - ctor(
+     type: string,
+     method: string,
+     result: string? [Nullable, Optional]
+   )
+
+## Diagrams.Sequence.SequenceDiagramGroup (interface)
+ - Group: SequenceDiagramGroupType { get; }
+ - GroupHeader: string { get; }
+
+## Diagrams.Sequence.SequenceDiagramGroupType (enum) : IComparable, ISpanFormattable, IFormattable, IConvertible
+ - None = 0
+ - Alt = 1
+ - Else = 2
+ - Loop = 3
+ - Par = 4
+ - Break = 5
+ - Critical = 6
+ - Group = 7
+
+## Diagrams.Sequence.SequenceDiagramNoteAttribute (attribute) : Attribute, SequenceDiagramElement
+ - Note: string? { get; set; }
+ - ctor(
+     note: string
+   )
+
+## Diagrams.Sequence.SequenceDiagramSelfCallAttribute (attribute) : Attribute, SequenceDiagramElement, SequenceDiagramGroup
+ - Group: SequenceDiagramGroupType { get; set; }
+ - GroupHeader: string? { get; set; }
+ - Method: string [Nullable] { get; }
+ - Note: string? { get; set; }
+ - ctor(
+     method: string
+   )
+
diff --git a/...Synergy.Architecture.Diagrams.verified.md → ...chitecture.Diagrams.DotNet6_0.verified.md b/...Synergy.Architecture.Diagrams.verified.md → ...chitecture.Diagrams.DotNet6_0.verified.md
diff --git a/.../Architecture/Public/Api.of.Synergy.Architecture.Diagrams.DotNet7_0.verified.md b/.../Architecture/Public/Api.of.Synergy.Architecture.Diagrams.DotNet7_0.verified.md
@@ -0,0 +1,112 @@
+# Synergy.Architecture.Diagrams
+
+## Documentation.TechnicalBlueprint (class)
+ - ctor()
+ - Add(
+     diagrams: IEnumerable<SequenceDiagram>
+   ) : TechnicalBlueprint
+ - Add(
+     diagrams: params SequenceDiagram[] [ParamArray]
+   ) : TechnicalBlueprint
+ - Intro(
+     markdown: string
+   ) : TechnicalBlueprint
+ - Register(
+     interface: Type,
+     implementation: Type
+   ) : TechnicalBlueprint
+ - Register(
+     interface: Type,
+     services: IServiceProvider
+   ) : TechnicalBlueprint
+ - Register<TComponent, TImplementation>() : TechnicalBlueprint
+ - Render() : string
+ - TechnicalBlueprint.Titled(
+     title: string
+   ) : TechnicalBlueprint
+ - ToString() : string
+
+## Documentation.TechnicalBlueprint+DiagramComponents (class)
+ - ctor()
+ - Register(
+     interface: Type,
+     implementation: Type
+   ) : void
+ - Register<TComponent, TImplementation>() : void [NullableContext]
+ - Resolve(
+     origin: Type
+   ) : Type
+
+## Sequence.SequenceDiagram (record) : IEquatable<SequenceDiagram>
+ - Actor: SequenceDiagramActor [Nullable] { get; set; }
+ - Components: TechnicalBlueprint+DiagramComponents? { get; set; }
+ - FinishOn: Type[]? [Nullable] { get; set; }
+ - FooterText: string? { get; set; }
+ - Method: MethodInfo? { get; set; }
+ - TitleText: string? { get; set; }
+ - ctor(
+     Actor: SequenceDiagramActor [Nullable],
+     Method: MethodInfo? [Optional],
+     FinishOn: Type[]? [Nullable, Optional],
+     FooterText: string? [Optional],
+     Components: TechnicalBlueprint+DiagramComponents? [Optional],
+     TitleText: string? [Optional]
+   )
+ - Calling(
+     method: MethodInfo
+   ) : SequenceDiagram [NullableContext]
+ - Calling(
+     type: Type,
+     methodName: string,
+     arguments: params Type[] [ParamArray]
+   ) : SequenceDiagram [NullableContext]
+ - Calling<T>(
+     call: Expression<Action<T>>
+   ) : SequenceDiagram [NullableContext]
+ - Calling<T>(
+     methodName: string,
+     arguments: params Type[] [ParamArray]
+   ) : SequenceDiagram [NullableContext]
+ - CutOff(
+     types: params Type[] [ParamArray]
+   ) : SequenceDiagram [NullableContext]
+ - Footer(
+     footer: string
+   ) : SequenceDiagram [NullableContext]
+ - Render() : string [NullableContext]
+ - SequenceDiagram.From(
+     actor: SequenceDiagramActor
+   ) : SequenceDiagram [NullableContext]
+ - SequenceDiagram.From<T>() : SequenceDiagram [NullableContext]
+ - Title(
+     title: string
+   ) : SequenceDiagram [NullableContext]
+
+## Sequence.SequenceDiagramActor (record) : IEquatable<SequenceDiagramActor>
+ - Archetype: SequenceDiagramArchetype { get; set; }
+ - Colour: string? { get; set; }
+ - Name: string [Nullable] { get; set; }
+ - Note: string? { get; set; }
+ - ctor(
+     Name: string [Nullable],
+     Archetype: SequenceDiagramArchetype [Optional],
+     Note: string? [Optional],
+     Colour: string? [Optional]
+   )
+
+## Sequence.SequenceDiagramUrl (record) : IEquatable<SequenceDiagramUrl>
+ - _actor: SequenceDiagramActor { get; set; }
+ - _finishOn: List<Type> { get; set; }
+ - _footer: string? [Nullable] { get; set; }
+ - _root: MethodInfo { get; set; }
+ - Components: TechnicalBlueprint+DiagramComponents { get; set; }
+ - ctor(
+     _actor: SequenceDiagramActor,
+     _root: MethodInfo,
+     _finishOn: List<Type>,
+     _footer: string? [Nullable],
+     Components: TechnicalBlueprint+DiagramComponents
+   )
+ - GenerateDiagramContent() : StringBuilder
+ - GenerateDiagramUrl() : string
+