Added support for partial Interface Aliases in Use Flows of YAML AaC (#…

…65)
SlavaVedernikov · Mar 16, 2024 · fdf5e06 · fdf5e06
2 parents fcc757a + 7739ca2
commit fdf5e06
Show file tree

Hide file tree

Showing 20 changed files with 144 additions and 112 deletions.
diff --git a/C4InterFlow.Automation/C4InterFlow.Automation.csproj b/C4InterFlow.Automation/C4InterFlow.Automation.csproj
@@ -7,12 +7,12 @@
 		<Deterministic>true</Deterministic>
 		<IncludeSymbols>true</IncludeSymbols>
 		<SymbolPackageFormat>snupkg</SymbolPackageFormat>
-		<Version>0.37.0</Version>
+		<Version>0.38.0</Version>
 	</PropertyGroup>
 
 	<PropertyGroup>
 		<PackageId>C4InterFlow.Automation</PackageId>
-		<PackageVersion>0.37.0</PackageVersion>
+		<PackageVersion>0.38.0</PackageVersion>
 		<Authors>Slava Vedernikov</Authors>
 		<Description>Revolutionise your Application Architecture Documentation with C4InterFlow. Designed for Architects and Engineers, this tool leverages the widely-recognised C4 Model (Architecture Visualisation framework), enhanced with unique features like Interface and Flow, to describe your Application Architecture as Code. Experience an intuitive, efficient way to document complex systems, ensuring clarity and consistency across your teams and products.</Description>
 		<Copyright>Copyright 2024 Slava Vedernikov</Copyright>

diff --git a/C4InterFlow.Automation/Readers/JObjectStructuresResolver.cs b/C4InterFlow.Automation/Readers/JObjectStructuresResolver.cs
@@ -19,6 +19,7 @@ public JObjectStructuresResolver()
         public JObjectStructuresResolver(JObject rootJObject)
         {
             RootJObject = rootJObject;
+            CompletePartialUseFlowExpressions();
         }
 
         public T? GetInstance<T>(string? alias) where T : Structure
@@ -234,6 +235,37 @@ public IEnumerable<T> GetNestedInstances<T>(string? alias) where T : Structure
             return result;
         }
 
+        public void CompletePartialUseFlowExpressions()
+        {
+            var interfaces = RootJObject.SelectTokens("..Interfaces.*");
+
+            foreach (var @interface in interfaces)
+            {
+                var useFlows = @interface.SelectTokens("..[?(@.Type=='Use')]");
+
+                foreach (var useFlow in useFlows)
+                {
+                    var usesInterfaceAlias = useFlow["Expression"].ToString();
+                    var usesInterface = RootJObject.SelectToken(usesInterfaceAlias);
+
+                    if (usesInterface == null)
+                    {
+                        var parent = @interface;
+                        do
+                        {
+                            parent = parent.Parent;
+                            usesInterface = parent.SelectToken(usesInterfaceAlias);
+                        } while (usesInterface == null && parent.Parent != null);
+
+                        if(usesInterface != null)
+                        {
+                            useFlow["Expression"] = usesInterface.Path;
+                        }
+                    }
+                }
+            }
+        }
+
         public void Validate(out IEnumerable<string> errors)
         {
             var errorsInternal = new List<string>();

diff --git a/C4InterFlow.Cli/C4InterFlow.Cli.csproj b/C4InterFlow.Cli/C4InterFlow.Cli.csproj
@@ -5,7 +5,7 @@
     <TargetFramework>net6.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
-    <Version>0.37.0</Version>
+    <Version>0.38.0</Version>
     <PublishSingleFile>true</PublishSingleFile>
     <SelfContained>true</SelfContained>
     <RuntimeIdentifier>win-x64</RuntimeIdentifier>

diff --git a/C4InterFlow.Cli/CLI Commands.txt b/C4InterFlow.Cli/CLI Commands.txt
@@ -2,4 +2,4 @@ execute-aac-strategy --aac-root-namespace "BigBankPlc" --aac-output-path "Archit
 
 draw-diagrams --aac-input-paths "C:\C4InterFlow\Samples\Internet Banking System\CSV\Architecture\Yaml" --aac-reader-strategy "C4InterFlow.Automation.Readers.YamlAaCReaderStrategy,C4InterFlow.Automation" --interfaces BigBankPlc.SoftwareSystems.*.Containers.*.Interfaces.* --business-processes BigBankPlc.BusinessProcesses.* --levels-of-details context container --output-dir "C:\C4InterFlow\Samples\Internet Banking System\CSV\Diagrams"
 
-draw-diagrams --aac-input-paths "C:\C4InterFlow\Samples\E-Commerce Platform\Yaml\Architecture" --aac-reader-strategy "C4InterFlow.Automation.Readers.YamlAaCReaderStrategy,C4InterFlow.Automation" --interfaces ECommercePlatform.SoftwareSystems.*.Containers.*.Interfaces.* --output-dir "C:\C4InterFlow\Samples\E-Commerce Platform\Yaml\Diagrams"
+draw-diagrams --aac-input-paths "C:\C4InterFlow\Samples\E-Commerce Platform\Yaml\Architecture" --aac-reader-strategy "C4InterFlow.Automation.Readers.YamlAaCReaderStrategy,C4InterFlow.Automation" --interfaces ECommercePlatform.SoftwareSystems.*.Interfaces.* ECommercePlatform.SoftwareSystems.*.Containers.*.Interfaces.* --levels-of-details context container --output-dir "C:\C4InterFlow\Samples\E-Commerce Platform\Yaml\Diagrams"
diff --git a/C4InterFlow.Cli/Properties/launchSettings.json b/C4InterFlow.Cli/Properties/launchSettings.json
@@ -2,7 +2,7 @@
   "profiles": {
     "C4InterFlow.Cli": {
       "commandName": "Project",
-      "commandLineArgs": "draw-diagrams --aac-input-paths \"C:\\C4InterFlow\\Samples\\Internet Banking System\\CSV\\Architecture\\Yaml\" --aac-reader-strategy \"C4InterFlow.Automation.Readers.YamlAaCReaderStrategy,C4InterFlow.Automation\" --interfaces BigBankPlc.SoftwareSystems.*.Containers.*.Interfaces.* --business-processes BigBankPlc.BusinessProcesses.* --levels-of-details context container --output-dir \"C:\\C4InterFlow\\Samples\\Internet Banking System\\CSV\\Diagrams\"\r\n",
+      "commandLineArgs": "draw-diagrams --aac-input-paths \"C:\\C4InterFlow\\Samples\\E-Commerce Platform\\Yaml\\Architecture\" --aac-reader-strategy \"C4InterFlow.Automation.Readers.YamlAaCReaderStrategy,C4InterFlow.Automation\" --interfaces ECommercePlatform.SoftwareSystems.*.Interfaces.* ECommercePlatform.SoftwareSystems.*.Containers.*.Interfaces.* --levels-of-details context container --output-dir \"C:\\C4InterFlow\\Samples\\E-Commerce Platform\\Yaml\\Diagrams\"",
       "workingDirectory": "C:\\C4InterFlow\\Samples\\Internet Banking System\\CSV"
     }
   }

diff --git a/C4InterFlow/C4InterFlow.csproj b/C4InterFlow/C4InterFlow.csproj
@@ -7,12 +7,12 @@
 		<Deterministic>true</Deterministic>
 		<IncludeSymbols>true</IncludeSymbols>
 		<SymbolPackageFormat>snupkg</SymbolPackageFormat>
-		<Version>0.37.0</Version>
+		<Version>0.38.0</Version>
 	</PropertyGroup>
 
 	<PropertyGroup>
 		<PackageId>C4InterFlow</PackageId>
-		<PackageVersion>0.37.0</PackageVersion>
+		<PackageVersion>0.38.0</PackageVersion>
 		<Authors>Slava Vedernikov</Authors>
     <Description>Revolutionise your Application Architecture Documentation with C4InterFlow. Designed for Architects and Engineers, this tool leverages the widely-recognised C4 Model (Architecture Visualisation framework), enhanced with unique features like Interface and Flow, to describe your Application Architecture as Code. Experience an intuitive, efficient way to document complex systems, ensuring clarity and consistency across your teams and products.</Description>
 		<Copyright>Copyright 2024 Slava Vedernikov</Copyright>

diff --git a/Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Basket Service.yaml b/Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Basket Service.yaml
@@ -8,27 +8,27 @@ ECommercePlatform:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BasketService.Containers.Database.Interfaces.SelectItems
+                  Expression: Database.Interfaces.SelectItems
             AddItem:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BasketService.Containers.Database.Interfaces.InsertItem
+                  Expression: Database.Interfaces.InsertItem
             UpdateItem:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BasketService.Containers.Database.Interfaces.UpdateItem
+                  Expression: Database.Interfaces.UpdateItem
             DeleteItem:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BasketService.Containers.Database.Interfaces.DeleteItem
+                  Expression: Database.Interfaces.DeleteItem
             DeleteBasket:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BasketService.Containers.Database.Interfaces.DeleteBasket
+                  Expression: Database.Interfaces.DeleteBasket
         Database:
           Interfaces:
             InsertItem: {}

diff --git a/...s/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Buying And Merchandising App.yaml b/...s/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Buying And Merchandising App.yaml
@@ -6,29 +6,29 @@ ECommercePlatform:
           Flow:
             Flows:
             - Type: Use
-              Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Api.Interfaces.GetPurchaseOrders
+              Expression: BuyingService.Containers.Api.Interfaces.GetPurchaseOrders
         CreatePurchaseOrder:
           Flow:
             Flows:
             - Type: Use
-              Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Api.Interfaces.CreatePurchaseOrder
+              Expression: BuyingService.Containers.Api.Interfaces.CreatePurchaseOrder
         UpdatePurchaseOrder:
           Flow:
             Flows:
             - Type: Use
-              Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Api.Interfaces.UpdatePurchaseOrder
+              Expression: BuyingService.Containers.Api.Interfaces.UpdatePurchaseOrder
         DeletePurchaseOrder:
           Flow:
             Flows:
             - Type: Use
-              Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Api.Interfaces.DeletePurchaseOrder
+              Expression: BuyingService.Containers.Api.Interfaces.DeletePurchaseOrder
         ViewProductPrices:
           Flow:
             Flows:
             - Type: Use
-              Expression: ECommercePlatform.SoftwareSystems.PricingService.Containers.Api.Interfaces.GetProductPrices
+              Expression: PricingService.Containers.Api.Interfaces.GetProductPrices
         UpdateProductPrices:
           Flow:
             Flows:
             - Type: Use
-              Expression: ECommercePlatform.SoftwareSystems.PricingService.Containers.Api.Interfaces.UpdateProductPrices
+              Expression: PricingService.Containers.Api.Interfaces.UpdateProductPrices
diff --git a/Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Buying Service.yaml b/Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Buying Service.yaml
@@ -8,28 +8,28 @@ ECommercePlatform:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Database.Interfaces.SelectPurchaseOrder
+                  Expression: Database.Interfaces.SelectPurchaseOrder
             CreatePurchaseOrder:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Database.Interfaces.InsertPurchaseOrder
+                  Expression: Database.Interfaces.InsertPurchaseOrder
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Messaging.Interfaces.SendPurchaseOrderCreatedEvent
+                  Expression: Messaging.Interfaces.SendPurchaseOrderCreatedEvent
             UpdatePurchaseOrder:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Database.Interfaces.UpdatePurchaseOrder
+                  Expression: Database.Interfaces.UpdatePurchaseOrder
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Messaging.Interfaces.SendPurchaseOrderUpdatedEvent
+                  Expression: Messaging.Interfaces.SendPurchaseOrderUpdatedEvent
             DeletePurchaseOrder:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Database.Interfaces.DeletePurchaseOrder
+                  Expression: Database.Interfaces.DeletePurchaseOrder
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Messaging.Interfaces.SendPurchaseOrderDeletedEvent
+                  Expression: Messaging.Interfaces.SendPurchaseOrderDeletedEvent
         Database:
           Interfaces:
             InsertPurchaseOrder: {}
@@ -50,20 +50,20 @@ ECommercePlatform:
              Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Messaging.Interfaces.ReceivePurchaseOrderCreatedEvent
+                  Expression: Messaging.Interfaces.ReceivePurchaseOrderCreatedEvent
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.WMS.Interfaces.CreatePurchaseOrder
+                  Expression: WMS.Interfaces.CreatePurchaseOrder
             HandlePurchaseOrderUpdatedEvent:
              Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Messaging.Interfaces.ReceivePurchaseOrderUpdatedEvent
+                  Expression: Messaging.Interfaces.ReceivePurchaseOrderUpdatedEvent
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.WMS.Interfaces.UpdatePurchaseOrder
+                  Expression: WMS.Interfaces.UpdatePurchaseOrder
             HandlePurchaseOrderDeletedEvent:
              Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.BuyingService.Containers.Messaging.Interfaces.ReceivePurchaseOrderDeletedEvent
+                  Expression: Messaging.Interfaces.ReceivePurchaseOrderDeletedEvent
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.WMS.Interfaces.DeletePurchaseOrder
+                  Expression: WMS.Interfaces.DeletePurchaseOrder
diff --git a/Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/CRM App.yaml b/Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/CRM App.yaml
@@ -6,9 +6,9 @@ ECommercePlatform:
           Flow:
             Flows:
             - Type: Use
-              Expression: ECommercePlatform.SoftwareSystems.FraudService.Containers.Api.Interfaces.GetHighRiskOrders
+              Expression: FraudService.Containers.Api.Interfaces.GetHighRiskOrders
         UpdateOrderFraudCheckResult:
           Flow:
             Flows:
             - Type: Use
-              Expression: ECommercePlatform.SoftwareSystems.FraudService.Containers.Api.Interfaces.UpdateOrderFraudCheckResult
+              Expression: FraudService.Containers.Api.Interfaces.UpdateOrderFraudCheckResult
diff --git a/Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Fraud Service.yaml b/Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Fraud Service.yaml
@@ -8,14 +8,14 @@ ECommercePlatform:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.FraudService.Containers.Database.Interfaces.SelectHighRiskOrders
+                  Expression: Database.Interfaces.SelectHighRiskOrders
             UpdateOrderFraudCheckResult:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.FraudService.Containers.Database.Interfaces.UpdateFraudCheckResult
+                  Expression: Database.Interfaces.UpdateFraudCheckResult
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.FraudService.Containers.Messaging.Interfaces.SendFraudCheckResultEvent
+                  Expression: Messaging.Interfaces.SendFraudCheckResultEvent
         Database:
           Interfaces:
             InsertOrder: {}
@@ -32,12 +32,12 @@ ECommercePlatform:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.OrderService.Containers.Messaging.Interfaces.ReceiveOrderCreatedEvent
+                  Expression: OrderService.Containers.Messaging.Interfaces.ReceiveOrderCreatedEvent
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.FraudService.Containers.Database.Interfaces.InsertOrder
+                  Expression: Database.Interfaces.InsertOrder
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.FraudEngine.Interfaces.GetFraudCheckResult
+                  Expression: FraudEngine.Interfaces.GetFraudCheckResult
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.FraudService.Containers.Database.Interfaces.InsertFraudCheckResult
+                  Expression: Database.Interfaces.InsertFraudCheckResult
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.FraudService.Containers.Messaging.Interfaces.SendFraudCheckResultEvent
+                  Expression: Messaging.Interfaces.SendFraudCheckResultEvent
diff --git a/Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Fulfilment Service.yaml b/Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Fulfilment Service.yaml
@@ -8,9 +8,9 @@ ECommercePlatform:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.FulfilmentService.Containers.Database.Interfaces.UpdateOrderStatus
+                  Expression: Database.Interfaces.UpdateOrderStatus
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.FulfilmentService.Containers.Messaging.Interfaces.SendOrderShippedEvent
+                  Expression: Messaging.Interfaces.SendOrderShippedEvent
         Database:
           Interfaces:
             InsertOrder: {}
@@ -25,13 +25,13 @@ ECommercePlatform:
               Flow:
                 Flows:
                 - Type: Use
-                  Expression: ECommercePlatform.SoftwareSystems.OrderService.Containers.Messaging.Interfaces.ReceiveOrderStatusChangedEvent
+                  Expression: OrderService.Containers.Messaging.Interfaces.ReceiveOrderStatusChangedEvent
                 - Type: If
                   Expression: Order Status is 'Pending Shipment'
                   Flows:
                   - Type: Use
-                    Expression: ECommercePlatform.SoftwareSystems.FulfilmentService.Containers.Database.Interfaces.InsertOrder
+                    Expression: Database.Interfaces.InsertOrder
                   - Type: Use
-                    Expression: ECommercePlatform.SoftwareSystems.WMS.Interfaces.ShipOrder
+                    Expression: WMS.Interfaces.ShipOrder
                   - Type: Use
-                    Expression: ECommercePlatform.SoftwareSystems.FulfilmentService.Containers.Database.Interfaces.UpdateOrderStatus
+                    Expression: Database.Interfaces.UpdateOrderStatus