refactor(core): consistently use json and filesystem utils (#1330)

Co-authored-by: Brent Roose <[email protected]>

Author: innocenzi

packages/command-bus/src/AsyncCommandRepositories/FileCommandRepository.php

@@ -6,6 +6,7 @@
 
 use Tempest\CommandBus\CommandRepository;
 use Tempest\CommandBus\Exceptions\PendingCommandCouldNotBeResolved;
+use Tempest\Support\Filesystem;
 
 use function Tempest\Support\arr;
 
@@ -15,32 +16,30 @@ public function store(string $uuid, object $command): void
     {
         $payload = serialize($command);
 
-        file_put_contents(__DIR__ . "/../stored-commands/{$uuid}.pending.txt", $payload);
+        Filesystem\write_file(__DIR__ . "/../stored-commands/{$uuid}.pending.txt", $payload);
     }
 
     public function findPendingCommand(string $uuid): object
     {
         $path = __DIR__ . "/../stored-commands/{$uuid}.pending.txt";
 
-        if (! file_exists($path)) {
+        if (! Filesystem\is_file($path)) {
             throw new PendingCommandCouldNotBeResolved($uuid);
         }
 
-        $payload = file_get_contents($path);
+        $payload = Filesystem\read_file($path);
 
         return unserialize($payload);
     }
 
     public function markAsDone(string $uuid): void
     {
-        $path = __DIR__ . "/../stored-commands/{$uuid}.pending.txt";
-
-        unlink($path);
+        Filesystem\delete_file(__DIR__ . "/../stored-commands/{$uuid}.pending.txt");
     }
 
     public function markAsFailed(string $uuid): void
     {
-        if (! is_file(__DIR__ . "/../stored-commands/{$uuid}.pending.txt")) {
+        if (! Filesystem\is_file(__DIR__ . "/../stored-commands/{$uuid}.pending.txt")) {
             return;
         }
 
@@ -55,7 +54,7 @@ public function getPendingCommands(): array
         return arr(glob(__DIR__ . '/../stored-commands/*.pending.txt'))
             ->mapWithKeys(function (string $path) {
                 $uuid = str_replace('.pending.txt', '', pathinfo($path, PATHINFO_BASENAME));
-                $payload = file_get_contents($path);
+                $payload = Filesystem\read_file($path);
 
                 yield $uuid => unserialize($payload);
             })

packages/console/src/Components/Concerns/OpensInEditor.php

@@ -7,6 +7,7 @@
 use Tempest\Console\CanOpenInEditor;
 use Tempest\Console\Components\ComponentState;
 use Tempest\Console\InteractiveConsoleComponent;
+use Tempest\Support\Filesystem;
 
 use function Tempest\env;
 
@@ -39,14 +40,14 @@ public function openInEditor(?string $text): string
         $editor = $this->getEditorCommand();
         $tempFile = tempnam(sys_get_temp_dir(), '.TEMPEST_INPUT');
 
-        file_put_contents($tempFile, $text ?? '');
+        Filesystem\write_file($tempFile, $text ?? '');
 
         if (passthru(escapeshellcmd("{$editor} " . escapeshellarg($tempFile))) === false) {
             // TODO: failed. handle that
             return $text;
         }
 
-        $updatedText = file_get_contents($tempFile);
+        $updatedText = Filesystem\read_file($tempFile);
         unlink($tempFile);
 
         $this->setState($previousState);

packages/console/src/Exceptions/ConsoleExceptionHandler.php

@@ -16,6 +16,7 @@
 use Tempest\Core\Kernel;
 use Tempest\Highlight\Escape;
 use Tempest\Highlight\Highlighter;
+use Tempest\Support\Filesystem;
 use Throwable;
 
 use function Tempest\Support\str;
@@ -76,7 +77,7 @@ public function handle(Throwable $throwable): void
     private function getSnippet(string $file, int $lineNumber): string
     {
         $highlighter = $this->highlighter->withGutter();
-        $code = Escape::terminal($highlighter->parse(file_get_contents($file), language: 'php'));
+        $code = Escape::terminal($highlighter->parse(Filesystem\read_file($file), language: 'php'));
         $lines = explode(PHP_EOL, $code);
 
         $lines[$lineNumber - 1] = str($lines[$lineNumber - 1])

packages/console/src/Output/LogOutputBuffer.php

@@ -5,6 +5,7 @@
 namespace Tempest\Console\Output;
 
 use Tempest\Console\OutputBuffer;
+use Tempest\Support\Filesystem;
 
 final readonly class LogOutputBuffer implements OutputBuffer
 {
@@ -14,14 +15,14 @@ public function __construct(
 
     public function clear(): self
     {
-        file_put_contents($this->path, '');
+        Filesystem\write_file($this->path, '');
 
         return $this;
     }
 
     public function read(): string
     {
-        return file_get_contents($this->path);
+        return Filesystem\read_file($this->path);
     }
 
     public function write(string $contents): void

packages/console/src/Scheduler/GenericScheduler.php

@@ -8,6 +8,7 @@
 use Tempest\Console\Input\ConsoleArgumentBag;
 use Tempest\Console\Scheduler;
 use Tempest\Core\ShellExecutor;
+use Tempest\Support\Filesystem;
 
 use function Tempest\event;
 use function Tempest\internal_storage_path;
@@ -84,11 +85,11 @@ private function getInvocationsToRun(DateTime $date): array
      */
     private function getPreviousRuns(): array
     {
-        if (! file_exists(self::getCachePath())) {
+        if (! Filesystem\is_file(self::getCachePath())) {
             return [];
         }
 
-        return unserialize(file_get_contents(self::getCachePath()), ['allowed_classes' => false]);
+        return unserialize(Filesystem\read_file(self::getCachePath()), ['allowed_classes' => false]);
     }
 
     /** @param ScheduledInvocation[] $ranInvocations */
@@ -106,6 +107,6 @@ private function markInvocationsAsRun(array $ranInvocations, DateTime $ranAt): v
             mkdir(directory: $directory, recursive: true);
         }
 
-        file_put_contents(self::getCachePath(), serialize($lastRuns));
+        Filesystem\write_file(self::getCachePath(), serialize($lastRuns));
     }
 }

packages/core/src/Composer.php

@@ -4,6 +4,8 @@
 
 namespace Tempest\Core;
 
+use Tempest\Support\Filesystem;
+use Tempest\Support\Json;
 use Tempest\Support\Namespace\Psr4Namespace;
 
 use function Tempest\Support\arr;
@@ -94,7 +96,7 @@ public function addNamespace(string $namespace, string $path): self
 
     public function save(): self
     {
-        file_put_contents($this->composerPath, json_encode($this->composer, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
+        Filesystem\write_json($this->composerPath, $this->composer, pretty: true);
 
         return $this;
     }
@@ -108,10 +110,10 @@ public function executeUpdate(): self
 
     private function loadComposerFile(string $path): array
     {
-        if (! file_exists($path)) {
+        if (! Filesystem\is_file($path)) {
             throw new ComposerJsonCouldNotBeLocated('Could not locate composer.json.');
         }
 
-        return json_decode(file_get_contents($path), associative: true);
+        return Filesystem\read_json($path);
     }
 }

packages/core/src/Kernel/LoadDiscoveryLocations.php

@@ -8,6 +8,7 @@
 use Tempest\Core\Kernel;
 use Tempest\Discovery\DiscoveryLocation;
 use Tempest\Discovery\DiscoveryLocationCouldNotBeLoaded;
+use Tempest\Support\Filesystem;
 
 use function Tempest\Support\Path\normalize;
 
@@ -115,10 +116,10 @@ private function discoverVendorPackages(): array
 
     private function loadJsonFile(string $path): array
     {
-        if (! file_exists($path)) {
+        if (! Filesystem\is_file($path)) {
             throw new DiscoveryLocationCouldNotBeLoaded($path);
         }
 
-        return json_decode(file_get_contents($path), true);
+        return Filesystem\read_json($path);
     }
 }

packages/core/src/PublishesFiles.php

@@ -17,6 +17,8 @@
 use Tempest\Generation\Exceptions\FileGenerationWasAborted;
 use Tempest\Generation\StubFileGenerator;
 use Tempest\Reflection\FunctionReflector;
+use Tempest\Support\Filesystem;
+use Tempest\Support\Json;
 use Tempest\Support\Str\ImmutableString;
 use Tempest\Validation\Rules\EndsWith;
 use Tempest\Validation\Rules\NotEmpty;
@@ -32,9 +34,6 @@
 use function Tempest\Support\str;
 use function Tempest\Support\Str\class_basename;
 
-use const JSON_PRETTY_PRINT;
-use const JSON_UNESCAPED_SLASHES;
-
 /**
  * Provides a bunch of methods to publish and generate files and work with common user input.
  */
@@ -129,13 +128,13 @@ public function publish(string $source, string $destination, ?Closure $callback
     public function publishImports(): void
     {
         foreach ($this->publishedFiles as $file) {
-            $contents = str(file_get_contents($file));
+            $contents = str(Filesystem\read_file($file));
 
             foreach ($this->publishedClasses as $old => $new) {
                 $contents = $contents->replace($old, $new);
             }
 
-            file_put_contents($file, $contents);
+            Filesystem\write_file($file, $contents);
         }
     }
 
@@ -188,7 +187,7 @@ public function promptTargetPath(string $suggestedPath, ?array $rules = null): s
      */
     public function askForOverride(string $targetPath): bool
     {
-        if (! file_exists($targetPath)) {
+        if (! Filesystem\is_file($targetPath)) {
             return true;
         }
 
@@ -206,15 +205,15 @@ public function askForOverride(string $targetPath): bool
      */
     public function update(string $path, Closure $callback, bool $ignoreNonExisting = false): void
     {
-        if (! is_file($path)) {
+        if (! Filesystem\is_file($path)) {
             if ($ignoreNonExisting) {
                 return;
             }
 
             throw new Exception("The file at path [{$path}] does not exist.");
         }
 
-        $contents = file_get_contents($path);
+        $contents = Filesystem\read_file($path);
 
         $reflector = new FunctionReflector($callback);
         $type = $reflector->getParameters()->current()->getType();
@@ -225,7 +224,7 @@ public function update(string $path, Closure $callback, bool $ignoreNonExisting
             default => throw new Exception('The callback must accept a string or ImmutableString.'),
         };
 
-        file_put_contents($path, $contents);
+        Filesystem\write_file($path, $contents);
     }
 
     /**
@@ -242,7 +241,7 @@ public function updateJson(string $path, Closure $callback, bool $ignoreNonExist
             function (string $content) use ($callback) {
                 $indent = $this->detectIndent($content);
 
-                $json = json_decode($content, associative: true);
+                $json = Json\decode($content);
                 $json = $callback($json);
 
                 // PHP will output empty arrays for empty dependencies,
@@ -256,7 +255,7 @@ function (string $content) use ($callback) {
                 $content = preg_replace_callback(
                     '/^ +/m',
                     fn ($m) => str_repeat($indent, strlen($m[0]) / 4),
-                    json_encode($json, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES),
+                    Json\encode($json, pretty: true),
                 );
 
                 return "{$content}\n";

packages/database/src/Exceptions/QueryWasInvalid.php

@@ -7,6 +7,7 @@
 use Exception;
 use PDOException;
 use Tempest\Database\Query;
+use Tempest\Support\Json;
 
 final class QueryWasInvalid extends Exception
 {
@@ -16,7 +17,7 @@ public function __construct(Query $query, array $bindings, PDOException $previou
 
         $message .= PHP_EOL . PHP_EOL . $query->toSql() . PHP_EOL;
 
-        $message .= PHP_EOL . 'bindings: ' . json_encode($bindings, JSON_PRETTY_PRINT);
+        $message .= PHP_EOL . 'bindings: ' . Json\encode($bindings, pretty: true);
 
         parent::__construct(
             message: $message,

packages/database/src/MigrationDiscovery.php

@@ -11,6 +11,7 @@
 use Tempest\Discovery\DiscoveryLocation;
 use Tempest\Discovery\IsDiscovery;
 use Tempest\Reflection\ClassReflector;
+use Tempest\Support\Filesystem;
 
 final class MigrationDiscovery implements Discovery, DiscoversPath
 {
@@ -45,7 +46,7 @@ public function discoverPath(DiscoveryLocation $location, string $path): void
 
         $fileName = pathinfo($path, PATHINFO_FILENAME);
 
-        $contents = explode(';', file_get_contents($path));
+        $contents = explode(';', Filesystem\read_file($path));
 
         foreach ($contents as $i => $content) {
             if (! $content) {