Merge branch 'cleanup'

Author: lkrms

src/Toolkit/Utility/Get.php

@@ -746,8 +746,8 @@ private static function doCode(
      *
      * Recognised line endings are LF (`"\n"`), CRLF (`"\r\n"`) and CR (`"\r"`).
      *
-     * @return string|null `null` if there are no recognised line breaks in
-     * `$string`.
+     * @return non-empty-string|null `null` if there are no recognised line
+     * breaks in `$string`.
      *
      * @see Filesystem::getEol()
      * @see Str::setEol()

src/Toolkit/Utility/Str.php

@@ -39,24 +39,23 @@ public static function coalesce(?string ...$strings): ?string
     }
 
     /**
-     * Convert ASCII alphabetic characters in a string to lowercase
+     * Convert an ASCII string to lowercase
      */
     public static function lower(string $string): string
     {
         return strtr($string, self::UPPER, self::LOWER);
     }
 
     /**
-     * Convert ASCII alphabetic characters in a string to uppercase
+     * Convert an ASCII string to uppercase
      */
     public static function upper(string $string): string
     {
         return strtr($string, self::LOWER, self::UPPER);
     }
 
     /**
-     * If the first character in a string is an ASCII alphabetic character, make
-     * it uppercase
+     * Make the first character in an ASCII string uppercase
      */
     public static function upperFirst(string $string): string
     {
@@ -102,7 +101,7 @@ public static function matchCase(string $string, string $match): string
     }
 
     /**
-     * Check if a string starts with any of the given substrings
+     * Check if a string starts with a given substring
      *
      * @param iterable<string>|string $needles
      */
@@ -124,7 +123,7 @@ public static function startsWith(string $haystack, $needles, bool $ignoreCase =
     }
 
     /**
-     * Check if a string ends with any of the given substrings
+     * Check if a string ends with a given substring
      *
      * @param iterable<string>|string $needles
      */
@@ -369,7 +368,9 @@ public static function words(
     }
 
     /**
-     * Expand tabs to spaces
+     * Expand tabs in a string to spaces
+     *
+     * @param int $column The starting column (1-based) of `$text`.
      */
     public static function expandTabs(
         string $text,
@@ -379,7 +380,7 @@ public static function expandTabs(
         if (strpos($text, "\t") === false) {
             return $text;
         }
-        $eol = Get::eol($text) ?: "\n";
+        $eol = Get::eol($text) ?? "\n";
         $expanded = '';
         foreach (explode($eol, $text) as $i => $line) {
             !$i || $expanded .= $eol;
@@ -402,7 +403,11 @@ public static function expandTabs(
     }
 
     /**
-     * Expand leading tabs to spaces
+     * Expand leading tabs in a string to spaces
+     *
+     * @param bool $preserveLine1 If `true`, tabs in the first line of `$text`
+     * are not expanded.
+     * @param int $column The starting column (1-based) of `$text`.
      */
     public static function expandLeadingTabs(
         string $text,
@@ -413,7 +418,7 @@ public static function expandLeadingTabs(
         if (strpos($text, "\t") === false) {
             return $text;
         }
-        $eol = Get::eol($text) ?: "\n";
+        $eol = Get::eol($text) ?? "\n";
         $softTab = str_repeat(' ', $tabSize);
         $expanded = '';
         foreach (explode($eol, $text) as $i => $line) {
@@ -432,7 +437,7 @@ public static function expandLeadingTabs(
                 if (!$parts) {
                     break;
                 }
-                if ($part) {
+                if ($part !== '') {
                     $expanded .= "\t" . implode("\t", $parts);
                     break;
                 }

tests/unit/Toolkit/Utility/StrTest.php

@@ -657,6 +657,7 @@ public static function expandLeadingTabsProvider(): array
             ['        a', "\ta", 8],
             ["   \nabc\t", "\t\nabc\t", 4, false, 2],
             ["   \n    abc\t", "\t\n\tabc\t", 4, false, 2],
+            ["   0\t1\t2\n    0\t1\t2", "\t0\t1\t2\n\t0\t1\t2", 4, false, 2],
             [
                 <<<EOF
     abc\tde\tf\t\tg