Add backup name resolver

Author: NeoIsRecursive

config/backup.php

@@ -48,6 +48,13 @@
         // 'time' => '03:00',
     ],
 
+    /**
+     * The backup name resolver
+     *
+     * the resolver handles generating and parsing backup names
+     */
+    'name_resolver' => \Itiden\Backup\GenericBackupNameResolver::class,
+
     /**
      * The backup repository
      *

src/Contracts/BackupNameResolver.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Itiden\Backup\Contracts;
+
+use Carbon\CarbonImmutable;
+use Itiden\Backup\DataTransferObjects\ResolvedBackupData;
+
+interface BackupNameResolver
+{
+    /**
+     * Generate a filename for a backup - should include an identifier and a timestamp
+     * the .zip extension will be appended automatically
+     */
+    public function generateFilename(CarbonImmutable $createdAt, string $id): string;
+
+    /**
+     * Parse a filename and return the resolved data
+     */
+    public function parseFilename(string $path): ResolvedBackupData;
+}

src/DataTransferObjects/BackupDto.php

@@ -7,6 +7,7 @@
 use Carbon\CarbonImmutable;
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Storage;
+use Itiden\Backup\Contracts\BackupNameResolver;
 use Itiden\Backup\Models\Metadata;
 use Statamic\Support\Str as StatamicStr;
 
@@ -18,7 +19,8 @@ public function __construct(
         public CarbonImmutable $created_at,
         public string $size,
         public string $path,
-    ) {}
+    ) {
+    }
 
     public function getMetadata(): Metadata
     {
@@ -30,14 +32,14 @@ public function getMetadata(): Metadata
      */
     public static function fromFile(string $path): static
     {
-        [$createtAt, $id, $name] = static::extractValuesFromPath($path);
+        $values = app(BackupNameResolver::class)->parseFilename($path);
 
         $bytes = Storage::disk(config('backup.destination.disk'))->size($path);
 
         return new static(
-            id: $id,
-            name: $name,
-            created_at: $createtAt,
+            id: $values->id,
+            name: $values->name,
+            created_at: $values->createdAt,
             size: StatamicStr::fileSizeForHumans($bytes, 2),
             path: $path,
         );
@@ -48,33 +50,16 @@ public static function fromFile(string $path): static
      */
     public static function fromAbsolutePath(string $path): static
     {
-        [$createdAt, $id, $name] = static::extractValuesFromPath($path);
+        $values = app(BackupNameResolver::class)->parseFilename($path);
 
         $bytes = File::size($path);
 
         return new static(
-            id: $id,
-            name: $name,
-            created_at: $createdAt,
+            id: $values->id,
+            name: $values->name,
+            created_at: $values->createdAt,
             size: StatamicStr::fileSizeForHumans($bytes, 2),
             path: $path,
         );
     }
-
-    private static function extractValuesFromPath(string $path): array
-    {
-        $timestamp = CarbonImmutable::createFromTimestamp(str(basename($path))
-            ->beforeLast('-')
-            ->afterLast('-')
-            ->toString());
-
-        $id = str(basename($path))
-            ->afterLast('-')
-            ->before('.zip')
-            ->toString();
-
-        $name = File::name($path);
-
-        return [$timestamp, $id, $name];
-    }
 }

src/DataTransferObjects/ResolvedBackupData.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Itiden\Backup\DataTransferObjects;
+
+use Carbon\CarbonImmutable;
+
+final readonly class ResolvedBackupData
+{
+    public function __construct(
+        public CarbonImmutable $createdAt,
+        public string $id,
+        public string $name,
+    ) {
+    }
+}

src/GenericBackupNameResolver.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Itiden\Backup;
+
+use Carbon\CarbonImmutable;
+use Itiden\Backup\Contracts\BackupNameResolver;
+use Itiden\Backup\DataTransferObjects\ResolvedBackupData;
+
+final readonly class GenericBackupNameResolver implements BackupNameResolver
+{
+    public function generateFilename(CarbonImmutable $createdAt, string $id): string
+    {
+        return implode('', [
+            str(config('app.name'))->slug(),
+            '-',
+            $createdAt->timestamp,
+            '-',
+            $id,
+        ]);
+    }
+
+    public function parseFilename(string $path): ResolvedBackupData
+    {
+        /** @var string */
+        $filename = pathinfo($path, PATHINFO_FILENAME);
+
+        $createdAt = CarbonImmutable::createFromTimestamp((string) str($filename)
+            ->beforeLast('-')
+            ->afterLast('-'));
+
+        $id = (string) str($filename)
+            ->afterLast('-')
+            ->before('.zip');
+
+        $name = (string) str($filename)
+            ->remove('-' . $createdAt->timestamp)
+            ->before('.zip');
+
+        return new ResolvedBackupData(createdAt: $createdAt, id: $id, name: $name);
+    }
+}

src/Repositories/FileBackupRepository.php

@@ -4,13 +4,14 @@
 
 namespace Itiden\Backup\Repositories;
 
-use Carbon\Carbon;
+use Carbon\CarbonImmutable;
 use Illuminate\Contracts\Filesystem\Filesystem;
 use Illuminate\Filesystem\FilesystemAdapter;
 use Illuminate\Http\File as StreamableFile;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Storage;
 use Illuminate\Support\Str;
+use Itiden\Backup\Contracts\BackupNameResolver;
 use Itiden\Backup\Contracts\Repositories\BackupRepository;
 use Itiden\Backup\DataTransferObjects\BackupDto;
 use Itiden\Backup\Events\BackupDeleted;
@@ -22,42 +23,30 @@ final class FileBackupRepository implements BackupRepository
     /** @var FilesystemAdapter */
     private Filesystem $filesystem;
 
-    public function __construct()
-    {
+    public function __construct(
+        private BackupNameResolver $nameResolver,
+    ) {
         $this->path = config('backup.destination.path');
         $this->filesystem = Storage::disk(config('backup.destination.disk'));
     }
 
-    private function makeFilename(string $timestamp, string $id): string
-    {
-        return implode('', [
-            Str::slug(config('app.name')),
-            '-',
-            $timestamp,
-            '-',
-            $id,
-            '.zip',
-        ]);
-    }
-
     public function all(): Collection
     {
-        return collect($this->filesystem->files($this->path))
+        return collect($this->filesystem->allFiles($this->path))
             ->map(BackupDto::fromFile(...))
-            ->sortByDesc('created_at');
+            ->sortByDesc(fn(BackupDto $backup) => $backup->created_at);
     }
 
     public function add(string $path): BackupDto
     {
         $this->filesystem->makeDirectory(path: $this->path);
 
-        $timestamp = (string) Carbon::now()->unix();
         $id = (string) Str::ulid();
 
         $this->filesystem->putFileAs(
             path: $this->path,
             file: new StreamableFile($path),
-            name: $this->makeFilename($timestamp, $id),
+            name: (string) str($this->nameResolver->generateFilename(CarbonImmutable::now(), $id))->finish('.zip'),
         );
 
         return $this->find($id);

src/ServiceProvider.php

@@ -8,6 +8,7 @@
 use Itiden\Backup\Console\Commands\BackupCommand;
 use Itiden\Backup\Console\Commands\ClearFilesCommand;
 use Itiden\Backup\Console\Commands\RestoreCommand;
+use Itiden\Backup\Contracts\BackupNameResolver;
 use Itiden\Backup\Contracts\Repositories\BackupRepository;
 use Itiden\Backup\Events\BackupDeleted;
 use Statamic\Auth\Permissions as PermissionContract;
@@ -69,6 +70,7 @@ public function register(): void
         $this->mergeConfigFrom(__DIR__ . '/../config/backup.php', 'backup');
 
         $this->app->bind(BackupRepository::class, config('backup.repository'));
+        $this->app->bind(BackupNameResolver::class, config('backup.name_resolver'));
     }
 
     private function configureCommands(): void

tests/Unit/BackuperTest.php

@@ -5,6 +5,7 @@
 use Carbon\Carbon;
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Storage;
+use Itiden\Backup\Contracts\BackupNameResolver;
 use Itiden\Backup\Contracts\Repositories\BackupRepository;
 use Itiden\Backup\DataTransferObjects\BackupDto;
 use Itiden\Backup\Facades\Backuper;
@@ -18,14 +19,22 @@
 
 describe('backuper', function (): void {
     it('can backup', function (): void {
-        $this->withoutExceptionHandling();
+        Carbon::setTestNow(Carbon::now());
+
         $backup = Backuper::backup();
 
+        $filename = app(BackupNameResolver::class)->generateFilename(Carbon::now()->toImmutable(), $backup->id);
+
         expect($backup)->toBeInstanceOf(BackupDto::class);
 
-        expect(Storage::disk(config('backup.destination.disk'))->exists(
-            config('backup.destination.path') . "/{$backup->name}.zip",
-        ))->toBeTrue();
+        expect(Storage::disk(config('backup.destination.disk'))->exists(str(
+            config('backup.destination.path') . "/{$filename}",
+        )->finish('.zip')))->toBeTrue();
+
+        expect(pathinfo(
+            Storage::disk(config('backup.destination.disk'))->path($backup->path),
+            PATHINFO_EXTENSION,
+        ))->toBe('zip');
     });
 
     it('backups correct files', function (): void {