Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 1 commit into from
Mar 16, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions C4InterFlow.Automation/C4InterFlow.Automation.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
32 changes: 32 additions & 0 deletions C4InterFlow.Automation/Readers/JObjectStructuresResolver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ public JObjectStructuresResolver()
public JObjectStructuresResolver(JObject rootJObject)
{
RootJObject = rootJObject;
CompletePartialUseFlowExpressions();
}

public T? GetInstance<T>(string? alias) where T : Structure
Expand Down Expand Up @@ -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>();
Expand Down
2 changes: 1 addition & 1 deletion C4InterFlow.Cli/C4InterFlow.Cli.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion C4InterFlow.Cli/CLI Commands.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
2 changes: 1 addition & 1 deletion C4InterFlow.Cli/Properties/launchSettings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
Expand Down
4 changes: 2 additions & 2 deletions C4InterFlow/C4InterFlow.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
10 changes: 5 additions & 5 deletions Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Basket Service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {}
Expand Down
12 changes: 6 additions & 6 deletions ...s/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Buying And Merchandising App.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
26 changes: 13 additions & 13 deletions Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Buying Service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {}
Expand All @@ -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
4 changes: 2 additions & 2 deletions Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/CRM App.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
16 changes: 8 additions & 8 deletions Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Fraud Service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {}
Expand All @@ -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
12 changes: 6 additions & 6 deletions Samples/E-Commerce Platform/Yaml/Architecture/SoftwareSystems/Fulfilment Service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {}
Expand All @@ -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
Loading