[Console] Support max column width in Table #28373

ro0NL · 2018-09-05T14:54:01Z

Q	A
Branch?	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#22156, #27832
License	MIT
Doc PR	symfony/symfony-docs#10300

Continuation of #22225 to better preserve spaces (which preserves background colors), using wordwrap it caused some issues.

Also the wrapping was plain wrong by not taking the current line length into account.

While at it, it comes with Table integration :)

Given

$table = new Table($output);
$table->setColumnMaxWidth(0, 2);
$table->setRow(0, ['pre <error>foo bar baz</error> post']);
$table->render();

$table = new Table($output);
$table->setColumnMaxWidth(0, 3);
$table->setRow(0, ['pre <error>foo bar baz</error> post']);
$table->render();

$table = new Table($output);
$table->setColumnMaxWidth(0, 4);
$table->setRow(0, ['pre <error>foo bar baz</error> post']);
$table->render();

ro0NL · 2018-09-05T14:57:26Z

src/Symfony/Component/Console/Formatter/OutputFormatter.php

+
+        $lines = array();
+        foreach (explode("\n", $text) as $line) {
+            $lines[] = '' === $line ? $line : $this->styleStack->getCurrent()->apply($line);


here we fix #27832 by formatting each line separate. This only helps when the user wraps a string. If it's wrapped by the terminal it can still occur.

nicolas-grekas · 2018-09-06T12:43:49Z

(tests are red)

ro0NL · 2018-09-06T12:48:22Z

Ah forgot to mention; failures unrelated :)

fabbot.io is a false-positive IMHO

travis

1) Symfony\Component\Lock\Tests\Store\PdoStoreTest::testRefreshLock
Failed asserting that false is true.

appveyor:

KO src\Symfony/Bundle/SecurityBundle

nicolas-grekas · 2018-09-06T12:50:47Z

I restarted the builds on Travis and appveyor. Let's fix fabbot.

ro0NL · 2018-09-06T13:03:53Z

Done. Consistent with render() anyway and doesnt break formatting: https://api.symfony.com/3.4/Symfony/Component/Console/Helper/Table.html#method_render

nicolas-grekas · 2018-09-07T12:16:24Z

src/Symfony/Component/Console/Formatter/OutputFormatter.php

-            if ('' !== $current && "\n" !== substr($current, -1)) {
-                $text = "\n".$text;
+        if ($this->isDecorated()) {
+            foreach ($lines as &$line) {


let's not use a reference when we can do without

nicolas-grekas · 2018-09-07T12:18:55Z

src/Symfony/Component/Console/Helper/Table.php

+     *
+     * @return $this
+     */
+    public function setColumnMaxWidths(array $widths): self


Do we really need this one? Can't we do the same with setColumnMaxWidth and keep a smaller public API?

currently we have setColumnWidth() and setColumnWidths() to control min. width. We can do without setColumnMaxWidths() but might raise some questions (why cant i set max. widths at once?)

IMHO the ideal api is: setColumnMinWidth + setColumnMaxWidth + setColumnWidth where the latter sets both min. and max. (thus fixed). However that requires to rename the current setColumnWidth to setColumnMinWidth first. Not aiming for that :)

Do you suggest to drop setColumnMaxWidths and add array support in setColumnMaxWidth or just drop it?

ro0NL · 2018-09-07T18:41:42Z

Ready for me :) really happy with this feature.

javiereguiluz

I like this! Thanks Roland.

javiereguiluz · 2018-09-10T06:53:50Z

src/Symfony/Component/Console/Formatter/OutputFormatter.php

@@ -142,6 +142,7 @@ public function formatAndWrap(string $message, int $width)
        $offset = 0;
        $output = '';
        $tagRegex = '[a-z][a-z0-9,_=;-]*+';
+        $length = 0;


Minor comment: should we rename $length as $maxLength ? "length" is too generic, and in this case is confusing because we are also using "width" --> $this->applyCurrentStyle(..., ..., $width, $length)

$currentLineLength? It's not a max value, e.g. for $width = 5 and $text = '123456'

12345 // $length = 0 aka "full" 6 // $length = 1

So we know we can add 5-1=4 more chars before the next line break

👍 for $currentLineLength

src/Symfony/Component/Console/Helper/Table.php

@chalasr

This PR was merged into the 3.4 branch. Discussion ---------- [Console] Fix typo in tests | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no  | Deprecations? | no | Tests pass? | yes  | Fixed tickets | #...  | License | MIT | Doc PR | symfony/symfony-docs#...  Spotted in #28373 cc @chalasr Commits ------- 01e491e [Console] Fix typo in tests

chalasr · 2018-09-11T17:20:37Z

Thank you @ro0NL.

This PR was squashed before being merged into the 4.2-dev branch (closes #28373). Discussion ---------- [Console] Support max column width in Table | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no  | Deprecations? | no | Tests pass? | yes  | Fixed tickets | #22156, #27832 | License | MIT | Doc PR | symfony/symfony-docs#10300 Continuation of #22225 to better preserve spaces (which preserves background colors), using `wordwrap` it caused some issues. Also the wrapping was plain wrong by not taking the current line length into account. While at it, it comes with `Table` integration :) Given ```php $table = new Table($output); $table->setColumnMaxWidth(0, 2); $table->setRow(0, ['pre <error>foo bar baz</error> post']); $table->render(); $table = new Table($output); $table->setColumnMaxWidth(0, 3); $table->setRow(0, ['pre <error>foo bar baz</error> post']); $table->render(); $table = new Table($output); $table->setColumnMaxWidth(0, 4); $table->setRow(0, ['pre <error>foo bar baz</error> post']); $table->render(); ``` ![image](https://user-images.githubusercontent.com/1047696/45101516-f19b5880-b12b-11e8-825f-6a1d84f68f47.png) Commits ------- 175f68f [Console] Support max column width in Table

pjcdawkins · 2018-11-30T11:12:17Z

In case you're interested in an older implementation of something that sets column widths according to the terminal width:
https://github.com/platformsh/platformsh-cli/blob/281b998a369339a0e481cf450d986f03f52e2146/src/Console/AdaptiveTable.php#L12

Looks like it can now be significantly simplified based on these Console changes (thanks @ro0NL)

carsonbot added Status: Needs Review Console Feature labels Sep 5, 2018

ro0NL commented Sep 5, 2018

View reviewed changes

nicolas-grekas added this to the next milestone Sep 6, 2018

nicolas-grekas reviewed Sep 7, 2018

View reviewed changes

ro0NL mentioned this pull request Sep 7, 2018

[Console] Table column max width / formatted text wrapping symfony/symfony-docs#10300

Closed

nicolas-grekas approved these changes Sep 7, 2018

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Sep 7, 2018

chalasr approved these changes Sep 7, 2018

View reviewed changes

javiereguiluz approved these changes Sep 10, 2018

View reviewed changes

ro0NL mentioned this pull request Sep 11, 2018

[Console] Fix typo in tests #28450

Merged

[Console] Support max column width in Table

175f68f

chalasr merged commit 175f68f into symfony:master Sep 11, 2018

ro0NL deleted the console/table-width branch September 11, 2018 17:22

nicolas-grekas modified the milestones: next, 4.2 Nov 1, 2018

This was referenced Nov 3, 2018

Release v4.2.0-BETA1 #29072

Closed

Release v4.2.0-BETA1 #29073

Merged

Raulnet mentioned this pull request Apr 8, 2019

[Console] fix buildTableRows when Colspan is use with content too long #30852

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Support max column width in Table #28373

[Console] Support max column width in Table #28373

ro0NL commented Sep 5, 2018 •

edited

Loading

ro0NL Sep 5, 2018 •

edited

Loading

nicolas-grekas commented Sep 6, 2018

ro0NL commented Sep 6, 2018

nicolas-grekas commented Sep 6, 2018

ro0NL commented Sep 6, 2018

nicolas-grekas Sep 7, 2018

nicolas-grekas Sep 7, 2018

ro0NL Sep 7, 2018

ro0NL commented Sep 7, 2018

javiereguiluz left a comment

javiereguiluz Sep 10, 2018

ro0NL Sep 10, 2018 •

edited

Loading

chalasr Sep 10, 2018

chalasr commented Sep 11, 2018

pjcdawkins commented Nov 30, 2018

[Console] Support max column width in Table #28373

[Console] Support max column width in Table #28373

Conversation

ro0NL commented Sep 5, 2018 • edited Loading

ro0NL Sep 5, 2018 • edited Loading

Choose a reason for hiding this comment

nicolas-grekas commented Sep 6, 2018

ro0NL commented Sep 6, 2018

nicolas-grekas commented Sep 6, 2018

ro0NL commented Sep 6, 2018

nicolas-grekas Sep 7, 2018

Choose a reason for hiding this comment

nicolas-grekas Sep 7, 2018

Choose a reason for hiding this comment

ro0NL Sep 7, 2018

Choose a reason for hiding this comment

ro0NL commented Sep 7, 2018

javiereguiluz left a comment

Choose a reason for hiding this comment

javiereguiluz Sep 10, 2018

Choose a reason for hiding this comment

ro0NL Sep 10, 2018 • edited Loading

Choose a reason for hiding this comment

chalasr Sep 10, 2018

Choose a reason for hiding this comment

chalasr commented Sep 11, 2018

pjcdawkins commented Nov 30, 2018

ro0NL commented Sep 5, 2018 •

edited

Loading

ro0NL Sep 5, 2018 •

edited

Loading

ro0NL Sep 10, 2018 •

edited

Loading