refactor: use assert in driver constructor

Author: lindyhopchris

.github/workflows/tests.yml

@@ -28,7 +28,7 @@ jobs:
         extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, gd
         tools: composer:v2
         coverage: none
-        ini-values: error_reporting=E_ALL
+        ini-values: error_reporting=E_ALL, zend.assertions=1
 
     - name: Set Laravel Version
       run: composer require "laravel/framework:^${{ matrix.laravel }}" --no-update -n

CHANGELOG.md

@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file. This projec
 
 - Upgraded to Laravel 10.
 - Minimum PHP version is now 8.1.
+- Use `assert()` to ensure the soft delete boolean driver receives the correct type of model.
 
 ## [1.1.0] - 2022-09-14
 

src/Drivers/SoftDeleteBooleanDriver.php

@@ -21,24 +21,23 @@
 
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
-use InvalidArgumentException;
 use LaravelJsonApi\Eloquent\Drivers\StandardDriver;
 use Webkid\LaravelBooleanSoftdeletes\SoftDeletesBoolean;
 use function boolval;
 
 class SoftDeleteBooleanDriver extends StandardDriver
 {
-
     /**
      * SoftDeleteDriver constructor.
      *
-     * @param Model|SoftDeletesBoolean $model
+     * @param Model&SoftDeletesBoolean $model
      */
     public function __construct($model)
     {
-        if (!in_array(SoftDeletesBoolean::class, class_uses_recursive($model), true)) {
-            throw new InvalidArgumentException('Expecting a model that is boolean soft-deletable.');
-        }
+        assert(
+            in_array(SoftDeletesBoolean::class, class_uses_recursive($model), true),
+            'Expecting a model that is boolean soft-deletable.',
+        );
 
         parent::__construct($model);
     }
@@ -91,7 +90,7 @@ public function destroy(Model $model): bool
     }
 
     /**
-     * @param Model|SoftDeletesBoolean $model
+     * @param Model&SoftDeletesBoolean $model
      * @return bool
      */
     private function restore(Model $model): bool
@@ -102,7 +101,7 @@ private function restore(Model $model): bool
     /**
      * Will the hydration operation restore the model?
      *
-     * @param Model|SoftDeletesBoolean $model
+     * @param Model&SoftDeletesBoolean $model
      * @return bool
      */
     private function willRestore(Model $model): bool
@@ -119,7 +118,7 @@ private function willRestore(Model $model): bool
     /**
      * Will the hydration operation result in the model being soft deleted?
      *
-     * @param Model|SoftDeletesBoolean $model
+     * @param Model&SoftDeletesBoolean $model
      * @return bool
      */
     private function willSoftDelete(Model $model): bool

tests/lib/Unit/.gitkeep

@@ -0,0 +1,43 @@
+<?php
+/*
+ * Copyright 2023 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\BooleanSoftDeletes\Tests\Unit\Drivers;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use LaravelJsonApi\BooleanSoftDeletes\Drivers\SoftDeleteBooleanDriver;
+use PHPUnit\Framework\TestCase;
+
+class SoftDeleteBooleanDriverTest extends TestCase
+{
+    /**
+     * @return void
+     */
+    public function testModelMustHaveBooleanSoftDeletesTrait(): void
+    {
+        $model = new class extends Model {
+            use SoftDeletes;
+        };
+
+        $this->expectException(\AssertionError::class);
+        $this->expectExceptionMessage('Expecting a model that is boolean soft-deletable.');
+
+        new SoftDeleteBooleanDriver($model);
+    }
+}