feat: phpstan lvl 6 compliant

Author: Ark4ne

CHANGELOG-1.1.md

@@ -1,6 +1,13 @@
 Release note
 ============
 
+# v1.1.4
+### Changes
+- phpstan lvl 6 compliant
+- Schema safe instantiate self for structure generation
+### Fixes
+- Schema correct handle attributes
+
 # v1.1.3
 ### Added 
 - `Includes::includes` return the remaining includes for current resource

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+    paths:
+        - src
+    level: 6
+    checkGenericClassInNonGenericObjectType: false

src/Requests/Rules/Fields.php

@@ -13,6 +13,9 @@ class Fields implements Rule
 {
     use UseTrans;
 
+    /**
+     * @var array<int, array{":resource": string, ":fields": ?string}>>
+     */
     protected array $failures;
 
     /**
@@ -31,7 +34,10 @@ public function passes($attribute, $value): bool
         return $this->assert($schema, $desired);
     }
 
-    public function message()
+    /**
+     * @return array<string>
+     */
+    public function message(): array
     {
         $base = 'validation.custom.jsonapi.fields';
         $message = $this->trans(
@@ -55,6 +61,12 @@ public function message()
         ));
     }
 
+    /**
+     * @param object                  $schema
+     * @param array<string, string[]> $desired
+     *
+     * @return bool
+     */
     private function assert(object $schema, array $desired): bool
     {
         $resources = $this->extractSchemaFields($schema);
@@ -75,6 +87,12 @@ private function assert(object $schema, array $desired): bool
         return empty($this->failures);
     }
 
+    /**
+     * @param object                  $schema
+     * @param array<string, string[]> $resources
+     *
+     * @return array<string, string[]>
+     */
     private function extractSchemaFields(object $schema, array $resources = []): array
     {
         if (isset($resources[$schema->type])) {

src/Requests/Rules/Includes.php

@@ -13,6 +13,9 @@ class Includes implements Rule
 {
     use UseTrans;
 
+    /**
+     * @var array<int, array{":include": string, ":relation": string}>>
+     */
     protected array $failures;
 
     /**
@@ -31,7 +34,10 @@ public function passes($attribute, $value): bool
         return $this->assert($schema, $desired);
     }
 
-    public function message()
+    /**
+     * @return array<string>
+     */
+    public function message(): array
     {
         $base = 'validation.custom.jsonapi.includes';
         $message = $this->trans(
@@ -49,7 +55,13 @@ public function message()
         ));
     }
 
-
+    /**
+     * @param object               $schema
+     * @param array<string, mixed> $desired
+     * @param string               $pretend
+     *
+     * @return bool
+     */
     private function assert(object $schema, array $desired, string $pretend = ''): bool
     {
         foreach ($desired as $relation => $sub) {

src/Requests/Rules/Traits/UseTrans.php

@@ -8,7 +8,14 @@
 
 trait UseTrans
 {
-    protected function trans($key, $default, array $replace = []): array
+    /**
+     * @param string|null           $key
+     * @param string                $default
+     * @param array<string, string> $replace
+     *
+     * @return array<string>
+     */
+    protected function trans(?string $key, string $default, array $replace = []): array
     {
         $message = trans($key);
 

src/Resources/Concerns/Attributes.php

@@ -4,8 +4,8 @@
 
 use Ark4ne\JsonApi\Support\Fields;
 use Illuminate\Http\Request;
+use Illuminate\Support\Collection;
 
-use function collect;
 use function value;
 
 trait Attributes
@@ -15,7 +15,7 @@ trait Attributes
      *
      * @param \Illuminate\Http\Request $request
      *
-     * @return array<string, Closure|mixed>
+     * @return iterable<string, Closure|mixed>
      *
      * ```
      * return [
@@ -33,11 +33,11 @@ protected function toAttributes(Request $request): iterable
     /**
      * @param \Illuminate\Http\Request $request
      *
-     * @return array
+     * @return array<string, mixed>
      */
     private function requestedAttributes(Request $request): array
     {
-        $attributes = collect($this->toAttributes($request))
+        $attributes = (new Collection($this->toAttributes($request)))
             ->map(fn($value) => value($value))
             ->toArray();
 

src/Resources/Concerns/Identifier.php

@@ -41,7 +41,7 @@ protected function toIdentifier(Request $request): int|string
             return $this->resource->getKey();
         }
 
-        return $this->id;
+        return $this->resource->id;
     }
 
 }

src/Resources/Concerns/Meta.php

@@ -12,7 +12,7 @@ trait Meta
      *
      * @param \Illuminate\Http\Request $request
      *
-     * @return iterable|null
+     * @return iterable<string, mixed>|null
      *
      * ```
      * return [
@@ -31,7 +31,7 @@ protected function toResourceMeta(Request $request): ?iterable
      *
      * @param \Illuminate\Http\Request $request
      *
-     * @return iterable|null
+     * @return iterable<string, string>|null
      */
     protected function toMeta(Request $request): ?iterable
     {

src/Resources/Concerns/Relationize.php

@@ -8,9 +8,9 @@
 trait Relationize
 {
     /**
-     * @param \Closure      $value
-     * @param \Closure|null $links
-     * @param \Closure|null $meta
+     * @param Closure      $value
+     * @param Closure|null $links
+     * @param Closure|null $meta
      *
      * @return \Ark4ne\JsonApi\Resources\Relationship<static>
      */

src/Resources/Concerns/Relationships.php

@@ -5,6 +5,7 @@
 use Ark4ne\JsonApi\Resources\Relationship;
 use Ark4ne\JsonApi\Support\Includes;
 use Illuminate\Http\Request;
+use Illuminate\Support\Collection;
 
 trait Relationships
 {
@@ -13,7 +14,7 @@ trait Relationships
      *
      * @param \Illuminate\Http\Request $request
      *
-     * @return array<string, Relationship>
+     * @return array<string, Relationship>|iterable<Relationship>
      *
      * ```
      * return [
@@ -30,6 +31,11 @@ protected function toRelationships(Request $request): iterable
         return [];
     }
 
+    /**
+     * @param \Illuminate\Http\Request $request
+     *
+     * @return array<string, array{data?: mixed, links?: mixed, meta?: mixed}>
+     */
     private function requestedRelationships(Request $request): array
     {
         $relations = [];
@@ -49,6 +55,13 @@ private function requestedRelationships(Request $request): array
         return $relations;
     }
 
+    /**
+     * @param bool                                   $included
+     * @param \Illuminate\Http\Request               $request
+     * @param \Ark4ne\JsonApi\Resources\Relationship $relationship
+     *
+     * @return array{data?: mixed, links?: mixed, meta?: mixed}
+     */
     private function mapRelationship(
         bool $included,
         Request $request,
@@ -67,11 +80,11 @@ private function mapRelationship(
             foreach ($resource['with'] as $key => $value) {
                 $this->with[$key] = array_merge(
                     $this->with[$key] ?? [],
-                    collect($value)->all()
+                    (new Collection($value))->all()
                 );
             }
         }
 
-        return $resource['data'] ?? [];
+        return $resource['data'];
     }
 }