Exclude tables by @k2idev #9

Author: mechelon

src/DumpSchema.php

@@ -16,6 +16,7 @@ class DumpSchema
 
     protected $loadAllTables = false;
     protected $customizedTables = [];
+    protected $excludedTables = [];
 
     public function __construct($connectionName = null)
     {
@@ -48,6 +49,13 @@ public function allTables()
         return $this;
     }
 
+    public function exclude(string $tableName)
+    {
+        $this->excludedTables[] = $tableName;
+
+        return $this;
+    }
+
     /**
      * @return \Illuminate\Database\Schema\Builder
      */
@@ -158,9 +166,15 @@ public function load()
         $this->loadAvailableTables();
 
         if ($this->loadAllTables) {
-            $this->dumpTables = collect($this->availableTables)->mapWithKeys(function (Table $table) {
+            $dumpTables = collect($this->availableTables)->mapWithKeys(function (Table $table) {
                 return [$table->getName() => new TableDefinition($table)];
-            })->toArray();
+            });
+
+            $excluded = $this->excludedTables;
+            $this->dumpTables = $dumpTables
+                ->filter(function ($table, $tableName) use ($excluded) {
+                    return !in_array($tableName, $excluded);
+                })->toArray();
         }
 
         foreach ($this->customizedTables as $tableName => $tableDefinition) {

src/LaravelMaskedDump.php

@@ -2,7 +2,6 @@
 
 namespace BeyondCode\LaravelMaskedDumper;
 
-use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Schema\Schema;
 use Illuminate\Console\OutputStyle;
 use BeyondCode\LaravelMaskedDumper\TableDefinitions\TableDefinition;
@@ -125,7 +124,7 @@ protected function dumpTableData(TableDefinition $table)
                 $row = $this->transformResultForInsert((array)$row, $table);
                 $tableName = $table->getDoctrineTable()->getName();
 
-                $query .= "INSERT INTO `${tableName}` (`" . implode('`, `', array_keys($row)) . '`) VALUES ';
+                $query .= "INSERT INTO `$tableName` (`" . implode('`, `', array_keys($row)) . '`) VALUES ';
                 $query .= "(";
 
                 $firstColumn = true;

tests/DumperTest.php

@@ -171,4 +171,31 @@ public function it_can_dump_certain_tables_as_schema_only()
 
         $this->assertMatchesTextSnapshot(file_get_contents($outputFile));
     }
+
+    /** @test */
+    public function it_does_remove_excluded_tables_from_allTables()
+    {
+        $this->loadLaravelMigrations();
+
+        DB::table('users')
+            ->insert([
+                'name' => 'Marcel',
+                'email' => 'marcel@beyondco.de',
+                'password' => 'test',
+                'created_at' => '2021-01-01 00:00:00',
+                'updated_at' => '2021-01-01 00:00:00',
+            ]);
+
+        $outputFile = base_path('test.sql');
+
+        $this->app['config']['masked-dump.default'] = DumpSchema::define()
+            ->allTables()
+            ->exclude('users');
+
+        $this->artisan('db:masked-dump', [
+            'output' => $outputFile
+        ]);
+
+        $this->assertMatchesTextSnapshot(file_get_contents($outputFile));
+    }
 }

tests/__snapshots__/DumperTest__it_does_remove_excluded_tables_from_allTables__1.txt

@@ -0,0 +1,51 @@
+DROP TABLE IF EXISTS `cache`;
+CREATE TABLE cache ("key" VARCHAR(255) NOT NULL, value CLOB NOT NULL, expiration INTEGER NOT NULL);
+LOCK TABLES `cache` WRITE;
+ALTER TABLE `cache` DISABLE KEYS;
+ALTER TABLE `cache` ENABLE KEYS;
+UNLOCK TABLES;
+DROP TABLE IF EXISTS `cache_locks`;
+CREATE TABLE cache_locks ("key" VARCHAR(255) NOT NULL, owner VARCHAR(255) NOT NULL, expiration INTEGER NOT NULL);
+LOCK TABLES `cache_locks` WRITE;
+ALTER TABLE `cache_locks` DISABLE KEYS;
+ALTER TABLE `cache_locks` ENABLE KEYS;
+UNLOCK TABLES;
+DROP TABLE IF EXISTS `failed_jobs`;
+CREATE TABLE failed_jobs (id INTEGER NOT NULL, uuid VARCHAR(255) NOT NULL, connection CLOB NOT NULL, queue CLOB NOT NULL, payload CLOB NOT NULL, exception CLOB NOT NULL, failed_at DATETIME NOT NULL);
+LOCK TABLES `failed_jobs` WRITE;
+ALTER TABLE `failed_jobs` DISABLE KEYS;
+ALTER TABLE `failed_jobs` ENABLE KEYS;
+UNLOCK TABLES;
+DROP TABLE IF EXISTS `job_batches`;
+CREATE TABLE job_batches (id VARCHAR(255) NOT NULL, name VARCHAR(255) NOT NULL, total_jobs INTEGER NOT NULL, pending_jobs INTEGER NOT NULL, failed_jobs INTEGER NOT NULL, failed_job_ids CLOB NOT NULL, options CLOB NOT NULL, cancelled_at INTEGER NOT NULL, created_at INTEGER NOT NULL, finished_at INTEGER NOT NULL);
+LOCK TABLES `job_batches` WRITE;
+ALTER TABLE `job_batches` DISABLE KEYS;
+ALTER TABLE `job_batches` ENABLE KEYS;
+UNLOCK TABLES;
+DROP TABLE IF EXISTS `jobs`;
+CREATE TABLE jobs (id INTEGER NOT NULL, queue VARCHAR(255) NOT NULL, payload CLOB NOT NULL, attempts INTEGER NOT NULL, reserved_at INTEGER NOT NULL, available_at INTEGER NOT NULL, created_at INTEGER NOT NULL);
+LOCK TABLES `jobs` WRITE;
+ALTER TABLE `jobs` DISABLE KEYS;
+ALTER TABLE `jobs` ENABLE KEYS;
+UNLOCK TABLES;
+DROP TABLE IF EXISTS `migrations`;
+CREATE TABLE migrations (id INTEGER NOT NULL, migration VARCHAR(255) NOT NULL, batch INTEGER NOT NULL);
+LOCK TABLES `migrations` WRITE;
+ALTER TABLE `migrations` DISABLE KEYS;
+INSERT INTO `migrations` (`id`, `migration`, `batch`) VALUES ('1', '0001_01_01_000000_testbench_create_users_table', '1');
+INSERT INTO `migrations` (`id`, `migration`, `batch`) VALUES ('2', '0001_01_01_000001_testbench_create_cache_table', '1');
+INSERT INTO `migrations` (`id`, `migration`, `batch`) VALUES ('3', '0001_01_01_000002_testbench_create_jobs_table', '1');
+ALTER TABLE `migrations` ENABLE KEYS;
+UNLOCK TABLES;
+DROP TABLE IF EXISTS `password_reset_tokens`;
+CREATE TABLE password_reset_tokens (email VARCHAR(255) NOT NULL, token VARCHAR(255) NOT NULL, created_at DATETIME NOT NULL);
+LOCK TABLES `password_reset_tokens` WRITE;
+ALTER TABLE `password_reset_tokens` DISABLE KEYS;
+ALTER TABLE `password_reset_tokens` ENABLE KEYS;
+UNLOCK TABLES;
+DROP TABLE IF EXISTS `sessions`;
+CREATE TABLE sessions (id VARCHAR(255) NOT NULL, user_id INTEGER NOT NULL, ip_address VARCHAR(255) NOT NULL, user_agent CLOB NOT NULL, payload CLOB NOT NULL, last_activity INTEGER NOT NULL);
+LOCK TABLES `sessions` WRITE;
+ALTER TABLE `sessions` DISABLE KEYS;
+ALTER TABLE `sessions` ENABLE KEYS;
+UNLOCK TABLES;