thumbs.js

// Thumbs.js 0.1.8
//
// Copyright (c) 2013 Pollenware.
// Distributed under MIT license.
//
// http://thumbsjs.com

(function () {
    /*globals module:true,exports:true,define:true,require:true*/

    var root = this;

    function defineThumbs(Backbone, _) {
        var previousThumbs = root.Thumbs,
            Thumbs = {},
            _extend = Backbone.Model.extend;

        Backbone.Thumbs = Thumbs;

        Thumbs.MULTI_ARG_TOKEN = / +/;
        Thumbs.KEY_VALUE_TOKEN = ":";

        Thumbs.noConflict = function () {
            root.Thumbs = previousThumbs;
            return this;
        };

        Thumbs.viewRegistry = (function () {
            var _hash = {},
                _length = 0;

            var viewRegistry = {
                _hash: _hash,
                getEnclosingView: function (searchNode) {
                    var id, node = searchNode;
                    while (node) {
                        if (node !== searchNode && (id = node.nodeType === 1 && node.getAttribute("thumbs-id"))) {
                            return _hash[id];
                        }
                        node = node.parentNode;
                    }
                    return null;
                },
                remove: function (id) {
                    if (_hash.hasOwnProperty(id)) {
                        delete _hash[id];
                        _length--;
                    }
                },
                add: function (view) {
                    var id = view.thumbsId;
                    if (_hash.hasOwnProperty(id)) {
                        throw new Error("Tried to register view with id " + id + " but that id is already registered");
                    }
                    if (id) {
                        _hash[id] = view;
                        _length++;
                    }
                },
                get: function (id) {
                    return "string" === typeof id ? _hash[id] : id;
                },
                uniqueId: function () {
                    return _.uniqueId("thumbs_view_");
                },
                getSubViews: function (node) {
                    var ret = [];

                    function gatherViews(root) {
                        var thumbsId, node, view;
                        for (node = root.firstChild; node; node = node.nextSibling) {
                            if (node.nodeType === 1) {
                                if ((thumbsId = node.getAttribute("thumbs-id")) && (view = _hash[thumbsId])) {
                                    ret.push(view);
                                }
                            }
                        }
                    }

                    gatherViews(node);
                    return ret;
                },
                getByNode: function (node) {
                    return node ? _hash[node.thumbsId || node.getAttribute("thumbs-id")] : undefined;
                },
                toArray: function () {
                    return _.values(_hash);
                }
            };

            return viewRegistry;
        })();

        Thumbs.viewByNode = Thumbs.viewRegistry.getByNode;
        Thumbs.viewById = Thumbs.viewRegistry.get;


        Thumbs.extend = function(prototype, staticProps) {
            var child = _extend.apply(this, arguments);
            child.prototype.__getConstructor = function () {
                return child;
            };

            return child;
        };

        Backbone.Model.extend = Backbone.Collection.extend = Backbone.View.extend = Backbone.History.extend = Backbone.Router.extend = Thumbs.extend;

        Thumbs._super = {
            _super: (function () {
                function findSuper(methodName, childObject) {
                    var object = childObject;
                    while (object[methodName] === childObject[methodName] && object.__getConstructor) {
                        var constructor = object.__getConstructor();
                        object = constructor['__super__'];
                    }

                    return object;
                }

                return function(methodName, args) {
                    if (!this._superCallObjects) {
                        this._superCallObjects = {};
                    }

                    var result,
                    currentObject = this._superCallObjects[methodName] || this,
                    parentObject = findSuper(methodName, currentObject);

                    this._superCallObjects[methodName] = parentObject;

                    result = parentObject[methodName].apply(this, args || {});
                    delete this._superCallObjects[methodName];
                    return result;
                };
            })()
        };

        // add Backbone.Events to the Thumbs namespace
        Thumbs.Events = Backbone.Events;

        // add Backbone.sync to Thumbs namespace
        Thumbs.sync = Backbone.sync;

        Thumbs.Class = (function () {

    var Class = function (options) {
        this.cid = _.uniqueId("class");
        this.initialize.apply(this, arguments);
    };

    _.extend(Class.prototype, Backbone.Events, Thumbs._super, {
        initialize: function () {}
    });

    Class.extend = Thumbs.extend;

    return Class;
})();

        Thumbs.Model = Backbone.Model.extend(Thumbs._super).extend({
});

        Thumbs.Collection = Backbone.Collection.extend(Thumbs._super).extend({
});

        Thumbs.History = (function () {
    var History = Backbone.History.extend(Thumbs._super).extend({
        notFoundRedirect: null,

        checkPreRouteHandler: function (handlers, path, fragment) {
            var result = true;
            var routeHandler = _.find(handlers, function (handler) {
                return handler.route.test(path + fragment);
            });

            if (routeHandler && routeHandler.callback) {
                result = routeHandler.callback(fragment);
            }

            return result;
        },

        loadUrl: function (fragmentOverride) {
            var fragment = this.fragment = this.getFragment(fragmentOverride);
            var matched = this.checkPreRouteHandler(this.handlers, 'pre-route_all', fragment);
            if (matched) {
                matched = this._super('loadUrl', arguments);
                if (!matched) {
                    if (this.options.notFoundRedirect) {
                        this.navigate(this.options.notFoundRedirect, { trigger: true });
                        matched = true;
                    }
                }
            }

            return matched;
        }
    });

    // create new history instance
    Thumbs.history = Backbone.history = new History();

    return History;
})();

        Thumbs.Router = Backbone.Router.extend(Thumbs._super).extend({
    preRoutes: null,

    _bindRoutes: function () {
        if (this.preBind && _.isFunction(this.preBind)) {
            this.preBind();
        }
        this._super('_bindRoutes', arguments);
    },

    route: function (route, name, callback) {
        if (!Thumbs.history) {
            Thumbs.history = Backbone.history;
        }

        this._super('route', arguments);

        this.setupPreRoute('all', route);
        this.setupPreRoute(null, route);

        return this;
    },

    setupPreRoute: function (path, route) {
        var checks, callback, preRoute;
        if (!path) {
            path = route;
            preRoute = "pre-route_" + route;
        } else {
            preRoute = "pre-route_" + path + route;
        }

        if (this.preRoutes && this.preRoutes[path]) {
            callback = this.preRoutes[path];

            if (_.isString(callback)) {
                callback = this[callback];
            } else if (_.isArray(callback)) {
                checks = callback;
                callback = _.bind(function () {
                    var i, result = true;
                    for (i = 0; i < checks.length; ++i) {
                        result = checks[i].apply(this);
                        if (!result) {
                            break;
                        }
                    }

                    return result;
                }, this);
            }

            if (!_.isRegExp(preRoute)) {
                preRoute = this._routeToRegExp(preRoute);
            }

            Thumbs.history.route(preRoute, _.bind(function () {
                return callback.apply(this);
            }, this));
        }

        return this;
    }
});

        Thumbs.View = (function () {
    var viewRegistry = Thumbs.viewRegistry;

    function splitParts(m, cb) {
        return _.each(m.split(Thumbs.MULTI_ARG_TOKEN), function (m) {
            cb(_.map(m.split(Thumbs.KEY_VALUE_TOKEN), function (m) {
                return $.trim(m);
            }));
        });
    }

    function setElData($el, data, type) {
        var thumbsId;
        if ((thumbsId = $el.attr("thumbs-id"))) {
            $el = viewRegistry.get(thumbsId) || $el;
        }
        if (type) {
            //if we have a type then we can try to look up the type function on the element
            if ("function" === typeof $el[type]) {
                $el[type](data);
            } else {
                //otherwise set it as an attribute
                if ($el.attr) {
                    $el.attr(type, data);
                } else if ($el instanceof View) {
                    $el[type] = data;
                } else {
                    throw new Error("unable to determine how to set data on " + $el);
                }
            }
        } else {
            //otherwise try to infer the type
            if ($el.is && $el.is("input")) {
                //if we are a checkbox or radio then go ahead an assumed checked
                if ($el.is("[type=checkbox], [type=radio]")) {
                    $el.attr("checked", data);
                } else {
                    //otherwise set the value of the input element
                    $el.val(data);
                }
            } else if ($el instanceof View && $el.val) {
                $el.val(data);
            } else if ($el.text) {
                //if we are not an input assume it is text
                $el.text(data);
            } else {
                throw new Error("unable to determine how to set data on " + $el);
            }
        }
    }

    var View = Backbone.View.extend(Thumbs._super).extend({
        _subviews: null,
        __subviews: null,
        __identifiers: null,
        __monitors: null,
        __events: null,

        initialize: function () {
            _.bindAll(this, "setElData", "__updateValues", "__setValues", "setupType", "setupBind", "setupClassBind", "setupEventBind", "findThumbsBind", "turnOnModelListeners", "turnOffModelListeners", "setupBinders");
            this.thumbsId = viewRegistry.uniqueId();
            viewRegistry.add(this);
            this._subviews = {};
            this.__subviews = [];
            this.__identifiers = [];
            this.__monitors = {};
            this.__events = {};
            this._super('initialize', arguments);
            if (this.$el) {
                this.$el.attr("thumbs-id", this.thumbsId);
            }
        },

        __updateValues: function () {
            if (this.model && this.model instanceof Thumbs.Model) {
                return this.__setValues(this.model.changedAttributes());
            }

            return this;
        },

        __setValues: function (values) {
            var monitors = this.__monitors;
            if (monitors) {
                _.each(values, function (val, key) {
                    var mon = monitors[key];
                    if (mon) {
                        _.each(mon, function (fn) {
                            fn(val);
                        });
                    }
                });
            }
        },

        setElData: function (el, data, type, attribute) {
            this.checkFormatting(el, data, type);

            return this;
        },

        setupType: function (m, el, type) {
            var monitors = this.__monitors;
            if (!(m in monitors)) {
                monitors[m] = [];
            }

            monitors[m].push(_.bind(function (data) {
                if ("function" === typeof el) {
                    el(data, m);
                } else {
                    this.setElData(el, data, type, m);
                }
            }, this));
        },

        setupBind: function (el) {
            if (viewRegistry.getEnclosingView(el) === this) {
                var $el = $(el), setupType = this.setupType;
                splitParts($el.data("thumbs-bind"), function (mParts) {
                    if (mParts.length === 1) {
                        setupType(mParts[0], el);
                    } else if (mParts.length === 2) {
                        setupType(mParts[1], el, mParts[0]);
                    } else {
                        throw new TypeError("Invalid data-thumbs-bind definition");
                    }
                });
            }
        },

        setupClassBind: function (el) {
            if (viewRegistry.getEnclosingView(el) === this) {
                var $el = $(el), setupType = this.setupType;
                splitParts($el.data("thumbs-bind-class"), function (mParts) {
                    if (mParts.length === 2) {
                        var clazz = mParts[0];
                        setupType(mParts[1], function (data) {
                            $el.toggleClass(clazz, data);
                        });
                    } else {
                        throw new TypeError("Invalid data-thumbs-bind-class definition");
                    }
                });
            }
        },

        setupEventBind: function (el) {
            if (viewRegistry.getEnclosingView(el) === this) {
                var events = this.__events;
                var $el = $(el), view = this;
                splitParts($el.data("thumbs-bind-event"), function (mParts) {
                    if (mParts.length === 2) {
                        var event = mParts[0], eventListeners = events[event];
                        if (!eventListeners) {
                            eventListeners = events[event] = [];
                        }
                        eventListeners.push(view[mParts[1]]);
                    } else {
                        throw new TypeError("Invalid data-thumbs-bind-class definition");
                    }
                });
            }
        },


        findThumbsBind: function () {
            var setupBind = this.setupBind,
                setupClassBind = this.setupClassBind,
                setupEventBind = this.setupEventBind;
            this.$("[data-thumbs-bind]").each(function () {
                setupBind(this);
            });
            this.$("[data-thumbs-bind-event]").each(function () {
                setupEventBind(this);
            });

            this.$("[data-thumbs-bind-class]").each(function () {
                setupClassBind(this);
            });
            if (this.$el.is("[data-thumbs-bind]")) {
                setupBind(this.el);
            }
            if (this.$el.is("[data-thumbs-bind-class]")) {
                setupClassBind(this.el);
            }
            if (this.$el.is("[data-thumbs-bind-event]")) {
                setupEventBind(this.el);
            }
            return this;
        },

        turnOnModelListeners: function () {
            var model = this.model || this.collection;
            if (model) {
                var monitors = this.__monitors, events = this.__events;
                if (monitors) {
                    _.each(this.__monitors, function (modelListeners, event) {
                        modelListeners.fn = function (model, val) {
                            _.each(modelListeners, function (l) {
                                l.apply(this, [val]);
                            }, this);
                        };
                        model.on("change:" + event, modelListeners.fn, this);
                    }, this);
                }
                if (events) {
                    _.each(this.__events, function (eventListeners, event) {
                        eventListeners.fn = function () {
                            var args = arguments;
                            _.each(eventListeners, function (l) {
                                l.apply(this, args);
                            }, this);
                        };
                        model.on(event, eventListeners.fn, this);
                    }, this);
                }
            }
            return this;
        },

        turnOffModelListeners: function () {
            var model = this.model || this.collection;
            if (model) {
                var monitors = this.__monitors, events = this.__events;
                if (monitors) {
                    //loop through each monitor and turn them off
                    _.each(this.__monitors, function (modelListeners, event) {
                        model.off("change:" + event, modelListeners.fn, this);
                    }, this);
                }
                if (events) {
                    //loop through bound events and turn them off
                    _.each(this.__events, function (eventListeners, event) {
                        model.off(event, eventListeners.fn, this);
                    }, this);
                }
            }
            return this;
        },


        setupBinders: function () {
            var model = this.model || this.collection;
            //turn off previous model listeners incase render is called more than once
            this.turnOffModelListeners()
                //find new ones
                .findThumbsBind()
                //turn them on again
                .turnOnModelListeners();
            if (model) {
                this.__setValues(model.attributes);
            }
            return this;
        },

        removeIdentifiers: function () {
            _.each(this.__identifiers, function (id) {
                this[id] = this['$' + id] = null;
            }, this);
            this.__identifiers = [];
        },

        checkForIdentifiers: function () {
            var self = this;
            this.removeIdentifiers();
            this.$('[data-thumbs-id]').each(function (el) {
                if (viewRegistry.getEnclosingView(this) === self) {
                    var $this = $(this);
                    var id = $this.data('thumbs-id');
                    self[id] = this;
                    self['$' + id] = viewRegistry.getByNode(this) || $this;
                    self.__identifiers.push(id);
                }
            });
            return this;
        },

        findEl: function () {
            var setElement = _.bind(this.setElement, this);
            //find an elements that are marked with data-thumbs-el
            var el = this.$("[data-thumbs-el]").first().get();
            if (el.length) {
                //we found some!
                el = el[0];
                //ensure that its not already our dom element
                if (el !== this.el) {
                    //set it
                    setElement(el);
                }
            }
            return this;
        },

        checkFormatting: function (el, data, type) {
            var formatter, $el = $(el), args = Array.prototype.slice.call(arguments, 0);
            data = args.length > 1 ? data : $el.text();
            data = (data !== null && "undefined" !== typeof data) ? data : "";
            formatter = $el.data("thumbs-format");

            splitParts(formatter || "", function (formatterParts) {
                if (formatterParts.length === 2) {
                    type = formatterParts[0];
                    formatter = formatterParts[1];
                } else {
                    formatter = formatterParts.pop();
                }
            });

            if (formatter && "function" === typeof this[formatter]) {
                data = this[formatter](data);
            }

            setElData($el, data, type);

            return this;
        },

        renderFormatters: function () {
            var self = this;
            this.$('[data-thumbs-format]').each(function () {
                self.checkFormatting(this);
            });

            return this;
        },

        setElement: function () {
            var ret = this._super("setElement", arguments);
            if (this.el) {
                this.$el.attr("thumbs-id", this.thumbsId);
            } else {
                viewRegistry.remove(this.thumbsId);
            }
            return this;
        },

        addSubView: function (selector, view) {
            if (view) {
                this.removeSubView(selector);
                this._subviews[selector] = view;
                view.setElement(this.$(selector)).render();
            }

            return this;
        },

        removeSubView: function (selector) {
            var view = this._subviews[selector];
            if (view) {
                view.setElement(null);
                view.remove();
                this.$(selector).empty();
                this._subviews[selector] = null;
            }

            return this;
        },

        removeSubViews: function () {
            _.each(this._subviews, function (view, selector) {
                this.removeSubView(selector);
            }, this);

            return this;
        },

        checkForEvents: function () {
            var self = this;
            this.events = this.events || {};
            this.$('[data-thumbs-delegate]').each(function () {
                var thumbsView = viewRegistry.get($(this).attr("thumbs-id"));
                if (viewRegistry.getEnclosingView(this) === self) {
                    var $this = $(this), id = _.uniqueId('thumbs_');
                    $this.addClass(id);
                    splitParts($this.data('thumbs-delegate'), function (data) {
                        var event = data[0], func = data[1];
                        self.events[event + ' .' + id] = func;
                        if (thumbsView) {
                            //Listen to event if this is a thumbs-view
                            self.listenTo(thumbsView, event, self[func]);
                        }
                    });
                }
            });
            this.delegateEvents();
            return this;
        },

        render: function () {
            // this order matters
            this.checkForSubviews()
                .checkForEvents()
                .setupBinders()
                .checkForIdentifiers()
                .renderFormatters()
                .findEl()
                .assign(this._subviews)
                ._super('render', arguments);
            return this;
        },

        assign: function (selector, view) {
            var selectors;
            if (_.isObject(selector)) {
                selectors = selector;
            } else if (selector) {
                selectors = {};
                selectors[selector] = view;
            }

            if (selectors) {
                _.each(selectors, function (view, selector) {
                    this.addSubView(selector, view);
                }, this);
            }

            return this;
        },

        _parseViewArgs: function (args) {
            /*jshint evil:true*/
            var ret = {};
            if (args) {
                try {
                    _.extend(ret, eval("with(this){({" + args + "})}"));
                } catch (e) {
                    throw new Error("Unable to parse data-thumbs-args : " + args + " : " + e.toString());
                }
            }
            return ret;
        },

        renderSubviewView: function (el) {
            var SubView = null, id,
                $el = $(el),
                v = $el.data('thumbs-view');
            if (v && (SubView = this[v])) {
                var args = this._parseViewArgs($el.data('thumbs-args'));
                _.extend(args, { el: el});
                var view = new SubView(args);
                view.render();
                this.__subviews.push(view);
                if (!!(id = $el.data('thumbs-id'))) {
                    this["$" + id] = view;
                }
            } else {
                throw new Error("Unable to find " + v + " on view");
            }
            return this;
        },


        checkForSubviews: function () {
            var self = this;
            this.$('[data-thumbs-view]').each(function () {
                self.renderSubviewView(this);
            });

            return this;
        },

        remove: function () {
            if (this.__subviews.length) {
                _.each(this.__subviews, function (subview) {
                    subview.remove();
                });

                this.__subviews = [];
            }
            this.stopListening();
            this.removeSubViews();
            this.turnOffModelListeners();
            this.removeIdentifiers();
            this.__monitors = {};
            this.__events = {};
            this._super('remove', arguments);
            return this;
        }
    });

    return View;
})();

        Thumbs.TemplateView = (function () {

    //helper to set a shared templater. Defaults to _.template
    Thumbs.templater = (function () {
        //bring a private templater into scope
        var templater = _.template;
        return function __templater(tmplr) {
            if (tmplr) {
                //if a templater was passed in then set it
                templater = tmplr;
                return templater;
            } else {
                //otherwise just get the templater
                return templater;
            }
        };
    }());

    var TemplateView = Thumbs.View.extend({
        templater: null,
        template: null,

        initialize: function (options) {
            this._super("initialize", arguments);
            if (!this.templater) {
                this.templater = Thumbs.templater();
            }

            if (_.isString(this.template)) {
                this._template = this.templater(this.template);
            } else if (_.isFunction(this.template)) {
                this._template = this.template;
            } else {
                throw "Unexpected template property type";
            }
        },

        getTemplateData: function () {
            return (this.model || this.collection) ? (this.model || this.collection)["toJSON"]() : {};
        },

        fillTemplate: function (data) {
            if (this._template) {
                return this._template(data || this.getTemplateData());
            } else {
                return null;
            }
        },

        renderTemplate: function () {
            if (this._template) {
                var template = this.fillTemplate();
                if (template) {
                    this.$el.html(template);
                }
            }

            return  this;
        },

        render: function () {
            this.renderTemplate()
                ._super("render", arguments);
            return this;
        }
    });

    return TemplateView;
})();


        return Thumbs;
    }


    if (typeof exports === 'object') {
        var underscore = require('undersore'),
            backbone = require('backbone');

        module.exports = defineThumbs(backbone, underscore);
    } else  if (typeof define === 'function' && define.amd) {
        define(['underscore', 'backbone'], function (_, Backbone) {
            return defineThumbs(Backbone, _);
        });
    } else {
        root.Thumbs = root.thumbs = defineThumbs(root.Backbone, root._);
    }

}).call(this);