Merge pull request #7 from TheDragonCode/1.x

Added the ability to delete files

Author: andrey-helldar

.github/workflows/tests.yml

@@ -1,6 +1,6 @@
 name: Tests
 
-on: [ push, pull_request ]
+on: [ pull_request ]
 
 jobs:
 

README.md

@@ -9,46 +9,51 @@
 
 ## Introduction
 
-The [squashing migrations](https://laravel.com/docs/migrations#squashing-migrations) in Laravel does not export data from tables?
+The [squashing migrations](https://laravel.com/docs/migrations#squashing-migrations) in Laravel does not export data
+from tables?
 
 There is a solution!
 
 ### How it works?
 
-After installing and configuring the package, you simply run the console command `php artisan schema:dump` (with or without flags - it's up to you), and the final SQL dump file will contain the data structure including the contents of the tables you specified at the configuration stage.
+After installing and configuring the package, you simply run the console command `php artisan schema:dump` (with or
+without flags - it's up to you), and the final SQL dump file will contain the data structure including the contents of
+the tables you specified at the configuration stage.
 
-This will allow you to painlessly execute the `php artisan schema:dump --prune` command, which will remove unnecessary migration files.
+This will allow you to painlessly execute the `php artisan schema:dump --prune` command, which will remove unnecessary
+migration files.
 
 ## Requirements
 
 - Laravel 10, 11
 - PHP 8.2 or higher
 - Databases:
-  - Sqlite 3
-  - MySQL 5.7, 8, 9
-  - PostgreSQL 12, 13, 14, 15, 16
+    - Sqlite 3
+    - MySQL 5.7, 8, 9
+    - PostgreSQL 12, 13, 14, 15, 16, 17
 
 ## Installation
 
-To get the latest version of `Database Data Dumper`, simply require the project using [Composer](https://getcomposer.org):
+To get the latest version of `Database Data Dumper`, simply require the project
+using [Composer](https://getcomposer.org):
 
 ```Bash
-composer require dragon-code/laravel-data-dumper --dev
+composer require dragon-code/laravel-data-dumper
 ```
 
-Or manually update `require-dev` block of `composer.json` and run `composer update`.
+Or manually update `require` block of `composer.json` and run `composer update`.
 
 ```json
 {
-    "require-dev": {
+    "require": {
         "dragon-code/laravel-data-dumper": "^1.0"
     }
 }
 ```
 
 ## Configuration
 
-Since Laravel's mechanism for publishing configuration files does not allow them to be merged on the fly,
+Since Laravel mechanism for publishing configuration files does not allow them to be merged on the fly,
 a new array element must be added to the [`config/database.php`](config/settings.php) file:
 
 ```php
@@ -68,6 +73,9 @@ return [
             // 'foo',
             // 'bar',
             // App\Models\Article::class,
+
+            // 'qwerty1' => ['column_name_1', 'database/foo'],
+            // 'qwerty2' => ['column_name_2', __DIR__ . '/../bar'],
         ],
     ],
 ];
@@ -78,6 +86,17 @@ 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
+>
+> 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!
+>
+> 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.
+
 
 ## License
 

config/settings.php

@@ -16,6 +16,9 @@
             // 'foo',
             // 'bar',
             // App\Models\Settings::class,
+
+            // 'qwerty1' => ['column_name_1', 'database/foo'],
+            // 'qwerty2' => ['column_name_2', __DIR__ . '/../bar'],
         ],
     ],
 ];

src/Service/Dumper.php

@@ -7,19 +7,25 @@
 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
 {
     public function dump(Connection $connection, string $path, array $tables): void
     {
-        foreach ($tables as $table) {
+        foreach ($tables as $table => $params) {
             if ($this->isNotMigration($table)) {
                 $this->export($connection, $path, $table);
+
+                if (is_array($params) && count($params) === 2) {
+                    $this->deleteFiles($connection, $table, $params[0], $params[1]);
+                }
             }
         }
     }
@@ -31,6 +37,17 @@ 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) => Files::delete($path, $item->{$column})
+        );
+    }
+
     protected function schemaState(Connection $connection): ?SchemaState
     {
         return match (get_class($connection)) {
@@ -50,4 +67,9 @@ 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

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelDataDumper\Service;
+
+use DragonCode\Support\Facades\Filesystem\File;
+
+class Files
+{
+    public static function delete(string $path, string $filename): void
+    {
+        if (! $dir = static::directory($path)) {
+            return;
+        }
+
+        File::ensureDelete($dir . '/' . $filename);
+    }
+
+    protected static function directory(string $path): false|string
+    {
+        if (realpath($path) && is_dir($path)) {
+            return rtrim($path, '\\/');
+        }
+
+        return realpath(base_path($path));
+    }
+}

src/Service/Tables.php

@@ -11,14 +11,29 @@ class Tables
 {
     public function dumpable(): array
     {
-        return array_intersect($this->available(), $this->tables());
+        return collect($this->tables())
+            ->intersectByKeys(collect($this->available())->flip())
+            ->all();
     }
 
     protected function tables(): array
     {
-        return collect(config('database.schema.tables', []))
-            ->map(fn (string $table) => $this->fromModels($table))
-            ->all();
+        return collect(config('database.schema.tables'))
+            ->mapWithKeys(function (array|string $value, int|string $key) {
+                if (is_numeric($key)) {
+                    $value = is_string($value) && ! is_numeric($value) ? $value : null;
+
+                    return [$this->fromModels($value) => null];
+                }
+
+                if (is_string($key) && is_array($value)) {
+                    return [$this->fromModels($key) => $value];
+                }
+
+                return [null => null];
+            })->reject(
+                fn (mixed $value, ?string $key) => is_null($key)
+            )->all();
     }
 
     protected function available(): array
@@ -31,8 +46,12 @@ protected function tableSchema(): array
         return Schema::getTables();
     }
 
-    protected function fromModels(Model|string $table): string
+    protected function fromModels(Model|string|null $table): ?string
     {
+        if (empty($table)) {
+            return null;
+        }
+
         if (! class_exists($table)) {
             return $table;
         }

tests/Fixtures/migrations/2024_12_12_210937_qwerty1.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+use Tests\Fixtures\Database\Migration;
+
+return new class extends Migration {
+    protected string $tableName = 'qwerty1';
+
+    protected function fillTable(): void
+    {
+        circleProcess(function (int $i) {
+            if ($i % 2 === 0) {
+                return;
+            }
+
+            $this->table()->insert([
+                $this->column() => sprintf('qwerty1File%s.stub', $i),
+            ]);
+        });
+    }
+};

tests/Fixtures/migrations/2024_12_12_210949_qwerty2.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+use Tests\Fixtures\Database\Migration;
+
+return new class extends Migration {
+    protected string $tableName = 'qwerty2';
+
+    protected function fillTable(): void
+    {
+        circleProcess(fn (int $i) => $this->table()->insert([
+            $this->column() => sprintf('sub/qwerty2File%s.stub', $i),
+        ]));
+    }
+};

tests/Helpers/data.php

@@ -2,13 +2,18 @@
 
 declare(strict_types=1);
 
-expect()->extend('toBeDataContains', function (string $name) {
+expect()->extend('toBeDataContains', function (string $name, ?Closure $callback = null, ?Closure $not = null) {
     expect($this->value)
         ->toContain(tableName($name))
         ->toContain(columnName($name));
 
+    $callback ??= fn (int $i) => valueName($name, $i);
+    $not      ??= fn (int $i) => false;
+
     circleProcess(
-        fn (int $i) => expect($this->value)->toContain(valueName($name, $i))
+        fn (int $i) => $not($i)
+            ? expect($this->value)->not()->toContain($callback($i))
+            : expect($this->value)->toContain($callback($i))
     );
 });
 
@@ -27,5 +32,7 @@
         ->toContain('2024_03_15_000001_foo')
         ->toContain('2024_03_15_000002_bar')
         ->toContain('2024_03_15_000003_baz')
-        ->toContain('2024_07_10_222137_articles');
+        ->toContain('2024_07_10_222137_articles')
+        ->toContain('2024_12_12_210937_qwerty1')
+        ->toContain('2024_12_12_210949_qwerty2');
 });

tests/Helpers/filling.php

@@ -8,7 +8,7 @@
     foreach (names() as $name) {
         expect(
             DB::table(tableName($name))->count()
-        )->toBe(10);
+        )->toBe($name === 'qwerty1' ? 5 : 10);
     }
 
     return $this;