feat(filesystem): add new Filesystem component (#441)

aidan-casey · brendt · web-flow · commit 25d4a47f741f · 2024-11-20T10:52:57.000+01:00
Co-authored-by: Brent Roose &lt;brent.roose@gmail.com&gt;
diff --git a/composer.json b/composer.json
@@ -43,6 +43,7 @@
         "guzzlehttp/psr7": "^2.6.1",
         "illuminate/view": "~11.7.0",
         "jenssegers/blade": "^2.0",
+        "mikey179/vfsstream": "^2.0@dev",
         "nyholm/psr7": "^1.8",
         "phpat/phpat": "^0.10.14",
         "phpbench/phpbench": "84.x-dev",
@@ -64,6 +65,7 @@
         "tempest/database": "self.version",
         "tempest/debug": "self.version",
         "tempest/event-bus": "self.version",
+        "tempest/filesystem": "self.version",
         "tempest/generation": "self.version",
         "tempest/http": "self.version",
         "tempest/http-client": "self.version",
@@ -88,6 +90,7 @@
             "Tempest\\Database\\": "src/Tempest/Database/src",
             "Tempest\\Debug\\": "src/Tempest/Debug/src",
             "Tempest\\EventBus\\": "src/Tempest/EventBus/src",
+            "Tempest\\Filesystem\\": "src/Tempest/Filesystem/src",
             "Tempest\\Framework\\": "src/Tempest/Framework",
             "Tempest\\Generation\\": "src/Tempest/Generation/src",
             "Tempest\\HttpClient\\": "src/Tempest/HttpClient/src",
@@ -123,6 +126,7 @@
             "Tempest\\Core\\Tests\\": "src/Tempest/Core/tests",
             "Tempest\\Database\\Tests\\": "src/Tempest/Database/tests",
             "Tempest\\EventBus\\Tests\\": "src/Tempest/EventBus/tests",
+            "Tempest\\Filesystem\\Tests\\": "src/Tempest/Filesystem/tests",
             "Tempest\\Generation\\Tests\\": "src/Tempest/Generation/tests",
             "Tempest\\HttpClient\\Tests\\": "src/Tempest/HttpClient/tests",
             "Tempest\\Http\\Tests\\": "src/Tempest/Http/tests",
diff --git a/src/Tempest/Filesystem/.gitattributes b/src/Tempest/Filesystem/.gitattributes
@@ -0,0 +1,10 @@
+# Exclude build/test files from the release
+.github/                  export-ignore
+tests/                    export-ignore
+.gitattributes            export-ignore
+.gitignore                export-ignore
+phpunit.xml               export-ignore
+README.md                 export-ignore
+
+# Configure diff output for .php and .phar files.
+*.php diff=php
diff --git a/src/Tempest/Filesystem/LICENCE.md b/src/Tempest/Filesystem/LICENCE.md
@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Brent Roose brendt@stitcher.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/src/Tempest/Filesystem/composer.json b/src/Tempest/Filesystem/composer.json
@@ -0,0 +1,22 @@
+{
+    "name": "tempest/filesystem",
+    "description": "The PHP framework that gets out of your way.",
+    "require": {
+        "php": "^8.3"
+    },
+    "autoload": {
+        "psr-4": {
+            "Tempest\\Filesystem\\": "src"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Tempest\\Filesystem\\Tests\\": "tests"
+        }
+    },
+    "license": "MIT",
+    "minimum-stability": "dev",
+    "require-dev": {
+        "mikey179/vfsstream": "^2.0@dev"
+    }
+}
diff --git a/src/Tempest/Filesystem/phpunit.xml b/src/Tempest/Filesystem/phpunit.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd" bootstrap="vendor/autoload.php" executionOrder="depends,defects" beStrictAboutOutputDuringTests="true" displayDetailsOnPhpunitDeprecations="true" failOnPhpunitDeprecation="false" failOnRisky="true" failOnWarning="true">
+    <testsuites>
+        <testsuite name="Tempest Filesystem">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <source restrictNotices="true" restrictWarnings="true" ignoreIndirectDeprecations="true">
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
+</phpunit>
diff --git a/src/Tempest/Filesystem/src/ErrorContext.php b/src/Tempest/Filesystem/src/ErrorContext.php
@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Filesystem;
+
+final class ErrorContext
+{
+    private array $lastError = [];
+
+    public function __construct()
+    {
+        error_clear_last();
+    }
+
+    public static function reset(): self
+    {
+        return new self();
+    }
+
+    public function getMessage(?string $default = 'Unknown error.'): string
+    {
+        return $this->getLastError()['message'] ?? $default;
+    }
+
+    public function commit(): self
+    {
+        $this->lastError = error_get_last() ?? [];
+
+        return $this;
+    }
+
+    private function getLastError(): array
+    {
+        return $this->lastError ??= $this->commit()->lastError;
+    }
+}
diff --git a/src/Tempest/Filesystem/src/Exceptions/FileDoesNotExist.php b/src/Tempest/Filesystem/src/Exceptions/FileDoesNotExist.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Filesystem\Exceptions;
+
+use RuntimeException;
+
+final class FileDoesNotExist extends RuntimeException
+{
+    public static function atPath(string $path): FileDoesNotExist
+    {
+        return new self("File does not exist at path `{$path}`.");
+    }
+}
diff --git a/src/Tempest/Filesystem/src/Exceptions/UnableToCopyFile.php b/src/Tempest/Filesystem/src/Exceptions/UnableToCopyFile.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Filesystem\Exceptions;
+
+use RuntimeException;
+use Tempest\Filesystem\ErrorContext;
+
+final class UnableToCopyFile extends RuntimeException
+{
+    public static function fromSourceToDestination(string $source, string $destination, ErrorContext $error): self
+    {
+        return new self(
+            sprintf("Unable to copy file from `%s` to `%s`. %s", $source, $destination, $error->getMessage())
+        );
+    }
+}
diff --git a/src/Tempest/Filesystem/src/Exceptions/UnableToCreateDirectory.php b/src/Tempest/Filesystem/src/Exceptions/UnableToCreateDirectory.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Filesystem\Exceptions;
+
+use RuntimeException;
+use Tempest\Filesystem\ErrorContext;
+
+final class UnableToCreateDirectory extends RuntimeException
+{
+    public static function atPath(string $path, ErrorContext $error): self
+    {
+        $message = sprintf('Unable to create directory at path [%s]. %s', $path, $error->getMessage());
+
+        return new self($message);
+    }
+}
diff --git a/src/Tempest/Filesystem/src/Exceptions/UnableToDeleteDirectory.php b/src/Tempest/Filesystem/src/Exceptions/UnableToDeleteDirectory.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Filesystem\Exceptions;
+
+use RuntimeException;
+use Tempest\Filesystem\ErrorContext;
+
+final class UnableToDeleteDirectory extends RuntimeException
+{
+    public static function atPath(string $path, ErrorContext $error): self
+    {
+        return new self(
+            sprintf('Unable to delete directory at path: %s. %s', $path, $error->getMessage()),
+        );
+    }
+}
diff --git a/src/Tempest/Filesystem/src/Exceptions/UnableToDeleteFile.php b/src/Tempest/Filesystem/src/Exceptions/UnableToDeleteFile.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Filesystem\Exceptions;
+
+use RuntimeException;
+
+final class UnableToDeleteFile extends RuntimeException
+{
+    public static function atPath(string $path): self
+    {
+        return new self("Unable to delete file '{$path}'.");
+    }
+}
diff --git a/src/Tempest/Filesystem/src/Exceptions/UnableToReadFile.php b/src/Tempest/Filesystem/src/Exceptions/UnableToReadFile.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Filesystem\Exceptions;
+
+use RuntimeException;
+use Tempest\Filesystem\ErrorContext;
+
+final class UnableToReadFile extends RuntimeException
+{
+    public static function atPath(string $path, ErrorContext $error): self
+    {
+        return new self(
+            sprintf('Unable to read file at path `%s`. %s', $path, $error->getMessage()),
+        );
+    }
+}
diff --git a/src/Tempest/Filesystem/src/Exceptions/UnableToWriteFile.php b/src/Tempest/Filesystem/src/Exceptions/UnableToWriteFile.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Filesystem\Exceptions;
+
+use RuntimeException;
+use Tempest\Filesystem\ErrorContext;
+
+final class UnableToWriteFile extends RuntimeException
+{
+    public static function atPath(string $path, ErrorContext $error): self
+    {
+        return new self(
+            sprintf('Unable to write to file at path `%s`. %s', $path, $error->getMessage())
+        );
+    }
+}
diff --git a/src/Tempest/Filesystem/src/Filesystem.php b/src/Tempest/Filesystem/src/Filesystem.php
@@ -0,0 +1,91 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Filesystem;
+
+use Tempest\Filesystem\Exceptions\FileDoesNotExist;
+use Tempest\Filesystem\Exceptions\UnableToCreateDirectory;
+use Tempest\Filesystem\Exceptions\UnableToDeleteDirectory;
+use Tempest\Filesystem\Exceptions\UnableToReadFile;
+use Tempest\Filesystem\Exceptions\UnableToWriteFile;
+
+interface Filesystem
+{
+    /**
+     * Reads the file at the specified path.
+     *
+     * @throws FileDoesNotExist if the file is not found.
+     * @throws UnableToReadFile if there is an issue reading the file.
+     */
+    public function read(string $filePath): string;
+
+    /**
+     * Writes to the file at the specified path.
+     *
+     * @throws UnableToWriteFile if there is an issue writing the file.
+     */
+    public function write(string $filePath, string $content): void;
+
+    /**
+     * Append content to the file at the specified path.
+     *
+     * @throws UnableToWriteFile if there is an issue appending to the file.
+     */
+    public function append(string $filePath, string $content): void;
+
+    /**
+     * Determines if the specified path is a file.
+     * Returns `false` if the path is a directory.
+     */
+    public function isFile(string $path): bool;
+
+    /**
+     * Creates a directory at the specified path.
+     *
+     * @throws UnableToCreateDirectory if there is an issue creating the directory.
+     */
+    public function createDirectory(string $directoryPath, int $permissions = Permission::FULL->value, bool $recursive = true): void;
+
+    /**
+     * Checks if the specified directory path exists and creates it if not.
+     *
+     * @throws UnableToCreateDirectory if the directory does not exist and there is an issue creating it.
+     */
+    public function ensureDirectoryExists(string $directoryPath, int $permissions = Permission::FULL->value): void;
+
+    /**
+     * Deletes a directory at the specified path.
+     *
+     * @throws UnableToDeleteDirectory if there is an issue deleting the directory.
+     */
+    public function deleteDirectory(string $directoryPath): void;
+
+    /**
+     * Determines if the specified path is a directory.
+     * Returns `false` if the path is a file.
+     */
+    public function isDirectory(string $path): bool;
+
+    /**
+     * Deletes the resource at the specified path,
+     * regardless of if it is a file or a directory.
+     */
+    public function delete(string $path): void;
+
+    /**
+     * Determines if the specified path exists,
+     * regardless of if it is a file or a directory.
+     */
+    public function exists(string $path): bool;
+
+    /**
+     * Copy the specified source file or directory to the destination path.
+     */
+    public function copy(string $sourcePath, string $destinationPath): void;
+
+    /**
+     * Move the specified source file or directory to the destination path.
+     */
+    public function move(string $sourcePath, string $destinationPath): void;
+}
diff --git a/src/Tempest/Filesystem/src/LocalFilesystem.php b/src/Tempest/Filesystem/src/LocalFilesystem.php
diff --git a/src/Tempest/Filesystem/src/Permission.php b/src/Tempest/Filesystem/src/Permission.php
diff --git a/src/Tempest/Filesystem/tests/LocalFilesystemTest.php b/src/Tempest/Filesystem/tests/LocalFilesystemTest.php
diff --git a/src/Tempest/Filesystem/tests/PermissionTest.php b/src/Tempest/Filesystem/tests/PermissionTest.php
