Fix regression in File::getEol(), deprecate Convert::lineEndingsToUnix()

- Remove use of deprecated `auto_detect_line_endings` setting
- Adopt `Str::setEol()` over `Convert::lineEndingsToUnix()`

Author: lkrms

src/Console/ConsoleFormatter.php

@@ -250,7 +250,7 @@ public function formatTags(
         // fenced code blocks and code spans
         if (!Pcre::matchAll(
             Regex::delimit(self::PARSER_REGEX) . 'u',
-            Convert::lineEndingsToUnix($string),
+            Str::setEol($string),
             $matches,
             PREG_SET_ORDER | PREG_UNMATCHED_AS_NULL
         )) {

src/Support/PhpDoc/PhpDoc.php

@@ -6,6 +6,7 @@
 use Lkrms\Contract\IReadable;
 use Lkrms\Support\Catalog\RegularExpression as Regex;
 use Lkrms\Utility\Convert;
+use Lkrms\Utility\Str;
 use UnexpectedValueException;
 
 /**
@@ -141,7 +142,7 @@ public function __construct(
                     '/(^\h*\* ?|\h+$)/um',
                     '',
                     // 2. Normalise line endings
-                    Convert::lineEndingsToUnix(
+                    Str::setEol(
                         // 1. Extract text between "/**" and "*/"
                         $matches['content']
                     )

src/Utility/Convert.php

@@ -1340,6 +1340,7 @@ public static function toNormal(string $text): string
     /**
      * Replace a string's CRLF or CR end-of-line sequences with LF
      *
+     * @deprecated Use {@see Str::setEol()} instead
      */
     public static function lineEndingsToUnix(string $string): string
     {

src/Utility/Env.php

@@ -60,7 +60,7 @@ public static function load(string ...$path): void
         $queue = [];
         $errors = [];
         foreach ($path as $filename) {
-            $lines = explode("\n", Convert::lineEndingsToUnix(file_get_contents($filename)));
+            $lines = explode("\n", Str::setEol(file_get_contents($filename)));
             self::parse($lines, $queue, $errors, $filename);
         }
         self::doLoad($queue, $errors);

src/Utility/Filesystem.php

@@ -152,12 +152,6 @@ function (SplFileInfo $current, string $key) use (
      */
     public function getEol(string $filename): ?string
     {
-        // Enable PHP's detection of CR line endings
-        $restore = ini_set('auto_detect_line_endings', '1');
-        if ($restore === false || $restore) {
-            $restore = null;
-        }
-
         if (($f = fopen($filename, 'r')) === false ||
                 ($line = fgets($f)) === false ||
                 fclose($f) === false) {
@@ -170,8 +164,8 @@ public function getEol(string $filename): ?string
             }
         }
 
-        if ($restore !== null) {
-            ini_set('auto_detect_line_endings', $restore);
+        if (strpos($line, "\r") !== false) {
+            return "\r";
         }
 
         return null;

src/Utility/Reflection.php

@@ -162,13 +162,13 @@ public function getAllClassDocComments(ReflectionClass $class): array
         $comments = [];
         do {
             if (($comment = $class->getDocComment()) !== false) {
-                $comments[$class->getName()] = Convert::lineEndingsToUnix($comment);
+                $comments[$class->getName()] = Str::setEol($comment);
             }
         } while ($class = $class->getParentClass());
 
         foreach ($interfaces as $interface) {
             if (($comment = $interface->getDocComment()) !== false) {
-                $comments[$interface->getName()] = Convert::lineEndingsToUnix($comment);
+                $comments[$interface->getName()] = Str::setEol($comment);
             }
         }
 
@@ -201,10 +201,10 @@ public function getAllMethodDocComments(ReflectionMethod $method, ?array &$class
             if ($interface->hasMethod($name) &&
                     ($comment = $interface->getMethod($name)->getDocComment()) !== false) {
                 $class = $interface->getName();
-                $comments[$class] = Convert::lineEndingsToUnix($comment);
+                $comments[$class] = Str::setEol($comment);
                 if (!is_null($classDocComments)) {
                     $comment = $interface->getDocComment() ?: null;
-                    $classDocComments[$class] = $comment === null ? null : Convert::lineEndingsToUnix($comment);
+                    $classDocComments[$class] = $comment === null ? null : Str::setEol($comment);
                 }
             }
         }
@@ -223,10 +223,10 @@ private function _getAllMethodDocComments(ReflectionMethod $method, string $name
         do {
             if (($comment = $method->getDocComment()) !== false) {
                 $class = $method->getDeclaringClass()->getName();
-                $comments[$class] = Convert::lineEndingsToUnix($comment);
+                $comments[$class] = Str::setEol($comment);
                 if (!is_null($classDocComments)) {
                     $comment = $method->getDeclaringClass()->getDocComment() ?: null;
-                    $classDocComments[$class] = $comment === null ? null : Convert::lineEndingsToUnix($comment);
+                    $classDocComments[$class] = $comment === null ? null : Str::setEol($comment);
                 }
             }
             // Interfaces don't have traits, so there's nothing else to do here
@@ -293,10 +293,10 @@ private function _getAllPropertyDocComments(
         do {
             if (($comment = $property->getDocComment()) !== false) {
                 $class = $property->getDeclaringClass()->getName();
-                $comments[$class] = Convert::lineEndingsToUnix($comment);
+                $comments[$class] = Str::setEol($comment);
                 if (!is_null($classDocComments)) {
                     $comment = $property->getDeclaringClass()->getDocComment() ?: null;
-                    $classDocComments[$class] = $comment === null ? null : Convert::lineEndingsToUnix($comment);
+                    $classDocComments[$class] = $comment === null ? null : Str::setEol($comment);
                 }
             }
             foreach ($property->getDeclaringClass()->getTraits() as $trait) {

src/Utility/Str.php

@@ -52,7 +52,7 @@ public static function wordwrap(
      */
     public static function setEol(
         string $string,
-        string $eol = PHP_EOL
+        string $eol = "\n"
     ): string {
         switch ($eol) {
             case "\n":

tests/unit/Polyfill/PhpTokenTest.php

@@ -4,6 +4,7 @@
 
 use Lkrms\Polyfill\PhpToken;
 use Lkrms\Utility\Convert;
+use Lkrms\Utility\Str;
 
 final class PhpTokenTest extends \Lkrms\Tests\TestCase
 {
@@ -14,7 +15,7 @@ final class PhpTokenTest extends \Lkrms\Tests\TestCase
      */
     public function testTokenize(string $input, array $expected)
     {
-        $actual = PhpToken::tokenize(Convert::lineEndingsToUnix($input), TOKEN_PARSE);
+        $actual = PhpToken::tokenize(Str::setEol($input), TOKEN_PARSE);
         $actualCode = array_reduce(
             $actual,
             fn(string $code, PhpToken $token) => sprintf(