groove/Part-DB-server
1
0
Fork 0
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2026-01-14 06:09:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Add trait dependency documentation and architecture diagrams

Browse source 
Co-authored-by: jbtronics <5410681+jbtronics@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot] 2026-01-02 23:51:52 +00:00
parent 30537fcb6c
commit 2d36373bea
3 changed files with 52 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

42
ENTITY_REFACTORING.md
View file

@ -4,6 +4,48 @@
This refactoring decomposes the deep entity inheritance hierarchy into a more flexible trait-based architecture. This provides better code reusability, composition, and maintainability.
## Architecture Diagram
### Before (Deep Inheritance):
```
AbstractDBElement (ID logic)
└─ AbstractNamedDBElement (name + timestamps)
└─ AttachmentContainingDBElement (attachments)
└─ AbstractStructuralDBElement (tree/hierarchy + parameters)
├─ AbstractPartsContainingDBElement
│ ├─ Category
│ ├─ Footprint
│ ├─ StorageLocation
│ └─ AbstractCompany (company fields)
│ ├─ Manufacturer
│ └─ Supplier
```
### After (Trait Composition):
```
Traits: Interfaces:
- DBElementTrait - DBElementInterface
- NamedElementTrait - NamedElementInterface
- TimestampTrait - TimeStampableInterface
- AttachmentsTrait - HasAttachmentsInterface
- MasterAttachmentTrait - HasMasterAttachmentInterface
- StructuralElementTrait - StructuralElementInterface
- ParametersTrait - HasParametersInterface
- CompanyTrait - CompanyInterface
Class Hierarchy (now uses traits):
AbstractDBElement (uses DBElementTrait, implements DBElementInterface)
└─ AbstractNamedDBElement (uses NamedElementTrait + TimestampTrait)
└─ AttachmentContainingDBElement (uses AttachmentsTrait + MasterAttachmentTrait)
└─ AbstractStructuralDBElement (uses StructuralElementTrait + ParametersTrait)
├─ AbstractPartsContainingDBElement
│ ├─ Category (gets all traits via inheritance)
│ ├─ Footprint (gets all traits via inheritance)
│ └─ AbstractCompany (uses CompanyTrait)
│ ├─ Manufacturer
│ └─ Supplier
```
## Changes Made
### New Traits Created