Merge pull request #30 from tenantcloud/next-major

Laravel 12

Author: tcmbilozub

.github/workflows/tests.yml

@@ -18,7 +18,7 @@ jobs:
             fail-fast: true
             matrix:
                 php: [8.2, 8.3]
-                test-bench: [^8.0, ^9.0]
+                test-bench: [^8.0, ^9.0, ^10.0]
 
         runs-on: packages
         container: chialab/php:${{ matrix.php }}
@@ -80,7 +80,7 @@ jobs:
             fail-fast: true
             matrix:
                 php: [8.2, 8.3]
-                test-bench: [^8.0, ^9.0]
+                test-bench: [^8.0, ^9.0, ^10.0]
 
         runs-on: packages
         container: chialab/php:${{ matrix.php }}

README.md

@@ -35,9 +35,9 @@ Also you can change default column name `is_deleted` to any other by setting sta
 Versions compatibility
 
 ```bash
-For Laravel 9 - laravel-boolean-softdeletes 4.*
 For Laravel 10 - laravel-boolean-softdeletes 5.*
 For Laravel 11 - laravel-boolean-softdeletes 6.*
+For Laravel 11 - laravel-boolean-softdeletes 7.*
 ```
 
 ## Change log

composer.json

@@ -4,21 +4,21 @@
 	"license": "MIT",
 	"require": {
 		"php": ">=8.2",
-		"illuminate/contracts": "^10.0|^11.0",
-		"illuminate/console": "^9.0|^10.0|^11.0",
-		"illuminate/database": "^9.0|^10.0|^11.0",
-		"illuminate/support": "^9.0|^10.0|^11.0"
+		"illuminate/contracts": "^10.0|^11.0|^12.0",
+		"illuminate/console": "^9.0|^10.0|^11.0|^12.0",
+		"illuminate/database": "^9.0|^10.0|^11.0|^12.0",
+		"illuminate/support": "^9.0|^10.0|^11.0|^12.0"
 	},
 	"require-dev": {
-		"pestphp/pest": "^2.8",
+		"pestphp/pest": "^2.8|^3.7",
 		"php-cs-fixer/shim": "^3.54",
 		"tenantcloud/php-cs-fixer-rule-sets": "~3.3.1",
-		"phpstan/phpstan": "~1.10.21",
-		"phpstan/phpstan-phpunit": "^1.3",
-		"phpstan/phpstan-webmozart-assert": "^1.2",
-		"phpstan/phpstan-mockery": "^1.1",
-		"nunomaduro/larastan": "^2.6",
-		"orchestra/testbench": "^8.5|^9.0"
+		"phpstan/phpstan": "~1.10.21|^2.1",
+		"phpstan/phpstan-phpunit": "^1.3|^2.0",
+		"phpstan/phpstan-webmozart-assert": "^1.2|^2.0",
+		"phpstan/phpstan-mockery": "^1.1|^2.0",
+		"nunomaduro/larastan": "^2.6|^3.1",
+		"orchestra/testbench": "^8.5|^9.0|^10.0"
 	},
 	"autoload": {
 		"psr-4": {

phpunit.xml

@@ -4,8 +4,8 @@
 		 colors="true"
 		 cacheDirectory=".phpunit.cache">
 	<testsuites>
-		<testsuite name="Test Suite">
-			<directory>./tests</directory>
+		<testsuite name="Feature">
+			<directory suffix="Test.php">./tests/Feature</directory>
 		</testsuite>
 	</testsuites>
 	<coverage/>
@@ -16,6 +16,7 @@
 	</source>
 	<php>
 		<env name="APP_ENV" value="testing"/>
-		<env name="DB_CONNECTION" value="testing"/>
+		<env name="DB_CONNECTION" value="sqlite"/>
+		<env name="DB_DATABASE" value=":memory:"/>
 	</php>
 </phpunit>

src/Commands/MigrateSoftDeletes.php

@@ -29,16 +29,26 @@ public function handle(): void
 	{
 		$table = $this->ask('Provide table name');
 
-		if (!Schema::hasTable($table)) {
+		if (!is_string($table) || !Schema::hasTable($table)) {
 			$this->error('Wrong table name. Try again, please');
+
+			return;
 		}
 
 		$field_name = $this->ask('Provide field name. If is_deleted than leave blank', 'is_deleted');
 
 		$old_field_name = $this->ask('Provide old field name. If deleted_at than leave blank', 'deleted_at');
 
+		if (!is_string($field_name) || !is_string($old_field_name)) {
+			$this->error('Wrong field name or old field name.');
+
+			return;
+		}
+
 		DB::table($table)->update([
-			$field_name => DB::raw("IF({$old_field_name} IS NULL, 0, 1)"),
+			$field_name => DB::raw("CASE WHEN {$old_field_name} IS NULL THEN 0 ELSE 1 END"),
 		]);
+
+		$this->info('Table has been migrated!');
 	}
 }

src/SoftDeletesBoolean.php

@@ -10,12 +10,8 @@
  */
 trait SoftDeletesBoolean
 {
-	/**
-	 * Indicates if the model is currently force deleting.
-	 *
-	 * @var bool
-	 */
-	protected $forceDeleting = false;
+	/** Indicates if the model is currently force deleting. */
+	protected bool $forceDeleting = false;
 
 	/**
 	 * Boot the soft deleting trait for a model.
@@ -28,7 +24,7 @@ public static function bootSoftDeletesBoolean(): void
 	/**
 	 * Force a hard delete on a soft deleted model.
 	 */
-	public function forceDelete(): ?bool
+	public function forceDelete(): bool
 	{
 		$this->forceDeleting = true;
 
@@ -38,13 +34,13 @@ public function forceDelete(): ?bool
 			if ($deleted) {
 				$this->fireModelEvent('forceDeleted', false);
 			}
-		});
+		}) ?? false;
 	}
 
 	/**
 	 * Restore a soft-deleted model instance.
 	 */
-	public function restore(): ?bool
+	public function restore(): bool
 	{
 		// If the restoring event does not return false, we will proceed with this
 		// restore operation. Otherwise, we bail out so the developer will stop
@@ -53,7 +49,7 @@ public function restore(): ?bool
 			return false;
 		}
 
-		$this->{$this->getIsDeletedColumn()} = 0;
+		$this->{$this->getIsDeletedColumn()} = false;
 
 		// Once we have saved the model, we will fire the "restored" event so this
 		// developer will do anything they need to after a restore operation is
@@ -77,30 +73,24 @@ public function trashed(): bool
 
 	/**
 	 * Register a restoring model event with the dispatcher.
-	 *
-	 * @param Closure|string $callback
 	 */
-	public static function restoring($callback)
+	public static function restoring(Closure|string $callback): void
 	{
 		static::registerModelEvent('restoring', $callback);
 	}
 
 	/**
 	 * Register a restored model event with the dispatcher.
-	 *
-	 * @param Closure|string|array $callback
 	 */
-	public static function restored($callback): void
+	public static function restored(Closure|string|array $callback): void
 	{
 		static::registerModelEvent('restored', $callback);
 	}
 
 	/**
 	 * Register a "forceDeleted" model event callback with the dispatcher.
-	 *
-	 * @param Closure|string|array $callback
 	 */
-	public static function forceDeleted($callback): void
+	public static function forceDeleted(Closure|string|array $callback): void
 	{
 		static::registerModelEvent('forceDeleted', $callback);
 	}
@@ -118,15 +108,17 @@ public function isForceDeleting(): bool
 	 */
 	public function getIsDeletedColumn(): string
 	{
-		return defined('static::IS_DELETED') ? constant('static::IS_DELETED') : 'is_deleted';
+		return defined(static::class . '::IS_DELETED')
+			? constant(static::class . '::IS_DELETED')
+			: 'is_deleted';
 	}
 
 	/**
 	 * Get the fully qualified "deleted at" column.
 	 */
 	public function getQualifiedIsDeletedColumn(): string
 	{
-		return $this->getTable() . '.' . $this->getIsDeletedColumn();
+		return "{$this->getTable()}.{$this->getIsDeletedColumn()}";
 	}
 
 	/**
@@ -137,7 +129,9 @@ protected function performDeleteOnModel(): ?bool
 		if ($this->forceDeleting) {
 			$this->exists = false;
 
-			return $this->newQueryWithoutScopes()->where($this->getKeyName(), $this->getKey())->forceDelete();
+			return (bool) $this->newQueryWithoutScopes()
+				->where($this->getKeyName(), $this->getKey())
+				->forceDelete();
 		}
 
 		$this->runSoftDelete();
@@ -151,17 +145,14 @@ protected function performDeleteOnModel(): ?bool
 	protected function runSoftDelete(): void
 	{
 		$query = $this->newQueryWithoutScopes()->where($this->getKeyName(), $this->getKey());
-
 		$time = $this->freshTimestamp();
 
-		$columns = [$this->getIsDeletedColumn() => 1];
-
-		$this->{$this->getIsDeletedColumn()} = 1;
-
-		if ($this->timestamps && null !== $this->getUpdatedAtColumn()) {
-			$this->{$this->getUpdatedAtColumn()} = $time;
+		$this->{$this->getIsDeletedColumn()} = true;
+		$columns = [$this->getIsDeletedColumn() => true];
 
-			$columns[$this->getUpdatedAtColumn()] = $this->fromDateTime($time);
+		if ($this->timestamps && ($updatedAt = $this->getUpdatedAtColumn()) !== null) {
+			$this->{$updatedAt} = $time;
+			$columns[$updatedAt] = $this->fromDateTime($time);
 		}
 
 		$query->update($columns);

testbench.yaml

@@ -0,0 +1,2 @@
+providers:
+    - Webkid\LaravelBooleanSoftdeletes\LaravelBooleanSoftdeletesServiceProvider

tests/Feature/MigrateSoftDeletesTest.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Tests\Feature;
+
+use Illuminate\Foundation\Testing\DatabaseMigrations;
+use Illuminate\Support\Facades\DB;
+use Orchestra\Testbench\Concerns\WithWorkbench;
+use Orchestra\Testbench\TestCase;
+use PHPUnit\Framework\Attributes\CoversClass;
+use Webkid\LaravelBooleanSoftdeletes\Commands\MigrateSoftDeletes;
+
+#[CoversClass(MigrateSoftDeletes::class)]
+class MigrateSoftDeletesTest extends TestCase
+{
+	use DatabaseMigrations;
+	use WithWorkbench;
+
+	/**
+	 * Setup the test environment.
+	 */
+	protected function setUp(): void
+	{
+		parent::setUp();
+
+		$this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
+	}
+
+	/**
+	 * Test the soft deletes migration command.
+	 */
+	public function testCommandMigratesSoftDeletes(): void
+	{
+		// Insert test data
+		DB::table('test_items')->insert([
+			['id' => 1, 'deleted_at' => null, 'is_deleted' => false],
+			['id' => 2, 'deleted_at' => now(), 'is_deleted' => false],
+		]);
+
+		// Run the command with mock user inputs
+		$this->artisan(MigrateSoftDeletes::class)
+			->expectsQuestion('Provide table name', 'test_items')
+			->expectsQuestion('Provide field name. If is_deleted than leave blank', 'is_deleted')
+			->expectsQuestion('Provide old field name. If deleted_at than leave blank', 'deleted_at')
+			->expectsOutput('Table has been migrated!')
+			->assertExitCode(0);
+
+		// Assert database updates
+		$this->assertDatabaseHas('test_items', ['id' => 1, 'is_deleted' => false]);
+		$this->assertDatabaseHas('test_items', ['id' => 2, 'is_deleted' => true]);
+	}
+}

tests/Feature/SoftDeletesBooleanTest.php

@@ -0,0 +1,89 @@
+<?php
+
+namespace Tests\Feature;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Foundation\Testing\DatabaseMigrations;
+use Orchestra\Testbench\Concerns\WithWorkbench;
+use Orchestra\Testbench\TestCase;
+use Webkid\LaravelBooleanSoftdeletes\SoftDeletesBoolean;
+
+/**
+ * Test case for the SoftDeletesBoolean trait.
+ */
+class SoftDeletesBooleanTest extends TestCase
+{
+	use DatabaseMigrations;
+	use WithWorkbench;
+
+	protected Model $model;
+
+	protected function setUp(): void
+	{
+		parent::setUp();
+
+		// Run migration for test model
+		$this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
+
+		$this->model = new class () extends Model {
+			use SoftDeletesBoolean;
+
+			public $timestamps = false;
+
+			protected $table = 'test_items';
+		};
+	}
+
+	public function testSoftDeletesModel(): void
+	{
+		$model = $this->model::create();
+
+		// Ensure model is not deleted initially
+		$this->assertFalse($model->trashed());
+
+		// Soft delete the model
+		$model->delete();
+
+		// Ensure it is marked as deleted
+		$this->assertTrue($model->trashed());
+		$this->assertDatabaseHas('test_items', ['id' => $model->id, 'is_deleted' => true]);
+	}
+
+	public function testRestoresSoftDeletedModel(): void
+	{
+		$model = $this->model::create();
+		$model->delete();
+
+		// Restore the model
+		$model->restore();
+
+		// Ensure it is no longer deleted
+		$this->assertFalse($model->trashed());
+		$this->assertDatabaseHas('test_items', ['id' => $model->id, 'is_deleted' => false]);
+	}
+
+	public function testForceDeletesModel(): void
+	{
+		$model = $this->model::create();
+
+		// Ensure the model exists
+		$this->assertDatabaseHas('test_items', ['id' => $model->id]);
+
+		// Force delete
+		$model->forceDelete();
+
+		// Ensure the model is completely removed from DB
+		$this->assertDatabaseMissing('test_items', ['id' => $model->id]);
+	}
+
+	public function testDoesNotForceDeleteIfSoftDeleted(): void
+	{
+		$model = $this->model::create();
+
+		// Soft delete
+		$model->delete();
+
+		// Ensure still exists but marked as deleted
+		$this->assertDatabaseHas('test_items', ['id' => $model->id, 'is_deleted' => true]);
+	}
+}