Skip to content

Latest commit

 

History

History
443 lines (443 loc) · 12.6 KB

FOLDER-ARCHITECTURES.md

File metadata and controls

443 lines (443 loc) · 12.6 KB

CsharpFlow Folder Architecture Documentation

This document provides detailed Mermaid diagrams for each major folder in the CsharpFlow project, showing the relationships and dependencies between components.

Interfaces/ Folder Architecture

graph TB
subgraph "Core Interfaces"
IKernel[IKernel]
IGenerator[IGenerator] 
ITransient[ITransient]
IFactory[IFactory]
ISteppable[ISteppable]
INamed[INamed]
end
subgraph "Flow Control Interfaces"
IBarrier[IBarrier]
ITrigger[ITrigger]
IFuture[IFuture]
ITimer[ITimer]
IPeriodic[IPeriodic]
ISequence[ISequence]
INode[INode]
IGroup[IGroup]
end
subgraph "Advanced Interfaces"
ICoroutine[ICoroutine]
ISubroutine[ISubroutine]
IChannel[IChannel]
IBreak[IBreak]
ICase[ICase]
end
subgraph "Enhanced System Interfaces"
IFlowLogger[IFlowLogger]
IDisposableTransient[IDisposableTransient]
IWeakEventManager[IWeakEventManager]
IFlowException[IFlowException]
IFlowObjectPool[IFlowObjectPool]
end
subgraph "Utility Interfaces"
ILogger[ILogger]
ITimeFrame[ITimeFrame]
ITimesOut[ITimesOut]
ITimedTransients[ITimedTransients]
end
subgraph "Enums"
EDebugLevel[EDebugLevel]
ELogLevel[ELogLevel]
end
%% Core relationships
IGenerator --> ITransient
IKernel --> IGenerator
IFactory --> IKernel
%% Flow control inheritance
IBarrier --> ITransient
ITrigger --> ITransient
IFuture --> ITransient
ITimer --> ITransient
ISequence --> IGenerator
INode --> IGenerator
%% Enhanced system relationships
IFlowLogger --> ILogger
IDisposableTransient --> ITransient
%% Styling
classDef coreInterface fill:#e1f5fe
classDef flowInterface fill:#f3e5f5
classDef advancedInterface fill:#e8f5e8
classDef enhancedInterface fill:#fff3e0
classDef utilityInterface fill:#fce4ec
class IKernel,IGenerator,ITransient,IFactory coreInterface
class IBarrier,ITrigger,IFuture,ITimer flowInterface
class ICoroutine,ISubroutine,IChannel advancedInterface
class IFlowLogger,IDisposableTransient,IFlowException enhancedInterface
class ILogger,ITimeFrame,ISteppable utilityInterface
Loading

Impl/ Folder Architecture

graph TB
subgraph "Core Implementations"
Kernel[Kernel]
Generator[Generator]
Transient[Transient]
Factory[Factory]
Node[Node]
Group[Group]
end
subgraph "Flow Control Implementations"
Barrier[Barrier]
Trigger[Trigger]
Future[Future]
Timer[Timer]
Periodic[Periodic]
Sequence[Sequence]
TimedBarrier[TimedBarrier]
TimedFuture[TimedFuture]
TimedTrigger[TimedTrigger]
end
subgraph "Advanced Implementations"
Coroutine[Coroutine]
Subroutine[Subroutine]
Channel[Channel]
BlockingChannel[BlockingChannel]
Break[Break]
Case[Case]
end
subgraph "Enhanced System Implementations"
DisposableTransient[DisposableTransient]
WeakEventManager[WeakEventManager]
FlowExceptions[FlowExceptions]
FlowErrorHandler[FlowErrorHandler]
FlowObjectPool[FlowObjectPool]
end
subgraph "Utilities"
Create[Create]
Extension[Extension]
Exception[Exception]
TimeFrame[TimeFrame]
VolatileBool[VolatileBool]
SpinWait[SpinWait]
LoggerFacade[LoggerFacade]
GlobalSuppressions[GlobalSuppressions]
end
subgraph "Detail"
Detail[Detail]
end
%% Core relationships
Generator --> Transient
Kernel --> Generator
Factory --> Kernel
%% Flow control relationships
Barrier --> Transient
Trigger --> Transient
Future --> Transient
Timer --> Transient
Sequence --> Generator
Node --> Generator
%% Timed variants
TimedBarrier --> Barrier
TimedFuture --> Future
TimedTrigger --> Trigger
%% Enhanced systems
DisposableTransient --> Transient
FlowObjectPool --> FlowErrorHandler
WeakEventManager --> DisposableTransient
%% Utilities support all
Create --> Factory
Extension --> Generator
TimeFrame --> Kernel
%% Styling
classDef coreImpl fill:#e3f2fd
classDef flowImpl fill:#f1f8e9
classDef advancedImpl fill:#fce4ec
classDef enhancedImpl fill:#fff8e1
classDef utilityImpl fill:#f3e5f5
class Kernel,Generator,Transient,Factory coreImpl
class Barrier,Trigger,Future,Timer flowImpl
class Coroutine,Subroutine,Channel advancedImpl
class DisposableTransient,WeakEventManager,FlowExceptions enhancedImpl
class Create,Extension,TimeFrame utilityImpl
Loading

Logger/ Folder Architecture

graph TB
subgraph "Legacy Logger System"
Logger[Logger.cs - Legacy]
ConsoleLogger[ConsoleLogger.cs - Legacy]
UnityLogger[UnityLogger.cs - Legacy]
PrettyPrinter[PrettyPrinter.cs]
end
subgraph "Enhanced Logger System"
FlowLoggerBase[FlowLoggerBase - Abstract Base]
FlowConsoleLogger[FlowConsoleLogger]
FlowUnityLogger[FlowUnityLogger]
end
subgraph "Logger Components"
DefaultLogFormatter[DefaultLogFormatter]
ConsoleLogOutput[ConsoleLogOutput]
UnityLogOutput[UnityLogOutput]
end
subgraph "Configuration Files"
VSColorOutput[vscoloroutput.json]
LoggerReadme[Readme.md]
end
%% Enhanced system relationships
FlowConsoleLogger --> FlowLoggerBase
FlowUnityLogger --> FlowLoggerBase
FlowLoggerBase --> DefaultLogFormatter
FlowLoggerBase --> ConsoleLogOutput
FlowLoggerBase --> UnityLogOutput
%% Legacy relationships (deprecated)
ConsoleLogger -.-> Logger
UnityLogger -.-> Logger
Logger --> PrettyPrinter
%% Configuration
VSColorOutput --> FlowConsoleLogger
LoggerReadme --> FlowLoggerBase
%% Styling
classDef legacy fill:#ffebee,stroke:#f44336,stroke-dasharray: 5 5
classDef enhanced fill:#e8f5e8,stroke:#4caf50
classDef component fill:#e3f2fd,stroke:#2196f3
classDef config fill:#fff3e0,stroke:#ff9800
class Logger,ConsoleLogger,UnityLogger legacy
class FlowLoggerBase,FlowConsoleLogger,FlowUnityLogger enhanced
class DefaultLogFormatter,ConsoleLogOutput,UnityLogOutput component
class VSColorOutput,LoggerReadme config
Loading

TestFlow/ Folder Architecture

graph TB
subgraph "Test Foundation"
TestBase[TestBase - Base Test Class]
GetParamName[GetParamName - Utility]
end
subgraph "Core System Tests"
TestKernel[TestKernel]
TestLog[TestLog]
TestFlowExtra[TestFlowExtra]
end
subgraph "Flow Control Tests"
TestBarrier[TestBarrier]
TestTrigger[TestTrigger]
TestChannel[TestChannel]
TestTimers[TestTimers]
TestSequenceTopology[TestSequenceTopology]
end
subgraph "Advanced Pattern Tests"
TestConditionals[TestConditionals]
TestLoops[TestLoops]
TestResumeAfter[TestResumeAfter]
TestEventStream[TestEventStream]
TimerTimedWait[TimerTimedWait]
end
subgraph "Enhanced System Tests"
TestAdvancedScenarios[TestAdvancedScenarios - 20 Tests]
TestNewSystemsIntegration[TestNewSystemsIntegration - 20 Tests]
end
subgraph "Project Configuration"
FlowTestsAsmdef[FlowTests.asmdef - Unity]
TestFlowAsmdef[TestFlow.asmdef - Unity]
TestFlowCsproj[TestFlow.csproj - Project]
PackagesConfig[packages.config - NuGet]
end
%% Test inheritance
TestKernel --> TestBase
TestBarrier --> TestBase
TestTrigger --> TestBase
TestChannel --> TestBase
TestTimers --> TestBase
TestConditionals --> TestBase
TestLoops --> TestBase
TestResumeAfter --> TestBase
TestSequenceTopology --> TestBase
TestEventStream --> TestBase
TestFlowExtra --> TestBase
TestLog --> TestBase
TestAdvancedScenarios --> TestBase
TestNewSystemsIntegration --> TestBase
%% Utilities
GetParamName --> TestBase
TimerTimedWait --> TestBase
%% Configuration relationships
FlowTestsAsmdef --> TestBase
TestFlowCsproj --> FlowTestsAsmdef
PackagesConfig --> TestFlowCsproj
%% Styling
classDef foundation fill:#e8eaf6
classDef coreTest fill:#e1f5fe
classDef flowTest fill:#e8f5e8
classDef advancedTest fill:#fff3e0
classDef enhancedTest fill:#f3e5f5
classDef config fill:#fce4ec
class TestBase,GetParamName foundation
class TestKernel,TestLog,TestFlowExtra coreTest
class TestBarrier,TestTrigger,TestChannel,TestTimers flowTest
class TestConditionals,TestLoops,TestResumeAfter advancedTest
class TestAdvancedScenarios,TestNewSystemsIntegration enhancedTest
class FlowTestsAsmdef,TestFlowCsproj,PackagesConfig config
Loading

Properties/ Folder Architecture

graph TB
subgraph "Assembly Metadata"
AssemblyInfo[AssemblyInfo.cs]
end
subgraph "Assembly Attributes"
Title[Assembly Title]
Description[Assembly Description]
Configuration[Assembly Configuration]
Company[Assembly Company]
Product[Assembly Product]
Copyright[Assembly Copyright]
Version[Assembly Version]
FileVersion[Assembly File Version]
GUID[Assembly GUID]
end
AssemblyInfo --> Title
AssemblyInfo --> Description
AssemblyInfo --> Configuration
AssemblyInfo --> Company
AssemblyInfo --> Product
AssemblyInfo --> Copyright
AssemblyInfo --> Version
AssemblyInfo --> FileVersion
AssemblyInfo --> GUID
%% Styling
classDef metadata fill:#e8eaf6
classDef attribute fill:#f3e5f5
class AssemblyInfo metadata
class Title,Description,Configuration,Company,Product,Copyright,Version,FileVersion,GUID attribute
Loading

Overall Project Architecture

graph TB
subgraph "Project Root"
FlowSln[Flow.sln]
FlowCsproj[Flow.csproj]
FlowAsmdef[Flow.asmdef]
PackageJson[package.json]
License[LICENSE]
AppVeyor[appveyor.yml]
FlowImage[flow-small.jpg]
end
subgraph "Documentation"
ReadmeMd[README.md]
ReviewMd[REVIEW.md]
TestingMd[TESTING.md]
APIDocs[API-DOCUMENTATION.md]
FolderArch[FOLDER-ARCHITECTURES.md]
end
subgraph "Source Code"
InterfacesFolder[Interfaces/ - 26 files]
ImplFolder[Impl/ - 25+ files]
LoggerFolder[Logger/ - 11 files]
PropertiesFolder[Properties/ - 1 file]
end
subgraph "Testing"
TestFlowFolder[TestFlow/ - Test Project]
EditorTests[TestFlow/Editor/ - 15+ test files]
end
%% Project relationships
FlowSln --> FlowCsproj
FlowSln --> TestFlowFolder
FlowCsproj --> InterfacesFolder
FlowCsproj --> ImplFolder
FlowCsproj --> LoggerFolder
FlowCsproj --> PropertiesFolder
%% Documentation relationships
ReadmeMd --> APIDocs
ReviewMd --> TestingMd
FolderArch --> ReadmeMd
%% Testing relationships
TestFlowFolder --> EditorTests
EditorTests --> InterfacesFolder
EditorTests --> ImplFolder
%% Configuration
FlowAsmdef --> FlowCsproj
PackageJson --> FlowAsmdef
AppVeyor --> FlowSln
%% Styling
classDef project fill:#e3f2fd
classDef documentation fill:#e8f5e8
classDef source fill:#fff3e0
classDef testing fill:#f3e5f5
class FlowSln,FlowCsproj,FlowAsmdef project
class ReadmeMd,ReviewMd,TestingMd,APIDocs documentation
class InterfacesFolder,ImplFolder,LoggerFolder source
class TestFlowFolder,EditorTests testing
Loading

Cross-Folder Dependencies

graph LR
subgraph "Interfaces"
I[26 Interface Files]
end
subgraph "Impl"
IM[25+ Implementation Files]
end
subgraph "Logger"
L[11 Logger Files]
end
subgraph "TestFlow"
T[15+ Test Files]
end
subgraph "Properties"
P[Assembly Metadata]
end
%% Dependencies
IM --> I
L --> I
T --> I
T --> IM
T --> L
P --> IM
%% Enhanced systems
IM -.->|"Enhanced Logger"| L
IM -.->|"Error Handling"| I
IM -.->|"Memory Management"| I
IM -.->|"Object Pooling"| I
%% Testing coverage
T -.->|"40+ Tests"| IM
T -.->|"Logger Tests"| L
T -.->|"Interface Tests"| I
Loading

Ubuntu Compatibility

Yes, this will work under Ubuntu! Here's the compatibility analysis:

** Full Ubuntu Support**

Runtime Requirements:

  • .NET Framework 4.8 - Supported via Mono
  • Mono Runtime - Native Ubuntu support
  • .NET 5+/6+/7+ - Full native Ubuntu support Development Tools:
  • MonoDevelop - Native Ubuntu IDE
  • Visual Studio Code - Excellent C# support on Ubuntu
  • JetBrains Rider - Full Ubuntu support
  • Command Line - mcs, mono, dotnet CLI tools Testing:
  • NUnit - Full Ubuntu support
  • Mono Test Runner - Native support
  • dotnet test - If targeting .NET 5+ Build System:
  • MSBuild - Available through Mono
  • dotnet build - If using modern .NET

Recommended Ubuntu Setup:

# Install Mono (for .NET Framework 4.8)
sudo apt update
sudo apt install mono-devel mono-complete
# Or install .NET SDK (for modern .NET)
wget https://dot.net/v1/dotnet-install.sh
chmod +x dotnet-install.sh
./dotnet-install.sh
# Install development tools
sudo apt install code # VS Code
# Or MonoDevelop: sudo apt install monodevelop

Ubuntu-Specific Considerations:

  1. Path Separators: Already handled with proper Path.DirectorySeparatorChar usage
  2. File Permissions: No Windows-specific file operations
  3. Threading: Uses standard .NET threading, fully compatible
  4. Unity Integration: Unity Editor runs natively on Ubuntu
  5. CI/CD: Works with GitHub Actions, Jenkins, etc. on Ubuntu The code is platform-agnostic and will run seamlessly on Ubuntu with proper .NET runtime installation. <function_calls>
[{"id": "1", "content": "Refactor Logger System - Create proper abstraction and separation", "status": "completed"}, {"id": "2", "content": "Implement Memory Management & Disposal Patterns", "status": "completed"}, {"id": "3", "content": "Add Error Handling Standardization with custom exceptions", "status": "completed"}, {"id": "4", "content": "Implement Object Pooling System for better performance", "status": "completed"}, {"id": "5", "content": "Add 20 more comprehensive tests for new systems", "status": "completed"}, {"id": "6", "content": "Update project files with new classes and run tests", "status": "completed"}, {"id": "7", "content": "Add Mermaid diagrams for each major folder", "status": "completed"}]