Finishing touches to generator refactor

paulbalandan · paulbalandan · commit f04cf0754f1b · 2021-01-31T23:21:29.000+08:00
diff --git a/app/Config/Generators.php b/app/Config/Generators.php
@@ -33,6 +33,7 @@ class Generators extends BaseConfig
 		'make:migration'    => 'CodeIgniter\Commands\Generators\Views\migration.tpl.php',
 		'make:model'        => 'CodeIgniter\Commands\Generators\Views\model.tpl.php',
 		'make:seeder'       => 'CodeIgniter\Commands\Generators\Views\seeder.tpl.php',
+		'make:validation'   => 'CodeIgniter\Commands\Generators\Views\validation.tpl.php',
 		'session:migration' => 'CodeIgniter\Commands\Generators\Views\migration.tpl.php',
 	];
 }
diff --git a/system/CLI/GeneratorTrait.php b/system/CLI/GeneratorTrait.php
@@ -116,7 +116,7 @@ protected function execute(array $params): void
 		// we are duplicating things, If 'force' option is not supplied, we bail.
 		if (! $this->getOption('force') && $isFile)
 		{
-			CLI::write(lang('CLI.generator.fileExist', [clean_path($path)]), 'red');
+			CLI::error(lang('CLI.generator.fileExist', [clean_path($path)]), 'light_gray', 'red');
 			CLI::newLine();
 
 			return;
@@ -131,7 +131,7 @@ protected function execute(array $params): void
 		}
 
 		helper('filesystem');
-		
+
 		// Build the class based on the details we have, We'll be getting our file
 		// contents from the template, and then we'll do the necessary replacements.
 		if (! write_file($path, $this->buildContent($class)))
@@ -170,7 +170,7 @@ protected function prepare(string $class): string
 
 	/**
 	 * Change file basename before saving.
-	 * 
+	 *
 	 * Useful for components where the file name has a date.
 	 *
 	 * @param string $filename
@@ -219,7 +219,7 @@ protected function qualifyClassName(): string
 
 		if (strncmp($class, $namespace, strlen($namespace)) === 0)
 		{
-			return $class;
+			return $class; // @codeCoverageIgnore
 		}
 
 		return $namespace . '\\' . $this->directory . '\\' . str_replace('/', '\\', $class);
@@ -326,20 +326,28 @@ protected function buildPath(string $class): string
 	 * Allows child generators to modify the internal `$hasClassName` flag.
 	 *
 	 * @param boolean $hasClassName
+	 *
+	 * @return $this
 	 */
 	protected function setHasClassName(bool $hasClassName)
 	{
 		$this->hasClassName = $hasClassName;
+
+		return $this;
 	}
 
 	/**
 	 * Allows child generators to modify the internal `$sortImports` flag.
 	 *
 	 * @param boolean $sortImports
+	 *
+	 * @return $this
 	 */
 	protected function setSortImports(bool $sortImports)
 	{
 		$this->sortImports = $sortImports;
+
+		return $this;
 	}
 
 	/**
diff --git a/system/Commands/Generators/ControllerGenerator.php b/system/Commands/Generators/ControllerGenerator.php
@@ -72,7 +72,7 @@ class ControllerGenerator extends BaseCommand
 		'--force'     => 'Force overwrite existing file.',
 	];
 
- 	/**
+	/**
 	 * Actually execute a command.
 	 *
 	 * @param array $params
@@ -100,7 +100,7 @@ protected function prepare(string $class): string
 
 		$useStatement = trim(APP_NAMESPACE, '\\') . '\Controllers\BaseController';
 		$extends      = 'BaseController';
-			
+
 		// Gets the appropriate parent class to extend.
 		if ($bare || $rest)
 		{
@@ -112,7 +112,7 @@ protected function prepare(string $class): string
 			elseif ($rest)
 			{
 				$rest = is_string($rest) ? $rest : 'controller';
-				
+
 				if (! in_array($rest, ['controller', 'presenter'], true))
 				{
 					// @codeCoverageIgnoreStart
diff --git a/system/Commands/Generators/MigrateCreate.php b/system/Commands/Generators/MigrateCreate.php
@@ -15,8 +15,7 @@
 use CodeIgniter\CLI\CLI;
 
 /**
- * Deprecated class for the migration
- * creation command.
+ * Deprecated class for the migration creation command.
  *
  * @deprecated Use make:command instead.
  *
@@ -80,8 +79,9 @@ class MigrateCreate extends BaseCommand
 	public function run(array $params)
 	{
 		// Resolve arguments before passing to make:migration
-		$params[0]   = $params[0] ?? CLI::getSegment(2);
-		$params['n'] = $params['n'] ?? CLI::getOption('n') ?? APP_NAMESPACE;
+		$params[0] = $params[0] ?? CLI::getSegment(2);
+
+		$params['namespace'] = $params['namespace'] ?? CLI::getOption('namespace') ?? APP_NAMESPACE;
 
 		if (array_key_exists('force', $params) || CLI::getOption('force'))
 		{
diff --git a/system/Commands/Generators/ScaffoldGenerator.php b/system/Commands/Generators/ScaffoldGenerator.php
@@ -18,7 +18,7 @@
 /**
  * Generates a complete set of scaffold files.
  */
-class ComponentGenerator extends BaseCommand
+class ScaffoldGenerator extends BaseCommand
 {
 	use GeneratorTrait;
 
@@ -34,7 +34,7 @@ class ComponentGenerator extends BaseCommand
 	 *
 	 * @var string
 	 */
-	protected $name = 'make:component';
+	protected $name = 'make:scaffold';
 
 	/**
 	 * The Command's Description
@@ -48,7 +48,7 @@ class ComponentGenerator extends BaseCommand
 	 *
 	 * @var string
 	 */
-	protected $usage = 'make:component <name> [options]';
+	protected $usage = 'make:scaffold <name> [options]';
 
 	/**
 	 * The Command's Arguments
@@ -65,13 +65,13 @@ class ComponentGenerator extends BaseCommand
 	 * @var array
 	 */
 	protected $options = [
-		'--bare'      => 'Add the \'--bare\' option to controller component.',
-		'--restful'   => 'Add the \'--restful\' option to controller component.',
-		'--table'     => 'Add the \'--table\' option to the model component.',
-		'--dbgroup'   => 'Add the \'--dbgroup\' option to model component.',
-		'--return'    => 'Add the \'--return\' option to the model component.',
+		'--bare'      => 'Add the "--bare" option to controller component.',
+		'--restful'   => 'Add the "--restful" option to controller component.',
+		'--table'     => 'Add the "--table" option to the model component.',
+		'--dbgroup'   => 'Add the "--dbgroup" option to model component.',
+		'--return'    => 'Add the "--return" option to the model component.',
 		'--namespace' => 'Set root namespace. Default: "APP_NAMESPACE".',
-		'--suffix'    => 'Append the component title to the class name (e.g. User => UserComponent).',
+		'--suffix'    => 'Append the component title to the class name.',
 		'--force'     => 'Force overwrite existing file.',
 	];
 
@@ -83,7 +83,7 @@ class ComponentGenerator extends BaseCommand
 	public function run(array $params)
 	{
 		$this->params = $params;
-		
+
 		$options = [];
 
 		if ($this->getOption('namespace'))
diff --git a/system/Commands/Generators/SeederGenerator.php b/system/Commands/Generators/SeederGenerator.php
@@ -12,7 +12,6 @@
 namespace CodeIgniter\Commands\Generators;
 
 use CodeIgniter\CLI\BaseCommand;
-use CodeIgniter\CLI\CLI;
 use CodeIgniter\CLI\GeneratorTrait;
 
 /**
diff --git a/system/Commands/Generators/SessionMigrationGenerator.php b/system/Commands/Generators/SessionMigrationGenerator.php
@@ -18,8 +18,8 @@
 /**
  * Generates a migration file for database sessions.
  *
- * @deprecated Use make:migration instead.
- * 
+ * @deprecated Use make:migration --session instead.
+ *
  * @codeCoverageIgnore
  */
 class SessionMigrationGenerator extends BaseCommand
@@ -76,12 +76,12 @@ public function run(array $params)
 		$this->template  = 'migration.tpl.php';
 
 		$table = 'ci_sessions';
-		
+
 		if (array_key_exists('t', $params) || CLI::getOption('t'))
 		{
 			$table = $params['t'] ?? CLI::getOption('t');
 		}
-		
+
 		$params[0] = "_create_{$table}_table";
 
 		$this->execute($params);
diff --git a/system/Commands/Generators/Views/controller.tpl.php b/system/Commands/Generators/Views/controller.tpl.php
@@ -16,7 +16,7 @@ public function index()
 	{
 		//
 	}
-	
+
 	/**
 	 * Return the properties of a resource object
 	 *
diff --git a/system/Commands/Generators/Views/migration.tpl.php b/system/Commands/Generators/Views/migration.tpl.php
@@ -8,7 +8,7 @@ class {class} extends Migration
 {
 <?php if ($session): ?>
 	protected $DBGroup = '<?= $DBGroup ?>';
-	
+
 	public function up()
 	{
 		$this->forge->addField([
diff --git a/system/Commands/Generators/Views/validation.tpl.php b/system/Commands/Generators/Views/validation.tpl.php
@@ -4,8 +4,8 @@
 
 class {class}
 {
-	public function custom_rule(): bool
-	{
-		return true;
-	}
+	// public function custom_rule(): bool
+	// {
+	// 	return true;
+	// }
 }
diff --git a/tests/system/Commands/ModelGeneratorTest.php b/tests/system/Commands/ModelGeneratorTest.php
@@ -101,7 +101,15 @@ public function testGenerateModelWithOptionReturnEntity()
 
 	public function testGenerateModelWithOptionSuffix()
 	{
-		command('make:model user -suffix');
-		$this->assertFileExists(APPPATH . 'Models/UserModel.php');
+		command('make:model user -suffix -return entity');
+
+		$model  = APPPATH . 'Models/UserModel.php';
+		$entity = APPPATH . 'Entities/UserEntity.php';
+
+		$this->assertFileExists($model);
+		$this->assertFileExists($entity);
+		unlink($model);
+		unlink($entity);
+		rmdir(dirname($entity));
 	}
 }
diff --git a/tests/system/Commands/ScaffoldGeneratorTest.php b/tests/system/Commands/ScaffoldGeneratorTest.php
@@ -5,7 +5,7 @@
 use CodeIgniter\Test\CIUnitTestCase;
 use CodeIgniter\Test\Filters\CITestStreamFilter;
 
-class ComponentGeneratorTest extends CIUnitTestCase
+class ScaffoldGeneratorTest extends CIUnitTestCase
 {
 	protected $streamFilter;
 
@@ -19,7 +19,7 @@ protected function setUp(): void
 
 	protected function tearDown(): void
 	{
-		stream_filter_remove($this->streamFilter);	
+		stream_filter_remove($this->streamFilter);
 	}
 
 	protected function getFileContents(string $filepath): string

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ class Generators extends BaseConfig`
`33`	`33`	`'make:migration' => 'CodeIgniter\Commands\Generators\Views\migration.tpl.php',`
`34`	`34`	`'make:model' => 'CodeIgniter\Commands\Generators\Views\model.tpl.php',`
`35`	`35`	`'make:seeder' => 'CodeIgniter\Commands\Generators\Views\seeder.tpl.php',`
	`36`	`+ 'make:validation' => 'CodeIgniter\Commands\Generators\Views\validation.tpl.php',`
`36`	`37`	`'session:migration' => 'CodeIgniter\Commands\Generators\Views\migration.tpl.php',`
`37`	`38`	`];`
`38`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ protected function execute(array $params): void`
`116`	`116`	`// we are duplicating things, If 'force' option is not supplied, we bail.`
`117`	`117`	`if (! $this->getOption('force') && $isFile)`
`118`	`118`	`{`
`119`		`- CLI::write(lang('CLI.generator.fileExist', [clean_path($path)]), 'red');`
	`119`	`+ CLI::error(lang('CLI.generator.fileExist', [clean_path($path)]), 'light_gray', 'red');`
`120`	`120`	`CLI::newLine();`
`121`	`121`
`122`	`122`	`return;`
`@@ -131,7 +131,7 @@ protected function execute(array $params): void`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`helper('filesystem');`
`134`		`-`
	`134`	`+`
`135`	`135`	`// Build the class based on the details we have, We'll be getting our file`
`136`	`136`	`// contents from the template, and then we'll do the necessary replacements.`
`137`	`137`	`if (! write_file($path, $this->buildContent($class)))`
`@@ -170,7 +170,7 @@ protected function prepare(string $class): string`
`170`	`170`
`171`	`171`	`/**`
`172`	`172`	`* Change file basename before saving.`
`173`		`- *`
	`173`	`+ *`
`174`	`174`	`* Useful for components where the file name has a date.`
`175`	`175`	`*`
`176`	`176`	`* @param string $filename`
`@@ -219,7 +219,7 @@ protected function qualifyClassName(): string`
`219`	`219`
`220`	`220`	`if (strncmp($class, $namespace, strlen($namespace)) === 0)`
`221`	`221`	`{`
`222`		`- return $class;`
	`222`	`+ return $class; // @codeCoverageIgnore`
`223`	`223`	`}`
`224`	`224`
`225`	`225`	`return $namespace . '\\' . $this->directory . '\\' . str_replace('/', '\\', $class);`
`@@ -326,20 +326,28 @@ protected function buildPath(string $class): string`
`326`	`326`	* Allows child generators to modify the internal `$hasClassName` flag.
`327`	`327`	`*`
`328`	`328`	`* @param boolean $hasClassName`
	`329`	`+ *`
	`330`	`+ * @return $this`
`329`	`331`	`*/`
`330`	`332`	`protected function setHasClassName(bool $hasClassName)`
`331`	`333`	`{`
`332`	`334`	`$this->hasClassName = $hasClassName;`
	`335`	`+`
	`336`	`+ return $this;`
`333`	`337`	`}`
`334`	`338`
`335`	`339`	`/**`
`336`	`340`	* Allows child generators to modify the internal `$sortImports` flag.
`337`	`341`	`*`
`338`	`342`	`* @param boolean $sortImports`
	`343`	`+ *`
	`344`	`+ * @return $this`
`339`	`345`	`*/`
`340`	`346`	`protected function setSortImports(bool $sortImports)`
`341`	`347`	`{`
`342`	`348`	`$this->sortImports = $sortImports;`
	`349`	`+`
	`350`	`+ return $this;`
`343`	`351`	`}`
`344`	`352`
`345`	`353`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ class ControllerGenerator extends BaseCommand`
`72`	`72`	`'--force' => 'Force overwrite existing file.',`
`73`	`73`	`];`
`74`	`74`
`75`		`- /**`
	`75`	`+ /**`
`76`	`76`	`* Actually execute a command.`
`77`	`77`	`*`
`78`	`78`	`* @param array $params`
`@@ -100,7 +100,7 @@ protected function prepare(string $class): string`
`100`	`100`
`101`	`101`	`$useStatement = trim(APP_NAMESPACE, '\\') . '\Controllers\BaseController';`
`102`	`102`	`$extends = 'BaseController';`
`103`		`-`
	`103`	`+`
`104`	`104`	`// Gets the appropriate parent class to extend.`
`105`	`105`	`if ($bare \|\| $rest)`
`106`	`106`	`{`
`@@ -112,7 +112,7 @@ protected function prepare(string $class): string`
`112`	`112`	`elseif ($rest)`
`113`	`113`	`{`
`114`	`114`	`$rest = is_string($rest) ? $rest : 'controller';`
`115`		`-`
	`115`	`+`
`116`	`116`	`if (! in_array($rest, ['controller', 'presenter'], true))`
`117`	`117`	`{`
`118`	`118`	`// @codeCoverageIgnoreStart`
Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,7 @@`
`15`	`15`	`use CodeIgniter\CLI\CLI;`
`16`	`16`
`17`	`17`	`/**`
`18`		`- * Deprecated class for the migration`
`19`		`- * creation command.`
	`18`	`+ * Deprecated class for the migration creation command.`
`20`	`19`	`*`
`21`	`20`	`* @deprecated Use make:command instead.`
`22`	`21`	`*`
`@@ -80,8 +79,9 @@ class MigrateCreate extends BaseCommand`
`80`	`79`	`public function run(array $params)`
`81`	`80`	`{`
`82`	`81`	`// Resolve arguments before passing to make:migration`
`83`		`- $params[0] = $params[0] ?? CLI::getSegment(2);`
`84`		`- $params['n'] = $params['n'] ?? CLI::getOption('n') ?? APP_NAMESPACE;`
	`82`	`+ $params[0] = $params[0] ?? CLI::getSegment(2);`
	`83`	`+`
	`84`	`+ $params['namespace'] = $params['namespace'] ?? CLI::getOption('namespace') ?? APP_NAMESPACE;`
`85`	`85`
`86`	`86`	`if (array_key_exists('force', $params) \|\| CLI::getOption('force'))`
`87`	`87`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public function index()`
`16`	`16`	`{`
`17`	`17`	`//`
`18`	`18`	`}`
`19`		`-`
	`19`	`+`
`20`	`20`	`/**`
`21`	`21`	`* Return the properties of a resource object`
`22`	`22`	`*`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ class {class} extends Migration`
`8`	`8`	`{`
`9`	`9`	`<?php if ($session): ?>`
`10`	`10`	`protected $DBGroup = '<?= $DBGroup ?>';`
`11`		`-`
	`11`	`+`
`12`	`12`	`public function up()`
`13`	`13`	`{`
`14`	`14`	`$this->forge->addField([`
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,8 @@`
`4`	`4`
`5`	`5`	`class {class}`
`6`	`6`	`{`
`7`		`- public function custom_rule(): bool`
`8`		`- {`
`9`		`- return true;`
`10`		`- }`
	`7`	`+ // public function custom_rule(): bool`
	`8`	`+ // {`
	`9`	`+ // return true;`
	`10`	`+ // }`
`11`	`11`	`}`