SqlDocument: added method save()

Author: janpecha

readme.md

@@ -100,6 +100,7 @@ Generate SQL:
 ```php
 $sql->toSql($driver); // returns string
 $sql->getSqlQueries($driver); // returns string[]
+$sql->save($file, $driver); // saves SQL into file
 ```
 
 ## Supported database

src/SqlDocument.php

@@ -67,6 +67,30 @@ public function toSql(IDriver $driver)
 		}
 
 
+		/**
+		 * @param  string
+		 * @param  IDriver
+		 * @return void
+		 * @throws IOException
+		 */
+		public function save($file, IDriver $driver)
+		{
+			// create directory
+			$dir = dirname($file);
+
+			if (!is_dir($dir) && !@mkdir($dir, 0777, TRUE) && !is_dir($dir)) { // @ - dir may already exist
+				throw new IOException("Unable to create directory '$dir'.");
+			}
+
+			// write file
+			$content = $this->toSql($driver);
+
+			if (@file_put_contents($file, $content) === FALSE) { // @ is escalated to exception
+				throw new IOException("Unable to write file '$file'.");
+			}
+		}
+
+
 		/**
 		 * @param  string
 		 * @param  array

src/exceptions.php

@@ -18,6 +18,11 @@ class InvalidArgumentException extends Exception
 	}
 
 
+	class IOException extends Exception
+	{
+	}
+
+
 	class NotImplementedException extends Exception
 	{
 	}

tests/.gitignore

@@ -0,0 +1 @@
+/tmp/

tests/SqlGenerator/SqlDocument.save.phpt

@@ -0,0 +1,40 @@
+<?php
+
+use CzProject\SqlGenerator\Drivers;
+use CzProject\SqlGenerator\SqlDocument;
+use CzProject\SqlGenerator\Statements\IndexDefinition;
+use Tester\Assert;
+
+require __DIR__ . '/../bootstrap.php';
+
+define('TEMP_DIR', prepareTempDir());
+
+
+test(function () {
+
+	$sql = new SqlDocument;
+	$driver = new Drivers\MysqlDriver;
+	$file = TEMP_DIR . '/subdir/file.sql';
+
+	$sql->command('SET NAMES "utf8mb4"');
+	$sql->save($file, $driver);
+
+	Assert::same(implode("\n", array(
+		'SET NAMES "utf8mb4";',
+		'',
+	)), file_get_contents($file));
+
+});
+
+
+test(function () {
+
+	$sql = new SqlDocument;
+	$sql->command('SET NAMES "utf8mb4"');
+	$file = TEMP_DIR . '/subdir';
+
+	Assert::exception(function () use ($sql, $file) {
+		$sql->save($file, new Drivers\MysqlDriver);
+	}, 'CzProject\SqlGenerator\IOException', "Unable to write file '$file'.");
+
+});

tests/bootstrap.php

@@ -9,3 +9,12 @@ function test($cb)
 {
 	$cb();
 }
+
+
+function prepareTempDir()
+{
+	$tempDir = __DIR__ . '/tmp/' . getmypid();
+	mkdir(dirname($tempDir), 0777, TRUE);
+	Tester\Helpers::purge($tempDir);
+	return $tempDir;
+}