Merge pull request #339 from lptn/fix-tests

Stubs for Eloquent Builder: Use `$this` instead of `self<TModel>`
psalm · Jul 13, 2023 · 61a1ca4 · 61a1ca4
2 parents a91791e + 3df84b9
commit 61a1ca4
Show file tree

Hide file tree

Showing 18 changed files with 102 additions and 156 deletions.
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -21,4 +21,11 @@
       <code>null</code>
     </TypeDoesNotContainType>
   </file>
+  <file src="src/Handlers/Eloquent/ModelPropertyAccessorHandler.php">
+    <LessSpecificImplementedReturnType>
+      <code>array</code>
+      <code>array</code>
+      <code>array</code>
+    </LessSpecificImplementedReturnType>
+  </file>
 </files>
diff --git a/src/Fakes/FakeModelsCommand.php b/src/Fakes/FakeModelsCommand.php
@@ -13,7 +13,6 @@
 use function get_class;
 use function is_a;
 use function in_array;
-use function is_string;
 use function implode;
 
 /** @psalm-suppress PropertyNotSetInConstructor */
@@ -128,7 +127,7 @@ public function getPropertiesFromTable($model): void
             if ($this->write_model_magic_where) {
                 $this->setMethod(
                     Str::camel("where_" . $column_name),
-                    '\Illuminate\Database\Eloquent\Builder|\\' . get_class($model),
+                    '\Illuminate\Database\Eloquent\Builder<static>', // @todo support custom EloquentBuilders
                     array('$value')
                 );
             }

diff --git a/src/Handlers/Eloquent/ModelMethodHandler.php b/src/Handlers/Eloquent/ModelMethodHandler.php
@@ -24,14 +24,13 @@
 
 final class ModelMethodHandler implements MethodReturnTypeProviderInterface, AfterClassLikeVisitInterface
 {
-    /**
-     * @return array<string>
-     */
+    /** @inheritDoc */
     public static function getClassLikeNames(): array
     {
         return [Model::class];
     }
 
+    /** @inheritDoc */
     public static function getMethodReturnType(MethodReturnTypeProviderEvent $event): ?Type\Union
     {
         $source = $event->getSource();

diff --git a/src/Handlers/Eloquent/ModelPropertyAccessorHandler.php b/src/Handlers/Eloquent/ModelPropertyAccessorHandler.php
@@ -16,14 +16,13 @@
 
 final class ModelPropertyAccessorHandler implements PropertyExistenceProviderInterface, PropertyVisibilityProviderInterface, PropertyTypeProviderInterface
 {
-    /**
-     * @return list<class-string<\Illuminate\Database\Eloquent\Model>>
-     */
+    /** @inheritDoc */
     public static function getClassLikeNames(): array
     {
         return ModelStubProvider::getModelClasses();
     }
 
+    /** @inheritDoc */
     public static function doesPropertyExist(PropertyExistenceProviderEvent $event): ?bool
     {
         $source = $event->getSource();

diff --git a/src/Handlers/Eloquent/ModelRelationshipPropertyHandler.php b/src/Handlers/Eloquent/ModelRelationshipPropertyHandler.php
@@ -35,6 +35,7 @@ public static function getClassLikeNames(): array
         return ModelStubProvider::getModelClasses();
     }
 
+    /** @inheritDoc */
     public static function doesPropertyExist(PropertyExistenceProviderEvent $event): ?bool
     {
         $source = $event->getSource();

diff --git a/src/Handlers/Helpers/CacheHandler.php b/src/Handlers/Helpers/CacheHandler.php
@@ -10,11 +10,13 @@
 
 final class CacheHandler implements FunctionReturnTypeProviderInterface
 {
+    /** @inheritDoc */
     public static function getFunctionIds(): array
     {
         return ['cache'];
     }
 
+    /** @inheritDoc */
     public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $event): Type\Union
     {
         $call_args = $event->getCallArgs();

diff --git a/src/Handlers/Helpers/PathHandler.php b/src/Handlers/Helpers/PathHandler.php
@@ -39,6 +39,7 @@ public static function getFunctionIds(): array
         ];
     }
 
+    /** @inheritDoc */
     public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $event): ?Union
     {
         $function_id = $event->getFunctionId();
@@ -51,6 +52,7 @@ public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $ev
         });
     }
 
+    /** @inheritDoc */
     public static function getClassLikeNames(): array
     {
         return [

diff --git a/src/Handlers/Helpers/TransHandler.php b/src/Handlers/Helpers/TransHandler.php
@@ -8,11 +8,13 @@
 
 class TransHandler implements FunctionReturnTypeProviderInterface
 {
+    /** @inheritDoc */
     public static function getFunctionIds(): array
     {
         return ['trans'];
     }
 
+    /** @inheritDoc */
     public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $event): Type\Union
     {
         $call_args = $event->getCallArgs();

diff --git a/src/Providers/ApplicationProvider.php b/src/Providers/ApplicationProvider.php
@@ -32,6 +32,7 @@ public static function bootApp(): void
         if ($app instanceof LaravelApplication) {
             /** @var \Illuminate\Contracts\Console\Kernel $consoleApp */
             $consoleApp = $app->make(Kernel::class);
+            // @todo do not bootstrap \Illuminate\Foundation\Bootstrap\HandleExceptions
             $consoleApp->bootstrap();
         } else { // LumenApplication
             $app->boot();

diff --git a/stubs/Database/BelongsToMany.stubphp b/stubs/Database/BelongsToMany.stubphp
@@ -86,7 +86,7 @@ class BelongsToMany extends Relation
      * Execute the query and get the first result or throw an exception.
      *
      * @param  list<non-empty-string>  $columns
-     * @return \Illuminate\Database\Eloquent\Model|static
+     * @return \Illuminate\Database\Eloquent\Model
      * @psalm-return TRelatedModel
      *
      * @throws \Illuminate\Database\Eloquent\ModelNotFoundException

diff --git a/stubs/Database/EloquentBuilder.stubphp → stubs/Database/Builder.stubphp b/stubs/Database/EloquentBuilder.stubphp → stubs/Database/Builder.stubphp
@@ -2,6 +2,7 @@
 
 namespace Illuminate\Database\Eloquent;
 
+use Illuminate\Contracts\Database\Eloquent\Builder as BuilderContract;
 use Illuminate\Database\Concerns\BuildsQueries;
 use Illuminate\Database\Query\Builder as QueryBuilder;
 use Illuminate\Support\Traits\ForwardsCalls;
@@ -12,7 +13,7 @@ use Illuminate\Support\Traits\ForwardsCalls;
  *
  * @mixin \Illuminate\Database\Query\Builder
  */
-class Builder
+class Builder implements BuilderContract
 {
     use BuildsQueries, Concerns\QueriesRelationships, ForwardsCalls;
 
@@ -31,13 +32,13 @@ class Builder
     /**
      * @param  string  $identifier
      * @param  \Illuminate\Database\Eloquent\Scope|\Closure  $scope
-     * @return self<TModel>
+     * @return $this
      */
     public function withGlobalScope($identifier, $scope) {}
 
     /**
      * @param  \Illuminate\Database\Eloquent\Scope|string  $scope
-     * @return self<TModel>
+     * @return $this
      */
     public function withoutGlobalScope($scope) {}
 
@@ -54,33 +55,37 @@ class Builder
 
     /**
      * @param  array|null  $scopes
-     * @return self<TModel>
+     * @return $this
      */
     public function withoutGlobalScopes(array $scopes = null) {}
 
     /**
-     * @return array
+     * Get an array of global scopes that were removed from the query.
+     *
+     * @return list<non-empty-string>
      */
     public function removedScopes() {}
 
     /**
      * @param  mixed  $id
-     * @return self<TModel>
+     * @return $this
      */
     public function whereKey($id) {}
 
     /**
      * @param  mixed  $id
-     * @return self<TModel>
+     * @return $this
      */
     public function whereKeyNot($id) {}
 
     /**
-     * @param  string|array|\Closure  $column
+     * Add a basic where clause to the query.
+     *
+     * @param  (\Closure(static): void)|(\Closure(static): static)|string|array|\Illuminate\Contracts\Database\Query\Expression  $column
      * @param  mixed   $operator
      * @param  mixed   $value
      * @param  string  $boolean
-     * @return self<TModel>
+     * @return $this
      */
     public function where($column, $operator = null, $value = null, $boolean = 'and') {}
 
@@ -89,15 +94,15 @@ class Builder
      * @param  string  $operator
      * @param  \DateTimeInterface|string|null  $value
      * @param  string  $boolean
-     * @return self<TModel>
+     * @return $this
      */
     public function whereDate($column, $operator, $value = null, $boolean = 'and') {}
 
     /**
      * @param  \Closure|array|string  $column
      * @param  mixed  $operator
      * @param  mixed  $value
-     * @return self<TModel>
+     * @return $this
      */
     public function orWhere($column, $operator = null, $value = null) {}
 
@@ -106,7 +111,7 @@ class Builder
      * @param  \Closure|null  $callback
      * @param  string  $operator
      * @param  int  $count
-     * @return self<TModel>
+     * @return $this
      */
     public function whereHas($relation, \Closure $callback = null, $operator = '>=', $count = 1) {}
 
@@ -115,7 +120,7 @@ class Builder
      * @param  \Closure|string|array<mixed>|\Illuminate\Database\Query\Expression  $column
      * @param  mixed  $operator
      * @param  mixed  $value
-     * @return self<TModel>
+     * @return $this
      */
     public function whereRelation($relation, $column, $operator = null, $value = null) {}
 
@@ -131,7 +136,7 @@ class Builder
      * @param  \Closure|string|array<int, string>|\Illuminate\Database\Query\Expression  $column
      * @param  mixed  $operator
      * @param  mixed  $value
-     * @return self<TModel>
+     * @return $this
      */
     public function orWhereRelation($relation, $column, $operator = null, $value = null) {}
 
@@ -140,20 +145,20 @@ class Builder
      * @param  \Closure|null  $callback
      * @param  string  $operator
      * @param  int  $count
-     * @return self<TModel>
+     * @return $this
      */
     public function orWhereHas($relation, \Closure $callback = null, $operator = '>=', $count = 1) {}
 
     /**
-     * @template TRelatedModel of Model
-     * @template TChildModel of Model
+     * @template TRelatedModel of \Illuminate\Database\Eloquent\Model
+     * @template TChildModel of \Illuminate\Database\Eloquent\Model
      * @param  \Illuminate\Database\Eloquent\Relations\MorphTo<TRelatedModel, TChildModel>|string  $relation
      * @param  string|array<string>  $types
      * @param  string  $operator
      * @param  int  $count
      * @param  string  $boolean
      * @param  \Closure|null  $callback
-     * @return self<TModel>
+     * @return $this
      */
     public function hasMorph($relation, $types, $operator = '>=', $count = 1, $boolean = 'and', \Closure $callback = null) {}
 
@@ -380,13 +385,13 @@ class Builder
     public function getModels($columns = ['*']) {}
 
     /**
-     * @template TRelatedModel of Model
+     * @template TRelatedModel of \Illuminate\Database\Eloquent\Model
      * @param  \Illuminate\Database\Eloquent\Relations\Relation<TRelatedModel>|string  $relation
      * @param  string  $operator
      * @param  int  $count
      * @param  string  $boolean
      * @param  \Closure|null  $callback
-     * @return static
+     * @return $this
      *
      * @throws \RuntimeException
      */
@@ -396,27 +401,27 @@ class Builder
      * @param  string  $relation
      * @param  string  $operator
      * @param  int  $count
-     * @return static
+     * @return $this
      */
     public function orHas($relation, $operator = '>=', $count = 1) {}
 
     /**
      * @param  string  $relation
      * @param  string  $boolean
      * @param  \Closure|null  $callback
-     * @return static
+     * @return $this
      */
     public function doesntHave($relation, $boolean = 'and', \Closure $callback = null) {}
 
     /**
      * @param  string  $relation
-     * @return static
+     * @return $this
      */
     public function orDoesntHave($relation) {}
 
     /**
-     * @param  array  $models
-     * @return array
+     * @param  array<array-key, \Illuminate\Database\Eloquent\Model>  $models
+     * @return array<array-key, \Illuminate\Database\Eloquent\Model>
      */
     public function eagerLoadRelations(array $models) {}
 
@@ -427,7 +432,9 @@ class Builder
     public function getRelation($name) {}
 
     /**
-     * @return \Generator
+     * Get a lazy collection for the given query.
+     *
+     * @return \Illuminate\Support\LazyCollection
      */
     public function cursor() {}
 

diff --git a/stubs/Database/EloquentCollection.stubphp → stubs/Database/Collection.stubphp b/stubs/Database/EloquentCollection.stubphp → stubs/Database/Collection.stubphp
diff --git a/tests/Acceptance/acceptance/CollectionTypes.feature b/tests/Acceptance/acceptance/CollectionTypes.feature
@@ -27,9 +27,7 @@ Feature: Collection types
     """
     final class CollectionTypes
     {
-        /**
-         * @return Collection<int, string>
-         */
+        /** @return Collection<int, string> */
         public function getCollection(): Collection
         {
             return new Collection(['hi']);
@@ -68,9 +66,7 @@ Feature: Collection types
             });
         }
 
-        /**
-         * @return Collection<string, int>
-         */
+        /** @return Collection<string, int> */
         public function testFlip(): Collection
         {
           return $this->getCollection()->flip();
@@ -117,9 +113,7 @@ Feature: Collection types
             });
         }
 
-        /**
-         * @return int|false
-         */
+        /** @return int|false */
         public function searchUsingClosureTest()
         {
             return $this->getCollection()->search(function (string $item) {
@@ -143,9 +137,7 @@ Feature: Collection types
             return $this->getCollection()->shift(2);
         }
 
-        /**
-         * @return array<int, string>
-         */
+        /** @return array<int, string> */
         public function allTest(): array
         {
           return $this->getCollection()->all();

diff --git a/tests/Acceptance/acceptance/DatabaseBuilderTypes.feature b/tests/Acceptance/acceptance/DatabaseBuilderTypes.feature
@@ -25,9 +25,7 @@ Feature: Database Builder types
 
     final class UserRepository
     {
-        /**
-        * @param \Illuminate\Database\Eloquent\Builder<User> $builder
-        */
+        /** @param \Illuminate\Database\Eloquent\Builder<User> $builder */
         public function firstFromDatabaseBuilderInstance(\Illuminate\Database\Eloquent\Builder $builder): ?User {
           return $builder->first();
         }