refactor: improve event management architecture and code structure

- Separate business logic from controllers into EventService
- Change value object to EventDetails for better data encapsulation
- Update InstructorEventController to use EventService
- Refactor request classes to include getEventDetails method
- Improve code organization, readability and reduce controller complexity

Author: Finnick223

app/Http/Controllers/InstructorEventController.php

@@ -6,24 +6,22 @@
 use App\Http\Requests\UpdateInstructorEventRequest;
 use App\Http\Resources\InstructorEventResource;
 use App\Models\Event;
-use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
+use App\Services\EventService;
+use Exception;
 use Illuminate\Http\Request;
+use Symfony\Component\HttpFoundation\Response;
 
 class InstructorEventController extends Controller
 {
-    use AuthorizesRequests;
+    public function __construct(protected EventService $eventService) {}
 
     /**
      * Display a listing of the resource.
      */
     public function index(Request $request)
     {
         $instructor = $request->user();
-
-        $driverIds = $instructor->drivers->pluck('id');
-
-        $events = Event::whereIntegerInRaw('user_id', $driverIds)->with('driver')->get();
-
+        $events = $this->eventService->getInstructorEvents($instructor);
         return InstructorEventResource::collection($events);
     }
 
@@ -32,52 +30,29 @@ public function index(Request $request)
      */
     public function store(StoreInstructorEventRequest $request)
     {
-        $validated = $request->validated();
-        $dateRange = $request->getEventDateRange();
         $instructor = $request->user();
-        $driver = $instructor->drivers()->findOrFail($validated['driver_id']);
+        $eventDetails = $request->getEventDetails();
+        $driverId = $request->validated('driver_id');
 
-        $event = $driver->events()->create([
-            'title' => $validated['title'],
-            'start' => $dateRange->start,
-            'end' => $dateRange->end,
-        ]);
-        $event->load('driver');
-
-        return response()->json(new InstructorEventResource($event), 201);
+        return response()->json(new InstructorEventResource($this->eventService->createEvent($instructor, $eventDetails, $driverId)), Response::HTTP_CREATED);
     }
 
     /**
      * Update the specified resource in storage.
      */
     public function update(UpdateInstructorEventRequest $request, Event $event)
     {
-        $validated = $request->validated();
-
-        $event->update([
-            'title' => $validated['title'],
-            'start' => $validated['start'],
-            'end' => $validated['end'],
-        ]);
-        $event->load('driver');
-
-        return response()->json(new InstructorEventResource($event));
+        $eventDetails = $request->getEventDetails();
+        return new InstructorEventResource($this->eventService->updateEvent($event, $eventDetails));
     }
 
     /**
      * Remove the specified resource from storage.
+     * @throws Exception
      */
     public function destroy(Request $request, Event $event)
     {
-        $instructor = $request->user();
-        if (! $instructor->drivers()->where('id', $event->user_id)->exists()) {
-            return response()->json(['message' => 'Unauthorized event'], 403);
-        }
-
-        $this->authorize('delete', $event);
-
-        $event->delete();
-
+        $this->eventService->deleteEvent($request->user(), $event);
         return response()->noContent();
     }
 }

app/Http/Requests/StoreInstructorEventRequest.php

@@ -2,7 +2,7 @@
 
 namespace App\Http\Requests;
 
-use App\ValueObjects\EventDateRange;
+use App\ValueObjects\EventDetails;
 use Illuminate\Foundation\Http\FormRequest;
 
 class StoreInstructorEventRequest extends FormRequest
@@ -28,8 +28,11 @@ public function rules(): array
         ];
     }
 
-    public function getEventDateRange(): EventDateRange
+    /**
+     * @throws \DateMalformedStringException
+     */
+    public function getEventDetails(): EventDetails
     {
-        return EventDateRange::fromArray($this->only(['start', 'end']));
+        return EventDetails::fromArray($this->validated());
     }
 }

app/Http/Requests/UpdateInstructorEventRequest.php

@@ -2,6 +2,7 @@
 
 namespace App\Http\Requests;
 
+use App\ValueObjects\EventDetails;
 use Illuminate\Foundation\Http\FormRequest;
 
 class UpdateInstructorEventRequest extends FormRequest
@@ -22,4 +23,12 @@ public function rules(): array
             'end' => 'required|date|after:start',
         ];
     }
+
+    /**
+     * @throws \DateMalformedStringException
+     */
+    public function getEventDetails(): EventDetails
+    {
+        return EventDetails::fromArray($this->validated());
+    }
 }

app/Models/Event.php

@@ -5,6 +5,9 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
+/**
+ * @method static whereIntegerInRaw(string $string, $driverIds)
+ */
 class Event extends Model
 {
     protected $fillable = ['title', 'start', 'end', 'user_id'];

app/Services/EventService.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace App\Services;
+
+use App\Models\Event;
+use App\Models\User;
+use App\ValueObjects\EventDetails;
+use Exception;
+use Illuminate\Support\Collection;
+
+class EventService
+{
+    public function getInstructorEvents(User $instructor): Collection
+    {
+        $driverIds = $instructor->drivers()->pluck('id');
+        return Event::whereIntegerInRaw('user_id', $driverIds)->with('driver')->get();
+    }
+    public function createEvent(User $instructor, EventDetails $eventDetails, int $driverId): Event
+    {
+        // Retrieve the driver and handle not-found logic
+        $driver = $instructor->drivers()->findOrFail($driverId);
+
+        $event = $driver->events()->create($eventDetails->toArray());
+        $event->load('driver');
+        return $event;
+    }
+
+    public function updateEvent(Event $event, EventDetails $eventDetails): Event
+    {
+        $event->update($eventDetails->toArray());
+        $event->load('driver');
+        return $event;
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function deleteEvent(User $instructor, Event $event): void
+    {
+        if (!$instructor->drivers()->where('id', $event->user_id)->exists()) {
+            throw new Exception("Unauthorized action");
+        }
+        $event->delete();
+
+    }
+}

app/ValueObjects/EventDateRange.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace App\ValueObjects;
+
+use DateTimeImmutable;
+use InvalidArgumentException;
+
+readonly class EventDetails
+{
+    public DateTimeImmutable $start;
+    public DateTimeImmutable $end;
+    public string $title;
+
+    public function __construct(string $title, DateTimeImmutable $startDate, DateTimeImmutable $endDate)
+    {
+        if ($endDate <= $startDate) {
+            throw new InvalidArgumentException('The end date must be after the start date.');
+        }
+
+        $this->title = $title;
+        $this->start = $startDate;
+        $this->end = $endDate;
+    }
+
+    public function getTitle(): string
+    {
+        return $this->title;
+    }
+
+    public function getStart(): DateTimeImmutable
+    {
+        return $this->start;
+    }
+
+    public function getEnd(): DateTimeImmutable
+    {
+        return $this->end;
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'title' => $this->getTitle(),
+            'start' => $this->getStart(),
+            'end' => $this->getEnd(),
+        ];
+    }
+
+    /**
+     * @throws \DateMalformedStringException
+     */
+    public static function fromArray(array $data): self
+    {
+        return new self(
+            $data['title'],
+            new DateTimeImmutable($data['start']),
+            new DateTimeImmutable($data['end'])
+        );
+    }
+}