Merge pull request #157 from caugner/firstOrCreate-firstOrNew

Ensure firstOrNew/Create can be called without parameters in Laravel 8+
psalm · Jul 13, 2021 · 5196f8f · 5196f8f
2 parents 04dd39b + 02f4b50
commit 5196f8f
Show file tree

Hide file tree

Showing 8 changed files with 256 additions and 66 deletions.
diff --git a/stubs/6/EloquentBuilder.stubphp b/stubs/6/EloquentBuilder.stubphp
@@ -0,0 +1,25 @@
+<?php
+
+namespace Illuminate\Database\Eloquent;
+/**
+ * @template-covariant TModel of \Illuminate\Database\Eloquent\Model
+ * @property-read HigherOrderBuilderProxy $orWhere
+ *
+ * @mixin \Illuminate\Database\Query\Builder
+ */
+class Builder
+{
+    /**
+     * @param  array  $attributes
+     * @param  array  $values
+     * @return TModel
+     */
+    public function firstOrNew(array $attributes, array $values = []) { }
+
+    /**
+     * @param  array  $attributes
+     * @param  array  $values
+     * @return TModel
+     */
+    public function firstOrCreate(array $attributes, array $values = []) { }
+}
diff --git a/stubs/6/HasOneOrMany.stubphp b/stubs/6/HasOneOrMany.stubphp
@@ -0,0 +1,27 @@
+<?php
+
+namespace Illuminate\Database\Eloquent\Relations;
+
+/**
+* @template TRelatedModel of Model
+* @template-extends Relation<TRelatedModel>
+* @mixin \Illuminate\Database\Eloquent\Builder<TRelatedModel>
+*/
+abstract class HasOneOrMany extends Relation
+{
+    /**
+     * @param  array  $attributes
+     * @param  array  $values
+     * @return \Illuminate\Database\Eloquent\Model
+     * @psalm-return TRelatedModel
+     */
+    public function firstOrNew(array $attributes, array $values = []) { }
+
+    /**
+     * @param  array  $attributes
+     * @param  array  $values
+     * @return \Illuminate\Database\Eloquent\Model
+     * @psalm-return TRelatedModel
+     */
+    public function firstOrCreate(array $attributes, array $values = []) { }
+}
diff --git a/stubs/8/EloquentBuilder.stubphp b/stubs/8/EloquentBuilder.stubphp
@@ -0,0 +1,26 @@
+<?php
+
+namespace Illuminate\Database\Eloquent;
+
+/**
+ * @template-covariant TModel of \Illuminate\Database\Eloquent\Model
+ * @property-read HigherOrderBuilderProxy $orWhere
+ *
+ * @mixin \Illuminate\Database\Query\Builder
+ */
+class Builder
+{
+    /**
+     * @param  array  $attributes
+     * @param  array  $values
+     * @return TModel
+     */
+    public function firstOrNew(array $attributes = [], array $values = []) { }
+
+    /**
+     * @param  array  $attributes
+     * @param  array  $values
+     * @return TModel
+     */
+    public function firstOrCreate(array $attributes = [], array $values = []) { }
+}
diff --git a/stubs/8/HasOneOrMany.stubphp b/stubs/8/HasOneOrMany.stubphp
@@ -0,0 +1,30 @@
+<?php
+
+namespace Illuminate\Database\Eloquent\Relations;
+
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Builder;
+
+/**
+* @template TRelatedModel of Model
+* @template-extends Relation<TRelatedModel>
+* @mixin \Illuminate\Database\Eloquent\Builder<TRelatedModel>
+*/
+abstract class HasOneOrMany extends Relation
+{
+    /**
+     * @param  array  $attributes
+     * @param  array  $values
+     * @return \Illuminate\Database\Eloquent\Model
+     * @psalm-return TRelatedModel
+     */
+    public function firstOrNew(array $attributes = [], array $values = []) { }
+
+    /**
+     * @param  array  $attributes
+     * @param  array  $values
+     * @return \Illuminate\Database\Eloquent\Model
+     * @psalm-return TRelatedModel
+     */
+    public function firstOrCreate(array $attributes = [], array $values = []) { }
+}
diff --git a/stubs/EloquentBuilder.stubphp b/stubs/EloquentBuilder.stubphp
@@ -136,20 +136,6 @@ class Builder
      */
     public function findOrNew($id, $columns = ['*']) { }
 
-    /**
-     * @param  array  $attributes
-     * @param  array  $values
-     * @return TModel
-     */
-    public function firstOrNew(array $attributes, array $values = []) { }
-
-    /**
-     * @param  array  $attributes
-     * @param  array  $values
-     * @return TModel
-     */
-    public function firstOrCreate(array $attributes, array $values = []) { }
-
     /**
      * @param  array  $attributes
      * @param  array  $values

diff --git a/stubs/HasOneOrMany.stubphp b/stubs/HasOneOrMany.stubphp
@@ -4,7 +4,6 @@ namespace Illuminate\Database\Eloquent\Relations;
 
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Builder;
-use Illuminate\Database\Eloquent\Collection;
 
 /**
 * @template TRelatedModel of Model
@@ -46,22 +45,6 @@ abstract class HasOneOrMany extends Relation
      */
     public function findOrNew($id, $columns = ['*']) { }
 
-    /**
-     * @param  array  $attributes
-     * @param  array  $values
-     * @return \Illuminate\Database\Eloquent\Model
-     * @psalm-return TRelatedModel
-     */
-    public function firstOrNew(array $attributes, array $values = []) { }
-
-    /**
-     * @param  array  $attributes
-     * @param  array  $values
-     * @return \Illuminate\Database\Eloquent\Model
-     * @psalm-return TRelatedModel
-     */
-    public function firstOrCreate(array $attributes, array $values = []) { }
-
     /**
      * @param  array  $attributes
      * @param  array  $values

diff --git a/tests/acceptance/EloquentBuilderTypes.feature b/tests/acceptance/EloquentBuilderTypes.feature
@@ -15,73 +15,78 @@ Feature: Eloquent Builder types
         </plugins>
       </psalm>
       """
+    And I have the following code preamble
+      """
+      <?php declare(strict_types=1);
+      namespace Tests\Psalm\LaravelPlugin\Sandbox;
+
+      use Illuminate\Database\Eloquent\Builder;
+      use Illuminate\Database\Eloquent\Collection;
+      use Tests\Psalm\LaravelPlugin\Models\User;
+      """
 
   Scenario: Models can call eloquent query builder instance methods
     Given I have the following code
     """
-    <?php declare(strict_types=1);
-
-    use Tests\Psalm\LaravelPlugin\Models\User;
-
     final class UserRepository
     {
 
         /**
-        * @return \Illuminate\Database\Eloquent\Builder<User>
+        * @return Builder<User>
         */
-        public function getNewQuery(): \Illuminate\Database\Eloquent\Builder
+        public function getNewQuery(): Builder
         {
           return User::query();
         }
 
         /**
-        * @return \Illuminate\Database\Eloquent\Builder<User>
+        * @return Builder<User>
         */
-        public function getNewModelQuery(): \Illuminate\Database\Eloquent\Builder
+        public function getNewModelQuery(): Builder
         {
           return (new User())->newModelQuery();
         }
 
         /**
-        * @param \Illuminate\Database\Eloquent\Builder<User> $builder
+        * @param Builder<User> $builder
         */
-        public function firstOrFailFromBuilderInstance(\Illuminate\Database\Eloquent\Builder $builder): User {
+        public function firstOrFailFromBuilderInstance(Builder $builder): User {
           return $builder->firstOrFail();
         }
 
         /**
-        * @param \Illuminate\Database\Eloquent\Builder<User> $builder
+        * @param Builder<User> $builder
         */
-        public function findOrFailFromBuilderInstance(\Illuminate\Database\Eloquent\Builder $builder): User {
+        public function findOrFailFromBuilderInstance(Builder $builder): User {
           return $builder->findOrFail(1);
         }
 
         /**
-        * @param \Illuminate\Database\Eloquent\Builder<User> $builder
-        * @return \Illuminate\Database\Eloquent\Collection<User>
+        * @param Builder<User> $builder
+        * @return Collection<User>
         */
-        public function findMultipleOrFailFromBuilderInstance(\Illuminate\Database\Eloquent\Builder $builder): \Illuminate\Database\Eloquent\Collection {
+        public function findMultipleOrFailFromBuilderInstance(Builder $builder): Collection {
           return $builder->findOrFail([1, 2]);
         }
 
         /**
-        * @param \Illuminate\Database\Eloquent\Builder<User> $builder
+        * @param Builder<User> $builder
         */
-        public function findOne(\Illuminate\Database\Eloquent\Builder $builder): ?User {
+        public function findOne(Builder $builder): ?User {
           return $builder->find(1);
         }
 
         /**
-        * @param \Illuminate\Database\Eloquent\Builder<User> $builder
+        * @param Builder<User> $builder
         */
-        public function findViaArray(\Illuminate\Database\Eloquent\Builder $builder): \Illuminate\Database\Eloquent\Collection {
+        public function findViaArray(Builder $builder): Collection {
           return $builder->find([1]);
         }
 
         /**
-        * @return \Illuminate\Database\Eloquent\Builder<User>
+        * @return Builder<User>
         */
-        public function getWhereBuilderViaInstance(array $attributes): \Illuminate\Database\Eloquent\Builder {
+        public function getWhereBuilderViaInstance(array $attributes): Builder {
           return (new User())->where($attributes);
         }
     }
@@ -90,10 +95,16 @@ Feature: Eloquent Builder types
     Then I see no errors
 
   Scenario: can call static methods on model
-    Given I have the following code
+    Given I have the following code preamble
     """
     <?php declare(strict_types=1);
 
+    use Illuminate\Database\Eloquent\Builder;
+    use Illuminate\Database\Eloquent\Collection;
+    """
+    And I have the following code
+    """
+
     final class User extends \Illuminate\Database\Eloquent\Model {
       protected $table = 'users';
     };
@@ -102,17 +113,17 @@ Feature: Eloquent Builder types
     {
 
         /**
-        * @return \Illuminate\Database\Eloquent\Builder<User>
+        * @return Builder<User>
         */
-        public function getWhereBuilderViaStatic(array $attributes): \Illuminate\Database\Eloquent\Builder
+        public function getWhereBuilderViaStatic(array $attributes): Builder
         {
           return User::where($attributes);
         }
 
         /**
-        * @psalm-return \Illuminate\Database\Eloquent\Collection<User>
+        * @psalm-return Collection<User>
         */
-        public function getWhereViaStatic(array $attributes): \Illuminate\Database\Eloquent\Collection
+        public function getWhereViaStatic(array $attributes): Collection
         {
           return User::where($attributes)->get();
         }
@@ -122,20 +133,25 @@ Feature: Eloquent Builder types
     Then I see no errors
 
   Scenario:
-    Given I have the following code
+    Given I have the following code preamble
     """
     <?php declare(strict_types=1);
 
-    final class User extends \Illuminate\Database\Eloquent\Model {
+    use Illuminate\Database\Eloquent\Builder;
+    use Illuminate\Database\Eloquent\Model;
+    """
+    And I have the following code
+    """
+    final class User extends Model {
       protected $table = 'users';
     };
 
     final class UserRepository
     {
         /**
-        * @return \Illuminate\Database\Eloquent\Builder<User>
+        * @return Builder<User>
         */
-        public function test_failure(): \Illuminate\Database\Eloquent\Builder
+        public function test_failure(): Builder
         {
           return User::fakeQueryMethodThatDoesntExist();
         }
@@ -150,11 +166,6 @@ Feature: Eloquent Builder types
   Scenario: can call methods on underlying query builder
     Given I have the following code
     """
-    <?php declare(strict_types=1);
-
-    use Tests\Psalm\LaravelPlugin\Models\User;
-    use \Illuminate\Database\Eloquent\Builder;
-
     /**
     * @psalm-param Builder<User> $builder
     * @psalm-return Builder<User>
@@ -165,3 +176,52 @@ Feature: Eloquent Builder types
     """
     When I run Psalm
     Then I see no errors
+
+  Scenario: cannot call firstOrNew and firstOrCreate without parameters in Laravel 6.x
+    Given I have the "laravel/framework" package satisfying the "6.*"
+    And I have the following code
+    """
+    /**
+    * @psalm-param Builder<User> $builder
+    * @psalm-return User
+    */
+    function test_firstOrCreate(Builder $builder): User {
+      return $builder->firstOrCreate();
+    }
+
+    /**
+    * @psalm-param Builder<User> $builder
+    * @psalm-return User
+    */
+    function test_firstOrNew(Builder $builder): User {
+      return $builder->firstOrNew();
+    }
+    """
+    When I run Psalm
+    Then I see these errors
+      | Type  | Message |
+      | TooFewArguments | Too few arguments for method Illuminate\Database\Eloquent\Builder::firstorcreate saw 0 |
+      | TooFewArguments | Too few arguments for method Illuminate\Database\Eloquent\Builder::firstornew saw 0    |
+
+  Scenario: can call firstOrNew and firstOrCreate without parameters in Laravel 8.x
+    Given I have the "laravel/framework" package satisfying the ">= 8.0"
+    And I have the following code
+    """
+    /**
+    * @psalm-param Builder<User> $builder
+    * @psalm-return User
+    */
+    function test_firstOrCreate(Builder $builder): User {
+      return $builder->firstOrCreate();
+    }
+
+    /**
+    * @psalm-param Builder<User> $builder
+    * @psalm-return User
+    */
+    function test_firstOrNew(Builder $builder): User {
+      return $builder->firstOrNew();
+    }
+    """
+    When I run Psalm
+    Then I see no errors