added --modularize option

Author: tmont

README.md

@@ -59,30 +59,32 @@ Omitting it will assume a schema of "public".
 
 #### `--help`
 ```
-  Usage: node-sql-generate [options]
+  Usage: node-sql-generate.js [options]
 
   Options:
 
-    -h, --help                utput usage information
+    -h, --help                output usage information
     -V, --version             output the version number
+    --dsn <dsn>               Connection string
     -d, --dialect <dialect>   Specify the SQL dialect: "mysql" or "pg"
     -o, --output-file <file>  Output to this file; defaults to stdout
     -i, --indent <token>      Indentation token; defaults to a TAB character
     -D, --database <name>     Name of database to extract from
     -s, --schema <name>       Name of schema to extract from (Postgres only)
-    --camelize                Convert underscored names to camel case ("foo_bar" -> "fooBar")
+    --camelize                Convert underscored names to camel case, requires sql >= 0.18.0"
     --eol <token>             Line terminator token; defaults to "\n"
     --mode <mode>             The permission mode of the generated file; defaults to 0644
     --encoding <encoding>     The encoding to use for writing; defaults to "utf8"
     --prepend <text>          Prepend text to the beginning of the file
     --append <text>           Append text to the end of the file
-    --dsn <dsn>               Connection string
+    --modularize              Omit "require('sql')" and wrap generated code in "module.exports = function(sql) {...}"
     --omit-comments           Omit autogenerated comments
+    --include-schema          Include schema in definition
     -v, --verbose             Print debugging information
 
 Example DSN:
-  PostgreSQL: "postgres://user:password@host/database"
-       MySQL: "mysql://user:password@host/database"
+  PostgreSQL: "postgres://user:password@host:5432/database"
+       MySQL: "mysql://user:password@host:3306/database"
 ```
 
 ### API

bin/node-sql-generate.js

@@ -17,6 +17,7 @@ program
 	.option('--encoding <encoding>', 'The encoding to use for writing; defaults to "utf8"', 'utf8')
 	.option('--prepend <text>', 'Prepend text to the beginning of the file')
 	.option('--append <text>', 'Append text to the end of the file')
+	.option('--modularize', 'Omit "require(\'sql\')" and wrap generated code in "module.exports = function(sql) {...}"')
 	.option('--omit-comments', 'Omit autogenerated comments', false)
 	.option('--include-schema', 'Include schema in definition', false)
 	.option('-v, --verbose', 'Print debugging information', false)

index.js

@@ -24,6 +24,7 @@ var supportedDialects = {
  * @param {String} [options.append] String to append to the end of the generated output
  * @param {String} [options.omitComments] Omit autogenerated comments
  * @param {String} [options.includeSchema] Include schema in definition
+ * @param {String} [options.modularize] Omit require('sql') and wrap generated code in module.exports = function() {...}
  * @param {function} [options.log] Logging function
  * @param {Function} [callback]
  */
@@ -285,9 +286,15 @@ module.exports = function(options, callback) {
 			});
 		}
 
-		functions.push(function(next) {
-			write('var sql = require(\'sql\');', options.eol, next);
-		});
+		if (options.modularize) {
+			functions.push(function(next) {
+				write('module.exports = function(sql) {', options.eol, next);
+			});
+		} else {
+			functions.push(function(next) {
+				write('var sql = require(\'sql\');', options.eol, next);
+			});
+		}
 
 		async.series(functions, next);
 	}
@@ -301,7 +308,9 @@ module.exports = function(options, callback) {
 
 	function processTables(next) {
 		function writeTable(tableName, next) {
-			var start = Date.now();
+			var start = Date.now(),
+				//indent everything by one if modularize is set
+				indent = options.modularize ? options.indent : '';
 			log('info', 'Starting ' + options.schema + '.' + tableName + '...');
 			getListOfColumns(tableName, function(err, columnData) {
 				if (err) {
@@ -315,20 +324,20 @@ module.exports = function(options, callback) {
 					fullName = (options.schema || options.database) + '.' + tableName;
 
 				if (!options.omitComments) {
-					args.push('/**');
-					args.push(' * SQL definition for ' + fullName);
-					args.push(' */');
+					args.push(indent + '/**');
+					args.push(indent + ' * SQL definition for ' + fullName);
+					args.push(indent + ' */');
 				}
 
-				args.push('exports.' + camelize(tableName) + ' = sql.define({');
-				args.push(options.indent + 'name: \'' + tableName + '\',');
+				args.push(indent + 'exports.' + camelize(tableName) + ' = sql.define({');
+				args.push(indent + options.indent + 'name: \'' + tableName + '\',');
 				if (options.includeSchema) {
-					args.push(options.indent + 'schema: \'' + (options.schema || options.database) + '\',');
+					args.push(indent + options.indent + 'schema: \'' + (options.schema || options.database) + '\',');
 				}
-				args.push(options.indent + 'columns: [');
+				args.push(indent + options.indent + 'columns: [');
 
 				args.push(columnData.map(function(column) {
-					var columnString = options.indent + options.indent + '{ ' +
+					var columnString = indent + options.indent + options.indent + '{ ' +
 						'name: \'' + column.name + '\'';
 
 					if (options.camelize) {
@@ -339,8 +348,8 @@ module.exports = function(options, callback) {
 					return columnString;
 				}).join(',' + options.eol));
 
-				args.push(options.indent + ']');
-				args.push('});');
+				args.push(indent + options.indent + ']');
+				args.push(indent + '});');
 				args.push(options.eol);
 
 				args.push(function(err) {
@@ -359,10 +368,23 @@ module.exports = function(options, callback) {
 	}
 
 	function writeTail(next) {
-		if (options.append) {
-			write(options.append, next);
+		if (options.modularize) {
+			write('};', tail);
 		} else {
-			process.nextTick(next);
+			tail();
+		}
+
+		function tail(err) {
+			if (err) {
+				next(err);
+				return;
+			}
+
+			if (options.append) {
+				write(options.append, next);
+			} else {
+				process.nextTick(next);
+			}
 		}
 	}
 

tests/expected/modularize.js

@@ -0,0 +1,30 @@
+
+module.exports = function(sql) {
+
+
+	/**
+	 * SQL definition for node_sql_generate.bar
+	 */
+	exports.bar = sql.define({
+		name: 'bar',
+		columns: [
+			{ name: 'id' },
+			{ name: 'foo_id' }
+		]
+	});
+
+
+	/**
+	 * SQL definition for node_sql_generate.foo
+	 */
+	exports.foo = sql.define({
+		name: 'foo',
+		columns: [
+			{ name: 'id' },
+			{ name: 'field_1' },
+			{ name: 'foo_bar_baz' }
+		]
+	});
+
+
+};

tests/generator-tests.js

@@ -223,6 +223,15 @@ describe('generator', function() {
 						done();
 					});
 				});
+
+				it('with modularization', function(done) {
+					generate(options({ modularize: true }, defaults), function(err, stats) {
+						should.not.exist(err);
+						var expected = getExpected('modularize');
+						removeAutogeneratedComment(stats.buffer).should.equal(expected);
+						done();
+					});
+				});
 			});
 		}(dsn, db, dialect));
 	}