safe_strpad() should pad the string according to display needs

Because `safe_strlen()` gives us the string length for output, we need the true length to determine how much we should pad the string

Author: danielbachhuber

lib/cli/cli.php

@@ -195,17 +195,20 @@ function safe_substr( $str, $start, $length = false ) {
 }
 
 /**
- * An encoding-safe way of padding string length
+ * An encoding-safe way of padding string length for display
  *
  * @param string $string The string to pad
  * @param int $length The length to pad it to
  * @return string
  */
 function safe_str_pad( $string, $length ) {
-	$real_length = safe_strlen($string);
-	$show_length = Colors::length($string);
-	$diff = strlen( $string ) - safe_strlen( $string );
-	$length += $real_length - $show_length + $diff;
-
-	return str_pad($string, $length);
+	if ( function_exists( 'mb_strwidth' ) ) {
+		$real_length = mb_strwidth( $string, mb_detect_encoding( $string ) );
+	} else {
+		$real_length = safe_strlen( $string );
+	}
+	$show_length = Colors::length( $string );
+	$diff = strlen( $string ) - $real_length;
+	$length += $diff;
+	return str_pad( $string, $length );
 }

tests/test-cli.php

@@ -20,9 +20,13 @@ function test_encoded_string_length() {
 		$this->assertEquals( \cli\Colors::length( 'óra' ), 3 );
 		$this->assertEquals( \cli\Colors::length( '日本語' ), 3 );
 
-		$this->assertEquals( \cli\safe_strlen( \cli\Colors::pad( 'hello', 6 ) ), 6 );
-		$this->assertEquals( \cli\safe_strlen( \cli\Colors::pad( 'óra', 6 ) ), 6 );
-		$this->assertEquals( \cli\safe_strlen( \cli\Colors::pad( '日本語', 6 ) ), 6 );
+	}
+
+	function test_encoded_string_pad() {
+
+		$this->assertEquals( 6, strlen( \cli\Colors::pad( 'hello', 6 ) ) );
+		$this->assertEquals( 7, strlen( \cli\Colors::pad( 'óra', 6 ) ) ); // special characters take one byte
+		$this->assertEquals( 9, strlen( \cli\Colors::pad( '日本語', 6 ) ) ); // each character takes two bytes
 
 	}