refactor(tests): extract some factory methods to trait

Simply to make it easier to customize factory classes in app-level

Signed-off-by: Fery Wardiyanto <[email protected]>

database/factories/BusinessFactory.php

@@ -2,17 +2,18 @@
 
 namespace Database\Factories;
 
-use Creasi\Base\Models\Address;
 use Creasi\Base\Models\Business;
-use Creasi\Base\Models\Enums\FileUploadType;
-use Creasi\Base\Models\FileUpload;
+use Creasi\Base\Models\Concerns\Factories;
 use Illuminate\Database\Eloquent\Factories\Factory;
 
 /**
  * @extends Factory<Business>
  */
 class BusinessFactory extends Factory
 {
+    use Factories\WithAddress;
+    use Factories\WithFileUpload;
+
     protected $model = Business::class;
 
     /**
@@ -27,16 +28,4 @@ public function definition(): array
             'summary' => $this->faker->sentence(4),
         ];
     }
-
-    public function withAddress(): static
-    {
-        return $this->has(Address::factory());
-    }
-
-    public function withFileUpload(FileUploadType $type = null): static
-    {
-        return $this->hasAttached(FileUpload::factory(), [
-            'type' => $type ?? $this->faker->randomElement(FileUploadType::cases()),
-        ], 'files');
-    }
 }

database/factories/PersonnelFactory.php

@@ -2,23 +2,20 @@
 
 namespace Database\Factories;
 
-use Creasi\Base\Models\Address;
-use Creasi\Base\Models\Business;
-use Creasi\Base\Models\Enums\EmploymentStatus;
-use Creasi\Base\Models\Enums\EmploymentType;
-use Creasi\Base\Models\Enums\FileUploadType;
+use Creasi\Base\Models\Concerns\Factories;
 use Creasi\Base\Models\Enums\Gender;
-use Creasi\Base\Models\FileUpload;
 use Creasi\Base\Models\Personnel;
-use Creasi\Base\Models\Profile;
-use DateTimeInterface;
 use Illuminate\Database\Eloquent\Factories\Factory;
 
 /**
  * @extends Factory<Personnel>
  */
 class PersonnelFactory extends Factory
 {
+    use Factories\AsPersonnel;
+    use Factories\WithAddress;
+    use Factories\WithFileUpload;
+
     protected $model = Personnel::class;
 
     /**
@@ -44,42 +41,4 @@ public function withoutUser(): static
             'user_id' => null,
         ]);
     }
-
-    public function withProfile(Gender $gender = null): static
-    {
-        return $this->has(Profile::factory(), 'profile')->state(fn () => [
-            'name' => $this->faker->firstName($gender?->toFaker()),
-        ]);
-    }
-
-    public function withCompany(
-        bool $primary = null,
-        EmploymentType $type = null,
-        EmploymentStatus $status = null,
-        false|DateTimeInterface $startDate = null,
-    ): static {
-        if (null === $startDate) {
-            $startDate = $this->faker->dateTime();
-        }
-
-        return $this->hasAttached(Business::factory(), [
-            'is_primary' => $primary,
-            'type' => $type ?? $this->faker->randomElement(EmploymentType::cases()),
-            'status' => $status ?? $this->faker->randomElement(EmploymentStatus::cases()),
-            'start_date' => $startDate?->format('Y-m-d'),
-            'finish_date' => null,
-        ], 'employers');
-    }
-
-    public function withAddress(): static
-    {
-        return $this->has(Address::factory());
-    }
-
-    public function withFileUpload(FileUploadType $type = null): static
-    {
-        return $this->hasAttached(FileUpload::factory(), [
-            'type' => $type ?? $this->faker->randomElement(FileUploadType::cases()),
-        ], 'files');
-    }
 }

database/factories/ProfileFactory.php

@@ -2,9 +2,7 @@
 
 namespace Database\Factories;
 
-use Creasi\Base\Models\Enums\Education;
-use Creasi\Base\Models\Enums\Religion;
-use Creasi\Base\Models\Enums\TaxStatus;
+use Creasi\Base\Models\Enums;
 use Creasi\Base\Models\Profile;
 use Creasi\Nusa\Models\Regency;
 use Illuminate\Contracts\Database\Query\Builder;
@@ -30,9 +28,9 @@ public function definition(): array
             'nik' => $nik = $this->faker->nik(null, $birthDate = $this->faker->dateTime()),
             'birth_date' => $birthDate->format('Y-m-d'),
             'birth_place_code' => $birthPlace->code,
-            'education' => $this->faker->randomElement(Education::cases()),
-            'religion' => $this->faker->randomElement(Religion::cases()),
-            'tax_status' => $this->faker->randomElement(TaxStatus::cases()),
+            'education' => $this->faker->randomElement(Enums\Education::cases()),
+            'religion' => $this->faker->randomElement(Enums\Religion::cases()),
+            'tax_status' => $this->faker->randomElement(Enums\TaxStatus::cases()),
             'tax_id' => $nik,
         ];
     }

database/factories/UserFactory.php

@@ -2,7 +2,7 @@
 
 namespace Database\Factories;
 
-use Creasi\Base\Models\Personnel;
+use Creasi\Base\Models\Concerns\Factories\WithIdentity;
 use Illuminate\Database\Eloquent\Factories\Factory;
 use Illuminate\Support\Str;
 
@@ -11,6 +11,8 @@
  */
 class UserFactory extends Factory
 {
+    use WithIdentity;
+
     public function modelName()
     {
         return app('creasi.base.user_model');
@@ -41,13 +43,4 @@ public function unverified(): static
             'email_verified_at' => null,
         ]);
     }
-
-    public function withIdentity(\Closure $cb = null): static
-    {
-        if ($cb === null) {
-            $cb = fn (PersonnelFactory $identity) => $identity->withProfile();
-        }
-
-        return $this->has($cb(Personnel::factory()), 'identity');
-    }
 }

src/Models/Business.php

@@ -12,7 +12,7 @@
  *
  * @method static \Database\Factories\BusinessFactory<static> factory()
  */
-class Business extends Entity implements HasTaxInfo, Company
+class Business extends Entity implements Company, HasTaxInfo
 {
     use AsCompany;
     use WithTaxInfo;

src/Models/Concerns/Factories/AsPersonnel.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Creasi\Base\Models\Concerns\Factories;
+
+use Creasi\Base\Models\Business;
+use Creasi\Base\Models\Enums;
+use Creasi\Base\Models\Profile;
+use DateTimeInterface;
+
+/**
+ * @mixin \Illuminate\Database\Eloquent\Factories\Factory
+ */
+trait AsPersonnel
+{
+    public function withProfile(Enums\Gender $gender = null): static
+    {
+        return $this->has(Profile::factory(), 'profile')->state(fn () => [
+            'name' => $this->faker->firstName($gender?->toFaker()),
+        ]);
+    }
+
+    public function withCompany(
+        bool $primary = null,
+        Enums\EmploymentType $type = null,
+        Enums\EmploymentStatus $status = null,
+        false|DateTimeInterface $startDate = null,
+    ): static {
+        if ($startDate === null) {
+            $startDate = $this->faker->dateTime();
+        }
+
+        return $this->hasAttached(Business::factory(), [
+            'is_primary' => $primary,
+            'type' => $type ?? $this->faker->randomElement(Enums\EmploymentType::cases()),
+            'status' => $status ?? $this->faker->randomElement(Enums\EmploymentStatus::cases()),
+            'start_date' => $startDate?->format('Y-m-d'),
+            'finish_date' => null,
+        ], 'employers');
+    }
+}

src/Models/Concerns/Factories/WithAddress.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Creasi\Base\Models\Concerns\Factories;
+
+use Creasi\Base\Models\Address;
+
+/**
+ * @mixin \Illuminate\Database\Eloquent\Factories\Factory
+ */
+trait WithAddress
+{
+    public function withAddress(): static
+    {
+        return $this->has(Address::factory());
+    }
+}

src/Models/Concerns/Factories/WithFileUpload.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Creasi\Base\Models\Concerns\Factories;
+
+use Creasi\Base\Models\Enums\FileUploadType;
+use Creasi\Base\Models\FileUpload;
+
+/**
+ * @mixin \Illuminate\Database\Eloquent\Factories\Factory
+ */
+trait WithFileUpload
+{
+    public function withFileUpload(FileUploadType $type = null): static
+    {
+        return $this->hasAttached(FileUpload::factory(), [
+            'type' => $type ?? $this->faker->randomElement(FileUploadType::cases()),
+        ], 'files');
+    }
+}

src/Models/Concerns/Factories/WithIdentity.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Creasi\Base\Models\Concerns\Factories;
+
+use Creasi\Base\Models\Personnel;
+use Database\Factories\PersonnelFactory;
+
+/**
+ * @mixin \Illuminate\Database\Eloquent\Factories\Factory
+ */
+trait WithIdentity
+{
+    public function withIdentity(\Closure $cb = null): static
+    {
+        if ($cb === null) {
+            $cb = fn (PersonnelFactory $identity) => $identity->withProfile();
+        }
+
+        return $this->has($cb(Personnel::factory()), 'identity');
+    }
+}