Merge branch 'release/2.0.0' into main

lindyhopchris · lindyhopchris · commit 0832af0b021e · 2023-06-20T17:46:57.000+01:00
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -14,15 +14,12 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.4, '8.0', 8.1]
-        laravel: [8.76, 9]
-        exclude:
-          - php: 7.4
-            laravel: 9
+        php: [8.1, 8.2]
+        laravel: [10]
 
     steps:
     - name: Checkout Code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
@@ -31,13 +28,13 @@ 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
 
     - name: Install dependencies
-      uses: nick-invision/retry@v1
+      uses: nick-fields/retry@v2
       with:
         timeout_minutes: 5
         max_attempts: 5
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## [2.0.0] - 2023-06-20
+
+### Changed
+
+- 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
 
 ### Added
diff --git a/composer.json b/composer.json
@@ -23,14 +23,14 @@
         }
     ],
     "require": {
-        "php": "^7.4|^8.0",
-        "illuminate/support": "^8.0|^9.0",
-        "laravel-json-api/eloquent": "^1.0.1|^2.0",
-        "tenantcloud/laravel-boolean-softdeletes": "^3.1|^4.0"
+        "php": "^8.1",
+        "illuminate/support": "^10.0",
+        "laravel-json-api/eloquent": "^3.0",
+        "tenantcloud/laravel-boolean-softdeletes": "^5.0"
     },
     "require-dev": {
-        "orchestra/testbench": "^6.23|^7.0",
-        "phpunit/phpunit": "^9.5.10"
+        "orchestra/testbench": "^8.0",
+        "phpunit/phpunit": "^9.6.9"
     },
     "autoload": {
         "psr-4": {
@@ -46,10 +46,10 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-develop": "1.x-dev"
+            "dev-develop": "2.x-dev"
         }
     },
-    "minimum-stability": "dev",
+    "minimum-stability": "stable",
     "prefer-stable": true,
     "config": {
         "sort-packages": true
diff --git a/src/Drivers/SoftDeleteBooleanDriver.php b/src/Drivers/SoftDeleteBooleanDriver.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * 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.
@@ -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
diff --git a/src/SoftDeletesBoolean.php b/src/SoftDeletesBoolean.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * 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.
diff --git a/tests/app/Models/Post.php b/tests/app/Models/Post.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * 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.
diff --git a/tests/app/Schemas/PostSchema.php b/tests/app/Schemas/PostSchema.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * 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.
diff --git a/tests/database/factories/PostFactory.php b/tests/database/factories/PostFactory.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * 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.
diff --git a/tests/database/migrations/2021_04_23_1032_create_post_table.php b/tests/database/migrations/2021_04_23_1032_create_post_table.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * 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.
diff --git a/tests/lib/Acceptance/Test.php b/tests/lib/Acceptance/Test.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * 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.
diff --git a/tests/lib/Acceptance/TestCase.php b/tests/lib/Acceptance/TestCase.php
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * 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.
diff --git a/tests/lib/Unit/.gitkeep b/tests/lib/Unit/.gitkeep
diff --git a/tests/lib/Unit/Drivers/SoftDeleteBooleanDriverTest.php b/tests/lib/Unit/Drivers/SoftDeleteBooleanDriverTest.php
@@ -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);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`<?php`
`2`	`2`	`/*`
`3`		`- * Copyright 2022 Cloud Creativity Limited`
	`3`	`+ * Copyright 2023 Cloud Creativity Limited`
`4`	`4`	`*`
`5`	`5`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`6`	`6`	`* you may not use this file except in compliance with the License.`