Merge branch 'develop' into next

Author: lindyhopchris

.github/workflows/tests.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [8.2, 8.3]
+        php: [8.2, 8.3, 8.4]
         laravel: [11]
 
     steps:

CHANGELOG.md

@@ -18,6 +18,31 @@ All notable changes to this project will be documented in this file. This projec
 
 ## Unreleased
 
+## [5.0.0] - 2024-11-29
+
+### Added
+
+- **BREAKING**: [#21](https://github.com/laravel-json-api/core/pull/21) The `Authorizer` contract now allows all methods
+  to return a `bool` or an Illuminate authorization response.
+
+## [4.3.1] - 2024-11-29
+
+### Fixed
+
+- Reverted [#19](https://github.com/laravel-json-api/core/pull/19) as the changes were breaking, so should not have been
+  released as a minor version.
+
+## [4.3.0] - 2024-11-26
+
+### Added
+
+- [#19](https://github.com/laravel-json-api/core/pull/19) The `Authorizer` contract now allows all methods to return a
+  `bool` or an authorizer response.
+
+### Fixed
+
+- Removed deprecation notices in PHP 8.4.
+
 ## [4.2.0] - 2024-08-21
 
 ### Added

composer.json

@@ -25,7 +25,7 @@
     "require": {
         "php": "^8.2",
         "ext-json": "*",
-        "illuminate/auth": "^11.0",
+        "illuminate/auth": "^11.33",
         "illuminate/contracts": "^11.0",
         "illuminate/http": "^11.0",
         "illuminate/pipeline": "^11.0",
@@ -47,8 +47,8 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-develop": "4.x-dev",
-            "dev-next": "5.x-dev"
+            "dev-develop": "5.x-dev",
+            "dev-next": "6.x-dev"
         }
     },
     "minimum-stability": "stable",

phpunit.xml

@@ -13,6 +13,7 @@
          failOnWarning="true"
          failOnDeprecation="true"
          failOnNotice="true"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
 >
   <coverage/>
   <testsuites>

src/Contracts/Auth/Authorizer.php

@@ -11,6 +11,7 @@
 
 namespace LaravelJsonApi\Contracts\Auth;
 
+use Illuminate\Auth\Access\Response;
 use Illuminate\Auth\Access\AuthorizationException;
 use Illuminate\Auth\AuthenticationException;
 use Illuminate\Http\Request;
@@ -25,95 +26,95 @@ interface Authorizer
      *
      * @param Request|null $request
      * @param string $modelClass
-     * @return bool
+     * @return bool|Response
      */
-    public function index(?Request $request, string $modelClass): bool;
+    public function index(?Request $request, string $modelClass): bool|Response;
 
     /**
      * Authorize a JSON:API store operation.
      *
      * @param Request|null $request
      * @param string $modelClass
-     * @return bool
+     * @return bool|Response
      */
-    public function store(?Request $request, string $modelClass): bool;
+    public function store(?Request $request, string $modelClass): bool|Response;
 
     /**
      * Authorize a JSON:API show query.
      *
      * @param Request|null $request
      * @param object $model
-     * @return bool
+     * @return bool|Response
      */
-    public function show(?Request $request, object $model): bool;
+    public function show(?Request $request, object $model): bool|Response;
 
     /**
      * Authorize the update controller action.
      *
      * @param object $model
      * @param Request $request
-     * @return bool
+     * @return bool|Response
      */
-    public function update(Request $request, object $model): bool;
+    public function update(Request $request, object $model): bool|Response;
 
     /**
      * Authorize the destroy controller action.
      *
      * @param Request $request
      * @param object $model
-     * @return bool
+     * @return bool|Response
      */
-    public function destroy(Request $request, object $model): bool;
+    public function destroy(Request $request, object $model): bool|Response;
 
     /**
      * Authorize the show-related controller action.
      *
      * @param Request $request
      * @param object $model
      * @param string $fieldName
-     * @return bool
+     * @return bool|Response
      */
-    public function showRelated(Request $request, object $model, string $fieldName): bool;
+    public function showRelated(Request $request, object $model, string $fieldName): bool|Response;
 
     /**
      * Authorize the show-relationship controller action.
      *
      * @param Request $request
      * @param object $model
      * @param string $fieldName
-     * @return bool
+     * @return bool|Response
      */
-    public function showRelationship(Request $request, object $model, string $fieldName): bool;
+    public function showRelationship(Request $request, object $model, string $fieldName): bool|Response;
 
     /**
      * Authorize the update-relationship controller action.
      *
      * @param Request $request
      * @param object $model
      * @param string $fieldName
-     * @return bool
+     * @return bool|Response
      */
-    public function updateRelationship(Request $request, object $model, string $fieldName): bool;
+    public function updateRelationship(Request $request, object $model, string $fieldName): bool|Response;
 
     /**
      * Authorize the attach-relationship controller action.
      *
      * @param Request $request
      * @param object $model
      * @param string $fieldName
-     * @return bool
+     * @return bool|Response
      */
-    public function attachRelationship(Request $request, object $model, string $fieldName): bool;
+    public function attachRelationship(Request $request, object $model, string $fieldName): bool|Response;
 
     /**
      * Authorize the detach-relationship controller action.
      *
      * @param Request $request
      * @param object $model
      * @param string $fieldName
-     * @return bool
+     * @return bool|Response
      */
-    public function detachRelationship(Request $request, object $model, string $fieldName): bool;
+    public function detachRelationship(Request $request, object $model, string $fieldName): bool|Response;
 
     /**
      * Get JSON:API errors describing the failure, or throw an appropriate exception.

src/Contracts/Schema/Schema.php

@@ -43,7 +43,7 @@ public function repository(): ?Repository;
      * @param bool|null $secure
      * @return string
      */
-    public function url($extra = [], bool $secure = null): string;
+    public function url($extra = [], ?bool $secure = null): string;
 
     /**
      * Do resources of this type have a `self` link?

src/Contracts/Server/Server.php

@@ -90,5 +90,5 @@ public function authorizable(): bool;
      * @param bool|null $secure
      * @return string
      */
-    public function url($extra = [], bool $secure = null): string;
+    public function url($extra = [], ?bool $secure = null): string;
 }

src/Core/Auth/Authorizer.php

@@ -15,6 +15,7 @@
 use Illuminate\Auth\AuthenticationException;
 use Illuminate\Contracts\Auth\Access\Gate;
 use Illuminate\Contracts\Auth\Guard;
+use Illuminate\Auth\Access\Response;
 use Illuminate\Http\Request;
 use LaravelJsonApi\Contracts\Auth\Authorizer as AuthorizerContract;
 use LaravelJsonApi\Contracts\Schema\Schema;
@@ -41,10 +42,10 @@ public function __construct(
     /**
      * @inheritDoc
      */
-    public function index(?Request $request, string $modelClass): bool
+    public function index(?Request $request, string $modelClass): bool|Response
     {
         if ($this->mustAuthorize()) {
-            return $this->gate->check(
+            return $this->gate->inspect(
                 'viewAny',
                 $modelClass
             );
@@ -56,10 +57,10 @@ public function index(?Request $request, string $modelClass): bool
     /**
      * @inheritDoc
      */
-    public function store(?Request $request, string $modelClass): bool
+    public function store(?Request $request, string $modelClass): bool|Response
     {
         if ($this->mustAuthorize()) {
-            return $this->gate->check(
+            return $this->gate->inspect(
                 'create',
                 $modelClass
             );
@@ -71,10 +72,10 @@ public function store(?Request $request, string $modelClass): bool
     /**
      * @inheritDoc
      */
-    public function show(?Request $request, object $model): bool
+    public function show(?Request $request, object $model): bool|Response
     {
         if ($this->mustAuthorize()) {
-            return $this->gate->check(
+            return $this->gate->inspect(
                 'view',
                 $model
             );
@@ -86,10 +87,10 @@ public function show(?Request $request, object $model): bool
     /**
      * @inheritDoc
      */
-    public function update(Request $request, object $model): bool
+    public function update(Request $request, object $model): bool|Response
     {
         if ($this->mustAuthorize()) {
-            return $this->gate->check(
+            return $this->gate->inspect(
                 'update',
                 $model
             );
@@ -101,10 +102,10 @@ public function update(Request $request, object $model): bool
     /**
      * @inheritDoc
      */
-    public function destroy(Request $request, object $model): bool
+    public function destroy(Request $request, object $model): bool|Response
     {
         if ($this->mustAuthorize()) {
-            return $this->gate->check(
+            return $this->gate->inspect(
                 'delete',
                 $model
             );
@@ -116,10 +117,10 @@ public function destroy(Request $request, object $model): bool
     /**
      * @inheritDoc
      */
-    public function showRelated(Request $request, object $model, string $fieldName): bool
+    public function showRelated(Request $request, object $model, string $fieldName): bool|Response
     {
         if ($this->mustAuthorize()) {
-            return $this->gate->check(
+            return $this->gate->inspect(
                 'view' . Str::classify($fieldName),
                 $model
             );
@@ -131,18 +132,18 @@ public function showRelated(Request $request, object $model, string $fieldName):
     /**
      * @inheritDoc
      */
-    public function showRelationship(Request $request, object $model, string $fieldName): bool
+    public function showRelationship(Request $request, object $model, string $fieldName): bool|Response
     {
         return $this->showRelated($request, $model, $fieldName);
     }
 
     /**
      * @inheritDoc
      */
-    public function updateRelationship(Request $request, object $model, string $fieldName): bool
+    public function updateRelationship(Request $request, object $model, string $fieldName): bool|Response
     {
         if ($this->mustAuthorize()) {
-            return $this->gate->check(
+            return $this->gate->inspect(
                 'update' . Str::classify($fieldName),
                 [$model, $this->createRelation($request, $fieldName)]
             );
@@ -154,10 +155,10 @@ public function updateRelationship(Request $request, object $model, string $fiel
     /**
      * @inheritDoc
      */
-    public function attachRelationship(Request $request, object $model, string $fieldName): bool
+    public function attachRelationship(Request $request, object $model, string $fieldName): bool|Response
     {
         if ($this->mustAuthorize()) {
-            return $this->gate->check(
+            return $this->gate->inspect(
                 'attach' . Str::classify($fieldName),
                 [$model, $this->createRelation($request, $fieldName)]
             );
@@ -169,10 +170,10 @@ public function attachRelationship(Request $request, object $model, string $fiel
     /**
      * @inheritDoc
      */
-    public function detachRelationship(Request $request, object $model, string $fieldName): bool
+    public function detachRelationship(Request $request, object $model, string $fieldName): bool|Response
     {
         if ($this->mustAuthorize()) {
-            return $this->gate->check(
+            return $this->gate->inspect(
                 'detach' . Str::classify($fieldName),
                 [$model, $this->createRelation($request, $fieldName)]
             );

src/Core/Document/JsonApi.php

@@ -34,7 +34,7 @@ class JsonApi implements Serializable
      * @param string|null $version
      * @return JsonApi
      */
-    public static function make(string $version = null): self
+    public static function make(?string $version = null): self
     {
         return new self($version);
     }
@@ -113,7 +113,7 @@ public static function nullable($value): ?self
      *
      * @param string|null $version
      */
-    public function __construct(string $version = null)
+    public function __construct(?string $version = null)
     {
         $this->version = $version ?: null;
     }

src/Core/Document/LinkHref.php

@@ -56,7 +56,7 @@ public static function cast($value): self
      * @param string $uri
      * @param iterable|null $query
      */
-    public function __construct(string $uri, iterable $query = null)
+    public function __construct(string $uri, ?iterable $query = null)
     {
         if (empty($uri)) {
             throw new UnexpectedValueException('Expecting a non-empty string URI.');