Plan MIL-007 and UC-002; AGPL-3.0 default only for a public GitHub project

- MIL-006: the AGPL-3.0 default needs GitHub and a public project - MIL-007: fetch the framework's own submodules (qc); start through a command link; README usage - UC-002 with SSD, DM, OC, SD and DCD; US-001.07 and US-002 - Reconcile the project DM, DCD, dictionary, use case diagram and traceability matrix - Review records RC-022 to RC-028
2026-10-07 12:30:58 +08:00
parent 5b66eff809
commit 1cd27f77ed
29 changed files with 1143 additions and 85 deletions
@@ -0,0 +1,87 @@
+# Design Class Diagram
+
+## Metadata
+| Key | Value |
+| --- | --- |
+| ID | DCD-003 |
+| CrossReference | [DM-003], [SD-002], [DICT-001], [UC-002], [DCD-001] |
+
+## Version History
+| Date | Status | Author | Reviewer | Change | Commit |
+| --- | --- | --- | --- | --- | --- |
+| 2026-10-07 | Proposed | Jens Tirsvad Nielsen | S02 | Initial version | pending |
+
+---
+
+## Purpose and Scope
+
+Covers [UC-002]. Adds the classes that start the script through a command link. `ProjectCreator`, `Configuration` and `Run` are the classes of [DCD-001] and change only as stated under Method Traceability. The consolidated diagram is [DCD-002].
+
+## Diagram
+
+```plantuml
+@startuml
+class Launcher {
+  +resolveCheckout(invocation : Path) : Checkout
+  +currentFolder() : WorkingFolder
+  +startFromWorkingFolder(configPath : Path [0..1], envPath : Path [0..1]) : PromptSet
+}
+class Checkout {
+  -path : Path
+  +configFile() : Path
+  +envFile() : Path
+}
+class WorkingFolder {
+  -path : Path
+}
+class ProjectCreator {
+  +startProjectCreation(checkout : Checkout, workingFolder : WorkingFolder, configPath : Path [0..1], envPath : Path [0..1]) : PromptSet
+}
+class Run
+Launcher "1" --> "1" ProjectCreator : starts
+Launcher ..> Checkout : creates
+Launcher ..> WorkingFolder : creates
+Run "1" *-- "1" Checkout
+Run "1" *-- "1" WorkingFolder
+@enduml
+```
+
+## Class Table
+
+| Class | Refines (Domain Model concept) | Responsibility | Attributes | Operations |
+| --- | --- | --- | --- | --- |
+| `Launcher` | Command Link (the object that follows it) | Follows the command link to the checkout, takes the folder the Maintainer stands in, and starts the run. | none | `resolveCheckout`, `currentFolder`, `startFromWorkingFolder` |
+| `Checkout` | Checkout | Names the folder that holds the script's own files and the default `config.env` and `.env`. | `path` | `configFile`, `envFile` |
+| `WorkingFolder` | Working Folder | Names the base of the default directory of the new project. | `path` | none |
+
+The concept Command Link has no class: it is a link the Maintainer makes with the shell, and the system only follows it.
+
+## Method Traceability
+
+| Method signature | Operation Contract / SD message |
+| --- | --- |
+| `Launcher.startFromWorkingFolder(configPath, envPath) : PromptSet` | [SD-002] `startFromWorkingFolder`; P1, P6 |
+| `Launcher.resolveCheckout(invocation) : Checkout` | [SD-002] `resolveCheckout(invocation)`; P2 |
+| `Launcher.currentFolder() : WorkingFolder` | [SD-002] `currentFolder()`; P3 |
+| `Checkout.configFile() : Path`, `Checkout.envFile() : Path` | [SD-002] `startProjectCreation`; P5 |
+| `ProjectCreator.startProjectCreation(checkout, workingFolder, configPath, envPath) : PromptSet` | [SD-002] `startProjectCreation`; P4, P5, P6. Replaces the signature of [DCD-001] by adding `checkout`, `workingFolder`, `configPath` and `envPath` |
+
+## Pattern Annotations
+
+| Pattern | Classes | Rationale |
+| --- | --- | --- |
+| Controller | `Launcher` | One class takes the system operation of [UC-002] |
+| Information Expert | `Launcher`, `Checkout` | The launcher knows the invocation; the checkout knows where its files are |
+
+## Dependency Check
+
+`Launcher` depends on `ProjectCreator`, `Checkout` and `WorkingFolder`; none of them depends on `Launcher`, so no cycle is added.
+
+---
+
+[DM-003]: ./dm.md
+[SD-002]: ./sd.md
+[DICT-001]: ../dictionary.md
+[UC-002]: ./uc.md
+[DCD-001]: ../uc-001/dcd.md
+[DCD-002]: ../dcd.md