Tirsvad
0b0a3b419a
- Review records RC-022 to RC-030 are Accepted - The documents they review are set to Accepted (previous rows Deprecated) - RC-028 and RC-029: Go-with-conditions becomes Go; the two action items are closed - OC-001, SD-001 and DCD-001 carry a note that the UC-002 documents supersede the startProjectCreation signature
3.8 KiB
3.8 KiB
Sequence Diagram
Metadata
| Key | Value |
|---|---|
| ID | SD-002 |
| CrossReference | OC-002, DCD-003, DICT-001 |
Version History
| Date | Status | Author | Reviewer | Change | Commit |
|---|---|---|---|---|---|
| 2026-10-07 | Deprecated | Jens Tirsvad Nielsen | S02 | Initial version | 1cd27f7 |
| 2026-10-07 | Accepted | Jens Tirsvad Nielsen | S02 | Default configuration files: --config and --env, else ./config.env and ./.env in the working folder, else the checkout's | 0ab5006 |
Design objects are conceptual; in create-project.sh each becomes a small function group. DCD-003 gives each object its class and turns each message below into a method signature. ProjectCreator and ConfigLoader are the design objects of SD-001.
Sequence: startFromWorkingFolder
Realizes: startFromWorkingFolder in OC-002
Diagram
@startuml
actor Maintainer
participant ":Launcher" as L
participant ":ProjectCreator" as PC
participant ":Checkout" as CK
participant ":WorkingFolder" as WF
participant ":ConfigFiles" as CF
Maintainer -> L : startFromWorkingFolder(configPath, envPath)
activate L
L -> L : resolveCheckout(invocation)
create CK
L -> CK : Checkout(path)
L -> L : currentFolder()
create WF
L -> WF : WorkingFolder(path)
L -> L : locateConfigFiles(configPath, envPath, checkout, workingFolder)
create CF
L -> CF : ConfigFiles(configFile, envFile)
alt a chosen file is in the working folder
L -> Maintainer : confirm the files and the Gitea address
Maintainer --> L : yes or no
end
alt the Checkout's own files, or both places for a config file, are not found
L --> Maintainer : error naming the folder looked in
end
L -> PC : startProjectCreation(workingFolder, configFiles)
activate PC
alt a value in config.env or .env is malformed
PC --> L : error naming the key
end
PC --> L : promptSet
deactivate PC
L --> Maintainer : promptSet
deactivate L
@enduml
Pattern Annotations
| Pattern (GRASP / GoF) | Applied to | Rationale |
|---|---|---|
| Information Expert | Launcher.resolveCheckout, Launcher.locateConfigFiles |
The launcher knows how the script was invoked, so it is the one that can follow the command link |
| Controller | Launcher |
One object takes the system operation and hands the work to ProjectCreator; ProjectCreator stays unaware of links |
| Low Coupling | ProjectCreator receives workingFolder and configFiles as values |
The use case [UC-001] runs unchanged whatever way the script was started |
Postcondition Coverage
| Postcondition (from contract) | Satisfied by message |
|---|---|
| P1 Run | startFromWorkingFolder (the run starts with it) |
| P2 Checkout | resolveCheckout(invocation) and the creation of Checkout |
| P3 WorkingFolder | currentFolder() and the creation of WorkingFolder |
| P4 default directory under the WorkingFolder | startProjectCreation(workingFolder, configFiles); the prompt default is built from workingFolder |
| P5 ConfigFiles | locateConfigFiles(...) and the creation of ConfigFiles; the paths are named before any request |
| P6 Configuration | startProjectCreation(workingFolder, configFiles) loads the two files (load of SD-001) |
| P7 PromptSet | the returned promptSet |
| Exceptions: files not found, not confirmed, or malformed | the alt fragments |
Responsibility Check
Launcher only finds the checkout, the working folder and the two files; it reads no configuration and makes no repository. ProjectCreator keeps every other responsibility of SD-001.