test: 🧪 add test

Author: edikurniawan-dev

tests/ArchTest.php

@@ -0,0 +1,90 @@
+<?php
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Config;
+
+it("add column userstamps", function (): void {
+  testUserstampsWorkflow();
+});
+
+it("add custom column userstamps", function (): void {
+  Config::set("userstamps.created_by_column", "creator");
+  Config::set("userstamps.updated_by_column", "editor");
+  Config::set("userstamps.deleted_by_column", "destroyer");
+
+  testUserstampsWorkflow();
+});
+
+function testUserstampsWorkflow(): void {
+  $columns = getColumnNames();
+
+  // Test userstamps creation
+  createTableWithUserstamps();
+  assertUserstampsExist($columns["created"], $columns["updated"]);
+
+  // Test soft userstamps
+  addSoftUserstamps();
+  assertSoftUserstampsExist($columns["deleted"]);
+
+  // Test userstamps removal
+  dropUserstamps();
+  assertUserstampsNotExist($columns["created"], $columns["updated"]);
+
+  // Test soft userstamps removal
+  dropSoftUserstamps();
+  assertSoftUserstampsNotExist($columns["deleted"]);
+}
+
+function getColumnNames(): array {
+  return [
+    "created" => Config::get("userstamps.created_by_column"),
+    "updated" => Config::get("userstamps.updated_by_column"),
+    "deleted" => Config::get("userstamps.deleted_by_column"),
+  ];
+}
+
+function createTableWithUserstamps(): void {
+  Schema::create("products", function (Blueprint $table): void {
+    $table->increments("id");
+    $table->userstamps();
+  });
+}
+
+function addSoftUserstamps(): void {
+  Schema::table("products", function (Blueprint $table): void {
+    $table->softUserstamps();
+  });
+}
+
+function dropUserstamps(): void {
+  Schema::table("products", function (Blueprint $table): void {
+    $table->dropUserstamps();
+  });
+}
+
+function dropSoftUserstamps(): void {
+  Schema::table("products", function (Blueprint $table): void {
+    $table->dropSoftUserstamps();
+  });
+}
+
+function assertUserstampsExist(string $createdColumn, string $updatedColumn): void {
+  $columns = Schema::getColumnlisting("products");
+  expect($columns)->toContain("{$createdColumn}_id", "{$createdColumn}_type");
+  expect($columns)->toContain("{$updatedColumn}_id", "{$updatedColumn}_type");
+}
+
+function assertSoftUserstampsExist(string $deletedColumn): void {
+  $columns = Schema::getColumnlisting("products");
+  expect($columns)->toContain("{$deletedColumn}_id", "{$deletedColumn}_type");
+}
+
+function assertUserstampsNotExist(string $createdColumn, string $updatedColumn): void {
+  $columns = Schema::getColumnlisting("products");
+  expect($columns)->not->toContain("{$createdColumn}_id", "{$createdColumn}_type");
+  expect($columns)->not->toContain("{$updatedColumn}_id", "{$updatedColumn}_type");
+}
+
+function assertSoftUserstampsNotExist(string $deletedColumn): void {
+  $columns = Schema::getColumnlisting("products");
+  expect($columns)->not->toContain("{$deletedColumn}_id", "{$deletedColumn}_type");
+}

tests/ExampleTest.php

@@ -0,0 +1,116 @@
+<?php
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Config;
+use SanSanLabs\Userstamps\Tests\Models\Product;
+use SanSanLabs\Userstamps\Tests\Models\UserWithId;
+use SanSanLabs\Userstamps\Tests\Models\UserWithUlid;
+use SanSanLabs\Userstamps\Tests\Models\UserWithUuid;
+
+beforeEach(function (): void {
+  Schema::create("products", function (Blueprint $table): void {
+    $table->id();
+    $table->string("name");
+    $table->timestamps();
+    $table->softDeletes();
+    $table->userstamps();
+    $table->softUserstamps();
+  });
+});
+
+// Helper function to test userstamps behavior
+function testUserstampsBehavior($john, $jane, $alice, $productName): void {
+  test()->actingAs($john);
+
+  $product = Product::create(["name" => $productName]);
+
+  // Test creation
+  expect($product->createdBy)->not()->toBeNull();
+  expect($product->updatedBy)->not()->toBeNull();
+  expect($product->deletedBy)->toBeNull();
+  expect($product->createdBy->email)->toBe($john->email);
+  expect($product->updatedBy->email)->toBe($john->email);
+
+  // Test deletion
+  test()->actingAs($jane);
+  $product->delete();
+  $product->refresh();
+
+  expect($product->deletedBy)->not()->toBeNull();
+  expect($product->updatedBy->email)->toBe($jane->email);
+  expect($product->deletedBy->email)->toBe($jane->email);
+
+  // Test restoration
+  test()->actingAs($alice);
+  $product->restore();
+  $product->refresh();
+
+  expect($product->deletedBy)->toBeNull();
+  expect($product->updatedBy->email)->toBe($alice->email);
+
+  // Test with trashed users
+  Config::set("userstamps.with_trashed", true);
+  $alice->delete();
+  $alice->refresh();
+  $product->refresh();
+
+  expect($product->updatedBy->email)->toBe($alice->email);
+}
+
+it("userstamps use id", function (): void {
+  Schema::create("user_with_ids", function (Blueprint $table): void {
+    $table->id();
+    $table->string("name");
+    $table->string("email")->unique();
+    $table->timestamps();
+    $table->softDeletes();
+  });
+
+  $users = [
+    UserWithId::create(["name" => "John Doe", "email" => "[email protected]"]),
+    UserWithId::create(["name" => "Jane Doe", "email" => "[email protected]"]),
+    UserWithId::create(["name" => "Alice Doe", "email" => "[email protected]"]),
+  ];
+
+  testUserstampsBehavior($users[0], $users[1], $users[2], "Test Product ID");
+});
+
+it("userstamps use ulid", function (): void {
+  Config::set("userstamps.users_table_id_column_type", "ulid");
+
+  Schema::create("user_with_ulids", function (Blueprint $table): void {
+    $table->ulid("id")->primary();
+    $table->string("name");
+    $table->string("email")->unique();
+    $table->timestamps();
+    $table->softDeletes();
+  });
+
+  $users = [
+    UserWithUlid::create(["name" => "John Doe", "email" => "[email protected]"]),
+    UserWithUlid::create(["name" => "Jane Doe", "email" => "[email protected]"]),
+    UserWithUlid::create(["name" => "Alice Doe", "email" => "[email protected]"]),
+  ];
+
+  testUserstampsBehavior($users[0], $users[1], $users[2], "Test Product ULID");
+});
+
+it("userstamps use uuid", function (): void {
+  Config::set("userstamps.users_table_id_column_type", "uuid");
+
+  Schema::create("user_with_uuids", function (Blueprint $table): void {
+    $table->uuid("id")->primary();
+    $table->string("name");
+    $table->string("email")->unique();
+    $table->timestamps();
+    $table->softDeletes();
+  });
+
+  $users = [
+    UserWithUuid::create(["name" => "John Doe", "email" => "[email protected]"]),
+    UserWithUuid::create(["name" => "Jane Doe", "email" => "[email protected]"]),
+    UserWithUuid::create(["name" => "Alice Doe", "email" => "[email protected]"]),
+  ];
+
+  testUserstampsBehavior($users[0], $users[1], $users[2], "Test Product UUID");
+});

tests/Feature/DatabaseMacrcoTest.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace SanSanLabs\Userstamps\Tests\Models;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use SanSanLabs\Userstamps\Concerns\HasUserstamps;
+
+class Product extends Model {
+  use HasUserstamps;
+  use SoftDeletes;
+
+  /**
+   * The attributes that are mass assignable.
+   *
+   * @var array
+   */
+  protected $fillable = ["name"];
+}

tests/Feature/UserstampsTest.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace SanSanLabs\Userstamps\Tests\Models;
+
+use Illuminate\Database\Eloquent\SoftDeletes;
+use Illuminate\Foundation\Auth\User as Authenticatable;
+
+class UserWithId extends Authenticatable {
+  use SoftDeletes;
+
+  protected $fillable = ["name", "email"];
+}

tests/Models/Product.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace SanSanLabs\Userstamps\Tests\Models;
+
+use Illuminate\Database\Eloquent\Concerns\HasUlids;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use Illuminate\Foundation\Auth\User as Authenticatable;
+
+class UserWithUlid extends Authenticatable {
+  use HasUlids;
+  use SoftDeletes;
+
+  protected $fillable = ["name", "email"];
+}

tests/Models/UserWithId.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace SanSanLabs\Userstamps\Tests\Models;
+
+use Illuminate\Database\Eloquent\Concerns\HasUuids;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use Illuminate\Foundation\Auth\User as Authenticatable;
+
+class UserWithUuid extends Authenticatable {
+  use HasUuids;
+  use SoftDeletes;
+
+  protected $fillable = ["name", "email"];
+}

tests/Models/UserWithUlid.php

@@ -1,5 +1,5 @@
 <?php
 
-use VendorName\Skeleton\Tests\TestCase;
+use SanSanLabs\Userstamps\Tests\TestCase;
 
 uses(TestCase::class)->in(__DIR__);

tests/Models/UserWithUuid.php

@@ -1,29 +1,16 @@
 <?php
 
-namespace VendorName\Skeleton\Tests;
+namespace SanSanLabs\Userstamps\Tests;
 
-use Illuminate\Database\Eloquent\Factories\Factory;
 use Orchestra\Testbench\TestCase as Orchestra;
-use VendorName\Skeleton\SkeletonServiceProvider;
+use SanSanLabs\Userstamps\UserstampsServiceProvider;
 
 class TestCase extends Orchestra {
   protected function setUp(): void {
     parent::setUp();
-
-    Factory::guessFactoryNamesUsing(fn(string $modelName) => "VendorName\\Skeleton\\Database\\Factories\\" . class_basename($modelName) . "Factory");
-  }
-
-  protected function getPackageProviders($app) {
-    return [SkeletonServiceProvider::class];
   }
 
-  public function getEnvironmentSetUp($app) {
-    config()->set("database.default", "testing");
-
-    /*
-         foreach (\Illuminate\Support\Facades\File::allFiles(__DIR__ . '/database/migrations') as $migration) {
-            (include $migration->getRealPath())->up();
-         }
-         */
+  protected function getPackageProviders($app): array {
+    return [UserstampsServiceProvider::class];
   }
 }