Remove OutputWrapperInterface

Author: GromNaN

CHANGELOG.md

@@ -12,9 +12,7 @@ CHANGELOG
 
  * Add support to display table vertically when calling setVertical()
  * Add method `__toString()` to `InputInterface`
- * Added `OutputWrapperInterface` and `OutputWrapper` to allow modifying your
-   wrapping strategy in `SymfonyStyle` or in other `OutputStyle`. Eg: you can
-   switch off to wrap URLs.
+ * Added `OutputWrapper` to prevent truncated URL in `SymfonyStyle::createBlock`.
  * Deprecate `Command::$defaultName` and `Command::$defaultDescription`, use the `AsCommand` attribute instead
  * Add suggested values for arguments and options in input definition, for input completion
  * Add `$resumeAt` parameter to `ProgressBar#start()`, so that one can easily 'resume' progress on longer tasks, and still get accurate `getEstimate()` and `getRemaining()` results.

Formatter/OutputFormatter.php

@@ -12,7 +12,6 @@
 namespace Symfony\Component\Console\Formatter;
 
 use Symfony\Component\Console\Exception\InvalidArgumentException;
-use Symfony\Component\Console\Helper\OutputWrapperInterface;
 
 /**
  * Formatter class for console output.
@@ -145,8 +144,8 @@ public function formatAndWrap(?string $message, int $width)
 
         $offset = 0;
         $output = '';
-        $openTagRegex = OutputWrapperInterface::TAG_OPEN_REGEX_SEGMENT;
-        $closeTagRegex = OutputWrapperInterface::TAG_CLOSE_REGEX_SEGMENT;
+        $openTagRegex = '[a-z](?:[^\\\\<>]*+ | \\\\.)*';
+        $closeTagRegex = '[a-z][^<>]*+';
         $currentLineLength = 0;
         preg_match_all("#<(($openTagRegex) | /($closeTagRegex)?)>#ix", $message, $matches, \PREG_OFFSET_CAPTURE);
         foreach ($matches[0] as $i => $match) {
@@ -162,7 +161,7 @@ public function formatAndWrap(?string $message, int $width)
             $offset = $pos + \strlen($text);
 
             // opening tag?
-            if ($open = ('/' !== $text[1])) {
+            if ($open = '/' !== $text[1]) {
                 $tag = $matches[1][$i][0];
             } else {
                 $tag = $matches[3][$i][0] ?? '';

Helper/OutputWrapper.php

@@ -42,22 +42,15 @@
  *
  * @see https://stackoverflow.com/a/20434776/1476819
  */
-final class OutputWrapper implements OutputWrapperInterface
+final class OutputWrapper
 {
+    private const TAG_OPEN_REGEX_SEGMENT = '[a-z](?:[^\\\\<>]*+ | \\\\.)*';
+    private const TAG_CLOSE_REGEX_SEGMENT = '[a-z][^<>]*+';
     private const URL_PATTERN = 'https?://\S+';
 
-    private bool $allowCutUrls = false;
-
-    public function isAllowCutUrls(): bool
-    {
-        return $this->allowCutUrls;
-    }
-
-    public function setAllowCutUrls(bool $allowCutUrls)
-    {
-        $this->allowCutUrls = $allowCutUrls;
-
-        return $this;
+    public function __construct(
+        private bool $allowCutUrls = false
+    ) {
     }
 
     public function wrap(string $text, int $width, string $break = "\n"): string
@@ -66,7 +59,7 @@ public function wrap(string $text, int $width, string $break = "\n"): string
             return $text;
         }
 
-        $tagPattern = sprintf('<(?:(?:%s)|/(?:%s)?)>', OutputWrapperInterface::TAG_OPEN_REGEX_SEGMENT, OutputWrapperInterface::TAG_CLOSE_REGEX_SEGMENT);
+        $tagPattern = sprintf('<(?:(?:%s)|/(?:%s)?)>', self::TAG_OPEN_REGEX_SEGMENT, self::TAG_CLOSE_REGEX_SEGMENT);
         $limitPattern = "{1,$width}";
         $patternBlocks = [$tagPattern];
         if (!$this->allowCutUrls) {

Helper/OutputWrapperInterface.php

@@ -16,7 +16,6 @@
 use Symfony\Component\Console\Formatter\OutputFormatter;
 use Symfony\Component\Console\Helper\Helper;
 use Symfony\Component\Console\Helper\OutputWrapper;
-use Symfony\Component\Console\Helper\OutputWrapperInterface;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Helper\SymfonyQuestionHelper;
 use Symfony\Component\Console\Helper\Table;
@@ -46,32 +45,18 @@ class SymfonyStyle extends OutputStyle
     private ProgressBar $progressBar;
     private int $lineLength;
     private TrimmedBufferOutput $bufferedOutput;
-    private OutputWrapperInterface $outputWrapper;
 
-    public function __construct(InputInterface $input, OutputInterface $output, OutputWrapperInterface $outputWrapper = null)
+    public function __construct(InputInterface $input, OutputInterface $output)
     {
         $this->input = $input;
         $this->bufferedOutput = new TrimmedBufferOutput(\DIRECTORY_SEPARATOR === '\\' ? 4 : 2, $output->getVerbosity(), false, clone $output->getFormatter());
         // Windows cmd wraps lines as soon as the terminal width is reached, whether there are following chars or not.
         $width = (new Terminal())->getWidth() ?: self::MAX_LINE_LENGTH;
         $this->lineLength = min($width - (int) (\DIRECTORY_SEPARATOR === '\\'), self::MAX_LINE_LENGTH);
-        $this->outputWrapper = $outputWrapper ?: new OutputWrapper();
 
         parent::__construct($this->output = $output);
     }
 
-    public function getOutputWrapper(): OutputWrapperInterface
-    {
-        return $this->outputWrapper;
-    }
-
-    public function setOutputWrapper(OutputWrapperInterface $outputWrapper)
-    {
-        $this->outputWrapper = $outputWrapper;
-
-        return $this;
-    }
-
     /**
      * Formats a message as a block of text.
      */
@@ -477,14 +462,15 @@ private function createBlock(iterable $messages, string $type = null, string $st
         }
 
         // wrap and add newlines for each element
+        $outputWrapper = new OutputWrapper();
         foreach ($messages as $key => $message) {
             if ($escape) {
                 $message = OutputFormatter::escape($message);
             }
 
             $lines = array_merge(
                 $lines,
-                explode(\PHP_EOL, $this->outputWrapper->wrap(
+                explode(\PHP_EOL, $outputWrapper->wrap(
                     $message,
                     $this->lineLength - $prefixLength - $indentLength,
                     \PHP_EOL

Style/SymfonyStyle.php

@@ -19,12 +19,9 @@ class OutputWrapperTest extends TestCase
     /**
      * @dataProvider textProvider
      */
-    public function testBasicWrap(string $text, int $width, ?bool $allowCutUrls, string $expected)
+    public function testBasicWrap(string $text, int $width, bool $allowCutUrls, string $expected)
     {
-        $wrapper = new OutputWrapper();
-        if (\is_bool($allowCutUrls)) {
-            $wrapper->setAllowCutUrls($allowCutUrls);
-        }
+        $wrapper = new OutputWrapper($allowCutUrls);
         $result = $wrapper->wrap($text, $width);
         $this->assertEquals($expected, $result);
     }
@@ -36,7 +33,7 @@ public static function textProvider(): iterable
         yield 'Default URL cut' => [
             $baseTextWithUtf8AndUrl,
             20,
-            null,
+            false,
             <<<'EOS'
             Árvíztűrőtükörfúrógé
             p https://github.com/symfony/symfony Lorem ipsum