rinkplanner/docs/refactor-whiteboard-controller.md

95 lines
4 KiB
Markdown
Raw Normal View History

# WhiteboardController zerlegen
Stand: 2026-11-13
Ziel: Der Controller war mit **9.092 Zeilen und 465 Funktionen** der größte
Baustein im Projekt; die Roadmap nennt < 1.500 Zeilen pro Datei. Nach den
Etappen 1 und 2 sind es 8.839 Zeilen. Diese Notiz
hält die Reihenfolge fest, damit der Umbau in Etappen mit grüner Suite
passiert und nicht als Big Bang.
## Grundregeln
1. **Erst reine Logik, dann UI.** Textaufbau, Formatierung und Prüf-Logik
lassen sich ohne Szene testen und sind risikofrei zu verschieben. Dialoge
und Signale kommen zuletzt.
2. **Eine Etappe = ein Commit mit grüner Suite.** Keine Etappe ändert
Verhalten; die Tests bleiben unverändert, nur Aufrufstellen wandern.
3. **Kein Big Bang.** Der Controller bleibt Node und Scene-Einstiegspunkt.
Ausgelagert werden Aufgaben, nicht die Klasse.
4. **Zustand bleibt beim Controller.** `_routine`, `_current_path`, Auswahl
und Historie gehören weiter dorthin; ausgelagerte Bausteine bekommen die
Daten übergeben, statt sie zu besitzen.
## Zielbausteine
| Baustein | Inhalt | Zeilen (grob) | Kopplung | Etappe |
| :--- | :--- | ---: | :--- | :--- |
| `HelpContent` | Hilfetext für den ?-Dialog | 137 | keine | 1 ✅ |
| `SeasonComparisonText` | Zeilen für den Saisonvergleichs-Dialog | 175 | nur Daten | 2 ✅ |
| `ValidationReportView` | Zeilen für den Prüfdialog | ~350 | nur Daten | 3 |
| `ExportService` | PDF/SVG/PNG schreiben, Abschlussdialog-Daten | ~250 | Dateisystem | 4 |
| `SeasonPanel` | Saison-/Programm-/Kategorieauswahl und Regelnachführung | ~250 | Statusleiste | 5 |
| `SyncPanel` | Dropbox-Sync, Konflikte, Küren verwalten | ~900 | Dialoge, Threads | 6 |
| `HubPanel` | Kür-Hub (Login, Upload, Downloads) | ~650 | Dialoge, Threads | 7 |
| `PlaybackPanel` | Wiedergabe, Musik, Timeline-Labels | ~600 | Canvas, Audio | 8 |
| `ElementInspector` | Element-Dialog, Features, Level, Kombinationen | ~800 | Dialog, Regeln | 9 |
Danach bleibt ein Controller von grob 2.000–2.500 Zeilen: Verdrahtung,
Auswahl, Werkzeuge, Abschnitte, Undo/Redo, Statuszeile.
## Etappen
### 1. `HelpContent` ✅
Der Hilfetext ist ein reiner String. Verschoben nach
`src/whiteboard/view/help_content.gd` (`HelpContent.build()`), der Controller
setzt ihn nur noch in den Dialog. Kein Verhalten geändert.
### 2. `SeasonComparisonText` ✅
Der Text des Saisonvergleichs (Kopf, Gruppen, Summe, Befunde) liegt jetzt in
`src/whiteboard/view/season_comparison_text.gd`. `build(routine, report)`
gibt die BBCode-Zeilen zurück; der Controller setzt sie nur noch in das
Label. Kein Verhalten geändert.
### 3. `ValidationReportView`
Derselbe Schnitt für den Prüfdialog: Kopf, Saisonhinweis, Kategorie,
Basiswert, Punktschätzung, Prüfliste und Befunde. Weil dort Anzeige-Optionen
(„Was ist enthalten?", „Annahmen ändern") mit hineinspielen, bekommt die
Klasse einen kleinen Kontext (Dictionary) statt vieler Einzelparameter.
Fertig, wenn der Controller nur noch `validation_text.text = ...` setzt und
der Dialog unverändert aussieht (Whiteboard-Test grün, keine neuen
Typfehler).
### 4. `ExportService`
Schreiben der Dateien, Pfadbildung und der Abschluss-Dialog bekommen einen
eigenen Baustein; der Controller reicht Kür, Format und Abschnitt durch.
### 5. `SeasonPanel`
Saison-, Programm- und Kategorieauswahl samt Regelnachführung
(`_apply_rules_for_season`, `_sync_season_option`, `set_season`, …). Danach
kennt nur noch dieser Baustein `RulesLibrary` und `RulesPackage`.
### 6–8. Sync, Hub, Playback
Die drei Thread-/Dialog-Cluster. Sie hängen an Signalen und Fenstern; hier
lohnt es, die Bausteine als eigene Nodes mit Signalen zu schneiden, statt als
RefCounted mit Rückruf.
### 9. `ElementInspector`
Zuletzt: Element-Dialog, Feature-Auswahl, Fußzuordnung, Levelableitung. Der
größte UI-Block und der, an dem am meisten hängt.
## Was bewusst bleibt
- `_ready()` und die Signalverdrahtung der Szene.
- Undo/Redo und die Historie (arbeiten auf dem gesamten Kürzustand).
- Die Statuszeile als Zusammenfassung (`_update_status`), solange Panels sie
nicht selbst besitzen.