Merge pull request #3561 from paulbalandan/basecommand-getpad

Deprecate BaseCommand::getPad and add more tests

Author: MGatner

system/CLI/BaseCommand.php

@@ -171,6 +171,7 @@ protected function showError(Throwable $e)
 	public function showHelp()
 	{
 		CLI::write(lang('CLI.helpUsage'), 'yellow');
+
 		if (! empty($this->usage))
 		{
 			$usage = $this->usage;
@@ -184,6 +185,7 @@ public function showHelp()
 				$usage .= ' [arguments]';
 			}
 		}
+
 		CLI::write($this->setPad($usage, 0, 0, 2));
 
 		if (! empty($this->description))
@@ -198,6 +200,7 @@ public function showHelp()
 			CLI::newLine();
 			CLI::write(lang('CLI.helpArguments'), 'yellow');
 			$length = max(array_map('strlen', array_keys($this->arguments)));
+
 			foreach ($this->arguments as $argument => $description)
 			{
 				CLI::write(CLI::color($this->setPad($argument, $length, 2, 2), 'green') . $description);
@@ -209,6 +212,7 @@ public function showHelp()
 			CLI::newLine();
 			CLI::write(lang('CLI.helpOptions'), 'yellow');
 			$length = max(array_map('strlen', array_keys($this->options)));
+
 			foreach ($this->options as $option => $description)
 			{
 				CLI::write(CLI::color($this->setPad($option, $length, 2, 2), 'green') . $description);
@@ -223,12 +227,12 @@ public function showHelp()
 	 *
 	 * @param string  $item
 	 * @param integer $max
-	 * @param integer $extra  // How many extra spaces to add at the end
+	 * @param integer $extra  How many extra spaces to add at the end
 	 * @param integer $indent
 	 *
 	 * @return string
 	 */
-	protected function setPad(string $item, int $max, int $extra = 2, int $indent = 0): string
+	public function setPad(string $item, int $max, int $extra = 2, int $indent = 0): string
 	{
 		$max += $extra + $indent;
 
@@ -244,6 +248,10 @@ protected function setPad(string $item, int $max, int $extra = 2, int $indent =
 	 * @param integer $pad
 	 *
 	 * @return integer
+	 *
+	 * @deprecated Use setPad() instead.
+	 *
+	 * @codeCoverageIgnore
 	 */
 	public function getPad(array $array, int $pad): int
 	{

tests/_support/Commands/AppInfo.php

@@ -10,6 +10,7 @@ class AppInfo extends BaseCommand
 
 	protected $group       = 'demo';
 	protected $name        = 'app:info';
+	protected $arguments   = ['draft' => 'unused'];
 	protected $description = 'Displays basic application information.';
 
 	public function run(array $params)

tests/system/Commands/HelpCommandTest.php

@@ -37,6 +37,12 @@ public function testHelpCommand()
 		$this->assertStringContainsString('command_name', $this->getBuffer());
 	}
 
+	public function testHelpCommandWithMissingUsage()
+	{
+		command('help app:info');
+		$this->assertStringContainsString('app:info [arguments]', $this->getBuffer());
+	}
+
 	public function testHelpCommandOnSpecificCommand()
 	{
 		command('help cache:clear');

user_guide_src/source/changelogs/v4.0.5.rst

@@ -17,3 +17,7 @@ Bugs Fixed:
 
 - Fixed a bug in ``Entity`` class where declaring class parameters was preventing data propagation to the ``attributes`` array.
 - Handling for the environment variable ``encryption.key`` has changed. Previously, explicit function calls, like ``getenv('encryption.key')`` or ``env('encryption.key')`` where the value has the special prefix ``hex2bin:`` returns an automatically converted binary string. This is now changed to just return the character string with the prefix. This change was due to incompatibility with handling binary strings in environment variables on Windows platforms. However, accessing ``$key`` using ``Encryption`` class config remains unchanged and still returns a binary string.
+
+Deprecations:
+
+- Deprecated ``BaseCommand::getPad`` in favor of ``BaseCommand::setPad``.