chore: use mago for linting and formating (#54)

BREAKING CHANGE: the `BackupPipe` abstract now requires return types to be specified

Author: NeoIsRecursive

.github/workflows/build-docs.yml

@@ -3,7 +3,6 @@
 name: Deploy VitePress site to Pages
 
 on:
-  # TODO: Change to tag?
   push:
     tags:
       - "v*"

.github/workflows/run-lint.yml

@@ -1,12 +1,22 @@
 name: Lint
 on: push
 jobs:
-  pint:
+  mago:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - name: "laravel-pint"
-        uses: aglipanci/[email protected]
+      - name: "checkout"
+        uses: "actions/checkout@v4"
+
+      - name: "installing PHP"
+        uses: "shivammathur/setup-php@v2"
         with:
-          verboseMode: true
-          testMode: true
+          php-version: "8.3"
+
+      - name: "installing dependencies"
+        run: composer install --no-interaction --prefer-dist --optimize-autoloader
+
+      - name: "formatting"
+        run: php vendor/bin/mago fmt --dry-run
+
+      - name: "linting"
+        run: php vendor/bin/mago lint --reporting-format=github

.github/workflows/run-tests.yml

@@ -15,7 +15,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2

composer.json

@@ -14,10 +14,10 @@
     "pixelfear/composer-dist-plugin": "^0.1.6"
   },
   "require-dev": {
-    "laravel/pint": "^1.13",
     "orchestra/testbench": "^9.0",
     "pestphp/pest": "^3.0",
-    "pestphp/pest-plugin-laravel": "^3.0"
+    "pestphp/pest-plugin-laravel": "^3.0",
+    "carthage-software/mago": "^0.10.0"
   },
   "autoload": {
     "psr-4": {
@@ -48,12 +48,16 @@
       "@php vendor/bin/testbench serve"
     ],
     "lint": [
-      "@php vendor/bin/pint"
+      "@php vendor/bin/mago lint"
+    ],
+    "format": [
+      "@php vendor/bin/mago format"
     ],
     "test": [
       "XDEBUG_MODE=coverage vendor/bin/pest --coverage"
     ],
     "qa": [
+      "@format",
       "@lint",
       "@test"
     ]
@@ -76,7 +80,8 @@
   "config": {
     "allow-plugins": {
       "pixelfear/composer-dist-plugin": true,
-      "pestphp/pest-plugin": true
+      "pestphp/pest-plugin": true,
+      "carthage-software/mago": true
     }
   }
 }

composer.lock

@@ -0,0 +1,11 @@
+[source]
+paths = ["src", "tests"]
+includes = ["vendor"]
+
+[format]
+method_chain_break_threshold = 2
+null_type_hint = "question"
+
+[[linter.rules]]
+name = "strictness/require-return-type"
+ignore_arrow_function = true

mago.toml

@@ -18,13 +18,17 @@ abstract public static function getKey(): string;
      * Run the restore process.
      *
      * @param string $path The path to the root of the backup file.
+     * @param Closure(string $path):string $next The next pipe in the chain.
      */
-    abstract public function restore(string $path, Closure $next);
+    abstract public function restore(string $path, Closure $next): string;
 
     /**
      * Run the backup process.
+     *
+     * @param Zipper $zip The zipper instance.
+     * @param Closure(Zipper $zip):Zipper $next The next pipe in the chain.
      */
-    abstract public function backup(Zipper $zip, Closure $next);
+    abstract public function backup(Zipper $zip, Closure $next): Zipper;
 
     /**
      * Get the directory path for the current pipe.
@@ -37,7 +41,7 @@ protected function getDirectoryPath(string $path): string
     /**
      * Mark pipe as skipped.
      */
-    protected function skip(string $reason, Closure $next, Zipper $zip)
+    protected function skip(string $reason, Closure $next, Zipper $zip): Zipper
     {
         $zip->addMeta(static::class, ['skipped' => $reason]);
         return $next($zip);

pint.json

@@ -5,6 +5,8 @@
 namespace Itiden\Backup;
 
 use Exception;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Pipeline;
 use Itiden\Backup\Contracts\Repositories\BackupRepository;
 use Itiden\Backup\Support\Zipper;
@@ -15,7 +17,7 @@
 final class Backuper
 {
     public function __construct(
-        protected BackupRepository $repository
+        protected BackupRepository $repository,
     ) {
     }
 
@@ -36,7 +38,9 @@ public function backup(): BackupDto
                 ->through(config('backup.pipeline'))
                 ->thenReturn();
 
-            if ($password = config('backup.password')) {
+            $password = config('backup.password');
+
+            if ($password) {
                 $zipper->encrypt($password);
             }
 
@@ -50,17 +54,23 @@ public function backup(): BackupDto
 
             $metadata = $backup->getMetadata();
 
-            if ($user = auth()->user()) {
+            $user = auth()->user();
+
+            if ($user) {
                 $metadata->setCreatedBy($user);
             }
 
-            $zipMeta->each(fn ($meta, $key) => match ($key) {
-                'skipped' => $meta->each(fn (string $reason, string $pipe) => $metadata->addSkippedPipe($pipe, $reason)),
-            });
+            $zipMeta->each(
+                static fn(Collection $meta, string $key): mixed => match ($key) {
+                    'skipped' => $meta->each(function (string $reason, string $pipe) use ($metadata): void {
+                        $metadata->addSkippedPipe(pipe: $pipe, reason: $reason);
+                    }),
+                },
+            );
 
             event(new BackupCreated($backup));
 
-            @unlink($temp_zip_path);
+            File::delete($temp_zip_path);
 
             $this->enforceMaxBackups();
 
@@ -76,17 +86,22 @@ public function backup(): BackupDto
         }
     }
 
-    private function resolveMetaFromZip(Zipper $zip)
+    /**
+     * @return Collection<string, Collection<string|int, mixed>>
+     */
+    private function resolveMetaFromZip(Zipper $zip): Collection
     {
-        $metadata = collect([
-            'skipped' => collect(),
-        ]);
-
-        $zip->getMeta()->each(function ($meta, $key) use ($metadata) {
-            if (isset($meta['skipped'])) {
-                $metadata->get('skipped')->put($key, $meta['skipped']);
-            }
-        });
+        $metadata = collect(['skipped' => collect()]);
+
+        $zip
+            ->getMeta()
+            ->each(static function (array|string $meta, string $key) use ($metadata): void {
+                if (is_array($meta) && isset($meta['skipped'])) {
+                    $metadata
+                        ->get('skipped')
+                        ->put($key, $meta['skipped']);
+                }
+            });
 
         return $metadata;
     }
@@ -96,16 +111,17 @@ private function resolveMetaFromZip(Zipper $zip)
      */
     private function enforceMaxBackups(): void
     {
-        if (!$max_backups = config('backup.max_backups', false)) {
+        $maxBackups = config('backup.max_backups', false);
+        if (!$maxBackups) {
             return;
         }
 
         $backups = $this->repository->all();
 
-        if ($backups->count() > $max_backups) {
-            $backups->slice($max_backups)->each(function ($backup) {
-                $this->repository->remove($backup->timestamp);
-            });
+        if ($backups->count() > $maxBackups) {
+            $backups
+                ->slice($maxBackups)
+                ->each(fn(BackupDto $backup): ?BackupDto => $this->repository->remove($backup->timestamp));
         }
     }
 }