pref: Add backup collection

resources/views/components/_backup.blade.php

@@ -21,7 +21,7 @@
                     <template v-for="(item, index) in items">
                         <tr :key="item.real_name" :bind="item">
                             <th scope="row" class="font-weight-bold ">@{{ item.name }}</th>
-                            <td>@{{ item.created_at_formatted }}</td>
+                            <td>@{{ item.created_at }}</td>
                             <td>
                                 <div class="btn-group" role="group">
                                     <button class="btn btn-info" data-toggle="collapse" aria-expanded="false"
@@ -40,7 +40,7 @@ class="fas fa-download"></span></a>
                                 <div class="collapse" :id="'collapse_'+item.real_name" data-parent="#env-editor-table-accordion">
                                     <div class="table-responsive table-sm px-3 pb-3">
                                         <table class="w-100 bg-light">
-                                            <tr v-for="(dt, index) in item.parsed_data">
+                                            <tr v-for="(dt, index) in item.entries">
                                                 <td class="pl-3"><code>@{{ dt.key||'&nbsp;' }}</code></td>
                                                 <td><code>@{{ dt.value }}</code></td>
                                             </tr>

src/Controllers/EnvController.php

@@ -73,7 +73,7 @@ public function deleteKey(Request $request): JsonResponse
      */
     public function getBackupFiles(Request $request): View|JsonResponse
     {
-        $allBackUps = $this->envEditor->getAllBackUps();
+        $allBackUps = $this->envEditor->getAllBackUps()->toArray();
         if ($request->wantsJson()) {
             return $this->returnGenericResponse(true, ['items' => $allBackUps]);
         }

src/Dto/BackupObj.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace GeoSot\EnvEditor\Dto;
+
+use Carbon\Carbon;
+use Illuminate\Contracts\Support\Arrayable;
+use Illuminate\Support\Collection;
+
+/**
+ * @implements Arrayable<string, scalar>
+ */
+class BackupObj implements \JsonSerializable, Arrayable
+{
+    /**
+     * @param Collection<int, EntryObj> $entries
+     */
+    public function __construct(
+        public readonly string $name,
+        public readonly Carbon $createdAt,
+        public readonly Carbon $modifiedAt,
+        public readonly string $path,
+        public readonly string $rawContent,
+        public readonly Collection $entries,
+    ) {
+    }
+
+    /**
+     * @return array{real_name:string, name:string, created_at:string, modified_at:string, raw_content:string, path:string, entries:array<int,EntryObj>}
+     */
+    public function toArray(): array
+    {
+        return [
+            'real_name' => $this->name,
+            'name' => $this->name,
+            'created_at' => Carbon::createFromTimestamp($this->createdAt)->format(config('env-editor.timeFormat')),
+            'modified_at' => Carbon::createFromTimestamp($this->modifiedAt)->format(config('env-editor.timeFormat')),
+            'raw_content' => $this->rawContent,
+            'path' => $this->path,
+            'entries' => $this->entries->toArray(),
+        ];
+    }
+
+    /**
+     * @return array{real_name:string, name:string, created_at:string, modified_at:string, raw_content:string, path:string, entries:array<int,EntryObj>}
+     */
+    public function jsonSerialize(): array
+    {
+        return $this->toArray();
+    }
+}

src/Helpers/EntryObj.php → src/Dto/EntryObj.php

@@ -1,16 +1,25 @@
 <?php
 
-namespace GeoSot\EnvEditor\Helpers;
+namespace GeoSot\EnvEditor\Dto;
 
+use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Arr;
 
-class EntryObj implements \JsonSerializable
+/**
+ * @implements Arrayable<string, scalar>
+ */
+class EntryObj implements \JsonSerializable, Arrayable
 {
     /**
      * @param int|string|null $value
      */
-    public function __construct(public string $key, protected mixed $value, public int $group, public int $index, protected bool $isSeparator = false)
-    {
+    public function __construct(
+        public readonly string $key,
+        protected mixed $value,
+        public readonly int $group,
+        public readonly int $index,
+        protected bool $isSeparator = false
+    ) {
     }
 
     public static function parseEnvLine(string $line, int $group, int $index): self

src/EnvEditor.php

@@ -2,8 +2,9 @@
 
 namespace GeoSot\EnvEditor;
 
+use GeoSot\EnvEditor\Dto\BackupObj;
+use GeoSot\EnvEditor\Dto\EntryObj;
 use GeoSot\EnvEditor\Exceptions\EnvException;
-use GeoSot\EnvEditor\Helpers\EntryObj;
 use GeoSot\EnvEditor\Helpers\EnvFileContentManager;
 use GeoSot\EnvEditor\Helpers\EnvFilesManager;
 use GeoSot\EnvEditor\Helpers\EnvKeysManager;
@@ -94,9 +95,7 @@ public function deleteKey(string $key): bool
     /**
      * Get all Backup Files.
      *
-     * @return Collection<int, array{real_name:string, name:string, created_at:int, modified_at:int, created_at_formatted:string, modified_at_formatted:string, content:string, path:string,parsed_data:Collection<int, EntryObj>}>
-     *
-     * @throws EnvException
+     * @return Collection<int, BackupObj>
      */
     public function getAllBackUps(): Collection
     {

src/Helpers/EnvFileContentManager.php

@@ -2,6 +2,7 @@
 
 namespace GeoSot\EnvEditor\Helpers;
 
+use GeoSot\EnvEditor\Dto\EntryObj;
 use GeoSot\EnvEditor\EnvEditor;
 use GeoSot\EnvEditor\Exceptions\EnvException;
 use Illuminate\Filesystem\Filesystem;

src/Helpers/EnvFilesManager.php

@@ -3,12 +3,14 @@
 namespace GeoSot\EnvEditor\Helpers;
 
 use Carbon\Carbon;
+use GeoSot\EnvEditor\Dto\BackupObj;
 use GeoSot\EnvEditor\EnvEditor;
 use GeoSot\EnvEditor\Exceptions\EnvException;
 use GeoSot\EnvEditor\ServiceProvider;
 use Illuminate\Filesystem\Filesystem;
 use Illuminate\Http\UploadedFile;
 use Illuminate\Support\Collection;
+use Symfony\Component\Finder\SplFileInfo;
 use Symfony\Component\HttpFoundation\File\File;
 
 class EnvFilesManager
@@ -21,30 +23,22 @@ public function __construct(protected EnvEditor $envEditor, protected Filesystem
     /**
      * Get all Backup Files.
      *
-     * @return Collection<int, array{real_name:string, name:string, created_at:int, modified_at:int, created_at_formatted:string, modified_at_formatted:string, content:string, path:string,parsed_data:Collection<int, EntryObj>}>
+     * @return Collection<int, BackupObj>
      */
     public function getAllBackUps(): Collection
     {
         $files = $this->filesystem->files($this->getBackupsDir());
-        /** @var Collection<int, array{real_name:string, name:string, created_at:int, modified_at:int, created_at_formatted:string, modified_at_formatted:string, content:string, path:string,parsed_data:Collection<int, EntryObj>}> $collection */
-        $collection = collect([]);
-        foreach ($files as $file) {
-            $data = [
-                'real_name' => $file->getFilename(),
-                'name' => $file->getFilename(),
-                'created_at' => $file->getCTime(),
-                'modified_at' => $file->getMTime(),
-                'created_at_formatted' => Carbon::createFromTimestamp($file->getCTime())->format($this->envEditor->config('timeFormat')),
-                'modified_at_formatted' => Carbon::createFromTimestamp($file->getMTime())->format($this->envEditor->config('timeFormat')),
-                'content' => $file->getContents(),
-                'path' => $file->getPath(),
-                'parsed_data' => $this->envEditor->getFileContentManager()->getParsedFileContent($file->getFilename()),
-            ];
-
-            $collection->push($data);
-        }
 
-        return $collection->sortByDesc('created_at');
+        return (new Collection($files))
+            ->map(fn (SplFileInfo $file): BackupObj => new BackupObj(
+                $file->getFilename(),
+                Carbon::parse($file->getCTime()),
+                Carbon::parse($file->getMTime()),
+                $file->getPath(),
+                $file->getContents(),
+                $this->envEditor->getFileContentManager()->getParsedFileContent($file->getFilename()),
+            ))
+            ->sortByDesc('createdAt');
     }
 
     /**

src/Helpers/EnvKeysManager.php

@@ -2,6 +2,7 @@
 
 namespace GeoSot\EnvEditor\Helpers;
 
+use GeoSot\EnvEditor\Dto\EntryObj;
 use GeoSot\EnvEditor\EnvEditor;
 use GeoSot\EnvEditor\Exceptions\EnvException;
 use GeoSot\EnvEditor\ServiceProvider;

tests/Feature/UiTest.php

@@ -124,7 +124,7 @@ public function can_restore_backups(): void
         EnvEditor::backUpCurrent();
         EnvEditor::deleteKey('FOO');
         $this->assertNull(EnvEditor::getKey('FOO'));
-        $file = EnvEditor::getAllBackUps()->first()['name'];
+        $file = EnvEditor::getAllBackUps()->first()->name;
         $this->postJson($this->makeRoute('restoreBackup').'/'.$file);
         $this->assertSame('bar', EnvEditor::getKey('FOO'));
     }
@@ -136,7 +136,7 @@ public function can_destroy_backups(): void
         File::deleteDirectory($backupsDir);
         EnvEditor::backUpCurrent();
 
-        $file = EnvEditor::getAllBackUps()->first()['name'];
+        $file = EnvEditor::getAllBackUps()->first()->name;
         $this->deleteJson($this->makeRoute('destroyBackup').'/'.$file);
         $this->assertCount(0, EnvEditor::getAllBackUps());
     }

tests/Unit/Helpers/EntryObjTest.php

@@ -2,7 +2,7 @@
 
 namespace GeoSot\EnvEditor\Tests\Unit\Helpers;
 
-use GeoSot\EnvEditor\Helpers\EntryObj;
+use GeoSot\EnvEditor\Dto\EntryObj;
 use GeoSot\EnvEditor\Tests\TestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;

tests/Unit/Helpers/EnvFileContentManagerTest.php

@@ -2,9 +2,9 @@
 
 namespace GeoSot\EnvEditor\Tests\Unit\Helpers;
 
+use GeoSot\EnvEditor\Dto\EntryObj;
 use GeoSot\EnvEditor\EnvEditor;
 use GeoSot\EnvEditor\Exceptions\EnvException;
-use GeoSot\EnvEditor\Helpers\EntryObj;
 use GeoSot\EnvEditor\Helpers\EnvFileContentManager;
 use GeoSot\EnvEditor\Tests\TestCase;
 use Illuminate\Config\Repository;

tests/Unit/Helpers/FilesManagerTest.php

@@ -8,7 +8,6 @@
 use GeoSot\EnvEditor\Tests\TestCase;
 use Illuminate\Config\Repository;
 use Illuminate\Filesystem\Filesystem;
-use Illuminate\Support\Arr;
 use PHPUnit\Framework\Attributes\Group;
 use PHPUnit\Framework\Attributes\Test;
 
@@ -129,8 +128,9 @@ public function back_up_current_env_works_and_returns_bool(): void
         $this->assertTrue($result);
 
         $backUps = $manager->getAllBackUps();
+
         $this->assertEquals(1, $backUps->count());
-        $this->assertEquals(Arr::get($backUps->first(), 'content'), $content);
+        $this->assertEquals($backUps->first()->rawContent, $content);
 
         unlink($file);
     }