Load existing data to the appointment show/edit form

Author: joaopms

.idea/dataSources.xml

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Exceptions;
+
+use Exception;
+
+class ResourceConditionsException extends Exception
+{
+    //
+}

app/Exceptions/ResourceConditionsException.php

@@ -3,6 +3,7 @@
 namespace App\Http\Controllers;
 
 use App\Http\Requests\ListAppointmentsRequest;
+use App\Http\Resources\AppointmentCollection;
 use App\Http\Resources\AppointmentResource;
 use App\Models\Animal;
 use App\Models\Appointment;
@@ -33,7 +34,7 @@ public function index(ListAppointmentsRequest $request)
         $animalTypes = Animal::types(approved: false);
 
         return Inertia::render('dashboard/appointments/Index', [
-            'appointments' => AppointmentResource::collection($appointments),
+            'appointments' => new AppointmentCollection($appointments)->listing(),
             'animalTypes' => $animalTypes,
         ]);
     }
@@ -43,7 +44,7 @@ public function show(Appointment $appointment)
         $appointment = $appointment->load(['animal', 'animal.client']);
 
         return Inertia::render('dashboard/appointments/Appointment', [
-            'appointment' => $appointment,
+            'appointment' => new AppointmentResource($appointment)->showing(),
             'animalTypes' => Animal::types(approved: false),
             'timesOfDay' => TimeOfDay::selectable(),
         ]);

app/Http/Controllers/AppointmentController.php

@@ -5,7 +5,6 @@
 use App\Helpers\AgeParser;
 use App\TimeOfDay;
 use Illuminate\Foundation\Http\FormRequest;
-use Illuminate\Support\Arr;
 use Illuminate\Validation\Rule;
 
 class StoreAppointmentSchedule extends FormRequest
@@ -55,25 +54,20 @@ public function getAnimalAgeInMonths(): int
     }
 
     /**
-     * Casts preferred times from string to TimeOfDay enum and returns them
+     * Casts preferred times from string to TimeOfDay enum
      *
      * This is necessary because they are sent as strings from the frontend
-     *
-     * @return TimeOfDay[]
      */
-    public function getAppointmentTimes(): array
+    public function getAppointmentTimes(): TimeOfDay
     {
-        return Arr::map(
-            $this['appointment.preferred_time'],
-            fn (string $time) => TimeOfDay::from($time)
-        );
+        return TimeOfDay::fromInputData($this['appointment.preferred_time']);
     }
 
     public function getAppointmentData(): array
     {
         return [
             ...$this['appointment'],
-            'preferred_time' => TimeOfDay::allDayOrOneTime($this->getAppointmentTimes()),
+            'preferred_time' => $this->getAppointmentTimes(),
             'animal_age_months' => $this->getAnimalAgeInMonths(),
         ];
     }

app/Http/Requests/StoreAppointmentSchedule.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Http\Resources;
+
+use App\Exceptions\ResourceConditionsException;
+use App\ResourceConditions;
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\ResourceCollection;
+
+class AppointmentCollection extends ResourceCollection
+{
+    use ResourceConditions;
+
+    protected array $conditions = ['listing', 'showing'];
+
+    /**
+     * @throws ResourceConditionsException
+     */
+    public function toArray(Request $request): array
+    {
+        // TODO Only set conditions on the resource itself, the ResourceCollection can just get it from there
+        $this->injectConditions();
+
+        return parent::toArray($request);
+    }
+}

app/Http/Resources/AppointmentCollection.php

@@ -4,26 +4,42 @@
 
 use App\Models\Appointment;
 use App\Models\User;
+use App\ResourceConditions;
+use App\TimeOfDay;
 use Illuminate\Http\Request;
 use Illuminate\Http\Resources\Json\JsonResource;
 
-/** @mixin Appointment */
+/** @mixin Appointment
+ * @property bool $listing
+ * @property bool $showing
+ */
 class AppointmentResource extends JsonResource
 {
+    use ResourceConditions;
+
+    protected array $conditions = ['listing', 'showing'];
+
     public function toArray(Request $request): array
     {
         return [
-            'id' => $this->id,
-            'preferred_date' => $this->preferred_date_formatted,
-            'preferred_time' => $this->preferred_time_formatted,
-            'symptoms' => $this->symptoms,
+            'appointment' => [
+                'id' => $this->when($this->listing, $this->id),
+                'preferred_date_formatted' => $this->when($this->listing, $this->preferred_date_formatted),
+                'preferred_time_formatted' => $this->when($this->listing, $this->preferred_time_formatted),
+                'preferred_date' => $this->when($this->showing, $this->preferred_date->toDateString()),
+                'preferred_time' => $this->when($this->showing, TimeOfDay::toInputData($this->preferred_time)),
+                'symptoms' => $this->symptoms,
+            ],
             'animal' => [
                 'name' => $this->animal->name,
                 'type' => $this->animal->type,
-                'age' => $this->animal_age_formatted,
+                'age_human' => $this->animal_age->human(),
+                'age_years' => $this->animal_age->years(),
+                'age_months' => $this->animal_age->months(),
             ],
             'client' => [
                 'name' => $this->animal->client->name,
+                'email' => $this->when($this->showing, $this->animal->client->email),
             ],
             'medic' => $this->whenLoaded('medic', fn (User $medic) => [
                 'name' => $medic->name,

app/Http/Resources/AppointmentResource.php

@@ -23,8 +23,10 @@ class Appointment extends Model
         'animal_age_months',
     ];
 
+    protected $dateFormat = 'Y-m-d';
+
     protected $casts = [
-        'preferred_date' => 'date',
+        'preferred_date' => 'date:Y-m-d',
         'preferred_time' => TimeOfDay::class,
         'assigned_at' => 'timestamp',
     ];
@@ -74,7 +76,7 @@ public function preferredTimeFormatted(): Attribute
         );
     }
 
-    public function animalAgeFormatted(): Attribute
+    public function animalAge(): Attribute
     {
         return Attribute::make(
             get: fn () => new AgeParser($this->animal_age_months)

app/Models/Appointment.php

@@ -0,0 +1,75 @@
+<?php
+
+namespace App;
+
+use App\Exceptions\ResourceConditionsException;
+use Illuminate\Http\Resources\DelegatesToResource;
+use Illuminate\Http\Resources\Json\ResourceCollection;
+
+/**
+ * Allows conditions to be passed to Resources and ResourceCollections
+ *
+ * Define `$conditions` in the resource/collection class and then call the name
+ * of the conditions.
+ *
+ * Example:
+ * <code>
+ * class AnimalResource extends JsonResource {
+ *     use ResourceConditions;
+ *     protected $conditions = ['listing'];
+ * }
+ * </code>
+ *
+ * <code>
+ * new AnimalResource($animal)->listing();
+ * </code>
+ */
+trait ResourceConditions
+{
+    use DelegatesToResource {
+        __get as resourceGet;
+        __call as resourceCall;
+    }
+
+    public array $enabledConditions = [];
+
+    public function __call($name, $arguments)
+    {
+        in_array($name, $this->conditions)
+            ? array_push($this->enabledConditions, $name)
+            : $this->resourceCall($name, $arguments);
+
+        return $this;
+    }
+
+    public function __get($name)
+    {
+        return in_array($name, $this->conditions)
+            ? in_array($name, $this->enabledConditions)
+            : $this->resourceGet($name);
+    }
+
+    /**
+     * @throws ResourceConditionsException
+     */
+    public function injectConditions(): void
+    {
+        if (! is_subclass_of($this, ResourceCollection::class)) {
+            throw new ResourceConditionsException(sprintf(
+                "Class %s does not use %s, can't call injectConditions()",
+                get_class($this), ResourceCollection::class
+            ));
+        }
+
+        $this->collection->each(function ($resource) {
+            if (! is_subclass_of($this, ResourceCollection::class)) {
+                throw new ResourceConditionsException(sprintf(
+                    "Class %s does not use %s, can't call injectConditions()",
+                    get_class($resource), ResourceCollection::class
+                ));
+            }
+
+            $resource->enabledConditions = $this->enabledConditions;
+        });
+    }
+}

app/ResourceConditions.php

@@ -2,6 +2,7 @@
 
 namespace App;
 
+use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
 
 enum TimeOfDay: string
@@ -17,10 +18,17 @@ enum TimeOfDay: string
      */
     public static function selectable(): array
     {
-        return [
-            self::Morning,
-            self::Afternoon,
-        ];
+        return [self::Morning, self::Afternoon];
+    }
+
+    /**
+     * Same as `selectable()` but returns an array of strings
+     *
+     * @return string[]
+     */
+    public static function selectableStrings(): array
+    {
+        return Arr::map(self::selectable(), fn (TimeOfDay $time) => $time->value);
     }
 
     /**
@@ -30,23 +38,29 @@ public static function selectable(): array
      */
     public static function isAllDay(array $times): bool
     {
-        return self::selectable() == $times;
+        $selectable = array_map(fn (TimeOfDay $time) => $time->value, self::selectable());
+        $given = array_map(fn (TimeOfDay $time) => $time->value, $times);
+
+        sort($selectable);
+        sort($given);
+
+        return $selectable == $given;
     }
 
     /**
      * If all possible times are selected, return `AllDay`; if not, return the only result
      *
      * @param  TimeOfDay[]  $times
      */
-    public static function allDayOrOneTime(array $times): TimeOfDay
+    private static function allDayOrOneTime(array $times): TimeOfDay
     {
         if (self::isAllDay($times)) {
             return self::AllDay;
         }
 
         assert(
             count($times) == 1,
-            'Got times of day and it was not considered as AllDay'
+            'Got times of day and it was not considered as AllDay. Did you pass an array of TimeOfDay?'
         );
 
         return $times[0];
@@ -56,4 +70,23 @@ public function format(): string
     {
         return Str::headline($this->value);
     }
+
+    /**
+     * @param  string[]  $values
+     */
+    public static function fromInputData(array $values): TimeOfDay
+    {
+        $converted = array_map(fn (string $value) => TimeOfDay::from($value), $values);
+
+        return TimeOfDay::allDayOrOneTime($converted);
+    }
+
+    public static function toInputData(TimeOfDay $value): array
+    {
+        if ($value == TimeOfDay::AllDay) {
+            return TimeOfDay::selectable();
+        }
+
+        return [$value];
+    }
 }

app/TimeOfDay.php

@@ -21,7 +21,7 @@ public function definition(): array
     {
         return [
             'symptoms' => fake()->text(),
-            'preferred_date' => fake()->dateTimeThisMonth('+15 days'),
+            'preferred_date' => fake()->dateTimeThisMonth('+15 days')->format('Y-m-d'),
             'preferred_time' => fake()->randomElement(TimeOfDay::class),
             'animal_age_months' => fake()->randomNumber(2),
             'animal_id' => Animal::factory(),