feat(plugin): add template plugin hook

Signed-off-by: Tobias Gurtzick <[email protected]>

Author: wzrdtales

index.js

@@ -55,7 +55,7 @@ function loadPlugins (options) {
       continue;
     }
 
-    plugin.hooks.map(function (hook) {
+    plugin.hooks.forEach(function (hook) {
       hooks[hook] = hooks[hook] || [];
       hooks[hook].push(plugin);
     });

lib/commands/create-migration.js

@@ -84,7 +84,8 @@ async function executeCreateMigration (internals, config) {
       (shouldCreateCoffeeFile(internals, config) ? '.coffee' : '.js'),
     path,
     internals.runTimestamp,
-    templateType
+    templateType,
+    internals.plugins
   );
 
   await migration.write();
@@ -132,7 +133,8 @@ async function createSqlFiles (internals, config) {
     internals.argv.title + '-up.sql',
     sqlDir,
     internals.runTimestamp,
-    templateTypeDefaultSQL
+    templateTypeDefaultSQL,
+    internals.plugins
   );
   await migrationUpSQL.write();
 
@@ -144,7 +146,8 @@ async function createSqlFiles (internals, config) {
     internals.argv.title + '-down.sql',
     sqlDir,
     internals.runTimestamp,
-    templateTypeDefaultSQL
+    templateTypeDefaultSQL,
+    internals.plugins
   );
   migrationDownSQL.write();
   log.info(

lib/template.js

@@ -1,9 +1,11 @@
 'use strict';
 
 const File = require('./file.js');
-const dbmUtil = require('db-migrate-shared').util;
+const { util: dbmUtil, log } = require('db-migrate-shared');
 
 const Template = function () {
+  this.plugins = arguments[4];
+  delete arguments[4];
   this.templateType = arguments[3];
   // this is a tweak for node 4 this can be translated
   // to ...arguments instead in upcoming node versions
@@ -257,6 +259,8 @@ Template.TemplateType = {
 };
 
 Template.prototype.getTemplate = function () {
+  let plugin = false;
+
   switch (this.templateType) {
     case Template.TemplateType.DEFAULT_SQL:
       return this.defaultSqlTemplate();
@@ -269,9 +273,29 @@ Template.prototype.getTemplate = function () {
     case Template.TemplateType.SQL_FILE_LOADER_IGNORE_ON_INIT:
       return this.sqlFileLoaderIgnoreOnInitTemplate();
     case Template.TemplateType.DEFAULT_JS:
-    /* falls through */
-    default:
       return this.defaultJsTemplate();
+    default:
+      if (this.plugins) {
+        plugin = this.plugins.overwrite(
+          `template:overwrite:provider:${this.templateType}`
+        );
+      }
+
+      if (plugin !== false) {
+        try {
+          return plugin[`template:overwrite:provider:${this.templateType}`]({
+            file: {
+              name: this.file.name
+            }
+          });
+        } catch (ex) {
+          log.error('Plugin failure "' + plugin.name + '", arborting!');
+
+          throw ex;
+        }
+      } else {
+        return this.defaultJsTemplate();
+      }
   }
 };
 

test/migration_test.js

@@ -6,6 +6,7 @@ const proxyquire = require('proxyquire').noPreserveCache();
 const lab = (exports.lab = Lab.script());
 const Migration = require('../lib/file.js');
 const Template = require('../lib/template.js');
+const Plugins = require('./pluginHelper.js');
 
 const date = createDateForTest();
 const dateString = '20140220143050';
@@ -229,6 +230,84 @@ function getTemplate () {
       });
     });
   });
+
+  lab.experiment('when template plugin is set', function () {
+    lab.experiment('as sql file loader', function () {
+      const name = 'test';
+      const plugins = Plugins.createSinglePlugin(
+        `template:overwrite:provider:${name}`,
+        opts => {
+          return `test all variables`;
+        }
+      );
+      const migration = new Template(fileName, dirName, date, name, plugins);
+
+      lab.test('should return sql file loader template', () => {
+        const actual = migration.getTemplate();
+        Code.expect(actual).to.equal(`test all variables`);
+      });
+    });
+
+    lab.experiment('as default sql', function () {
+      const migration = new Template(
+        fileName,
+        dirName,
+        date,
+        Template.TemplateType.DEFAULT_SQL,
+        internals
+      );
+
+      lab.test('should return default sql template', () => {
+        const actual = migration.getTemplate();
+        Code.expect(actual).to.equal(migration.defaultSqlTemplate());
+      });
+    });
+
+    lab.experiment('as default coffee', function () {
+      const migration = new Template(
+        fileName,
+        dirName,
+        date,
+        Template.TemplateType.DEFAULT_COFFEE,
+        internals
+      );
+
+      lab.test('should return default coffee template', () => {
+        const actual = migration.getTemplate();
+        Code.expect(actual).to.equal(migration.defaultCoffeeTemplate());
+      });
+    });
+
+    lab.experiment('as coffee sql loader', function () {
+      const migration = new Template(
+        fileName,
+        dirName,
+        date,
+        Template.TemplateType.COFFEE_SQL_FILE_LOADER,
+        internals
+      );
+
+      lab.test('should return default coffee template', () => {
+        const actual = migration.getTemplate();
+        Code.expect(actual).to.equal(migration.coffeeSqlFileLoaderTemplate());
+      });
+    });
+
+    lab.experiment('as default javascript', function () {
+      const migration = new Template(
+        fileName,
+        dirName,
+        date,
+        Template.TemplateType.DEFAULT_JS,
+        internals
+      );
+
+      lab.test('should return default sql template', () => {
+        const actual = migration.getTemplate();
+        Code.expect(actual).to.equal(migration.defaultJsTemplate());
+      });
+    });
+  });
 }
 
 function stubApiInstance (isModule, stubs, options, callback) {

test/pluginHelper.js

@@ -0,0 +1,13 @@
+const load = require('../lib/commands');
+
+module.exports = {
+  createSinglePlugin: (name, plugin) => {
+    return load('fn/plugin.js')({
+      [name]: [
+        {
+          [name]: plugin
+        }
+      ]
+    });
+  }
+};