* Added simple report generation to CSV file

Author: mmoczulski

lib/csvReport.js

@@ -0,0 +1,71 @@
+"use strict";
+
+var HEADER = "Table,Column,Before,After,Changes";
+var fs = require("fs");
+var os = require("os");
+var constants = require("./constants");
+var format = require("util").format;
+
+var LABELS = {};
+var DIFF_WRITERS = {};
+
+
+LABELS[constants.ADDED_COLUMN] = "Added";
+DIFF_WRITERS[constants.ADDED_COLUMN] = function (stream, tableName, difference) {
+    stream.write(format("%s,%s,,,%s", tableName, difference.definition,
+        LABELS[constants.ADDED_COLUMN]));
+};
+
+LABELS[constants.ADDED_TABLE] = "Table added";
+DIFF_WRITERS[constants.ADDED_TABLE] = function (stream, tableName, difference) {
+    stream.write(format("%s,%s,,,%s", tableName, tableName, LABELS[constants.ADDED_TABLE]));
+};
+
+LABELS[constants.CHANGED_COLUMN_NAME] = "Name";
+DIFF_WRITERS[constants.CHANGED_COLUMN_NAME] = function (stream, tableName, difference) {
+    stream.write(format("%s,%s,%s,,%s", tableName, difference.name, difference.from,
+        LABELS[constants.CHANGED_COLUMN_NAME]));
+};
+
+LABELS[constants.CHANGED_COLUMN_OBLIGATION] = "Essentiality type";
+DIFF_WRITERS[constants.CHANGED_COLUMN_OBLIGATION] = function (stream, tableName, difference) {
+    stream.write(format("%s,%s,%s,%s,%s", tableName, difference.name, nullability(difference.from),
+        nullability(difference.to), LABELS[constants.CHANGED_COLUMN_OBLIGATION]));
+};
+function nullability(isMandatory) {
+    return isMandatory ? "NOT NULL" : "NULL";
+}
+
+LABELS[constants.CHANGED_COLUMN_TYPE] = "Data type";
+DIFF_WRITERS[constants.CHANGED_COLUMN_TYPE] = function (stream, tableName, difference) {
+    stream.write(format("%s,%s,%s,%s,%s", tableName, difference.name, difference.from, difference.to,
+        LABELS[constants.CHANGED_COLUMN_TYPE]));
+};
+
+LABELS[constants.REMOVED_COLUMN] = "Removed";
+DIFF_WRITERS[constants.REMOVED_COLUMN] = function (stream, tableName, difference) {
+    stream.write(format("%s,%s,,,%s", tableName, difference.name, LABELS[constants.REMOVED_COLUMN]));
+};
+
+
+LABELS[constants.REMOVED_TABLE] = "Table removed";
+DIFF_WRITERS[constants.REMOVED_TABLE] = function (stream, tableName, difference) {
+    stream.write(format("%s,%s,,,%s", tableName, tableName, LABELS[constants.REMOVED_TABLE]));
+};
+
+exports.generate = function (differences, fileName, done) {
+
+    var stream = fs.createWriteStream(fileName);
+
+    stream.write(HEADER + os.EOL);
+
+    differences.forEach(function (differencesInTable) {
+        differencesInTable.forEach(function (difference) {
+            DIFF_WRITERS[difference.type](stream, differencesInTable.tableName, difference);
+            stream.write(os.EOL);
+        });
+    });
+    stream.end();
+
+    done(null);
+};

lib/diff.js

@@ -2,12 +2,20 @@
 
 var loader = require("./definitionLoader");
 var processor = require("./diffProcessor");
+var reporter = require("./csvReport");
 
 exports.findDifferences = function (options) {
     loader.loadSqlFiles(options.left, options.right, function(sqlDefinitions) {
 
-        var differences = sqlDefinitions.map(processor.loadSqlFiles);
+        var differences = sqlDefinitions.map(processor.processSqlDefinitions);
 
-        options.done(differences);
+        reporter.generate(differences, options.output, function (err) {
+            if (err) {
+                console.error("An error occurred during generation of report", err);
+                process.exit(-1);
+            }
+
+            options.done();
+        });
     });
 };

lib/diffProcessor.js

@@ -2,8 +2,9 @@
 
 var constants = require("./constants");
 
-exports.loadSqlFiles = function(sqlDefinition) {
+exports.processSqlDefinitions = function(sqlDefinition) {
     var diff = [];
+    diff.tableName = sqlDefinition.newTableName;
 
     if (sqlDefinition.newTableName !== sqlDefinition.oldTableName) {
         diff.push({

sql-diff.js

@@ -4,10 +4,11 @@ var fs = require("fs");
 var async = require("async");
 var path = require("path");
 var args = require("optimist").
-    usage("Usage: $0 --left [path] --right [path]").
-    demand(["left", "right"]).
+    usage("Usage: $0 --output [path] --left [path] --right [path]").
+    demand(["left", "right", "output"]).
     describe("left", "Left folder (earlier one) to compare").
     describe("right", "Right folder (later one) to compare").
+    describe("output", "The name of file, to which report will be generated").
     argv;
 
 
@@ -40,6 +41,7 @@ async.each([leftDir, rightDir], directoryExists, function(err) {
         diff.findDifferences({
             left: leftDirectory,
             right: rightDirectory,
+            output: args.output,
             done: function () {
                 console.log("Job finished successfully");
             }