Make the class name input optional with default.

Author: paulbalandan

docs/concepts.md

@@ -36,6 +36,8 @@ command in the terminal:
 php spark shield:model UserModel
 ```
 
+The class name is optional. If none is provided, the generated class name would be `UserModel`.
+
 You should set `Config\Auth::$userProvider` as follows:
 
 ```php

src/Commands/Generators/UserModelGenerator.php

@@ -5,6 +5,7 @@
 namespace CodeIgniter\Shield\Commands\Generators;
 
 use CodeIgniter\CLI\BaseCommand;
+use CodeIgniter\CLI\CLI;
 use CodeIgniter\CLI\GeneratorTrait;
 
 /**
@@ -32,15 +33,13 @@ class UserModelGenerator extends BaseCommand
     /**
      * @var string
      */
-    protected $usage = 'shield:model <name> [options]';
+    protected $usage = 'shield:model [<name>] [options]';
 
     /**
-     * The Command's Arguments
-     *
      * @var array<string, string>
      */
     protected $arguments = [
-        'name' => 'The model class name.',
+        'name' => 'The model class name. If not provided, this will default to `UserModel`.',
     ];
 
     /**
@@ -62,6 +61,17 @@ public function run(array $params): void
         $this->template  = 'usermodel.tpl.php';
 
         $this->classNameLang = 'CLI.generator.className.model';
+        $this->setHasClassName(false);
+
+        $class = $params[0] ?? CLI::getSegment(2) ?? 'UserModel';
+
+        if (in_array(strtolower($class), ['shielduser', 'shieldusermodel'], true)) {
+            CLI::error('Cannot use `ShieldUserModel` as class name as this conflicts with the parent class.', 'light_gray', 'red');
+
+            return; // @TODO when CI4 is at v4.3+, change this to `return 1;` to signify failing exit
+        }
+
+        $params[0] = $class;
 
         $this->execute($params);
     }

tests/Commands/UserModelGeneratorTest.php

@@ -113,4 +113,30 @@ public function testGenerateUserModelWithSuffix(): void
         $this->assertFileExists($filepath);
         $this->assertStringContainsString('class UserModel extends ShieldUserModel', $this->getFileContents($filepath));
     }
+
+    public function testGenerateUserModelWithoutClassNameInput(): void
+    {
+        command('shield:model');
+
+        $this->assertStringContainsString('File created: ', CITestStreamFilter::$buffer);
+
+        $filepath = APPPATH . 'Models/UserModel.php';
+        $this->assertFileExists($filepath);
+        $this->assertStringContainsString('class UserModel extends ShieldUserModel', $this->getFileContents($filepath));
+    }
+
+    public function testGenerateUserCannotAcceptShieldUserModelAsInput(): void
+    {
+        command('shield:model ShieldUserModel');
+
+        $this->assertStringContainsString('Cannot use `ShieldUserModel` as class name as this conflicts with the parent class.', CITestStreamFilter::$buffer);
+        $this->assertFileDoesNotExist(APPPATH . 'Models/UserModel.php');
+
+        CITestStreamFilter::$buffer = '';
+
+        command('shield:model ShieldUser --suffix');
+
+        $this->assertStringContainsString('Cannot use `ShieldUserModel` as class name as this conflicts with the parent class.', CITestStreamFilter::$buffer);
+        $this->assertFileDoesNotExist(APPPATH . 'Models/UserModel.php');
+    }
 }