Merge pull request #4197 from paulbalandan/generator-finishing-touches

Finishing touches to generator refactor

Author: paulbalandan

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',
 	];
 }

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;
 	}
 
 	/**

system/Commands/Generators/ConfigGenerator.php

@@ -12,11 +12,10 @@
 namespace CodeIgniter\Commands\Generators;
 
 use CodeIgniter\CLI\BaseCommand;
-use CodeIgniter\CLI\CLI;
 use CodeIgniter\CLI\GeneratorTrait;
 
 /**
- * Generates a skeleton Config file.
+ * Generates a skeleton config file.
  */
 class ConfigGenerator extends BaseCommand
 {
@@ -93,9 +92,13 @@ public function run(array $params)
 	 */
 	protected function prepare(string $class): string
 	{
-		$namespace = $this->getOption('namespace');
-		$namespace = is_string($namespace) ? $namespace . '\\' . $this->directory : $this->directory;
+		$namespace = $this->getOption('namespace') ?? APP_NAMESPACE;
 
-		return $this->parseTemplate($class, ['{namespace}'], [$namespace]);
+		if ($namespace === APP_NAMESPACE)
+		{
+			$class = substr($class, strlen($namespace . '\\'));
+		}
+
+		return $this->parseTemplate($class);
 	}
 }

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

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'))
 		{

system/Commands/Generators/ComponentGenerator.php renamed to 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'))

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;
 
 /**

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);

system/Commands/Generators/Views/controller.tpl.php

@@ -16,7 +16,7 @@ public function index()
 	{
 		//
 	}
-	
+
 	/**
 	 * Return the properties of a resource object
 	 *

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([