[12.x] Add NamedScope attribute (#54450)

* Add NamedScope attribute

* StyleCI

* Make Model::getAttributedNamedScope() protected

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* fix(database): ✏ Fix typo

* refactor(database): 🚚 Rename attribute class

to comply with PSR-4

* refactor(database): ✅ Simplify test

* refactor(database): ♻️ Simplify named local scope attribute check logic

* fix(database): 🐛 Make attributed named scope statically callable

* style(database): 🚨 StyleCI

* style(database): 🚨 StyleCI

* formatting

* add files

* fix tests

---------

Signed-off-by: Mior Muhammad Zaki <[email protected]>
Co-authored-by: Mior Muhammad Zaki <[email protected]>
Co-authored-by: Taylor Otwell <[email protected]>

Author: 3 people

src/Illuminate/Database/Eloquent/Attributes/Scope.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Illuminate\Database\Eloquent\Attributes;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_METHOD)]
+class Scope
+{
+    /**
+     * Create a new attribute instance.
+     *
+     * @param  array|string  $classes
+     * @return void
+     */
+    public function __construct()
+    {
+    }
+}

src/Illuminate/Database/Eloquent/Model.php

@@ -11,6 +11,7 @@
 use Illuminate\Contracts\Support\CanBeEscapedWhenCastToString;
 use Illuminate\Contracts\Support\Jsonable;
 use Illuminate\Database\ConnectionResolverInterface as Resolver;
+use Illuminate\Database\Eloquent\Attributes\Scope as LocalScope;
 use Illuminate\Database\Eloquent\Collection as EloquentCollection;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\Concerns\AsPivot;
@@ -24,6 +25,7 @@
 use JsonException;
 use JsonSerializable;
 use LogicException;
+use ReflectionMethod;
 use Stringable;
 
 abstract class Model implements Arrayable, ArrayAccess, CanBeEscapedWhenCastToString, HasBroadcastChannel, Jsonable, JsonSerializable, QueueableEntity, Stringable, UrlRoutable
@@ -1639,7 +1641,8 @@ public function newPivot(self $parent, array $attributes, $table, $exists, $usin
      */
     public function hasNamedScope($scope)
     {
-        return method_exists($this, 'scope'.ucfirst($scope));
+        return method_exists($this, 'scope'.ucfirst($scope)) ||
+            static::isScopeMethodWithAttribute($scope);
     }
 
     /**
@@ -1651,9 +1654,26 @@ public function hasNamedScope($scope)
      */
     public function callNamedScope($scope, array $parameters = [])
     {
+        if ($this->isScopeMethodWithAttribute($scope)) {
+            return $this->{$scope}(...$parameters);
+        }
+
         return $this->{'scope'.ucfirst($scope)}(...$parameters);
     }
 
+    /**
+     * Determine if the given method has a scope attribute.
+     *
+     * @param  string  $method
+     * @return bool
+     */
+    protected static function isScopeMethodWithAttribute(string $method)
+    {
+        return method_exists(static::class, $method) &&
+            (new ReflectionMethod(static::class, $method))
+                ->getAttributes(LocalScope::class) !== [];
+    }
+
     /**
      * Convert the model instance to an array.
      *
@@ -2381,6 +2401,10 @@ public function __call($method, $parameters)
      */
     public static function __callStatic($method, $parameters)
     {
+        if (static::isScopeMethodWithAttribute($method)) {
+            $parameters = [static::query(), ...$parameters];
+        }
+
         return (new static)->$method(...$parameters);
     }
 

tests/Integration/Database/EloquentModelScopeTest.php

@@ -2,6 +2,8 @@
 
 namespace Illuminate\Tests\Integration\Database;
 
+use Illuminate\Contracts\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Attributes\Scope as NamedScope;
 use Illuminate\Database\Eloquent\Model;
 
 class EloquentModelScopeTest extends DatabaseTestCase
@@ -19,12 +21,25 @@ public function testModelDoesNotHaveScope()
 
         $this->assertFalse($model->hasNamedScope('doesNotExist'));
     }
+
+    public function testModelHasAttributedScope()
+    {
+        $model = new TestScopeModel1;
+
+        $this->assertTrue($model->hasNamedScope('existsAsWell'));
+    }
 }
 
 class TestScopeModel1 extends Model
 {
-    public function scopeExists()
+    public function scopeExists(Builder $builder)
+    {
+        return $builder;
+    }
+
+    #[NamedScope]
+    protected function existsAsWell(Builder $builder)
     {
-        return true;
+        return $builder;
     }
 }

tests/Integration/Database/EloquentNamedScopeAttibuteTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Database;
+
+use Orchestra\Testbench\Attributes\WithMigration;
+use Orchestra\Testbench\TestCase;
+
+#[WithMigration]
+class EloquentNamedScopeAttibuteTest extends TestCase
+{
+    protected $query = 'select * from "named_scope_users" where "email_verified_at" is not null';
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->markTestSkippedUnless(
+            $this->usesSqliteInMemoryDatabaseConnection(),
+            'Requires in-memory database connection',
+        );
+    }
+
+    public function test_it_can_query_named_scoped_from_the_query_builder()
+    {
+        $query = Fixtures\NamedScopeUser::query()->verified(true);
+
+        $this->assertSame($this->query, $query->toRawSql());
+    }
+
+    public function test_it_can_query_named_scoped_from_static_query()
+    {
+        $query = Fixtures\NamedScopeUser::verified(true);
+
+        $this->assertSame($this->query, $query->toRawSql());
+    }
+}

tests/Integration/Database/Fixtures/NamedScopeUser.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Database\Fixtures;
+
+use Illuminate\Database\Eloquent\Attributes\Scope as NamedScope;
+use Illuminate\Database\Eloquent\Builder;
+
+class NamedScopeUser extends User
+{
+    /** {@inheritdoc} */
+    #[\Override]
+    protected function casts(): array
+    {
+        return [
+            'email_verified_at' => 'datetime',
+            'password' => 'hashed',
+        ];
+    }
+
+    #[NamedScope]
+    protected function verified(Builder $builder, bool $email = true)
+    {
+        return $builder->when(
+            $email === true,
+            fn ($query) => $query->whereNotNull('email_verified_at'),
+            fn ($query) => $query->whereNull('email_verified_at'),
+        );
+    }
+
+    public function scopeVerifiedUser(Builder $builder, bool $email = true)
+    {
+        return $builder->when(
+            $email === true,
+            fn ($query) => $query->whereNotNull('email_verified_at'),
+            fn ($query) => $query->whereNull('email_verified_at'),
+        );
+    }
+}