chore(zipper)!: remove open method in favor of read and write methods

Author: NeoIsRecursive

src/Backuper.php

@@ -37,7 +37,7 @@ public function backup(): BackupDto
 
             $temp_zip_path = config('backup.temp_path') . '/temp.zip';
 
-            $zipper = Zipper::open($temp_zip_path);
+            $zipper = Zipper::write($temp_zip_path);
 
             Pipeline::via('backup')
                 ->send($zipper)

src/Restorer.php

@@ -142,7 +142,7 @@ private function unzip(string $path): string
     {
         $target = config('backup.temp_path') . DIRECTORY_SEPARATOR . 'unzipping';
 
-        Zipper::open($path, true)
+        Zipper::read($path)
             ->extractTo($target, config('backup.password'))
             ->close();
 

src/StateManager.php

@@ -24,7 +24,8 @@
     public function __construct(
         private Repository $cache,
         private Filesystem $filesystem,
-    ) {}
+    ) {
+    }
 
     public function getState(): State
     {
@@ -38,7 +39,7 @@ public function getState(): State
 
         if (
             !in_array($state, [State::BackupInProgress, State::RestoreInProgress]) &&
-            $this->cache->has(self::JOB_QUEUED_KEY)
+                $this->cache->has(self::JOB_QUEUED_KEY)
         ) {
             $state = State::Queued;
         }

src/Support/Zipper.php

@@ -9,6 +9,7 @@
 use Symfony\Component\Finder\SplFileInfo;
 use ZipArchive;
 
+// @mago-ignore maintainability/too-many-methods
 final class Zipper
 {
     private ZipArchive $zip;
@@ -26,11 +27,14 @@ public function __construct(string $path, int $flags = ZipArchive::CREATE | ZipA
     /**
      * Create a new instance of the Zipper.
      */
-    public static function open(string $path, bool $readOnly = false): self
+    public static function write(string $path): self
     {
-        $flags = $readOnly ? ZipArchive::RDONLY : (ZipArchive::CREATE | ZipArchive::OVERWRITE);
+        return new static($path, ZipArchive::CREATE | ZipArchive::OVERWRITE);
+    }
 
-        return new static($path, $flags);
+    public static function read(string $path): self
+    {
+        return new static($path, ZipArchive::RDONLY);
     }
 
     /**
@@ -115,12 +119,7 @@ public function getArchive(): ZipArchive
      */
     public function addMeta(string $key, array|string $meta): self
     {
-        if (is_array($meta)) {
-            $current = $this->meta[$key] ?? [];
-            $this->meta[$key] = array_merge($current, $meta);
-        } else {
-            $this->meta[$key] = $meta;
-        }
+        $this->meta[$key] = is_array($meta) ? array_merge($this->meta[$key] ?? [], $meta) : $meta;
 
         $this->zip->setArchiveComment(comment: json_encode($this->meta));
 

tests/Feature/RestoreFromPathTest.php

@@ -64,7 +64,7 @@
         $emptyArchive = storage_path(config('backup.temp_path') . '/empty.zip');
 
         // The zip file cant be empty, but when extracting it can if the password is wrong.
-        Zipper::open($emptyArchive)
+        Zipper::write($emptyArchive)
             ->addFromString('empty.txt', 'empty')
             ->encrypt('not-the-password-we-decrypt-with')
             ->close();

tests/Unit/BackuperTest.php

@@ -27,7 +27,7 @@
         $backup = Backuper::backup();
 
         $unzipped = config('backup.temp_path') . '/unzipped';
-        Zipper::open(Storage::disk(config('backup.destination.disk'))->path($backup->path), true)->extractTo(
+        Zipper::read(Storage::disk(config('backup.destination.disk'))->path($backup->path))->extractTo(
             $unzipped,
             config('backup.password'),
         );

tests/Unit/PipeTest.php

@@ -15,7 +15,7 @@
     test('backup pipes can pass zipper instance', function (string $pipe): void {
         $temp_zip = config('backup.temp_path') . '/backup.zip';
 
-        $zipper = Zipper::open($temp_zip);
+        $zipper = Zipper::write($temp_zip);
         expect(app()
             ->make($pipe)
             ->backup($zipper, fn(Zipper $z): Zipper => $z))->toBeInstanceOf(Zipper::class);
@@ -58,7 +58,7 @@
 
         File::deleteDirectory(Stache::store('users')->directory());
 
-        $zipper = Zipper::open(config('backup.temp_path') . '/backup.zip');
+        $zipper = Zipper::write(config('backup.temp_path') . '/backup.zip');
 
         $pipe->backup(zip: $zipper, next: $callable);
 
@@ -79,7 +79,7 @@
         File::copyDirectory(config('backup.content_path'), config('backup.content_path') . '_backup');
         File::deleteDirectory(config('backup.content_path'));
 
-        $zipper = Zipper::open(config('backup.temp_path') . '/backup.zip');
+        $zipper = Zipper::write(config('backup.temp_path') . '/backup.zip');
 
         $pipe->backup(zip: $zipper, next: $callable);
 

tests/Unit/ZipperTest.php

@@ -21,7 +21,7 @@
     it('can zip file from string', function (): void {
         $target = storage_path('test.zip');
 
-        Zipper::open($target)
+        Zipper::write($target)
             ->addFromString('test.txt', 'test')
             ->close();
 
@@ -33,7 +33,7 @@
     it('can zip file from path', function (): void {
         $target = storage_path('test.zip');
 
-        Zipper::open($target)
+        Zipper::write($target)
             ->addFile(__FILE__)
             ->close();
 
@@ -45,7 +45,7 @@
     it('can zip directory', function (): void {
         $path = storage_path('test.zip');
 
-        Zipper::open($path)->addDirectory(config('backup.content_path'), 'example');
+        Zipper::write($path)->addDirectory(config('backup.content_path'), 'example');
 
         expect($path)->toBeString();
         expect(file_exists($path))->toBeTrue();
@@ -54,13 +54,13 @@
     it('can unzip file', function (): void {
         $target = storage_path('test.zip');
 
-        Zipper::open($target)
+        Zipper::write($target)
             ->addFromString('test.txt', 'test')
             ->close();
 
         $unzip = storage_path('unzip');
 
-        Zipper::open($target, true)
+        Zipper::read($target)
             ->extractTo($unzip)
             ->close();
 
@@ -70,10 +70,12 @@
     it('can unzip file to directory', function (): void {
         $target = storage_path('test.zip');
 
-        Zipper::open($target)->addFromString('test.txt', 'test');
+        Zipper::write($target)
+            ->addFromString('test.txt', 'test')
+            ->close();
 
         $unzip = storage_path('test');
-        Zipper::open($target, true)
+        Zipper::read($target)
             ->extractTo($unzip)
             ->close();
 
@@ -88,10 +90,12 @@
 
         $target = storage_path('test.zip');
 
-        Zipper::open($target)->addDirectory(config('backup.content_path'), 'example');
+        Zipper::write($target)
+            ->addDirectory(config('backup.content_path'), 'example')
+            ->close();
 
         $unzip = storage_path('unzipdir');
-        Zipper::open($target, true)
+        Zipper::read($target)
             ->extractTo($unzip)
             ->close();
 
@@ -108,7 +112,7 @@
         // @mago-ignore security/no-literal-password
         $password = 'password';
 
-        Zipper::open($target)
+        Zipper::write($target)
             ->addFromString('test.txt', 'test')
             ->encrypt($password)
             ->close();
@@ -118,7 +122,7 @@
 
         $unzip = storage_path('unzip');
 
-        Zipper::open($target, true)
+        Zipper::read($target)
             ->extractTo($unzip, $password)
             ->close();
 
@@ -129,12 +133,12 @@
     it('can write meta to zip', function (): void {
         $target = storage_path('test.zip');
 
-        Zipper::open($target)
+        Zipper::write($target)
             ->addFromString('test.txt', 'test')
             ->addMeta('test', 'test')
             ->close();
 
-        $zip = Zipper::open($target, true);
+        $zip = Zipper::read($target);
 
         expect($zip->getMeta())->toHaveKey('test');
         expect($zip->getMeta())