feat(hook): parser hook and transitioner api

Added a hook for parsers and added the API endpoints for the transitioner.

Refers to #403
Refers to #397

Author: wzrdtales

api.js

@@ -62,7 +62,8 @@ function dbmigrate(plugins, isModule, options, callback) {
 
   this.internals = {
 
-    onComplete: onComplete
+    onComplete: onComplete,
+    migrationProtocol: 1
   };
   var internals = this.internals;
 
@@ -295,6 +296,14 @@ dbmigrate.prototype = {
     return log.silence(isSilent);
   },
 
+  /**
+    * Transition migrations to the latest defined protocol.
+    */
+  transition: function() {
+
+    transition(this.internals);
+  },
+
   /**
    * Creates a correctly formatted migration
    */
@@ -474,7 +483,7 @@ function setDefaultArgv(internals, isModule) {
       'ignore-completed-migrations': false
     })
     .usage(
-      'Usage: db-migrate [up|down|reset|create|db|seed] [[dbname/]migrationName|all] [options]'
+      'Usage: db-migrate [up|down|reset|create|db|seed|transition] [[dbname/]migrationName|all] [options]'
     )
 
   .describe('env',
@@ -780,61 +789,75 @@ function _assert(err, callback) {
   return true;
 }
 
+function migrationHook(internals) {
+
+  var Migration = require('./lib/migration.js');
+  return Migration.registerHook(internals.plugins, internals);
+}
+
 function executeUp(internals, config, callback) {
 
-  var Migrator = require('./lib/migrator.js');
-  var index = require('./connect');
+  migrationHook(internals)
+  .then(function() {
 
-  if (!internals.argv.count) {
-    internals.argv.count = Number.MAX_VALUE;
-  }
-  index.connect({
-    config: config.getCurrent().settings,
-    internals: internals
-  }, Migrator, function(err, migrator) {
-    assert.ifError(err);
+    var Migrator = require('./lib/migrator.js');
+    var index = require('./connect');
+
+    if (!internals.argv.count) {
+      internals.argv.count = Number.MAX_VALUE;
+    }
+    index.connect({
+      config: config.getCurrent().settings,
+      internals: internals
+    }, Migrator, function(err, migrator) {
+      assert.ifError(err);
 
-    if (internals.locTitle)
+      if (internals.locTitle)
       migrator.migrationsDir = path.resolve(internals.argv['migrations-dir'],
-        internals.locTitle);
-    else
+      internals.locTitle);
+      else
       migrator.migrationsDir = path.resolve(internals.argv['migrations-dir']);
 
-    internals.migrationsDir = migrator.migrationsDir;
+      internals.migrationsDir = migrator.migrationsDir;
 
-    migrator.driver.createMigrationsTable(function(err) {
-      assert.ifError(err);
-      log.verbose('migration table created');
+      migrator.driver.createMigrationsTable(function(err) {
+        assert.ifError(err);
+        log.verbose('migration table created');
 
-      migrator.up(internals.argv, internals.onComplete.bind(this,
-        migrator, internals, callback));
-    });
+        migrator.up(internals.argv, internals.onComplete.bind(this,
+          migrator, internals, callback));
+        });
+      });
   });
 }
 
 function executeDown(internals, config, callback) {
 
-  var Migrator = require('./lib/migrator.js');
-  var index = require('./connect');
-
-  if (!internals.argv.count) {
-    log.info('Defaulting to running 1 down migration.');
-    internals.argv.count = 1;
-  }
+  migrationHook(internals)
+  .then(function() {
 
-  index.connect({
-    config: config.getCurrent().settings,
-    internals: internals
-  }, Migrator, function(err, migrator) {
-    assert.ifError(err);
+    var Migrator = require('./lib/migrator.js');
+    var index = require('./connect');
 
-    migrator.migrationsDir = path.resolve(internals.argv['migrations-dir']);
+    if (!internals.argv.count) {
+      log.info('Defaulting to running 1 down migration.');
+      internals.argv.count = 1;
+    }
 
-    migrator.driver.createMigrationsTable(function(err) {
+    index.connect({
+      config: config.getCurrent().settings,
+      internals: internals
+    }, Migrator, function(err, migrator) {
       assert.ifError(err);
-      migrator.down(internals.argv, internals.onComplete.bind(this,
-        migrator, internals, callback));
-    });
+
+      migrator.migrationsDir = path.resolve(internals.argv['migrations-dir']);
+
+      migrator.driver.createMigrationsTable(function(err) {
+        assert.ifError(err);
+        migrator.down(internals.argv, internals.onComplete.bind(this,
+          migrator, internals, callback));
+        });
+      });
   });
 }
 
@@ -994,13 +1017,22 @@ function onComplete(migrator, internals, callback, originalErr) {
   });
 }
 
+function transition(internals) {
+
+  require('./lib/transitions/transitioner.js')(internals);
+}
+
 function run(internals, config) {
   var action = internals.argv._.shift(),
     folder = action.split(':');
 
   action = folder[0];
 
   switch (action) {
+    case 'transition':
+
+      transition(internals);
+      break;
     case 'create':
 
       if (folder[1]) {

lib/migration.js

@@ -2,17 +2,9 @@ var fs = require('fs');
 var path = require('path');
 var log = require('db-migrate-shared').log;
 var Skeleton = require('./skeleton');
+var Promise = require('bluebird');
 
 var filesRegEx = /\.js$/;
-var coffeeSupported = false;
-var coffeeModule = null;
-try {
-  coffeeModule = require('coffee-script');
-  if (coffeeModule && coffeeModule.register) coffeeModule.register();
-  coffeeSupported = true;
-  filesRegEx = /\.(js|coffee)$/;
-} catch (e) {}
-
 var internals = {};
 
 function writeMigrationRecord(db, migration, callback) {
@@ -42,6 +34,38 @@ var Migration = Skeleton.extend({
   }
 });
 
+Migration.registerHook = function(plugin, internals) {
+
+  var plugin = plugin.hook('migrator:migration:hook:require');
+  internals.parser = internals.parse || {
+    filesRegEx: filesRegEx,
+    extensions: 'js'
+  };
+
+  if(!plugin)
+    return Promise.resolve(null);
+
+  return Promise.resolve(plugin)
+  .map(function(plugin) {
+
+    return plugin['migrator:migration:hook:require']();
+  })
+  .each(function(parser) {
+
+    internals.parser.extensions = internals.parser.extensions + '|' +
+      parser.extensions;
+  })
+  .then(function() {
+    internals.parser.filesRegEx = new RegExp(
+      '\\.(' +
+      internals.parser.extensions +
+      ')$'
+    );
+
+    return internals.parser;
+  });
+};
+
 Migration.prototype.defaultCoffeeTemplate = function() {
   return [
     '\'use strict\';',
@@ -302,11 +326,8 @@ Migration.loadFromFilesystem = function(dir, internals, callback) {
     }
     var coffeeWarn = true;
     files = files.filter(function(file) {
-      if (coffeeWarn && !coffeeSupported && /\.coffee$/.test(file)) {
-        log.warn('CoffeeScript not installed');
-        coffeeWarn = false;
-      }
-      return filesRegEx.test(file);
+
+      return internals.parser.filesRegEx.test(file);
     });
     var migrations = files.sort().map(function(file) {
       return new Migration(path.join(dir, file), internals);

lib/seed.js

@@ -3,16 +3,6 @@ var path = require('path');
 var log = require('db-migrate-shared').log;
 var Skeleton = require('./skeleton');
 
-var filesRegEx = /\.js$/;
-var coffeeSupported = false;
-var coffeeModule = null;
-try {
-  coffeeModule = require('coffee-script');
-  if (coffeeModule && coffeeModule.register) coffeeModule.register();
-  coffeeSupported = true;
-  filesRegEx = /\.(js|coffee)$/;
-} catch (e) {}
-
 var Seed = Skeleton.extend({
 
   init: function() {
@@ -129,11 +119,8 @@ Seed.loadFromFilesystem = function(dir, internals, callback) {
     if (err) { callback(err); return; }
     var coffeeWarn = true;
     files = files.filter(function(file) {
-      if (coffeeWarn && !coffeeSupported && /\.coffee$/.test(file)) {
-        log.warn('CoffeeScript not installed');
-        coffeeWarn = false;
-      }
-      return filesRegEx.test(file);
+
+      return internals.parser.filesRegEx.test(file);
     });
     var seeds = files.sort().map(function(file) {
       return new Seed(path.join(dir, file), internals);