Adding a lot of events and extracting output to separate module

Author: joakimbeng

bin/klei-migrate

@@ -1,8 +1,6 @@
 #!/usr/bin/env node
 
-var cli = require('../lib/cli');
+var cli = require('../lib/cli'),
+    reporter = require('../lib/reporter');
 
-cli.init().exec(function () {
-    console.log(arguments);
-    process.exit();
-});
+cli.init().reporter(reporter).exec();

lib/cli.js

@@ -22,9 +22,7 @@ var options = {
   commands = {
     run: "Run migrations",
     create: "Create a new migration (optional name as [arguments])",
-    dry: "List what is able to migrate (according to direction and limit)",
-    help: "Show this usage information",
-    version: "Show version information"
+    dry: "List what is able to migrate (according to direction and limit)"
   },
   aliases = {
     status: "dry",
@@ -39,7 +37,13 @@ exports.init = function (args) {
   var parsed = nopt(noptions.full, noptions.short, args, args ? 0 : 2),
       argv = parsed.argv.remain || [];
 
-  this.command(argv.shift());
+  try {
+    this.command(argv.shift());
+  } catch (e) {
+    this.help();
+    console.error('\n' + e.message.red + '\n');
+    process.exit(1);
+  }
   this._showVersion = parsed.version;
   this._showHelp = parsed.help || this.command() === 'help';
   this.migrate = migrate;
@@ -55,6 +59,19 @@ exports.init = function (args) {
   return this;
 };
 
+/**
+ * Set reporter
+ *
+ * @param {Function} reporter
+ */
+exports.reporter = function (reporter) {
+  if (!this.migrate) {
+    throw new Error('Initialize the cli with init() first!');
+  }
+  this.reporter = reporter(this.migrate);
+  return this;
+};
+
 /**
  * Execute current klei-migrate command
  */
@@ -133,6 +150,83 @@ exports.command = function (newCommand) {
   return this._newCommand = this._newCommand || 'help';
 };
 
+/**
+ * Set printer/output handler
+ *
+ * @param {Function} newPrinter
+ */
+exports.printer = function (newPrinter) {
+  if (newPrinter) {
+    this._printer = newPrinter;
+    return this;
+  }
+  return this._printer = this._printer || function () { /* noop */ };
+};
+
+/**
+ * Log message to printer
+ *
+ * @param {String} msg
+ */
+exports.log = function (msg) {
+  this.printer()(msg);
+  return this;
+};
+
+/**
+ * Log info messages
+ *
+ * @param {String} msg
+ */
+exports.info = function (msg) {
+  return this.log(msg.yellow);
+};
+
+/**
+ * Log debug messages
+ *
+ * @param {String} msg
+ */
+exports.debug = function (msg) {
+  return this.log(msg.grey);
+};
+
+/**
+ * Log successful messages
+ *
+ * @param {String} msg
+ */
+exports.success = function (msg) {
+  return this.log(msg.green);
+};
+
+/**
+ * Log bad messages
+ *
+ * @param {String} msg
+ */
+exports.bad = function (msg) {
+  return this.log(msg.red);
+};
+
+/**
+ * Log errors
+ *
+ * @param {Error} err
+ * @param {String} heading
+ */
+exports.error = function (err, heading) {
+  if (heading) {
+    this.log(heading.bold.red);
+  }
+  if (err instanceof Error) {
+    this.log(err.stack.red);
+  } else {
+    this.log(err.toString().red);
+  }
+  return this;
+};
+
 function getOptionsForNopt () {
   var result = {short: {}, full: {}};
   Object.keys(options).forEach(function (key) {

lib/migrate.js

@@ -68,18 +68,27 @@ exports.create = function (cb) {
   var name = +new Date + '_' + (this.args().join(' ').replace(/[\s\.]+/g, '_') || 'migration') + '.js';
 
   var dir = this.directory();
+
+  ee.emit('create:init');
+
   ensureExistingMigrationsDir(dir, function (err) {
     if (err) {
-      cb(err);
+      error(err, cb);
       return;
     }
     exports.template(function (err, template) {
       if (err) {
-        cb(err);
+        error(err, cb);
         return;
       }
+      ee.emit('create:ready', name, dir);
       fs.writeFile(join(dir, name), template, 'utf8', function (err) {
-        cb(err, name);
+        if (err) {
+          error(err, cb);
+        } else {
+          ee.emit('create:success', name, dir);
+          cb && cb(null, name);
+        }
       });
     });
   });
@@ -170,41 +179,12 @@ exports.directory = function (newDirectory) {
  * @param {Function} cb
  */
 exports.dry = function (cb) {
-  var dir = this.directory(),
-      name = this.args().join(' ');
-  fs.readdir(dir, function (err, files) {
-    if (err) {
-      cb([], {});
-      return;
-    }
-    fs.readJson(join(dir, '.migrated.json'), function (err, migrated) {
-      if (err || !migrated) {
-        migrated = {};
-      }
-
-      var down = isDown(exports.direction()),
-          limit = exports.limit();
-
-      var migratable = files.filter(function (file) {
-        return /^[0-9]{13}_.*\.js$/.test(file)
-            && (down && migrated[file] || !down && !migrated[file])
-            && (!name || !limit && (down && name <= file || !down && name >= file) || limit && name == file);
-      });
-
-      migratable.sort();
-
-      if (down) {
-        migratable.reverse();
-      }
-
-      if (limit && migratable.length > 1) {
-        migratable = [migratable.shift()];
-      }
+  ee.emit('dry:init');
 
-      cb(migratable, migrated);
-    });
+  return this.migratables(function (migratable, migrated) {
+    ee.emit('dry:success', migratable, migrated);
+    cb && cb(migratable, migrated);
   });
-  return this;
 };
 
 /**
@@ -215,11 +195,24 @@ exports.dry = function (cb) {
 exports.run = function (cb) {
   var self = this;
 
-  return this.dry(function (migratable, migrated) {
+  ee.emit('run:init');
+
+  return this.migratables(function (migratable, migrated) {
+    ee.emit('run:ready', migratable, migrated);
+
+    if (!migratable.length) {
+      cb && cb(null, []);
+      return;
+    }
+
     var migratedNow = [];
     function next (err, file) {
-      if (err || !file) {
-        cb(err, migratedNow);
+      if (err) {
+        cb ? cb(err, migratedNow) : ee.emit('error', err);
+        return;
+      } else if (!file) {
+        ee.emit('run:success', migratedNow);
+        cb && cb(null, migratedNow);
         return;
       }
 
@@ -230,6 +223,7 @@ exports.run = function (cb) {
           }, self.timeout());
 
       try {
+        ee.emit('run:migrate:before', file);
         var migration = loadMigration(self.directory(), file);
         migration[self.direction()](function (err) {
           if (hasTimedout) {
@@ -238,12 +232,15 @@ exports.run = function (cb) {
           clearTimeout(timeoutId);
           if (!err) {
             migratedNow.push(file);
+            ee.emit('run:migrate:after', file);
             saveProgress(migrated, file, doNext);
           } else {
+            ee.emit('run:migrate:fail', err, file);
             doNext(err);
           }
         });
       } catch (e) {
+        ee.emit('run:migrate:fail', e, file);
         next(e);
       }
     }
@@ -256,54 +253,68 @@ exports.run = function (cb) {
   });
 };
 
-/**
- * Add event listener for event
- *
- * @param {String} event
- * @param {Function} cb Listener
- */
-exports.on = function (event, cb) {
-  ee.on(event, cb);
-};
+exports.migratables = function (cb) {
+  var self = this,
+      dir = this.directory(),
+      name = this.args().join(' ');
+  fs.readdir(dir, function (err, files) {
+    if (err) {
+      cb([], {});
+      return;
+    }
+    fs.readJson(join(dir, '.migrated.json'), function (err, migrated) {
+      if (err || !migrated) {
+        migrated = {};
+      }
 
-/**
- * Trigger output event (with optional level)
- *
- * @param {String} msg
- * @param {String} level
- */
-exports.output = function (msg, level) {
-  ee.emit('output', msg);
-  if (level) {
-    ee.emit('output:' + level, msg);
-  }
-};
+      var down = isDown(exports.direction()),
+          limit = exports.limit();
 
-/**
- * Trigger output:info event
- *
- * @param {String} msg
- */
-exports.info = function (msg) {
-  this.output(msg, 'info');
-};
+      var migratable = files.filter(function (file) {
+        if (!/^[0-9]{13}_.*\.js$/.test(file))
+          return false;
 
-/**
- * Trigger output:debug event
- *
- * @param {String} msg
- */
-exports.debug = function (msg) {
-  this.output(msg, 'debug');
+        if (down && !migrated[file] || !down && migrated[file])
+          return false;
+
+        if (limit === 1 && name && name !== file) {
+          return false;
+        }
+
+        if (name && down && name > file)
+          return false;
+
+        if (name && !down && name < file)
+          return false;
+
+        return true;
+      });
+
+      migratable.sort();
+
+      if (down) {
+        migratable.reverse();
+      }
+
+      if (limit) {
+        migratable = migratable.slice(0, limit);
+      }
+
+      cb(migratable, migrated);
+    });
+  });
+  return this;
 };
 
 /**
- * Trigger output:success event
+ * Add event listener for event
  *
- * @param {String} msg
+ * @param {String} event
+ * @param {Function} cb Listener
  */
-exports.success = function (msg) {
-  this.output(msg, 'success');
+exports.on = function (event, cb) {
+  ee.on(event, cb);
+  return this;
 };
 
 exports.error = function (err, heading) {
@@ -354,3 +365,7 @@ function isDirection (str) {
 function isDown (str) {
   return str === 'down';
 }
+
+function error (err, cb) {
+  cb ? cb(err) : ee.emit('error', err);
+}