loopback-datasource-juggler/lib/model.js

/**
 * Module exports class Model
 */
module.exports = ModelBaseClass;

/**
 * Module dependencies
 */
 
var util = require('util');
var traverse = require('traverse');
var jutil = require('./jutil');
var List = require('./list');
var Hookable = require('./hooks');
var validations = require('./validations.js');

var BASE_TYPES = ['String', 'Boolean', 'Number', 'Date', 'Text'];

/**
 * Model class - base class for all persist objects
 * provides **common API** to access any database connector.
 * This class describes only abstract behavior layer, refer to `lib/connectors/*.js`
 * to learn more about specific connector implementations
 *
 * `ModelBaseClass` mixes `Validatable` and `Hookable` classes methods
 *
 * @constructor
 * @param {Object} data - initial object data
 */
function ModelBaseClass(data) {
    this._initProperties(data, true);
}

// FIXME: [rfeng] We need to make sure the input data should not be mutated. Disabled cloning for now to get tests passing
function clone(data) {
    /*
    if(!(data instanceof ModelBaseClass)) {
        if(data && (Array.isArray(data) || 'object' === typeof data)) {
            return traverse(data).clone();
        }
    }
    */
    return data;
}
/**
 * Initialize properties
 * @param data
 * @param applySetters
 * @private
 */
ModelBaseClass.prototype._initProperties = function (data, applySetters) {
    var self = this;
    var ctor = this.constructor;
    
    var properties = ctor.definition.build();
    data = data || {};

    Object.defineProperty(this, '__cachedRelations', {
        writable: true,
        enumerable: false,
        configurable: true,
        value: {}
    });

    Object.defineProperty(this, '__data', {
        writable: true,
        enumerable: false,
        configurable: true,
        value: {}
    });

    Object.defineProperty(this, '__dataWas', {
        writable: true,
        enumerable: false,
        configurable: true,
        value: {}
    });

    if (data['__cachedRelations']) {
        this.__cachedRelations = data['__cachedRelations'];
    }

    // Check if the strict option is set to false for the model
    var strict = ctor.definition.settings.strict;

    for (var i in data) {
        if (i in properties) {
            this.__data[i] = this.__dataWas[i] = clone(data[i]);
        } else if (i in ctor.relations) {
            this.__data[ctor.relations[i].keyFrom] = this.__dataWas[i] = data[i][ctor.relations[i].keyTo];
            this.__cachedRelations[i] = data[i];
        } else {
            if(strict === false) {
                this.__data[i] = this.__dataWas[i] = clone(data[i]);
            } else if(strict === 'throw') {
                throw new Error('Unknown property: ' + i);
            }
        }
    }

    if (applySetters === true) {
        Object.keys(data).forEach(function (propertyName) {
            if((propertyName in properties) || (propertyName in ctor.relations)) {
                self[propertyName] = self.__data[propertyName] || data[propertyName];
            }
        });
    }

    // Set the unknown properties as properties to the object
    if(strict === false) {
        Object.keys(data).forEach(function (propertyName) {
            if(!(propertyName in properties)) {
                self[propertyName] = self.__data[propertyName] || data[propertyName];
            }
        });
    }

    ctor.forEachProperty(function (propertyName) {

        if ('undefined' === typeof self.__data[propertyName]) {
            self.__data[propertyName] = self.__dataWas[propertyName] = getDefault(propertyName);
        } else {
            self.__dataWas[propertyName] = self.__data[propertyName];
        }

    });

    ctor.forEachProperty(function (propertyName) {

        var type = properties[propertyName].type;
        
        if (BASE_TYPES.indexOf(type.name) === -1) {
            if (typeof self.__data[propertyName] !== 'object' && self.__data[propertyName]) {
                try {
                    self.__data[propertyName] = JSON.parse(self.__data[propertyName] + '');
                } catch (e) {
                    self.__data[propertyName] = String(self.__data[propertyName]);
                }
            }
            if (type.name === 'Array' || Array.isArray(type)) {
                if(!(self.__data[propertyName] instanceof List)) {
                    self.__data[propertyName] = new List(self.__data[propertyName], type, self);
                }
            }
        }

    });

    function getDefault(propertyName) {
        var def = properties[propertyName]['default'];
        if (def !== undefined) {
            if (typeof def === 'function') {
                return def();
            } else {
                return def;
            }
        } else {
            return undefined;
        }
    }

    this.trigger('initialize');
}

/**
 * @param {String} prop - property name
 * @param {Object} params - various property configuration
 */
ModelBaseClass.defineProperty = function (prop, params) {
    this.dataSource.defineProperty(this.modelName, prop, params);
};

ModelBaseClass.getPropertyType = function (propName) {
    var prop = this.definition.properties[propName];
    if(!prop) {
        // The property is not part of the definition
        return null;
    }
    if (!prop.type) {
        throw new Error('Type not defined for property ' + this.modelName + '.' + propName);
        // return null;
    }
    return prop.type.name;
};

ModelBaseClass.prototype.getPropertyType = function (propName) {
    return this.constructor.getPropertyType(propName);
};

/**
 * Return string representation of class
 *
 * @override default toString method
 */
ModelBaseClass.toString = function () {
    return '[Model ' + this.modelName + ']';
};

/**
 * Convert instance to Object
 *
 * @param {Boolean} onlySchema - restrict properties to dataSource only, default false
 * when onlySchema == true, only properties defined in dataSource returned,
 * otherwise all enumerable properties returned
 * @returns {Object} - canonical object representation (no getters and setters)
 */
ModelBaseClass.prototype.toObject = function (onlySchema) {
    var data = {};
    var self = this;

    var schemaLess = this.constructor.definition.settings.strict === false || !onlySchema;
    this.constructor.forEachProperty(function (propertyName) {
        if (self[propertyName] instanceof List) {
            data[propertyName] = self[propertyName].toObject(!schemaLess);
        } else if (self.__data.hasOwnProperty(propertyName)) {
            if(self[propertyName] !== undefined && self[propertyName]!== null && self[propertyName].toObject) {
                data[propertyName] = self[propertyName].toObject(!schemaLess);
            } else {
                data[propertyName] = self[propertyName];
            }
        } else {
            data[propertyName] = null;
        }
    });

    if (schemaLess) {
        Object.keys(self.__data).forEach(function (propertyName) {
            if (!data.hasOwnProperty(propertyName)) {
                var val = self.hasOwnProperty(propertyName) ? self[propertyName] : self.__data[propertyName];
                if(val !== undefined && val!== null && val.toObject) {
                    data[propertyName] = val.toObject(!schemaLess);
                } else {
                    data[propertyName] = val;
                }
            }
        });
    }
    return data;
};

// ModelBaseClass.prototype.hasOwnProperty = function (prop) {
//     return this.__data && this.__data.hasOwnProperty(prop) ||
//         Object.getOwnPropertyNames(this).indexOf(prop) !== -1;
// };

ModelBaseClass.prototype.toJSON = function () {
    return this.toObject();
};

ModelBaseClass.prototype.fromObject = function (obj) {
    Object.keys(obj).forEach(function (key) {
        this[key] = obj[key];
    }.bind(this));
};

/**
 * Checks is property changed based on current property and initial value
 *
 * @param {String} propertyName - property name
 * @return Boolean
 */
ModelBaseClass.prototype.propertyChanged = function propertyChanged(propertyName) {
    return this.__data[propertyName] !== this.__dataWas[propertyName];
};

/**
 * Reset dirty attributes
 *
 * this method does not perform any database operation it just reset object to it's
 * initial state
 */
ModelBaseClass.prototype.reset = function () {
    var obj = this;
    Object.keys(obj).forEach(function (k) {
        if (k !== 'id' && !obj.constructor.dataSource.definitions[obj.constructor.modelName].properties[k]) {
            delete obj[k];
        }
        if (obj.propertyChanged(k)) {
            obj[k] = obj[k + '$was'];
        }
    });
};

ModelBaseClass.prototype.inspect = function () {
    return util.inspect(this.__data, false, 4, true);
};

ModelBaseClass.mixin = function(anotherClass, options) {
    return jutil.mixin(this, anotherClass, options);
};

jutil.mixin(ModelBaseClass, Hookable);
jutil.mixin(ModelBaseClass, validations.Validatable);