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

Itamar Junior · Itamar Junior · commit a55400c26ab1 · 2024-12-21T13:36:44.000+01:00
diff --git a/README.md b/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
diff --git a/composer.json b/composer.json
@@ -29,6 +29,11 @@
       "Codeitamarjr\\LaravelAppointments\\": "src/"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "Tests\\": "tests/"
+    }
+  },
   "extra": {
     "laravel": {
       "providers": [
diff --git a/src/Database/Factories/AppointmentFactory.php b/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'),
         ];
     }
 }
diff --git a/src/Database/Factories/SlotFactory.php b/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]),
         ];
     }
diff --git a/src/Database/Migrations/2024_12_18_133759_create_appointments_table.php b/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');
         });
     }
 
diff --git a/src/Database/Seeders/EventSeeder.php b/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();
     }
 }
diff --git a/src/LaravelAppointmentServiceProvider.php b/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'
         );
     }
diff --git a/src/Models/Appointment.php b/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'));
     }
 }
diff --git a/src/Models/Event.php b/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()
diff --git a/src/Traits/HasAppointments.php b/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');
+    }
+}
diff --git a/src/config/laravel-appointments.php b/src/config/laravel-appointments.php
@@ -4,9 +4,10 @@
     'default_duration' => 30, // Default duration for events in minutes
     'notification_class' => \Codeitamarjr\LaravelAppointments\Notifications\AppointmentNotification::class,
     'models' => [
-        'event' => \Codeitamarjr\LaravelAppointments\Models\Event::class,
-        'slot' => \Codeitamarjr\LaravelAppointments\Models\Slot::class,
-        'appointment' => \Codeitamarjr\LaravelAppointments\Models\Appointment::class,
+        'participant' => Object::class, // Default participant model(Ex: App\Models\User::class)
+    ],
+    'relationships' => [
+        'participant' => 'participant', // Default relationship name
     ],
 ];
 
diff --git a/tests/EventTest.php b/tests/EventTest.php
diff --git a/tests/Feature/AppointmentWorkflowTest.php b/tests/Feature/AppointmentWorkflowTest.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Tests\Feature;
+
+use Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
+use Codeitamarjr\LaravelAppointments\Models\Event;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+
+class AppointmentWorkflowTest extends TestCase
+{
+    use RefreshDatabase;
+
+    #[Test]
+    public function it_can_create_an_event_with_slots_and_book_appointments()
+    {
+        // Create an Event
+        $event = Event::factory()->create(['title' => 'Test Event']);
+
+        // Add Slots to the Event
+        $slots = $event->slots()->createMany([
+            ['start_time' => now(), 'end_time' => now()->addMinutes(30), 'attendees_limit' => 5],
+            ['start_time' => now()->addHours(1), 'end_time' => now()->addHours(1)->addMinutes(30), 'attendees_limit' => 5],
+        ]);
+
+        // Book an Appointment for the First Slot
+        $slot = $slots->first();
+        $slot->appointments()->create([
+            'participant_id' => 1,
+            'participant_type' => \App\Models\User::class,
+        ]);
+
+        // Assertions
+        $this->assertDatabaseHas('events', ['id' => $event->id, 'title' => 'Test Event']);
+        $this->assertDatabaseHas('slots', ['event_id' => $event->id, 'attendees_limit' => 5]);
+        $this->assertDatabaseHas('appointments', ['slot_id' => $slot->id, 'participant_id' => 1]);
+    }
+}
diff --git a/tests/Unit/AppointmentTest.php b/tests/Unit/AppointmentTest.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace Tests\Unit;
+
+use Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Codeitamarjr\LaravelAppointments\Models\Appointment;
+
+class AppointmentTest extends TestCase
+{
+    use RefreshDatabase;
+
+    #[Test]
+    public function it_belongs_to_a_slot()
+    {
+        $appointment = Appointment::factory()->create();
+
+        $this->assertNotNull($appointment->slot);
+    }
+
+    /** @test */
+    public function it_belongs_to_a_participant()
+    {
+        $appointment = Appointment::factory()->create();
+
+        $this->assertNotNull($appointment->participant);
+    }
+}
diff --git a/tests/Unit/EventTest.php b/tests/Unit/EventTest.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace Tests\Unit;
+
+use Tests\TestCase;
+use PHPUnit\Framework\Attributes\Test;
+use Codeitamarjr\LaravelAppointments\Models\Event;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+
+class EventTest extends TestCase
+{
+    use RefreshDatabase;
+
+    #[Test]
+    public function it_can_create_an_event()
+    {
+        $event = Event::factory()->create(['title' => 'Test Event']);
+
+        $this->assertDatabaseHas('events', ['title' => 'Test Event']);
+    }
+
+    #[Test]
+    public function it_can_have_slots()
+    {
+        $event = Event::factory()->create();
+        $event->slots()->createMany([
+            ['start_time' => now(), 'end_time' => now()->addMinutes(30), 'attendees_limit' => 5],
+            ['start_time' => now()->addHours(1), 'end_time' => now()->addHours(1)->addMinutes(30), 'attendees_limit' => 5],
+        ]);
+
+        $this->assertCount(2, $event->slots);
+    }
+}
diff --git a/tests/Unit/SlotTest.php b/tests/Unit/SlotTest.php

Original file line number	Diff line number	Diff line change
`@@ -4,10 +4,11 @@`
`4`	`4`
`5`	`5`	`use Codeitamarjr\LaravelAppointments\Models\Appointment;`
`6`	`6`	`use Illuminate\Database\Eloquent\Factories\Factory;`
	`7`	`+use Codeitamarjr\LaravelAppointments\Models\Slot;`
`7`	`8`
`8`	`9`
`9`	`10`	`/**`
`10`		`- * @extends \Illuminate\Database\Eloquent\Factories\Factory<\App\Models\Appointment>`
	`11`	`+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\Codeitamarjr\LaravelAppointments\Models\Appointment>`
`11`	`12`	`*/`
`12`	`13`	`class AppointmentFactory extends Factory`
`13`	`14`	`{`
`@@ -22,7 +23,8 @@ public function definition(): array`
`22`	`23`	`{`
`23`	`24`	`return [`
`24`	`25`	`'slot_id' => Slot::factory(),`
`25`		`- 'user_id' => \App\Models\User::factory(), // Adjust based on your user model namespace`
	`26`	`+ 'participant_id' => config('laravel-appointments.models.participant')::factory(),`
	`27`	`+ 'participant_type' => config('laravel-appointments.relationships.participant', 'participant'),`
`26`	`28`	`];`
`27`	`29`	`}`
`28`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,11 @@ public function up(): void`
`13`	`13`	`{`
`14`	`14`	`Schema::create('appointments', function (Blueprint $table) {`
`15`	`15`	`$table->id();`
`16`		`- $table->foreignId('slot_id')->constrained()->cascadeOnDelete();`
`17`		`- $table->foreignId('user_id')->constrained()->cascadeOnDelete();`
	`16`	`+ $table->unsignedBigInteger('slot_id');`
	`17`	`+ $table->morphs('participant'); // Adds participant_id and participant_type`
`18`	`18`	`$table->timestamps();`
	`19`	`+`
	`20`	`+ $table->foreign('slot_id')->references('id')->on('slots')->onDelete('cascade');`
`19`	`21`	`});`
`20`	`22`	`}`
`21`	`23`
Original file line number	Diff line number	Diff line change
`@@ -7,15 +7,12 @@`
`7`	`7`
`8`	`8`	`class EventSeeder extends Seeder`
`9`	`9`	`{`
`10`		`- /**`
`11`		`- * Run the database seeds.`
`12`		`- */`
`13`	`10`	`public function run(): void`
`14`	`11`	`{`
`15`		`- Event::factory(5)`
`16`		`- ->hasSlots(3)`
`17`		`- ->hasSlots(3, [`
`18`		`- 'attendees_limit' => 5`
`19`		`- ])->create();`
	`12`	`+ // Create 5 events, each with 3 slots`
	`13`	`+ Event::factory()`
	`14`	`+ ->count(5)`
	`15`	`+ ->hasSlots(3, ['attendees_limit' => 5])`
	`16`	`+ ->create();`
`20`	`17`	`}`
`21`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,15 +9,25 @@ class Appointment extends Model`
`9`	`9`	`{`
`10`	`10`	`use HasFactory;`
`11`	`11`
`12`		`- protected $fillable = ['slot_id', 'user_id'];`
	`12`	`+ protected $fillable = [`
	`13`	`+ 'slot_id',`
	`14`	`+ 'participant_id',`
	`15`	`+ 'participant_type' // "Owner" or "Participant"`
	`16`	`+ ];`
`13`	`17`
`14`		`- public function slot() : \Illuminate\Database\Eloquent\Relations\BelongsTo`
	`18`	`+ /**`
	`19`	`+ * Define the polymorphic relationship with the participant.`
	`20`	`+ */`
	`21`	`+ public function participant()`
`15`	`22`	`{`
`16`		`- return $this->belongsTo(config('laravel-appointments.models.slot'));`
	`23`	`+ return $this->morphTo(config('laravel-appointments.relationships.participant', 'participant'));`
`17`	`24`	`}`
`18`	`25`
`19`		`- public function user() : \Illuminate\Database\Eloquent\Relations\BelongsTo`
	`26`	`+ /**`
	`27`	`+ * The slot that this appointment belongs to.`
	`28`	`+ */`
	`29`	`+ public function slot(): \Illuminate\Database\Eloquent\Relations\BelongsTo`
`20`	`30`	`{`
`21`		`- return $this->belongsTo(config('laravel-appointments.models.user'));`
	`31`	`+ return $this->belongsTo(config('laravel-appointments.models.slot'));`
`22`	`32`	`}`
`23`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ class Event extends Model`
`18`	`18`
`19`	`19`	`public function slots()`
`20`	`20`	`{`
`21`		`- return $this->hasMany(config('laravel-appointments.models.slot'));`
	`21`	`+ return $this->hasMany(\Codeitamarjr\LaravelAppointments\Models\Slot::class);`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`protected static function newFactory()`