Merge pull request #887 from hydephp/dynamic-info-comment-helper

emmadesilva · web-flow · commit 0e9a9c61ce2d · 2023-01-30T12:10:39.000+01:00
Update InfoComment command helper to dynamically format output from a single fluent string
diff --git a/packages/framework/src/Console/Commands/ChangeSourceDirectoryCommand.php b/packages/framework/src/Console/Commands/ChangeSourceDirectoryCommand.php
@@ -76,7 +76,7 @@ protected function getValidatedName(string $name): string
     {
         $this->validateName($name);
         $this->validateDirectoryCanBeUsed($name);
-        $this->infoComment('Setting', $name, 'as the project source directory!');
+        $this->infoComment("Setting [$name] as the project source directory!");
 
         return $name;
     }
diff --git a/packages/framework/src/Console/Concerns/Command.php b/packages/framework/src/Console/Concerns/Command.php
@@ -22,10 +22,19 @@ public static function createClickableFilepath(string $filepath): string
 
     /**
      * Write a nicely formatted and consistent message to the console. Using InfoComment for a lack of a better term.
+     *
+     * Text in [brackets] will automatically be wrapped in <comment> tags.
      */
-    public function infoComment(string $info, string $comment, ?string $moreInfo = null): void
+    public function infoComment(string $string): void
     {
-        $this->line("<info>$info</info> [<comment>$comment</comment>]".($moreInfo ? " <info>$moreInfo</info>" : ''));
+        $replacements = [
+            '[' => '</info>[<comment>',
+            ']' => '</comment>]<info>',
+        ];
+
+        $string = str_replace(array_keys($replacements), array_values($replacements), $string);
+
+        $this->line("<info>$string</info>");
     }
 
     /** @experimental This method may change (or be removed) before the 1.0.0 release */
diff --git a/packages/framework/tests/Feature/CommandTest.php b/packages/framework/tests/Feature/CommandTest.php
@@ -37,12 +37,12 @@ public function testInfoComment()
     {
         $command = new MockableTestCommand();
         $command->closure = function (Command $command) {
-            $command->infoComment('foo', 'bar');
+            $command->infoComment('foo [bar]');
         };
 
         $output = $this->mock(OutputStyle::class);
         $output->shouldReceive('writeln')->once()->withArgs(function (string $message): bool {
-            return $message === '<info>foo</info> [<comment>bar</comment>]';
+            return $message === '<info>foo </info>[<comment>bar</comment>]<info></info>';
         });
 
         $command->setMockedOutput($output);
@@ -53,12 +53,28 @@ public function testInfoCommentWithExtraInfo()
     {
         $command = new MockableTestCommand();
         $command->closure = function (Command $command) {
-            $command->infoComment('foo', 'bar', 'baz');
+            $command->infoComment('foo [bar] baz');
         };
 
         $output = $this->mock(OutputStyle::class);
         $output->shouldReceive('writeln')->once()->withArgs(function (string $message): bool {
-            return $message === '<info>foo</info> [<comment>bar</comment>] <info>baz</info>';
+            return $message === '<info>foo </info>[<comment>bar</comment>]<info> baz</info>';
+        });
+
+        $command->setMockedOutput($output);
+        $command->handle();
+    }
+
+    public function testInfoCommentWithExtraInfoAndComments()
+    {
+        $command = new MockableTestCommand();
+        $command->closure = function (Command $command) {
+            $command->infoComment('foo [bar] baz [qux]');
+        };
+
+        $output = $this->mock(OutputStyle::class);
+        $output->shouldReceive('writeln')->once()->withArgs(function (string $message): bool {
+            return $message === '<info>foo </info>[<comment>bar</comment>]<info> baz </info>[<comment>qux</comment>]<info></info>';
         });
 
         $command->setMockedOutput($output);

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ protected function getValidatedName(string $name): string`
`76`	`76`	`{`
`77`	`77`	`$this->validateName($name);`
`78`	`78`	`$this->validateDirectoryCanBeUsed($name);`
`79`		`- $this->infoComment('Setting', $name, 'as the project source directory!');`
	`79`	`+ $this->infoComment("Setting [$name] as the project source directory!");`
`80`	`80`
`81`	`81`	`return $name;`
`82`	`82`	`}`