oxjs/source/Ox/js/Core.js

// OxJS (c) 2012 0x2620, dual-licensed GPL/MIT, see http://oxjs.org for details

'use strict';

/*
Some conventions:
    Functions
        - only one var statement, in the first line of the function
        - return only once, from the last line of the function
    Variable names
        arg         argument
        args        arguments
        array       array
        canFoo      boolean
        callback    callback function
        collection  collection (array, string or object)
        date        date
        iterator    iterator function
        hasFoo      boolean
        i           index (integer key)
        index       index (integer key)
        isFoo       boolean
        k           key (of a key/value pair)
        key         key (of a key/value pair)
        max         maximum value
        min         minimum value
        number      number
        object      object
        regexp      regexp
        ret         return value
        string      string
        test        test function
        v           value (of a key/value pair)
        value       value (of a key/value pair)
    Indentation
        Variable definitions
            var a = {
                    key: value,
                    key: value,
                    key: value
                },
                b = {key: value},
                c = {key: value};
        Method chaining
            Obj.fnA({
                    key: value,
                    key: value,
                    key: value
                })
                .fnB({key: val})
                .fnC({key: val});
        Simple conditionals
            condition && expression;
        Conditionals
            if (condition) {
                expression;
            }
        Conditionals with long conditions
            if (
                condition
                && condition
                && condition
            ) {
                expression;
            }
        Ternary operator
            condition ? expression : expression;
        Ternary operator with long conditions or expressions
            condition ? expression
                : condition ? expression
                : expression;
*/

// todo: check http://ejohn.org/blog/ecmascript-5-strict-mode-json-and-more/
// also see https://github.com/tlrobinson/narwhal/blob/master/lib/util.js

(function(global) {
    /*@
    Ox <f> The <code>Ox</code> object
        See <code>Ox.wrap</code> for details.
        (value) -> <o> wrapped value
        value <*> Any value
    @*/
    global.Ox = function(value) {
        return Ox.wrap(value);
    };    
})(this);

/*@
Ox.Break <f> Breaks from <code>Ox.forEach</code> and <code>Ox.loop</code>
@*/
Ox.Break = function() {
    throw Ox.BreakError;
};

Ox.BreakError = new SyntaxError('Illegal Ox.Break() statement');

/*@
Ox.load <f> Loads a module
    A module named "Foo" provides <code>Ox.Foo/Ox.Foo.js</code>, in which it
    defines one method, <code>Ox.load.Foo</code>, that takes two arguments,
    <code>options</code> and <code>callback</code>, and calls
    <code>callback</code> with one argument, <code>true</code> for success or
    <code>false</code> if an error occurred. Generally, the module should
    define <code>Ox.Foo</code> and attach its own methods there.
    (module, callback)          -> <u> undefined
    (module, options, callback) -> <u> undefined
    (modules, callback)         -> <u> undefined
    module   <s> Module name
    modules  <o> Multiple modules {name: options, ...}
    options  <o> Module options
    callback <f> Callback function
        success <b> If true, the module has been loaded successfully
@*/
Ox.load = function() {
    var callback = arguments[arguments.length - 1],
        counter = 0,
        isObject = Ox.isObject(arguments[0]),
        length,
        modules = isObject ? arguments[0] : {},
        success = 0;
    if (!isObject) {   
        modules[arguments[0]] = Ox.isObject(arguments[1]) ? arguments[1] : {};
    }
    length = Ox.len(modules);
    Ox.forEach(modules, function(options, module) {
        Ox.loadFile(
            Ox.PATH + 'Ox.' + module + '/Ox.' + module + '.js',
            function() {
                Ox.load[module](options, function(s) {
                    success += s;
                    ++counter == length && callback(success == counter);
                });
            }
        );
    });
};

/*@
Ox.localStorage <o> localStorage wrapper
    (namespace) -> <f> localStorage object for a given namespace
        FIXME: there is a bug in Ox.doc here, 
        will use "(namespace)" as function name
        () -> <o> returns all key:value pairs
        (key) -> <*> returns one value
        (key, val) -> <f> sets one value, returns localStorage object
        ({key: val, ...}) -> <f> sets values, returns localStorage object
@*/
Ox.localStorage = function(namespace) {
    if (!window.localStorage) {
        window.localStorage = {};
    }
    function storage(key, value) {
        var args, ret;
        if (arguments.length == 0) {
            ret = {};
            Ox.forEach(localStorage, function(value, key) {
                if (Ox.startsWith(key, namespace + '.')) {
                    ret[key.slice(namespace.length + 1)] = JSON.parse(value);
                }
            });
        } else if (arguments.length == 1 && typeof key == 'string') {
            // This gets called by Ox.Log before Type.js has loaded
            value = localStorage[namespace + '.' + key];
            ret = value === void 0 ? void 0 : JSON.parse(value);
        } else {
            args = Ox.makeObject(arguments);
            Ox.forEach(args, function(value, key) {
                localStorage[namespace + '.' + key] = JSON.stringify(value);
            });
            ret = this;
        }
        return ret;
    };
    // IE 8 doesn't like `storage.delete`
    storage['delete'] = function(key) {
        var keys = arguments.length == 0 ? Object.keys(storage()) : [key];
        keys.forEach(function(key) {
            delete localStorage[namespace + '.' + key];
        });
        return storage;
    };
    return storage;
};

/*@
Ox.Log <f> Logging module
@*/
Ox.Log = (function() {
    var storage = Ox.localStorage('Ox'),
        log = storage('log') || {filter: [], filterEnabled: true},
        that = function() {
            var ret;
            if (arguments.length == 0) {
                ret = log;
            } else {
                ret = that.log.apply(null, arguments);
            }
            return ret;
        };
    that.filter = function(value) {
        if (!Ox.isUndefined(value)) {
            that.filter.enable();
            log.filter = Ox.makeArray(value);
            storage('log', log);
        }
        return log.filter;
    };
    that.filter.add = function(value) {
        return that.filter(Ox.unique(log.filter.concat(Ox.makeArray(value))));
    };
    that.filter.disable = function() {
        log.filterEnabled = false;
        storage('log', log);
    };
    that.filter.enable = function() {
        log.filterEnabled = true;
        storage('log', log);
    };
    that.filter.remove = function(value) {
        value = Ox.makeArray(value);
        return that.filter(log.filter.filter(function(v) {
            return value.indexOf(v) == -1;
        }));
    };
    that.log = function() {
        var args = Ox.toArray(arguments), date, ret;
        if (!log.filterEnabled || log.filter.indexOf(args[0]) > -1) {
            date = new Date();
            args.unshift(
                Ox.formatDate(date, '%H:%M:%S.') + (+date).toString().slice(-3)
            );
            window.console && window.console.log.apply(window.console, args);
            ret = args.join(' ');
        }
        return ret;
    };
    return that;
}());

/*@
Ox.loop <f> For-loop, functional-style
    Returning <code>false</code> from the iterator function acts like a
    <code>break</code> statement. Unlike a <code>for</code> loop,
    <code>Ox.loop</code> doesn't leak its counter variable to the outer scope,
    but returns it.
    (stop, fn) -> <n> Next value
        equivalent to <code>for (var i = 0; i < stop; i++) { fn(i); }</code>
    (start, stop, fn) -> <n> Next value
        equivalent to <code>for (var i = start; i < stop; i++) { fn(i); }</code>
        or, if <code>start</code> is larger than <code>stop</code>,
        <code>for (var i = start; i > stop; i--) { fn(i); }</code>
    (start, stop, step, fn) -> <n> Next value
        equivalent to <code>for (var i = start; i < stop; i += step) { fn(i);
        }</code> or, if <code>step</code> is negative, <code>for (var i = start;
        i > stop; i += step) { fn(i); }</code>
    start <n> Start value
    stop <n> Stop value (exclusive)
    step <n> Step value
    fn <f> Iterator function
        i <n> Counter value
    > Ox.loop(10, function(i) { i == 4 && Ox.Break() })
    4
    > Ox.loop(0, 3, 2, function() {})
    4
@*/
Ox.loop = function() {
    var length = arguments.length,
        start = length > 2 ? arguments[0] : 0,
        stop = arguments[length > 2 ? 1 : 0],
        step = length == 4 ? arguments[2] : (start <= stop ? 1 : -1),
        iterator = arguments[length - 1],
        i;
    try {
        for (i = start; step > 0 ? i < stop : i > stop; i += step) {
            // iterator(i);
            if (iterator(i) === false) {
                throw new Error('Returning false in Ox.loop is deprecated.');
            }
        }
    } catch (error) {
        if (error !== Ox.BreakError) {
            throw error;
        }
    }
    return i;
};

/*@
Ox.print <f> Prints its arguments to the console
    (arg, ...) -> <s> String
        The string contains the timestamp, the name of the caller function, and
        any arguments, separated by spaces
    arg <*> any value
    > Ox.print('foo').split(' ').pop()
    "foo"
@*/
Ox.print = function() {
    var args = Ox.toArray(arguments),
        date = new Date();
    args.unshift(
        Ox.formatDate(date, '%H:%M:%S.') + (+date).toString().slice(-3)
    );
    window.console && window.console.log.apply(window.console, args);
    return args.join(' ');
};

/*@
Ox.uid <f> Returns a unique id
    () -> <n> Unique id
    > Ox.uid() != Ox.uid()
    true
@*/
Ox.uid = (function() {
    var uid = 0;
    return function() {
        return uid++;
    };
}());

/*@
Ox.wrap <f> Wraps a value so that one can directly call any Ox function on it
    <code>Ox(value)</code> is a shorthand for <code>Ox.wrap(value)</code>.
    (value) -> <o> wrapped value
        chain <f> Wrap return values to allow chaining
        value <f> Unwrap the value wrapped by <code>chain()</chain>
    value <*> Any value
    > Ox("foobar").repeat(2)
    "foobarfoobar"
    > Ox("foobar").chain().reverse().toTitleCase().value()
    "Raboof"
    > Ox.wrap("foobar").value()
    "foobar"
@*/
Ox.wrap = function(value, chained) {
    // somewhat inspired by underscore.js
    var wrapper = {
        chain: function() {
            wrapper.chained = true;
            return wrapper;
        },
        chained: chained || false,
        value: function() {
            return value;
        }
    };
    Object.getOwnPropertyNames(Ox).forEach(function(name) {
        if (
            ['arguments', 'callee', 'caller', 'length'].indexOf(name) == -1
            && name[0] == name[0].toLowerCase()
            && Ox.isFunction(Ox[name])
        ) {
            wrapper[name] = function() {
                var args = Array.prototype.slice.call(arguments), ret;
                args.unshift(value);
                ret = Ox[name].apply(Ox, args);
                return wrapper.chained ? Ox.wrap(ret, true) : ret;
            };
        }
    });
    return wrapper;
};