index.js
33.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
/**
* @module
* @author Özüm Eldoğan
*/
/*jslint node: true, nomen: true, regexp: true */
/*global __dirname */
"use strict";
process.env.SUPPRESS_NO_CONFIG_WARNING = true;
var fs = require('fs-extra');
var path = require('path');
var pgStructure = require('pg-structure');
var cons = require('consolidate');
var async = require('async');
var beautify = require('js-beautify').js_beautify;
var inflection = require('inflection');
var config = require('config');
var lodash = require('lodash');
var jsonStringfy = require('json-stable-stringify');
var winston = require('winston');
var sequelizeTypes = require('./sequelize-types.js');
var util = require('util');
var logger = new (winston.Logger)({
transports: [
new (winston.transports.Console)({ level: 'info' }),
new (winston.transports.File)({ level: 'error', filename: 'sequelize-pg-generator.log', timestamp: true })
]
});
var overriddenAliases = {};
var newAliases = {};
require('./_polyfill-quote.js'); // add String's prototype quote function.
/**
* @private
* @typedef {Object} template
* @property {string} engine - Template engine to use.
* @property {string} extension - File extension to use in template files.
* @property {string} folder - Template folder to look for templates.
*/
/**
* Gets requested config by prefixing the key with 'sequelize-pg-generator.'
* As a result getConfig('database.host') returns result of config.get('sequelize-pg-generator.database.host')
* @private
* @param configKey
* @returns {Object|any}
*/
function getConfig(configKey) {
configKey = 'sequelize-pg-generator.' + configKey;
return config.get(configKey);
}
/**
* Gets requested config value. Returns more specific config for table if there is one, returns general otherwise.
* Specific configs are config keys having suffix "Override".
* @private
* @param {string} table - Name of the table. This will be used to find specific config for the table.
* @param {string} configName - Configuration name to look for.
* @returns {*}
* @example
* var config = {
* "generate": {
* "columnDescription": false
* },
* "generateOverride: {
* "account": {
* "columnDescription": true
* }
* }
* };
*
* console.log(getSpecificConfig('contact.columnDescription')); // false
* console.log(getSpecificConfig('account.columnDescription')); // true
*/
function getSpecificConfig(table, configName) {
var specific = configName.replace(/^(.+?)\./, '$1Override.' + table + '.'); // generateOverride.product_category.columnDefault
return config.has(specific) ? getConfig(specific) : getConfig(configName);
}
/**
* Renders the template and executes callback function.
* @private
* @param {string} filePath - Path of the template file relative to template folder.
* @param {object} locals - Local variables to pass to template
* @param {function} fn - Callback function(err, output)
*/
function template(filePath, locals, fn) {
filePath = path.join(getConfig('template.folder'), filePath + '.' + getConfig('template.extension')); // i.e. index -> index.ejs
return cons[getConfig('template.engine')].call(null, filePath, locals, fn); // i.e. cons.swig('views/page.html', { user: 'tobi' }, function(err, html){}
}
/**
* Parses by reverse engineering using pgStructure module and calls callback.
* @private
* @param {function} callback - Callback function(err, structure)
*/
function parseDB(callback) {
pgStructure(getConfig('database.host'), getConfig('database.database'), getConfig('database.user'),
getConfig('database.password'), { port: getConfig('database.port'), schema: getConfig('database.schema') },
callback);
}
/**
* Given plain object, this function does the following:
* - Strips null or undefined values from object,
* - Add quotes around string values
* @private
* @param {object} obj - Simple object to filter.
* @returns {object}
*/
function filterAttributes(obj) {
var attribute;
for (attribute in obj) {
if (obj.hasOwnProperty(attribute)) {
if (obj[attribute] === undefined || obj[attribute] === null) {
delete obj[attribute];
} else if (lodash.isString(obj[attribute])) {
obj[attribute] = obj[attribute] // DO NOT quote type string. It is a JS variable.
}
}
}
return obj;
}
/**
* Clears SQL type escapes (Two quote '' to one quote ') and strips beginning and trailing quotes around string.
* @private
* @param {string} string - Default
* @returns {string|boolean|undefined}
* @example
* var clear = clearDefaultValue("'No ''value'' given'");
* console.log(clear); // No value 'given'
*/
function clearDefaultValue(string) {
// Does not support SQL functions. IMHO it is better to handle sql function default values in RDMS.
var defaultValue = undefined, lowercaseString, booleanValue;
if (string.charAt(0) === "'" || string.charAt(0) === '"') {
string = string.substring(1, string.length - 1);
defaultValue = string.replace(/''/g, "'");
} else {
lowercaseString = string.toLowerCase()
booleanValue = (lowercaseString === 'true');
if (booleanValue || lowercaseString === 'false') {
defaultValue = booleanValue;
}
}
return defaultValue;
}
/**
* Calculates belongsTo relation name based on table, column and config.
* @private
* @param {object} fkc - pg-structure foreign key constraint object.
* @returns {string} - Name for the belongsTo relationship.
*/
function getBelongsToName(fkc) {
var as = fkc.foreignKey(0).name(), // company_id
tableName = fkc.table().name(),
camelCase = getSpecificConfig(tableName, 'generate.relationAccessorCamelCase'),
prefix = getSpecificConfig(tableName, 'generate.prefixForBelongsTo'); // related
if (as.match(/_id$/i)) {
as = as.replace(/_id$/i, ''); // company_id -> company
} else {
as = prefix + '_' + as; // company -> related_company
}
if (camelCase) {
as = inflection.camelize(inflection.underscore(as), true);
}
return inflection.singularize(as);
}
/**
* Calculates belongsToMany relation name based on table, column and config.
* @private
* @param {object} hasManyThrough - pg-structure foreign key constraint object.
* @returns {string} - Name for the belongsToMany relationship.
*/
function getBelongsToManyName(hasManyThrough) {
var tfkc = hasManyThrough.throughForeignKeyConstraint(),
as = tfkc.foreignKey(0).name(), // company_id
throughTableName = hasManyThrough.through().name(),
relationName = hasManyThrough.throughForeignKeyConstraintToSelf().name(),
tableName = hasManyThrough.table().name(),
camelCase = getSpecificConfig(tableName, 'generate.relationAccessorCamelCase'),
prefix = getSpecificConfig(tableName, 'generate.prefixForBelongsTo'); // related
if (getSpecificConfig(tableName, 'generate.addRelationNameToManyToMany')) {
if (getSpecificConfig(tableName, 'generate.stripFirstTableNameFromManyToMany')) {
relationName = relationName.replace(new RegExp('^' + tableName + '[_-]?', 'i'), ''); // cart_cart_line_items -> cart_line_item
}
as = inflection.singularize(relationName) + '_' + as;
} else if (getSpecificConfig(tableName, 'generate.addTableNameToManyToMany')) {
as = inflection.singularize(throughTableName) + '_' + as;
}
if (as.match(/_id$/i)) {
as = as.replace(/_id$/i, ''); // company_id -> company
} else {
as = prefix + '_' + as; // company -> related_company
}
if (camelCase) {
as = inflection.camelize(inflection.underscore(as), true);
}
return inflection.pluralize(as);
}
/**
* Calculates hasMany relation name based on table, column and config.
* @private
* @param {object} hasMany - pg-structure foreign key constraint object.
* @returns {string} - Name for the belongsTo relationship.
*/
function getHasManyName(hasMany) {
var as, tableName;
if (hasMany.through() !== undefined) {
as = getBelongsToManyName(hasMany); //inflection.pluralize(getBelongsToName(hasMany.throughForeignKeyConstraint()));
} else {
as = inflection.pluralize(hasMany.name()); // cart_cart_line_items
tableName = hasMany.table().name();
if (getSpecificConfig(tableName, 'generate.stripFirstTableFromHasMany')) {
as = as.replace(new RegExp('^' + tableName + '[_-]?', 'i'), ''); // cart_cart_line_items -> cart_line_items
}
if (getSpecificConfig(tableName, 'generate.relationAccessorCamelCase')) {
as = inflection.camelize(inflection.underscore(as), true); // cart_line_items -> cartLineItems
}
}
return as;
}
/**
* Calculates model name for given table.
* @private
* @param {object} table - pg-structure table object.
* @returns {string} - Model name for table
*/
function getModelNameFor(table) {
var schemaName = getSpecificConfig(table.name(), 'generate.modelCamelCase') ? inflection.camelize(inflection.underscore(table.schema().name()), true) : table.schema().name(),
tableName = getSpecificConfig(table.name(), 'generate.modelCamelCase') ? inflection.camelize(inflection.underscore(table.name()), true) : table.name();
return getSpecificConfig(table.name(), 'generate.useSchemaName') ? schemaName + '.' + tableName : tableName;
}
/**
* Returns table details as plain object to use in templates.
* @private
* @param table
* @returns {Object}
*/
function getTableOptions(table) {
logger.debug('table details are calculated for: %s', table.name());
var specificName = 'tableOptionsOverride.' + table.name(),
specificOptions = config.has(specificName) ? getConfig(specificName) : {},
generalOptions = getConfig('tableOptions'),
otherOptions = {
modelName : getModelNameFor(table),
tableName : table.name(),
schema : table.schema().name(),
comment : getSpecificConfig(table.name(), 'generate.tableDescription') ? table.description() : undefined,
columns : [],
hasManies : [],
belongsTos : [],
belongsToManies : []
},
tableOptions = filterAttributes(lodash.defaults(specificOptions, generalOptions, otherOptions));
tableOptions.baseFileName = table.name();
return tableOptions;
}
/**
* Returns Sequelize ORM datatype for column.
* @param {Object} column - pg-structure column object.
* @param {string} [varName = DataTypes] - Variable name to use in sequelize data type. ie. 'DataTypes' for DataTypes.INTEGER
* @returns {string}
* @private
* @example
* var typeA = column.sequelizeType(); // DataTypes.INTEGER(3)
* var typeB = column.sequelizeType('Sequelize'); // Sequelize.INTEGER(3)
*/
function sequelizeType(column, varName) {
varName = varName || 'DataTypes'; // DataTypes.INTEGER etc. prefix
var enumValues = column.enumValues();
var type = enumValues ? '.ENUM' : sequelizeTypes[column.type()].type;
var realType = column.arrayDimension() >= 1 ? column.arrayType() : column.type(); // type or type of array (if array).
var hasLength = sequelizeTypes[realType].hasLength;
var hasPrecision = sequelizeTypes[realType].hasPrecision;
var isObject = type && type.indexOf('.') !== -1; // . ile başlıyorsa değişkene çevirmek için
var details;
var isArrayTypeObject;
if (isObject) { type = varName + type; }
details = function(num1, num2) {
var detail = '';
if (num1 >= 0 && num1 !== null && num2 && num2 !== null) {
detail = '(' + num1 + ',' + num2 + ')'; // (5,2)
} else if (num1 >= 0 && num1 !== null) {
detail = '(' + num1 + ')'; // (5)
}
return detail;
};
if (column.arrayDimension() >= 1) {
isArrayTypeObject = sequelizeTypes[column.arrayType()].type.indexOf('.') !== -1;
type += '(';
if (column.arrayDimension() > 1) { type += new Array(column.arrayDimension()).join(varName + '.ARRAY('); } // arrayDimension -1 tane 'ARRAY(' yaz
type += isArrayTypeObject ? varName : "'";
type += sequelizeTypes[column.arrayType()].type;
type += isArrayTypeObject ? '' : "'";
}
if (enumValues) {
enumValues = util.inspect(enumValues.substring(1, enumValues.length - 1).split(',')); // Strip { and } -> make array -> makeJSON;
enumValues = enumValues.substring(2, enumValues.length - 2); // Strip '[ ' and ' ]'
type += '(' + enumValues + ')';
}
if (hasPrecision) {
type += details(column.precision(), column.scale());
}
if (hasLength) {
type += details(column.length());
}
if (column.arrayDimension() >= 1) {
type += new Array(column.arrayDimension() + 1).join(')'); // arrayDimension -1 tane ) yaz
}
if (!isObject) {
type = "'" + type + "'";
}
return type;
};
/**
* Returns column details as plain object to use in templates.
* @private
* @param {object} column - pg-structure column object
* @returns {Object} - Simple object to use in template
*/
function getColumnDetails(column) {
logger.debug('column details are calculated for: %s', column.name());
var result = filterAttributes({
source : 'generator',
accessorName : getSpecificConfig(column.table().name(), 'generate.columnAccessorCamelCase') ? inflection.camelize(inflection.underscore(column.name()), true) : column.name(),
name : column.name(),
primaryKey : column.isPrimaryKey(),
autoIncrement : column.isAutoIncrement() && getSpecificConfig(column.table().name(), 'generate.columnAutoIncrement') ? true : undefined,
allowNull : column.allowNull(),
defaultValue : getSpecificConfig(column.table().name(), 'generate.columnDefault') && column.default() !== null ? clearDefaultValue(column.default()) : undefined,
unique : column.unique(),
comment : getSpecificConfig(column.table().name(), 'generate.columnDescription') ? column.description() : undefined,
references : column.foreignKeyConstraint() ? getModelNameFor(column.foreignKeyConstraint().referencesTable()) : undefined,
referencesKey : column.foreignKeyConstraint() ? column.foreignKeyConstraint().foreignKey(0).name() : undefined,
onUpdate : column.onUpdate(),
onDelete : column.onDelete()
});
result.type = sequelizeType(column, getSpecificConfig(column.table().name(), 'generate.dataTypeVariable')); // To prevent type having quotes.
//result.type = column.sequelizeType(getSpecificConfig(column.table().name(), 'generate.dataTypeVariable')); // To prevent type having quotes.
return result;
}
function getAlias(table, as, type) {
var model = getModelNameFor(table);
if (!newAliases[model]) newAliases[model] = {};
if (!newAliases[model][type]) newAliases[model][type] = {};
if (!overriddenAliases[model]) overriddenAliases[model] = {};
if (!overriddenAliases[model][type]) overriddenAliases[model][type] = {};
newAliases[model][type][as] = overriddenAliases[model][type][as] || null; // If set by user, add it to new created file.
return newAliases[model][type][as] || as;
}
/**
* Returns hasMany details as plain object to use in templates.
* @private
* @param {object} hasMany - pg-structure hasMany object
* @returns {Object} - Simple object to use in template
*/
function getHasManyDetails(hasMany) {
logger.debug('hasMany%s details are calculated for: %s', hasMany.through() ? 'through' : '', hasMany.name());
var model = getModelNameFor(hasMany.referencesTable()),
as = getHasManyName(hasMany);
return filterAttributes({
type : 'hasMany',
source : 'generator',
name : hasMany.name(),
model : model,
as : getAlias(hasMany.table(), as, 'hasMany'),
targetSchema : hasMany.referencesTable().schema().name(),
targetTable : hasMany.referencesTable().name(),
foreignKey : hasMany.foreignKey(0).name(), // Sequelize support single key only
onDelete : hasMany.onDelete(),
onUpdate : hasMany.onUpdate(),
through : hasMany.through() ? hasMany.through().name() : undefined
});
}
/**
* Returns belongsTo details as plain object to use in templates.
* @private
* @param {object} fkc - pg-structure belongsTo object
* @returns {Object} - Simple object to use in template
*/
function getBelongsToDetails(fkc) {
logger.debug('belongsTo details are calculated for: %s', fkc.name());
var model = getModelNameFor(fkc.referencesTable()),
as = getBelongsToName(fkc);
return filterAttributes({
type : 'belongsTo',
source : 'generator',
name : fkc.name(),
model : model,
as : getAlias(fkc.table(), as, 'belongsTo'),
targetSchema : fkc.referencesTable().schema().name(),
targetTable : fkc.referencesTable().name(),
foreignKey : fkc.foreignKey(0).name(), // Sequelize support single key only
onDelete : fkc.onDelete(),
onUpdate : fkc.onUpdate()
});
}
/**
* Returns belongsToMany details as plain object to use in templates.
* @private
* @param {object} hasManyThrough - pg-structure hasManyThrough object
* @returns {Object} - Simple object to use in template
*/
function getBelongsToManyDetails(hasManyThrough) {
logger.debug('belongsToMany details are calculated for: %s', hasManyThrough.name());
var model = getModelNameFor(hasManyThrough.referencesTable()),
as = getBelongsToManyName(hasManyThrough);
return filterAttributes({
type : 'belongsToMany',
source : 'generator',
name : hasManyThrough.name(),
model : model,
as : getAlias(hasManyThrough.table(), as, 'belongsToMany'),
targetSchema : hasManyThrough.referencesTable().schema().name(),
targetTable : hasManyThrough.referencesTable().name(),
foreignKey : hasManyThrough.foreignKey(0).name(), // Sequelize support single key only
otherKey : hasManyThrough.throughForeignKeyConstraint().foreignKey(0).name(), // Sequelize support single key only
onDelete : hasManyThrough.onDelete(),
onUpdate : hasManyThrough.onUpdate(),
through : hasManyThrough.through().name()
});
}
/**
* Calculates and returns file name based on schema and table.
* @private
* @param {object} table - pg-structure table object
* @returns {string} - file name for the model
*/
function getFileName(table) {
var fileName = table.name() + '.js';
if (getSpecificConfig(table.name(), 'generate.useSchemaName')) { // Prefix with schema name if config requested it.
fileName = table.schema().name() + '_' + fileName;
}
return fileName;
}
/**
* Returns if table is in the list of tables to be skipped. Looks for schema.table and table name.
* @private
* @param {object} table - pg-structure object
* @param {string} detail - Type of object to include it in explanation
* @returns {boolean}
*/
function shouldSkip(table, detail) {
var skipTable = getConfig('generate.skipTable'); // Do not auto generate files for those tables.
if (skipTable.indexOf(table.name()) !== -1 || skipTable.indexOf(table.schema().name() + '.' + table.name()) !== -1) {
if (getConfig('output.log')) {
if (detail === 'table') {
logger.info('(Skipped ' + detail + ') File \'' + getFileName(table) + '\' is skipped for model \'' + getModelNameFor(table) + '\'');
} else if (detail === 'relation') {
logger.info('(Skipped ' + detail + ') Relation is skipped for model \'' + getModelNameFor(table) + '\'');
}
}
return true;
}
return false;
}
/**
* Validates model relations naming. If any relation has same alias with any column and/or relation, this function
* returns description of the error as string.
* @private
* @param {Object} templateTable -
* @param {Object} relation -
*/
function validateNaming(templateTable) {
var ri, ci, pi, relationToValidate, column, catched, relation, duplicates = [];
for (ri = 0; ri < templateTable.relations.length; ri = ri + 1) {
relationToValidate = templateTable.relations[ri];
// Check against columns
for (ci = 0, catched = false; ci < templateTable.columns.length && !catched; ci = ci + 1) {
column = templateTable.columns[ci];
if (column.name === relationToValidate.as) {
logger.warn('ERROR: %s is already used. %s relation is trying to have alias of previously defined column with same name in table %s.%s.', relationToValidate.as, relationToValidate.type, templateTable.schema, templateTable.tableName);
duplicates.push(relationToValidate.as);
catched = true;
}
}
// Check against previous relations. Later realitons will check against this already.
for (pi = 0, catched = false; pi < ri && !catched; pi = pi + 1) {
relation = templateTable.relations[pi];
if (relation.as === relationToValidate.as) {
logger.warn('ERROR: %s is already used. %s relation is trying to have alias of previously defined %s relation in table %s.%s.', relationToValidate.as, relationToValidate.type, relation.type, templateTable.schema, templateTable.tableName);
duplicates.push(relationToValidate.as);
catched = true;
}
}
}
if (duplicates.length > 0) {
return 'Table ' + templateTable.schema + '.' + templateTable.tableName + ' has duplicate relation aliases: ' + duplicates.join(',') + '.';
}
}
/**
* Generates all model files.
* @private
* @param {object} db - pg-structure db object
* @param {function} next - Callback to execute.
*/
function generateModelFiles(db, next) {
var q, templateTable, allNamingErrors = [];
q = async.queue(function (task, workerCallback) {
var output = getConfig('output.beautify') ? beautify(task.content, { indent_size: getConfig('output.indent'), preserve_newlines: getConfig('output.preserveNewLines') }) : task.content;
fs.writeFile(path.join(getConfig('output.folder'), 'definition-files', getFileName(task.table)), output, workerCallback);
if (getConfig('output.log')) { logger.info('(Created) File \'' + getFileName(task.table) + '\' is created for model \'' + getModelNameFor(task.table) + '\''); }
}, 4);
db.schemas(function (schema) {
schema.tables(function (table) {
var namingError = '';
logger.debug('Now parsing table: %s', table.name());
if (getSpecificConfig(table.name(), 'generate.hasManyThrough') && getSpecificConfig(table.name(), 'generate.belongsToMany')) {
next(new Error('Configuration error: Both "generate.hasManyThrough" and "generate.belongsToMany" configuration is set to be true for table "' + table.schema().name() + '.' + table.name() + '". They cannot be true at the same time.'));
}
if (shouldSkip(table, 'table')) { return; }
templateTable = getTableOptions(table);
table.columns(function (column) {
templateTable.columns.push(getColumnDetails(column));
});
table.hasManies(function (hasMany) {
if (shouldSkip(hasMany.referencesTable(), 'relation')) { return; }
templateTable.hasManies.push(getHasManyDetails(hasMany));
});
table.hasManyThroughs(function (hasManyThrough) {
if (getSpecificConfig(table.name(), 'generate.addRelationNameToManyToMany') && getSpecificConfig(table.name(), 'generate.addTableNameToManyToMany')) {
next(new Error('Configuration error: Both "generate.addRelationNameToManyToMany" and "generate.addTableNameToManyToMany" configuration is set to be true for table "' + table.schema().name() + '.' + table.name() + '". They cannot be true at the same time.'));
}
if (shouldSkip(hasManyThrough.referencesTable(), 'relation') || shouldSkip(hasManyThrough.through(), 'relation')) { return; }
if (getSpecificConfig(table.name(), 'generate.hasManyThrough')) {
templateTable.hasManies.push(getHasManyDetails(hasManyThrough)); // has many throughs are deprecated after Sequelize 2.0 RC3
}
if (getSpecificConfig(table.name(), 'generate.belongsToMany')) {
templateTable.belongsToManies.push(getBelongsToManyDetails(hasManyThrough));
}
});
table.foreignKeyConstraints(function (fkc) {
if (shouldSkip(fkc.referencesTable(), 'relation')) { return; }
templateTable.belongsTos.push(getBelongsToDetails(fkc));
});
templateTable.relations = templateTable.hasManies.concat(templateTable.belongsTos, templateTable.belongsToManies);
namingError = validateNaming(templateTable);
if (namingError) {
allNamingErrors.push(namingError);
}
template('index', {
table: templateTable,
mainScript: path.join(getConfig('output.folder'), 'index.js'),
warning: getConfig('output.warning'),
dataTypeVariable: getSpecificConfig(table.name(), 'generate.dataTypeVariable')
}, function (err, result) {
if (err) { next(err); }
q.push({content: result, table: table}, function (err) { if (err) { next(err); } });
});
});
});
q.drain = function () {
if (allNamingErrors.length > 0) {
next(new Error('There are naming errors. Either set "generate.addRelationNameToManyToMany" true in configuration or rename your relations.\n' + allNamingErrors.join('\n')));
} else {
next(null);
}
};
}
/**
* Creates 'definition-files' and 'definition-files-custom' directories if they do not exist.
* Before creating definition-files it deletes definition-files directory.
* @private
* @param {function} next - Callback to execute
*/
function createOutputFolder(next) {
var defPath = path.join(getConfig('output.folder'), 'definition-files'),
defPathCustom = path.join(getConfig('output.folder'), 'definition-files-custom');
fs.remove(defPath, function (err) {
if (err) { next(err); }
fs.createFile(path.join(defPath, '¡Modelos Generados!'), function (err) {
if (err) { next(err); }
fs.mkdirs(defPathCustom, function (err) {
if (err) { next(err); }
next(null);
});
});
});
}
/**
* Generates index file by copying index.js from template directory to model directory. These locations come from
* config.
* @private
* @param next
*/
function generateUtilityFiles(next) {
fs.copy(path.join(getConfig('template.folder'), 'index.js'), path.join(getConfig('output.folder'), 'index.js'), function (err) {
if (err) { next(err); return; }
if (getConfig('output.log')) { logger.info('(Created) Index file: ' + path.resolve(path.join(getConfig('output.folder'), 'index.js'))); }
fs.copy(path.join(getConfig('template.folder'), '..', 'utils.js'), path.join(getConfig('output.folder'), 'utils.js'), function (err) {
if (err) { next(err); return; }
next(null);
});
});
try {
overriddenAliases = require(path.join(process.cwd(), getConfig('output.folder'), 'alias.json'));
} catch (ignore) {}
}
function generateAliasFile(next) {
fs.writeFile(path.join(getConfig('output.folder'), 'alias.json'), beautify(jsonStringfy(newAliases), { indent_size: getConfig('output.indent') }), function (err) {
if (err) { console.log(err); }
next();
});
}
/**
* Combines default configuration, custom config file and command line options by overriding lower priority ones.
* @private
* @param {object} options - Options converted to config structure.
*/
function setupConfig(options) {
if (options.resetConfig) {
// Reset your environment variables for resetting node-config module. node-config is a singleton.
// For testing it's necessary to reset and this is a workaround from node-config support.
global.NODE_CONFIG = null;
delete require.cache[require.resolve('config')];
config = require('config');
delete options.resetConfig;
}
var customConfigFile, customConfig,
defaultConfig = require('../config/default.js');
options = options || {};
if (options.config) {
customConfigFile = options.config.charAt(0) === '/' || options.config.charAt(0) === '\\' ? options.config : path.join(process.cwd(), options.config); // Absolute or relative
customConfig = require(customConfigFile);
}
delete options.config;
// Combine configs and override lower priority configs.
config.util.extendDeep(config, defaultConfig, customConfig || {}, { "sequelize-pg-generator": options });
}
/**
* Converts options to config params by inserting root level values into correct position in config object.
* For example: { host: '127.0.0.1' } -> { database: { host: '127.0.0.1'} }
* @private
* @param {Object} options - Options from constructor
* @returns {{database: {}, output: {}}}
*/
function convertOptionsToConfig(options) {
var result = { database: {}, output: {} };
// Copy all database options to options global variable to override config.
['host', 'port', 'database', 'user', 'password', 'schema'].forEach(function (option) {
if (options[option] !== undefined) {
result.database[option] = options[option];
delete options[option];
}
});
if (options.nolog !== undefined) {
result.output.log = !options.nolog; // Reverse of the nolog
delete options.nolog;
}
// Override output folder if given.
if (options.output !== undefined) {
result.output.folder = options.output;
delete options.output;
}
// Override template folder
if (options.templateName !== undefined) {
if (options.template === undefined) {
options.template = {};
}
options.template.folder = path.join(__dirname, '..', 'template', options.templateName);
delete options.templateName;
}
// Copy remaining non deleted options to root of result.
lodash.defaults(result, options);
return result;
}
/**
* Generates model files for Sequelize ORM.
* @param {function} callback - Function to execute after completion of auto generation. callback(err)
* @param {object} options - Options to override configuration parameters from config file
* @param {string} options.host - IP address or host name of the database server
* @param {number} options.port - Port of database server to connect
* @param {string} options.database - Database name
* @param {string} options.user - Username to connect to database
* @param {string} options.password - Password to connect to database
* @param {Array} options.schema - List of comma separated names of the database schemas to traverse. Example public,extra_schema.
* @param {string} options.output - Output folder
* @param {string} options.config - Path of the configuration file
* @param {boolean} options.nolog - Don't output log of generated files.
* @param {boolean} options.resetConfig - Reset configuration via side-step solution to prevent singleton behaviour. (Not recomended for production)
*/
module.exports = function (callback, options) {
var delayedError;
setupConfig(convertOptionsToConfig(options));
if (!getConfig('database.database') || !getConfig('database.host')) {
callback(new Error('Host and database are required'));
return;
}
if (getConfig('generate.hasManyThrough') && getConfig('generate.belongsToMany')) {
callback(new Error('Configuration error: Both "generate.hasManyThrough" and "generate.belongsToMany" configuration is set to be true. They cannot be true at the same time.'));
return;
}
if (getConfig('generate.addRelationNameToManyToMany') && getConfig('generate.addTableNameToManyToMany')) {
callback(new Error('Configuration error: Both "generate.addRelationNameToManyToMany" and "generate.addTableNameToManyToMany" configuration is set to be true. They cannot be true at the same time.'));
}
async.waterfall([
createOutputFolder,
generateUtilityFiles,
parseDB,
generateModelFiles,
generateAliasFile
], function (err) {
if (err) {
callback(err);
} else {
callback(null);
}
});
};