iridium/test/instance.js

A custom lightweight ORM for MongoDB designed for power-users

var Database = require('../index');
var Model = Database.Model;
var Instance = Database.Instance;
var should = require('should');
var Concoction = require('concoction');

describe('orm', function () {
	"use strict";

	describe('Instance', function () {
		var db = {
			plugins: []
		};

		describe('diff', function () {
			it('should generate $set for basic changes', function () {
				Instance.diff({ x: 1 }, { x: 2 }).should.eql({ $set: { x: 2 } });
			});

			it('should not generate $set for unnecessary changes', function () {
				Instance.diff({ x: 1, y: 1 }, { x: 1, y: 2 }).should.eql({ $set: { y: 2 } });
				Instance.diff({ a: [1], b: 1 }, { a: [1], b: 2 }).should.eql({ $set: { b: 2 } });
			});

			it('should generate $set for new properties', function () {
				Instance.diff({ a: 1 }, { a: 1, b: 1 }).should.eql({ $set: { b: 1 } });
			});

			it('should generate $set for array changes', function () {
				Instance.diff({ a: [1] }, { a: [1, 2] }).should.eql({ $set: { a: [1, 2] } });
			});

			it('should generate recursive $set for child properties', function () {
				Instance.diff({ a: { b: 1, c: 1 } }, { a: { b: 1, c: 2 } }).should.eql({ $set: { 'a.c': 2 } });
			});
		});

		describe('constructor', function () {
			it('should present all properties of the document', function () {
				var model = new Model(db, 'model', {
					name: String
				}, {
					preprocessors: []
				})

				var i = new model.Instance({
					id: 'custom_id',
					name: 'name'
				});

				i.should.have.property('id', 'custom_id');
				i.should.have.property('name', 'name');
			});

			it('should allow renaming of properties', function () {
				var model = new Model(db, 'model', {
						pretty: String
					},{
						preprocessors: [
							new Concoction.Rename({
								uglyName: 'pretty'
							})
						]
					});

				var i = new model.Instance({
					_id: 'custom_id',
					uglyName: 'value'
				});

				i.should.have.property('pretty', 'value');
			});

			it('should allow the creation of methods', function () {
				var model = new Model(db, 'model', {}, {
					methods: {
						test: function() { return true; }
					}
				});

				var i = new model.Instance({
					_id: 'custom_id'
				});

				i.test().should.equal(true);
			});

			it('should correctly pass all arguments to a method', function () {
				var model = new Model(db, 'model', {}, {
					methods: {
						test: function (a, b, c) {
							should.equal(a, 'a');
							should.equal(b, 'b');
							should.equal(c, 'c');
						}
					}
				});

				var i = new model.Instance({
					_id: 'custom_id'
				});

				i.test('a', 'b', 'c');
			});

			it('should allow the creation of virtual properties', function () {
				var model = new Model(db, 'model', {}, {
					virtuals: {
						fullname: function () { return this.firstname + ' ' + this.lastname; }
					}
				});

				var i = new model.Instance({
					_id: 'custom_id',
					firstname: 'Billy',
					lastname: 'Bob'
				});

				i.fullname.should.equal('Billy Bob');
			});

			it('should allow the creation of virtual getter/setters', function() {
				var model = new Model(db, 'model', {}, {
					virtuals: {
						fullname: {
							get: function () { return this.firstname + ' ' + this.lastname; },
							set: function(value) {
								this.firstname = value.split(' ')[0];
								this.lastname = value.split(' ')[1];
							}
						}
					}
				});

				var i = new model.Instance({
					_id: 'custom_id',
					firstname: 'Billy',
					lastname: 'Bob'
				});

				i.fullname.should.equal('Billy Bob');

				i.fullname = 'Sally Jane';
				i.firstname.should.equal('Sally');
				i.lastname.should.equal('Jane');
			});

			it('should allow a custom schema', function () {
				var model = new Model(db, 'model', {
						name: String,
						age: { type: Number, required: false }
					}, {
						preprocessors: []
					});

				var i = new model.Instance({
					id: 'custom_id',
					name: 'name'
				});

				(function () {
					i.age = 'hello';
				}).should.throwError();

				i.should.have.property('id', 'custom_id');
				i.should.have.property('name', 'name');
				i.should.have.property('age').and.eql(null);
			});
		});
	});
});