Setup model factory and their tests

Author: veeqtoh

database/migrations/2023_08_04_200132_create_door_access_codes_table.php

@@ -11,10 +11,17 @@
      */
     public function up(): void
     {
-        Schema::create('door_access_codes', function (Blueprint $table) {
-            $table->id();
-            $table->string('code')->unique();
-            $table->string('team_member_id')->nullable();
+        Schema::connection(config('door-access.connection'))->create('access_codes', function (Blueprint $table) {
+            $table->bigIncrements('id');
+            $table->string('code')->unique()->when(
+                Schema::getConnection()->getConfig('driver') === 'mysql',
+                function (Blueprint $column) {
+                    $column->collation('utf8mb4_bin');
+                }
+            );
+            $table->string('owner_id')->nullable();
+            $table->timestamp('allocated_at')->nullable();
+            $table->timestamp('reset_at')->nullable();
             $table->timestamps();
         });
     }
@@ -24,6 +31,6 @@ public function up(): void
      */
     public function down(): void
     {
-        Schema::dropIfExists('door_access_codes');
+        Schema::connection(config('door-access.connection'))->dropIfExists('access_codes');
     }
 };

src/Models/AccessCode.php

@@ -0,0 +1,93 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Veeqtoh\DoorAccess\Models;
+
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Collection;
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @property int $id
+ * @property string $owner_id
+ * @property ?Carbon $allocated_at
+ * @property ?Carbon $reset_at
+ * @property Carbon $created_at
+ * @property Carbon $updated_at
+ */
+class AccessCode extends Model
+{
+    use HasFactory;
+
+    /**
+     * The table associated with the model.
+     *
+     * @var string
+     */
+    protected $table = 'access_codes';
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array<int,string>
+     */
+    protected $fillable = [
+        'owner_id',
+        'allocated_at',
+        'reset_at',
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array<string, string>
+     */
+    protected $casts = [
+        'allocated_at' => 'datetime',
+        'reset_at'     => 'datetime',
+    ];
+
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+
+        if (config('door-access.connection')) {
+            $this->setConnection(config('door-access.connection'));
+        }
+    }
+
+    /**
+     * @return Factory<AccessCode>
+     */
+    protected static function newFactory()
+    {
+        $factoryConfig = config('door-access.factories');
+
+        $modelFactory = app($factoryConfig[__CLASS__]);
+
+        return $modelFactory::new();
+    }
+
+    /**
+     * A helper method that can be used for finding a AccessCode model with the
+     * given code key.
+     */
+    public static function findByCode(string $code): ?self
+    {
+        return self::where('code', $code)->first();
+    }
+
+    /**
+     * A helper method that can be used for finding all the AccessCode models
+     * with the given owner id.
+     *
+     * @return Collection<int, AccessCode>
+     */
+    public static function findByOwnerId(string $ownerId): Collection
+    {
+        return self::where('owner_id', $ownerId)->get();
+    }
+}

src/Models/Factories/AccessCode.php

@@ -5,6 +5,7 @@
 namespace Veeqtoh\DoorAccess\Models\Factories;
 
 use Illuminate\Database\Eloquent\Factories\Factory;
+use Veeqtoh\DoorAccess\Classes\CodeGenerator;
 use Veeqtoh\DoorAccess\Models\AccessCode;
 
 /**
@@ -14,8 +15,37 @@ class AccessCodeFactory extends Factory
 {
     protected $model = AccessCode::class;
 
-    public function definition()
+    public function definition(): array
     {
+        $generator = new CodeGenerator();
+        $code      = $generator->generate();
+
+        return [
+            'code'         => $code,
+            'owner_id'     => $this->faker->randomDigit(),
+            'allocated_at' => now(),
+            'reset_at'     => null,
+            'created_at'   => now(),
+            'updated_at'   => now(),
+        ];
+    }
+
+    public function deactivated(): AccessCodeFactory
+    {
+        return $this->state(function () {
+            return [
+                'reset_at' => now()->subDay(),
+            ];
+        });
     }
 
+    public function inactive(): AccessCodeFactory
+    {
+        return $this->state(function () {
+            return [
+                'allocated_at' => null,
+                'reset_at'     => null,
+            ];
+        });
+    }
 }

src/Models/Factories/AccessCodeFactory.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Veeqtoh\DoorAccess\Tests\Unit\Models\AccessCode;
+
+use Veeqtoh\DoorAccess\Models\AccessCode;
+use Veeqtoh\DoorAccess\Tests\Unit\TestCase;
+
+final class AccessCodeFactoryTest extends TestCase
+{
+    public function test_that_the_access_code_model_factory_works_fine(): void
+    {
+        $accessCode = AccessCode::factory()->create();
+
+        $deactivatedAccessCode = AccessCode::factory()->deactivated()->create();
+
+        $inactiveAccessCode = AccessCode::factory()->inactive()->create();
+
+        $this->assertDatabaseCount('access_codes', 3)
+            ->assertModelExists($accessCode)
+            ->assertModelExists($deactivatedAccessCode)
+            ->assertModelExists($inactiveAccessCode);
+
+        $this->assertTrue($accessCode->allocated_at !== null && $accessCode->reset_at == null);
+        $this->assertTrue($deactivatedAccessCode->allocated_at !== null && $deactivatedAccessCode->reset_at !== null);
+        $this->assertTrue($inactiveAccessCode->allocated_at == null && $inactiveAccessCode->reset_at == null);
+    }
+}

tests/Unit/Models/AccessCodeFactoryTest.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Veeqtoh\DoorAccess\Tests\Unit\Models\AccessCode;
+
+use PHPUnit\Framework\Attributes\Test;
+use Veeqtoh\DoorAccess\Models\AccessCode;
+use Veeqtoh\DoorAccess\Tests\Unit\TestCase;
+
+final class AccessCodeTest extends TestCase
+{
+    #[Test]
+    public function connection_can_be_overridden(): void
+    {
+        config(['door-access.connection' => 'custom']);
+
+        $this->assertEquals(
+            'custom',
+            (new AccessCode())->getConnectionName(),
+        );
+    }
+
+    #[Test]
+    public function default_connection_is_used_if_the_override_is_not_set(): void
+    {
+        $this->assertNull((new AccessCode())->getConnectionName());
+    }
+}

tests/Unit/Models/AccessCodeTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Veeqtoh\DoorAccess\Tests\Unit\Models\AccessCode;
+
+use Carbon\Carbon;
+use PHPUnit\Framework\Attributes\Test;
+use Veeqtoh\DoorAccess\Models\AccessCode;
+use Veeqtoh\DoorAccess\Tests\Unit\TestCase;
+
+final class CastsTest extends TestCase
+{
+    #[Test]
+    public function carbon_date_objects_are_returned(): void
+    {
+        $accessCode = AccessCode::factory()
+            ->create([
+                'allocated_at' => now(),
+                'reset_at'     => now(),
+                'created_at'   => now(),
+                'updated_at'   => now(),
+            ]);
+
+        $accessCode->refresh();
+
+        $this->assertInstanceOf(Carbon::class, $accessCode->allocated_at);
+        $this->assertInstanceOf(Carbon::class, $accessCode->reset_at);
+        $this->assertInstanceOf(Carbon::class, $accessCode->created_at);
+        $this->assertInstanceOf(Carbon::class, $accessCode->updated_at);
+    }
+}