Compare commits

Author SHA1 Message Date
Technoir 179ec1206b update
zeilenlänge, LEerzeilen und verweis auf docs hinzugefügt
2026-10-19 16:04:24 +02:00
Technoir e22cd8c650 zeilenlänge und so angepasst weil nvim heult 2026-10-19 16:03:20 +02:00
Technoir bb60da6aaa leerzeieln weil nvim heult 2026-10-19 16:03:06 +02:00
Technoir af46c19651 updated 2026-10-19 15:16:21 +02:00
Technoir ea6a330fab datenmodell-archtiektur doc hinzugefügt 2026-10-19 14:18:39 +02:00
Technoir 27ebe17be5 datenmodell 2026-10-19 13:44:11 +02:00
Technoir 84bf7b9129 nutzungshinweis hinzugefügt 2026-10-19 11:55:34 +02:00
Technoir d9d511ae29 update 2026-10-19 11:30:15 +02:00
Technoir e5dbf649f8 weitere Doku 2026-10-19 11:29:43 +02:00
Technoir 1bbff06760 newLine 2026-10-19 11:27:55 +02:00
Technoir 8e3c6b8c36 beispiele für Items und Kategorien hinzugefügt 2026-10-19 11:25:47 +02:00
Technoir 57c541bbb7 readme 2026-10-19 11:19:08 +02:00
Technoir d5389af958 api doc 2026-10-19 11:19:00 +02:00
Technoir ad4a9d12d5 fehlermeldungen zu deutsch geändert
da #29 nicht mehr erfüllt werden kann
2026-10-19 10:21:04 +02:00
Technoir 3abf47e2ea abstand entfertn wegen hoverproblem 2026-10-19 09:40:18 +02:00
Technoir fb5052d43d click auf dropdown öffnet es (für mobile) 2026-10-19 09:40:08 +02:00
Technoir c0cbc5a49c Merge branch 'feature/31-GET-Endpoints', fixes #31 2026-10-19 09:08:53 +02:00
Technoir 16775b45ee imports 2026-10-19 09:08:37 +02:00
Technoir 0ac781114f getlist und lilsts im cotnroller implementiert 2026-10-17 17:44:28 +02:00
Technoir d373ecce2b getLists überabreitet 2026-10-17 17:44:16 +02:00
Technoir ea8ebf79b2 ListDTO Mapper implementiert 2026-10-17 17:44:11 +02:00
Technoir 966705ec90 vorherige GetDTOs von List zusammengeführt 2026-10-17 17:43:58 +02:00
Technoir 4bbc1b73d5 falsche reihenfolge gefixt 2026-10-17 17:43:29 +02:00
Technoir 4f387d2b7f getItem implementiert 2026-10-17 17:43:21 +02:00
Technoir 1c1d3f6571 getCategory implementiert 2026-10-17 17:43:08 +02:00
Technoir 7db358721d category kann nach listen ID gefunden werden 2026-10-17 17:12:52 +02:00
Technoir c1bd997e33 implementierung getLists und getList 2026-10-17 17:12:38 +02:00
Technoir df20f8c426 Erstelen von item und category Service klassen
sieht besser aus
2026-10-17 17:12:30 +02:00
Technoir c0cddc3ef8 erstellen von getDTOs 2026-10-17 17:12:01 +02:00
Technoir e8d35385ca implementierung von Mappern
da wir sehr oft von Model zu DTO Mappen müssen, lohnt es sich eine
seperate Mapperklasse zu erstellen
2026-10-17 17:11:48 +02:00
Technoir d4b5382f70 DTO für /api/lists 2026-10-17 16:17:56 +02:00
26 changed files with 813 additions and 16 deletions

No files matched your search

+77
View File
@@ -0,0 +1,77 @@
# Einkaufsliste
Repository für das Webapp-Projekt, was eine Einkaufsliste zur Verfügung stellt.
Es ist möglich, mehrere Listen anzulegen. In einer Liste kann man
Gegenstände und Kategorien erstellen.
Gegenständen können, aber müssen nicht Kategorien gehören.
## Dokumentation
### Entwicklungsverlauf und User Stories
Dieses Projekt hat seine Dokumentation über Gitea vorgenommen.
Die Entwicklungshistorie ist über die Commitliste einsehbar,
User-Stories, Erweiterungen/Änderungen am Projekt und andere
Entwicklungsentscheidungen wurden über Issues abgewickelt.
Es wurden auch Meilensteine verwendet um die Issues zu organisieren.
Bugs und Fehler wurden nicht mit Issues dokumentiert, da
sie entweder während der Entwicklung auf einem anderen Branch beseitigt worden sind
(wenn der Fehler von der Entwicklung des Branches kam) oder spontan gefixt.
Die Commits, welche Bugs fixen sind mit `bug:` bzw. `bugfix:`
gekennzeichnet und in der Commit-Historie auffindbar.
## Architektur
Die Seite verfolgt einen hybriden Ansatz. Das Backend schickt dem Browser eine HTML-Datei,
welche in Teilen mit Attributen bei Custom Elementen und Daten befüllt sind.
Der Client rendert dann die Custom Elemente.
Die Webseite selbst ist so ziemlich im Frontend benutzbar.
Ein Neuladen der Seite ist nicht nötig, mit Ausnahme wenn man
zwischen Listen und der Listenübersicht wechselt.
### Backend
Für das Backend wurde Spring mit Thymeleaf für das Bereitstellen von Seiten genutzt (`src/main/java/de/timaldinger/einkaufsliste`).
Das Backend ist über eine RESTful-API ansprechbar. Die Datenbank ist H2.
### Frontend
Für das Frontend wurde Vanilla-JS und CSS benutzt.
Hinweis: Kategorien und Gegenstände können bearbeitet werden indem man auf sie drückt!
## API Übersicht
| Pfad | Zugelassene Methoden | Angesprochene Modelle |
| ----------------- | ------------------------ | --------------------- |
| `/api/lists` | GET, POST, DELETE, PATCH | Einkaufslisten |
| `/api/categories` | GET, POST, DELETE, PATCH | Kategorien |
| `/api/items` | GET, POST, DELETE, PATCH | Gegenstände |
Die vollständige API-Dokumentation befindet sich unter [`/docs/`](/docs/API.md)
## Aufsetzen
Auf der Maschine muss Java 25 und Maven installiert sein.
```
# Repo clonen
git clone https://gitea.von.timaldinger.de/Technoir/einkaufsliste-web.git
# Im Ordner
mvn spring-boot:run
```
Nun kann man im Browser `localhost:8080` aufrufen.
## Sonstiges
### Weitere Dokumentation
Weitere Dokumentation befindet sich unter [`/docs/`](/docs)
### Nutzung von KI
Es wurde Claude Code Opus 4.8 genutzt. Die KI wurde zum Debuggen,
bei scheinbar nicht erkennbaren Fehlern, großen Refactors und als Nachschlagewerk genutzt.
Konzept-, Architekturentscheidungen und Umsetzung des Projekts liegen an mir.
Vorschläge von KI wurden geprüft und bewusst übernommen oder verworfen.
+163
View File
@@ -0,0 +1,163 @@
# Datenmodell und Architektur
Das Projekt nutzt die Modelle `ShoppingList`, `ShoppingItem` und `ShoppingCategory`.
Neben den Spring und Thymeleaf Bibliotheken wurde noch zusätzlich lombok genutzt.
Lombok stellt Annotationen bereit um Boilerplatecode zu vermeiden.
## Diagramm
```mermaid
erDiagram
ShoppingList ||--o{ ShoppingCategory : hat
ShoppingList ||--o{ ShoppingItem : hat
ShoppingCategory ||--o{ ShoppingItem : enthält
```
## Modelle
### ShoppingList
Eine ShoppingList hat beliebige ShoppingCategory und ShoppingItem.
Der Name darf nicht leer sein.
### ShoppingCategory
Eine ShoppingCategory hat beliebige ShoppingItem.
Der Name darf nicht leer sein.
### ShoppingItem
Ein ShoppingItem hat sowohl einen Namen als auch eine Menge.
Der Nutzer hat und sollte die Freiheit haben,
die Felder so zu befüllen wie er will.
Es findet deshalb keine Eingabevalidierung in dem Sinne statt,
dass bei Menge nur Mengeneinheiten stehen dürfen oder im Namen keine Zahlen.
Die einzige Anforderung ist es, dass der Nutzer einen der beiden Felder
ausfüllen muss.
## Architektur Backend (`src/main/java/de/timaldinger/einkaufsliste/`)
### Controller (`Controller/`)
`PageController` ist zuständig für das Bereitstellen von den einzelnen Seiten.
Die restlichen Controller sind RESTController, welche die API-Schnittstelle
behandeln. Sie sind nach der betroffenen Ressource aufgeteilt.
### Data Transfer Objects (`Dto/`)
Die Webapp nutzt sogenannte DTOs (Data transfer objects)
um die geschickten JSON-Daten auf das Model abzubilden. Diese liegen unter `Dto/`.
Dort sind die DTOs nochmal nach den HTTP-Methoden aufgeteilt, da je nach Methode
der Nutzer unterschiedliche Daten mitschicken tut.
### Exceptions (`Exceptions/`)
Hier liegen benutzerdefinierte Fehlermeldungen, die an das Frontend geschickt werden
(hauptsächlich für 400 und 404)
und ein eigener Exception Handler `GlobalExceptionHandler.java`.
Dieser wurde erstellt damit Fehlermeldungen
besser dargestellt werden können und keine Spring-Fehlermeldungen an das Frontend
geschickt werden.
Er ist mit `@RestControllerAdvice` annotiert, das heißt,
dass er für alle anderen Controller gilt. Er greift, wenn ein Fehler von
einer Controllerklasse aus propagiert. Er implementiert Methoden annotiert
mit `@ExceptionHandler`, welche angibt, für welche Funktion ein geworfener Fehler
in einer Funktion des Controllers greift. Es werden in den Controllern die
Custom Exceptions geworfen.
Die CustomException-Klassen erben von `RuntimeException`.
Das Record `ErrorResponse.java` stellt einen JSON-Body dar um daraus die Fehlermeldung
zu bauen die an das Frontend geschickt wird.
### Mapper (`Mapper/`)
Klassen, welche die Models aus der Datenbank zu DTOs mappen. Nötig um GET
Anfragen zu nutzen.
### Models (`Models/`)
Unter `Models/` liegen die Modelle. Die Modelle werden in der Datenbank
so abgebildet wie sie in der Klasse definiert sind. Auch sind Relationen
der Entities wie sie in der Datenbank seien sollen abgebildet mit
Annotationen wie `@ManyToOne`. Es gibt eine abstrakte Klasse `ShoppingElement`,
von welcher alle anderen Entities erben. Die Klasse hat eine Variable `id`,
welche ihre Unterklassen dann auch haben.
### Repository (`Repository/`)
Interfaces, die das JpaRepositories-Interface implementieren. Das JPARep wurde genommen,
da man dort Bulkfunktionen wie `saveAll` und `findAll` nutzen kann,
Rückgabetypen wie `List` erlaubt sind und diese auch eine `h2`-db
Implementierung aufweist.
### Services (`Service/`)
Serviceklassen, welche Methoden für die Controller zur Verfügung stellen,
um die jeweile HTTP-Request erfüllen zu können. Sie kapseln die Logik von den Controllern.
### Templating (`src/main/resources/templates`)
Da die Webapp einen Hybridansatz beim Rendering verfolgt, wurden Thymeleaf-Templates
genutzt um die Seite beim Aufrufen bereitzustellen. Die `PageController` Klasse
stellt diese bereit.
## Architektur Frontend (`src/main/resources/static`)
Genutzt wurde Vanilla-JS und CSS. Das CSS liegt unter `static/css` und das JS unter `static/js`.
Jede aufrufbare Seite (`/` und `/list`) hat seinen eigenen Ordner, wo für die Seite
spezifische JS Dateien liegen. Hier finden sich zwei Unterordner: `api/` und `frontend/`.
Unter jenen Ordner befinden sich Funktionen die jeweils API und UI abwickeln.
Die `.js` Datei die in dem Ordnerroot liegt, nutzt und bündelt diese.
Die Trennung wurde getätigt um bessere Übersicht und
sauberere Entwicklung zu ermöglichen.
Unter `shared/` liegen Dateien, die von alle Seiten
genutzt werden. Unter Models liegen die Implementierungen der CustomHTML-Elemente.
### Custom Elemente (`/static/js/models`)
Im Laufe der Entwicklung wurden CustomHTML Elemente genommen, um die ShoppingList,
ShoppingCategory und ShoppingItems darzustellen und besser zu handhaben. Es wurde
sich für ein LightDOM Ansatz entschieden, da zum einen die Eventpropagation einfacher
zu gestalten ist (EventListener auf `div`) und zum anderen die CSS Klassen greifen.
Mit einem Shadow-DOM Ansatz mit zB `templates` wäre das umständlicher.
### Index Seite (`/static/js/pages/index`)
Hier liegen nötige Javascriptdateien für die Root Seite `/`.
Unter `/api` liegen die API Methoden, unter `/frontend` UI Methoden
### List Seite (`static/js/pages/list`)
Hier liegen nötige Javascriptdateien für die Seite `/list/{id}`.
Unter `/api` liegen die API Methoden, unter `/frontend` UI Methoden.
Da die Seite sowohl Kategorien als auch Gegenstände
behandelt sind in den Ordnern jeweils API und UI Dateien für die beiden Elemente.
Diese sind dann in den jeweilen `listUI.js` und `listAPI.js` gebündelt.
### Shared Module (`static/js/shared`)
#### editing.js
Hier liegt die Logik, welche genutzt wird um eines
der Elemente (Liste, Kategorie, Gegenstand) zu bearbeiten.
Zusammen mit `sharedUI.js` bildet sie den Ablauf ab.
Die beiden Dateien sind bewusst getrennt,
da die Funktion `editElement()` eine Mischung aus UI und API Aufrufe hat.
Das Muster, dass API und UI Funktionen in getrennten Dateien leben,
sollte beibehalten werden.
#### error.js
Globale Fehlermeldungsdarstellung. Eine Clientseitige Validierung findet
nicht statt, da sie serverseitig behandelt werden.
#### helper.js
Hilfsfunktion für das Abwickeln von `fetch()` Anfragen.
Zur Vereinheitlichung der Funktionen die API calls nutzen.
#### sharedUI.js
Stellt UI-Funktionen bereit, die alle Seiten nutzen. Momentan nur für
Bearbeitung der Elemente.
+296
View File
@@ -0,0 +1,296 @@
# API
Die API versucht möglichst RESTful zu sein. Es hat:
- Ressourcen im Plural
- Client-Server Trennung, Änderung der Daten auf der Oberfläche geschieht über `fetch()` an die API
- Einheitliche Schnittstelle
Die Schnittstelle erfolgt vollständig über JSON.
Es wurde auf Cache-fähigkeit verzichtet aus Zeitgründen. HATEOAS ist auch nicht vorhanden, da Zeitgründe und fragwürdig, ob es für ein Projekt diesen Umfang nötig ist.
## API Pfade
IDs sind im UUID Format
### Listen `/api/lists`
| Pfad | Methoden | Beschreibung | Parameter | Codes Erfolg |
| ------------ | -------- | --------------------------------------------------- | ----------------------------------------- | ------------ |
| `/api/lists` | `GET` | Gibt alle vorhandenen Listen zurück mit Name und ID | / | 200 |
| | `POST` | Erlaubt es eine neue Liste zu erstellen | `listName` für den gewünschten Listenname | 201 |
#### `GET /api/lists` - Alle Listen
##### Body Beispiel
Leer
##### Response Beispiel
```json
[
{
"listName": "Liste 1",
"listID": "ddb3ac36-8213-4f9d-bf1e-39c836768e57"
},
{
"listName": "Liste 2",
"listID": "8937a2fa-2ab1-4b1e-8ee2-17bb0358dc1f"
},
...
]
```
#### `POST /api/lists` - Erstellen einer Liste
##### Body Beispiel
```json
{
"listName": "Listenname"
}
```
##### Response Beispiel
```json
{
"listName": "Listenname",
"listID": "ddb3ac36-8213-4f9d-bf1e-39c836768e57"
}
```
### Liste `/api/lists`
| Pfad | Methoden | Beschreibung | Parameter | Codes Erfolg |
| ----------------- | -------- | ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------------ |
| `/api/lists/{id}` | GET | Gibt alle Gegenstände und Kategorien (mit ihren Gegenständen) in der Liste mit der UUID id zurück | `id`: UUID der Liste in der URL | 200 |
| | PATCH | Verändert den Namen der Liste | `id`: UUID der Liste in der URL. Im Body `listName` für den neuen Namen | 204 |
| | DELETE | löscht eine Liste | `id`: UUID Der Liste in der URL | 204 |
#### GET `/api/lists/{id}` - Inhalt der Liste
##### Body Beispiel
/
##### Response Beispiel
```json
{
"categories": [
{
"categoryName": "testkategorie",
"items": [
{
"status": false,
"itemName": "test",
"itemAmount": "1",
"itemID": "99403d02-4771-4a5a-b6a7-6f3af0a5ee84",
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4",
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
},
{
"status": true,
"itemName": "test",
"itemAmount": "2",
"itemID": "fc2806f6-d430-49f8-8c56-a6e2bc9792a7",
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4",
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
}
],
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4"
}
],
"itemsNoCategory": [ //Gegenstände ohne Kategorie
{
"status": false,
"itemName": "test",
"itemAmount": "3",
"itemID": "38a0991e-4b51-42d7-b12c-0ddbcf6f583e",
"categoryID": null,
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
}
]
}
```
#### `PATCH /api/lists/{id}` - Bearbeiten der Liste
##### Body
```json
{
"listName": "neuer Listname"
}
```
##### Response
/
#### `DELETE /api/lists/{id}` - Löschen einer Liste
##### Body
/
##### Response
/
### Kategorien `/api/categories`
| Pfad | Methoden | Beschreibung | Parameter | Codes Erfolg |
| ---------------------- | -------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `/api/categories/{id}` | `GET` | Gibt den Inhalt der Kategorie zurück | / | 200 |
| | `POST` | Erlaubt es eine neue Kategorie zu erstellen | `categoryName` im Body für den gewünschten Kategorienamen | 201 |
| | `PATCH` | Ändern vom Namen der Liste | `categoryName` im Body für neuen Kategorienamen | 204 |
| | `DELETE` | Löschen einer Liste | `deleteAllItems=(true\|false)` als Queryparameter. Entscheidet, ob Gegenstände in der Kategorie mitgelöscht werden sollen | 204 |
#### `GET /api/categories/{id}` - Inhalt der Kategorie
##### Body Beispiel
/
##### Response Beispiel
```json
{
"categoryName": "testkategorie",
"items": [
{
"status": false,
"itemName": "test",
"itemAmount": "1",
"itemID": "99403d02-4771-4a5a-b6a7-6f3af0a5ee84",
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4",
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
}
],
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4"
}
```
#### `POST /api/categories` - Erstellen einer Kategorie
##### Body Beispiel
```json
{
"categoryName": "testKategorie",
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
}
```
##### Response Beispiel
```json
{
"categoryName": "testKategorie",
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4"
}
```
#### `PATCH /api/categories/{id}` - Bearbeiten der Kategorie
##### Body Beispiel
```json
{
"categoryName": "Gemüse"
}
```
##### Response
/
#### `DELETE /api/categories/{id}?deleteAllItems=(true|false)`
##### Body
/
##### Response
/
### Gegenstände `/api/items`
| Pfad | Methoden | Beschreibung | Parameter | Codes Erfolg |
| ----------------- | -------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `/api/items/{id}` | `GET` | Gibt den Inhalt des Gegenstands zurück | / | 200 |
| | `POST` | Erlaubt es einen neuen Gegenstand zu erstellen | `itemName,itemAmount,categoryID?,listID` im Body, für den Namen und Menge (entweder beide oder mindst einer muss vorhanden sein). | 201 |
| | `PATCH` | Ändern vom Namen, Menge oder Status eines Gegenstands | `itemName, itemAmount, isDone, categoryID` im Body. | 204 |
| | `DELETE` | Löschen eines Gegenstands | / | 204 |
#### `GET /api/items/{id}` - Inhalt des Gegenstands
##### Body Beispiel
/
##### Response Beispiel
```json
{
"status": false,
"itemName": "Milch",
"itemAmount": "1L",
"itemID": "38a0991e-4b51-42d7-b12c-0ddbcf6f583e",
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4",
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
}
```
#### `POST /api/items` - Erstellen eines Gegenstands
##### Body Beispiel
```json
{
"itemName": "Milch",
"itemAmount": "1L",
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4",
"listID": "9038b8ef-7be8-4dcb-9229-6f51b11be137"
}
```
##### Response Beispiel
```json
{
"itemName": "Milch",
"itemAmount": "1L",
"itemID": "38a0991e-4b51-42d7-b12c-0ddbcf6f583e",
"categoryID": "08bedce1-9b25-4fe6-9ede-4d9ee3a904d4"
}
```
#### `PATCH /api/items/{id}` - Bearbeiten eines Gegenstands
##### Body Beispiel
```json
{
"isDone": true
}
```
##### Response
/
#### `DELETE /api/items/{id}` - Löschen eines Gegenstands
##### Body
/
##### Response
/
@@ -1,5 +1,6 @@
package de.timaldinger.einkaufsliste.Controller;
import de.timaldinger.einkaufsliste.Dto.Get.ShoppingCategoryGetDTO;
import de.timaldinger.einkaufsliste.Dto.Post.ShoppingCategoryPostDTO;
import de.timaldinger.einkaufsliste.Dto.Patch.ShoppingCategoryPatchDTO;
import de.timaldinger.einkaufsliste.Dto.Response.ShoppingCategoryResponseDTO;
@@ -11,12 +12,11 @@ import de.timaldinger.einkaufsliste.Models.ShoppingList;
import de.timaldinger.einkaufsliste.Repository.ShoppingCategoryRepository;
import de.timaldinger.einkaufsliste.Repository.ShoppingItemRepository;
import de.timaldinger.einkaufsliste.Repository.ShoppingListRepository;
import de.timaldinger.einkaufsliste.Service.ShoppingCategoryService;
import jakarta.validation.Valid;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.server.ResponseStatusException;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
import java.net.URI;
@@ -32,6 +32,14 @@ public class ShoppingCategoryController {
@Autowired
private ShoppingItemRepository shoppingItemRepository;
@Autowired
private ShoppingCategoryService shoppingCategoryService;
@GetMapping("/api/categories/{categoryID}")
public ResponseEntity<ShoppingCategoryGetDTO> getCategory(@PathVariable UUID categoryID){
return ResponseEntity.ok().body(shoppingCategoryService.getCategory(categoryID));
}
@PostMapping("/api/categories")
public ResponseEntity<ShoppingCategoryResponseDTO> addCategory(@Valid @RequestBody ShoppingCategoryPostDTO newCategory){
@@ -1,23 +1,23 @@
package de.timaldinger.einkaufsliste.Controller;
import de.timaldinger.einkaufsliste.Dto.Get.ShoppingItemGetDTO;
import de.timaldinger.einkaufsliste.Dto.Post.ShoppingItemPostDTO;
import de.timaldinger.einkaufsliste.Dto.Patch.ShoppingItemPatchDTO;
import de.timaldinger.einkaufsliste.Dto.Response.ShoppingItemResponseDTO;
import de.timaldinger.einkaufsliste.Exceptions.BadRequestException;
import de.timaldinger.einkaufsliste.Exceptions.ResourceNotFoundException;
import de.timaldinger.einkaufsliste.Mapper.ShoppingItemMapper;
import de.timaldinger.einkaufsliste.Models.ShoppingCategory;
import de.timaldinger.einkaufsliste.Models.ShoppingItem;
import de.timaldinger.einkaufsliste.Models.ShoppingList;
import de.timaldinger.einkaufsliste.Repository.ShoppingCategoryRepository;
import de.timaldinger.einkaufsliste.Repository.ShoppingItemRepository;
import de.timaldinger.einkaufsliste.Repository.ShoppingListRepository;
import jakarta.annotation.Resource;
import de.timaldinger.einkaufsliste.Service.ShoppingItemService;
import jakarta.validation.Valid;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.server.ResponseStatusException;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
import java.net.URI;
@@ -33,6 +33,17 @@ public class ShoppingItemController {
@Autowired
private ShoppingItemRepository shoppingItemRepository;
@Autowired
private ShoppingItemService shoppingItemService;
@Autowired
private ShoppingItemMapper shoppingItemMapper;
@GetMapping("/api/items/{itemID}")
public ResponseEntity<ShoppingItemGetDTO> getItem(@PathVariable UUID itemID){
return ResponseEntity.ok().body(shoppingItemService.getItem(itemID));
}
@PostMapping("/api/items")
public ResponseEntity<ShoppingItemResponseDTO> addItem(@Valid @RequestBody ShoppingItemPostDTO newItem){
String name = newItem.itemName();
@@ -1,10 +1,12 @@
package de.timaldinger.einkaufsliste.Controller;
import de.timaldinger.einkaufsliste.Dto.Get.*;
import de.timaldinger.einkaufsliste.Dto.Patch.ShoppingListPatchDTO;
import de.timaldinger.einkaufsliste.Dto.Post.ShoppingListPostDTO;
import de.timaldinger.einkaufsliste.Dto.Response.ShoppingListResponseDTO;
import de.timaldinger.einkaufsliste.Exceptions.ResourceNotFoundException;
import de.timaldinger.einkaufsliste.Models.ShoppingItem;
import de.timaldinger.einkaufsliste.Mapper.ShoppingCategoryMapper;
import de.timaldinger.einkaufsliste.Mapper.ShoppingItemMapper;
import de.timaldinger.einkaufsliste.Models.ShoppingList;
import de.timaldinger.einkaufsliste.Repository.ShoppingCategoryRepository;
import de.timaldinger.einkaufsliste.Repository.ShoppingItemRepository;
@@ -12,10 +14,8 @@ import de.timaldinger.einkaufsliste.Repository.ShoppingListRepository;
import de.timaldinger.einkaufsliste.Service.ShoppingListService;
import jakarta.validation.Valid;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.server.ResponseStatusException;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
import java.net.URI;
@@ -34,6 +34,21 @@ public class ShoppingListController {
@Autowired
private ShoppingListService shoppingListService;
@Autowired
private ShoppingItemMapper shoppingItemMapper;
@Autowired
private ShoppingCategoryMapper shoppingCategoryMapper;
@GetMapping("/api/lists")
public ResponseEntity<List<ShoppingListsGetDTO>> getLists(){
return ResponseEntity.ok().body(shoppingListService.getLists());
}
@GetMapping("/api/lists/{listID}")
public ResponseEntity<ShoppingListGetDTO> getList(@PathVariable UUID listID){
return ResponseEntity.ok().body(shoppingListService.getList(listID));
}
@PostMapping("/api/lists")
public ResponseEntity<ShoppingListResponseDTO> addList(@Valid @RequestBody ShoppingListPostDTO newList){
ShoppingList list = new ShoppingList(newList.listName(), null, null, 0, 0);
@@ -0,0 +1,7 @@
package de.timaldinger.einkaufsliste.Dto.Get;
import java.util.List;
import java.util.UUID;
public record ShoppingCategoryGetDTO(String categoryName, List<ShoppingItemGetDTO> items, UUID categoryID) {
}
@@ -0,0 +1,6 @@
package de.timaldinger.einkaufsliste.Dto.Get;
import java.util.UUID;
public record ShoppingItemGetDTO(boolean status, String itemName, String itemAmount, UUID itemID, UUID categoryID, UUID listID) {
}
@@ -0,0 +1,6 @@
package de.timaldinger.einkaufsliste.Dto.Get;
import java.util.List;
public record ShoppingListGetDTO(List<ShoppingCategoryGetDTO> categories, List<ShoppingItemGetDTO> itemsNoCategory) {
}
@@ -0,0 +1,7 @@
package de.timaldinger.einkaufsliste.Dto.Get;
import java.util.UUID;
public record ShoppingListsGetDTO(String listName, UUID listID){
}
@@ -2,5 +2,5 @@ package de.timaldinger.einkaufsliste.Dto.Patch;
import jakarta.validation.constraints.NotBlank;
public record ShoppingCategoryPatchDTO(@NotBlank(message = "categoryName can't be blank") String categoryName) {
public record ShoppingCategoryPatchDTO(@NotBlank(message = "Kategoriename darf nicht leer sein!") String categoryName) {
}
@@ -6,7 +6,7 @@ import java.util.UUID;
public record ShoppingItemPatchDTO(String itemName, String itemAmount, Boolean isDone, UUID categoryID) {
@AssertTrue(message = "itemName and itemAmount both cant be blank!")
@AssertTrue(message = "Wenigstens eines der Felder muss ausgefüllt sein!")
private boolean isAtleastOneNotBlank(){
boolean n = itemName != null && !itemName.isBlank();
boolean a = itemAmount != null && !itemAmount.isBlank();
@@ -2,5 +2,5 @@ package de.timaldinger.einkaufsliste.Dto.Patch;
import jakarta.validation.constraints.NotBlank;
public record ShoppingListPatchDTO(@NotBlank(message = "listName must not be blank!") String listName) {
public record ShoppingListPatchDTO(@NotBlank(message = "Listenname darf nicht leer sein!") String listName) {
}
@@ -4,5 +4,5 @@ import jakarta.validation.constraints.NotBlank;
import java.util.UUID;
public record ShoppingCategoryPostDTO(@NotBlank(message = "categoryName must not be blank!") String categoryName, UUID listID) {
public record ShoppingCategoryPostDTO(@NotBlank(message = "Kategoriename darf nicht leer sein!") String categoryName, UUID listID) {
}
@@ -11,7 +11,7 @@ public record ShoppingItemPostDTO(String itemName,
@NotNull(message = "listID must not be empty!")
UUID listID){
@AssertTrue(message = "itemName and itemAmount cant both be blank!")
@AssertTrue(message = "Wenigstens eines der Felder muss ausgefüllt sein!")
private boolean isAtleastOneNotBlank(){
boolean n = itemName != null && !itemName.isBlank();
boolean a = itemAmount != null && !itemAmount.isBlank();
@@ -2,5 +2,5 @@ package de.timaldinger.einkaufsliste.Dto.Post;
import jakarta.validation.constraints.NotBlank;
public record ShoppingListPostDTO(@NotBlank(message = "listName must not be blank!") String listName) {
public record ShoppingListPostDTO(@NotBlank(message = "Listenname darf nicht leer sein!") String listName) {
}
@@ -0,0 +1,27 @@
package de.timaldinger.einkaufsliste.Mapper;
import de.timaldinger.einkaufsliste.Dto.Get.ShoppingCategoryGetDTO;
import de.timaldinger.einkaufsliste.Models.ShoppingCategory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.util.List;
@Component
public class ShoppingCategoryMapper {
@Autowired
ShoppingItemMapper shoppingItemMapper;
public ShoppingCategoryGetDTO toGetDTO(ShoppingCategory category){
return new ShoppingCategoryGetDTO(
category.getCategoryName(),
shoppingItemMapper.toGetDTOs(category.getItemsInCategory()),
category.getId()
);
}
public List<ShoppingCategoryGetDTO> toGetDTOs(List<ShoppingCategory> categories){
return categories.stream().map(this::toGetDTO).toList();
}
}
@@ -0,0 +1,25 @@
package de.timaldinger.einkaufsliste.Mapper;
import de.timaldinger.einkaufsliste.Dto.Get.ShoppingItemGetDTO;
import de.timaldinger.einkaufsliste.Models.ShoppingItem;
import org.springframework.stereotype.Component;
import java.util.List;
@Component
public class ShoppingItemMapper {
public ShoppingItemGetDTO toGetDTO(ShoppingItem item){
return new ShoppingItemGetDTO(
item.isDone(),
item.getItemName(),
item.getItemAmount(),
item.getId(),
item.getCategory() != null ? item.getCategory().getId() : null,
item.getList().getId()
);
}
public List<ShoppingItemGetDTO> toGetDTOs(List<ShoppingItem> items){
return items.stream().map(this::toGetDTO).toList();
}
}
@@ -0,0 +1,22 @@
package de.timaldinger.einkaufsliste.Mapper;
import de.timaldinger.einkaufsliste.Dto.Get.ShoppingListsGetDTO;
import de.timaldinger.einkaufsliste.Models.ShoppingList;
import org.springframework.stereotype.Component;
import java.util.List;
@Component
public class ShoppingListMapper {
public List<ShoppingListsGetDTO> toListsGetDTOs(List<ShoppingList> list){
return list.stream().map(this::toListsGetDTO).toList();
}
public ShoppingListsGetDTO toListsGetDTO(ShoppingList list){
return new ShoppingListsGetDTO(
list.getListName(),
list.getId()
);
}
}
@@ -12,7 +12,10 @@ import java.util.UUID;
public interface ShoppingCategoryRepository extends JpaRepository<ShoppingCategory, UUID>{
List<ShoppingCategory> findByList(ShoppingList list);
List<ShoppingCategory> findByList_Id(UUID listID);
@Modifying
@Query("DELETE FROM ShoppingCategory c WHERE c.list.id = :listID")
void deleteByListId(@Param("listID") UUID listID);
}
@@ -0,0 +1,26 @@
package de.timaldinger.einkaufsliste.Service;
import de.timaldinger.einkaufsliste.Dto.Get.ShoppingCategoryGetDTO;
import de.timaldinger.einkaufsliste.Exceptions.ResourceNotFoundException;
import de.timaldinger.einkaufsliste.Mapper.ShoppingCategoryMapper;
import de.timaldinger.einkaufsliste.Models.ShoppingCategory;
import de.timaldinger.einkaufsliste.Repository.ShoppingCategoryRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.UUID;
@Service
public class ShoppingCategoryService {
@Autowired
private ShoppingCategoryMapper shoppingCategoryMapper;
@Autowired
private ShoppingCategoryRepository shoppingCategoryRepository;
public ShoppingCategoryGetDTO getCategory(UUID categoryID){
ShoppingCategory category = shoppingCategoryRepository.findById(categoryID).orElseThrow(() -> new ResourceNotFoundException("categoryID", categoryID));
return shoppingCategoryMapper.toGetDTO(category);
}
}
@@ -0,0 +1,26 @@
package de.timaldinger.einkaufsliste.Service;
import de.timaldinger.einkaufsliste.Dto.Get.ShoppingItemGetDTO;
import de.timaldinger.einkaufsliste.Exceptions.ResourceNotFoundException;
import de.timaldinger.einkaufsliste.Mapper.ShoppingItemMapper;
import de.timaldinger.einkaufsliste.Models.ShoppingItem;
import de.timaldinger.einkaufsliste.Repository.ShoppingItemRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.UUID;
@Service
public class ShoppingItemService {
@Autowired
private ShoppingItemMapper shoppingItemMapper;
@Autowired
private ShoppingItemRepository shoppingItemRepository;
public ShoppingItemGetDTO getItem(UUID itemID){
ShoppingItem item = shoppingItemRepository.findById(itemID).orElseThrow(() -> new ResourceNotFoundException("itemID", itemID));
return shoppingItemMapper.toGetDTO(item);
}
}
@@ -1,5 +1,11 @@
package de.timaldinger.einkaufsliste.Service;
import de.timaldinger.einkaufsliste.Dto.Get.*;
import de.timaldinger.einkaufsliste.Exceptions.ResourceNotFoundException;
import de.timaldinger.einkaufsliste.Mapper.ShoppingCategoryMapper;
import de.timaldinger.einkaufsliste.Mapper.ShoppingItemMapper;
import de.timaldinger.einkaufsliste.Mapper.ShoppingListMapper;
import de.timaldinger.einkaufsliste.Models.ShoppingList;
import de.timaldinger.einkaufsliste.Repository.ShoppingCategoryRepository;
import de.timaldinger.einkaufsliste.Repository.ShoppingItemRepository;
import de.timaldinger.einkaufsliste.Repository.ShoppingListRepository;
@@ -7,6 +13,7 @@ import jakarta.transaction.Transactional;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
import java.util.UUID;
@Service
@@ -17,6 +24,12 @@ public class ShoppingListService {
private ShoppingListRepository shoppingListRepository;
@Autowired
private ShoppingCategoryRepository shoppingCategoryRepository;
@Autowired
private ShoppingCategoryMapper shoppingCategoryMapper;
@Autowired
private ShoppingItemMapper shoppingItemMapper;
@Autowired
private ShoppingListMapper shoppingListMapper;
@Transactional
public void deleteList(UUID listID){
@@ -24,4 +37,21 @@ public class ShoppingListService {
shoppingCategoryRepository.deleteByListId(listID);
shoppingListRepository.deleteById(listID);
}
public List<ShoppingListsGetDTO> getLists(){
return shoppingListMapper.toListsGetDTOs(shoppingListRepository.findAll());
}
public ShoppingListGetDTO getList(UUID listID){
ShoppingList l = shoppingListRepository.findById(listID).orElseThrow( () -> new ResourceNotFoundException("listID", listID));
List<ShoppingCategoryGetDTO> categories = shoppingCategoryMapper.toGetDTOs(shoppingCategoryRepository.findByList(l));
List<ShoppingItemGetDTO> items = shoppingItemMapper.toGetDTOs(shoppingItemRepository.findByList_IdAndCategoryIsNull(listID));
return new ShoppingListGetDTO(categories,items);
}
}
+11 -1
View File
@@ -113,13 +113,14 @@ button:hover { background: var(--c-accent-hover); }
.nav a:hover { color: var(--c-accent); }
.nav__dropdown { position: relative; cursor: default; }
.nav__dropdownMenu {
display: none;
position: absolute;
top: 100%;
left: 0;
min-width: 12rem;
margin-top: var(--space-2);
margin-top: 0;
list-style: none;
background: var(--c-bg);
border: 1px solid var(--c-border);
@@ -132,3 +133,12 @@ button:hover { background: var(--c-accent-hover); }
.nav__list a { display: block; padding: var(--space-1) var(--space-2); }
.nav__list a:hover { background: var(--c-surface); border-radius: var(--radius); }
@media (max-width: 640px) {
button {
padding: var(--space-1) var(--space-2);
font-size: .875rem;
}
}
@@ -60,11 +60,25 @@ function init() {
, errmsg: `liste konnte nicht aktualsiiert werden`
})
} else if (event.target.matches(".list__deleteButton")) {
deleteList(event.target.closest("li"));
}
});
document.querySelector(".nav").addEventListener("click", (event) => {
if (event.target.matches(".nav__dropdown")) {
event.target.closest("li").classList.add("is-open");
event.stopPropagation();
}
});
document.querySelector("body").addEventListener("click", (event) => {
if (!event.target.matches(".nav__dropdown")) {
document.querySelector(".is-open")?.classList.remove("is-open");
}
});
}
document.addEventListener('DOMContentLoaded', init);
@@ -151,6 +151,16 @@ function init() {
});
}
});
document.querySelector(".nav").addEventListener("click", (event) => {
if (event.target.matches(".nav__dropdown")) {
event.target.closest("li").classList.add("is-open");
event.stopPropagation();
}
});
document.querySelector(".displayedList").addEventListener("change", (e) => {
@@ -161,6 +171,14 @@ function init() {
}
});
document.querySelector("body").addEventListener("click", (event) => {
if (!event.target.matches(".nav__dropdown")) {
document.querySelector(".is-open")?.classList.remove("is-open");
}
});
console.log("javascript initialized!");
}