diff src/Generator/BaseGenerator.php @ 21:f0b0d014e448 main-dev

Cleaning up code based on AI overlord review
author Luka Sitas <sitas.luka.97@gmail.com>
date Wed, 26 Feb 2025 19:45:08 -0500
parents 19b7a8de0019
children 827efbf4d73c
line wrap: on
line diff
--- a/src/Generator/BaseGenerator.php	Wed Feb 26 19:29:55 2025 -0500
+++ b/src/Generator/BaseGenerator.php	Wed Feb 26 19:45:08 2025 -0500
@@ -2,77 +2,43 @@
 
 namespace Wizard\MagicForger\Generator;
 
-use DB;
 use Illuminate\Console\GeneratorCommand;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 use Wizard\MagicForger\Replacer\Replacer;
 use Wizard\MagicForger\Replacer\TableReplacer;
+use Illuminate\Support\Facades\DB;
+use InvalidArgumentException;
 
 abstract class BaseGenerator extends GeneratorCommand
 {
     use Replacer;
     use TableReplacer;
 
-    /**
-     * The schema of the database.
-     *
-     * @var string
-     */
-    protected $schema;
-
-    /**
-     * The tables available in the schema.
-     *
-     * @var array
-     */
-    protected $tables;
-
-    /**
-     * The current Table being used.
-     *
-     * @var table
-     */
+    protected string $schema;
+    protected array $tables;
     protected $currentTable;
 
-    /**
-     * Execute the console command.
-     */
     public function handle()
     {
-        // First we need to ensure that the table exists, then we can
         if (!$this->tableExists($this->getTableInput())) {
-            $this->components->error('The table: "'.$this->getTableInput().'" does not exist in the database.');
-
+            $this->components->error('The table: "' . $this->getTableInput() . '" does not exist in the database.');
             return false;
         }
 
         $this->setCurrentTable($this->getTableInput());
-
         $path = $this->getPath();
-
         $file = $this->getFile($path);
-
         $file = $this->apply_replacements($file);
-
         $file = $this->apply_inserts($file);
-
         $this->makeDirectory($path);
-
         $this->files->put($path, $this->sortImports($file));
-
         $this->format_file($path);
-
-        $info = $this->type;
-
-        $this->components->info(sprintf('%s [%s] created successfully.', $info, $path));
+        $this->components->info(sprintf('%s [%s] created successfully.', $this->type, $path));
     }
 
-    /**
-     * Override the original so that we can prompt for a table with autocomplete.
-     */
-    protected function promptForMissingArguments(InputInterface $input, OutputInterface $output)
+    protected function promptForMissingArguments(InputInterface $input, OutputInterface $output): void
     {
         $prompted = false;
         if (is_null($input->getArgument('table'))) {
@@ -84,133 +50,82 @@
                     $this->possibleTables()
                 );
             }
-
             $input->setArgument('table', $table);
         }
 
         parent::promptForMissingArguments($input, $output);
 
-        // This will get missed if we prompt here but not in the parent
         if ($prompted) {
             $this->afterPromptingForMissingArguments($input, $output);
         }
     }
 
-    /**
-     * Get the console command arguments.
-     *
-     * @return array
-     */
-    protected function getArguments()
+    protected function getArguments(): array
     {
         return [
             ['table', InputOption::VALUE_REQUIRED, 'The table to generate files for.'],
         ];
     }
 
-    /**
-     * Prompt for missing input arguments using the returned questions.
-     *
-     * @return array
-     */
-    protected function promptForMissingArgumentsUsing()
+    protected function promptForMissingArgumentsUsing(): array
     {
-        return [
-        ];
+        return [];
     }
 
-    /**
-     * Get the console command options.
-     *
-     * @return array
-     */
-    protected function getOptions()
+    protected function getOptions(): array
     {
         return [
             ['fresh', 'f', InputOption::VALUE_NONE, 'Start from the stub or use existing if possible.'],
         ];
     }
 
-    /**
-     * Interact further with the user if they were prompted for missing arguments.
-     *
-     * @return void
-     */
-    protected function afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)
+    protected function afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output): void
     {
+        // Additional logic after prompting goes here
     }
 
-    /**
-     * Determines if the file exists.
-     */
     protected function fileExists(string $path): bool
     {
         return $this->files->exists($path);
     }
 
-    /**
-     * Gets the file that will be worked on. If there is already an existing file
-     * then we can open that. However if we are forcing the operation, then we
-     * will start with an empty stub.
-     */
-    protected function getFile($name)
+    protected function getFile($name): string
     {
-        if (!($this->hasOption('fresh')
-             && $this->option('fresh'))
-             && $this->fileExists($name)) {
-            // Working with an existing file
+        if (!($this->hasOption('fresh') && $this->option('fresh')) && $this->fileExists($name)) {
             return $this->files->get($name);
         }
 
-        // Working with a stub
         return $this->files->get($this->getStub());
     }
 
-    /**
-     * Get the desired class table from the input.
-     *
-     * @return string
-     */
-    protected function getTableInput()
+    protected function getTableInput(): string
     {
         return trim($this->argument('table'));
     }
 
-    /**
-     * Determines if the table exists in the current database.
-     */
     protected function tableExists(string $table_name): bool
     {
         return in_array($table_name, $this->getTables());
     }
 
-    /**
-     * Get a list of possible table names.
-     */
-    protected function possibleTables()
+    protected function possibleTables(): array
     {
         return $this->getTables();
     }
 
-    /**
-     * Get the tables in the schema.
-     */
-    protected function getTables()
+    protected function getTables(): array
     {
         if (is_null($this->tables)) {
-            $this->tables = collect($this->getSchema()->listTableNames())->all();
+            $this->tables = DB::connection()->getDoctrineSchemaManager()->listTableNames();
         }
 
         return $this->tables;
     }
-
-    /**
-     * Get the database schema for DB interactions.
-     */
+    
     protected function getSchema()
     {
         if (is_null($this->schema)) {
-            $this->schema = \DB::connection()->getDoctrineSchemaManager();
+            $this->schema = DB::connection()->getDoctrineSchemaManager();
         }
 
         return $this->schema;
@@ -226,17 +141,13 @@
         return $this->currentTable;
     }
 
-    protected function setCurrentTable(string $table_name)
+    protected function setCurrentTable(string $table_name): void
     {
-        $table = null;
-        if (!is_null($table_name) && '' !== trim($table_name)) {
-            $table = $this->getTable($table_name);
-        }
-        $this->currentTable = $table;
+        $this->currentTable = !empty(trim($table_name)) ? $this->getTable($table_name) : null;
     }
 
-    protected function format_file(string $path)
+    protected function format_file(string $path): void
     {
-        exec('php-cs-fixer fix '.$path);
+        exec('php-cs-fixer fix ' . escapeshellarg($path));
     }
 }