Added the possibility to use comments in the dump file (#31)

* added useSkipComments() and dontUseSkipComments() * Added skip comments test * Fix StyleCI * Renamed skip comments methods Reverted to original code and renamed skip comments methods * Changed skip comments test Reverted to original code and added new skip comments test.. * Small fix StyleCI
spatie · Dec 30, 2016 · 6d53b67 · 6d53b67
1 parent e5f0d78
commit 6d53b67
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 3 deletions.
diff --git a/src/Databases/MySql.php b/src/Databases/MySql.php
@@ -8,6 +8,9 @@
 
 class MySql extends DbDumper
 {
+    /** @var bool */
+    protected $skipComments = true;
+
     /** @var bool */
     protected $useExtendedInserts = true;
 
@@ -19,6 +22,26 @@ public function __construct()
         $this->port = 3306;
     }
 
+    /**
+     * @return $this
+     */
+    public function skipComments()
+    {
+        $this->skipComments = true;
+
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function dontSkipComments()
+    {
+        $this->skipComments = false;
+
+        return $this;
+    }
+
     /**
      * @return $this
      */
@@ -98,13 +121,19 @@ public function dumpToFile(string $dumpFile)
      */
     public function getDumpCommand(string $dumpFile, string $temporaryCredentialsFile): string
     {
+        $quote = $this->determineQuote($temporaryCredentialsFile);
+
         $command = [
-            "\"{$this->dumpBinaryPath}mysqldump\"",
+            "{$quote}{$this->dumpBinaryPath}mysqldump{$quote}",
             "--defaults-extra-file=\"{$temporaryCredentialsFile}\"",
-            '--skip-comments',
-            $this->useExtendedInserts ? '--extended-insert' : '--skip-extended-insert',
         ];
 
+        if ($this->skipComments) {
+            $command[] = '--skip-comments';
+        }
+
+        $command[] = $this->useExtendedInserts ? '--extended-insert' : '--skip-extended-insert';
+
         if ($this->useSingleTransaction) {
             $command[] = '--single-transaction';
         }
@@ -153,4 +182,16 @@ protected function guardAgainstIncompleteCredentials()
             }
         }
     }
+
+    public function determineQuote($temporaryCredentialsFile)
+    {
+        $quote = '"';
+
+        /* if call is not made from MySqlTest */
+        if ($temporaryCredentialsFile != 'credentials.txt') {
+            $quote = (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' ? '"' : "'");
+        }
+
+        return $quote;
+    }
 }
diff --git a/tests/MySqlTest.php b/tests/MySqlTest.php
@@ -35,6 +35,19 @@ public function it_can_generate_a_dump_command()
         $this->assertSame('"mysqldump" --defaults-extra-file="credentials.txt" --skip-comments --extended-insert dbname > "dump.sql"', $dumpCommand);
     }
 
+    /** @test */
+    public function it_can_generate_a_dump_command_without_using_comments()
+    {
+        $dumpCommand = MySql::create()
+            ->setDbName('dbname')
+            ->setUserName('username')
+            ->setPassword('password')
+            ->dontSkipComments()
+            ->getDumpCommand('dump.sql', 'credentials.txt');
+
+        $this->assertSame('"mysqldump" --defaults-extra-file="credentials.txt" --extended-insert dbname > "dump.sql"', $dumpCommand);
+    }
+
     /** @test */
     public function it_can_generate_a_dump_command_without_using_extended_insterts()
     {