Skip to content

T
todomvc
Commit c5b1781e authored by Pascal Hartig's avatar Pascal Hartig
Browse files
Options

Backbone: Updated to 1.0

parent b542c361
Show whitespace changes
Inline Side-by-side
Showing with 600 additions and 507 deletions
architecture-examples/backbone/component.json
View file @ c5b1781e
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
"name": "todomvc-backbone", "name": "todomvc-backbone",
"version": "0.0.0", "version": "0.0.0",
"dependencies": { "dependencies": {
"backbone": "~0.9.10", "backbone": "~1.0.0",
"underscore": "~1.4.4", "underscore": "~1.4.4",
"jquery": "~1.9.1", "jquery": "~1.9.1",
"todomvc-common": "~0.1.0", "todomvc-common": "~0.1.0",
......
architecture-examples/backbone/components/backbone/backbone.js
View file @ c5b1781e
// Backbone.js 0.9.10 // Backbone.js 1.0.0
// (c) 2010-2012 Jeremy Ashkenas, DocumentCloud Inc. // (c) 2010-2013 Jeremy Ashkenas, DocumentCloud Inc.
// Backbone may be freely distributed under the MIT license. // Backbone may be freely distributed under the MIT license.
// For all details and documentation: // For all details and documentation:
// http://backbonejs.org // http://backbonejs.org
...@@ -18,14 +18,14 @@ ...@@ -18,14 +18,14 @@
// restored later on, if `noConflict` is used. // restored later on, if `noConflict` is used.
var previousBackbone = root.Backbone; var previousBackbone = root.Backbone;
// Create a local reference to array methods. // Create local references to array methods we'll want to use later.
var array = []; var array = [];
var push = array.push; var push = array.push;
var slice = array.slice; var slice = array.slice;
var splice = array.splice; var splice = array.splice;
// The top-level namespace. All public Backbone classes and modules will // The top-level namespace. All public Backbone classes and modules will
// be attached to this. Exported for both CommonJS and the browser. // be attached to this. Exported for both the browser and the server.
var Backbone; var Backbone;
if (typeof exports !== 'undefined') { if (typeof exports !== 'undefined') {
Backbone = exports; Backbone = exports;
...@@ -34,14 +34,15 @@ ...@@ -34,14 +34,15 @@
} }
// Current version of the library. Keep in sync with `package.json`. // Current version of the library. Keep in sync with `package.json`.
Backbone.VERSION = '0.9.10'; Backbone.VERSION = '1.0.0';
// Require Underscore, if we're on the server, and it's not already present. // Require Underscore, if we're on the server, and it's not already present.
var _ = root._; var _ = root._;
if (!_ && (typeof require !== 'undefined')) _ = require('underscore'); if (!_ && (typeof require !== 'undefined')) _ = require('underscore');
// For Backbone's purposes, jQuery, Zepto, or Ender owns the `$` variable. // For Backbone's purposes, jQuery, Zepto, Ender, or My Library (kidding) owns
Backbone.$ = root.jQuery || root.Zepto || root.ender; // the `$` variable.
Backbone.$ = root.jQuery || root.Zepto || root.ender || root.$;
// Runs Backbone.js in *noConflict* mode, returning the `Backbone` variable // Runs Backbone.js in *noConflict* mode, returning the `Backbone` variable
// to its previous owner. Returns a reference to this Backbone object. // to its previous owner. Returns a reference to this Backbone object.
...@@ -64,45 +65,6 @@ ...@@ -64,45 +65,6 @@
// Backbone.Events // Backbone.Events
// --------------- // ---------------
// Regular expression used to split event strings.
var eventSplitter = /\s+/;
// Implement fancy features of the Events API such as multiple event
// names `"change blur"` and jQuery-style event maps `{change: action}`
// in terms of the existing API.
var eventsApi = function(obj, action, name, rest) {
if (!name) return true;
if (typeof name === 'object') {
for (var key in name) {
obj[action].apply(obj, [key, name[key]].concat(rest));
}
} else if (eventSplitter.test(name)) {
var names = name.split(eventSplitter);
for (var i = 0, l = names.length; i < l; i++) {
obj[action].apply(obj, [names[i]].concat(rest));
}
} else {
return true;
}
};
// Optimized internal dispatch function for triggering events. Tries to
// keep the usual cases speedy (most Backbone events have 3 arguments).
var triggerEvents = function(events, args) {
var ev, i = -1, l = events.length;
switch (args.length) {
case 0: while (++i < l) (ev = events[i]).callback.call(ev.ctx);
return;
case 1: while (++i < l) (ev = events[i]).callback.call(ev.ctx, args[0]);
return;
case 2: while (++i < l) (ev = events[i]).callback.call(ev.ctx, args[0], args[1]);
return;
case 3: while (++i < l) (ev = events[i]).callback.call(ev.ctx, args[0], args[1], args[2]);
return;
default: while (++i < l) (ev = events[i]).callback.apply(ev.ctx, args);
}
};
// A module that can be mixed in to *any object* in order to provide it with // A module that can be mixed in to *any object* in order to provide it with
// custom events. You may bind with `on` or remove with `off` callback // custom events. You may bind with `on` or remove with `off` callback
// functions to an event; `trigger`-ing an event fires all callbacks in // functions to an event; `trigger`-ing an event fires all callbacks in
...@@ -115,29 +77,27 @@ ...@@ -115,29 +77,27 @@
// //
var Events = Backbone.Events = { var Events = Backbone.Events = {
// Bind one or more space separated events, or an events map, // Bind an event to a `callback` function. Passing `"all"` will bind
// to a `callback` function. Passing `"all"` will bind the callback to // the callback to all events fired.
// all events fired.
on: function(name, callback, context) { on: function(name, callback, context) {
if (!(eventsApi(this, 'on', name, [callback, context]) && callback)) return this; if (!eventsApi(this, 'on', name, [callback, context]) || !callback) return this;
this._events || (this._events = {}); this._events || (this._events = {});
var list = this._events[name] || (this._events[name] = []); var events = this._events[name] || (this._events[name] = []);
list.push({callback: callback, context: context, ctx: context || this}); events.push({callback: callback, context: context, ctx: context || this});
return this; return this;
}, },
// Bind events to only be triggered a single time. After the first time // Bind an event to only be triggered a single time. After the first time
// the callback is invoked, it will be removed. // the callback is invoked, it will be removed.
once: function(name, callback, context) { once: function(name, callback, context) {
if (!(eventsApi(this, 'once', name, [callback, context]) && callback)) return this; if (!eventsApi(this, 'once', name, [callback, context]) || !callback) return this;
var self = this; var self = this;
var once = _.once(function() { var once = _.once(function() {
self.off(name, once); self.off(name, once);
callback.apply(this, arguments); callback.apply(this, arguments);
}); });
once._callback = callback; once._callback = callback;
this.on(name, once, context); return this.on(name, once, context);
return this;
}, },
// Remove one or many callbacks. If `context` is null, removes all // Remove one or many callbacks. If `context` is null, removes all
...@@ -145,7 +105,7 @@ ...@@ -145,7 +105,7 @@
// callbacks for the event. If `name` is null, removes all bound // callbacks for the event. If `name` is null, removes all bound
// callbacks for all events. // callbacks for all events.
off: function(name, callback, context) { off: function(name, callback, context) {
var list, ev, events, names, i, l, j, k; var retain, ev, events, names, i, l, j, k;
if (!this._events || !eventsApi(this, 'off', name, [callback, context])) return this; if (!this._events || !eventsApi(this, 'off', name, [callback, context])) return this;
if (!name && !callback && !context) { if (!name && !callback && !context) {
this._events = {}; this._events = {};
...@@ -155,19 +115,18 @@ ...@@ -155,19 +115,18 @@
names = name ? [name] : _.keys(this._events); names = name ? [name] : _.keys(this._events);
for (i = 0, l = names.length; i < l; i++) { for (i = 0, l = names.length; i < l; i++) {
name = names[i]; name = names[i];
if (list = this._events[name]) { if (events = this._events[name]) {
events = []; this._events[name] = retain = [];
if (callback || context) { if (callback || context) {
for (j = 0, k = list.length; j < k; j++) { for (j = 0, k = events.length; j < k; j++) {
ev = list[j]; ev = events[j];
if ((callback && callback !== ev.callback && if ((callback && callback !== ev.callback && callback !== ev.callback._callback) ||
callback !== ev.callback._callback) ||
(context && context !== ev.context)) { (context && context !== ev.context)) {
events.push(ev); retain.push(ev);
} }
} }
} }
this._events[name] = events; if (!retain.length) delete this._events[name];
} }
} }
...@@ -189,34 +148,81 @@ ...@@ -189,34 +148,81 @@
return this; return this;
}, },
// An inversion-of-control version of `on`. Tell *this* object to listen to
// an event in another object ... keeping track of what it's listening to.
listenTo: function(obj, name, callback) {
var listeners = this._listeners || (this._listeners = {});
var id = obj._listenerId || (obj._listenerId = _.uniqueId('l'));
listeners[id] = obj;
obj.on(name, typeof name === 'object' ? this : callback, this);
return this;
},
// Tell this object to stop listening to either specific events ... or // Tell this object to stop listening to either specific events ... or
// to every object it's currently listening to. // to every object it's currently listening to.
stopListening: function(obj, name, callback) { stopListening: function(obj, name, callback) {
var listeners = this._listeners; var listeners = this._listeners;
if (!listeners) return; if (!listeners) return this;
if (obj) { var deleteListener = !name && !callback;
obj.off(name, typeof name === 'object' ? this : callback, this);
if (!name && !callback) delete listeners[obj._listenerId];
} else {
if (typeof name === 'object') callback = this; if (typeof name === 'object') callback = this;
if (obj) (listeners = {})[obj._listenerId] = obj;
for (var id in listeners) { for (var id in listeners) {
listeners[id].off(name, callback, this); listeners[id].off(name, callback, this);
} if (deleteListener) delete this._listeners[id];
this._listeners = {};
} }
return this; return this;
} }
};
// Regular expression used to split event strings.
var eventSplitter = /\s+/;
// Implement fancy features of the Events API such as multiple event
// names `"change blur"` and jQuery-style event maps `{change: action}`
// in terms of the existing API.
var eventsApi = function(obj, action, name, rest) {
if (!name) return true;
// Handle event maps.
if (typeof name === 'object') {
for (var key in name) {
obj[action].apply(obj, [key, name[key]].concat(rest));
}
return false;
}
// Handle space separated event names.
if (eventSplitter.test(name)) {
var names = name.split(eventSplitter);
for (var i = 0, l = names.length; i < l; i++) {
obj[action].apply(obj, [names[i]].concat(rest));
}
return false;
}
return true;
};
// A difficult-to-believe, but optimized internal dispatch function for
// triggering events. Tries to keep the usual cases speedy (most internal
// Backbone events have 3 arguments).
var triggerEvents = function(events, args) {
var ev, i = -1, l = events.length, a1 = args[0], a2 = args[1], a3 = args[2];
switch (args.length) {
case 0: while (++i < l) (ev = events[i]).callback.call(ev.ctx); return;
case 1: while (++i < l) (ev = events[i]).callback.call(ev.ctx, a1); return;
case 2: while (++i < l) (ev = events[i]).callback.call(ev.ctx, a1, a2); return;
case 3: while (++i < l) (ev = events[i]).callback.call(ev.ctx, a1, a2, a3); return;
default: while (++i < l) (ev = events[i]).callback.apply(ev.ctx, args);
}
};
var listenMethods = {listenTo: 'on', listenToOnce: 'once'};
// Inversion-of-control versions of `on` and `once`. Tell *this* object to
// listen to an event in another object ... keeping track of what it's
// listening to.
_.each(listenMethods, function(implementation, method) {
Events[method] = function(obj, name, callback) {
var listeners = this._listeners || (this._listeners = {});
var id = obj._listenerId || (obj._listenerId = _.uniqueId('l'));
listeners[id] = obj;
if (typeof name === 'object') callback = this;
obj[implementation](name, callback, this);
return this;
}; };
});
// Aliases for backwards compatibility. // Aliases for backwards compatibility.
Events.bind = Events.on; Events.bind = Events.on;
...@@ -229,15 +235,21 @@ ...@@ -229,15 +235,21 @@
// Backbone.Model // Backbone.Model
// -------------- // --------------
// Create a new model, with defined attributes. A client id (`cid`) // Backbone **Models** are the basic data object in the framework --
// frequently representing a row in a table in a database on your server.
// A discrete chunk of data and a bunch of useful, related methods for
// performing computations and transformations on that data.
// Create a new model with the specified attributes. A client id (`cid`)
// is automatically generated and assigned for you. // is automatically generated and assigned for you.
var Model = Backbone.Model = function(attributes, options) { var Model = Backbone.Model = function(attributes, options) {
var defaults; var defaults;
var attrs = attributes || {}; var attrs = attributes || {};
options || (options = {});
this.cid = _.uniqueId('c'); this.cid = _.uniqueId('c');
this.attributes = {}; this.attributes = {};
if (options && options.collection) this.collection = options.collection; _.extend(this, _.pick(options, modelOptions));
if (options && options.parse) attrs = this.parse(attrs, options) || {}; if (options.parse) attrs = this.parse(attrs, options) || {};
if (defaults = _.result(this, 'defaults')) { if (defaults = _.result(this, 'defaults')) {
attrs = _.defaults({}, attrs, defaults); attrs = _.defaults({}, attrs, defaults);
} }
...@@ -246,12 +258,18 @@ ...@@ -246,12 +258,18 @@
this.initialize.apply(this, arguments); this.initialize.apply(this, arguments);
}; };
// A list of options to be attached directly to the model, if provided.
var modelOptions = ['url', 'urlRoot', 'collection'];
// Attach all inheritable methods to the Model prototype. // Attach all inheritable methods to the Model prototype.
_.extend(Model.prototype, Events, { _.extend(Model.prototype, Events, {
// A hash of attributes whose current and previous value differ. // A hash of attributes whose current and previous value differ.
changed: null, changed: null,
// The value returned during the last failed validation.
validationError: null,
// The default name for the JSON `id` attribute is `"id"`. MongoDB and // The default name for the JSON `id` attribute is `"id"`. MongoDB and
// CouchDB users may want to set this to `"_id"`. // CouchDB users may want to set this to `"_id"`.
idAttribute: 'id', idAttribute: 'id',
...@@ -265,7 +283,8 @@ ...@@ -265,7 +283,8 @@
return _.clone(this.attributes); return _.clone(this.attributes);
}, },
// Proxy `Backbone.sync` by default. // Proxy `Backbone.sync` by default -- but override this if you need
// custom syncing semantics for *this* particular model.
sync: function() { sync: function() {
return Backbone.sync.apply(this, arguments); return Backbone.sync.apply(this, arguments);
}, },
...@@ -286,10 +305,9 @@ ...@@ -286,10 +305,9 @@
return this.get(attr) != null; return this.get(attr) != null;
}, },
// ---------------------------------------------------------------------- // Set a hash of model attributes on the object, firing `"change"`. This is
// the core primitive operation of a model, updating the data and notifying
// Set a hash of model attributes on the object, firing `"change"` unless // anyone who needs to know about the change in state. The heart of the beast.
// you choose to silence it.
set: function(key, val, options) { set: function(key, val, options) {
var attr, attrs, unset, changes, silent, changing, prev, current; var attr, attrs, unset, changes, silent, changing, prev, current;
if (key == null) return this; if (key == null) return this;
...@@ -343,6 +361,8 @@ ...@@ -343,6 +361,8 @@
} }
} }
// You might be wondering why there's a `while` loop here. Changes can
// be recursively nested within `"change"` events.
if (changing) return this; if (changing) return this;
if (!silent) { if (!silent) {
while (this._pending) { while (this._pending) {
...@@ -355,14 +375,13 @@ ...@@ -355,14 +375,13 @@
return this; return this;
}, },
// Remove an attribute from the model, firing `"change"` unless you choose // Remove an attribute from the model, firing `"change"`. `unset` is a noop
// to silence it. `unset` is a noop if the attribute doesn't exist. // if the attribute doesn't exist.
unset: function(attr, options) { unset: function(attr, options) {
return this.set(attr, void 0, _.extend({}, options, {unset: true})); return this.set(attr, void 0, _.extend({}, options, {unset: true}));
}, },
// Clear all attributes on the model, firing `"change"` unless you choose // Clear all attributes on the model, firing `"change"`.
// to silence it.
clear: function(options) { clear: function(options) {
var attrs = {}; var attrs = {};
for (var key in this.attributes) attrs[key] = void 0; for (var key in this.attributes) attrs[key] = void 0;
...@@ -406,19 +425,20 @@ ...@@ -406,19 +425,20 @@
return _.clone(this._previousAttributes); return _.clone(this._previousAttributes);
}, },
// ---------------------------------------------------------------------
// Fetch the model from the server. If the server's representation of the // Fetch the model from the server. If the server's representation of the
// model differs from its current attributes, they will be overriden, // model differs from its current attributes, they will be overridden,
// triggering a `"change"` event. // triggering a `"change"` event.
fetch: function(options) { fetch: function(options) {
options = options ? _.clone(options) : {}; options = options ? _.clone(options) : {};
if (options.parse === void 0) options.parse = true; if (options.parse === void 0) options.parse = true;
var model = this;
var success = options.success; var success = options.success;
options.success = function(model, resp, options) { options.success = function(resp) {
if (!model.set(model.parse(resp, options), options)) return false; if (!model.set(model.parse(resp, options), options)) return false;
if (success) success(model, resp, options); if (success) success(model, resp, options);
model.trigger('sync', model, resp, options);
}; };
wrapError(this, options);
return this.sync('read', this, options); return this.sync('read', this, options);
}, },
...@@ -426,7 +446,7 @@ ...@@ -426,7 +446,7 @@
// If the server returns an attributes hash that differs, the model's // If the server returns an attributes hash that differs, the model's
// state will be `set` again. // state will be `set` again.
save: function(key, val, options) { save: function(key, val, options) {
var attrs, success, method, xhr, attributes = this.attributes; var attrs, method, xhr, attributes = this.attributes;
// Handle both `"key", value` and `{key: value}` -style arguments. // Handle both `"key", value` and `{key: value}` -style arguments.
if (key == null || typeof key === 'object') { if (key == null || typeof key === 'object') {
...@@ -452,8 +472,9 @@ ...@@ -452,8 +472,9 @@
// After a successful server-side save, the client is (optionally) // After a successful server-side save, the client is (optionally)
// updated with the server-side state. // updated with the server-side state.
if (options.parse === void 0) options.parse = true; if (options.parse === void 0) options.parse = true;
success = options.success; var model = this;
options.success = function(model, resp, options) { var success = options.success;
options.success = function(resp) {
// Ensure attributes are restored during synchronous saves. // Ensure attributes are restored during synchronous saves.
model.attributes = attributes; model.attributes = attributes;
var serverAttrs = model.parse(resp, options); var serverAttrs = model.parse(resp, options);
...@@ -462,9 +483,10 @@ ...@@ -462,9 +483,10 @@
return false; return false;
} }
if (success) success(model, resp, options); if (success) success(model, resp, options);
model.trigger('sync', model, resp, options);
}; };
wrapError(this, options);
// Finish configuring and sending the Ajax request.
method = this.isNew() ? 'create' : (options.patch ? 'patch' : 'update'); method = this.isNew() ? 'create' : (options.patch ? 'patch' : 'update');
if (method === 'patch') options.attrs = attrs; if (method === 'patch') options.attrs = attrs;
xhr = this.sync(method, this, options); xhr = this.sync(method, this, options);
...@@ -487,15 +509,17 @@ ...@@ -487,15 +509,17 @@
model.trigger('destroy', model, model.collection, options); model.trigger('destroy', model, model.collection, options);
}; };
options.success = function(model, resp, options) { options.success = function(resp) {
if (options.wait || model.isNew()) destroy(); if (options.wait || model.isNew()) destroy();
if (success) success(model, resp, options); if (success) success(model, resp, options);
if (!model.isNew()) model.trigger('sync', model, resp, options);
}; };
if (this.isNew()) { if (this.isNew()) {
options.success(this, null, options); options.success();
return false; return false;
} }
wrapError(this, options);
var xhr = this.sync('delete', this, options); var xhr = this.sync('delete', this, options);
if (!options.wait) destroy(); if (!options.wait) destroy();
...@@ -529,39 +553,61 @@ ...@@ -529,39 +553,61 @@
// Check if the model is currently in a valid state. // Check if the model is currently in a valid state.
isValid: function(options) { isValid: function(options) {
return !this.validate || !this.validate(this.attributes, options); return this._validate({}, _.extend(options || {}, { validate: true }));
}, },
// Run validation against the next complete set of model attributes, // Run validation against the next complete set of model attributes,
// returning `true` if all is well. Otherwise, fire a general // returning `true` if all is well. Otherwise, fire an `"invalid"` event.
// `"error"` event and call the error callback, if specified.
_validate: function(attrs, options) { _validate: function(attrs, options) {
if (!options.validate || !this.validate) return true; if (!options.validate || !this.validate) return true;
attrs = _.extend({}, this.attributes, attrs); attrs = _.extend({}, this.attributes, attrs);
var error = this.validationError = this.validate(attrs, options) || null; var error = this.validationError = this.validate(attrs, options) || null;
if (!error) return true; if (!error) return true;
this.trigger('invalid', this, error, options || {}); this.trigger('invalid', this, error, _.extend(options || {}, {validationError: error}));
return false; return false;
} }
}); });
// Underscore methods that we want to implement on the Model.
var modelMethods = ['keys', 'values', 'pairs', 'invert', 'pick', 'omit'];
// Mix in each Underscore method as a proxy to `Model#attributes`.
_.each(modelMethods, function(method) {
Model.prototype[method] = function() {
var args = slice.call(arguments);
args.unshift(this.attributes);
return _[method].apply(_, args);
};
});
// Backbone.Collection // Backbone.Collection
// ------------------- // -------------------
// Provides a standard collection class for our sets of models, ordered // If models tend to represent a single row of data, a Backbone Collection is
// or unordered. If a `comparator` is specified, the Collection will maintain // more analagous to a table full of data ... or a small slice or page of that
// table, or a collection of rows that belong together for a particular reason
// -- all of the messages in this particular folder, all of the documents
// belonging to this particular author, and so on. Collections maintain
// indexes of their models, both in order, and for lookup by `id`.
// Create a new **Collection**, perhaps to contain a specific type of `model`.
// If a `comparator` is specified, the Collection will maintain
// its models in sort order, as they're added and removed. // its models in sort order, as they're added and removed.
var Collection = Backbone.Collection = function(models, options) { var Collection = Backbone.Collection = function(models, options) {
options || (options = {}); options || (options = {});
if (options.url) this.url = options.url;
if (options.model) this.model = options.model; if (options.model) this.model = options.model;
if (options.comparator !== void 0) this.comparator = options.comparator; if (options.comparator !== void 0) this.comparator = options.comparator;
this.models = [];
this._reset(); this._reset();
this.initialize.apply(this, arguments); this.initialize.apply(this, arguments);
if (models) this.reset(models, _.extend({silent: true}, options)); if (models) this.reset(models, _.extend({silent: true}, options));
}; };
// Default options for `Collection#set`.
var setOptions = {add: true, remove: true, merge: true};
var addOptions = {add: true, merge: false, remove: false};
// Define the Collection's inheritable methods. // Define the Collection's inheritable methods.
_.extend(Collection.prototype, Events, { _.extend(Collection.prototype, Events, {
...@@ -586,34 +632,62 @@ ...@@ -586,34 +632,62 @@
// Add a model, or list of models to the set. // Add a model, or list of models to the set.
add: function(models, options) { add: function(models, options) {
return this.set(models, _.defaults(options || {}, addOptions));
},
// Remove a model, or a list of models from the set.
remove: function(models, options) {
models = _.isArray(models) ? models.slice() : [models]; models = _.isArray(models) ? models.slice() : [models];
options || (options = {}); options || (options = {});
var i, l, model, attrs, existing, doSort, add, at, sort, sortAttr; var i, l, index, model;
add = []; for (i = 0, l = models.length; i < l; i++) {
at = options.at; model = this.get(models[i]);
sort = this.comparator && (at == null) && options.sort != false; if (!model) continue;
sortAttr = _.isString(this.comparator) ? this.comparator : null; delete this._byId[model.id];
delete this._byId[model.cid];
index = this.indexOf(model);
this.models.splice(index, 1);
this.length--;
if (!options.silent) {
options.index = index;
model.trigger('remove', model, this, options);
}
this._removeReference(model);
}
return this;
},
// Update a collection by `set`-ing a new list of models, adding new ones,
// removing models that are no longer present, and merging models that
// already exist in the collection, as necessary. Similar to **Model#set**,
// the core operation for updating the data contained by the collection.
set: function(models, options) {
options = _.defaults(options || {}, setOptions);
if (options.parse) models = this.parse(models, options);
if (!_.isArray(models)) models = models ? [models] : [];
var i, l, model, attrs, existing, sort;
var at = options.at;
var sortable = this.comparator && (at == null) && options.sort !== false;
var sortAttr = _.isString(this.comparator) ? this.comparator : null;
var toAdd = [], toRemove = [], modelMap = {};
// Turn bare objects into model references, and prevent invalid models // Turn bare objects into model references, and prevent invalid models
// from being added. // from being added.
for (i = 0, l = models.length; i < l; i++) { for (i = 0, l = models.length; i < l; i++) {
if (!(model = this._prepareModel(attrs = models[i], options))) { if (!(model = this._prepareModel(models[i], options))) continue;
this.trigger('invalid', this, attrs, options);
continue;
}
// If a duplicate is found, prevent it from being added and // If a duplicate is found, prevent it from being added and
// optionally merge it into the existing model. // optionally merge it into the existing model.
if (existing = this.get(model)) { if (existing = this.get(model)) {
if (options.remove) modelMap[existing.cid] = true;
if (options.merge) { if (options.merge) {
existing.set(attrs === model ? model.attributes : attrs, options); existing.set(model.attributes, options);
if (sort && !doSort && existing.hasChanged(sortAttr)) doSort = true; if (sortable && !sort && existing.hasChanged(sortAttr)) sort = true;
}
continue;
} }
// This is a new model, push it to the `add` list. // This is a new model, push it to the `toAdd` list.
add.push(model); } else if (options.add) {
toAdd.push(model);
// Listen to added models' events, and index models for lookup by // Listen to added models' events, and index models for lookup by
// `id` and by `cid`. // `id` and by `cid`.
...@@ -621,53 +695,55 @@ ...@@ -621,53 +695,55 @@
this._byId[model.cid] = model; this._byId[model.cid] = model;
if (model.id != null) this._byId[model.id] = model; if (model.id != null) this._byId[model.id] = model;
} }
}
// Remove nonexistent models if appropriate.
if (options.remove) {
for (i = 0, l = this.length; i < l; ++i) {
if (!modelMap[(model = this.models[i]).cid]) toRemove.push(model);
}
if (toRemove.length) this.remove(toRemove, options);
}
// See if sorting is needed, update `length` and splice in new models. // See if sorting is needed, update `length` and splice in new models.
if (add.length) { if (toAdd.length) {
if (sort) doSort = true; if (sortable) sort = true;
this.length += add.length; this.length += toAdd.length;
if (at != null) { if (at != null) {
splice.apply(this.models, [at, 0].concat(add)); splice.apply(this.models, [at, 0].concat(toAdd));
} else { } else {
push.apply(this.models, add); push.apply(this.models, toAdd);
} }
} }
// Silently sort the collection if appropriate. // Silently sort the collection if appropriate.
if (doSort) this.sort({silent: true}); if (sort) this.sort({silent: true});
if (options.silent) return this; if (options.silent) return this;
// Trigger `add` events. // Trigger `add` events.
for (i = 0, l = add.length; i < l; i++) { for (i = 0, l = toAdd.length; i < l; i++) {
(model = add[i]).trigger('add', model, this, options); (model = toAdd[i]).trigger('add', model, this, options);
} }
// Trigger `sort` if the collection was sorted. // Trigger `sort` if the collection was sorted.
if (doSort) this.trigger('sort', this, options); if (sort) this.trigger('sort', this, options);
return this; return this;
}, },
// Remove a model, or a list of models from the set. // When you have more items than you want to add or remove individually,
remove: function(models, options) { // you can reset the entire set with a new list of models, without firing
models = _.isArray(models) ? models.slice() : [models]; // any granular `add` or `remove` events. Fires `reset` when finished.
// Useful for bulk operations and optimizations.
reset: function(models, options) {
options || (options = {}); options || (options = {});
var i, l, index, model; for (var i = 0, l = this.models.length; i < l; i++) {
for (i = 0, l = models.length; i < l; i++) { this._removeReference(this.models[i]);
model = this.get(models[i]);
if (!model) continue;
delete this._byId[model.id];
delete this._byId[model.cid];
index = this.indexOf(model);
this.models.splice(index, 1);
this.length--;
if (!options.silent) {
options.index = index;
model.trigger('remove', model, this, options);
}
this._removeReference(model);
} }
options.previousModels = this.models;
this._reset();
this.add(models, _.extend({silent: true}, options));
if (!options.silent) this.trigger('reset', this, options);
return this; return this;
}, },
...@@ -707,8 +783,7 @@ ...@@ -707,8 +783,7 @@
// Get a model from the set by id. // Get a model from the set by id.
get: function(obj) { get: function(obj) {
if (obj == null) return void 0; if (obj == null) return void 0;
this._idAttr || (this._idAttr = this.model.prototype.idAttribute); return this._byId[obj.id != null ? obj.id : obj.cid || obj];
return this._byId[obj.id || obj.cid || obj[this._idAttr] || obj];
}, },
// Get the model at the given index. // Get the model at the given index.
...@@ -716,10 +791,11 @@ ...@@ -716,10 +791,11 @@
return this.models[index]; return this.models[index];
}, },
// Return models with matching attributes. Useful for simple cases of `filter`. // Return models with matching attributes. Useful for simple cases of
where: function(attrs) { // `filter`.
if (_.isEmpty(attrs)) return []; where: function(attrs, first) {
return this.filter(function(model) { if (_.isEmpty(attrs)) return first ? void 0 : [];
return this[first ? 'find' : 'filter'](function(model) {
for (var key in attrs) { for (var key in attrs) {
if (attrs[key] !== model.get(key)) return false; if (attrs[key] !== model.get(key)) return false;
} }
...@@ -727,13 +803,17 @@ ...@@ -727,13 +803,17 @@
}); });
}, },
// Return the first model with matching attributes. Useful for simple cases
// of `find`.
findWhere: function(attrs) {
return this.where(attrs, true);
},
// Force the collection to re-sort itself. You don't need to call this under // Force the collection to re-sort itself. You don't need to call this under
// normal circumstances, as the set will maintain sort order as each item // normal circumstances, as the set will maintain sort order as each item
// is added. // is added.
sort: function(options) { sort: function(options) {
if (!this.comparator) { if (!this.comparator) throw new Error('Cannot sort a set without a comparator');
throw new Error('Cannot sort a set without a comparator');
}
options || (options = {}); options || (options = {});
// Run sort based on type of `comparator`. // Run sort based on type of `comparator`.
...@@ -747,75 +827,36 @@ ...@@ -747,75 +827,36 @@
return this; return this;
}, },
// Figure out the smallest index at which a model should be inserted so as
// to maintain order.
sortedIndex: function(model, value, context) {
value || (value = this.comparator);
var iterator = _.isFunction(value) ? value : function(model) {
return model.get(value);
};
return _.sortedIndex(this.models, model, iterator, context);
},
// Pluck an attribute from each model in the collection. // Pluck an attribute from each model in the collection.
pluck: function(attr) { pluck: function(attr) {
return _.invoke(this.models, 'get', attr); return _.invoke(this.models, 'get', attr);
}, },
// Smartly update a collection with a change set of models, adding,
// removing, and merging as necessary.
update: function(models, options) {
options = _.extend({add: true, merge: true, remove: true}, options);
if (options.parse) models = this.parse(models, options);
var model, i, l, existing;
var add = [], remove = [], modelMap = {};
// Allow a single model (or no argument) to be passed.
if (!_.isArray(models)) models = models ? [models] : [];
// Proxy to `add` for this case, no need to iterate...
if (options.add && !options.remove) return this.add(models, options);
// Determine which models to add and merge, and which to remove.
for (i = 0, l = models.length; i < l; i++) {
model = models[i];
existing = this.get(model);
if (options.remove && existing) modelMap[existing.cid] = true;
if ((options.add && !existing) || (options.merge && existing)) {
add.push(model);
}
}
if (options.remove) {
for (i = 0, l = this.models.length; i < l; i++) {
model = this.models[i];
if (!modelMap[model.cid]) remove.push(model);
}
}
// Remove models (if applicable) before we add and merge the rest.
if (remove.length) this.remove(remove, options);
if (add.length) this.add(add, options);
return this;
},
// When you have more items than you want to add or remove individually,
// you can reset the entire set with a new list of models, without firing
// any `add` or `remove` events. Fires `reset` when finished.
reset: function(models, options) {
options || (options = {});
if (options.parse) models = this.parse(models, options);
for (var i = 0, l = this.models.length; i < l; i++) {
this._removeReference(this.models[i]);
}
options.previousModels = this.models.slice();
this._reset();
if (models) this.add(models, _.extend({silent: true}, options));
if (!options.silent) this.trigger('reset', this, options);
return this;
},
// Fetch the default set of models for this collection, resetting the // Fetch the default set of models for this collection, resetting the
// collection when they arrive. If `update: true` is passed, the response // collection when they arrive. If `reset: true` is passed, the response
// data will be passed through the `update` method instead of `reset`. // data will be passed through the `reset` method instead of `set`.
fetch: function(options) { fetch: function(options) {
options = options ? _.clone(options) : {}; options = options ? _.clone(options) : {};
if (options.parse === void 0) options.parse = true; if (options.parse === void 0) options.parse = true;
var success = options.success; var success = options.success;
options.success = function(collection, resp, options) { var collection = this;
var method = options.update ? 'update' : 'reset'; options.success = function(resp) {
var method = options.reset ? 'reset' : 'set';
collection[method](resp, options); collection[method](resp, options);
if (success) success(collection, resp, options); if (success) success(collection, resp, options);
collection.trigger('sync', collection, resp, options);
}; };
wrapError(this, options);
return this.sync('read', this, options); return this.sync('read', this, options);
}, },
...@@ -828,7 +869,7 @@ ...@@ -828,7 +869,7 @@
if (!options.wait) this.add(model, options); if (!options.wait) this.add(model, options);
var collection = this; var collection = this;
var success = options.success; var success = options.success;
options.success = function(model, resp, options) { options.success = function(resp) {
if (options.wait) collection.add(model, options); if (options.wait) collection.add(model, options);
if (success) success(model, resp, options); if (success) success(model, resp, options);
}; };
...@@ -847,14 +888,16 @@ ...@@ -847,14 +888,16 @@
return new this.constructor(this.models); return new this.constructor(this.models);
}, },
// Reset all internal state. Called when the collection is reset. // Private method to reset all internal state. Called when the collection
// is first initialized or reset.
_reset: function() { _reset: function() {
this.length = 0; this.length = 0;
this.models.length = 0; this.models = [];
this._byId = {}; this._byId = {};
}, },
// Prepare a model or hash of attributes to be added to this collection. // Prepare a hash of attributes (or other model) to be added to this
// collection.
_prepareModel: function(attrs, options) { _prepareModel: function(attrs, options) {
if (attrs instanceof Model) { if (attrs instanceof Model) {
if (!attrs.collection) attrs.collection = this; if (!attrs.collection) attrs.collection = this;
...@@ -863,11 +906,14 @@ ...@@ -863,11 +906,14 @@
options || (options = {}); options || (options = {});
options.collection = this; options.collection = this;
var model = new this.model(attrs, options); var model = new this.model(attrs, options);
if (!model._validate(attrs, options)) return false; if (!model._validate(attrs, options)) {
this.trigger('invalid', this, attrs, options);
return false;
}
return model; return model;
}, },
// Internal method to remove a model's ties to a collection. // Internal method to sever a model's ties to a collection.
_removeReference: function(model) { _removeReference: function(model) {
if (this === model.collection) delete model.collection; if (this === model.collection) delete model.collection;
model.off('all', this._onModelEvent, this); model.off('all', this._onModelEvent, this);
...@@ -885,19 +931,13 @@ ...@@ -885,19 +931,13 @@
if (model.id != null) this._byId[model.id] = model; if (model.id != null) this._byId[model.id] = model;
} }
this.trigger.apply(this, arguments); this.trigger.apply(this, arguments);
},
sortedIndex: function (model, value, context) {
value || (value = this.comparator);
var iterator = _.isFunction(value) ? value : function(model) {
return model.get(value);
};
return _.sortedIndex(this.models, model, iterator, context);
} }
}); });
// Underscore methods that we want to implement on the Collection. // Underscore methods that we want to implement on the Collection.
// 90% of the core usefulness of Backbone Collections is actually implemented
// right here:
var methods = ['forEach', 'each', 'map', 'collect', 'reduce', 'foldl', var methods = ['forEach', 'each', 'map', 'collect', 'reduce', 'foldl',
'inject', 'reduceRight', 'foldr', 'find', 'detect', 'filter', 'select', 'inject', 'reduceRight', 'foldr', 'find', 'detect', 'filter', 'select',
'reject', 'every', 'all', 'some', 'any', 'include', 'contains', 'invoke', 'reject', 'every', 'all', 'some', 'any', 'include', 'contains', 'invoke',
...@@ -927,48 +967,288 @@ ...@@ -927,48 +967,288 @@
}; };
}); });
// Backbone.Router // Backbone.View
// --------------- // -------------
// Routers map faux-URLs to actions, and fire events when routes are // Backbone Views are almost more convention than they are actual code. A View
// matched. Creating a new one sets its `routes` hash, if not set statically. // is simply a JavaScript object that represents a logical chunk of UI in the
var Router = Backbone.Router = function(options) { // DOM. This might be a single item, an entire list, a sidebar or panel, or
options || (options = {}); // even the surrounding frame which wraps your whole app. Defining a chunk of
if (options.routes) this.routes = options.routes; // UI as a **View** allows you to define your DOM events declaratively, without
this._bindRoutes(); // having to worry about render order ... and makes it easy for the view to
// react to specific changes in the state of your models.
// Creating a Backbone.View creates its initial element outside of the DOM,
// if an existing element is not provided...
var View = Backbone.View = function(options) {
this.cid = _.uniqueId('view');
this._configure(options || {});
this._ensureElement();
this.initialize.apply(this, arguments); this.initialize.apply(this, arguments);
this.delegateEvents();
}; };
// Cached regular expressions for matching named param parts and splatted // Cached regex to split keys for `delegate`.
// parts of route strings. var delegateEventSplitter = /^(\S+)\s*(.*)$/;
var optionalParam = /\((.*?)\)/g;
var namedParam = /(\(\?)?:\w+/g;
var splatParam = /\*\w+/g;
var escapeRegExp = /[\-{}\[\]+?.,\\\^$|#\s]/g;
// Set up all inheritable **Backbone.Router** properties and methods. // List of view options to be merged as properties.
_.extend(Router.prototype, Events, { var viewOptions = ['model', 'collection', 'el', 'id', 'attributes', 'className', 'tagName', 'events'];
// Set up all inheritable **Backbone.View** properties and methods.
_.extend(View.prototype, Events, {
// The default `tagName` of a View's element is `"div"`.
tagName: 'div',
// jQuery delegate for element lookup, scoped to DOM elements within the
// current view. This should be prefered to global lookups where possible.
$: function(selector) {
return this.$el.find(selector);
},
// Initialize is an empty function by default. Override it with your own // Initialize is an empty function by default. Override it with your own
// initialization logic. // initialization logic.
initialize: function(){}, initialize: function(){},
// Manually bind a single named route to a callback. For example: // **render** is the core function that your view should override, in order
// // to populate its element (`this.el`), with the appropriate HTML. The
// this.route('search/:query/p:num', 'search', function(query, num) { // convention is for **render** to always return `this`.
render: function() {
return this;
},
// Remove this view by taking the element out of the DOM, and removing any
// applicable Backbone.Events listeners.
remove: function() {
this.$el.remove();
this.stopListening();
return this;
},
// Change the view's element (`this.el` property), including event
// re-delegation.
setElement: function(element, delegate) {
if (this.$el) this.undelegateEvents();
this.$el = element instanceof Backbone.$ ? element : Backbone.$(element);
this.el = this.$el[0];
if (delegate !== false) this.delegateEvents();
return this;
},
// Set callbacks, where `this.events` is a hash of
//
// *{"event selector": "callback"}*
//
// {
// 'mousedown .title': 'edit',
// 'click .button': 'save'
// 'click .open': function(e) { ... }
// }
//
// pairs. Callbacks will be bound to the view, with `this` set properly.
// Uses event delegation for efficiency.
// Omitting the selector binds the event to `this.el`.
// This only works for delegate-able events: not `focus`, `blur`, and
// not `change`, `submit`, and `reset` in Internet Explorer.
delegateEvents: function(events) {
if (!(events || (events = _.result(this, 'events')))) return this;
this.undelegateEvents();
for (var key in events) {
var method = events[key];
if (!_.isFunction(method)) method = this[events[key]];
if (!method) continue;
var match = key.match(delegateEventSplitter);
var eventName = match[1], selector = match[2];
method = _.bind(method, this);
eventName += '.delegateEvents' + this.cid;
if (selector === '') {
this.$el.on(eventName, method);
} else {
this.$el.on(eventName, selector, method);
}
}
return this;
},
// Clears all callbacks previously bound to the view with `delegateEvents`.
// You usually don't need to use this, but may wish to if you have multiple
// Backbone views attached to the same DOM element.
undelegateEvents: function() {
this.$el.off('.delegateEvents' + this.cid);
return this;
},
// Performs the initial configuration of a View with a set of options.
// Keys with special meaning *(e.g. model, collection, id, className)* are
// attached directly to the view. See `viewOptions` for an exhaustive
// list.
_configure: function(options) {
if (this.options) options = _.extend({}, _.result(this, 'options'), options);
_.extend(this, _.pick(options, viewOptions));
this.options = options;
},
// Ensure that the View has a DOM element to render into.
// If `this.el` is a string, pass it through `$()`, take the first
// matching element, and re-assign it to `el`. Otherwise, create
// an element from the `id`, `className` and `tagName` properties.
_ensureElement: function() {
if (!this.el) {
var attrs = _.extend({}, _.result(this, 'attributes'));
if (this.id) attrs.id = _.result(this, 'id');
if (this.className) attrs['class'] = _.result(this, 'className');
var $el = Backbone.$('<' + _.result(this, 'tagName') + '>').attr(attrs);
this.setElement($el, false);
} else {
this.setElement(_.result(this, 'el'), false);
}
}
});
// Backbone.sync
// -------------
// Override this function to change the manner in which Backbone persists
// models to the server. You will be passed the type of request, and the
// model in question. By default, makes a RESTful Ajax request
// to the model's `url()`. Some possible customizations could be:
//
// * Use `setTimeout` to batch rapid-fire updates into a single request.
// * Send up the models as XML instead of JSON.
// * Persist models via WebSockets instead of Ajax.
//
// Turn on `Backbone.emulateHTTP` in order to send `PUT` and `DELETE` requests
// as `POST`, with a `_method` parameter containing the true HTTP method,
// as well as all requests with the body as `application/x-www-form-urlencoded`
// instead of `application/json` with the model in a param named `model`.
// Useful when interfacing with server-side languages like **PHP** that make
// it difficult to read the body of `PUT` requests.
Backbone.sync = function(method, model, options) {
var type = methodMap[method];
// Default options, unless specified.
_.defaults(options || (options = {}), {
emulateHTTP: Backbone.emulateHTTP,
emulateJSON: Backbone.emulateJSON
});
// Default JSON-request options.
var params = {type: type, dataType: 'json'};
// Ensure that we have a URL.
if (!options.url) {
params.url = _.result(model, 'url') || urlError();
}
// Ensure that we have the appropriate request data.
if (options.data == null && model && (method === 'create' || method === 'update' || method === 'patch')) {
params.contentType = 'application/json';
params.data = JSON.stringify(options.attrs || model.toJSON(options));
}
// For older servers, emulate JSON by encoding the request into an HTML-form.
if (options.emulateJSON) {
params.contentType = 'application/x-www-form-urlencoded';
params.data = params.data ? {model: params.data} : {};
}
// For older servers, emulate HTTP by mimicking the HTTP method with `_method`
// And an `X-HTTP-Method-Override` header.
if (options.emulateHTTP && (type === 'PUT' || type === 'DELETE' || type === 'PATCH')) {
params.type = 'POST';
if (options.emulateJSON) params.data._method = type;
var beforeSend = options.beforeSend;
options.beforeSend = function(xhr) {
xhr.setRequestHeader('X-HTTP-Method-Override', type);
if (beforeSend) return beforeSend.apply(this, arguments);
};
}
// Don't process data on a non-GET request.
if (params.type !== 'GET' && !options.emulateJSON) {
params.processData = false;
}
// If we're sending a `PATCH` request, and we're in an old Internet Explorer
// that still has ActiveX enabled by default, override jQuery to use that
// for XHR instead. Remove this line when jQuery supports `PATCH` on IE8.
if (params.type === 'PATCH' && window.ActiveXObject &&
!(window.external && window.external.msActiveXFilteringEnabled)) {
params.xhr = function() {
return new ActiveXObject("Microsoft.XMLHTTP");
};
}
// Make the request, allowing the user to override any Ajax options.
var xhr = options.xhr = Backbone.ajax(_.extend(params, options));
model.trigger('request', model, xhr, options);
return xhr;
};
// Map from CRUD to HTTP for our default `Backbone.sync` implementation.
var methodMap = {
'create': 'POST',
'update': 'PUT',
'patch': 'PATCH',
'delete': 'DELETE',
'read': 'GET'
};
// Set the default implementation of `Backbone.ajax` to proxy through to `$`.
// Override this if you'd like to use a different library.
Backbone.ajax = function() {
return Backbone.$.ajax.apply(Backbone.$, arguments);
};
// Backbone.Router
// ---------------
// Routers map faux-URLs to actions, and fire events when routes are
// matched. Creating a new one sets its `routes` hash, if not set statically.
var Router = Backbone.Router = function(options) {
options || (options = {});
if (options.routes) this.routes = options.routes;
this._bindRoutes();
this.initialize.apply(this, arguments);
};
// Cached regular expressions for matching named param parts and splatted
// parts of route strings.
var optionalParam = /\((.*?)\)/g;
var namedParam = /(\(\?)?:\w+/g;
var splatParam = /\*\w+/g;
var escapeRegExp = /[\-{}\[\]+?.,\\\^$|#\s]/g;
// Set up all inheritable **Backbone.Router** properties and methods.
_.extend(Router.prototype, Events, {
// Initialize is an empty function by default. Override it with your own
// initialization logic.
initialize: function(){},
// Manually bind a single named route to a callback. For example:
//
// this.route('search/:query/p:num', 'search', function(query, num) {
// ... // ...
// }); // });
// //
route: function(route, name, callback) { route: function(route, name, callback) {
if (!_.isRegExp(route)) route = this._routeToRegExp(route); if (!_.isRegExp(route)) route = this._routeToRegExp(route);
if (_.isFunction(name)) {
callback = name;
name = '';
}
if (!callback) callback = this[name]; if (!callback) callback = this[name];
Backbone.history.route(route, _.bind(function(fragment) { var router = this;
var args = this._extractParameters(route, fragment); Backbone.history.route(route, function(fragment) {
callback && callback.apply(this, args); var args = router._extractParameters(route, fragment);
this.trigger.apply(this, ['route:' + name].concat(args)); callback && callback.apply(router, args);
this.trigger('route', name, args); router.trigger.apply(router, ['route:' + name].concat(args));
Backbone.history.trigger('route', this, name, args); router.trigger('route', name, args);
}, this)); Backbone.history.trigger('route', router, name, args);
});
return this; return this;
}, },
...@@ -983,6 +1263,7 @@ ...@@ -983,6 +1263,7 @@
// routes can be defined at the bottom of the route map. // routes can be defined at the bottom of the route map.
_bindRoutes: function() { _bindRoutes: function() {
if (!this.routes) return; if (!this.routes) return;
this.routes = _.result(this, 'routes');
var route, routes = _.keys(this.routes); var route, routes = _.keys(this.routes);
while ((route = routes.pop()) != null) { while ((route = routes.pop()) != null) {
this.route(route, this.routes[route]); this.route(route, this.routes[route]);
...@@ -1002,9 +1283,13 @@ ...@@ -1002,9 +1283,13 @@
}, },
// Given a route, and a URL fragment that it matches, return the array of // Given a route, and a URL fragment that it matches, return the array of
// extracted parameters. // extracted decoded parameters. Empty or unmatched parameters will be
// treated as `null` to normalize cross-browser behavior.
_extractParameters: function(route, fragment) { _extractParameters: function(route, fragment) {
return route.exec(fragment).slice(1); var params = route.exec(fragment).slice(1);
return _.map(params, function(param) {
return param ? decodeURIComponent(param) : null;
});
} }
}); });
...@@ -1012,8 +1297,11 @@ ...@@ -1012,8 +1297,11 @@
// Backbone.History // Backbone.History
// ---------------- // ----------------
// Handles cross-browser history management, based on URL fragments. If the // Handles cross-browser history management, based on either
// browser does not support `onhashchange`, falls back to polling. // [pushState](http://diveintohtml5.info/history.html) and real URLs, or
// [onhashchange](https://developer.mozilla.org/en-US/docs/DOM/window.onhashchange)
// and URL fragments. If the browser supports neither (old IE, natch),
// falls back to polling.
var History = Backbone.History = function() { var History = Backbone.History = function() {
this.handlers = []; this.handlers = [];
_.bindAll(this, 'checkUrl'); _.bindAll(this, 'checkUrl');
...@@ -1224,230 +1512,6 @@ ...@@ -1224,230 +1512,6 @@
// Create the default Backbone.history. // Create the default Backbone.history.
Backbone.history = new History; Backbone.history = new History;
// Backbone.View
// -------------
// Creating a Backbone.View creates its initial element outside of the DOM,
// if an existing element is not provided...
var View = Backbone.View = function(options) {
this.cid = _.uniqueId('view');
this._configure(options || {});
this._ensureElement();
this.initialize.apply(this, arguments);
this.delegateEvents();
};
// Cached regex to split keys for `delegate`.
var delegateEventSplitter = /^(\S+)\s*(.*)$/;
// List of view options to be merged as properties.
var viewOptions = ['model', 'collection', 'el', 'id', 'attributes', 'className', 'tagName', 'events'];
// Set up all inheritable **Backbone.View** properties and methods.
_.extend(View.prototype, Events, {
// The default `tagName` of a View's element is `"div"`.
tagName: 'div',
// jQuery delegate for element lookup, scoped to DOM elements within the
// current view. This should be prefered to global lookups where possible.
$: function(selector) {
return this.$el.find(selector);
},
// Initialize is an empty function by default. Override it with your own
// initialization logic.
initialize: function(){},
// **render** is the core function that your view should override, in order
// to populate its element (`this.el`), with the appropriate HTML. The
// convention is for **render** to always return `this`.
render: function() {
return this;
},
// Remove this view by taking the element out of the DOM, and removing any
// applicable Backbone.Events listeners.
remove: function() {
this.$el.remove();
this.stopListening();
return this;
},
// Change the view's element (`this.el` property), including event
// re-delegation.
setElement: function(element, delegate) {
if (this.$el) this.undelegateEvents();
this.$el = element instanceof Backbone.$ ? element : Backbone.$(element);
this.el = this.$el[0];
if (delegate !== false) this.delegateEvents();
return this;
},
// Set callbacks, where `this.events` is a hash of
//
// *{"event selector": "callback"}*
//
// {
// 'mousedown .title': 'edit',
// 'click .button': 'save'
// 'click .open': function(e) { ... }
// }
//
// pairs. Callbacks will be bound to the view, with `this` set properly.
// Uses event delegation for efficiency.
// Omitting the selector binds the event to `this.el`.
// This only works for delegate-able events: not `focus`, `blur`, and
// not `change`, `submit`, and `reset` in Internet Explorer.
delegateEvents: function(events) {
if (!(events || (events = _.result(this, 'events')))) return;
this.undelegateEvents();
for (var key in events) {
var method = events[key];
if (!_.isFunction(method)) method = this[events[key]];
if (!method) throw new Error('Method "' + events[key] + '" does not exist');
var match = key.match(delegateEventSplitter);
var eventName = match[1], selector = match[2];
method = _.bind(method, this);
eventName += '.delegateEvents' + this.cid;
if (selector === '') {
this.$el.on(eventName, method);
} else {
this.$el.on(eventName, selector, method);
}
}
},
// Clears all callbacks previously bound to the view with `delegateEvents`.
// You usually don't need to use this, but may wish to if you have multiple
// Backbone views attached to the same DOM element.
undelegateEvents: function() {
this.$el.off('.delegateEvents' + this.cid);
},
// Performs the initial configuration of a View with a set of options.
// Keys with special meaning *(model, collection, id, className)*, are
// attached directly to the view.
_configure: function(options) {
if (this.options) options = _.extend({}, _.result(this, 'options'), options);
_.extend(this, _.pick(options, viewOptions));
this.options = options;
},
// Ensure that the View has a DOM element to render into.
// If `this.el` is a string, pass it through `$()`, take the first
// matching element, and re-assign it to `el`. Otherwise, create
// an element from the `id`, `className` and `tagName` properties.
_ensureElement: function() {
if (!this.el) {
var attrs = _.extend({}, _.result(this, 'attributes'));
if (this.id) attrs.id = _.result(this, 'id');
if (this.className) attrs['class'] = _.result(this, 'className');
var $el = Backbone.$('<' + _.result(this, 'tagName') + '>').attr(attrs);
this.setElement($el, false);
} else {
this.setElement(_.result(this, 'el'), false);
}
}
});
// Backbone.sync
// -------------
// Map from CRUD to HTTP for our default `Backbone.sync` implementation.
var methodMap = {
'create': 'POST',
'update': 'PUT',
'patch': 'PATCH',
'delete': 'DELETE',
'read': 'GET'
};
// Override this function to change the manner in which Backbone persists
// models to the server. You will be passed the type of request, and the
// model in question. By default, makes a RESTful Ajax request
// to the model's `url()`. Some possible customizations could be:
//
// * Use `setTimeout` to batch rapid-fire updates into a single request.
// * Send up the models as XML instead of JSON.
// * Persist models via WebSockets instead of Ajax.
//
// Turn on `Backbone.emulateHTTP` in order to send `PUT` and `DELETE` requests
// as `POST`, with a `_method` parameter containing the true HTTP method,
// as well as all requests with the body as `application/x-www-form-urlencoded`
// instead of `application/json` with the model in a param named `model`.
// Useful when interfacing with server-side languages like **PHP** that make
// it difficult to read the body of `PUT` requests.
Backbone.sync = function(method, model, options) {
var type = methodMap[method];
// Default options, unless specified.
_.defaults(options || (options = {}), {
emulateHTTP: Backbone.emulateHTTP,
emulateJSON: Backbone.emulateJSON
});
// Default JSON-request options.
var params = {type: type, dataType: 'json'};
// Ensure that we have a URL.
if (!options.url) {
params.url = _.result(model, 'url') || urlError();
}
// Ensure that we have the appropriate request data.
if (options.data == null && model && (method === 'create' || method === 'update' || method === 'patch')) {
params.contentType = 'application/json';
params.data = JSON.stringify(options.attrs || model.toJSON(options));
}
// For older servers, emulate JSON by encoding the request into an HTML-form.
if (options.emulateJSON) {
params.contentType = 'application/x-www-form-urlencoded';
params.data = params.data ? {model: params.data} : {};
}
// For older servers, emulate HTTP by mimicking the HTTP method with `_method`
// And an `X-HTTP-Method-Override` header.
if (options.emulateHTTP && (type === 'PUT' || type === 'DELETE' || type === 'PATCH')) {
params.type = 'POST';
if (options.emulateJSON) params.data._method = type;
var beforeSend = options.beforeSend;
options.beforeSend = function(xhr) {
xhr.setRequestHeader('X-HTTP-Method-Override', type);
if (beforeSend) return beforeSend.apply(this, arguments);
};
}
// Don't process data on a non-GET request.
if (params.type !== 'GET' && !options.emulateJSON) {
params.processData = false;
}
var success = options.success;
options.success = function(resp) {
if (success) success(model, resp, options);
model.trigger('sync', model, resp, options);
};
var error = options.error;
options.error = function(xhr) {
if (error) error(model, xhr, options);
model.trigger('error', model, xhr, options);
};
// Make the request, allowing the user to override any Ajax options.
var xhr = options.xhr = Backbone.ajax(_.extend(params, options));
model.trigger('request', model, xhr, options);
return xhr;
};
// Set the default implementation of `Backbone.ajax` to proxy through to `$`.
Backbone.ajax = function() {
return Backbone.$.ajax.apply(Backbone.$, arguments);
};
// Helpers // Helpers
// ------- // -------
...@@ -1495,4 +1559,13 @@ ...@@ -1495,4 +1559,13 @@
throw new Error('A "url" property or function must be specified'); throw new Error('A "url" property or function must be specified');
}; };
// Wrap an optional error callback with a fallback error event.
var wrapError = function (model, options) {
var error = options.error;
options.error = function(resp) {
if (error) error(model, resp, options);
model.trigger('error', model, resp, options);
};
};
}).call(this); }).call(this);
architecture-examples/backbone/components/todomvc-common/base.js
View file @ c5b1781e
...@@ -4,4 +4,20 @@ ...@@ -4,4 +4,20 @@
if (location.hostname === 'todomvc.com') { if (location.hostname === 'todomvc.com') {
var _gaq=[['_setAccount','UA-31081062-1'],['_trackPageview']];(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];g.src='//www.google-analytics.com/ga.js';s.parentNode.insertBefore(g,s)}(document,'script')); var _gaq=[['_setAccount','UA-31081062-1'],['_trackPageview']];(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];g.src='//www.google-analytics.com/ga.js';s.parentNode.insertBefore(g,s)}(document,'script'));
} }
function appendSourceLink() {
var sourceLink = document.createElement('a');
var paragraph = document.createElement('p');
var footer = document.getElementById('info');
var urlBase = 'https://github.com/addyosmani/todomvc/tree/gh-pages';
if (footer) {
sourceLink.href = urlBase + location.pathname;
sourceLink.appendChild(document.createTextNode('Check out the source'));
paragraph.appendChild(sourceLink);
footer.appendChild(paragraph);
}
}
appendSourceLink();
})(); })();
architecture-examples/backbone/js/routers/router.js
View file @ c5b1781e
...@@ -13,7 +13,7 @@ var app = app || {}; ...@@ -13,7 +13,7 @@ var app = app || {};
setFilter: function (param) { setFilter: function (param) {
// Set the current filter to be used // Set the current filter to be used
app.TodoFilter = param.trim() || ''; app.TodoFilter = param || '';
// Trigger a collection filter event, causing hiding/unhiding // Trigger a collection filter event, causing hiding/unhiding
// of Todo view items // of Todo view items
......
changelog.md
View file @ c5b1781e
...@@ -6,6 +6,10 @@ ...@@ -6,6 +6,10 @@
- Flight - Flight
- DeftJS + ExtJS - DeftJS + ExtJS
- Aria Templates - Aria Templates
- Updates since 1.1:
- Backbone 1.0
- The GWT example implemented routing - The GWT example implemented routing
## 1.1 - 2013-02-14 ## 1.1 - 2013-02-14
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7