Pass progress symbol as a parameter instead of part of the constructor (#97)

This offers more flexibility as it makes the instantiation of the standard logger no longer dependent of the progress symbol. This means if we remove the progress symbol from being passed to the parallel executor (for example to use a default value), this will not be a problem (currently that default value _needs_ to be in Parallelization).

Author: theofidry

src/Logger/Logger.php

@@ -33,7 +33,7 @@ public function advance(int $steps = 1): void;
 
     public function finish(string $itemName): void;
 
-    public function logUnexpectedOutput(string $buffer): void;
+    public function logUnexpectedOutput(string $buffer, string $progressSymbol): void;
 
     public function logCommandStarted(string $commandName): void;
 

src/Logger/StandardLogger.php

@@ -26,21 +26,18 @@
 final class StandardLogger implements Logger
 {
     private OutputInterface $output;
-    private string $advancementChar;
     private int $terminalWidth;
     private ProgressBar $progressBar;
     private ProgressBarFactory $progressBarFactory;
     private LoggerInterface $logger;
 
     public function __construct(
         OutputInterface $output,
-        string $advancementCharacter,
         int $terminalWidth,
         ProgressBarFactory $progressBarFactory,
         LoggerInterface $logger
     ) {
         $this->output = $output;
-        $this->advancementChar = $advancementCharacter;
         $this->terminalWidth = $terminalWidth;
         $this->progressBarFactory = $progressBarFactory;
         $this->logger = $logger;
@@ -115,7 +112,7 @@ public function finish(string $itemName): void
         unset($this->progressBar);
     }
 
-    public function logUnexpectedOutput(string $buffer): void
+    public function logUnexpectedOutput(string $buffer, string $progressSymbol): void
     {
         $this->output->writeln('');
         $this->output->writeln(sprintf(
@@ -127,7 +124,7 @@ public function logUnexpectedOutput(string $buffer): void
                 STR_PAD_BOTH,
             ),
         ));
-        $this->output->writeln(str_replace($this->advancementChar, '', $buffer));
+        $this->output->writeln(str_replace($progressSymbol, '', $buffer));
         $this->output->writeln('');
     }
 

src/ParallelExecutor.php

@@ -330,12 +330,12 @@ private function processChildOutput(
         string $buffer,
         Logger $logger
     ): void {
-        $advancementChar = $this->progressSymbol;
-        $chars = mb_substr_count($buffer, $advancementChar);
+        $progressSymbol = $this->progressSymbol;
+        $chars = mb_substr_count($buffer, $progressSymbol);
 
         // Display unexpected output
         if ($chars !== mb_strlen($buffer)) {
-            $logger->logUnexpectedOutput($buffer);
+            $logger->logUnexpectedOutput($buffer, $progressSymbol);
         }
 
         $logger->advance($chars);

src/Parallelization.php

@@ -259,7 +259,6 @@ protected function createLogger(OutputInterface $output): Logger
     {
         return new StandardLogger(
             $output,
-            self::getProgressSymbol(),
             (new Terminal())->getWidth(),
             new DebugProgressBarFactory(),
             new ConsoleLogger($output),

tests/Fixtures/Command/ImportMoviesCommand.php

@@ -115,7 +115,6 @@ protected function createLogger(OutputInterface $output): Logger
     {
         return new StandardLogger(
             $output,
-            self::getProgressSymbol(),
             (new Terminal())->getWidth(),
             new TestDebugProgressBarFactory(),
             new ConsoleLogger($output),

tests/Fixtures/Command/NoSubProcessCommand.php

@@ -78,7 +78,6 @@ protected function createLogger(OutputInterface $output): Logger
     {
         return new StandardLogger(
             $output,
-            self::getProgressSymbol(),
             (new Terminal())->getWidth(),
             new TestDebugProgressBarFactory(),
             new ConsoleLogger($output),

tests/Logger/FakeLogger.php

@@ -45,7 +45,7 @@ public function finish(string $itemName): void
         throw new DomainException('Unexpected call.');
     }
 
-    public function logUnexpectedOutput(string $buffer): void
+    public function logUnexpectedOutput(string $buffer, string $progressSymbol): void
     {
         throw new DomainException('Unexpected call.');
     }

tests/Logger/StandardLoggerTest.php

@@ -36,7 +36,6 @@ protected function setUp(): void
 
         $this->logger = new StandardLogger(
             $this->output,
-            self::ADVANCEMENT_CHARACTER,
             self::TERMINAL_WIDTH,
             new TestProgressBarFactory(),
             new ConsoleLogger($this->output),
@@ -129,7 +128,32 @@ public function test_it_can_log_the_unexpected_output_of_a_child_process(): void
         $this->logger->advance(4);
         $this->output->fetch();
 
-        $this->logger->logUnexpectedOutput('An error occurred.');
+        $this->logger->logUnexpectedOutput(
+            'An error occurred.',
+            self::ADVANCEMENT_CHARACTER,
+        );
+
+        $expected = <<<'TXT'
+            
+            ================= Process Output =================
+            An error occurred.
+
+
+            TXT;
+
+        self::assertSame($expected, $this->output->fetch());
+    }
+
+    public function test_it_removes_the_progress_character_of_the_unexpected_output_of_a_child_process(): void
+    {
+        $this->logger->startProgress(10);
+        $this->logger->advance(4);
+        $this->output->fetch();
+
+        $this->logger->logUnexpectedOutput(
+            'An error'.self::ADVANCEMENT_CHARACTER.' occurred.',
+            self::ADVANCEMENT_CHARACTER,
+        );
 
         $expected = <<<'TXT'