Upgrade to PHPStan 2 (#119)

staudenmeir · web-flow · commit 076bb0b9d934 · 2024-12-10T22:28:03.000+01:00
* Upgrade to PHPStan 2

* Upgrade to PHPStan 2

* Increase PHPStan level

* Increase PHPStan level
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/staudenmeir/eloquent-json-relations/actions/workflows/ci.yml/badge.svg)](https://github.com/staudenmeir/eloquent-json-relations/actions/workflows/ci.yml?query=branch%3Amain)
 [![Code Coverage](https://codecov.io/gh/staudenmeir/eloquent-json-relations/graph/badge.svg?token=T41IX53I5U)](https://codecov.io/gh/staudenmeir/eloquent-json-relations)
-[![PHPStan](https://img.shields.io/badge/PHPStan-level%209-brightgreen.svg?style=flat)](https://github.com/staudenmeir/eloquent-json-relations/actions/workflows/static-analysis.yml?query=branch%3Amain)
+[![PHPStan](https://img.shields.io/badge/PHPStan-level%2010-brightgreen.svg?style=flat)](https://github.com/staudenmeir/eloquent-json-relations/actions/workflows/static-analysis.yml?query=branch%3Amain)
 [![Latest Stable Version](https://poser.pugx.org/staudenmeir/eloquent-json-relations/v/stable)](https://packagist.org/packages/staudenmeir/eloquent-json-relations)
 [![Total Downloads](https://poser.pugx.org/staudenmeir/eloquent-json-relations/downloads)](https://packagist.org/packages/staudenmeir/eloquent-json-relations/stats)
 [![License](https://poser.pugx.org/staudenmeir/eloquent-json-relations/license)](https://github.com/staudenmeir/eloquent-json-relations/blob/main/LICENSE)
diff --git a/composer.json b/composer.json
@@ -15,8 +15,10 @@
     },
     "require-dev": {
         "barryvdh/laravel-ide-helper": "^3.0",
-        "larastan/larastan": "^2.9",
-        "orchestra/testbench": "^9.0",
+        "larastan/larastan": "^3.0",
+        "laravel/framework": "^11.0",
+        "mockery/mockery": "^1.5.1",
+        "orchestra/testbench-core": "^9.5",
         "phpunit/phpunit": "^11.0",
         "staudenmeir/eloquent-has-many-deep": "^1.20"
     },
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,4 +1,4 @@
 parameters:
-    level: 9
+    level: 10
     paths:
         - src
diff --git a/phpstan.types.neon.dist b/phpstan.types.neon.dist
@@ -1,6 +1,6 @@
 includes:
     - ./vendor/larastan/larastan/extension.neon
 parameters:
-    level: 9
+    level: 10
     paths:
         - types
diff --git a/src/Grammars/SqlServerGrammar.php b/src/Grammars/SqlServerGrammar.php
@@ -39,6 +39,8 @@ public function compileJsonObject($column, $levels)
      */
     public function compileJsonValueSelect(string $column): string
     {
+        /** @var string $field */
+        /** @var string $path */
         [$field, $path] = $this->wrapJsonFieldAndPath($column);
 
         return "json_query($field$path)";
diff --git a/src/Grammars/Traits/CompilesMySqlJsonQueries.php b/src/Grammars/Traits/CompilesMySqlJsonQueries.php
@@ -71,6 +71,8 @@ public function compileMemberOf(string $column, ?string $objectKey, mixed $value
     {
         $columnWithKey = $objectKey ? $column . (str_contains($column, '->') ? '[*]' : '') . "->$objectKey" : $column;
 
+        /** @var string $field */
+        /** @var string $path */
         [$field, $path] = $this->wrapJsonFieldAndPath($columnWithKey);
 
         if ($objectKey && !str_contains($column, '->')) {
diff --git a/src/HasJsonRelationships.php b/src/HasJsonRelationships.php
@@ -24,6 +24,9 @@
 use Staudenmeir\EloquentJsonRelations\Relations\Postgres\MorphMany as MorphManyPostgres;
 use Staudenmeir\EloquentJsonRelations\Relations\Postgres\MorphOne as MorphOnePostgres;
 
+/**
+ * @phpstan-ignore trait.unused
+ */
 trait HasJsonRelationships
 {
     /** @inheritDoc */
diff --git a/src/Relations/BelongsToJson.php b/src/Relations/BelongsToJson.php
@@ -283,7 +283,7 @@ protected function relationExistenceQueryOwnerKey(Builder $query, string $ownerK
      *
      * @param TRelatedModel $model
      * @param TDeclaringModel $parent
-     * @param list<array<string, mixed>> $records
+     * @param array<int, array<string, mixed>> $records
      * @return array<string, mixed>
      */
     public function pivotAttributes(Model $model, Model $parent, array $records)
@@ -301,22 +301,28 @@ public function pivotAttributes(Model $model, Model $parent, array $records)
                 return Arr::get($value, $key) == $model->$ownerKey;
             })->first();
 
-        return Arr::except($record, $key);
+        /** @var array<string, mixed> $result */
+        $result = Arr::except($record, $key);
+
+        return $result;
     }
 
     /**
      * Get the foreign key values.
      *
      * @param \Illuminate\Database\Eloquent\Model|null $model
-     * @return list<mixed>
+     * @return array<int, mixed>
      */
     public function getForeignKeys(?Model $model = null)
     {
         $model = $model ?: $this->child;
 
         $foreignKey = $this->hasCompositeKey() ? $this->foreignKey[0] : $this->foreignKey;
 
-        return (new BaseCollection($model->$foreignKey))->filter(fn ($key) => $key !== null)->all();
+        /** @var list<int|string|null> $foreignKeys */
+        $foreignKeys = $model->$foreignKey;
+
+        return (new BaseCollection($foreignKeys))->filter(fn ($key) => $key !== null)->all();
     }
 
     /**
diff --git a/src/Relations/HasManyJson.php b/src/Relations/HasManyJson.php
@@ -163,8 +163,11 @@ protected function matchOneOrMany(array $models, Collection $results, $relation,
 
         if ($this->key) {
             foreach ($models as $model) {
+                /** @var \Illuminate\Database\Eloquent\Collection<int, TRelatedModel> $relatedModels */
+                $relatedModels = $model->$relation;
+
                 $this->hydratePivotRelation(
-                    $model->$relation,
+                    $relatedModels,
                     $model,
                     fn (Model $model) => $model->{$this->getPathName()}
                 );
@@ -182,7 +185,10 @@ protected function buildDictionary(Collection $results)
         $dictionary = [];
 
         foreach ($results as $result) {
-            foreach ($result->{$foreign} as $value) {
+            /** @var list<int|string|null> $foreignKeys */
+            $foreignKeys = $result->$foreign;
+
+            foreach ($foreignKeys as $value) {
                 $dictionary[$value][] = $result;
             }
         }
@@ -297,7 +303,7 @@ protected function relationExistenceQueryParentKey(Builder $query): array
      *
      * @param TRelatedModel $model
      * @param TDeclaringModel $parent
-     * @param list<array<string, mixed>> $records
+     * @param array<int, array<string, mixed>> $records
      * @return array<string, mixed>
      */
     public function pivotAttributes(Model $model, Model $parent, array $records)
@@ -315,7 +321,10 @@ public function pivotAttributes(Model $model, Model $parent, array $records)
                 return Arr::get($value, $key) == $parent->$localKey;
             })->first();
 
-        return Arr::except($record, $key);
+        /** @var array<string, mixed> $result */
+        $result = Arr::except($record, $key);
+
+        return $result;
     }
 
     /**
diff --git a/src/Relations/HasOneJson.php b/src/Relations/HasOneJson.php
@@ -54,15 +54,18 @@ public function matchOne(array $models, Collection $results, $relation)
 
         if ($this->key) {
             foreach ($models as $model) {
-                /** @var \Illuminate\Database\Eloquent\Collection<int, TRelatedModel> $relatedModel */
-                $relatedModel = new Collection(
-                    array_filter([$model->$relation])
+                /** @var TRelatedModel|null $relatedModel */
+                $relatedModel = $model->$relation;
+
+                /** @var \Illuminate\Database\Eloquent\Collection<int, TRelatedModel> $relatedModels */
+                $relatedModels = new Collection(
+                    array_filter([$relatedModel])
                 );
 
                 $model->setRelation(
                     $relation,
                     $this->hydratePivotRelation(
-                        $relatedModel,
+                        $relatedModels,
                         $model,
                         fn (Model $model) => $model->{$this->getPathName()}
                     )->first()
diff --git a/src/Relations/InteractsWithPivotRecords.php b/src/Relations/InteractsWithPivotRecords.php
@@ -121,6 +121,8 @@ protected function decodeRecords()
                 continue;
             }
 
+            /** @var array<string, mixed> $record */
+
             $foreignKey = Arr::get($record, $key);
 
             if (!is_null($foreignKey)) {
@@ -167,7 +169,10 @@ protected function encodeRecords(array $records, array $others)
     protected function parseIds($value)
     {
         if ($value instanceof Model) {
-            return [$value->{$this->ownerKey}];
+            /** @var int|string $id */
+            $id = $value->{$this->ownerKey};
+
+            return [$id];
         }
 
         if ($value instanceof Collection) {
diff --git a/src/Relations/Postgres/HasOneOrManyThrough.php b/src/Relations/Postgres/HasOneOrManyThrough.php
@@ -29,7 +29,10 @@ protected function performJoin(?Builder $query = null)
 
         if ($this->throughParentSoftDeletes()
             && method_exists($this->throughParent, 'getQualifiedDeletedAtColumn')) {
-            $query->whereNull($this->throughParent->getQualifiedDeletedAtColumn());
+            /** @var string $deletedAtColumn */
+            $deletedAtColumn = $this->throughParent->getQualifiedDeletedAtColumn();
+
+            $query->whereNull($deletedAtColumn);
         }
     }
 
@@ -114,7 +117,10 @@ public function getRelationExistenceQueryForThroughSelfRelation(Builder $query,
 
         if ($this->throughParentSoftDeletes()
             && method_exists($this->throughParent, 'getDeletedAtColumn')) {
-            $query->whereNull($hash.'.'.$this->throughParent->getDeletedAtColumn());
+            /** @var string $deletedAtColumn */
+            $deletedAtColumn = $this->throughParent->getDeletedAtColumn();
+
+            $query->whereNull("$hash.$deletedAtColumn");
         }
 
         /** @var string $parentFrom */
diff --git a/src/Relations/Traits/CompositeKeys/SupportsBelongsToJsonCompositeKeys.php b/src/Relations/Traits/CompositeKeys/SupportsBelongsToJsonCompositeKeys.php
@@ -50,7 +50,7 @@ protected function addConstraintsWithCompositeKey(): void
     /**
      * Set the constraints for an eager load of the relation for a composite key.
      *
-     * @param list<TDeclaringModel> $models
+     * @param array<int, TDeclaringModel> $models
      * @return void
      */
     protected function addEagerConstraintsWithCompositeKey(array $models): void
@@ -99,10 +99,10 @@ function (Builder $query) use ($key, $ownerKey) {
     /**
      * Match the eagerly loaded results to their parents for a composite key.
      *
-     * @param list<TDeclaringModel> $models
+     * @param array<int, TDeclaringModel> $models
      * @param \Illuminate\Database\Eloquent\Collection<int, TRelatedModel> $results
      * @param string $relation
-     * @return list<TDeclaringModel>
+     * @return array<int, TDeclaringModel>
      */
     protected function matchWithCompositeKey(array $models, Collection $results, string $relation): array
     {
diff --git a/src/Relations/Traits/CompositeKeys/SupportsHasManyJsonCompositeKeys.php b/src/Relations/Traits/CompositeKeys/SupportsHasManyJsonCompositeKeys.php
@@ -50,7 +50,7 @@ protected function addConstraintsWithCompositeKey(): void
     /**
      * Set the constraints for an eager load of the relation for a composite key.
      *
-     * @param list<TDeclaringModel> $models
+     * @param array<int, TDeclaringModel> $models
      * @return void
      */
     protected function addEagerConstraintsWithCompositeKey(array $models): void
@@ -101,11 +101,11 @@ function (Builder $query) use ($foreignKey, $key) {
     /**
      * Match the eagerly loaded results to their parents for a composite key.
      *
-     * @param list<TDeclaringModel> $models
+     * @param array<int, TDeclaringModel> $models
      * @param \Illuminate\Database\Eloquent\Collection<int, TRelatedModel> $results
      * @param string $relation
      * @param string $type
-     * @return list<TDeclaringModel>
+     * @return array<int, TDeclaringModel>
      */
     protected function matchWithCompositeKey(array $models, Collection $results, string $relation, string $type): array
     {
@@ -153,7 +153,10 @@ protected function buildDictionaryWithCompositeKey(Collection $results): array
                 $additionalColumns
             );
 
-            foreach($result->$foreignKey as $value) {
+            /** @var list<int|string> $values */
+            $values = $result->$foreignKey;
+
+            foreach($values as $value) {
                 $values = [$value, ...$additionalValues];
 
                 $key = implode("\0", $values);
diff --git a/src/Relations/Traits/Concatenation/IsConcatenableHasManyJsonRelation.php b/src/Relations/Traits/Concatenation/IsConcatenableHasManyJsonRelation.php
@@ -123,8 +123,11 @@ protected function buildDictionaryForDeepRelationship(Collection $results): arra
         $key = $this->key ? str_replace('->', '.', $this->key) : null;
 
         foreach ($results as $result) {
+            /** @var string|null $throughKey */
+            $throughKey = $result->getAttribute('laravel_through_key');
+
             /** @var array<string, mixed> $values */
-            $values = json_decode($result->laravel_through_key ?? '[]', true);
+            $values = json_decode($throughKey ?? '[]', true);
 
             if ($key) {
                 $values = array_filter(
diff --git a/src/Relations/Traits/Concatenation/IsConcatenableRelation.php b/src/Relations/Traits/Concatenation/IsConcatenableRelation.php
@@ -33,6 +33,7 @@ public function addEagerConstraintsToDeepRelationship(Builder $query, array $mod
      */
     public function mergeWhereConstraints(Builder $query, Builder $from): Builder
     {
+        /** @var array<int, mixed> $whereBindings */
         $whereBindings = $from->getQuery()->getRawBindings()['where'] ?? [];
 
         $wheres = $from->getQuery()->wheres;
diff --git a/src/Relations/Traits/IsJsonRelation.php b/src/Relations/Traits/IsJsonRelation.php
@@ -67,6 +67,7 @@ public function hydratePivotRelation(Collection $models, Model $parent, callable
      */
     protected function pivotRelation(Model $model, Model $parent, callable $callback)
     {
+        /** @var list<array<string, mixed>>|\Illuminate\Contracts\Support\Arrayable<int, array<string, mixed>> $records */
         $records = $callback($model, $parent);
 
         if ($records instanceof Arrayable) {
@@ -86,7 +87,7 @@ protected function pivotRelation(Model $model, Model $parent, callable $callback
      *
      * @param TRelatedModel $model
      * @param TDeclaringModel $parent
-     * @param list<array<string, mixed>> $records
+     * @param array<int, array<string, mixed>> $records
      * @return array<string, mixed>
      */
     abstract public function pivotAttributes(Model $model, Model $parent, array $records);

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,8 @@ public function compileJsonObject($column, $levels)`
`39`	`39`	`*/`
`40`	`40`	`public function compileJsonValueSelect(string $column): string`
`41`	`41`	`{`
	`42`	`+ /** @var string $field */`
	`43`	`+ /** @var string $path */`
`42`	`44`	`[$field, $path] = $this->wrapJsonFieldAndPath($column);`
`43`	`45`
`44`	`46`	`return "json_query($field$path)";`
Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,8 @@ public function compileMemberOf(string $column, ?string $objectKey, mixed $value`
`71`	`71`	`{`
`72`	`72`	`$columnWithKey = $objectKey ? $column . (str_contains($column, '->') ? '[*]' : '') . "->$objectKey" : $column;`
`73`	`73`
	`74`	`+ /** @var string $field */`
	`75`	`+ /** @var string $path */`
`74`	`76`	`[$field, $path] = $this->wrapJsonFieldAndPath($columnWithKey);`
`75`	`77`
`76`	`78`	`if ($objectKey && !str_contains($column, '->')) {`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,9 @@`
`24`	`24`	`use Staudenmeir\EloquentJsonRelations\Relations\Postgres\MorphMany as MorphManyPostgres;`
`25`	`25`	`use Staudenmeir\EloquentJsonRelations\Relations\Postgres\MorphOne as MorphOnePostgres;`
`26`	`26`
	`27`	`+/**`
	`28`	`+ * @phpstan-ignore trait.unused`
	`29`	`+ */`
`27`	`30`	`trait HasJsonRelationships`
`28`	`31`	`{`
`29`	`32`	`/** @inheritDoc */`