Use UserModel as test class name

Author: paulbalandan

docs/concepts.md

@@ -29,17 +29,17 @@ A default model is provided for you by the `CodeIgniter\Shield\Models\UserModel`
 this in the `Config\Auth::$userProvider` setting. The only requirement is that your new class
 MUST extend the provided `UserModel`.
 
-Shield has a CLI command to quickly create a custom `MyUserModel` class by running the following
+Shield has a CLI command to quickly create a custom `UserModel` class by running the following
 command in the terminal:
 
 ```console
-php spark shield:model MyUserModel
+php spark shield:model UserModel
 ```
 
 You should set `Config\Auth::$userProvider` as follows:
 
 ```php
-public string $userProvider = \App\Models\MyUserModel::class;
+public string $userProvider = \App\Models\UserModel::class;
 ```
 
 ## User Identities

src/Commands/Generators/Views/usermodel.tpl.php

@@ -4,17 +4,16 @@
 
 namespace {namespace};
 
-use CodeIgniter\Shield\Models\UserModel;
+use CodeIgniter\Shield\Models\UserModel as ShieldUserModel;
 
-class {class} extends UserModel
+class {class} extends ShieldUserModel
 {
     protected function initialize(): void
     {
         $this->allowedFields = [
             ...$this->allowedFields,
-            // Add here your custom fields
+
             // 'first_name',
         ];
     }
 }
-

tests/Commands/UserModelGeneratorTest.php

@@ -23,6 +23,10 @@ protected function setUp(): void
         $this->streamFilter = stream_filter_append(STDOUT, 'CITestStreamFilter');
         $this->streamFilter = stream_filter_append(STDERR, 'CITestStreamFilter');
 
+        if (is_file(HOMEPATH . 'src/Models/UserModel.php')) {
+            copy(HOMEPATH . 'src/Models/UserModel.php', HOMEPATH . 'src/Models/UserModel.php.bak');
+        }
+
         $this->deleteTestFiles();
     }
 
@@ -32,13 +36,18 @@ protected function tearDown(): void
 
         stream_filter_remove($this->streamFilter);
         $this->deleteTestFiles();
+
+        if (is_file(HOMEPATH . 'src/Models/UserModel.php.bak')) {
+            copy(HOMEPATH . 'src/Models/UserModel.php.bak', HOMEPATH . 'src/Models/UserModel.php');
+            unlink(HOMEPATH . 'src/Models/UserModel.php.bak');
+        }
     }
 
     private function deleteTestFiles(): void
     {
         $possibleFiles = [
-            APPPATH . 'Models/MyUserModel.php',
-            HOMEPATH . 'src/Models/MyUserModel.php',
+            APPPATH . 'Models/UserModel.php',
+            HOMEPATH . 'src/Models/UserModel.php',
         ];
 
         foreach ($possibleFiles as $file) {
@@ -57,51 +66,51 @@ private function getFileContents(string $filepath): string
 
     public function testGenerateUserModel(): void
     {
-        command('shield:model MyUserModel');
+        command('shield:model UserModel');
 
-        $filepath = APPPATH . 'Models/MyUserModel.php';
+        $filepath = APPPATH . 'Models/UserModel.php';
         $this->assertStringContainsString('File created: ', CITestStreamFilter::$buffer);
         $this->assertFileExists($filepath);
 
         $contents = $this->getFileContents($filepath);
         $this->assertStringContainsString('namespace App\Models;', $contents);
-        $this->assertStringContainsString('class MyUserModel extends UserModel', $contents);
-        $this->assertStringContainsString('use CodeIgniter\Shield\Models\UserModel;', $contents);
+        $this->assertStringContainsString('class UserModel extends ShieldUserModel', $contents);
+        $this->assertStringContainsString('use CodeIgniter\Shield\Models\UserModel as ShieldUserModel;', $contents);
         $this->assertStringContainsString('protected function initialize(): void', $contents);
     }
 
     public function testGenerateUserModelCustomNamespace(): void
     {
-        command('shield:model MyUserModel --namespace CodeIgniter\\\\Shield');
+        command('shield:model UserModel --namespace CodeIgniter\\\\Shield');
 
-        $filepath = HOMEPATH . 'src/Models/MyUserModel.php';
+        $filepath = HOMEPATH . 'src/Models/UserModel.php';
         $this->assertStringContainsString('File created: ', CITestStreamFilter::$buffer);
         $this->assertFileExists($filepath);
 
         $contents = $this->getFileContents($filepath);
         $this->assertStringContainsString('namespace CodeIgniter\Shield\Models;', $contents);
-        $this->assertStringContainsString('class MyUserModel extends UserModel', $contents);
-        $this->assertStringContainsString('use CodeIgniter\Shield\Models\UserModel;', $contents);
+        $this->assertStringContainsString('class UserModel extends ShieldUserModel', $contents);
+        $this->assertStringContainsString('use CodeIgniter\Shield\Models\UserModel as ShieldUserModel;', $contents);
         $this->assertStringContainsString('protected function initialize(): void', $contents);
     }
 
     public function testGenerateUserModelWithForce(): void
     {
-        command('shield:model MyUserModel');
-        command('shield:model MyUserModel --force');
+        command('shield:model UserModel');
+        command('shield:model UserModel --force');
 
         $this->assertStringContainsString('File overwritten: ', CITestStreamFilter::$buffer);
-        $this->assertFileExists(APPPATH . 'Models/MyUserModel.php');
+        $this->assertFileExists(APPPATH . 'Models/UserModel.php');
     }
 
     public function testGenerateUserModelWithSuffix(): void
     {
-        command('shield:model MyUser --suffix');
+        command('shield:model User --suffix');
 
         $this->assertStringContainsString('File created: ', CITestStreamFilter::$buffer);
 
-        $filepath = APPPATH . 'Models/MyUserModel.php';
+        $filepath = APPPATH . 'Models/UserModel.php';
         $this->assertFileExists($filepath);
-        $this->assertStringContainsString('class MyUserModel extends UserModel', $this->getFileContents($filepath));
+        $this->assertStringContainsString('class UserModel extends ShieldUserModel', $this->getFileContents($filepath));
     }
 }