Add Colors::width() instead of changing Colors::length() for api BC.

Author: gitlost

lib/cli/Colors.php

@@ -176,7 +176,7 @@ static public function cacheString($passed, $colorized, $colored) {
 	 * Return the length of the string without color codes.
 	 *
 	 * @param string  $string  the string to measure
-     * @return string
+     * @return int
 	 */
 	static public function length($string) {
 		if (isset(self::$_string_cache[md5($string)]['decolorized'])) {
@@ -185,6 +185,22 @@ static public function length($string) {
 			$test_string = self::decolorize($string);
 		}
 
+		return safe_strlen($test_string);
+	}
+
+	/**
+	 * Return the width (length in characters) of the string without color codes.
+	 *
+	 * @param string  $string  the string to measure
+     * @return int
+	 */
+	static public function width($string) {
+		if (isset(self::$_string_cache[md5($string)]['decolorized'])) {
+			$test_string = self::$_string_cache[md5($string)]['decolorized'];
+		} else {
+			$test_string = self::decolorize($string);
+		}
+
 		return strwidth($test_string);
 	}
 

lib/cli/Table.php

@@ -102,7 +102,7 @@ public function setRenderer(Renderer $renderer) {
 	 */
 	protected function checkRow(array $row) {
 		foreach ($row as $column => $str) {
-			$width = Colors::shouldColorize() ? Colors::length($str) : strwidth($str);
+			$width = Colors::shouldColorize() ? Colors::width($str) : strwidth($str);
 			if (!isset($this->_width[$column]) || $width > $this->_width[$column]) {
 				$this->_width[$column] = $width;
 			}

lib/cli/table/Ascii.php

@@ -133,7 +133,7 @@ public function row( array $row ) {
 				$value = str_replace( PHP_EOL, ' ', $value );
 
 				$col_width = $this->_widths[ $col ];
-				$original_val_width = Colors::shouldColorize() ? Colors::length( $value ) : \cli\strwidth( $value );
+				$original_val_width = Colors::shouldColorize() ? Colors::width( $value ) : \cli\strwidth( $value );
 				if ( $original_val_width > $col_width ) {
 					$row[ $col ] = \cli\safe_substr( $value, 0, $col_width );
 					$value = \cli\safe_substr( $value, $col_width, $original_val_width );

tests/test-cli.php

@@ -12,13 +12,27 @@ function setUp() {
 
 	function test_string_length() {
 		$this->assertEquals( \cli\Colors::length( 'x' ), 1 );
+		$this->assertEquals( \cli\Colors::length( '日' ), 1 );
+	}
+
+	function test_string_width() {
+		$this->assertEquals( \cli\Colors::width( 'x' ), 1 );
+		$this->assertEquals( \cli\Colors::width( '日' ), 2 ); // Double-width char.
 	}
 
 	function test_encoded_string_length() {
 
 		$this->assertEquals( \cli\Colors::length( 'hello' ), 5 );
 		$this->assertEquals( \cli\Colors::length( 'óra' ), 3 );
-		$this->assertEquals( \cli\Colors::length( '日本語' ), 6 ); // 3 double-width chars.
+		$this->assertEquals( \cli\Colors::length( '日本語' ), 3 );
+
+	}
+
+	function test_encoded_string_width() {
+
+		$this->assertEquals( \cli\Colors::width( 'hello' ), 5 );
+		$this->assertEquals( \cli\Colors::width( 'óra' ), 3 );
+		$this->assertEquals( \cli\Colors::width( '日本語' ), 6 ); // 3 double-width chars.
 
 	}
 
@@ -45,6 +59,12 @@ function test_encoded_substr() {
 
 	function test_colorized_string_length() {
 		$this->assertEquals( \cli\Colors::length( \cli\Colors::colorize( '%Gx%n', true ) ), 1 );
+		$this->assertEquals( \cli\Colors::length( \cli\Colors::colorize( '%G日%n', true ) ), 1 );
+	}
+
+	function test_colorized_string_width() {
+		$this->assertEquals( \cli\Colors::width( \cli\Colors::colorize( '%Gx%n', true ) ), 1 );
+		$this->assertEquals( \cli\Colors::width( \cli\Colors::colorize( '%G日%n', true ) ), 2 ); // Double-width char.
 	}
 
 	function test_colorize_string_is_colored() {