Adds possibility to dry run

README.md

@@ -20,7 +20,7 @@ time you run the migration tool, you'll need to *Initialize* it (generating that
 ```php
 $pdo = new PDO("mysql:host=yourdbhost;database=yourdb", "youruser", "yourpass");
 
-(new \dbmigrate\Initialize($pdo))->createInstalledMigrationsTable();
+call_user_func(new \dbmigrate\Initialize($pdo));
 ```
 
 ##### Running Migrations (on every deployment)
@@ -35,7 +35,7 @@ If multiple migrations have to be installed at once, the order in which they are
 ```php
 $pdo = new PDO("mysql:host=yourdbhost;database=yourdb", "youruser", "yourpass");
 
-(new \dbmigrate\Migrate($pdo, new \SplFileInfo("/path/to/your/sql/folder")))->runMissingMigrations();
+call_user_func(new \dbmigrate\Migrate($pdo, new \SplFileInfo("/path/to/your/sql/folder")));
 ```
 
 

src/php/Initialize.php

@@ -22,7 +22,7 @@ public function __construct(\PDO $pdo)
     }
 
 
-    public function createInstalledMigrationsTable()
+    public function __invoke()
     {
         $this->migrationTablePresenceConstraint->assertTableMissing();
         $this->runMigration->run(new SqlFile(new \SplFileInfo(__DIR__ . "/../sql/init.sql")));

src/php/Migrate.php

@@ -4,6 +4,7 @@
 namespace dbmigrate;
 
 
+use dbmigrate\application\MigrationDirectoryValidator;
 use dbmigrate\application\MigrationException;
 use dbmigrate\application\MigrationFileScanner;
 use dbmigrate\application\Planner;
@@ -30,18 +31,14 @@ public function __construct(\PDO $pdo, \SplFileInfo $sqlDirectory)
         if($pdo === null) {
             throw new \InvalidArgumentException("PDO may not be null");
         }
-        if($sqlDirectory===null) {
-            throw new \InvalidArgumentException("sqlDirectory may not be null");
-        }
 
-        if(!$sqlDirectory->isDir() || !is_readable($sqlDirectory->getPathname())) {
-            throw new \InvalidArgumentException("sqlDirectory ".$sqlDirectory->getPathname()." does not exist or is not readable");
-        }
+        (new MigrationDirectoryValidator())->assertValidMigrationFileDirectory($sqlDirectory);
+
         $this->pdo = $pdo;
         $this->sqlDirectory = $sqlDirectory;
     }
 
-    public function runMissingMigrations() {
+    public function __invoke() {
         $fileScanner = new MigrationFileScanner($this->sqlDirectory);
         $loadMigrations = new LoadMigrations($this->pdo);
         $migrationsToInstall = (new Planner($fileScanner, $loadMigrations))->findMigrationsToInstall();

src/php/MigrateDryRun.php

@@ -0,0 +1,42 @@
+<?php
+
+
+namespace dbmigrate;
+
+
+use dbmigrate\application\MigrationDirectoryValidator;
+use dbmigrate\application\MigrationFileScanner;
+use dbmigrate\application\Planner;
+use dbmigrate\application\sql\LoadMigrations;
+use dbmigrate\application\sql\SqlFile;
+
+class MigrateDryRun
+{
+    /** @var  \PDO */
+    private $pdo;
+
+    /** @var  \SplFileInfo */
+    private $sqlDirectory;
+
+    public function __construct(\PDO $pdo, \SplFileInfo $sqlDirectory)
+    {
+        if ($pdo === null) {
+            throw new \InvalidArgumentException("PDO may not be null");
+        }
+
+        (new MigrationDirectoryValidator())->assertValidMigrationFileDirectory($sqlDirectory);
+
+        $this->pdo = $pdo;
+        $this->sqlDirectory = $sqlDirectory;
+    }
+
+    /** @return SqlFile[] */
+    public function __invoke()
+    {
+        $fileScanner = new MigrationFileScanner($this->sqlDirectory);
+        $loadMigrations = new LoadMigrations($this->pdo);
+
+        return (new Planner($fileScanner, $loadMigrations))->findMigrationsToInstall();
+
+    }
+}

src/php/application/MigrationDirectoryValidator.php

@@ -0,0 +1,20 @@
+<?php
+
+
+namespace dbmigrate\application;
+
+
+class MigrationDirectoryValidator
+{
+    public function assertValidMigrationFileDirectory(\SplFileInfo $sqlDirectory)
+    {
+        if($sqlDirectory===null) {
+            throw new \InvalidArgumentException("sqlDirectory may not be null");
+        }
+
+        if(!$sqlDirectory->isDir() || !is_readable($sqlDirectory->getPathname())) {
+            throw new \InvalidArgumentException("sqlDirectory ".$sqlDirectory->getPathname()." does not exist or is not readable");
+        }
+
+    }
+}

src/php/application/MigrationFileScanner.php

@@ -17,9 +17,7 @@ class MigrationFileScanner
      */
     public function __construct(\SplFileInfo $scanDir)
     {
-        if (!$scanDir->isDir() || !is_readable($scanDir->getPathname())) {
-            throw new \InvalidArgumentException("Passed dir " . $scanDir->getPathname() . " is not a dir or not readable");
-        }
+        (new MigrationDirectoryValidator())->assertValidMigrationFileDirectory($scanDir);
         $this->scanDir = $scanDir;
     }
 

test/php/InitializeIntegrationTest.php

@@ -12,15 +12,15 @@ class InitializeIntegrationTest extends PHPUnit_Framework_TestCase
     public function testInitializeCreatesExactlyOneTable()
     {
         $pdo = $this->aNewSchema();
-        (new Initialize($pdo))->createInstalledMigrationsTable();
+        call_user_func(new Initialize($pdo));
 
         $this->assertEquals(1, $pdo->query("show tables;")->rowCount());
     }
 
     public function testInitializeCreatesInfoTable()
     {
         $pdo = $this->aNewSchema();
-        (new Initialize($pdo))->createInstalledMigrationsTable();
+        call_user_func(new Initialize($pdo));
 
         $this->assertEquals("installed_migrations", $pdo->query("show tables;")->fetchColumn(0));
     }

test/php/MigrateDryRunIntegrationTest.php

@@ -0,0 +1,33 @@
+<?php
+
+
+namespace dbmigrate;
+
+
+use dbmigrate\application\MigrationException;
+use dbmigrate\application\schema\Migration;
+use dbmigrate\application\sql\LoadMigrations;
+use dbmigrate\application\sql\SqlFile;
+use dbmigrate\testutil\IntegrationDatabase;
+
+class MigrateDryRunIntegrationTest extends \PHPUnit_Framework_TestCase
+{
+    use IntegrationDatabase;
+
+
+    public function testInitializeFromEmptySchema()
+    {
+        $pdo = $this->aNewInitializedSchema();
+
+        $sqlDirectory = new \SplFileInfo(__DIR__ . "/../testsets/nummericsorting");
+
+        $files = call_user_func(new MigrateDryRun($pdo, $sqlDirectory));
+
+        $this->assertEquals([
+            new SqlFile(new \SplFileInfo($sqlDirectory->getPathname()."/v3_test.sql")),
+            new SqlFile(new \SplFileInfo($sqlDirectory->getPathname()."/v10_test.sql"))
+        ], $files);
+    }
+
+
+}

test/php/MigrateIntegrationTest.php

@@ -18,7 +18,7 @@ public function testInitializeFromEmptySchema()
     {
         $pdo = $this->aNewInitializedSchema();
 
-        (new Migrate($pdo, new \SplFileInfo(__DIR__ . "/../testsets/nummericsorting")))->runMissingMigrations();
+        call_user_func(new Migrate($pdo, new \SplFileInfo(__DIR__ . "/../testsets/nummericsorting")));
 
         $migrations = (new LoadMigrations($pdo))->allInstalledMigrations();
         $this->assertEquals("v3_test.sql", $migrations[0]->getFilename());
@@ -30,8 +30,8 @@ public function testInitializeIncremental()
 
         $pdo = $this->aNewInitializedSchema();
 
-        (new Migrate($pdo, new \SplFileInfo(__DIR__ . "/../testsets/incremental/step1")))->runMissingMigrations();
-        (new Migrate($pdo, new \SplFileInfo(__DIR__ . "/../testsets/incremental/step2")))->runMissingMigrations();
+        call_user_func(new Migrate($pdo, new \SplFileInfo(__DIR__ . "/../testsets/incremental/step1")));
+        call_user_func(new Migrate($pdo, new \SplFileInfo(__DIR__ . "/../testsets/incremental/step2")));
 
         $migrations = (new LoadMigrations($pdo))->allInstalledMigrations();
         $this->assertEquals("v3_test.sql", $migrations[0]->getFilename());
@@ -44,7 +44,7 @@ public function testMarkBrokenSqlFileAsFailed()
         $pdo = $this->aNewInitializedSchema();
 
         try {
-            (new Migrate($pdo, new \SplFileInfo(__DIR__ . "/../testsets/failing")))->runMissingMigrations();
+            call_user_func(new Migrate($pdo, new \SplFileInfo(__DIR__ . "/../testsets/failing")));
             $this->fail("should throw an exception");
         } catch(MigrationException $e) {
             // expected

test/php/application/sql/MigrationTablePresenceConstraintIntegrationTest.php

@@ -25,7 +25,7 @@ public function testValidationPassesOnExistingTable()
     {
         $pdo = $this->aNewSchema();
 
-        (new Initialize($pdo))->createInstalledMigrationsTable();
+        (new Initialize($pdo))->__invoke();
 
         (new MigrationTablePresenceConstraint($pdo))->assertTablePresent();
     }

test/php/testutil/IntegrationDatabase.php

@@ -23,7 +23,7 @@ public function aNewSchema() {
     public function aNewInitializedSchema() {
         $pdo = $this->aNewSchema();
 
-        (new Initialize($pdo))->createInstalledMigrationsTable();
+        (new Initialize($pdo))->__invoke();
 
         return $pdo;
     }