feat(ModelsCommand): add support for the new Scope attribute (#1694)

* composer fix-style

* feat(model): add support for new Scope attribute

* composer fix-style

* snapshot

* check if class_exists for psalm

* check if class_exists for psalm

* resolve psalm issue

* remove prefix slash

* revert whitespace changes

* composer fix-style

* Update composer.json

---------

Co-authored-by: laravel-ide-helper <laravel-ide-helper@users.noreply.github.com>
Co-authored-by: Barry vd. Heuvel <barryvdh@gmail.com>

Author: 3 people

resources/views/helper.php

@@ -29,7 +29,7 @@
 <?php foreach ($namespaces_by_extends_ns as $namespace => $aliases) : ?>
 namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
     <?php foreach ($aliases as $alias) : ?>
-<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $alias->getClassType() ?> <?= $alias->getExtendsClass() ?><?php if($alias->shouldExtendParentClass()): ?> extends <?= $alias->getParentClass() ?><?php endif; ?> {
+<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $alias->getClassType() ?> <?= $alias->getExtendsClass() ?><?php if ($alias->shouldExtendParentClass()): ?> extends <?= $alias->getParentClass() ?><?php endif; ?> {
         <?php foreach ($alias->getMethods() as $method) : ?>
 <?= trim($method->getDocComment($s2)) . "\n{$s2}" ?>public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
         {<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
@@ -76,7 +76,7 @@
 
 <?php endforeach; ?>
 
-<?php foreach($real_time_facades as $name): ?>
+<?php foreach ($real_time_facades as $name): ?>
 <?php $nested = explode('\\', str_replace('\\' . class_basename($name), '', $name)); ?>
 namespace <?php echo implode('\\', $nested); ?> {
     /**

resources/views/meta.php

@@ -81,7 +81,7 @@
 
     <?php if (isset($expectedArgumentSets)): ?>
     <?php foreach ($expectedArgumentSets as $name => $argumentsList) : ?>
-    registerArgumentsSet('<?= $name ?>', <?php foreach ($argumentsList as $i => $arg) : ?><?php if($i % 5 == 0) {
+    registerArgumentsSet('<?= $name ?>', <?php foreach ($argumentsList as $i => $arg) : ?><?php if ($i % 5 == 0) {
         echo "\n";
     } ?><?= var_export($arg, true); ?>,<?php endforeach; ?>);
     <?php endforeach; ?>

src/Console/ModelsCommand.php

@@ -669,9 +669,11 @@ public function getPropertiesFromMethods($model)
                         $comment = $this->getCommentFromDocBlock($reflection);
                         $this->setProperty($name, null, null, true, $comment);
                     }
-                } elseif (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes') {
+                } elseif (!empty($reflection->getAttributes('Illuminate\Database\Eloquent\Attributes\Scope')) || (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes')) {
+                    $scopeUsingAttribute = !empty($reflection->getAttributes('Illuminate\Database\Eloquent\Attributes\Scope'));
+
                     //Magic scope<name>Attribute
-                    $name = Str::camel(substr($method, 5));
+                    $name = $scopeUsingAttribute ? $method : Str::camel(substr($method, 5));
                     if (!empty($name)) {
                         $comment = $this->getCommentFromDocBlock($reflection);
                         $args = $this->getParameters($reflection);

tests/Console/ModelsCommand/QueryScopes/Models/Comment.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
+
+use Illuminate\Database\Eloquent\Attributes\Scope;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+
+class Comment extends Model
+{
+    /**
+     * @comment Scope using the 'Scope' attribute
+     * @param Builder $query
+     * @return void
+     */
+    #[Scope]
+    protected function local(Builder $query): void
+    {
+        $query->where('ip_address', '127.0.0.1');
+    }
+
+    /**
+     * @comment Scope using the 'scope' prefix
+     * @param Builder $query
+     * @return void
+     */
+    protected function scopeSystem(Builder $query): void
+    {
+        $query->where('system', true);
+    }
+}

tests/Console/ModelsCommand/QueryScopes/__snapshots__/Test__test__1.php

@@ -4,6 +4,49 @@
 
 namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
 
+use Illuminate\Database\Eloquent\Attributes\Scope;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * 
+ *
+ * @method static Builder<static>|Comment local() Scope using the 'Scope' attribute
+ * @method static Builder<static>|Comment newModelQuery()
+ * @method static Builder<static>|Comment newQuery()
+ * @method static Builder<static>|Comment query()
+ * @method static Builder<static>|Comment system() Scope using the 'scope' prefix
+ * @mixin \Eloquent
+ */
+class Comment extends Model
+{
+    /**
+     * @comment Scope using the 'Scope' attribute
+     * @param Builder $query
+     * @return void
+     */
+    #[Scope]
+    protected function local(Builder $query): void
+    {
+        $query->where('ip_address', '127.0.0.1');
+    }
+
+    /**
+     * @comment Scope using the 'scope' prefix
+     * @param Builder $query
+     * @return void
+     */
+    protected function scopeSystem(Builder $query): void
+    {
+        $query->where('system', true);
+    }
+}
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
+
 /**
  * 
  *