405 lines
12 KiB
JavaScript
405 lines
12 KiB
JavaScript
// This test written in mocha+should.js
|
||
var should = require('./init.js');
|
||
var assert = require('assert');
|
||
|
||
var jdb = require('../');
|
||
var ModelBuilder = jdb.ModelBuilder;
|
||
var DataSource = jdb.DataSource;
|
||
var Memory = require('../lib/connectors/memory');
|
||
|
||
var ModelDefinition = require('../lib/model-definition');
|
||
|
||
describe('ModelDefinition class', function () {
|
||
var memory;
|
||
beforeEach(function() {
|
||
memory = new DataSource({connector: Memory});
|
||
});
|
||
|
||
it('should be able to define plain models', function (done) {
|
||
var modelBuilder = new ModelBuilder();
|
||
|
||
var User = new ModelDefinition(modelBuilder, 'User', {
|
||
name: "string",
|
||
bio: ModelBuilder.Text,
|
||
approved: Boolean,
|
||
joinedAt: Date,
|
||
age: "number"
|
||
});
|
||
|
||
User.build();
|
||
assert.equal(User.properties.name.type, String);
|
||
assert.equal(User.properties.bio.type, ModelBuilder.Text);
|
||
assert.equal(User.properties.approved.type, Boolean);
|
||
assert.equal(User.properties.joinedAt.type, Date);
|
||
assert.equal(User.properties.age.type, Number);
|
||
|
||
var json = User.toJSON();
|
||
assert.equal(json.name, "User");
|
||
assert.equal(json.properties.name.type, "String");
|
||
assert.equal(json.properties.bio.type, "Text");
|
||
assert.equal(json.properties.approved.type, "Boolean");
|
||
assert.equal(json.properties.joinedAt.type, "Date");
|
||
assert.equal(json.properties.age.type, "Number");
|
||
|
||
assert.deepEqual(User.toJSON(), json);
|
||
|
||
done();
|
||
|
||
});
|
||
|
||
it('should be able to define additional properties', function (done) {
|
||
var modelBuilder = new ModelBuilder();
|
||
|
||
var User = new ModelDefinition(modelBuilder, 'User', {
|
||
name: "string",
|
||
bio: ModelBuilder.Text,
|
||
approved: Boolean,
|
||
joinedAt: Date,
|
||
age: "number"
|
||
});
|
||
|
||
User.build();
|
||
|
||
var json = User.toJSON();
|
||
|
||
User.defineProperty("id", {type: "number", id: true});
|
||
assert.equal(User.properties.name.type, String);
|
||
assert.equal(User.properties.bio.type, ModelBuilder.Text);
|
||
assert.equal(User.properties.approved.type, Boolean);
|
||
assert.equal(User.properties.joinedAt.type, Date);
|
||
assert.equal(User.properties.age.type, Number);
|
||
|
||
assert.equal(User.properties.id.type, Number);
|
||
|
||
json = User.toJSON();
|
||
assert.deepEqual(json.properties.id, {type: 'Number', id: true});
|
||
|
||
done();
|
||
|
||
});
|
||
|
||
it('should be able to define nesting models', function (done) {
|
||
var modelBuilder = new ModelBuilder();
|
||
|
||
var User = new ModelDefinition(modelBuilder, 'User', {
|
||
name: String,
|
||
bio: ModelBuilder.Text,
|
||
approved: Boolean,
|
||
joinedAt: Date,
|
||
age: Number,
|
||
address: {
|
||
street: String,
|
||
city: String,
|
||
zipCode: String,
|
||
state: String
|
||
}
|
||
});
|
||
|
||
User.build();
|
||
assert.equal(User.properties.name.type, String);
|
||
assert.equal(User.properties.bio.type, ModelBuilder.Text);
|
||
assert.equal(User.properties.approved.type, Boolean);
|
||
assert.equal(User.properties.joinedAt.type, Date);
|
||
assert.equal(User.properties.age.type, Number);
|
||
assert.equal(typeof User.properties.address.type, 'function');
|
||
|
||
var json = User.toJSON();
|
||
assert.equal(json.name, "User");
|
||
assert.equal(json.properties.name.type, "String");
|
||
assert.equal(json.properties.bio.type, "Text");
|
||
assert.equal(json.properties.approved.type, "Boolean");
|
||
assert.equal(json.properties.joinedAt.type, "Date");
|
||
assert.equal(json.properties.age.type, "Number");
|
||
|
||
assert.deepEqual(json.properties.address.type, { street: { type: 'String' },
|
||
city: { type: 'String' },
|
||
zipCode: { type: 'String' },
|
||
state: { type: 'String' } });
|
||
|
||
done();
|
||
|
||
});
|
||
|
||
it('should be able to define referencing models', function (done) {
|
||
var modelBuilder = new ModelBuilder();
|
||
|
||
var Address = modelBuilder.define('Address', {
|
||
street: String,
|
||
city: String,
|
||
zipCode: String,
|
||
state: String
|
||
});
|
||
var User = new ModelDefinition(modelBuilder, 'User', {
|
||
name: String,
|
||
bio: ModelBuilder.Text,
|
||
approved: Boolean,
|
||
joinedAt: Date,
|
||
age: Number,
|
||
address: Address
|
||
|
||
});
|
||
|
||
User.build();
|
||
assert.equal(User.properties.name.type, String);
|
||
assert.equal(User.properties.bio.type, ModelBuilder.Text);
|
||
assert.equal(User.properties.approved.type, Boolean);
|
||
assert.equal(User.properties.joinedAt.type, Date);
|
||
assert.equal(User.properties.age.type, Number);
|
||
assert.equal(User.properties.address.type, Address);
|
||
|
||
var json = User.toJSON();
|
||
assert.equal(json.name, "User");
|
||
assert.equal(json.properties.name.type, "String");
|
||
assert.equal(json.properties.bio.type, "Text");
|
||
assert.equal(json.properties.approved.type, "Boolean");
|
||
assert.equal(json.properties.joinedAt.type, "Date");
|
||
assert.equal(json.properties.age.type, "Number");
|
||
|
||
assert.equal(json.properties.address.type, 'Address');
|
||
|
||
done();
|
||
|
||
});
|
||
|
||
it('should be able to define referencing models by name', function (done) {
|
||
var modelBuilder = new ModelBuilder();
|
||
|
||
var Address = modelBuilder.define('Address', {
|
||
street: String,
|
||
city: String,
|
||
zipCode: String,
|
||
state: String
|
||
});
|
||
var User = new ModelDefinition(modelBuilder, 'User', {
|
||
name: String,
|
||
bio: ModelBuilder.Text,
|
||
approved: Boolean,
|
||
joinedAt: Date,
|
||
age: Number,
|
||
address: 'Address'
|
||
|
||
});
|
||
|
||
User.build();
|
||
assert.equal(User.properties.name.type, String);
|
||
assert.equal(User.properties.bio.type, ModelBuilder.Text);
|
||
assert.equal(User.properties.approved.type, Boolean);
|
||
assert.equal(User.properties.joinedAt.type, Date);
|
||
assert.equal(User.properties.age.type, Number);
|
||
assert.equal(User.properties.address.type, Address);
|
||
|
||
var json = User.toJSON();
|
||
assert.equal(json.name, "User");
|
||
assert.equal(json.properties.name.type, "String");
|
||
assert.equal(json.properties.bio.type, "Text");
|
||
assert.equal(json.properties.approved.type, "Boolean");
|
||
assert.equal(json.properties.joinedAt.type, "Date");
|
||
assert.equal(json.properties.age.type, "Number");
|
||
|
||
assert.equal(json.properties.address.type, 'Address');
|
||
|
||
done();
|
||
|
||
});
|
||
|
||
it('should report correct id names', function (done) {
|
||
var modelBuilder = new ModelBuilder();
|
||
|
||
var User = new ModelDefinition(modelBuilder, 'User', {
|
||
userId: {type: String, id: true},
|
||
name: "string",
|
||
bio: ModelBuilder.Text,
|
||
approved: Boolean,
|
||
joinedAt: Date,
|
||
age: "number"
|
||
});
|
||
|
||
assert.equal(User.idName(), 'userId');
|
||
assert.deepEqual(User.idNames(), ['userId']);
|
||
done();
|
||
});
|
||
|
||
it('should sort id properties by its index', function () {
|
||
var modelBuilder = new ModelBuilder();
|
||
|
||
var User = new ModelDefinition(modelBuilder, 'User', {
|
||
userId: {type: String, id: 2},
|
||
userType: {type: String, id: 1},
|
||
name: "string",
|
||
bio: ModelBuilder.Text,
|
||
approved: Boolean,
|
||
joinedAt: Date,
|
||
age: "number"
|
||
});
|
||
|
||
var ids = User.ids();
|
||
assert.ok(Array.isArray(ids));
|
||
assert.equal(ids.length, 2);
|
||
assert.equal(ids[0].id, 1);
|
||
assert.equal(ids[0].name, 'userType');
|
||
assert.equal(ids[1].id, 2);
|
||
assert.equal(ids[1].name, 'userId');
|
||
});
|
||
|
||
it('should report correct table/column names', function (done) {
|
||
var modelBuilder = new ModelBuilder();
|
||
|
||
var User = new ModelDefinition(modelBuilder, 'User', {
|
||
userId: {type: String, id: true, oracle: {column: 'ID'}},
|
||
name: "string"
|
||
}, {oracle: {table: 'USER'}});
|
||
|
||
assert.equal(User.tableName('oracle'), 'USER');
|
||
assert.equal(User.tableName('mysql'), 'User');
|
||
assert.equal(User.columnName('oracle', 'userId'), 'ID');
|
||
assert.equal(User.columnName('mysql', 'userId'), 'userId');
|
||
done();
|
||
});
|
||
|
||
it('should inherit prototype using option.base', function () {
|
||
var modelBuilder = memory.modelBuilder;
|
||
var parent = memory.createModel('parent', {}, {
|
||
relations: {
|
||
children: {
|
||
type: 'hasMany',
|
||
model: 'anotherChild'
|
||
}
|
||
}
|
||
});
|
||
var baseChild = modelBuilder.define('baseChild');
|
||
baseChild.attachTo(memory);
|
||
// the name of this must begin with a letter < b
|
||
// for this test to fail
|
||
var anotherChild = baseChild.extend('anotherChild');
|
||
|
||
assert(anotherChild.prototype instanceof baseChild);
|
||
});
|
||
|
||
it('should ignore inherited options.base', function() {
|
||
var modelBuilder = memory.modelBuilder;
|
||
var base = modelBuilder.define('base');
|
||
var child = base.extend('child', {}, { base: 'base' });
|
||
var grandChild = child.extend('grand-child');
|
||
assert.equal('child', grandChild.base.modelName);
|
||
assert(grandChild.prototype instanceof child);
|
||
});
|
||
|
||
it('should ignore inherited options.super', function() {
|
||
var modelBuilder = memory.modelBuilder;
|
||
var base = modelBuilder.define('base');
|
||
var child = base.extend('child', {}, { super: 'base' });
|
||
var grandChild = child.extend('grand-child');
|
||
assert.equal('child', grandChild.base.modelName);
|
||
assert(grandChild.prototype instanceof child);
|
||
});
|
||
|
||
it('should serialize protected properties into JSON', function() {
|
||
var modelBuilder = memory.modelBuilder;
|
||
var ProtectedModel = memory.createModel('protected', {}, {
|
||
protected: ['protectedProperty']
|
||
});
|
||
var pm = new ProtectedModel({
|
||
id: 1, foo: 'bar', protectedProperty: 'protected'
|
||
});
|
||
var serialized = pm.toJSON();
|
||
assert.deepEqual(serialized, {
|
||
id: 1, foo: 'bar', protectedProperty: 'protected'
|
||
});
|
||
});
|
||
|
||
it('should not serialize protected properties of nested models into JSON', function(done){
|
||
var modelBuilder = memory.modelBuilder;
|
||
var Parent = memory.createModel('parent');
|
||
var Child = memory.createModel('child', {}, {protected: ['protectedProperty']});
|
||
Parent.hasMany(Child);
|
||
Parent.create({
|
||
name: 'parent'
|
||
}, function(err, parent) {
|
||
parent.children.create({
|
||
name: 'child',
|
||
protectedProperty: 'protectedValue'
|
||
}, function(err, child) {
|
||
Parent.find({include: 'children'}, function(err, parents) {
|
||
var serialized = parents[0].toJSON();
|
||
var child = serialized.children[0];
|
||
assert.equal(child.name, 'child');
|
||
assert.notEqual(child.protectedProperty, 'protectedValue');
|
||
done();
|
||
});
|
||
});
|
||
});
|
||
});
|
||
|
||
it('should not serialize hidden properties into JSON', function () {
|
||
var modelBuilder = memory.modelBuilder;
|
||
var HiddenModel = memory.createModel('hidden', {}, {
|
||
hidden: ['secret']
|
||
});
|
||
var hm = new HiddenModel({
|
||
id: 1,
|
||
foo: 'bar',
|
||
secret: 'secret'
|
||
});
|
||
var serialized = hm.toJSON();
|
||
assert.deepEqual(serialized, {
|
||
id: 1,
|
||
foo: 'bar'
|
||
});
|
||
});
|
||
|
||
it('should not serialize hidden properties of nested models into JSON', function (done) {
|
||
var modelBuilder = memory.modelBuilder;
|
||
var Parent = memory.createModel('parent');
|
||
var Child = memory.createModel('child', {}, {hidden: ['secret']});
|
||
Parent.hasMany(Child);
|
||
Parent.create({
|
||
name: 'parent'
|
||
}, function(err, parent) {
|
||
parent.children.create({
|
||
name: 'child',
|
||
secret: 'secret'
|
||
}, function(err, child) {
|
||
Parent.find({include: 'children'}, function(err, parents) {
|
||
var serialized = parents[0].toJSON();
|
||
var child = serialized.children[0];
|
||
assert.equal(child.name, 'child');
|
||
assert.notEqual(child.secret, 'secret');
|
||
done();
|
||
});
|
||
});
|
||
});
|
||
});
|
||
|
||
it('should report deprecation warning for property names containing dot', function() {
|
||
var message = 'deprecation not reported';
|
||
process.once('deprecation', function(err) { message = err.message; });
|
||
|
||
memory.createModel('Dotted', { 'dot.name': String });
|
||
|
||
message.should.match(/Dotted.*dot\.name/);
|
||
});
|
||
|
||
it('should report deprecation warning for dynamic property names containing dot', function(done) {
|
||
var message = 'deprecation not reported';
|
||
process.once('deprecation', function(err) { message = err.message; });
|
||
|
||
var Model = memory.createModel('DynamicDotted');
|
||
Model.create({ 'dot.name': 'dot.value' }, function(err) {
|
||
if (err) return done(err);
|
||
message.should.match(/Dotted.*dot\.name/);
|
||
done();
|
||
});
|
||
});
|
||
|
||
it('should support "array" type shortcut', function() {
|
||
var Model = memory.createModel('TwoArrays', {
|
||
regular: Array,
|
||
sugar: 'array'
|
||
});
|
||
|
||
var props = Model.definition.properties;
|
||
props.regular.type.should.equal(props.sugar.type);
|
||
});
|
||
});
|
||
|