PHPStan fixes.

LastDragon-ru · Sep 20, 2024 · 867f9a1 · 867f9a1
1 parent 5b80fa0
commit 867f9a1
Show file tree

Hide file tree

Showing 19 changed files with 79 additions and 56 deletions.
diff --git a/packages/eloquent/src/Testing/Package/Models/TestObject.php b/packages/eloquent/src/Testing/Package/Models/TestObject.php
@@ -18,7 +18,7 @@ class TestObject extends Model {
 
     /**
      * @phpcsSuppress SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
-     * @var string
+     * @var ?string
      */
     protected $table = 'test_objects';
 

diff --git a/packages/graphql/src/Builder/Directives/HandlerDirective.php b/packages/graphql/src/Builder/Directives/HandlerDirective.php
@@ -73,6 +73,11 @@ public function handleBuilder($builder, mixed $value): EloquentBuilder|QueryBuil
         return $this->handleAnyBuilder($builder, $value);
     }
 
+    /**
+     * @param ScoutBuilder<Model> $builder
+     *
+     * @return ScoutBuilder<Model>
+     */
     public function handleScoutBuilder(ScoutBuilder $builder, mixed $value): ScoutBuilder {
         return $this->handleAnyBuilder($builder, $value);
     }

diff --git a/packages/graphql/src/SearchBy/Directives/DirectiveTest.php b/packages/graphql/src/SearchBy/Directives/DirectiveTest.php
@@ -408,10 +408,10 @@ public function testHandleBuilderV5Compat(
     }
 
     /**
-     * @param array<string, mixed>|Exception      $expected
-     * @param Closure(static): ScoutBuilder       $builderFactory
-     * @param Closure(object, Field): string|null $resolver
-     * @param Closure():FieldResolver|null        $fieldResolver
+     * @param array<string, mixed>|Exception               $expected
+     * @param Closure(static): ScoutBuilder<EloquentModel> $builderFactory
+     * @param Closure(object, Field): string|null          $resolver
+     * @param Closure():FieldResolver|null                 $fieldResolver
      */
     #[DataProvider('dataProviderHandleScoutBuilder')]
     #[RequiresLaravelScout]
@@ -483,10 +483,10 @@ static function (MockInterface $mock) use ($resolver): void {
     /**
      * @deprecated   5.5.0
      *
-     * @param array<string, mixed>|Exception      $expected
-     * @param Closure(static): ScoutBuilder       $builderFactory
-     * @param Closure(object, Field): string|null $resolver
-     * @param Closure():FieldResolver|null        $fieldResolver
+     * @param array<string, mixed>|Exception               $expected
+     * @param Closure(static): ScoutBuilder<EloquentModel> $builderFactory
+     * @param Closure(object, Field): string|null          $resolver
+     * @param Closure():FieldResolver|null                 $fieldResolver
      */
     #[DataProvider('dataProviderHandleScoutBuilderV5Compat')]
     #[RequiresLaravelScout]

diff --git a/packages/graphql/src/SearchBy/Operators/Comparison/EqualTest.php b/packages/graphql/src/SearchBy/Operators/Comparison/EqualTest.php
@@ -63,12 +63,12 @@ public function testCall(
     }
 
     /**
-     * @param array<string, mixed>                $expected
-     * @param Closure(static): ScoutBuilder       $builderFactory
-     * @param Closure(static): Argument           $argumentFactory
-     * @param Closure(static): Context|null       $contextFactory
-     * @param Closure(object, Field): string|null $resolver
-     * @param Closure():FieldResolver|null        $fieldResolver
+     * @param array<string, mixed>                 $expected
+     * @param Closure(static): ScoutBuilder<Model> $builderFactory
+     * @param Closure(static): Argument            $argumentFactory
+     * @param Closure(static): Context|null        $contextFactory
+     * @param Closure(object, Field): string|null  $resolver
+     * @param Closure():FieldResolver|null         $fieldResolver
      */
     #[DataProvider('dataProviderCallScout')]
     #[RequiresLaravelScout]

diff --git a/packages/graphql/src/SearchBy/Operators/Comparison/InTest.php b/packages/graphql/src/SearchBy/Operators/Comparison/InTest.php
@@ -63,12 +63,12 @@ public function testCall(
     }
 
     /**
-     * @param array<string, mixed>                $expected
-     * @param Closure(static): ScoutBuilder       $builderFactory
-     * @param Closure(static): Argument           $argumentFactory
-     * @param Closure(static): Context|null       $contextFactory
-     * @param Closure(object, Field): string|null $resolver
-     * @param Closure():FieldResolver|null        $fieldResolver
+     * @param array<string, mixed>                 $expected
+     * @param Closure(static): ScoutBuilder<Model> $builderFactory
+     * @param Closure(static): Argument            $argumentFactory
+     * @param Closure(static): Context|null        $contextFactory
+     * @param Closure(object, Field): string|null  $resolver
+     * @param Closure():FieldResolver|null         $fieldResolver
      */
     #[DataProvider('dataProviderCallScout')]
     #[RequiresLaravelScout]

diff --git a/packages/graphql/src/SearchBy/Operators/Comparison/NotInTest.php b/packages/graphql/src/SearchBy/Operators/Comparison/NotInTest.php
@@ -66,12 +66,12 @@ public function testCall(
     }
 
     /**
-     * @param array<string, mixed>                $expected
-     * @param Closure(static): ScoutBuilder       $builderFactory
-     * @param Closure(static): Argument           $argumentFactory
-     * @param Closure(static): Context|null       $contextFactory
-     * @param Closure(object, Field): string|null $resolver
-     * @param Closure():FieldResolver|null        $fieldResolver
+     * @param array<string, mixed>                 $expected
+     * @param Closure(static): ScoutBuilder<Model> $builderFactory
+     * @param Closure(static): Argument            $argumentFactory
+     * @param Closure(static): Context|null        $contextFactory
+     * @param Closure(object, Field): string|null  $resolver
+     * @param Closure():FieldResolver|null         $fieldResolver
      */
     #[DataProvider('dataProviderCallScout')]
     #[RequiresLaravelScout]

diff --git a/packages/graphql/src/SearchBy/Operators/Logical/AllOfTest.php b/packages/graphql/src/SearchBy/Operators/Logical/AllOfTest.php
@@ -65,12 +65,12 @@ public function testCall(
     }
 
     /**
-     * @param array<string, mixed>                $expected
-     * @param Closure(static): ScoutBuilder       $builderFactory
-     * @param Closure(static): Argument           $argumentFactory
-     * @param Closure(static): Context|null       $contextFactory
-     * @param Closure(object, Field): string|null $resolver
-     * @param Closure():FieldResolver|null        $fieldResolver
+     * @param array<string, mixed>                 $expected
+     * @param Closure(static): ScoutBuilder<Model> $builderFactory
+     * @param Closure(static): Argument            $argumentFactory
+     * @param Closure(static): Context|null        $contextFactory
+     * @param Closure(object, Field): string|null  $resolver
+     * @param Closure():FieldResolver|null         $fieldResolver
      */
     #[DataProvider('dataProviderCallScout')]
     #[RequiresLaravelScout]

diff --git a/packages/graphql/src/SortBy/Directives/DirectiveTest.php b/packages/graphql/src/SortBy/Directives/DirectiveTest.php
@@ -418,10 +418,10 @@ public function testHandleBuilderV5Compat(
     }
 
     /**
-     * @param array<string, mixed>|Exception      $expected
-     * @param Closure(static): ScoutBuilder       $builderFactory
-     * @param Closure(object, Field): string|null $resolver
-     * @param Closure():FieldResolver|null        $fieldResolver
+     * @param array<string, mixed>|Exception               $expected
+     * @param Closure(static): ScoutBuilder<EloquentModel> $builderFactory
+     * @param Closure(object, Field): string|null          $resolver
+     * @param Closure():FieldResolver|null                 $fieldResolver
      */
     #[DataProvider('dataProviderHandleScoutBuilder')]
     #[RequiresLaravelScout]
@@ -493,10 +493,10 @@ static function (MockInterface $mock) use ($resolver): void {
     /**
      * @deprecated   5.5.0
      *
-     * @param array<string, mixed>|Exception      $expected
-     * @param Closure(static): ScoutBuilder       $builderFactory
-     * @param Closure(object, Field): string|null $resolver
-     * @param Closure():FieldResolver|null        $fieldResolver
+     * @param array<string, mixed>|Exception               $expected
+     * @param Closure(static): ScoutBuilder<EloquentModel> $builderFactory
+     * @param Closure(object, Field): string|null          $resolver
+     * @param Closure():FieldResolver|null                 $fieldResolver
      */
     #[DataProvider('dataProviderHandleScoutBuilderV5Compat')]
     #[RequiresLaravelScout]

diff --git a/packages/graphql/src/SortBy/Sorters/ScoutSorter.php b/packages/graphql/src/SortBy/Sorters/ScoutSorter.php
@@ -2,6 +2,7 @@
 
 namespace LastDragon_ru\LaraASP\GraphQL\SortBy\Sorters;
 
+use Illuminate\Database\Eloquent\Model;
 use Laravel\Scout\Builder as ScoutBuilder;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Contracts\BuilderFieldResolver;
 use LastDragon_ru\LaraASP\GraphQL\Builder\Field;
@@ -12,7 +13,7 @@
 use Override;
 
 /**
- * @implements Sorter<ScoutBuilder>
+ * @implements Sorter<ScoutBuilder<Model>>
  */
 class ScoutSorter implements Sorter {
     public function __construct(

diff --git a/packages/graphql/src/Stream/Directives/DirectiveTest.php b/packages/graphql/src/Stream/Directives/DirectiveTest.php
@@ -1181,28 +1181,28 @@ public function getPreviousOffset(): ?StreamOffset {
             }
 
             /**
-             * @param Stream<EloquentBuilder<EloquentModel>|QueryBuilder|ScoutBuilder> $stream
+             * @param Stream<EloquentBuilder<EloquentModel>|QueryBuilder|ScoutBuilder<EloquentModel>> $stream
              */
             public function getInternalBuilder(Stream $stream): object {
                 return $stream->builder;
             }
 
             /**
-             * @param Stream<EloquentBuilder<EloquentModel>|QueryBuilder|ScoutBuilder> $stream
+             * @param Stream<EloquentBuilder<EloquentModel>|QueryBuilder|ScoutBuilder<EloquentModel>> $stream
              */
             public function getInternalKey(Stream $stream): string {
                 return $stream->key;
             }
 
             /**
-             * @param Stream<EloquentBuilder<EloquentModel>|QueryBuilder|ScoutBuilder> $stream
+             * @param Stream<EloquentBuilder<EloquentModel>|QueryBuilder|ScoutBuilder<EloquentModel>> $stream
              */
             public function getInternalOffset(Stream $stream): StreamOffset {
                 return $stream->offset;
             }
 
             /**
-             * @param Stream<EloquentBuilder<EloquentModel>|QueryBuilder|ScoutBuilder> $stream
+             * @param Stream<EloquentBuilder<EloquentModel>|QueryBuilder|ScoutBuilder<EloquentModel>> $stream
              */
             public function getInternalLimit(Stream $stream): int {
                 return $stream->limit;

diff --git a/packages/graphql/src/Stream/StreamFactory.php b/packages/graphql/src/Stream/StreamFactory.php
@@ -16,7 +16,7 @@
 
 /**
  * @internal
- * @implements StreamFactoryContract<EloquentBuilder<EloquentModel>|QueryBuilder|ScoutBuilder>
+ * @implements StreamFactoryContract<EloquentBuilder<EloquentModel>|QueryBuilder|ScoutBuilder<EloquentModel>>
  */
 class StreamFactory implements StreamFactoryContract {
     public function __construct() {

diff --git a/packages/graphql/src/Stream/Streams/Scout.php b/packages/graphql/src/Stream/Streams/Scout.php
@@ -3,6 +3,7 @@
 namespace LastDragon_ru\LaraASP\GraphQL\Stream\Streams;
 
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
+use Illuminate\Database\Eloquent\Model;
 use Laravel\Scout\Builder as ScoutBuilder;
 use LastDragon_ru\LaraASP\Core\Utils\Cast;
 use LastDragon_ru\LaraASP\GraphQL\Stream\Offset;
@@ -13,7 +14,7 @@
 use function max;
 
 /**
- * @extends Stream<ScoutBuilder>
+ * @extends Stream<ScoutBuilder<covariant Model>>
  */
 class Scout extends Stream {
     /**

diff --git a/packages/graphql/src/Testing/Package/Data/Models/TestObject.php b/packages/graphql/src/Testing/Package/Data/Models/TestObject.php
@@ -21,7 +21,7 @@ class TestObject extends Model {
 
     /**
      * @phpcsSuppress SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
-     * @var string
+     * @var ?string
      */
     protected $table = 'test_objects';
 

diff --git a/packages/graphql/src/Testing/Package/Data/Models/TestObjectSearchable.php b/packages/graphql/src/Testing/Package/Data/Models/TestObjectSearchable.php
@@ -23,7 +23,7 @@ class TestObjectSearchable extends Model {
 
     /**
      * @phpcsSuppress SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint
-     * @var string
+     * @var ?string
      */
     protected $table = 'test_objects';
 

diff --git a/packages/graphql/src/Testing/Package/Directives/ExposeBuilderDirective.php b/packages/graphql/src/Testing/Package/Directives/ExposeBuilderDirective.php
@@ -24,12 +24,12 @@
  */
 class ExposeBuilderDirective extends BaseDirective implements FieldResolver, BuilderInfoProvider {
     /**
-     * @var QueryBuilder|EloquentBuilder<Model>|ScoutBuilder
+     * @var QueryBuilder|EloquentBuilder<Model>|ScoutBuilder<Model>
      */
     public static QueryBuilder|EloquentBuilder|ScoutBuilder $builder;
 
     /**
-     * @var QueryBuilder|EloquentBuilder<Model>|ScoutBuilder|Relation<Model>|null
+     * @var QueryBuilder|EloquentBuilder<Model>|ScoutBuilder<Model>|Relation<Model>|null
      */
     public static QueryBuilder|EloquentBuilder|ScoutBuilder|Relation|null $result = null;
 

diff --git a/packages/graphql/src/Testing/Package/TestCase.php b/packages/graphql/src/Testing/Package/TestCase.php
@@ -101,7 +101,7 @@ protected function getGraphQLArgument(
     /**
      * @template M of EloquentModel
      *
-     * @param QueryBuilder|EloquentBuilder<M>|ScoutBuilder $builder
+     * @param QueryBuilder|EloquentBuilder<M>|ScoutBuilder<M> $builder
      */
     protected function getExposeBuilderDirective(
         QueryBuilder|EloquentBuilder|ScoutBuilder $builder,

diff --git a/packages/graphql/src/Testing/SchemaBuilderWrapper.php b/packages/graphql/src/Testing/SchemaBuilderWrapper.php
@@ -47,7 +47,7 @@ public function schema(): Schema {
      *      but the lowest supported version is {@see https://github.com/nuwave/lighthouse/releases/tag/v6.5.0}.
      *      To avoid the error the {@see Override} is missed.
      *
-     * @phpstan-ignore method.missingOverride
+     * @phpstan-ignore-next-line
      */
     public function schemaHash(): string {
         return $this->getSchemaBuilder()->schemaHash();

diff --git a/packages/testing/src/Assertions/ScoutAssertions.php b/packages/testing/src/Assertions/ScoutAssertions.php
@@ -2,6 +2,7 @@
 
 namespace LastDragon_ru\LaraASP\Testing\Assertions;
 
+use Illuminate\Database\Eloquent\Model;
 use Laravel\Scout\Builder;
 use LastDragon_ru\LaraASP\Testing\Utils\Args;
 use PHPUnit\Framework\Assert;
@@ -13,8 +14,8 @@ trait ScoutAssertions {
     /**
      * Asserts that Scout Query equals Scout Query.
      *
-     * @param Builder|array<string, mixed>|string $expected
-     * @param Builder|array<string, mixed>|string $actual
+     * @param Builder<covariant Model>|array<string, mixed>|string $expected
+     * @param Builder<covariant Model>|array<string, mixed>|string $actual
      */
     public static function assertScoutQueryEquals(
         Builder|array|string $expected,

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -25,6 +25,11 @@ parameters:
 			count: 1
 			path: packages/formatter/src/Formatter.php
 
+		-
+			message: "#^Method class@anonymous/packages/graphql/src/Stream/Directives/Directive\\.php\\:476\\:\\:enhanceEloquentBuilder\\(\\) return type with generic class Laravel\\\\Scout\\\\Builder does not specify its types\\: TModel$#"
+			count: 1
+			path: packages/graphql/src/Stream/Directives/Directive.php
+
 		-
 			message: "#^Method LastDragon_ru\\\\LaraASP\\\\GraphQL\\\\Testing\\\\Package\\\\Models\\\\Image\\:\\:imageable\\(\\) should return Illuminate\\\\Database\\\\Eloquent\\\\Relations\\\\MorphTo\\<LastDragon_ru\\\\LaraASP\\\\GraphQL\\\\Testing\\\\Package\\\\Models\\\\Role\\|LastDragon_ru\\\\LaraASP\\\\GraphQL\\\\Testing\\\\Package\\\\Models\\\\User, LastDragon_ru\\\\LaraASP\\\\GraphQL\\\\Testing\\\\Package\\\\Models\\\\Image\\> but returns Illuminate\\\\Database\\\\Eloquent\\\\Relations\\\\MorphTo\\<Illuminate\\\\Database\\\\Eloquent\\\\Model, LastDragon_ru\\\\LaraASP\\\\GraphQL\\\\Testing\\\\Package\\\\Models\\\\Image\\>\\.$#"
 			count: 1
@@ -50,6 +55,11 @@ parameters:
 			count: 1
 			path: packages/spa/src/Http/Resources/Resource.php
 
+		-
+			message: "#^Method class@anonymous/packages/spa/src/Http/WithValueProviderTest\\.php\\:50\\:\\:validate\\(\\) has parameter \\$fail with no signature specified for Closure\\.$#"
+			count: 1
+			path: packages/spa/src/Http/WithValueProviderTest.php
+
 		-
 			message: "#^Cannot access property \\$id on mixed\\.$#"
 			count: 1
@@ -60,6 +70,11 @@ parameters:
 			count: 1
 			path: packages/spa/src/Validation/Rules/DateTimeRule.php
 
+		-
+			message: "#^Method LastDragon_ru\\\\LaraASP\\\\Spa\\\\Validation\\\\Rules\\\\Rule\\:\\:validate\\(\\) has parameter \\$fail with no signature specified for Closure\\.$#"
+			count: 1
+			path: packages/spa/src/Validation/Rules/Rule.php
+
 		-
 			message: "#^Parameter \\#1 \\$query of method LastDragon_ru\\\\LaraASP\\\\Testing\\\\Comparators\\\\DatabaseQueryComparator\\:\\:normalize\\(\\) expects LastDragon_ru\\\\LaraASP\\\\Testing\\\\Database\\\\QueryLog\\\\Query, mixed given\\.$#"
 			count: 2