Remove Dom prefix from domain models: rename classes to reflect business terminology, update references in tests, repositories, and services; add ADR for new naming conventions.
This commit is contained in:
@@ -0,0 +1,57 @@
|
||||
---
|
||||
type: ADR
|
||||
status: ACCEPTED
|
||||
date: 2026-04-08
|
||||
deciders: Lead Architect, Backend Developer
|
||||
---
|
||||
|
||||
# ADR-0023: Naming Convention für Domain-Entitäten (kein `Dom`-Präfix)
|
||||
|
||||
## Status
|
||||
|
||||
**ACCEPTED** – Umgesetzt in Session 2026-04-08 (Phase 1 & 2 Domain Clean-Up).
|
||||
|
||||
## Kontext
|
||||
|
||||
In der frühen Entwicklungsphase wurden Domain-Klassen mit dem Präfix `Dom` versehen
|
||||
(z.B. `DomBewerb`, `DomVeranstaltung`, `DomTurnier`), um sie von DTOs und Datenbank-Entitäten
|
||||
zu unterscheiden. Diese Konvention hat sich als unnötig und verwirrend erwiesen, da sie
|
||||
gegen die Prinzipien der **Ubiquitous Language** (DDD) und der **Clean Architecture** verstößt.
|
||||
|
||||
## Entscheidung
|
||||
|
||||
**Domain-Entitäten tragen ab sofort ihren fachlichen Namen ohne Präfix.**
|
||||
|
||||
| Schicht | Namenskonvention | Beispiel |
|
||||
|-----------------|-------------------------|-----------------------|
|
||||
| **Domain** | `<FachlicheName>` | `Bewerb` |
|
||||
| **Datenbank** | `<FachlicheName>Table` | `BewerbTable` |
|
||||
| **Persistence** | `<FachlicheName>Entity` | `BewerbEntity` |
|
||||
| **API/Transfer**| `<FachlicheName>Dto` | `BewerbDto` |
|
||||
|
||||
## Durchgeführte Umbenennungen (Phase 1)
|
||||
|
||||
| Alt (Dom-Präfix) | Neu (Clean Name) | Modul |
|
||||
|-----------------------|---------------------|-----------------|
|
||||
| `DomBewerb` | `Bewerb` | entries-domain |
|
||||
| `DomAbteilung` | `Abteilung` | entries-domain |
|
||||
| `DomNennung` | `Nennung` | entries-domain |
|
||||
| `DomNennungsTransfer` | `NennungsTransfer` | entries-domain |
|
||||
| `DomTurnier` | `Turnier` | events-domain |
|
||||
| `DomAusschreibung` | `Ausschreibung` | events-domain |
|
||||
| `DomVeranstaltung` | `Veranstaltung` | events-domain (bereits vorhanden, Duplikat gelöscht) |
|
||||
|
||||
## Konsequenzen
|
||||
|
||||
- **Positiv:** Ubiquitous Language im Code – Fachexperten und Entwickler sprechen dieselbe Sprache.
|
||||
- **Positiv:** Weniger kognitive Last – kein mentales Mapping zwischen `DomBewerb` und `Bewerb`.
|
||||
- **Positiv:** Entspricht Clean Architecture – die Domain-Schicht ist die "reine" Schicht.
|
||||
- **Negativ:** Einmalige Umbenennung erfordert Anpassung aller Referenzen (wurde systemweit durchgeführt).
|
||||
- **Achtung:** Datenbank-Migrationen (Flyway) und Repository-Mappings werden in Phase 3 separat behandelt.
|
||||
|
||||
## Coding Guideline (verbindlich ab sofort)
|
||||
|
||||
> **Neue Domain-Klassen werden NIEMALS mit `Dom`, `Model`, `Entity` oder ähnlichen
|
||||
> technischen Präfixen/Suffixen versehen. Der fachliche Name ist der Klassenname.**
|
||||
>
|
||||
> Ausnahmen: Datenbank-Klassen (`...Table`, `...Entity`) und Transfer-Objekte (`...Dto`, `...Request`, `...Response`).
|
||||
@@ -53,6 +53,7 @@ Veranstalter (OEPS-Mitgliedsverein)
|
||||
| Die ÖTO definiert sparten- und klassenabhängige Schwellenwerte, ab wievielen Startern eine Abteilung **verpflichtend** getrennt werden muss. Bei Überschreitung gibt das System eine **WARNUNG** (kein harter Fehler) – der TBA hat das letzte Wort (→ *Override-Event*). Vollständige Schwellenwert-Tabellen: → [`Abteilungs-Trennungs-Schwellenwerte.md`](../02_Reference/OETO_Regelwerk/Abteilungs-Trennungs-Schwellenwerte.md) | ÖTO § 2 Abs. 7, § 39 | |
|
||||
| **Akteur** | Historischer Begriff (siehe → *Stammdaten*). Oberbegriff für alle Personen (Reiter, Richter, Funktionäre, Besitzer) und Organisationen (Vereine), die im System interagieren. | – |
|
||||
| **Ausschreibung** | Das offizielle Dokument, das alle Bedingungen eines Turniers festlegt. Pflichtfelder gemäß ÖTO (A-Satz der ZNS-Schnittstelle). | ÖTO Ausschreibungs-Struktur |
|
||||
| **Austragungsplatz** | Physischer Ort (Platz, Arena, Halle) innerhalb einer Veranstaltung, auf dem Bewerbe stattfinden. Typ: `"Austragungsplatz"` (Wettkampf) oder `"Vorbereitungsplatz"` (Einreiten). Kann einer Sparte zugeordnet sein. Im Code als Entität **`Austragungsplatz`** (events-domain) abgebildet. | – |
|
||||
|
||||
### B
|
||||
|
||||
@@ -131,7 +132,8 @@ Veranstalter (OEPS-Mitgliedsverein)
|
||||
### R
|
||||
|
||||
| Begriff | Definition | ÖTO-Referenz |
|
||||
|--------------------|------------------------------------------------------------------------------------------------------------------------------|--------------|
|
||||
|--------------------|------------------------------------------------------------------------------------------------------------------------------|--------------|
|
||||
| **RichterEinsatz** | Value Object, das den Einsatz eines Funktionärs (Richter, Aufsicht) in einem Bewerb beschreibt. Felder: `funktionaerId` (Referenz auf Funktionär) und `position` (z.B. `"C"`, `"M"`, `"B"`, `"Aufsicht"`). Im Code als **`RichterEinsatz`** (entries-domain) abgebildet. | ÖTO Funktionärs-Qualifikation |
|
||||
| **Richtverfahren** | Das Bewertungsverfahren eines Bewerbs (z.B. § 204/4 Stilspringen, § 218 Einlauf). Bestimmt, wie Ergebnisse berechnet werden. | ÖTO B-Teil |
|
||||
|
||||
### S
|
||||
@@ -153,6 +155,7 @@ Veranstalter (OEPS-Mitgliedsverein)
|
||||
| Begriff | Definition | ÖTO-Referenz |
|
||||
|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|
|
||||
| **TBA** | Turnierbeauftragter. Hat bei Regelkonflikten immer das letzte Wort. Jede Überschreibung wird als → *Override-Event* gespeichert. | ÖTO § 24/§ 25 |
|
||||
| **TurnierArtikel** | Abrechenbare Leistung oder Produkt im Rahmen einer Veranstaltung (z.B. Ansage, Heu, Startgeld). Preis in Cent (Long). Typ: `"AUTOMATISCH"` (systemseitig erzeugt) oder `"MANUELL"` (manuell erfasst). Im Code als Entität **`TurnierArtikel`** (events-domain, Billing Context) abgebildet. | Billing Context |
|
||||
| **Tierwohl-Euro** | Gebühr, die **pro Start** anfällt (nicht pro Nennung!). | ÖTO Gebührenordnung |
|
||||
| **Turnier** | In unserer Software: Eine pferdesportliche Veranstaltung mit einer offiziellen **Ausschreibung** und einer vom OEPS/LFV vergebenen, eindeutigen **Turniernummer**. Entspricht ÖTO § 2 Abs. 2. Ist eine Spezialisierung von → *Veranstaltung*. | ÖTO § 2 Abs. 2, § 5, § 24 |
|
||||
| **Turniernummer** | Offizielle, vom OEPS vergebene **5-stellige** Kennung eines Turniers (z.B. `26128`). Sie ist eindeutig und Voraussetzung für die offizielle Ausschreibung. | ÖTO § 3, ZNS A-Satz |
|
||||
|
||||
Reference in New Issue
Block a user