#24: Moved Architecture Diagrams classes into dedicated folders

synergy-software · May 21, 2023 · 07893de · 07893de
1 parent 15be833
commit 07893de
Show file tree

Hide file tree

Showing 12 changed files with 50 additions and 70 deletions.
diff --git a/Architecture/Synergy.Architecture.Diagrams/Api/ApiDescription.cs b/Architecture/Synergy.Architecture.Diagrams/Api/ApiDescription.cs
@@ -4,12 +4,13 @@
 using System.Runtime.InteropServices;
 using System.Text;
 using JetBrains.Annotations;
+using Synergy.Architecture.Diagrams.Extensions;
 
 namespace Synergy.Architecture.Diagrams.Api
 {
     // TODO: Marcin Celej [from: Marcin Celej on: 08-04-2023]: remove this class from here - check what it is used for
 
-    public static class ApiDescription
+    internal static class ApiDescription
     {
         static readonly BindingFlags bindingFlags = BindingFlags.FlattenHierarchy | BindingFlags.Instance | BindingFlags.Static | BindingFlags.Public;
 

diff --git a/...chitecture.Diagrams/TechnicalBlueprint.cs → ...grams/Documentation/TechnicalBlueprint.cs b/...chitecture.Diagrams/TechnicalBlueprint.cs → ...grams/Documentation/TechnicalBlueprint.cs
@@ -2,7 +2,7 @@
 using Synergy.Architecture.Diagrams.Sequence;
 using Synergy.Contracts;
 
-namespace Synergy.Architecture.Diagrams;
+namespace Synergy.Architecture.Diagrams.Documentation;
 
 public class TechnicalBlueprint
 {

diff --git a/...itecture.Diagrams/ReflectionExtensions.cs → ...agrams/Extensions/ReflectionExtensions.cs b/...itecture.Diagrams/ReflectionExtensions.cs → ...agrams/Extensions/ReflectionExtensions.cs
@@ -1,6 +1,6 @@
 using System.Reflection;
 
-namespace Synergy.Architecture.Diagrams;
+namespace Synergy.Architecture.Diagrams.Extensions;
 
 internal static class ReflectionExtensions
 {
@@ -23,7 +23,7 @@ public static bool IsAssignableTo(this Type type, string assignableType)
 
     public static Attribute? GetCustomAttribute(this Type type, string attributeType)
         => type.GetCustomAttributes().FirstOrDefault(a => a.GetType().IsAssignableTo(attributeType));
-    
+
     public static Attribute? GetCustomAttribute(this MethodInfo method, string attributeType)
         => method.GetCustomAttributes().FirstOrDefault(a => a.GetType().IsAssignableTo(attributeType));
 

diff --git a/Architecture/Synergy.Architecture.Diagrams/Sequence/SequenceDiagram.cs b/Architecture/Synergy.Architecture.Diagrams/Sequence/SequenceDiagram.cs
@@ -3,6 +3,7 @@
 using System.Text;
 using Synergy.Architecture.Annotations.Diagrams.Sequence;
 using Synergy.Architecture.Diagrams.Api;
+using Synergy.Architecture.Diagrams.Documentation;
 using Synergy.Contracts;
 using Synergy.Reflection;
 

diff --git a/Architecture/Synergy.Architecture.Diagrams/Sequence/SequenceDiagramUrl.cs b/Architecture/Synergy.Architecture.Diagrams/Sequence/SequenceDiagramUrl.cs
@@ -4,6 +4,8 @@
 using PlantUml.Net;
 using Synergy.Architecture.Annotations.Diagrams.Sequence;
 using Synergy.Architecture.Diagrams.Api;
+using Synergy.Architecture.Diagrams.Documentation;
+using Synergy.Architecture.Diagrams.Extensions;
 using Synergy.Contracts;
 using Synergy.Reflection;
 

diff --git a/Architecture/Synergy.Architecture.Diagrams/Synergy.Architecture.Diagrams.csproj b/Architecture/Synergy.Architecture.Diagrams/Synergy.Architecture.Diagrams.csproj
@@ -22,12 +22,6 @@
       <ProjectReference Include="..\Synergy.Architecture.Annotations\Synergy.Architecture.Annotations.csproj" />
     </ItemGroup>
 
-    <ItemGroup>
-      <Compile Include="..\..\Reflection\Synergy.Reflection\CustomAttributeExtensions.cs">
-        <Link>CustomAttributeExtensions.cs</Link>
-      </Compile>
-    </ItemGroup>
-
     <ItemGroup>
       <PackageReference Include="PlantUml.Net" Version="1.4.80" />
     </ItemGroup>
@@ -37,4 +31,10 @@
         <None Include="license.txt" Pack="true" PackagePath="" />
     </ItemGroup>
 
+    <ItemGroup>
+      <Compile Include="..\..\Reflection\Synergy.Reflection\CustomAttributeExtensions.cs">
+        <Link>Extensions\CustomAttributeExtensions.cs</Link>
+      </Compile>
+    </ItemGroup>
+
 </Project>
diff --git a/...e/Synergy.Architecture.Tests/Architecture/Debt/Todos.Technical.Debt.verified.md b/...e/Synergy.Architecture.Tests/Architecture/Debt/Todos.Technical.Debt.verified.md
@@ -1,9 +1,6 @@
 # Technical Debt for Synergy.Contracts
 
-Total: 3
-
-## [SequenceDiagramActivationAttribute.cs](../../../Synergy.Architecture.Annotations/Diagrams/Sequence/SequenceDiagramActivationAttribute.cs)
-- TODO: Marcin Celej [from: Marcin Celej on: 08-04-2023]: Add optional attributes when compilation constant CODE_ANALYSIS (or other) is present
+Total: 2
 
 ## [ApiDescription.cs](../../../Synergy.Architecture.Diagrams/Api/ApiDescription.cs)
 - TODO: Marcin Celej [from: Marcin Celej on: 08-04-2023]: remove this class from here - check what it is used for

diff --git a/Architecture/Synergy.Architecture.Tests/Architecture/Public/Api.cs b/Architecture/Synergy.Architecture.Tests/Architecture/Public/Api.cs
@@ -1,5 +1,6 @@
 using Synergy.Architecture.Annotations.Diagrams.Sequence;
 using Synergy.Architecture.Diagrams;
+using Synergy.Architecture.Diagrams.Documentation;
 using Synergy.Documentation.Api;
 
 namespace Synergy.Architecture.Tests.Architecture.Public;

diff --git a/...ture.Tests/Architecture/Public/Api.of.Synergy.Architecture.Diagrams.verified.md b/...ture.Tests/Architecture/Public/Api.of.Synergy.Architecture.Diagrams.verified.md
@@ -11,32 +11,6 @@
      type: Type
    ) : TAttribute[] [Extension]
 
-## TechnicalBlueprint (class)
- - ctor()
- - Add(
-     diagram: params SequenceDiagram[] [ParamArray]
-   ) : TechnicalBlueprint
- - Add(
-     diagram: IEnumerable<SequenceDiagram>
-   ) : TechnicalBlueprint
- - Intro(
-     markdown: string
-   ) : TechnicalBlueprint
- - Register<TComponent, TImplementation>() : TechnicalBlueprint [NullableContext]
- - Register(
-     interface: Type,
-     services: IServiceProvider
-   ) : TechnicalBlueprint
- - Register(
-     interface: Type,
-     implementation: Type
-   ) : TechnicalBlueprint
- - Render() : string
- - TechnicalBlueprint.Titled(
-     title: string
-   ) : TechnicalBlueprint
- - ToString() : string
-
 ## Sequence.SequenceDiagram (record) : IEquatable<SequenceDiagram>
  - Actor: SequenceDiagramActor [Nullable] { get; set; }
  - Components: TechnicalBlueprint+DiagramComponents? { get; set; }
@@ -110,30 +84,33 @@
  - GenerateDiagramContent() : StringBuilder
  - GenerateDiagramUrl() : string
 
-## Api.ApiDescription (abstract class)
- - ApiDescription.For(
-     method: MethodInfo,
-     withAttributes: bool [Optional]
-   ) : string
- - ApiDescription.GenerateFor(
-     assembly: Assembly
-   ) : string
- - ApiDescription.GenerateFor(
-     types: IEnumerable<Type>,
-     description: StringBuilder? [Nullable, Optional],
-     assemblyName: string? [Nullable, Optional]
-   ) : string
- - ApiDescription.GetTypeName(
-     method: MethodInfo
-   ) : string
- - ApiDescription.GetTypeName(
-     parameter: ParameterInfo
-   ) : string
- - ApiDescription.GetTypeName(
-     type: Type
-   ) : string
+## Documentation.TechnicalBlueprint (class)
+ - ctor()
+ - Add(
+     diagram: params SequenceDiagram[] [ParamArray]
+   ) : TechnicalBlueprint
+ - Add(
+     diagram: IEnumerable<SequenceDiagram>
+   ) : TechnicalBlueprint
+ - Intro(
+     markdown: string
+   ) : TechnicalBlueprint
+ - Register<TComponent, TImplementation>() : TechnicalBlueprint [NullableContext]
+ - Register(
+     interface: Type,
+     services: IServiceProvider
+   ) : TechnicalBlueprint
+ - Register(
+     interface: Type,
+     implementation: Type
+   ) : TechnicalBlueprint
+ - Render() : string
+ - TechnicalBlueprint.Titled(
+     title: string
+   ) : TechnicalBlueprint
+ - ToString() : string
 
-## TechnicalBlueprint+DiagramComponents (class)
+## Documentation.TechnicalBlueprint+DiagramComponents (class)
  - ctor()
  - Register<TComponent, TImplementation>() : void [NullableContext]
  - Register(

diff --git a/Reflection/Synergy.Reflection/CustomAttributeExtensions.cs b/Reflection/Synergy.Reflection/CustomAttributeExtensions.cs
@@ -127,9 +127,9 @@ private static T[] GetInheritedAttributes<T>([NotNull] IEnumerable<object> allAt
             Fail.IfArgumentNull(allAttributes, nameof(allAttributes));
 
             T[] attributes = allAttributes
-                .Where(a => a is T)
-                .Cast<T>()
-                .ToArray();
+                             .Where(a => a is T)
+                             .Cast<T>()
+                             .ToArray();
 
             Fail.IfCollectionContainsNull(attributes, $"Attributes collection on {name}");
 

diff --git a/Web/Sample/Synergy.Sample.Web.API.Tests/Architecture/Diagrams.cs b/Web/Sample/Synergy.Sample.Web.API.Tests/Architecture/Diagrams.cs
@@ -2,6 +2,7 @@
 using System.IO;
 using System.Threading.Tasks;
 using Synergy.Architecture.Diagrams;
+using Synergy.Architecture.Diagrams.Documentation;
 using Synergy.Architecture.Diagrams.Sequence;
 using Synergy.Documentation.Code;
 using Synergy.Sample.Web.API.Controllers;

diff --git a/Web/Sample/Synergy.Sample.Web.API.Tests/Users/Users.md b/Web/Sample/Synergy.Sample.Web.API.Tests/Users/Users.md
@@ -95,7 +95,7 @@ Content-Length: 129
 
 ### 2.2. Get created user pointed by "Location" header (1 request)
 
-### 2.2.2. Request to [Get user located at http://localhost/api/v1/users/42dcb695c2c241b6aef90281aa2cf9d7]
+### 2.2.2. Request to [Get user located at http://localhost/api/v1/users/e1efd892e55746e7a9199de1493ebd42]
 
 - Request
 ```
@@ -137,7 +137,7 @@ Content-Length: 129
 
 ### 3.1. Get user by id (1 request)
 
-### 3.1.1. Request to [Get user with id "42dcb695c2c241b6aef90281aa2cf9d7"]
+### 3.1.1. Request to [Get user with id "e1efd892e55746e7a9199de1493ebd42"]
 
 - Request
 ```
@@ -391,7 +391,7 @@ Content-Length: 351
 
 ### 6.1. Delete user by id (1 request)
 
-### 6.1.1. Request to [Delete user with id "42dcb695c2c241b6aef90281aa2cf9d7"]
+### 6.1.1. Request to [Delete user with id "e1efd892e55746e7a9199de1493ebd42"]
 
 - Request
 ```
@@ -418,7 +418,7 @@ Content-Length: 2
 
 ### 6.2. Try to get the deleted user (1 request)
 
-### 6.2.2. Request to [Get user with id "42dcb695c2c241b6aef90281aa2cf9d7"]
+### 6.2.2. Request to [Get user with id "e1efd892e55746e7a9199de1493ebd42"]
 
 - Request
 ```