feat: add BuilderMakeCommand to generate builder classes

Author: MrPunyapal

src/Commands/BuilderMakeCommand.php

@@ -0,0 +1,135 @@
+<?php
+
+namespace MrPunyapal\LaravelExtendedCommands\Commands;
+
+use Illuminate\Console\GeneratorCommand;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Input\InputOption;
+
+#[AsCommand(name: 'make:builder')]
+class BuilderMakeCommand extends GeneratorCommand
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'make:builder';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new builder class';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Builder';
+
+    /**
+     * Determine if the class already exists.
+     *
+     * @param  string  $rawName
+     * @return bool
+     */
+    protected function alreadyExists($rawName)
+    {
+        return class_exists($rawName) ||
+               $this->files->exists($this->getPath($this->qualifyClass($rawName)));
+    }
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        return $this->resolveStubPath('/../../stubs/builder.stub');
+    }
+
+    /**
+     * Resolve the fully-qualified path to the stub.
+     *
+     * @param  string  $stub
+     * @return string
+     */
+    protected function resolveStubPath($stub)
+    {
+        return file_exists($customPath = $this->laravel->basePath(trim($stub, '/')))
+            ? $customPath
+            : __DIR__.$stub;
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param  string  $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace.'\Models\Builders';
+    }
+
+    /**
+     * Build the class with the given name.
+     *
+     * @param  string  $name
+     * @return string
+     *
+     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
+     */
+    protected function buildClass($name)
+    {
+        $replace = $this->buildModelReplacements();
+
+        return str_replace(
+            array_keys($replace), array_values($replace), parent::buildClass($name)
+        );
+    }
+
+    /**
+     * Build the replacements for a model.
+     *
+     * @return array<string, string>
+     */
+    protected function buildModelReplacements()
+    {
+        $replacements = [];
+
+        if ($this->option('model')) {
+            $modelNamespace = $this->option('model');
+
+            $replacements['{{ modelPhpdoc }}'] = <<<EOT
+            /**
+             * @template TModel of $modelNamespace
+             *
+             * @extends Builder<$modelNamespace>
+             */
+            EOT;
+        } else {
+            $replacements["{{ modelPhpdoc }}\n"] = '';
+            $replacements["{{ modelPhpdoc }}\r\n"] = '';
+        }
+
+        return $replacements;
+    }
+
+    /**
+     * Get the console command options.
+     *
+     * @return array
+     */
+    protected function getOptions()
+    {
+        return [
+            ['model', 'm', InputOption::VALUE_REQUIRED, 'The model that the builder applies to'],
+            ['force', 'f', InputOption::VALUE_NONE, 'Create the class even if the event already exists'],
+        ];
+    }
+}

src/LaravelExtendedCommandsServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace MrPunyapal\LaravelExtendedCommands;
 
+use MrPunyapal\LaravelExtendedCommands\Commands\BuilderMakeCommand;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -16,6 +17,7 @@ public function configurePackage(Package $package): void
          */
         $package
             ->name('laravel-extended-commands')
-            ->hasConfigFile();
+            ->hasConfigFile()
+            ->hasCommand(BuilderMakeCommand::class);
     }
 }

stubs/builder.stub

@@ -0,0 +1,11 @@
+<?php
+
+namespace {{ namespace }};
+
+use Illuminate\Database\Eloquent\Builder;
+
+{{ modelPhpdoc }}
+class {{ class }} extends Builder
+{
+    //
+}