Added support for Laravel 11.36

Author: andrey-helldar

README.md

@@ -86,16 +86,19 @@ After that, add to the array the names of the tables for which you want to expor
 That's it. Now you can run the [`php artisan schema:dump`](https://laravel.com/docs/migrations#squashing-migrations)
 console command and enjoy the result.
 
-> Note
+> [!NOTE]
 >
 > If you need to delete files from a folder to which a table is related (for example, the `migrations` table),
 > you can specify an array of two values in the parameter, where the first element should be the name of the column
 > containing the file name, and the second element should be absolute or relative folder path.
 
-> Attention!
+> [!WARNING]
 >
-> Laravel does not know how to report the presence of the `--prune` parameter when calling the `artisan schema:dump`
-> console command, so specifying paths to folders will always delete files from them.
+> Laravel 11.35.2 and below does not know how to report the presence of the `--prune` parameter when calling the
+> `artisan schema:dump` console command, so specifying paths to folders will always delete files from them.
+>
+> Starting with Laravel version 11.36, files will be deleted only when calling the console command with the
+> `--prune` parameter.
 
 
 ## License

src/Listeners/DumpListener.php renamed to src/Listeners/DumpedListener.php

@@ -8,7 +8,7 @@
 use DragonCode\LaravelDataDumper\Service\Tables;
 use Illuminate\Database\Events\SchemaDumped;
 
-class DumpListener
+class DumpedListener extends Listener
 {
     public function __construct(
         protected readonly Tables $tables,

src/Listeners/FilesListener.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelDataDumper\Listeners;
+
+use DragonCode\LaravelDataDumper\Service\Files;
+use DragonCode\LaravelDataDumper\Service\Tables;
+use Illuminate\Database\Events\MigrationsPruned;
+use Illuminate\Database\Events\SchemaDumped;
+
+class FilesListener extends Listener
+{
+    public function __construct(
+        protected readonly Tables $tables,
+        protected readonly Files $files
+    ) {}
+
+    public function handle(MigrationsPruned|SchemaDumped $event): void
+    {
+        $this->files->clean(
+            $event->connection,
+            $this->tables->dumpable()
+        );
+    }
+}

src/Listeners/Listener.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelDataDumper\Listeners;
+
+abstract class Listener {}

src/Service/Dumper.php

@@ -7,13 +7,11 @@
 use DragonCode\LaravelDataDumper\Schema\MySqlSchemaState;
 use DragonCode\LaravelDataDumper\Schema\PostgresSchemaState;
 use DragonCode\LaravelDataDumper\Schema\SQLiteSchemaState;
-use Illuminate\Contracts\Database\Query\Builder;
 use Illuminate\Database\Connection;
 use Illuminate\Database\MySqlConnection;
 use Illuminate\Database\PostgresConnection;
 use Illuminate\Database\Schema\SchemaState;
 use Illuminate\Database\SQLiteConnection;
-use Illuminate\Support\Facades\Schema;
 
 class Dumper
 {
@@ -23,13 +21,9 @@ public function __construct(
 
     public function dump(Connection $connection, string $path, array $tables): void
     {
-        foreach ($tables as $table => $params) {
+        foreach (array_keys($tables) as $table) {
             if ($this->isNotMigration($table)) {
                 $this->export($connection, $path, $table);
-
-                if (is_array($params) && count($params) === 2) {
-                    $this->deleteFiles($connection, $table, $params[0], $params[1]);
-                }
             }
         }
     }
@@ -41,17 +35,6 @@ protected function export(Connection $connection, string $path, string $table):
             ?->dump($connection, $path);
     }
 
-    protected function deleteFiles(Connection $connection, string $table, string $column, string $path): void
-    {
-        $connection->table($table)->when(
-            $this->hasIdColumn($connection, $table),
-            fn (Builder $query) => $query->lazyById(),
-            fn (Builder $query) => $query->lazyById(column: $column),
-        )->each(
-            fn ($item) => $this->files->delete($path, $item->{$column})
-        );
-    }
-
     protected function schemaState(Connection $connection): ?SchemaState
     {
         return match (get_class($connection)) {
@@ -71,9 +54,4 @@ protected function migrationTable(): string
     {
         return is_array($migration = config('database.migrations')) ? $migration['table'] : $migration;
     }
-
-    protected function hasIdColumn(Connection $connection, string $table): bool
-    {
-        return Schema::connection($connection->getName())->hasColumn($table, 'id');
-    }
 }

src/Service/Files.php

@@ -7,10 +7,33 @@
 use Closure;
 use DragonCode\Support\Facades\Filesystem\File;
 use DragonCode\Support\Facades\Helpers\Str;
+use Illuminate\Contracts\Database\Query\Builder;
+use Illuminate\Database\Connection;
+use Illuminate\Support\Facades\Schema;
 
 class Files
 {
-    public function delete(string $path, string $filename): void
+    public function clean(Connection $connection, array $tables): void
+    {
+        foreach ($tables as $table => $params) {
+            if (is_array($params) && count($params) === 2) {
+                $this->deleteFiles($connection, $table, $params[0], $params[1]);
+            }
+        }
+    }
+
+    protected function deleteFiles(Connection $connection, string $table, string $column, string $path): void
+    {
+        $connection->table($table)->when(
+            $this->hasIdColumn($connection, $table),
+            fn (Builder $query) => $query->lazyById(),
+            fn (Builder $query) => $query->lazyById(column: $column),
+        )->each(
+            fn ($item) => $this->delete($path, $item->{$column})
+        );
+    }
+
+    protected function delete(string $path, string $filename): void
     {
         if (! $dir = $this->directory($path)) {
             return;
@@ -29,7 +52,11 @@ protected function directory(string $path): false|string
             return rtrim($path, '\\/');
         }
 
-        return realpath(base_path($path));
+        if (is_dir($path = realpath(base_path($path)))) {
+            return rtrim($path, '\\/');
+        }
+
+        return false;
     }
 
     protected function findFile(string $path, string $filename): string
@@ -48,4 +75,9 @@ protected function resolvePath(string $path): string
     {
         return str_replace('\\', '/', $path);
     }
+
+    protected function hasIdColumn(Connection $connection, string $table): bool
+    {
+        return Schema::connection($connection->getName())->hasColumn($table, 'id');
+    }
 }

src/ServiceProvider.php

@@ -5,7 +5,9 @@
 namespace DragonCode\LaravelDataDumper;
 
 use DragonCode\LaravelDataDumper\Concerns\About;
-use DragonCode\LaravelDataDumper\Listeners\DumpListener;
+use DragonCode\LaravelDataDumper\Listeners\DumpedListener;
+use DragonCode\LaravelDataDumper\Listeners\FilesListener;
+use Illuminate\Database\Events\MigrationsPruned;
 use Illuminate\Database\Events\SchemaDumped;
 use Illuminate\Support\Facades\Event;
 use Illuminate\Support\ServiceProvider as BaseServiceProvider;
@@ -29,7 +31,11 @@ public function register(): void
 
     protected function bootListener(): void
     {
-        Event::listen(SchemaDumped::class, DumpListener::class);
+        Event::listen(SchemaDumped::class, DumpedListener::class);
+
+        class_exists(MigrationsPruned::class)
+            ? Event::listen(MigrationsPruned::class, FilesListener::class)
+            : Event::listen(SchemaDumped::class, FilesListener::class);
     }
 
     protected function registerConfig(): void

tests/Unit/Dumps/DeleteFilesTest.php

@@ -3,9 +3,10 @@
 use DragonCode\Support\Facades\Filesystem\Directory;
 use DragonCode\Support\Facades\Filesystem\File;
 use Illuminate\Database\Console\DumpCommand;
+use Illuminate\Foundation\Application;
 use Illuminate\Support\Facades\Artisan;
 
-it('checks the export of data from tables to a dump file', function () {
+it('checks for file deletion on older versions of Laravel', function () {
     Directory::ensureDelete(base_path('to_delete'));
 
     circleProcess(fn (int $i) => File::store(base_path("to_delete/first/qwerty1File$i.stub"), '1'));
@@ -25,4 +26,54 @@
     circleProcess(fn (int $i) => expect(
         file_exists(base_path("to_delete/third/file$i.stub"))
     )->toBeTrue());
-})->group('SQLite', 'MySQL', 'Postgres');
+})->group('SQLite', 'MySQL', 'Postgres')->skip(
+    version_compare(Application::VERSION, '11.36.0', '>=')
+);
+
+it('checks for file deletion on new version of Laravel', function () {
+    Directory::ensureDelete(base_path('to_delete'));
+
+    circleProcess(fn (int $i) => File::store(base_path("to_delete/first/qwerty1File$i.stub"), '1'));
+    circleProcess(fn (int $i) => File::store(base_path("to_delete/second/sub/qwerty2File$i.stub"), '1'));
+    circleProcess(fn (int $i) => File::store(base_path("to_delete/third/file$i.stub"), '1'));
+
+    Artisan::call(DumpCommand::class, ['--path' => dumpStoragePath(), '----prune' => true]);
+
+    circleProcess(fn (int $i) => expect(
+        file_exists(base_path("to_delete/first/qwerty1File$i.stub"))
+    )->toBe($i % 2 === 0));
+
+    circleProcess(fn (int $i) => expect(
+        file_exists(base_path("to_delete/second/sub/qwerty2File$i.stub"))
+    )->toBeFalse());
+
+    circleProcess(fn (int $i) => expect(
+        file_exists(base_path("to_delete/third/file$i.stub"))
+    )->toBeTrue());
+})->group('SQLite', 'MySQL', 'Postgres')->skip(
+    version_compare(Application::VERSION, '11.36.0', '<')
+);
+
+it('checks for skipping file deletion on new version of Laravel', function () {
+    Directory::ensureDelete(base_path('to_delete'));
+
+    circleProcess(fn (int $i) => File::store(base_path("to_delete/first/qwerty1File$i.stub"), '1'));
+    circleProcess(fn (int $i) => File::store(base_path("to_delete/second/sub/qwerty2File$i.stub"), '1'));
+    circleProcess(fn (int $i) => File::store(base_path("to_delete/third/file$i.stub"), '1'));
+
+    Artisan::call(DumpCommand::class, ['--path' => dumpStoragePath()]);
+
+    circleProcess(fn (int $i) => expect(
+        file_exists(base_path("to_delete/first/qwerty1File$i.stub"))
+    )->toBeTrue());
+
+    circleProcess(fn (int $i) => expect(
+        file_exists(base_path("to_delete/second/sub/qwerty2File$i.stub"))
+    )->toBeTrue());
+
+    circleProcess(fn (int $i) => expect(
+        file_exists(base_path("to_delete/third/file$i.stub"))
+    )->toBeTrue());
+})->group('SQLite', 'MySQL', 'Postgres')->skip(
+    version_compare(Application::VERSION, '11.36.0', '<')
+);