bugcore/lib/util/LiteralUtil.js

bugcore is a JavaScript library that provides a foundational architecture for object oriented JS

/*
 * Copyright (c) 2016 airbug Inc. http://airbug.com
 *
 * bugcore may be freely distributed under the MIT license.
 */


//-------------------------------------------------------------------------------
// Annotations
//-------------------------------------------------------------------------------

//@Export('LiteralUtil')

//@Require('Class')
//@Require('IArrayable')
//@Require('IObjectable')
//@Require('Obj')
//@Require('ObjectUtil')
//@Require('TypeUtil')


//-------------------------------------------------------------------------------
// Context
//-------------------------------------------------------------------------------

require('bugpack').context("*", function(bugpack) {

    //-------------------------------------------------------------------------------
    // BugPack
    //-------------------------------------------------------------------------------

    var Class           = bugpack.require('Class');
    var IArrayable      = bugpack.require('IArrayable');
    var IObjectable     = bugpack.require('IObjectable');
    var Obj             = bugpack.require('Obj');
    var ObjectUtil      = bugpack.require('ObjectUtil');
    var TypeUtil        = bugpack.require('TypeUtil');


    //-------------------------------------------------------------------------------
    // Declare Class
    //-------------------------------------------------------------------------------

    /**
     * @class
     * @extends {Obj}
     */
    var LiteralUtil     = Class.extend(Obj, {
        _name: "LiteralUtil"
    });


    //-------------------------------------------------------------------------------
    // Static Methods
    //-------------------------------------------------------------------------------

    /**
     * @static
     * @param {*} value
     * @return {*}
     */
    LiteralUtil.convertToLiteral = function(value) {
        var literal = undefined;
        if (Class.doesImplement(value, IObjectable)) {
            value = value.toObject();
        } else if (Class.doesImplement(value, IArrayable)) {
            value = value.toArray();
        }

        if (TypeUtil.isObject(value)) {
            literal = {};
            ObjectUtil.forIn(value, function(propertyName, propertyValue) {
                if (!TypeUtil.isFunction(propertyValue)) {
                    literal[propertyName] = LiteralUtil.convertToLiteral(propertyValue);
                }
            });
        } else if (TypeUtil.isArray(value)) {
            literal = [];
            for (var i = 0, size = value.length; i < size; i++) {
                var arrayValue = value[i];
                literal.push(LiteralUtil.convertToLiteral(arrayValue));
            }
        } else {

            //TODO BRN: Any basic types that need to be converted?

            literal = value;
        }
        return literal
    };


    //-------------------------------------------------------------------------------
    // Exports
    //-------------------------------------------------------------------------------

    bugpack.export('LiteralUtil', LiteralUtil);
});