feat: add laravel 10 support

patrickhoogkamer · tomasvanrijsse · commit a5864de3ed09 · 2023-03-02T14:16:44.000+01:00
diff --git a/composer.json b/composer.json
@@ -12,15 +12,16 @@
         "php": ">=8.1",
         "ext-json": "*",
         "intermax/laravel-open-api": "^1.0",
-        "laravel/framework": "^8.0 || ^9.0",
+        "laravel/framework": "^8.0 || ^9.0 || ^10.0",
         "spatie/laravel-json-api-paginate": "^1.12",
         "spatie/laravel-query-builder": "^4.0 || ^5.0"
     },
     "require-dev": {
         "laravel/pint": "^1.1",
-        "nunomaduro/collision": "^5.0 || ^6.1",
+        "nunomaduro/collision": "^7.0",
+        "phpunit/phpunit": "^9.0 || ^10.0",
         "nunomaduro/larastan": "^2.2",
-        "orchestra/testbench": "^6.6 || ^7.0"
+        "orchestra/testbench": "^6.6 || ^7.0 || ^8.0"
     },
     "autoload-dev": {
         "psr-4": {
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,19 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         colors="true"
-         cacheResult="false"
-         printerClass="NunoMaduro\Collision\Adapters\Phpunit\Printer"
->
-    <coverage processUncoveredFiles="true">
-        <include>
-            <directory suffix=".php">./src</directory>
-        </include>
-    </coverage>
-    <testsuites>
-        <testsuite name="Main">
-            <directory>./tests</directory>
-        </testsuite>
-    </testsuites>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true" cacheResult="false" cacheDirectory=".phpunit.cache">
+  <coverage>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="Main">
+      <directory>./tests</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>
diff --git a/src/Exceptions/Handler.php b/src/Exceptions/Handler.php
@@ -27,8 +27,6 @@ public function __construct(
      * Render an exception into an HTTP response.
      *
      * @param  Request  $request
-     * @param  Throwable  $e
-     * @return Response
      *
      * @throws Throwable
      */
@@ -119,10 +117,7 @@ protected function renderDefaultException(Throwable $e, Request $request): Respo
     }
 
     /**
-     * @param  Request  $request
      * @param  iterable<Error>  $errors
-     * @param  int|string  $statusCode
-     * @return Response
      */
     protected function renderException(Request $request, iterable $errors, int|string $statusCode): Response
     {
diff --git a/src/Exceptions/JsonApiException.php b/src/Exceptions/JsonApiException.php
@@ -19,10 +19,6 @@ class JsonApiException extends HttpException implements RenderableError
     protected ?iterable $errors;
 
     /**
-     * @param  int  $statusCode
-     * @param  string|null  $message
-     * @param  Throwable|null  $previous
-     * @param  int|null  $code
      * @param  iterable<Error>|null  $errors
      */
     public function __construct(
diff --git a/src/Filters/OperatorFilter.php b/src/Filters/OperatorFilter.php
@@ -45,9 +45,6 @@ class OperatorFilter implements QueryBuilderFilter, Filter
     protected string $type;
 
     /**
-     * @param  string  $fieldName
-     * @param  string|null  $columnName
-     * @param  string  $type
      * @param  array|string[]|null  $allowedOperators
      */
     public function __construct(
@@ -70,7 +67,6 @@ public function __construct(
     /**
      * @param  Builder<Model>  $query
      * @param  mixed  $value
-     * @param  string  $property
      */
     public function __invoke(Builder $query, $value, string $property): void
     {
diff --git a/src/Filters/ScopeFilter.php b/src/Filters/ScopeFilter.php
@@ -11,11 +11,7 @@
 class ScopeFilter implements Filter
 {
     /**
-     * @param  string  $fieldName
-     * @param  string  $type
      * @param  array<int, string>|null  $options
-     * @param  mixed|null  $example
-     * @param  string|null  $scopeName
      */
     public function __construct(
         protected string $fieldName,
diff --git a/src/Includes/Contracts/Relation.php b/src/Includes/Contracts/Relation.php
@@ -10,8 +10,6 @@ interface Relation
 {
     /**
      * Make custom AllowedInclude with AllowedInclude::custom, otherwise use name of the relationship
-     *
-     * @return AllowedInclude|string
      */
     public function allowedInclude(): AllowedInclude|string;
 }
diff --git a/src/Middleware/RenderJsonApiExceptions.php b/src/Middleware/RenderJsonApiExceptions.php
@@ -23,9 +23,6 @@ public function __construct(
     /**
      * Handle an incoming request.
      *
-     * @param  Request  $request
-     * @param  Closure  $next
-     * @return mixed
      *
      * @throws Exception
      */
diff --git a/src/Requests/QueryResolver.php b/src/Requests/QueryResolver.php
@@ -19,7 +19,6 @@ class QueryResolver
     /**
      * @template TModelClass of Model
      *
-     * @param  CollectionRequest  $request
      * @param  Builder<TModelClass>  $query
      */
     public function resolve(CollectionRequest $request, Builder $query): void
@@ -46,7 +45,6 @@ public function resolve(CollectionRequest $request, Builder $query): void
     }
 
     /**
-     * @param  CollectionRequest  $request
      * @return array<AllowedFilter>
      */
     protected function filters(CollectionRequest $request): array
@@ -55,7 +53,6 @@ protected function filters(CollectionRequest $request): array
     }
 
     /**
-     * @param  CollectionRequest  $request
      * @return array<AllowedSort>
      */
     protected function sorts(CollectionRequest $request): array
@@ -64,7 +61,6 @@ protected function sorts(CollectionRequest $request): array
     }
 
     /**
-     * @param  CollectionRequest  $request
      * @return array<AllowedInclude|string>
      */
     protected function includes(CollectionRequest $request): array
diff --git a/src/Resources/IncludesBag.php b/src/Resources/IncludesBag.php
@@ -24,7 +24,6 @@ public function __construct()
 
     /**
      * @param  array<mixed>  $resource
-     * @return void
      */
     public function add(array $resource): void
     {
diff --git a/src/Resources/JsonApiResource.php b/src/Resources/JsonApiResource.php
@@ -79,7 +79,6 @@ public function with($request): array
     /**
      * Expects an associative array of the attributes you want to include in the response, excluding id.
      *
-     * @param  Request  $request
      * @return array<string,mixed>
      */
     abstract protected function getAttributes(Request $request): array;
@@ -98,7 +97,6 @@ abstract protected function getAttributes(Request $request): array;
      *     ]
      * ].
      *
-     * @param  Request  $request
      * @return array<string,array<string, string>>|null
      */
     protected function getRelations(Request $request): ?array
@@ -110,7 +108,6 @@ protected function getRelations(Request $request): ?array
      * Expects an associative array of links for the resource, preferably use the route helper to generate links (eg:
      * ['self' => route('articles.show', ['article' => 1])] ).
      *
-     * @param  Request  $request
      * @return array<string,string>|null
      */
     protected function getLinks(Request $request): ?array
@@ -119,8 +116,6 @@ protected function getLinks(Request $request): ?array
     }
 
     /**
-     * @return string
-     *
      * @throws JsonApiException
      */
     protected function getId(): string
@@ -133,8 +128,6 @@ protected function getId(): string
     }
 
     /**
-     * @return string
-     *
      * @throws ReflectionException
      */
     protected function getType(): string
@@ -145,7 +138,6 @@ protected function getType(): string
     }
 
     /**
-     * @param  Request  $request
      * @return array<mixed>|null
      */
     protected function discoverRelations(Request $request): ?array
@@ -204,7 +196,6 @@ protected function discoverRelations(Request $request): ?array
     }
 
     /**
-     * @param  string  $definedRelation
      * @return mixed
      */
     protected function getRelationData(string $definedRelation)
diff --git a/tests/Resources/JsonApi/ResourceCollectionTest.php b/tests/Resources/JsonApi/ResourceCollectionTest.php
@@ -82,10 +82,6 @@ public function it_outputs_a_collection_with_nested_includes()
         $this->assertTrue($isFound);
     }
 
-    /**
-     * @param  Collection  $collection
-     * @return LengthAwarePaginator
-     */
     protected function createPaginator(Collection $collection): LengthAwarePaginator
     {
         $paginator = new LengthAwarePaginator($collection, $collection->count(), 15);
diff --git a/tests/Utilities/UserResource.php b/tests/Utilities/UserResource.php
@@ -11,10 +11,6 @@
 
 class UserResource extends JsonApiResource
 {
-    /**
-     * @param  Request  $request
-     * @return array
-     */
     protected function getAttributes(Request $request): array
     {
         return [
@@ -25,9 +21,6 @@ protected function getAttributes(Request $request): array
     }
 
     /**
-     * @param  Request  $request
-     * @return array
-     *
      * @throws JsonApiException
      */
     protected function getRelations(Request $request): array
@@ -51,7 +44,6 @@ protected function getRelations(Request $request): array
     }
 
     /**
-     * @param  Request  $request
      * @return array|string[]
      *
      * @throws JsonApiException

Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,6 @@ public function __construct(`
`27`	`27`	`* Render an exception into an HTTP response.`
`28`	`28`	`*`
`29`	`29`	`* @param Request $request`
`30`		`- * @param Throwable $e`
`31`		`- * @return Response`
`32`	`30`	`*`
`33`	`31`	`* @throws Throwable`
`34`	`32`	`*/`
`@@ -119,10 +117,7 @@ protected function renderDefaultException(Throwable $e, Request $request): Respo`
`119`	`117`	`}`
`120`	`118`
`121`	`119`	`/**`
`122`		`- * @param Request $request`
`123`	`120`	`* @param iterable<Error> $errors`
`124`		`- * @param int\|string $statusCode`
`125`		`- * @return Response`
`126`	`121`	`*/`
`127`	`122`	`protected function renderException(Request $request, iterable $errors, int\|string $statusCode): Response`
`128`	`123`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,6 @@ interface Relation`
`10`	`10`	`{`
`11`	`11`	`/**`
`12`	`12`	`* Make custom AllowedInclude with AllowedInclude::custom, otherwise use name of the relationship`
`13`		`- *`
`14`		`- * @return AllowedInclude\|string`
`15`	`13`	`*/`
`16`	`14`	`public function allowedInclude(): AllowedInclude\|string;`
`17`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,6 @@ public function __construct(`
`23`	`23`	`/**`
`24`	`24`	`* Handle an incoming request.`
`25`	`25`	`*`
`26`		`- * @param Request $request`
`27`		`- * @param Closure $next`
`28`		`- * @return mixed`
`29`	`26`	`*`
`30`	`27`	`* @throws Exception`
`31`	`28`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,6 @@ public function __construct()`
`24`	`24`
`25`	`25`	`/**`
`26`	`26`	`* @param array<mixed> $resource`
`27`		`- * @return void`
`28`	`27`	`*/`
`29`	`28`	`public function add(array $resource): void`
`30`	`29`	`{`