Enhance LaravelAppointments by adding polymorphic relationships, updating factories, and improving test coverage

Author: Itamar Junior

README.md

@@ -15,12 +15,14 @@ After installing the package, publish the configuration file:
 ```bash
 php artisan vendor:publish --provider="Codeitamarjr\LaravelAppointments\LaravelAppointmentServiceProvider" --tag=config
 php artisan vendor:publish --provider="Codeitamarjr\LaravelAppointments\LaravelAppointmentServiceProvider" --tag=migrations
+php artisan vendor:publish --tag=tests # Optional
 ```
 
 Run the migrations to create the necessary database tables:
 
 ```bash
 php artisan migrate
+php artisan db:seed --class=Codeitamarjr\\LaravelAppointments\\Database\\Seeders\\EventSeeder # Optional
 ```
 
 ## Usage

composer.json

@@ -29,6 +29,11 @@
       "Codeitamarjr\\LaravelAppointments\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "Tests\\": "tests/"
+    }
+  },
   "extra": {
     "laravel": {
       "providers": [

src/Database/Factories/AppointmentFactory.php

@@ -4,10 +4,11 @@
 
 use Codeitamarjr\LaravelAppointments\Models\Appointment;
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Codeitamarjr\LaravelAppointments\Models\Slot;
 
 
 /**
- * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\Appointment>
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\Codeitamarjr\LaravelAppointments\Models\Appointment>
  */
 class AppointmentFactory extends Factory
 {
@@ -22,7 +23,8 @@ public function definition(): array
     {
         return [
             'slot_id' => Slot::factory(),
-            'user_id' => \App\Models\User::factory(), // Adjust based on your user model namespace
+            'participant_id' => config('laravel-appointments.models.participant')::factory(),
+            'participant_type' => config('laravel-appointments.relationships.participant', 'participant'),
         ];
     }
 }

src/Database/Factories/SlotFactory.php

@@ -2,6 +2,7 @@
 
 namespace Codeitamarjr\LaravelAppointments\Database\Factories;
 
+use Carbon\Carbon;
 use Codeitamarjr\LaravelAppointments\Models\Slot;
 use Codeitamarjr\LaravelAppointments\Models\Event;
 use Illuminate\Database\Eloquent\Factories\Factory;
@@ -20,10 +21,12 @@ class SlotFactory extends Factory
      */
     public function definition(): array
     {
+        $startTime = $this->faker->dateTimeBetween('now', '+1 week');
+        $endTime = Carbon::parse($startTime)->addMinutes($this->faker->numberBetween(15, 120));
         return [
             'event_id' => Event::factory(),
-            'start_time' => $this->faker->dateTimeBetween('now', '+1 week'),
-            'end_time' => $this->faker->dateTimeBetween('+1 week', '+2 weeks'),
+            'start_time' => $startTime,
+            'end_time' => $endTime,
             'attendees_limit' => $this->faker->randomElement([null, 5, 10]),
         ];
     }

src/Database/Migrations/2024_12_18_133759_create_appointments_table.php

@@ -13,9 +13,11 @@ public function up(): void
     {
         Schema::create('appointments', function (Blueprint $table) {
             $table->id();
-            $table->foreignId('slot_id')->constrained()->cascadeOnDelete();
-            $table->foreignId('user_id')->constrained()->cascadeOnDelete();
+            $table->unsignedBigInteger('slot_id');
+            $table->morphs('participant'); // Adds participant_id and participant_type
             $table->timestamps();
+
+            $table->foreign('slot_id')->references('id')->on('slots')->onDelete('cascade');
         });
     }
 

src/Database/Seeders/EventSeeder.php

@@ -7,15 +7,12 @@
 
 class EventSeeder extends Seeder
 {
-    /**
-     * Run the database seeds.
-     */
     public function run(): void
     {
-        Event::factory(5)
-            ->hasSlots(3)
-            ->hasSlots(3, [
-                'attendees_limit' => 5
-            ])->create();
+        // Create 5 events, each with 3 slots
+        Event::factory()
+            ->count(5)
+            ->hasSlots(3, ['attendees_limit' => 5])
+            ->create();
     }
 }

src/LaravelAppointmentServiceProvider.php

@@ -10,48 +10,58 @@ public function boot()
     {
         // Publish Configuration
         $this->publishes([
-            __DIR__.'/config/laravel-appointments.php' => config_path('laravel-appointments.php'),
+            __DIR__ . '/config/laravel-appointments.php' => config_path('laravel-appointments.php'),
         ], 'config');
 
         // Publish Migrations
         $this->publishes([
-            __DIR__.'/database/migrations/' => database_path('migrations'),
+            __DIR__ . '/database/migrations/' => database_path('migrations'),
         ], 'migrations');
 
         // Publish Seeders
         $this->publishes([
-            __DIR__.'/database/seeders/' => database_path('seeders'),
+            __DIR__ . '/database/seeders/' => database_path('seeders'),
         ], 'seeders');
 
         // Publish Factories
         $this->publishes([
-            __DIR__.'/database/factories/' => database_path('factories'),
+            __DIR__ . '/database/factories/' => database_path('factories'),
         ], 'factories');
 
         // Publish Controllers
         $this->publishes([
-            __DIR__.'/Http/Controllers/' => app_path('Http/Controllers'),
+            __DIR__ . '/Http/Controllers/' => app_path('Http/Controllers'),
         ], 'controllers');
 
         // Publish Models
         $this->publishes([
-            __DIR__.'/Http/Models/' => app_path('Models'),
+            __DIR__ . '/Http/Models/' => app_path('Models'),
         ], 'models');
 
+        // Publish Traits
+        $this->publishes([
+            __DIR__ . '/Traits/' => app_path('Traits'),
+        ], 'traits');
+
+        // Publish Tests
+        $this->publishes([
+            __DIR__ . '/../Tests/' => base_path('Tests'),
+        ], 'tests');
+
         // Publish Notifications
         $this->publishes([
-            __DIR__.'/../Notifications/' => app_path('Notifications'),
+            __DIR__ . '/../Notifications/' => app_path('Notifications'),
         ], 'notifications');
 
         // Load Migrations
-        $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
+        $this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
     }
 
     public function register()
     {
         // Merge the configuration file
         $this->mergeConfigFrom(
-            __DIR__.'/config/laravel-appointments.php',
+            __DIR__ . '/config/laravel-appointments.php',
             'laravel-appointments'
         );
     }

src/Models/Appointment.php

@@ -9,15 +9,25 @@ class Appointment extends Model
 {
     use HasFactory;
 
-    protected $fillable = ['slot_id', 'user_id'];
+    protected $fillable = [
+        'slot_id',
+        'participant_id',
+        'participant_type' //  "Owner" or "Participant"
+    ];
 
-    public function slot() : \Illuminate\Database\Eloquent\Relations\BelongsTo
+    /**
+     * Define the polymorphic relationship with the participant.
+     */
+    public function participant()
     {
-        return $this->belongsTo(config('laravel-appointments.models.slot'));
+        return $this->morphTo(config('laravel-appointments.relationships.participant', 'participant'));
     }
 
-    public function user() : \Illuminate\Database\Eloquent\Relations\BelongsTo
+    /**
+     * The slot that this appointment belongs to.
+     */
+    public function slot(): \Illuminate\Database\Eloquent\Relations\BelongsTo
     {
-        return $this->belongsTo(config('laravel-appointments.models.user'));
+        return $this->belongsTo(config('laravel-appointments.models.slot'));
     }
 }

src/Models/Event.php

@@ -18,7 +18,7 @@ class Event extends Model
 
     public function slots()
     {
-        return $this->hasMany(config('laravel-appointments.models.slot'));
+        return $this->hasMany(\Codeitamarjr\LaravelAppointments\Models\Slot::class);
     }
 
     protected static function newFactory()

src/Traits/HasAppointments.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Codeitamarjr\LaravelAppointments\Traits;
+
+use Codeitamarjr\LaravelAppointments\Models\Appointment;
+
+trait HasAppointments
+{
+    /**
+     * Define the polymorphic relationship with appointments.
+     */
+    public function appointments()
+    {
+        return $this->morphMany(Appointment::class, 'participant');
+    }
+}