Merge branch 'eol-improvements'

Author: lkrms

src/Facade/File.php

@@ -16,7 +16,7 @@
  * @method static void unload() Clear the underlying Filesystem instance
  * @method static string createTemporaryDirectory() Create a temporary directory
  * @method static FluentIteratorInterface<string,SplFileInfo> find(string $directory, string|null $exclude = null, string|null $include = null, array<string,callable(SplFileInfo): bool> $excludeCallbacks = null, array<string,callable(SplFileInfo): bool> $includeCallbacks = null, bool $recursive = true, bool $withDirectories = false, bool $withDirectoriesFirst = true) Iterate over files in a directory (see {@see Filesystem::find()})
- * @method static string|false getEol(string $filename) Get a file's end-of-line sequence (see {@see Filesystem::getEol()})
+ * @method static string|null getEol(string $filename) Get the end-of-line sequence used in a file (see {@see Filesystem::getEol()})
  * @method static string getStablePath(string $suffix = '', ?string $dir = null) Generate a filename unique to the current user and the path of the running script (see {@see Filesystem::getStablePath()})
  * @method static string|null getStreamUri(resource $stream) Get the URI or filename associated with a stream (see {@see Filesystem::getStreamUri()})
  * @method static bool isPhp(string $filename) True if a file appears to contain PHP code

src/Utility/Filesystem.php

@@ -140,27 +140,41 @@ function (SplFileInfo $current, string $key) use (
     }
 
     /**
-     * Get a file's end-of-line sequence
+     * Get the end-of-line sequence used in a file
      *
-     * @param string $filename
-     * @return string|false `"\r\n"` or `"\n"` on success, or `false` if the
-     * file's line endings couldn't be determined.
+     * Recognised line endings are LF (`"\n"`), CRLF (`"\r\n"`) and CR (`"\r"`).
+     *
+     * @return string|null `null` if there are no recognised line breaks in the
+     * file.
+     *
+     * @see Inspect::getEol()
+     * @see Str::setEol()
      */
-    public function getEol(string $filename)
+    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) {
-            return false;
+            throw new RuntimeException(sprintf('Error reading file: %s', $filename));
         }
 
-        foreach (["\r\n", "\n"] as $eol) {
-            if (substr($line, -strlen($eol)) == $eol) {
+        foreach (["\r\n", "\n", "\r"] as $eol) {
+            if (substr($line, -strlen($eol)) === $eol) {
                 return $eol;
             }
         }
 
-        return false;
+        if ($restore !== null) {
+            ini_set('auto_detect_line_endings', $restore);
+        }
+
+        return null;
     }
 
     /**

src/Utility/Inspect.php

@@ -11,10 +11,13 @@ final class Inspect
     /**
      * Get the end-of-line sequence used in a string
      *
-     * Line endings recognised are LF (`"\n"`), CRLF (`"\r\n"`) and CR (`"\r"`).
+     * 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`.
+     *
+     * @see Filesystem::getEol()
+     * @see Str::setEol()
      */
     public static function getEol(string $string): ?string
     {

src/Utility/Str.php

@@ -2,6 +2,8 @@
 
 namespace Lkrms\Utility;
 
+use LogicException;
+
 /**
  * Manipulate strings
  *
@@ -43,4 +45,27 @@ public static function wordwrap(
             $delta
         );
     }
+
+    /**
+     * Apply an end-of-line sequence to a string
+     *
+     */
+    public static function setEol(
+        string $string,
+        string $eol = PHP_EOL
+    ): string {
+        switch ($eol) {
+            case "\n":
+                return str_replace(["\r\n", "\r"], $eol, $string);
+
+            case "\r":
+                return str_replace(["\r\n", "\n"], $eol, $string);
+
+            case "\r\n":
+                return str_replace(["\r\n", "\r", "\n"], ["\n", "\n", $eol], $string);
+
+            default:
+                throw new LogicException(sprintf('Invalid end-of-line sequence: %s', $eol));
+        }
+    }
 }