Merge pull request #54 from falestra/hotfix/custom-polymorphic-types

hotfix: use getMorphClass for custom polymorphic types

Author: ludoguenet

README.md

@@ -32,12 +32,32 @@ Zap is a comprehensive calendar and scheduling system for Laravel. Manage availa
 
 **Requirements:** PHP ≤8.5 • Laravel ≤12.0
 
+You can install the package via composer:
+
 ```bash
 composer require laraveljutsu/zap
-php artisan vendor:publish --tag=zap-migrations
+```
+
+You should publish the migration and the `config/zap.php` config file with:
+
+```bash
+php artisan vendor:publish --provider="Zap\ZapServiceProvider"
+```
+
+### Before Running Migrations
+
+**If you are USING UUIDs**, see the [Custom Model Support](#custom-model-support) section of the docs on UUID steps, before you continue. It explains some changes you may want to make to the migrations and config file before continuing. It also mentions important considerations after extending this package's models for UUID capability.
+
+If so, run the migration command:
+
+```bash
 php artisan migrate
 ```
 
+### Note for Apps Using UUIDs/ULIDs/GUIDs
+
+This package expects the primary key of your models to be an auto-incrementing int. If it is not, you may need to modify the `create_schedules_table` and `create_schedule_periods_table` migration and/or modify the default configuration. See [Custom Model Support](#custom-model-support) for more information.
+
 ### Setup Your Models
 
 Add the `HasSchedules` trait to any Eloquent model you want to make schedulable:
@@ -51,14 +71,6 @@ class Doctor extends Model
 }
 ```
 
-### Note for Apps Using UUIDs/ULIDs/GUIDs
-
-This package expects the primary key of your models to be an auto-incrementing int. If it is not, you may need to modify the `create_schedules_table` and `create_schedule_periods_table` migration and/or modify the default configuration. See [Custom Model Support](#custom-model-support) for more information.
-
-### Before Running Migrations
-
-**If you are USING UUIDs**, see the [Custom Model Support](#custom-model-support) section of the docs on UUID steps, before you continue. It explains some changes you may want to make to the migrations and config file before continuing. It also mentions important considerations after extending this package's models for UUID capability.
-
 ---
 
 ## 🧩 Core Concepts

src/Models/Concerns/HasSchedules.php

@@ -156,7 +156,7 @@ public function isAvailableAt(string $date, string $startTime, string $endTime,
             E_USER_DEPRECATED
         );
         // Get all active schedules for this model on this date
-        $schedules = $schedules ?? $this->getScheduleClass()::where('schedulable_type', get_class($this))
+        $schedules = $schedules ?? $this->getScheduleClass()::where('schedulable_type', $this->getMorphClass())
             ->where('schedulable_id', $this->getKey())
             ->active()
             ->forDate($date)
@@ -318,7 +318,7 @@ public function getAvailableSlots(
         $iterations = 0;
         $slotInterval = $slotDuration + $bufferMinutes;
 
-        $schedules = $this->getScheduleClass()::where('schedulable_type', get_class($this))
+        $schedules = $this->getScheduleClass()::where('schedulable_type', $this->getMorphClass())
             ->where('schedulable_id', $this->getKey())
             ->active()
             ->forDate($date)
@@ -501,7 +501,7 @@ protected function getAvailabilityPeriodsForDate(string $date): \Illuminate\Supp
         $checkDate = \Carbon\Carbon::parse($date);
 
         // Get all availability schedules for this date
-        $availabilitySchedules = $this->getScheduleClass()::where('schedulable_type', get_class($this))
+        $availabilitySchedules = $this->getScheduleClass()::where('schedulable_type', $this->getMorphClass())
             ->where('schedulable_id', $this->getKey())
             ->availability()
             ->active()
@@ -543,7 +543,7 @@ protected function getAvailabilityPeriodsForDate(string $date): \Illuminate\Supp
      */
     protected function getBlockingSchedulesForDate(string $date): \Illuminate\Support\Collection
     {
-        return $this->getScheduleClass()::where('schedulable_type', get_class($this))
+        return $this->getScheduleClass()::where('schedulable_type', $this->getMorphClass())
             ->where('schedulable_id', $this->getKey())
             ->whereIn('schedule_type', [
                 ScheduleTypes::APPOINTMENT->value,

src/Services/ConflictDetectionService.php

@@ -99,7 +99,7 @@ public function findSchedulableConflicts(Model $schedulable, \Zap\Models\Schedul
     {
         // Create a temporary schedule for conflict checking
         $tempSchedule = new $this->scheduleClass([
-            'schedulable_type' => get_class($schedulable),
+            'schedulable_type' => $schedulable->getMorphClass(),
             'schedulable_id' => $schedulable->getKey(),
             'start_date' => $schedule->start_date,
             'end_date' => $schedule->end_date,
@@ -355,7 +355,7 @@ public function findPeriodConflicts(
         string $startTime,
         string $endTime
     ): Collection {
-        return $this->scheduleClass::where('schedulable_type', get_class($schedulable))
+        return $this->scheduleClass::where('schedulable_type', $schedulable->getMorphClass())
             ->where('schedulable_id', $schedulable->getKey())
             ->active()
             ->forDate($date)

src/Services/ScheduleService.php

@@ -42,7 +42,7 @@ public function create(
 
             // Create the schedule
             $schedule = new $this->scheduleClass($attributes);
-            $schedule->schedulable_type = get_class($schedulable);
+            $schedule->schedulable_type = $schedulable->getMorphClass();
             $schedule->schedulable_id = $schedulable->getKey();
             $schedule->save();
 

src/Services/ValidationService.php

@@ -547,7 +547,7 @@ protected function validateNoOverlap($config, Model $schedulable, array $attribu
 
         // Create a temporary schedule for conflict checking
         $tempSchedule = new $this->scheduleClass([
-            'schedulable_type' => get_class($schedulable),
+            'schedulable_type' => $schedulable->getMorphClass(),
             'schedulable_id' => $schedulable->getKey(),
             'start_date' => $attributes['start_date'],
             'end_date' => $attributes['end_date'] ?? null,

tests/Feature/ComprehensiveUseCasesTest.php

@@ -1025,7 +1025,7 @@
             // Create the schedule object without saving to check conflicts
             // Use the same approach as ValidationService
             $tempSchedule = new Schedule([
-                'schedulable_type' => get_class($user),
+                'schedulable_type' => $user->getMorphClass(),
                 'schedulable_id' => $user->getKey(),
                 'start_date' => $newSchedule['attributes']['start_date'],
                 'end_date' => $newSchedule['attributes']['end_date'] ?? null,
@@ -1071,7 +1071,7 @@
 
             // Create the schedule object without saving to check conflicts
             $tempSchedule = new Schedule($schedule['attributes']);
-            $tempSchedule->schedulable_type = get_class($user);
+            $tempSchedule->schedulable_type = $user->getMorphClass();
             $tempSchedule->schedulable_id = $user->getKey();
             $tempSchedule->setRelation('periods', collect($schedule['periods'])->map(function ($period) {
                 return new \Zap\Models\SchedulePeriod($period);
@@ -1101,7 +1101,7 @@
             // Create the schedule object without saving to check conflicts
             // Use the same approach as ValidationService
             $tempSchedule = new Schedule([
-                'schedulable_type' => get_class($user),
+                'schedulable_type' => $user->getMorphClass(),
                 'schedulable_id' => $user->getKey(),
                 'start_date' => $newSchedule['attributes']['start_date'],
                 'end_date' => $newSchedule['attributes']['end_date'] ?? null,
@@ -1148,7 +1148,7 @@
             // Create the schedule object without saving to check conflicts
             // Use the same approach as ValidationService
             $tempSchedule = new Schedule([
-                'schedulable_type' => get_class($user),
+                'schedulable_type' => $user->getMorphClass(),
                 'schedulable_id' => $user->getKey(),
                 'start_date' => $newSchedule['attributes']['start_date'],
                 'end_date' => $newSchedule['attributes']['end_date'] ?? null,

tests/Feature/ConflictDetectionTest.php

@@ -127,7 +127,7 @@
 
         // Create a new appointment schedule that overlaps with both
         $newSchedule = new Schedule([
-            'schedulable_type' => get_class($user),
+            'schedulable_type' => $user->getMorphClass(),
             'schedulable_id' => $user->getKey(),
             'start_date' => '2025-01-01',
             'name' => 'Conflicting Meeting',

tests/Feature/DocumentationExamplesTest.php

@@ -241,7 +241,7 @@
         expect($availability->id)->not->toBeNull();
         // Verify the schedule is associated with the doctor
         expect($availability->schedulable_id)->toBe($doctor->getKey());
-        expect($availability->schedulable_type)->toBe(get_class($doctor));
+        expect($availability->schedulable_type)->toBe($doctor->getMorphClass());
 
         // Create appointment on a different date to avoid conflicts
         // Verify it was saved successfully
@@ -255,7 +255,7 @@
         expect($appointment->schedule_type->value)->toBe('appointment');
         // Verify the appointment is associated with the doctor
         expect($appointment->schedulable_id)->toBe($doctor->getKey());
-        expect($appointment->schedulable_type)->toBe(get_class($doctor));
+        expect($appointment->schedulable_type)->toBe($doctor->getMorphClass());
 
         // Get schedules for a date (forDate scope filters by date range and recurrence)
         // Note: forDate works for recurring schedules, for non-recurring it checks if date is within range

tests/Feature/ScheduleManagementTest.php

@@ -314,8 +314,8 @@
         ->addPeriod('11:00', '12:00')
         ->save();
 
-    expect($userSchedule->schedulable_type)->toBe('Zap\Tests\ZapTestUser');
-    expect($roomSchedule->schedulable_type)->toBe('Zap\Tests\ZapTestRoom');
+    expect($userSchedule->schedulable_type)->toBe('users');
+    expect($roomSchedule->schedulable_type)->toBe('rooms');
     expect($userSchedule->schedulable_id)->toBe($user->getKey());
     expect($roomSchedule->schedulable_id)->toBe($room->getKey());
 });

tests/Feature/WeeklyOddEven/ConflictDetectionTest.php

@@ -124,7 +124,7 @@
         // Create a new appointment schedule that overlaps only Meeting 2.
         // Because 'Weekly-Even Meeting' is in even weeks
         $newSchedule = new Schedule([
-            'schedulable_type' => get_class($user),
+            'schedulable_type' => $user->getMorphClass(),
             'schedulable_id' => $user->getKey(),
             'start_date' => '2025-01-01',
             'name' => 'Conflicting Meeting',
@@ -168,7 +168,7 @@
         // Create a new appointment schedule that overlaps only Meeting 2.
         // Because 'Weekly-Odd Meeting' is in odd weeks
         $newSchedule = new Schedule([
-            'schedulable_type' => get_class($user),
+            'schedulable_type' => $user->getMorphClass(),
             'schedulable_id' => $user->getKey(),
             'start_date' => '2025-01-06',
             'name' => 'Conflicting Meeting',