[Console] SymfonyStyle: Align multi-line/very-long-line blocks

Remove SymfonyStyle::comment() changes (out of scope)

CS Fixes

Add tests

Author: chalasr

src/Symfony/Component/Console/Style/SymfonyStyle.php

@@ -67,23 +67,36 @@ public function block($messages, $type = null, $style = null, $prefix = ' ', $pa
     {
         $this->autoPrependBlock();
         $messages = is_array($messages) ? array_values($messages) : array($messages);
+        $indentLength = 0;
         $lines = array();
 
-        // add type
         if (null !== $type) {
-            $messages[0] = sprintf('[%s] %s', $type, $messages[0]);
+            $typePrefix = sprintf('[%s] ', $type);
+            $indentLength = strlen($typePrefix);
+            $lineIndentation = str_repeat(' ', $indentLength);
         }
 
         // wrap and add newlines for each element
         foreach ($messages as $key => $message) {
             $message = OutputFormatter::escape($message);
-            $lines = array_merge($lines, explode(PHP_EOL, wordwrap($message, $this->lineLength - Helper::strlen($prefix), PHP_EOL, true)));
+            $lines = array_merge($lines, explode(PHP_EOL, wordwrap($message, $this->lineLength - Helper::strlen($prefix) - $indentLength, PHP_EOL, true)));
+
+            // prefix each line with a number of spaces equivalent to the type length
+            if (null !== $type) {
+                foreach ($lines as &$line) {
+                    $line = $lineIndentation === substr($line, 0, $indentLength) ? $line : $lineIndentation.$line;
+                }
+            }
 
             if (count($messages) > 1 && $key < count($messages) - 1) {
                 $lines[] = '';
             }
         }
 
+        if (null !== $type) {
+            $lines[0] = substr_replace($lines[0], $typePrefix, 0, $indentLength);
+        }
+
         if ($padding && $this->isDecorated()) {
             array_unshift($lines, '');
             $lines[] = '';

src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/command/command_10.php

@@ -0,0 +1,17 @@
+<?php
+
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Tests\Style\SymfonyStyleWithForcedLineLength;
+
+//Ensure that all lines are aligned to the begin of the first line in a very long line block
+return function (InputInterface $input, OutputInterface $output) {
+    $output = new SymfonyStyleWithForcedLineLength($input, $output);
+    $output->block(
+        'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum',
+        'CUSTOM',
+        'fg=white;bg=green',
+        'X ',
+        true
+    );
+};

src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/command/command_9.php

@@ -0,0 +1,11 @@
+<?php
+
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Tests\Style\SymfonyStyleWithForcedLineLength;
+
+//Ensure that all lines are aligned to the begin of the first line in a multi-line block
+return function (InputInterface $input, OutputInterface $output) {
+    $output = new SymfonyStyleWithForcedLineLength($input, $output);
+    $output->block(['Custom block', 'Second custom block line'], 'CUSTOM', 'fg=white;bg=green', 'X ', true);
+};

src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_10.txt

@@ -0,0 +1,7 @@
+
+X [CUSTOM] Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et      
+X          dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
+X          commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat    
+X          nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit    
+X          anim id est laborum                                                                                          
+

src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_9.txt

@@ -0,0 +1,5 @@
+
+X [CUSTOM] Custom block                                                                                                 
+X                                                                                                                       
+X          Second custom block line                                                                                     
+

src/Symfony/Component/Console/Tests/Style/SymfonyStyleTest.php

@@ -57,7 +57,7 @@ public function inputCommandToOutputFilesProvider()
 
     public function testLongWordsBlockWrapping()
     {
-        $word = 'Lopadotemachoselachogaleokranioleipsanodrimhypotrimmatosilphioparaomelitokatakechymenokichlepikossyphophattoperisteralektryonoptekephalliokigklopeleiolagoiosiraiobaphetraganopterygon';
+        $word = 'Lopadotemachoselachogaleokranioleipsanodrimhypotrimmatosilphioparaomelitokatakechymenokichlepikossyphophattoperisteralektryonoptekephalliokigklopeleiolagoiosiraiobaphetraganopterygovgollhjvhvljfezefeqifzeiqgiqzhrsdgihqzridghqridghqirshdghdghieridgheirhsdgehrsdvhqrsidhqshdgihrsidvqhneriqsdvjzergetsrfhgrstsfhsetsfhesrhdgtesfhbzrtfbrztvetbsdfbrsdfbrn';
         $wordLength = strlen($word);
         $maxLineLength = SymfonyStyle::MAX_LINE_LENGTH - 3;