Add option for only eloquent (#1636)

* Add option for only eloquent * composer fix-style * Add snapshot * Add option to models command * composer fix-style * Fix namespace --------- Co-authored-by: laravel-ide-helper <[email protected]>
2026-08-17 17:47:13 +00:00 · 2024-12-29 11:51:09 +01:00
parent 14fdb572bb
commit 347483be03
13 changed files with 305 additions and 45343 deletions
@@ -113,7 +113,12 @@ class GeneratorCommand extends Command
        }

        $generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers);
-        $content = $generator->generate();
+        if ($this->option('eloquent')) {
+            $content = $generator->generateEloquent();
+        } else {
+            $content = $generator->generate();
+        }
+
        $written = $this->files->put($filename, $content);

        if ($written !== false) {
@@ -169,6 +174,7 @@ class GeneratorCommand extends Command
            ['write_mixins', 'W', InputOption::VALUE_OPTIONAL, 'Write mixins to Laravel Model?', $writeMixins],
            ['helpers', 'H', InputOption::VALUE_NONE, 'Include the helper files'],
            ['memory', 'M', InputOption::VALUE_NONE, 'Use sqlite memory driver'],
+            ['eloquent', 'E', InputOption::VALUE_NONE, 'Only write Eloquent methods'],
        ];
    }
 }
@@ -12,6 +12,7 @@
 namespace Barryvdh\LaravelIdeHelper\Console;

 use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
+use Barryvdh\LaravelIdeHelper\Generator;
 use Barryvdh\LaravelIdeHelper\Parsers\PhpDocReturnTypeParser;
 use Barryvdh\Reflection\DocBlock;
 use Barryvdh\Reflection\DocBlock\Context;
@@ -19,6 +20,7 @@ use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
 use Barryvdh\Reflection\DocBlock\Tag;
 use Composer\ClassMapGenerator\ClassMapGenerator;
 use Illuminate\Console\Command;
+use Illuminate\Contracts\Config\Repository;
 use Illuminate\Contracts\Database\Eloquent\Castable;
 use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
 use Illuminate\Contracts\Database\Eloquent\CastsInboundAttributes;
@@ -46,6 +48,7 @@ use Illuminate\Filesystem\Filesystem;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
+use Illuminate\View\Factory as ViewFactory;
 use phpDocumentor\Reflection\Types\ContextFactory;
 use ReflectionClass;
 use ReflectionNamedType;
@@ -82,6 +85,14 @@ class ModelsCommand extends Command
     */
    protected $files;

+    /**
+     * @var Repository
+     */
+    protected $config;
+
+    /** @var ViewFactory */
+    protected $view;
+
    /**
     * The console command name.
     *
@@ -131,10 +142,12 @@ class ModelsCommand extends Command
    /**
     * @param Filesystem $files
     */
-    public function __construct(Filesystem $files)
+    public function __construct(Filesystem $files, Repository $config, ViewFactory $view)
    {
-        parent::__construct();
+        $this->config = $config;
        $this->files = $files;
+        $this->view = $view;
+        parent::__construct();
    }

    /**
@@ -187,6 +200,27 @@ class ModelsCommand extends Command
                $this->error("Failed to write model information to $filename");
            }
        }
+
+        $helperFilename = $this->config->get('ide-helper.filename');
+        $writeHelper = $this->option('write-eloquent-helper');
+
+        if (!$writeHelper && !$this->files->exists($helperFilename) && ($this->write || $this->write_mixin)) {
+            if ($this->confirm("{$helperFilename} does not exist.
+            Do you want to generate a minimal helper to generate the Eloquent methods?")) {
+                $writeHelper = true;
+            }
+        }
+
+        if ($writeHelper) {
+            $generator = new Generator($this->config, $this->view, $this->getOutput());
+            $content = $generator->generateEloquent();
+            $written = $this->files->put($helperFilename, $content);
+            if ($written !== false) {
+                $this->info("Eloquent helper was written to $helperFilename");
+            } else {
+                $this->error("Failed to write eloquent helper to $helperFilename");
+            }
+        }
    }


@@ -217,6 +251,9 @@ class ModelsCommand extends Command
            ['write-mixin', 'M', InputOption::VALUE_NONE,
                "Write models to {$this->filename} and adds @mixin to each model, avoiding IDE duplicate declaration warnings",
            ],
+            ['write-eloquent-helper', 'E', InputOption::VALUE_NONE,
+                'Write Eloquent helper file to _ide_helper.php',
+            ],
            ['nowrite', 'N', InputOption::VALUE_NONE, 'Don\'t write to Model file'],
            ['reset', 'R', InputOption::VALUE_NONE, 'Remove the original phpdocs instead of appending'],
            ['smart-reset', 'r', InputOption::VALUE_NONE, 'Retained for compatibility, while it no longer has any effect'],
@@ -11,6 +11,7 @@

 namespace Barryvdh\LaravelIdeHelper;

+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\AliasLoader;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Facade;
@@ -89,6 +90,33 @@ class Generator
            ->render();
    }

+    public function generateEloquent()
+    {
+        $name = 'Eloquent';
+        $facade = Model::class;
+        $magicMethods = array_key_exists($name, $this->magic) ? $this->magic[$name] : [];
+        $alias = new Alias($this->config, $name, $facade, $magicMethods, $this->interfaces);
+        if ($alias->isValid()) {
+            //Add extra methods, from other classes (magic static calls)
+            if (array_key_exists($name, $this->extra)) {
+                $alias->addClass($this->extra[$name]);
+            }
+
+            $eloquentAliases['__root'] = [$alias];
+        }
+
+        $app = app();
+        return $this->view->make('helper')
+            ->with('namespaces_by_extends_ns', [])
+            ->with('namespaces_by_alias_ns', $eloquentAliases)
+            ->with('real_time_facades', [])
+            ->with('helpers', '')
+            ->with('version', $app->version())
+            ->with('include_fluent', false)
+            ->with('factories', [])
+            ->render();
+    }
+
    protected function detectDrivers()
    {
        $defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
@@ -65,7 +65,7 @@ class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProv
        $configPath = __DIR__ . '/../config/ide-helper.php';
        $this->mergeConfigFrom($configPath, 'ide-helper');

-        $this->app->when([GeneratorCommand::class, MetaCommand::class])
+        $this->app->when([GeneratorCommand::class, MetaCommand::class, ModelsCommand::class])
            ->needs(\Illuminate\Contracts\View\Factory::class)
            ->give(function () {
                return $this->createLocalViewFactory();
@@ -2,7 +2,7 @@

 declare(strict_types=1);

-namespace Barryvdh\LaravelIdeHelper\Tests\Console;
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\EloquentCommand;

 use Barryvdh\LaravelIdeHelper\Console\EloquentCommand;
 use Barryvdh\LaravelIdeHelper\Tests\TestCase;
@@ -23,7 +23,7 @@ class EloquentCommandTest extends TestCase
        }

        $actualContent = null;
-        $mockFilesystem = Mockery::mock(Filesystem::class);
+        $mockFilesystem = Mockery::mock(Filesystem::class)->makePartial();
        $mockFilesystem
            ->shouldReceive('get')
            // We don't care about actual args (filename)
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\GenerateEloquentOnly;
+
+use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
+
+class Test extends AbstractGeneratorCommand
+{
+    public function testGenerator(): void
+    {
+        $command = $this->app->make(GeneratorCommand::class);
+
+        $tester = $this->runCommand($command, [
+            '--eloquent' => true,
+        ]);
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('A new helper file was written to _ide_helper.php', $tester->getDisplay());
+        $this->assertStringNotContainsString('public static function configure($basePath = null)', $this->mockFilesystemOutput);
+        $this->assertStringContainsString('class Eloquent extends \Illuminate\Database\Eloquent\Model', $this->mockFilesystemOutput);
+    }
+}
@@ -19,6 +19,8 @@ class Test extends AbstractModelsCommand

        $this->assertSame(0, $tester->getStatusCode());
        $this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
+        $this->assertStringContainsString('Do you want to generate a minimal helper to generate the Eloquent methods?', $tester->getDisplay());
+
        $this->assertMatchesMockedSnapshot();
    }
 }
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpdocWithEloquentHelper\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class Post extends Model
+{
+}
@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpdocWithEloquentHelper;
+
+use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
+use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
+
+class Test extends AbstractModelsCommand
+{
+    public function test(): void
+    {
+        $command = $this->app->make(ModelsCommand::class);
+
+        $tester = $this->runCommand($command, [
+            '--write' => true,
+            '--write-eloquent-helper' => true,
+        ]);
+
+        $this->assertSame(0, $tester->getStatusCode());
+        $this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
+        $this->assertStringNotContainsString('Do you want to generate a minimal helper to generate the Eloquent methods?', $tester->getDisplay());
+        $this->assertStringContainsString('Eloquent helper was written to _ide_helper.php', $tester->getDisplay());
+
+        //        $this->assertMatchesMockedSnapshot();
+    }
+}
@@ -0,0 +1,161 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpdocWithEloquentHelper\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * 
+ *
+ * @property int $id
+ * @property string|null $char_nullable
+ * @property string $char_not_nullable
+ * @property string|null $string_nullable
+ * @property string $string_not_nullable
+ * @property string|null $text_nullable
+ * @property string $text_not_nullable
+ * @property string|null $medium_text_nullable
+ * @property string $medium_text_not_nullable
+ * @property string|null $long_text_nullable
+ * @property string $long_text_not_nullable
+ * @property int|null $integer_nullable
+ * @property int $integer_not_nullable
+ * @property int|null $tiny_integer_nullable
+ * @property int $tiny_integer_not_nullable
+ * @property int|null $small_integer_nullable
+ * @property int $small_integer_not_nullable
+ * @property int|null $medium_integer_nullable
+ * @property int $medium_integer_not_nullable
+ * @property int|null $big_integer_nullable
+ * @property int $big_integer_not_nullable
+ * @property int|null $unsigned_integer_nullable
+ * @property int $unsigned_integer_not_nullable
+ * @property int|null $unsigned_tiny_integer_nullable
+ * @property int $unsigned_tiny_integer_not_nullable
+ * @property int|null $unsigned_small_integer_nullable
+ * @property int $unsigned_small_integer_not_nullable
+ * @property int|null $unsigned_medium_integer_nullable
+ * @property int $unsigned_medium_integer_not_nullable
+ * @property int|null $unsigned_big_integer_nullable
+ * @property int $unsigned_big_integer_not_nullable
+ * @property float|null $float_nullable
+ * @property float $float_not_nullable
+ * @property float|null $double_nullable
+ * @property float $double_not_nullable
+ * @property string|null $decimal_nullable
+ * @property string $decimal_not_nullable
+ * @property int|null $boolean_nullable
+ * @property int $boolean_not_nullable
+ * @property string|null $enum_nullable
+ * @property string $enum_not_nullable
+ * @property string|null $json_nullable
+ * @property string $json_not_nullable
+ * @property string|null $jsonb_nullable
+ * @property string $jsonb_not_nullable
+ * @property string|null $date_nullable
+ * @property string $date_not_nullable
+ * @property string|null $datetime_nullable
+ * @property string $datetime_not_nullable
+ * @property string|null $datetimetz_nullable
+ * @property string $datetimetz_not_nullable
+ * @property string|null $time_nullable
+ * @property string $time_not_nullable
+ * @property string|null $timetz_nullable
+ * @property string $timetz_not_nullable
+ * @property string|null $timestamp_nullable
+ * @property string $timestamp_not_nullable
+ * @property string|null $timestamptz_nullable
+ * @property string $timestamptz_not_nullable
+ * @property int|null $year_nullable
+ * @property int $year_not_nullable
+ * @property string|null $binary_nullable
+ * @property string $binary_not_nullable
+ * @property string|null $uuid_nullable
+ * @property string $uuid_not_nullable
+ * @property string|null $ipaddress_nullable
+ * @property string $ipaddress_not_nullable
+ * @property string|null $macaddress_nullable
+ * @property string $macaddress_not_nullable
+ * @property \Illuminate\Support\Carbon|null $created_at
+ * @property \Illuminate\Support\Carbon|null $updated_at
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post newModelQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post newQuery()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post query()
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBigIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBigIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBinaryNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBinaryNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBooleanNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereBooleanNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCharNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCharNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereCreatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDateNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDateNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimeNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimeNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimetzNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDatetimetzNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDecimalNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDecimalNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDoubleNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereDoubleNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereEnumNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereEnumNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereFloatNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereFloatNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereId($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIpaddressNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereIpaddressNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonbNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereJsonbNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereLongTextNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereLongTextNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMacaddressNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMacaddressNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumTextNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereMediumTextNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereSmallIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereSmallIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereStringNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereStringNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTextNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTextNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimeNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimeNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestampNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestampNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestamptzNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimestamptzNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimetzNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTimetzNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTinyIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereTinyIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedBigIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedBigIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedMediumIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedMediumIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedSmallIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedSmallIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedTinyIntegerNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUnsignedTinyIntegerNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUpdatedAt($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUuidNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereUuidNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereYearNotNullable($value)
+ * @method static \Illuminate\Database\Eloquent\Builder<static>|Post whereYearNullable($value)
+ * @mixin \Eloquent
+ */
+class Post extends Model
+{
+}
@@ -36,7 +36,7 @@ class Test extends AbstractModelsCommand
    {
        $actualContent = null;

-        $mockFilesystem = Mockery::mock(Filesystem::class);
+        $mockFilesystem = Mockery::mock(Filesystem::class)->makePartial();
        $mockFilesystem
            ->shouldReceive('get')
            ->andReturn(file_get_contents(__DIR__ . '/Models/Simple.php'))