Fix removal of trailing tab / whitespace in tabular table (#184)

mrsdizzie · web-flow · commit fbb9c6eb83c0 · 2025-03-05T15:35:01.000+01:00
Previously the final table output was trimmed with the intention of
removing the last newline. This had an unintended side effect of
removing the tab characters from empty columns in the specific case
where the last row had one or more empty columns at the end of the row.
This makes sure we are only removing the newline character as intended.

Add a new unit test to verify this behavior as well.
diff --git a/lib/cli/table/Tabular.php b/lib/cli/table/Tabular.php
@@ -45,7 +45,6 @@ public function row( array $row ) {
 		foreach ( $rows as $r ) {
 			$output .= implode( "\t", array_values( $r ) ) . PHP_EOL;
 		}
-
-		return trim( $output );
+		return rtrim( $output, PHP_EOL );
 	}
 }
diff --git a/tests/Test_Table.php b/tests/Test_Table.php
@@ -245,4 +245,26 @@ public function test_ascii_pre_colorized_widths() {
 		$this->assertSame( 56, strlen( $out[6] ) );
 	}
 
+	public function test_preserve_trailing_tabs() {
+		$table    = new cli\Table();
+		$renderer = new cli\Table\Tabular();
+		$table->setRenderer( $renderer );
+
+		$table->setHeaders( array( 'Field', 'Type', 'Null', 'Key', 'Default', 'Extra' ) );
+
+		// Add row with missing values at the end
+		$table->addRow( array( 'date', 'date', 'NO', 'PRI', '', '' ) );
+		$table->addRow( array( 'awesome_stuff', 'text', 'YES', '', '', '' ) );
+
+		$out = $table->getDisplayLines();
+
+		$expected = [
+			"Field\tType\tNull\tKey\tDefault\tExtra",
+			"date\tdate\tNO\tPRI\t\t",
+			"awesome_stuff\ttext\tYES\t\t\t",
+		];
+
+		$this->assertSame( $expected, $out, 'Trailing tabs should be preserved in table output.' );
+	}
+
 }

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,6 @@ public function row( array $row ) {`
`45`	`45`	`foreach ( $rows as $r ) {`
`46`	`46`	`$output .= implode( "\t", array_values( $r ) ) . PHP_EOL;`
`47`	`47`	`}`
`48`		`-`
`49`		`- return trim( $output );`
	`48`	`+ return rtrim( $output, PHP_EOL );`
`50`	`49`	`}`
`51`	`50`	`}`