backbone-support 0.3.2 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,22 +1,31 @@
1
- // Backbone.js 0.5.3
2
- // (c) 2010 Jeremy Ashkenas, DocumentCloud Inc.
1
+ // Backbone.js 1.0.0
2
+
3
+ // (c) 2010-2013 Jeremy Ashkenas, DocumentCloud Inc.
3
4
  // Backbone may be freely distributed under the MIT license.
4
5
  // For all details and documentation:
5
- // http://documentcloud.github.com/backbone
6
+ // http://backbonejs.org
6
7
 
7
8
  (function(){
8
9
 
9
10
  // Initial Setup
10
11
  // -------------
11
12
 
12
- // Save a reference to the global object.
13
+ // Save a reference to the global object (`window` in the browser, `exports`
14
+ // on the server).
13
15
  var root = this;
14
16
 
15
- // Save the previous value of the `Backbone` variable.
17
+ // Save the previous value of the `Backbone` variable, so that it can be
18
+ // restored later on, if `noConflict` is used.
16
19
  var previousBackbone = root.Backbone;
17
20
 
21
+ // Create local references to array methods we'll want to use later.
22
+ var array = [];
23
+ var push = array.push;
24
+ var slice = array.slice;
25
+ var splice = array.splice;
26
+
18
27
  // The top-level namespace. All public Backbone classes and modules will
19
- // be attached to this. Exported for both CommonJS and the browser.
28
+ // be attached to this. Exported for both the browser and the server.
20
29
  var Backbone;
21
30
  if (typeof exports !== 'undefined') {
22
31
  Backbone = exports;
@@ -25,14 +34,15 @@
25
34
  }
26
35
 
27
36
  // Current version of the library. Keep in sync with `package.json`.
28
- Backbone.VERSION = '0.5.3';
37
+ Backbone.VERSION = '1.0.0';
29
38
 
30
39
  // Require Underscore, if we're on the server, and it's not already present.
31
40
  var _ = root._;
32
- if (!_ && (typeof require !== 'undefined')) _ = require('underscore')._;
41
+ if (!_ && (typeof require !== 'undefined')) _ = require('underscore');
33
42
 
34
- // For Backbone's purposes, jQuery or Zepto owns the `$` variable.
35
- var $ = root.jQuery || root.Zepto;
43
+ // For Backbone's purposes, jQuery, Zepto, Ender, or My Library (kidding) owns
44
+ // the `$` variable.
45
+ Backbone.$ = root.jQuery || root.Zepto || root.ender || root.$;
36
46
 
37
47
  // Runs Backbone.js in *noConflict* mode, returning the `Backbone` variable
38
48
  // to its previous owner. Returns a reference to this Backbone object.
@@ -41,9 +51,9 @@
41
51
  return this;
42
52
  };
43
53
 
44
- // Turn on `emulateHTTP` to support legacy HTTP servers. Setting this option will
45
- // fake `"PUT"` and `"DELETE"` requests via the `_method` parameter and set a
46
- // `X-Http-Method-Override` header.
54
+ // Turn on `emulateHTTP` to support legacy HTTP servers. Setting this option
55
+ // will fake `"PUT"` and `"DELETE"` requests via the `_method` parameter and
56
+ // set a `X-Http-Method-Override` header.
47
57
  Backbone.emulateHTTP = false;
48
58
 
49
59
  // Turn on `emulateJSON` to support legacy servers that can't deal with direct
@@ -53,428 +63,727 @@
53
63
  Backbone.emulateJSON = false;
54
64
 
55
65
  // Backbone.Events
56
- // -----------------
66
+ // ---------------
57
67
 
58
68
  // A module that can be mixed in to *any object* in order to provide it with
59
- // custom events. You may `bind` or `unbind` a callback function to an event;
60
- // `trigger`-ing an event fires all callbacks in succession.
69
+ // custom events. You may bind with `on` or remove with `off` callback
70
+ // functions to an event; `trigger`-ing an event fires all callbacks in
71
+ // succession.
61
72
  //
62
73
  // var object = {};
63
74
  // _.extend(object, Backbone.Events);
64
- // object.bind('expand', function(){ alert('expanded'); });
75
+ // object.on('expand', function(){ alert('expanded'); });
65
76
  // object.trigger('expand');
66
77
  //
67
- Backbone.Events = {
68
-
69
- // Bind an event, specified by a string name, `ev`, to a `callback` function.
70
- // Passing `"all"` will bind the callback to all events fired.
71
- bind : function(ev, callback, context) {
72
- var calls = this._callbacks || (this._callbacks = {});
73
- var list = calls[ev] || (calls[ev] = []);
74
- list.push([callback, context]);
78
+ var Events = Backbone.Events = {
79
+
80
+ // Bind an event to a `callback` function. Passing `"all"` will bind
81
+ // the callback to all events fired.
82
+ on: function(name, callback, context) {
83
+ if (!eventsApi(this, 'on', name, [callback, context]) || !callback) return this;
84
+ this._events || (this._events = {});
85
+ var events = this._events[name] || (this._events[name] = []);
86
+ events.push({callback: callback, context: context, ctx: context || this});
75
87
  return this;
76
88
  },
77
89
 
78
- // Remove one or many callbacks. If `callback` is null, removes all
79
- // callbacks for the event. If `ev` is null, removes all bound callbacks
80
- // for all events.
81
- unbind : function(ev, callback) {
82
- var calls;
83
- if (!ev) {
84
- this._callbacks = {};
85
- } else if (calls = this._callbacks) {
86
- if (!callback) {
87
- calls[ev] = [];
88
- } else {
89
- var list = calls[ev];
90
- if (!list) return this;
91
- for (var i = 0, l = list.length; i < l; i++) {
92
- if (list[i] && callback === list[i][0]) {
93
- list[i] = null;
94
- break;
90
+ // Bind an event to only be triggered a single time. After the first time
91
+ // the callback is invoked, it will be removed.
92
+ once: function(name, callback, context) {
93
+ if (!eventsApi(this, 'once', name, [callback, context]) || !callback) return this;
94
+ var self = this;
95
+ var once = _.once(function() {
96
+ self.off(name, once);
97
+ callback.apply(this, arguments);
98
+ });
99
+ once._callback = callback;
100
+ return this.on(name, once, context);
101
+ },
102
+
103
+ // Remove one or many callbacks. If `context` is null, removes all
104
+ // callbacks with that function. If `callback` is null, removes all
105
+ // callbacks for the event. If `name` is null, removes all bound
106
+ // callbacks for all events.
107
+ off: function(name, callback, context) {
108
+ var retain, ev, events, names, i, l, j, k;
109
+ if (!this._events || !eventsApi(this, 'off', name, [callback, context])) return this;
110
+ if (!name && !callback && !context) {
111
+ this._events = {};
112
+ return this;
113
+ }
114
+
115
+ names = name ? [name] : _.keys(this._events);
116
+ for (i = 0, l = names.length; i < l; i++) {
117
+ name = names[i];
118
+ if (events = this._events[name]) {
119
+ this._events[name] = retain = [];
120
+ if (callback || context) {
121
+ for (j = 0, k = events.length; j < k; j++) {
122
+ ev = events[j];
123
+ if ((callback && callback !== ev.callback && callback !== ev.callback._callback) ||
124
+ (context && context !== ev.context)) {
125
+ retain.push(ev);
126
+ }
95
127
  }
96
128
  }
129
+ if (!retain.length) delete this._events[name];
97
130
  }
98
131
  }
132
+
99
133
  return this;
100
134
  },
101
135
 
102
- // Trigger an event, firing all bound callbacks. Callbacks are passed the
103
- // same arguments as `trigger` is, apart from the event name.
104
- // Listening for `"all"` passes the true event name as the first argument.
105
- trigger : function(eventName) {
106
- var list, calls, ev, callback, args;
107
- var both = 2;
108
- if (!(calls = this._callbacks)) return this;
109
- while (both--) {
110
- ev = both ? eventName : 'all';
111
- if (list = calls[ev]) {
112
- for (var i = 0, l = list.length; i < l; i++) {
113
- if (!(callback = list[i])) {
114
- list.splice(i, 1); i--; l--;
115
- } else {
116
- args = both ? Array.prototype.slice.call(arguments, 1) : arguments;
117
- callback[0].apply(callback[1] || this, args);
118
- }
119
- }
120
- }
136
+ // Trigger one or many events, firing all bound callbacks. Callbacks are
137
+ // passed the same arguments as `trigger` is, apart from the event name
138
+ // (unless you're listening on `"all"`, which will cause your callback to
139
+ // receive the true name of the event as the first argument).
140
+ trigger: function(name) {
141
+ if (!this._events) return this;
142
+ var args = slice.call(arguments, 1);
143
+ if (!eventsApi(this, 'trigger', name, args)) return this;
144
+ var events = this._events[name];
145
+ var allEvents = this._events.all;
146
+ if (events) triggerEvents(events, args);
147
+ if (allEvents) triggerEvents(allEvents, arguments);
148
+ return this;
149
+ },
150
+
151
+ // Tell this object to stop listening to either specific events ... or
152
+ // to every object it's currently listening to.
153
+ stopListening: function(obj, name, callback) {
154
+ var listeners = this._listeners;
155
+ if (!listeners) return this;
156
+ var deleteListener = !name && !callback;
157
+ if (typeof name === 'object') callback = this;
158
+ if (obj) (listeners = {})[obj._listenerId] = obj;
159
+ for (var id in listeners) {
160
+ listeners[id].off(name, callback, this);
161
+ if (deleteListener) delete this._listeners[id];
121
162
  }
122
163
  return this;
123
164
  }
124
165
 
125
166
  };
126
167
 
168
+ // Regular expression used to split event strings.
169
+ var eventSplitter = /\s+/;
170
+
171
+ // Implement fancy features of the Events API such as multiple event
172
+ // names `"change blur"` and jQuery-style event maps `{change: action}`
173
+ // in terms of the existing API.
174
+ var eventsApi = function(obj, action, name, rest) {
175
+ if (!name) return true;
176
+
177
+ // Handle event maps.
178
+ if (typeof name === 'object') {
179
+ for (var key in name) {
180
+ obj[action].apply(obj, [key, name[key]].concat(rest));
181
+ }
182
+ return false;
183
+ }
184
+
185
+ // Handle space separated event names.
186
+ if (eventSplitter.test(name)) {
187
+ var names = name.split(eventSplitter);
188
+ for (var i = 0, l = names.length; i < l; i++) {
189
+ obj[action].apply(obj, [names[i]].concat(rest));
190
+ }
191
+ return false;
192
+ }
193
+
194
+ return true;
195
+ };
196
+
197
+ // A difficult-to-believe, but optimized internal dispatch function for
198
+ // triggering events. Tries to keep the usual cases speedy (most internal
199
+ // Backbone events have 3 arguments).
200
+ var triggerEvents = function(events, args) {
201
+ var ev, i = -1, l = events.length, a1 = args[0], a2 = args[1], a3 = args[2];
202
+ switch (args.length) {
203
+ case 0: while (++i < l) (ev = events[i]).callback.call(ev.ctx); return;
204
+ case 1: while (++i < l) (ev = events[i]).callback.call(ev.ctx, a1); return;
205
+ case 2: while (++i < l) (ev = events[i]).callback.call(ev.ctx, a1, a2); return;
206
+ case 3: while (++i < l) (ev = events[i]).callback.call(ev.ctx, a1, a2, a3); return;
207
+ default: while (++i < l) (ev = events[i]).callback.apply(ev.ctx, args);
208
+ }
209
+ };
210
+
211
+ var listenMethods = {listenTo: 'on', listenToOnce: 'once'};
212
+
213
+ // Inversion-of-control versions of `on` and `once`. Tell *this* object to
214
+ // listen to an event in another object ... keeping track of what it's
215
+ // listening to.
216
+ _.each(listenMethods, function(implementation, method) {
217
+ Events[method] = function(obj, name, callback) {
218
+ var listeners = this._listeners || (this._listeners = {});
219
+ var id = obj._listenerId || (obj._listenerId = _.uniqueId('l'));
220
+ listeners[id] = obj;
221
+ if (typeof name === 'object') callback = this;
222
+ obj[implementation](name, callback, this);
223
+ return this;
224
+ };
225
+ });
226
+
227
+ // Aliases for backwards compatibility.
228
+ Events.bind = Events.on;
229
+ Events.unbind = Events.off;
230
+
231
+ // Allow the `Backbone` object to serve as a global event bus, for folks who
232
+ // want global "pubsub" in a convenient place.
233
+ _.extend(Backbone, Events);
234
+
127
235
  // Backbone.Model
128
236
  // --------------
129
237
 
130
- // Create a new model, with defined attributes. A client id (`cid`)
238
+ // Backbone **Models** are the basic data object in the framework --
239
+ // frequently representing a row in a table in a database on your server.
240
+ // A discrete chunk of data and a bunch of useful, related methods for
241
+ // performing computations and transformations on that data.
242
+
243
+ // Create a new model with the specified attributes. A client id (`cid`)
131
244
  // is automatically generated and assigned for you.
132
- Backbone.Model = function(attributes, options) {
245
+ var Model = Backbone.Model = function(attributes, options) {
133
246
  var defaults;
134
- attributes || (attributes = {});
135
- if (defaults = this.defaults) {
136
- if (_.isFunction(defaults)) defaults = defaults.call(this);
137
- attributes = _.extend({}, defaults, attributes);
138
- }
139
- this.attributes = {};
140
- this._escapedAttributes = {};
247
+ var attrs = attributes || {};
248
+ options || (options = {});
141
249
  this.cid = _.uniqueId('c');
142
- this.set(attributes, {silent : true});
143
- this._changed = false;
144
- this._previousAttributes = _.clone(this.attributes);
145
- if (options && options.collection) this.collection = options.collection;
146
- this.initialize(attributes, options);
250
+ this.attributes = {};
251
+ _.extend(this, _.pick(options, modelOptions));
252
+ if (options.parse) attrs = this.parse(attrs, options) || {};
253
+ if (defaults = _.result(this, 'defaults')) {
254
+ attrs = _.defaults({}, attrs, defaults);
255
+ }
256
+ this.set(attrs, options);
257
+ this.changed = {};
258
+ this.initialize.apply(this, arguments);
147
259
  };
148
260
 
261
+ // A list of options to be attached directly to the model, if provided.
262
+ var modelOptions = ['url', 'urlRoot', 'collection'];
263
+
149
264
  // Attach all inheritable methods to the Model prototype.
150
- _.extend(Backbone.Model.prototype, Backbone.Events, {
265
+ _.extend(Model.prototype, Events, {
151
266
 
152
- // A snapshot of the model's previous attributes, taken immediately
153
- // after the last `"change"` event was fired.
154
- _previousAttributes : null,
267
+ // A hash of attributes whose current and previous value differ.
268
+ changed: null,
155
269
 
156
- // Has the item been changed since the last `"change"` event?
157
- _changed : false,
270
+ // The value returned during the last failed validation.
271
+ validationError: null,
158
272
 
159
273
  // The default name for the JSON `id` attribute is `"id"`. MongoDB and
160
274
  // CouchDB users may want to set this to `"_id"`.
161
- idAttribute : 'id',
275
+ idAttribute: 'id',
162
276
 
163
277
  // Initialize is an empty function by default. Override it with your own
164
278
  // initialization logic.
165
- initialize : function(){},
279
+ initialize: function(){},
166
280
 
167
281
  // Return a copy of the model's `attributes` object.
168
- toJSON : function() {
282
+ toJSON: function(options) {
169
283
  return _.clone(this.attributes);
170
284
  },
171
285
 
286
+ // Proxy `Backbone.sync` by default -- but override this if you need
287
+ // custom syncing semantics for *this* particular model.
288
+ sync: function() {
289
+ return Backbone.sync.apply(this, arguments);
290
+ },
291
+
172
292
  // Get the value of an attribute.
173
- get : function(attr) {
293
+ get: function(attr) {
174
294
  return this.attributes[attr];
175
295
  },
176
296
 
177
297
  // Get the HTML-escaped value of an attribute.
178
- escape : function(attr) {
179
- var html;
180
- if (html = this._escapedAttributes[attr]) return html;
181
- var val = this.attributes[attr];
182
- return this._escapedAttributes[attr] = escapeHTML(val == null ? '' : '' + val);
298
+ escape: function(attr) {
299
+ return _.escape(this.get(attr));
183
300
  },
184
301
 
185
302
  // Returns `true` if the attribute contains a value that is not null
186
303
  // or undefined.
187
- has : function(attr) {
188
- return this.attributes[attr] != null;
304
+ has: function(attr) {
305
+ return this.get(attr) != null;
189
306
  },
190
307
 
191
- // Set a hash of model attributes on the object, firing `"change"` unless you
192
- // choose to silence it.
193
- set : function(attrs, options) {
308
+ // Set a hash of model attributes on the object, firing `"change"`. This is
309
+ // the core primitive operation of a model, updating the data and notifying
310
+ // anyone who needs to know about the change in state. The heart of the beast.
311
+ set: function(key, val, options) {
312
+ var attr, attrs, unset, changes, silent, changing, prev, current;
313
+ if (key == null) return this;
314
+
315
+ // Handle both `"key", value` and `{key: value}` -style arguments.
316
+ if (typeof key === 'object') {
317
+ attrs = key;
318
+ options = val;
319
+ } else {
320
+ (attrs = {})[key] = val;
321
+ }
194
322
 
195
- // Extract attributes and options.
196
323
  options || (options = {});
197
- if (!attrs) return this;
198
- if (attrs.attributes) attrs = attrs.attributes;
199
- var now = this.attributes, escaped = this._escapedAttributes;
200
324
 
201
325
  // Run validation.
202
- if (!options.silent && this.validate && !this._performValidation(attrs, options)) return false;
326
+ if (!this._validate(attrs, options)) return false;
327
+
328
+ // Extract attributes and options.
329
+ unset = options.unset;
330
+ silent = options.silent;
331
+ changes = [];
332
+ changing = this._changing;
333
+ this._changing = true;
334
+
335
+ if (!changing) {
336
+ this._previousAttributes = _.clone(this.attributes);
337
+ this.changed = {};
338
+ }
339
+ current = this.attributes, prev = this._previousAttributes;
203
340
 
204
341
  // Check for changes of `id`.
205
342
  if (this.idAttribute in attrs) this.id = attrs[this.idAttribute];
206
343
 
207
- // We're about to start triggering change events.
208
- var alreadyChanging = this._changing;
209
- this._changing = true;
210
-
211
- // Update attributes.
212
- for (var attr in attrs) {
213
- var val = attrs[attr];
214
- if (!_.isEqual(now[attr], val)) {
215
- now[attr] = val;
216
- delete escaped[attr];
217
- this._changed = true;
218
- if (!options.silent) this.trigger('change:' + attr, this, val, options);
344
+ // For each `set` attribute, update or delete the current value.
345
+ for (attr in attrs) {
346
+ val = attrs[attr];
347
+ if (!_.isEqual(current[attr], val)) changes.push(attr);
348
+ if (!_.isEqual(prev[attr], val)) {
349
+ this.changed[attr] = val;
350
+ } else {
351
+ delete this.changed[attr];
352
+ }
353
+ unset ? delete current[attr] : current[attr] = val;
354
+ }
355
+
356
+ // Trigger all relevant attribute changes.
357
+ if (!silent) {
358
+ if (changes.length) this._pending = true;
359
+ for (var i = 0, l = changes.length; i < l; i++) {
360
+ this.trigger('change:' + changes[i], this, current[changes[i]], options);
219
361
  }
220
362
  }
221
363
 
222
- // Fire the `"change"` event, if the model has been changed.
223
- if (!alreadyChanging && !options.silent && this._changed) this.change(options);
364
+ // You might be wondering why there's a `while` loop here. Changes can
365
+ // be recursively nested within `"change"` events.
366
+ if (changing) return this;
367
+ if (!silent) {
368
+ while (this._pending) {
369
+ this._pending = false;
370
+ this.trigger('change', this, options);
371
+ }
372
+ }
373
+ this._pending = false;
224
374
  this._changing = false;
225
375
  return this;
226
376
  },
227
377
 
228
- // Remove an attribute from the model, firing `"change"` unless you choose
229
- // to silence it. `unset` is a noop if the attribute doesn't exist.
230
- unset : function(attr, options) {
231
- if (!(attr in this.attributes)) return this;
232
- options || (options = {});
233
- var value = this.attributes[attr];
378
+ // Remove an attribute from the model, firing `"change"`. `unset` is a noop
379
+ // if the attribute doesn't exist.
380
+ unset: function(attr, options) {
381
+ return this.set(attr, void 0, _.extend({}, options, {unset: true}));
382
+ },
234
383
 
235
- // Run validation.
236
- var validObj = {};
237
- validObj[attr] = void 0;
238
- if (!options.silent && this.validate && !this._performValidation(validObj, options)) return false;
239
-
240
- // Remove the attribute.
241
- delete this.attributes[attr];
242
- delete this._escapedAttributes[attr];
243
- if (attr == this.idAttribute) delete this.id;
244
- this._changed = true;
245
- if (!options.silent) {
246
- this.trigger('change:' + attr, this, void 0, options);
247
- this.change(options);
248
- }
249
- return this;
384
+ // Clear all attributes on the model, firing `"change"`.
385
+ clear: function(options) {
386
+ var attrs = {};
387
+ for (var key in this.attributes) attrs[key] = void 0;
388
+ return this.set(attrs, _.extend({}, options, {unset: true}));
250
389
  },
251
390
 
252
- // Clear all attributes on the model, firing `"change"` unless you choose
253
- // to silence it.
254
- clear : function(options) {
255
- options || (options = {});
256
- var attr;
257
- var old = this.attributes;
391
+ // Determine if the model has changed since the last `"change"` event.
392
+ // If you specify an attribute name, determine if that attribute has changed.
393
+ hasChanged: function(attr) {
394
+ if (attr == null) return !_.isEmpty(this.changed);
395
+ return _.has(this.changed, attr);
396
+ },
258
397
 
259
- // Run validation.
260
- var validObj = {};
261
- for (attr in old) validObj[attr] = void 0;
262
- if (!options.silent && this.validate && !this._performValidation(validObj, options)) return false;
263
-
264
- this.attributes = {};
265
- this._escapedAttributes = {};
266
- this._changed = true;
267
- if (!options.silent) {
268
- for (attr in old) {
269
- this.trigger('change:' + attr, this, void 0, options);
270
- }
271
- this.change(options);
398
+ // Return an object containing all the attributes that have changed, or
399
+ // false if there are no changed attributes. Useful for determining what
400
+ // parts of a view need to be updated and/or what attributes need to be
401
+ // persisted to the server. Unset attributes will be set to undefined.
402
+ // You can also pass an attributes object to diff against the model,
403
+ // determining if there *would be* a change.
404
+ changedAttributes: function(diff) {
405
+ if (!diff) return this.hasChanged() ? _.clone(this.changed) : false;
406
+ var val, changed = false;
407
+ var old = this._changing ? this._previousAttributes : this.attributes;
408
+ for (var attr in diff) {
409
+ if (_.isEqual(old[attr], (val = diff[attr]))) continue;
410
+ (changed || (changed = {}))[attr] = val;
272
411
  }
273
- return this;
412
+ return changed;
413
+ },
414
+
415
+ // Get the previous value of an attribute, recorded at the time the last
416
+ // `"change"` event was fired.
417
+ previous: function(attr) {
418
+ if (attr == null || !this._previousAttributes) return null;
419
+ return this._previousAttributes[attr];
420
+ },
421
+
422
+ // Get all of the attributes of the model at the time of the previous
423
+ // `"change"` event.
424
+ previousAttributes: function() {
425
+ return _.clone(this._previousAttributes);
274
426
  },
275
427
 
276
428
  // Fetch the model from the server. If the server's representation of the
277
- // model differs from its current attributes, they will be overriden,
429
+ // model differs from its current attributes, they will be overridden,
278
430
  // triggering a `"change"` event.
279
- fetch : function(options) {
280
- options || (options = {});
431
+ fetch: function(options) {
432
+ options = options ? _.clone(options) : {};
433
+ if (options.parse === void 0) options.parse = true;
281
434
  var model = this;
282
435
  var success = options.success;
283
- options.success = function(resp, status, xhr) {
284
- if (!model.set(model.parse(resp, xhr), options)) return false;
285
- if (success) success(model, resp);
436
+ options.success = function(resp) {
437
+ if (!model.set(model.parse(resp, options), options)) return false;
438
+ if (success) success(model, resp, options);
439
+ model.trigger('sync', model, resp, options);
286
440
  };
287
- options.error = wrapError(options.error, model, options);
288
- return (this.sync || Backbone.sync).call(this, 'read', this, options);
441
+ wrapError(this, options);
442
+ return this.sync('read', this, options);
289
443
  },
290
444
 
291
445
  // Set a hash of model attributes, and sync the model to the server.
292
446
  // If the server returns an attributes hash that differs, the model's
293
447
  // state will be `set` again.
294
- save : function(attrs, options) {
295
- options || (options = {});
296
- if (attrs && !this.set(attrs, options)) return false;
448
+ save: function(key, val, options) {
449
+ var attrs, method, xhr, attributes = this.attributes;
450
+
451
+ // Handle both `"key", value` and `{key: value}` -style arguments.
452
+ if (key == null || typeof key === 'object') {
453
+ attrs = key;
454
+ options = val;
455
+ } else {
456
+ (attrs = {})[key] = val;
457
+ }
458
+
459
+ // If we're not waiting and attributes exist, save acts as `set(attr).save(null, opts)`.
460
+ if (attrs && (!options || !options.wait) && !this.set(attrs, options)) return false;
461
+
462
+ options = _.extend({validate: true}, options);
463
+
464
+ // Do not persist invalid models.
465
+ if (!this._validate(attrs, options)) return false;
466
+
467
+ // Set temporary attributes if `{wait: true}`.
468
+ if (attrs && options.wait) {
469
+ this.attributes = _.extend({}, attributes, attrs);
470
+ }
471
+
472
+ // After a successful server-side save, the client is (optionally)
473
+ // updated with the server-side state.
474
+ if (options.parse === void 0) options.parse = true;
297
475
  var model = this;
298
476
  var success = options.success;
299
- options.success = function(resp, status, xhr) {
300
- if (!model.set(model.parse(resp, xhr), options)) return false;
301
- if (success) success(model, resp, xhr);
477
+ options.success = function(resp) {
478
+ // Ensure attributes are restored during synchronous saves.
479
+ model.attributes = attributes;
480
+ var serverAttrs = model.parse(resp, options);
481
+ if (options.wait) serverAttrs = _.extend(attrs || {}, serverAttrs);
482
+ if (_.isObject(serverAttrs) && !model.set(serverAttrs, options)) {
483
+ return false;
484
+ }
485
+ if (success) success(model, resp, options);
486
+ model.trigger('sync', model, resp, options);
302
487
  };
303
- options.error = wrapError(options.error, model, options);
304
- var method = this.isNew() ? 'create' : 'update';
305
- return (this.sync || Backbone.sync).call(this, method, this, options);
488
+ wrapError(this, options);
489
+
490
+ method = this.isNew() ? 'create' : (options.patch ? 'patch' : 'update');
491
+ if (method === 'patch') options.attrs = attrs;
492
+ xhr = this.sync(method, this, options);
493
+
494
+ // Restore attributes.
495
+ if (attrs && options.wait) this.attributes = attributes;
496
+
497
+ return xhr;
306
498
  },
307
499
 
308
- // Destroy this model on the server if it was already persisted. Upon success, the model is removed
309
- // from its collection, if it has one.
310
- destroy : function(options) {
311
- options || (options = {});
312
- if (this.isNew()) return this.trigger('destroy', this, this.collection, options);
500
+ // Destroy this model on the server if it was already persisted.
501
+ // Optimistically removes the model from its collection, if it has one.
502
+ // If `wait: true` is passed, waits for the server to respond before removal.
503
+ destroy: function(options) {
504
+ options = options ? _.clone(options) : {};
313
505
  var model = this;
314
506
  var success = options.success;
315
- options.success = function(resp) {
507
+
508
+ var destroy = function() {
316
509
  model.trigger('destroy', model, model.collection, options);
317
- if (success) success(model, resp);
318
510
  };
319
- options.error = wrapError(options.error, model, options);
320
- return (this.sync || Backbone.sync).call(this, 'delete', this, options);
511
+
512
+ options.success = function(resp) {
513
+ if (options.wait || model.isNew()) destroy();
514
+ if (success) success(model, resp, options);
515
+ if (!model.isNew()) model.trigger('sync', model, resp, options);
516
+ };
517
+
518
+ if (this.isNew()) {
519
+ options.success();
520
+ return false;
521
+ }
522
+ wrapError(this, options);
523
+
524
+ var xhr = this.sync('delete', this, options);
525
+ if (!options.wait) destroy();
526
+ return xhr;
321
527
  },
322
528
 
323
529
  // Default URL for the model's representation on the server -- if you're
324
530
  // using Backbone's restful methods, override this to change the endpoint
325
531
  // that will be called.
326
- url : function() {
327
- var base = getUrl(this.collection) || this.urlRoot || urlError();
532
+ url: function() {
533
+ var base = _.result(this, 'urlRoot') || _.result(this.collection, 'url') || urlError();
328
534
  if (this.isNew()) return base;
329
- return base + (base.charAt(base.length - 1) == '/' ? '' : '/') + encodeURIComponent(this.id);
535
+ return base + (base.charAt(base.length - 1) === '/' ? '' : '/') + encodeURIComponent(this.id);
330
536
  },
331
537
 
332
538
  // **parse** converts a response into the hash of attributes to be `set` on
333
539
  // the model. The default implementation is just to pass the response along.
334
- parse : function(resp, xhr) {
540
+ parse: function(resp, options) {
335
541
  return resp;
336
542
  },
337
543
 
338
544
  // Create a new model with identical attributes to this one.
339
- clone : function() {
340
- return new this.constructor(this);
545
+ clone: function() {
546
+ return new this.constructor(this.attributes);
341
547
  },
342
548
 
343
549
  // A model is new if it has never been saved to the server, and lacks an id.
344
- isNew : function() {
550
+ isNew: function() {
345
551
  return this.id == null;
346
552
  },
347
553
 
348
- // Call this method to manually fire a `change` event for this model.
349
- // Calling this will cause all objects observing the model to update.
350
- change : function(options) {
351
- this.trigger('change', this, options);
352
- this._previousAttributes = _.clone(this.attributes);
353
- this._changed = false;
354
- },
355
-
356
- // Determine if the model has changed since the last `"change"` event.
357
- // If you specify an attribute name, determine if that attribute has changed.
358
- hasChanged : function(attr) {
359
- if (attr) return this._previousAttributes[attr] != this.attributes[attr];
360
- return this._changed;
361
- },
362
-
363
- // Return an object containing all the attributes that have changed, or false
364
- // if there are no changed attributes. Useful for determining what parts of a
365
- // view need to be updated and/or what attributes need to be persisted to
366
- // the server.
367
- changedAttributes : function(now) {
368
- now || (now = this.attributes);
369
- var old = this._previousAttributes;
370
- var changed = false;
371
- for (var attr in now) {
372
- if (!_.isEqual(old[attr], now[attr])) {
373
- changed = changed || {};
374
- changed[attr] = now[attr];
375
- }
376
- }
377
- return changed;
554
+ // Check if the model is currently in a valid state.
555
+ isValid: function(options) {
556
+ return this._validate({}, _.extend(options || {}, { validate: true }));
378
557
  },
379
558
 
380
- // Get the previous value of an attribute, recorded at the time the last
381
- // `"change"` event was fired.
382
- previous : function(attr) {
383
- if (!attr || !this._previousAttributes) return null;
384
- return this._previousAttributes[attr];
385
- },
559
+ // Run validation against the next complete set of model attributes,
560
+ // returning `true` if all is well. Otherwise, fire an `"invalid"` event.
561
+ _validate: function(attrs, options) {
562
+ if (!options.validate || !this.validate) return true;
563
+ attrs = _.extend({}, this.attributes, attrs);
564
+ var error = this.validationError = this.validate(attrs, options) || null;
565
+ if (!error) return true;
566
+ this.trigger('invalid', this, error, _.extend(options || {}, {validationError: error}));
567
+ return false;
568
+ }
386
569
 
387
- // Get all of the attributes of the model at the time of the previous
388
- // `"change"` event.
389
- previousAttributes : function() {
390
- return _.clone(this._previousAttributes);
391
- },
570
+ });
392
571
 
393
- // Run validation against a set of incoming attributes, returning `true`
394
- // if all is well. If a specific `error` callback has been passed,
395
- // call that instead of firing the general `"error"` event.
396
- _performValidation : function(attrs, options) {
397
- var error = this.validate(attrs);
398
- if (error) {
399
- if (options.error) {
400
- options.error(this, error, options);
401
- } else {
402
- this.trigger('error', this, error, options);
403
- }
404
- return false;
405
- }
406
- return true;
407
- }
572
+ // Underscore methods that we want to implement on the Model.
573
+ var modelMethods = ['keys', 'values', 'pairs', 'invert', 'pick', 'omit'];
408
574
 
575
+ // Mix in each Underscore method as a proxy to `Model#attributes`.
576
+ _.each(modelMethods, function(method) {
577
+ Model.prototype[method] = function() {
578
+ var args = slice.call(arguments);
579
+ args.unshift(this.attributes);
580
+ return _[method].apply(_, args);
581
+ };
409
582
  });
410
583
 
411
584
  // Backbone.Collection
412
585
  // -------------------
413
586
 
414
- // Provides a standard collection class for our sets of models, ordered
415
- // or unordered. If a `comparator` is specified, the Collection will maintain
587
+ // If models tend to represent a single row of data, a Backbone Collection is
588
+ // more analagous to a table full of data ... or a small slice or page of that
589
+ // table, or a collection of rows that belong together for a particular reason
590
+ // -- all of the messages in this particular folder, all of the documents
591
+ // belonging to this particular author, and so on. Collections maintain
592
+ // indexes of their models, both in order, and for lookup by `id`.
593
+
594
+ // Create a new **Collection**, perhaps to contain a specific type of `model`.
595
+ // If a `comparator` is specified, the Collection will maintain
416
596
  // its models in sort order, as they're added and removed.
417
- Backbone.Collection = function(models, options) {
597
+ var Collection = Backbone.Collection = function(models, options) {
418
598
  options || (options = {});
419
- if (options.comparator) this.comparator = options.comparator;
420
- _.bindAll(this, '_onModelEvent', '_removeReference');
599
+ if (options.url) this.url = options.url;
600
+ if (options.model) this.model = options.model;
601
+ if (options.comparator !== void 0) this.comparator = options.comparator;
421
602
  this._reset();
422
- if (models) this.reset(models, {silent: true});
423
603
  this.initialize.apply(this, arguments);
604
+ if (models) this.reset(models, _.extend({silent: true}, options));
424
605
  };
425
606
 
607
+ // Default options for `Collection#set`.
608
+ var setOptions = {add: true, remove: true, merge: true};
609
+ var addOptions = {add: true, merge: false, remove: false};
610
+
426
611
  // Define the Collection's inheritable methods.
427
- _.extend(Backbone.Collection.prototype, Backbone.Events, {
612
+ _.extend(Collection.prototype, Events, {
428
613
 
429
614
  // The default model for a collection is just a **Backbone.Model**.
430
615
  // This should be overridden in most cases.
431
- model : Backbone.Model,
616
+ model: Model,
432
617
 
433
618
  // Initialize is an empty function by default. Override it with your own
434
619
  // initialization logic.
435
- initialize : function(){},
620
+ initialize: function(){},
436
621
 
437
622
  // The JSON representation of a Collection is an array of the
438
623
  // models' attributes.
439
- toJSON : function() {
440
- return this.map(function(model){ return model.toJSON(); });
624
+ toJSON: function(options) {
625
+ return this.map(function(model){ return model.toJSON(options); });
626
+ },
627
+
628
+ // Proxy `Backbone.sync` by default.
629
+ sync: function() {
630
+ return Backbone.sync.apply(this, arguments);
631
+ },
632
+
633
+ // Add a model, or list of models to the set.
634
+ add: function(models, options) {
635
+ return this.set(models, _.defaults(options || {}, addOptions));
441
636
  },
442
637
 
443
- // Add a model, or list of models to the set. Pass **silent** to avoid
444
- // firing the `added` event for every new model.
445
- add : function(models, options) {
446
- if (_.isArray(models)) {
447
- for (var i = 0, l = models.length; i < l; i++) {
448
- this._add(models[i], options);
638
+ // Remove a model, or a list of models from the set.
639
+ remove: function(models, options) {
640
+ models = _.isArray(models) ? models.slice() : [models];
641
+ options || (options = {});
642
+ var i, l, index, model;
643
+ for (i = 0, l = models.length; i < l; i++) {
644
+ model = this.get(models[i]);
645
+ if (!model) continue;
646
+ delete this._byId[model.id];
647
+ delete this._byId[model.cid];
648
+ index = this.indexOf(model);
649
+ this.models.splice(index, 1);
650
+ this.length--;
651
+ if (!options.silent) {
652
+ options.index = index;
653
+ model.trigger('remove', model, this, options);
449
654
  }
450
- } else {
451
- this._add(models, options);
655
+ this._removeReference(model);
452
656
  }
453
657
  return this;
454
658
  },
455
659
 
456
- // Remove a model, or a list of models from the set. Pass silent to avoid
457
- // firing the `removed` event for every model removed.
458
- remove : function(models, options) {
459
- if (_.isArray(models)) {
460
- for (var i = 0, l = models.length; i < l; i++) {
461
- this._remove(models[i], options);
660
+ // Update a collection by `set`-ing a new list of models, adding new ones,
661
+ // removing models that are no longer present, and merging models that
662
+ // already exist in the collection, as necessary. Similar to **Model#set**,
663
+ // the core operation for updating the data contained by the collection.
664
+ set: function(models, options) {
665
+ options = _.defaults(options || {}, setOptions);
666
+ if (options.parse) models = this.parse(models, options);
667
+ if (!_.isArray(models)) models = models ? [models] : [];
668
+ var i, l, model, attrs, existing, sort;
669
+ var at = options.at;
670
+ var sortable = this.comparator && (at == null) && options.sort !== false;
671
+ var sortAttr = _.isString(this.comparator) ? this.comparator : null;
672
+ var toAdd = [], toRemove = [], modelMap = {};
673
+
674
+ // Turn bare objects into model references, and prevent invalid models
675
+ // from being added.
676
+ for (i = 0, l = models.length; i < l; i++) {
677
+ if (!(model = this._prepareModel(models[i], options))) continue;
678
+
679
+ // If a duplicate is found, prevent it from being added and
680
+ // optionally merge it into the existing model.
681
+ if (existing = this.get(model)) {
682
+ if (options.remove) modelMap[existing.cid] = true;
683
+ if (options.merge) {
684
+ existing.set(model.attributes, options);
685
+ if (sortable && !sort && existing.hasChanged(sortAttr)) sort = true;
686
+ }
687
+
688
+ // This is a new model, push it to the `toAdd` list.
689
+ } else if (options.add) {
690
+ toAdd.push(model);
691
+
692
+ // Listen to added models' events, and index models for lookup by
693
+ // `id` and by `cid`.
694
+ model.on('all', this._onModelEvent, this);
695
+ this._byId[model.cid] = model;
696
+ if (model.id != null) this._byId[model.id] = model;
462
697
  }
463
- } else {
464
- this._remove(models, options);
465
698
  }
699
+
700
+ // Remove nonexistent models if appropriate.
701
+ if (options.remove) {
702
+ for (i = 0, l = this.length; i < l; ++i) {
703
+ if (!modelMap[(model = this.models[i]).cid]) toRemove.push(model);
704
+ }
705
+ if (toRemove.length) this.remove(toRemove, options);
706
+ }
707
+
708
+ // See if sorting is needed, update `length` and splice in new models.
709
+ if (toAdd.length) {
710
+ if (sortable) sort = true;
711
+ this.length += toAdd.length;
712
+ if (at != null) {
713
+ splice.apply(this.models, [at, 0].concat(toAdd));
714
+ } else {
715
+ push.apply(this.models, toAdd);
716
+ }
717
+ }
718
+
719
+ // Silently sort the collection if appropriate.
720
+ if (sort) this.sort({silent: true});
721
+
722
+ if (options.silent) return this;
723
+
724
+ // Trigger `add` events.
725
+ for (i = 0, l = toAdd.length; i < l; i++) {
726
+ (model = toAdd[i]).trigger('add', model, this, options);
727
+ }
728
+
729
+ // Trigger `sort` if the collection was sorted.
730
+ if (sort) this.trigger('sort', this, options);
466
731
  return this;
467
732
  },
468
733
 
469
- // Get a model from the set by id.
470
- get : function(id) {
471
- if (id == null) return null;
472
- return this._byId[id.id != null ? id.id : id];
734
+ // When you have more items than you want to add or remove individually,
735
+ // you can reset the entire set with a new list of models, without firing
736
+ // any granular `add` or `remove` events. Fires `reset` when finished.
737
+ // Useful for bulk operations and optimizations.
738
+ reset: function(models, options) {
739
+ options || (options = {});
740
+ for (var i = 0, l = this.models.length; i < l; i++) {
741
+ this._removeReference(this.models[i]);
742
+ }
743
+ options.previousModels = this.models;
744
+ this._reset();
745
+ this.add(models, _.extend({silent: true}, options));
746
+ if (!options.silent) this.trigger('reset', this, options);
747
+ return this;
748
+ },
749
+
750
+ // Add a model to the end of the collection.
751
+ push: function(model, options) {
752
+ model = this._prepareModel(model, options);
753
+ this.add(model, _.extend({at: this.length}, options));
754
+ return model;
755
+ },
756
+
757
+ // Remove a model from the end of the collection.
758
+ pop: function(options) {
759
+ var model = this.at(this.length - 1);
760
+ this.remove(model, options);
761
+ return model;
762
+ },
763
+
764
+ // Add a model to the beginning of the collection.
765
+ unshift: function(model, options) {
766
+ model = this._prepareModel(model, options);
767
+ this.add(model, _.extend({at: 0}, options));
768
+ return model;
769
+ },
770
+
771
+ // Remove a model from the beginning of the collection.
772
+ shift: function(options) {
773
+ var model = this.at(0);
774
+ this.remove(model, options);
775
+ return model;
776
+ },
777
+
778
+ // Slice out a sub-array of models from the collection.
779
+ slice: function(begin, end) {
780
+ return this.models.slice(begin, end);
473
781
  },
474
782
 
475
- // Get a model from the set by client id.
476
- getByCid : function(cid) {
477
- return cid && this._byCid[cid.cid || cid];
783
+ // Get a model from the set by id.
784
+ get: function(obj) {
785
+ if (obj == null) return void 0;
786
+ return this._byId[obj.id != null ? obj.id : obj.cid || obj];
478
787
  },
479
788
 
480
789
  // Get the model at the given index.
@@ -482,61 +791,87 @@
482
791
  return this.models[index];
483
792
  },
484
793
 
485
- // Force the collection to re-sort itself. You don't need to call this under normal
486
- // circumstances, as the set will maintain sort order as each item is added.
487
- sort : function(options) {
488
- options || (options = {});
489
- if (!this.comparator) throw new Error('Cannot sort a set without a comparator');
490
- this.models = this.sortBy(this.comparator);
491
- if (!options.silent) this.trigger('reset', this, options);
492
- return this;
794
+ // Return models with matching attributes. Useful for simple cases of
795
+ // `filter`.
796
+ where: function(attrs, first) {
797
+ if (_.isEmpty(attrs)) return first ? void 0 : [];
798
+ return this[first ? 'find' : 'filter'](function(model) {
799
+ for (var key in attrs) {
800
+ if (attrs[key] !== model.get(key)) return false;
801
+ }
802
+ return true;
803
+ });
493
804
  },
494
805
 
495
- // Pluck an attribute from each model in the collection.
496
- pluck : function(attr) {
497
- return _.map(this.models, function(model){ return model.get(attr); });
806
+ // Return the first model with matching attributes. Useful for simple cases
807
+ // of `find`.
808
+ findWhere: function(attrs) {
809
+ return this.where(attrs, true);
498
810
  },
499
811
 
500
- // When you have more items than you want to add or remove individually,
501
- // you can reset the entire set with a new list of models, without firing
502
- // any `added` or `removed` events. Fires `reset` when finished.
503
- reset : function(models, options) {
504
- models || (models = []);
812
+ // Force the collection to re-sort itself. You don't need to call this under
813
+ // normal circumstances, as the set will maintain sort order as each item
814
+ // is added.
815
+ sort: function(options) {
816
+ if (!this.comparator) throw new Error('Cannot sort a set without a comparator');
505
817
  options || (options = {});
506
- this.each(this._removeReference);
507
- this._reset();
508
- this.add(models, {silent: true});
509
- if (!options.silent) this.trigger('reset', this, options);
818
+
819
+ // Run sort based on type of `comparator`.
820
+ if (_.isString(this.comparator) || this.comparator.length === 1) {
821
+ this.models = this.sortBy(this.comparator, this);
822
+ } else {
823
+ this.models.sort(_.bind(this.comparator, this));
824
+ }
825
+
826
+ if (!options.silent) this.trigger('sort', this, options);
510
827
  return this;
511
828
  },
512
829
 
830
+ // Figure out the smallest index at which a model should be inserted so as
831
+ // to maintain order.
832
+ sortedIndex: function(model, value, context) {
833
+ value || (value = this.comparator);
834
+ var iterator = _.isFunction(value) ? value : function(model) {
835
+ return model.get(value);
836
+ };
837
+ return _.sortedIndex(this.models, model, iterator, context);
838
+ },
839
+
840
+ // Pluck an attribute from each model in the collection.
841
+ pluck: function(attr) {
842
+ return _.invoke(this.models, 'get', attr);
843
+ },
844
+
513
845
  // Fetch the default set of models for this collection, resetting the
514
- // collection when they arrive. If `add: true` is passed, appends the
515
- // models to the collection instead of resetting.
516
- fetch : function(options) {
517
- options || (options = {});
518
- var collection = this;
846
+ // collection when they arrive. If `reset: true` is passed, the response
847
+ // data will be passed through the `reset` method instead of `set`.
848
+ fetch: function(options) {
849
+ options = options ? _.clone(options) : {};
850
+ if (options.parse === void 0) options.parse = true;
519
851
  var success = options.success;
520
- options.success = function(resp, status, xhr) {
521
- collection[options.add ? 'add' : 'reset'](collection.parse(resp, xhr), options);
522
- if (success) success(collection, resp);
852
+ var collection = this;
853
+ options.success = function(resp) {
854
+ var method = options.reset ? 'reset' : 'set';
855
+ collection[method](resp, options);
856
+ if (success) success(collection, resp, options);
857
+ collection.trigger('sync', collection, resp, options);
523
858
  };
524
- options.error = wrapError(options.error, collection, options);
525
- return (this.sync || Backbone.sync).call(this, 'read', this, options);
859
+ wrapError(this, options);
860
+ return this.sync('read', this, options);
526
861
  },
527
862
 
528
- // Create a new instance of a model in this collection. After the model
529
- // has been created on the server, it will be added to the collection.
530
- // Returns the model, or 'false' if validation on a new model fails.
531
- create : function(model, options) {
532
- var coll = this;
533
- options || (options = {});
534
- model = this._prepareModel(model, options);
535
- if (!model) return false;
863
+ // Create a new instance of a model in this collection. Add the model to the
864
+ // collection immediately, unless `wait: true` is passed, in which case we
865
+ // wait for the server to agree.
866
+ create: function(model, options) {
867
+ options = options ? _.clone(options) : {};
868
+ if (!(model = this._prepareModel(model, options))) return false;
869
+ if (!options.wait) this.add(model, options);
870
+ var collection = this;
536
871
  var success = options.success;
537
- options.success = function(nextModel, resp, xhr) {
538
- coll.add(nextModel, options);
539
- if (success) success(nextModel, resp, xhr);
872
+ options.success = function(resp) {
873
+ if (options.wait) collection.add(model, options);
874
+ if (success) success(model, resp, options);
540
875
  };
541
876
  model.save(null, options);
542
877
  return model;
@@ -544,93 +879,56 @@
544
879
 
545
880
  // **parse** converts a response into a list of models to be added to the
546
881
  // collection. The default implementation is just to pass it through.
547
- parse : function(resp, xhr) {
882
+ parse: function(resp, options) {
548
883
  return resp;
549
884
  },
550
885
 
551
- // Proxy to _'s chain. Can't be proxied the same way the rest of the
552
- // underscore methods are proxied because it relies on the underscore
553
- // constructor.
554
- chain: function () {
555
- return _(this.models).chain();
886
+ // Create a new collection with an identical list of models as this one.
887
+ clone: function() {
888
+ return new this.constructor(this.models);
556
889
  },
557
890
 
558
- // Reset all internal state. Called when the collection is reset.
559
- _reset : function(options) {
891
+ // Private method to reset all internal state. Called when the collection
892
+ // is first initialized or reset.
893
+ _reset: function() {
560
894
  this.length = 0;
561
895
  this.models = [];
562
896
  this._byId = {};
563
- this._byCid = {};
564
897
  },
565
898
 
566
- // Prepare a model to be added to this collection
567
- _prepareModel: function(model, options) {
568
- if (!(model instanceof Backbone.Model)) {
569
- var attrs = model;
570
- model = new this.model(attrs, {collection: this});
571
- if (model.validate && !model._performValidation(attrs, options)) model = false;
572
- } else if (!model.collection) {
573
- model.collection = this;
899
+ // Prepare a hash of attributes (or other model) to be added to this
900
+ // collection.
901
+ _prepareModel: function(attrs, options) {
902
+ if (attrs instanceof Model) {
903
+ if (!attrs.collection) attrs.collection = this;
904
+ return attrs;
574
905
  }
575
- return model;
576
- },
577
-
578
- // Internal implementation of adding a single model to the set, updating
579
- // hash indexes for `id` and `cid` lookups.
580
- // Returns the model, or 'false' if validation on a new model fails.
581
- _add : function(model, options) {
582
- options || (options = {});
583
- model = this._prepareModel(model, options);
584
- if (!model) return false;
585
- var already = this.getByCid(model);
586
- if (already) throw new Error(["Can't add the same model to a set twice", already.id]);
587
- this._byId[model.id] = model;
588
- this._byCid[model.cid] = model;
589
- var index = options.at != null ? options.at :
590
- this.comparator ? this.sortedIndex(model, this.comparator) :
591
- this.length;
592
- this.models.splice(index, 0, model);
593
- model.bind('all', this._onModelEvent);
594
- this.length++;
595
- if (!options.silent) model.trigger('add', model, this, options);
596
- return model;
597
- },
598
-
599
- // Internal implementation of removing a single model from the set, updating
600
- // hash indexes for `id` and `cid` lookups.
601
- _remove : function(model, options) {
602
906
  options || (options = {});
603
- model = this.getByCid(model) || this.get(model);
604
- if (!model) return null;
605
- delete this._byId[model.id];
606
- delete this._byCid[model.cid];
607
- this.models.splice(this.indexOf(model), 1);
608
- this.length--;
609
- if (!options.silent) model.trigger('remove', model, this, options);
610
- this._removeReference(model);
907
+ options.collection = this;
908
+ var model = new this.model(attrs, options);
909
+ if (!model._validate(attrs, options)) {
910
+ this.trigger('invalid', this, attrs, options);
911
+ return false;
912
+ }
611
913
  return model;
612
914
  },
613
915
 
614
- // Internal method to remove a model's ties to a collection.
615
- _removeReference : function(model) {
616
- if (this == model.collection) {
617
- delete model.collection;
618
- }
619
- model.unbind('all', this._onModelEvent);
916
+ // Internal method to sever a model's ties to a collection.
917
+ _removeReference: function(model) {
918
+ if (this === model.collection) delete model.collection;
919
+ model.off('all', this._onModelEvent, this);
620
920
  },
621
921
 
622
922
  // Internal method called every time a model in the set fires an event.
623
923
  // Sets need to update their indexes when models change ids. All other
624
924
  // events simply proxy through. "add" and "remove" events that originate
625
925
  // in other collections are ignored.
626
- _onModelEvent : function(ev, model, collection, options) {
627
- if ((ev == 'add' || ev == 'remove') && collection != this) return;
628
- if (ev == 'destroy') {
629
- this._remove(model, options);
630
- }
631
- if (model && ev === 'change:' + model.idAttribute) {
926
+ _onModelEvent: function(event, model, collection, options) {
927
+ if ((event === 'add' || event === 'remove') && collection !== this) return;
928
+ if (event === 'destroy') this.remove(model, options);
929
+ if (model && event === 'change:' + model.idAttribute) {
632
930
  delete this._byId[model.previous(model.idAttribute)];
633
- this._byId[model.id] = model;
931
+ if (model.id != null) this._byId[model.id] = model;
634
932
  }
635
933
  this.trigger.apply(this, arguments);
636
934
  }
@@ -638,91 +936,360 @@
638
936
  });
639
937
 
640
938
  // Underscore methods that we want to implement on the Collection.
641
- var methods = ['forEach', 'each', 'map', 'reduce', 'reduceRight', 'find', 'detect',
642
- 'filter', 'select', 'reject', 'every', 'all', 'some', 'any', 'include',
643
- 'contains', 'invoke', 'max', 'min', 'sortBy', 'sortedIndex', 'toArray', 'size',
644
- 'first', 'rest', 'last', 'without', 'indexOf', 'lastIndexOf', 'isEmpty', 'groupBy'];
939
+ // 90% of the core usefulness of Backbone Collections is actually implemented
940
+ // right here:
941
+ var methods = ['forEach', 'each', 'map', 'collect', 'reduce', 'foldl',
942
+ 'inject', 'reduceRight', 'foldr', 'find', 'detect', 'filter', 'select',
943
+ 'reject', 'every', 'all', 'some', 'any', 'include', 'contains', 'invoke',
944
+ 'max', 'min', 'toArray', 'size', 'first', 'head', 'take', 'initial', 'rest',
945
+ 'tail', 'drop', 'last', 'without', 'indexOf', 'shuffle', 'lastIndexOf',
946
+ 'isEmpty', 'chain'];
645
947
 
646
948
  // Mix in each Underscore method as a proxy to `Collection#models`.
647
949
  _.each(methods, function(method) {
648
- Backbone.Collection.prototype[method] = function() {
649
- return _[method].apply(_, [this.models].concat(_.toArray(arguments)));
950
+ Collection.prototype[method] = function() {
951
+ var args = slice.call(arguments);
952
+ args.unshift(this.models);
953
+ return _[method].apply(_, args);
650
954
  };
651
955
  });
652
956
 
653
- // Backbone.Router
654
- // -------------------
957
+ // Underscore methods that take a property name as an argument.
958
+ var attributeMethods = ['groupBy', 'countBy', 'sortBy'];
655
959
 
656
- // Routers map faux-URLs to actions, and fire events when routes are
657
- // matched. Creating a new one sets its `routes` hash, if not set statically.
658
- Backbone.Router = function(options) {
659
- options || (options = {});
660
- if (options.routes) this.routes = options.routes;
661
- this._bindRoutes();
960
+ // Use attributes instead of properties.
961
+ _.each(attributeMethods, function(method) {
962
+ Collection.prototype[method] = function(value, context) {
963
+ var iterator = _.isFunction(value) ? value : function(model) {
964
+ return model.get(value);
965
+ };
966
+ return _[method](this.models, iterator, context);
967
+ };
968
+ });
969
+
970
+ // Backbone.View
971
+ // -------------
972
+
973
+ // Backbone Views are almost more convention than they are actual code. A View
974
+ // is simply a JavaScript object that represents a logical chunk of UI in the
975
+ // DOM. This might be a single item, an entire list, a sidebar or panel, or
976
+ // even the surrounding frame which wraps your whole app. Defining a chunk of
977
+ // UI as a **View** allows you to define your DOM events declaratively, without
978
+ // having to worry about render order ... and makes it easy for the view to
979
+ // react to specific changes in the state of your models.
980
+
981
+ // Creating a Backbone.View creates its initial element outside of the DOM,
982
+ // if an existing element is not provided...
983
+ var View = Backbone.View = function(options) {
984
+ this.cid = _.uniqueId('view');
985
+ this._configure(options || {});
986
+ this._ensureElement();
662
987
  this.initialize.apply(this, arguments);
988
+ this.delegateEvents();
663
989
  };
664
990
 
665
- // Cached regular expressions for matching named param parts and splatted
666
- // parts of route strings.
667
- var namedParam = /:([\w\d]+)/g;
668
- var splatParam = /\*([\w\d]+)/g;
669
- var escapeRegExp = /[-[\]{}()+?.,\\^$|#\s]/g;
991
+ // Cached regex to split keys for `delegate`.
992
+ var delegateEventSplitter = /^(\S+)\s*(.*)$/;
670
993
 
671
- // Set up all inheritable **Backbone.Router** properties and methods.
672
- _.extend(Backbone.Router.prototype, Backbone.Events, {
994
+ // List of view options to be merged as properties.
995
+ var viewOptions = ['model', 'collection', 'el', 'id', 'attributes', 'className', 'tagName', 'events'];
996
+
997
+ // Set up all inheritable **Backbone.View** properties and methods.
998
+ _.extend(View.prototype, Events, {
999
+
1000
+ // The default `tagName` of a View's element is `"div"`.
1001
+ tagName: 'div',
1002
+
1003
+ // jQuery delegate for element lookup, scoped to DOM elements within the
1004
+ // current view. This should be prefered to global lookups where possible.
1005
+ $: function(selector) {
1006
+ return this.$el.find(selector);
1007
+ },
673
1008
 
674
1009
  // Initialize is an empty function by default. Override it with your own
675
1010
  // initialization logic.
676
- initialize : function(){},
1011
+ initialize: function(){},
677
1012
 
678
- // Manually bind a single named route to a callback. For example:
679
- //
680
- // this.route('search/:query/p:num', 'search', function(query, num) {
1013
+ // **render** is the core function that your view should override, in order
1014
+ // to populate its element (`this.el`), with the appropriate HTML. The
1015
+ // convention is for **render** to always return `this`.
1016
+ render: function() {
1017
+ return this;
1018
+ },
1019
+
1020
+ // Remove this view by taking the element out of the DOM, and removing any
1021
+ // applicable Backbone.Events listeners.
1022
+ remove: function() {
1023
+ this.$el.remove();
1024
+ this.stopListening();
1025
+ return this;
1026
+ },
1027
+
1028
+ // Change the view's element (`this.el` property), including event
1029
+ // re-delegation.
1030
+ setElement: function(element, delegate) {
1031
+ if (this.$el) this.undelegateEvents();
1032
+ this.$el = element instanceof Backbone.$ ? element : Backbone.$(element);
1033
+ this.el = this.$el[0];
1034
+ if (delegate !== false) this.delegateEvents();
1035
+ return this;
1036
+ },
1037
+
1038
+ // Set callbacks, where `this.events` is a hash of
1039
+ //
1040
+ // *{"event selector": "callback"}*
1041
+ //
1042
+ // {
1043
+ // 'mousedown .title': 'edit',
1044
+ // 'click .button': 'save'
1045
+ // 'click .open': function(e) { ... }
1046
+ // }
1047
+ //
1048
+ // pairs. Callbacks will be bound to the view, with `this` set properly.
1049
+ // Uses event delegation for efficiency.
1050
+ // Omitting the selector binds the event to `this.el`.
1051
+ // This only works for delegate-able events: not `focus`, `blur`, and
1052
+ // not `change`, `submit`, and `reset` in Internet Explorer.
1053
+ delegateEvents: function(events) {
1054
+ if (!(events || (events = _.result(this, 'events')))) return this;
1055
+ this.undelegateEvents();
1056
+ for (var key in events) {
1057
+ var method = events[key];
1058
+ if (!_.isFunction(method)) method = this[events[key]];
1059
+ if (!method) continue;
1060
+
1061
+ var match = key.match(delegateEventSplitter);
1062
+ var eventName = match[1], selector = match[2];
1063
+ method = _.bind(method, this);
1064
+ eventName += '.delegateEvents' + this.cid;
1065
+ if (selector === '') {
1066
+ this.$el.on(eventName, method);
1067
+ } else {
1068
+ this.$el.on(eventName, selector, method);
1069
+ }
1070
+ }
1071
+ return this;
1072
+ },
1073
+
1074
+ // Clears all callbacks previously bound to the view with `delegateEvents`.
1075
+ // You usually don't need to use this, but may wish to if you have multiple
1076
+ // Backbone views attached to the same DOM element.
1077
+ undelegateEvents: function() {
1078
+ this.$el.off('.delegateEvents' + this.cid);
1079
+ return this;
1080
+ },
1081
+
1082
+ // Performs the initial configuration of a View with a set of options.
1083
+ // Keys with special meaning *(e.g. model, collection, id, className)* are
1084
+ // attached directly to the view. See `viewOptions` for an exhaustive
1085
+ // list.
1086
+ _configure: function(options) {
1087
+ if (this.options) options = _.extend({}, _.result(this, 'options'), options);
1088
+ _.extend(this, _.pick(options, viewOptions));
1089
+ this.options = options;
1090
+ },
1091
+
1092
+ // Ensure that the View has a DOM element to render into.
1093
+ // If `this.el` is a string, pass it through `$()`, take the first
1094
+ // matching element, and re-assign it to `el`. Otherwise, create
1095
+ // an element from the `id`, `className` and `tagName` properties.
1096
+ _ensureElement: function() {
1097
+ if (!this.el) {
1098
+ var attrs = _.extend({}, _.result(this, 'attributes'));
1099
+ if (this.id) attrs.id = _.result(this, 'id');
1100
+ if (this.className) attrs['class'] = _.result(this, 'className');
1101
+ var $el = Backbone.$('<' + _.result(this, 'tagName') + '>').attr(attrs);
1102
+ this.setElement($el, false);
1103
+ } else {
1104
+ this.setElement(_.result(this, 'el'), false);
1105
+ }
1106
+ }
1107
+
1108
+ });
1109
+
1110
+ // Backbone.sync
1111
+ // -------------
1112
+
1113
+ // Override this function to change the manner in which Backbone persists
1114
+ // models to the server. You will be passed the type of request, and the
1115
+ // model in question. By default, makes a RESTful Ajax request
1116
+ // to the model's `url()`. Some possible customizations could be:
1117
+ //
1118
+ // * Use `setTimeout` to batch rapid-fire updates into a single request.
1119
+ // * Send up the models as XML instead of JSON.
1120
+ // * Persist models via WebSockets instead of Ajax.
1121
+ //
1122
+ // Turn on `Backbone.emulateHTTP` in order to send `PUT` and `DELETE` requests
1123
+ // as `POST`, with a `_method` parameter containing the true HTTP method,
1124
+ // as well as all requests with the body as `application/x-www-form-urlencoded`
1125
+ // instead of `application/json` with the model in a param named `model`.
1126
+ // Useful when interfacing with server-side languages like **PHP** that make
1127
+ // it difficult to read the body of `PUT` requests.
1128
+ Backbone.sync = function(method, model, options) {
1129
+ var type = methodMap[method];
1130
+
1131
+ // Default options, unless specified.
1132
+ _.defaults(options || (options = {}), {
1133
+ emulateHTTP: Backbone.emulateHTTP,
1134
+ emulateJSON: Backbone.emulateJSON
1135
+ });
1136
+
1137
+ // Default JSON-request options.
1138
+ var params = {type: type, dataType: 'json'};
1139
+
1140
+ // Ensure that we have a URL.
1141
+ if (!options.url) {
1142
+ params.url = _.result(model, 'url') || urlError();
1143
+ }
1144
+
1145
+ // Ensure that we have the appropriate request data.
1146
+ if (options.data == null && model && (method === 'create' || method === 'update' || method === 'patch')) {
1147
+ params.contentType = 'application/json';
1148
+ params.data = JSON.stringify(options.attrs || model.toJSON(options));
1149
+ }
1150
+
1151
+ // For older servers, emulate JSON by encoding the request into an HTML-form.
1152
+ if (options.emulateJSON) {
1153
+ params.contentType = 'application/x-www-form-urlencoded';
1154
+ params.data = params.data ? {model: params.data} : {};
1155
+ }
1156
+
1157
+ // For older servers, emulate HTTP by mimicking the HTTP method with `_method`
1158
+ // And an `X-HTTP-Method-Override` header.
1159
+ if (options.emulateHTTP && (type === 'PUT' || type === 'DELETE' || type === 'PATCH')) {
1160
+ params.type = 'POST';
1161
+ if (options.emulateJSON) params.data._method = type;
1162
+ var beforeSend = options.beforeSend;
1163
+ options.beforeSend = function(xhr) {
1164
+ xhr.setRequestHeader('X-HTTP-Method-Override', type);
1165
+ if (beforeSend) return beforeSend.apply(this, arguments);
1166
+ };
1167
+ }
1168
+
1169
+ // Don't process data on a non-GET request.
1170
+ if (params.type !== 'GET' && !options.emulateJSON) {
1171
+ params.processData = false;
1172
+ }
1173
+
1174
+ // If we're sending a `PATCH` request, and we're in an old Internet Explorer
1175
+ // that still has ActiveX enabled by default, override jQuery to use that
1176
+ // for XHR instead. Remove this line when jQuery supports `PATCH` on IE8.
1177
+ if (params.type === 'PATCH' && window.ActiveXObject &&
1178
+ !(window.external && window.external.msActiveXFilteringEnabled)) {
1179
+ params.xhr = function() {
1180
+ return new ActiveXObject("Microsoft.XMLHTTP");
1181
+ };
1182
+ }
1183
+
1184
+ // Make the request, allowing the user to override any Ajax options.
1185
+ var xhr = options.xhr = Backbone.ajax(_.extend(params, options));
1186
+ model.trigger('request', model, xhr, options);
1187
+ return xhr;
1188
+ };
1189
+
1190
+ // Map from CRUD to HTTP for our default `Backbone.sync` implementation.
1191
+ var methodMap = {
1192
+ 'create': 'POST',
1193
+ 'update': 'PUT',
1194
+ 'patch': 'PATCH',
1195
+ 'delete': 'DELETE',
1196
+ 'read': 'GET'
1197
+ };
1198
+
1199
+ // Set the default implementation of `Backbone.ajax` to proxy through to `$`.
1200
+ // Override this if you'd like to use a different library.
1201
+ Backbone.ajax = function() {
1202
+ return Backbone.$.ajax.apply(Backbone.$, arguments);
1203
+ };
1204
+
1205
+ // Backbone.Router
1206
+ // ---------------
1207
+
1208
+ // Routers map faux-URLs to actions, and fire events when routes are
1209
+ // matched. Creating a new one sets its `routes` hash, if not set statically.
1210
+ var Router = Backbone.Router = function(options) {
1211
+ options || (options = {});
1212
+ if (options.routes) this.routes = options.routes;
1213
+ this._bindRoutes();
1214
+ this.initialize.apply(this, arguments);
1215
+ };
1216
+
1217
+ // Cached regular expressions for matching named param parts and splatted
1218
+ // parts of route strings.
1219
+ var optionalParam = /\((.*?)\)/g;
1220
+ var namedParam = /(\(\?)?:\w+/g;
1221
+ var splatParam = /\*\w+/g;
1222
+ var escapeRegExp = /[\-{}\[\]+?.,\\\^$|#\s]/g;
1223
+
1224
+ // Set up all inheritable **Backbone.Router** properties and methods.
1225
+ _.extend(Router.prototype, Events, {
1226
+
1227
+ // Initialize is an empty function by default. Override it with your own
1228
+ // initialization logic.
1229
+ initialize: function(){},
1230
+
1231
+ // Manually bind a single named route to a callback. For example:
1232
+ //
1233
+ // this.route('search/:query/p:num', 'search', function(query, num) {
681
1234
  // ...
682
1235
  // });
683
1236
  //
684
- route : function(route, name, callback) {
685
- Backbone.history || (Backbone.history = new Backbone.History);
1237
+ route: function(route, name, callback) {
686
1238
  if (!_.isRegExp(route)) route = this._routeToRegExp(route);
687
- Backbone.history.route(route, _.bind(function(fragment) {
688
- var args = this._extractParameters(route, fragment);
689
- callback.apply(this, args);
690
- this.trigger.apply(this, ['route:' + name].concat(args));
691
- }, this));
1239
+ if (_.isFunction(name)) {
1240
+ callback = name;
1241
+ name = '';
1242
+ }
1243
+ if (!callback) callback = this[name];
1244
+ var router = this;
1245
+ Backbone.history.route(route, function(fragment) {
1246
+ var args = router._extractParameters(route, fragment);
1247
+ callback && callback.apply(router, args);
1248
+ router.trigger.apply(router, ['route:' + name].concat(args));
1249
+ router.trigger('route', name, args);
1250
+ Backbone.history.trigger('route', router, name, args);
1251
+ });
1252
+ return this;
692
1253
  },
693
1254
 
694
1255
  // Simple proxy to `Backbone.history` to save a fragment into the history.
695
- navigate : function(fragment, triggerRoute) {
696
- Backbone.history.navigate(fragment, triggerRoute);
1256
+ navigate: function(fragment, options) {
1257
+ Backbone.history.navigate(fragment, options);
1258
+ return this;
697
1259
  },
698
1260
 
699
1261
  // Bind all defined routes to `Backbone.history`. We have to reverse the
700
1262
  // order of the routes here to support behavior where the most general
701
1263
  // routes can be defined at the bottom of the route map.
702
- _bindRoutes : function() {
1264
+ _bindRoutes: function() {
703
1265
  if (!this.routes) return;
704
- var routes = [];
705
- for (var route in this.routes) {
706
- routes.unshift([route, this.routes[route]]);
707
- }
708
- for (var i = 0, l = routes.length; i < l; i++) {
709
- this.route(routes[i][0], routes[i][1], this[routes[i][1]]);
1266
+ this.routes = _.result(this, 'routes');
1267
+ var route, routes = _.keys(this.routes);
1268
+ while ((route = routes.pop()) != null) {
1269
+ this.route(route, this.routes[route]);
710
1270
  }
711
1271
  },
712
1272
 
713
1273
  // Convert a route string into a regular expression, suitable for matching
714
1274
  // against the current location hash.
715
- _routeToRegExp : function(route) {
716
- route = route.replace(escapeRegExp, "\\$&")
717
- .replace(namedParam, "([^\/]*)")
718
- .replace(splatParam, "(.*?)");
1275
+ _routeToRegExp: function(route) {
1276
+ route = route.replace(escapeRegExp, '\\$&')
1277
+ .replace(optionalParam, '(?:$1)?')
1278
+ .replace(namedParam, function(match, optional){
1279
+ return optional ? match : '([^\/]+)';
1280
+ })
1281
+ .replace(splatParam, '(.*?)');
719
1282
  return new RegExp('^' + route + '$');
720
1283
  },
721
1284
 
722
1285
  // Given a route, and a URL fragment that it matches, return the array of
723
- // extracted parameters.
724
- _extractParameters : function(route, fragment) {
725
- return route.exec(fragment).slice(1);
1286
+ // extracted decoded parameters. Empty or unmatched parameters will be
1287
+ // treated as `null` to normalize cross-browser behavior.
1288
+ _extractParameters: function(route, fragment) {
1289
+ var params = route.exec(fragment).slice(1);
1290
+ return _.map(params, function(param) {
1291
+ return param ? decodeURIComponent(param) : null;
1292
+ });
726
1293
  }
727
1294
 
728
1295
  });
@@ -730,114 +1297,155 @@
730
1297
  // Backbone.History
731
1298
  // ----------------
732
1299
 
733
- // Handles cross-browser history management, based on URL fragments. If the
734
- // browser does not support `onhashchange`, falls back to polling.
735
- Backbone.History = function() {
1300
+ // Handles cross-browser history management, based on either
1301
+ // [pushState](http://diveintohtml5.info/history.html) and real URLs, or
1302
+ // [onhashchange](https://developer.mozilla.org/en-US/docs/DOM/window.onhashchange)
1303
+ // and URL fragments. If the browser supports neither (old IE, natch),
1304
+ // falls back to polling.
1305
+ var History = Backbone.History = function() {
736
1306
  this.handlers = [];
737
1307
  _.bindAll(this, 'checkUrl');
1308
+
1309
+ // Ensure that `History` can be used outside of the browser.
1310
+ if (typeof window !== 'undefined') {
1311
+ this.location = window.location;
1312
+ this.history = window.history;
1313
+ }
738
1314
  };
739
1315
 
740
- // Cached regex for cleaning hashes.
741
- var hashStrip = /^#*/;
1316
+ // Cached regex for stripping a leading hash/slash and trailing space.
1317
+ var routeStripper = /^[#\/]|\s+$/g;
1318
+
1319
+ // Cached regex for stripping leading and trailing slashes.
1320
+ var rootStripper = /^\/+|\/+$/g;
742
1321
 
743
1322
  // Cached regex for detecting MSIE.
744
1323
  var isExplorer = /msie [\w.]+/;
745
1324
 
1325
+ // Cached regex for removing a trailing slash.
1326
+ var trailingSlash = /\/$/;
1327
+
746
1328
  // Has the history handling already been started?
747
- var historyStarted = false;
1329
+ History.started = false;
748
1330
 
749
1331
  // Set up all inheritable **Backbone.History** properties and methods.
750
- _.extend(Backbone.History.prototype, {
1332
+ _.extend(History.prototype, Events, {
751
1333
 
752
1334
  // The default interval to poll for hash changes, if necessary, is
753
1335
  // twenty times a second.
754
1336
  interval: 50,
755
1337
 
1338
+ // Gets the true hash value. Cannot use location.hash directly due to bug
1339
+ // in Firefox where location.hash will always be decoded.
1340
+ getHash: function(window) {
1341
+ var match = (window || this).location.href.match(/#(.*)$/);
1342
+ return match ? match[1] : '';
1343
+ },
1344
+
756
1345
  // Get the cross-browser normalized URL fragment, either from the URL,
757
1346
  // the hash, or the override.
758
- getFragment : function(fragment, forcePushState) {
1347
+ getFragment: function(fragment, forcePushState) {
759
1348
  if (fragment == null) {
760
- if (this._hasPushState || forcePushState) {
761
- fragment = window.location.pathname;
762
- var search = window.location.search;
763
- if (search) fragment += search;
764
- if (fragment.indexOf(this.options.root) == 0) fragment = fragment.substr(this.options.root.length);
1349
+ if (this._hasPushState || !this._wantsHashChange || forcePushState) {
1350
+ fragment = this.location.pathname;
1351
+ var root = this.root.replace(trailingSlash, '');
1352
+ if (!fragment.indexOf(root)) fragment = fragment.substr(root.length);
765
1353
  } else {
766
- fragment = window.location.hash;
1354
+ fragment = this.getHash();
767
1355
  }
768
1356
  }
769
- return decodeURIComponent(fragment.replace(hashStrip, ''));
1357
+ return fragment.replace(routeStripper, '');
770
1358
  },
771
1359
 
772
1360
  // Start the hash change handling, returning `true` if the current URL matches
773
1361
  // an existing route, and `false` otherwise.
774
- start : function(options) {
1362
+ start: function(options) {
1363
+ if (History.started) throw new Error("Backbone.history has already been started");
1364
+ History.started = true;
775
1365
 
776
1366
  // Figure out the initial configuration. Do we need an iframe?
777
1367
  // Is pushState desired ... is it available?
778
- if (historyStarted) throw new Error("Backbone.history has already been started");
779
1368
  this.options = _.extend({}, {root: '/'}, this.options, options);
1369
+ this.root = this.options.root;
1370
+ this._wantsHashChange = this.options.hashChange !== false;
780
1371
  this._wantsPushState = !!this.options.pushState;
781
- this._hasPushState = !!(this.options.pushState && window.history && window.history.pushState);
1372
+ this._hasPushState = !!(this.options.pushState && this.history && this.history.pushState);
782
1373
  var fragment = this.getFragment();
783
1374
  var docMode = document.documentMode;
784
1375
  var oldIE = (isExplorer.exec(navigator.userAgent.toLowerCase()) && (!docMode || docMode <= 7));
785
- if (oldIE) {
786
- this.iframe = $('<iframe src="javascript:0" tabindex="-1" />').hide().appendTo('body')[0].contentWindow;
1376
+
1377
+ // Normalize root to always include a leading and trailing slash.
1378
+ this.root = ('/' + this.root + '/').replace(rootStripper, '/');
1379
+
1380
+ if (oldIE && this._wantsHashChange) {
1381
+ this.iframe = Backbone.$('<iframe src="javascript:0" tabindex="-1" />').hide().appendTo('body')[0].contentWindow;
787
1382
  this.navigate(fragment);
788
1383
  }
789
1384
 
790
1385
  // Depending on whether we're using pushState or hashes, and whether
791
1386
  // 'onhashchange' is supported, determine how we check the URL state.
792
1387
  if (this._hasPushState) {
793
- $(window).bind('popstate', this.checkUrl);
794
- } else if ('onhashchange' in window && !oldIE) {
795
- $(window).bind('hashchange', this.checkUrl);
796
- } else {
797
- setInterval(this.checkUrl, this.interval);
1388
+ Backbone.$(window).on('popstate', this.checkUrl);
1389
+ } else if (this._wantsHashChange && ('onhashchange' in window) && !oldIE) {
1390
+ Backbone.$(window).on('hashchange', this.checkUrl);
1391
+ } else if (this._wantsHashChange) {
1392
+ this._checkUrlInterval = setInterval(this.checkUrl, this.interval);
798
1393
  }
799
1394
 
800
1395
  // Determine if we need to change the base url, for a pushState link
801
1396
  // opened by a non-pushState browser.
802
1397
  this.fragment = fragment;
803
- historyStarted = true;
804
- var loc = window.location;
805
- var atRoot = loc.pathname == this.options.root;
806
- if (this._wantsPushState && !this._hasPushState && !atRoot) {
1398
+ var loc = this.location;
1399
+ var atRoot = loc.pathname.replace(/[^\/]$/, '$&/') === this.root;
1400
+
1401
+ // If we've started off with a route from a `pushState`-enabled browser,
1402
+ // but we're currently in a browser that doesn't support it...
1403
+ if (this._wantsHashChange && this._wantsPushState && !this._hasPushState && !atRoot) {
807
1404
  this.fragment = this.getFragment(null, true);
808
- window.location.replace(this.options.root + '#' + this.fragment);
1405
+ this.location.replace(this.root + this.location.search + '#' + this.fragment);
809
1406
  // Return immediately as browser will do redirect to new url
810
1407
  return true;
1408
+
1409
+ // Or if we've started out with a hash-based route, but we're currently
1410
+ // in a browser where it could be `pushState`-based instead...
811
1411
  } else if (this._wantsPushState && this._hasPushState && atRoot && loc.hash) {
812
- this.fragment = loc.hash.replace(hashStrip, '');
813
- window.history.replaceState({}, document.title, loc.protocol + '//' + loc.host + this.options.root + this.fragment);
1412
+ this.fragment = this.getHash().replace(routeStripper, '');
1413
+ this.history.replaceState({}, document.title, this.root + this.fragment + loc.search);
814
1414
  }
815
1415
 
816
- if (!this.options.silent) {
817
- return this.loadUrl();
818
- }
1416
+ if (!this.options.silent) return this.loadUrl();
1417
+ },
1418
+
1419
+ // Disable Backbone.history, perhaps temporarily. Not useful in a real app,
1420
+ // but possibly useful for unit testing Routers.
1421
+ stop: function() {
1422
+ Backbone.$(window).off('popstate', this.checkUrl).off('hashchange', this.checkUrl);
1423
+ clearInterval(this._checkUrlInterval);
1424
+ History.started = false;
819
1425
  },
820
1426
 
821
- // Add a route to be tested when the fragment changes. Routes added later may
822
- // override previous routes.
823
- route : function(route, callback) {
824
- this.handlers.unshift({route : route, callback : callback});
1427
+ // Add a route to be tested when the fragment changes. Routes added later
1428
+ // may override previous routes.
1429
+ route: function(route, callback) {
1430
+ this.handlers.unshift({route: route, callback: callback});
825
1431
  },
826
1432
 
827
1433
  // Checks the current URL to see if it has changed, and if it has,
828
1434
  // calls `loadUrl`, normalizing across the hidden iframe.
829
- checkUrl : function(e) {
1435
+ checkUrl: function(e) {
830
1436
  var current = this.getFragment();
831
- if (current == this.fragment && this.iframe) current = this.getFragment(this.iframe.location.hash);
832
- if (current == this.fragment || current == decodeURIComponent(this.fragment)) return false;
1437
+ if (current === this.fragment && this.iframe) {
1438
+ current = this.getFragment(this.getHash(this.iframe));
1439
+ }
1440
+ if (current === this.fragment) return false;
833
1441
  if (this.iframe) this.navigate(current);
834
- this.loadUrl() || this.loadUrl(window.location.hash);
1442
+ this.loadUrl() || this.loadUrl(this.getHash());
835
1443
  },
836
1444
 
837
1445
  // Attempt to load the current URL fragment. If a route succeeds with a
838
1446
  // match, returns `true`. If no defined routes matches the fragment,
839
1447
  // returns `false`.
840
- loadUrl : function(fragmentOverride) {
1448
+ loadUrl: function(fragmentOverride) {
841
1449
  var fragment = this.fragment = this.getFragment(fragmentOverride);
842
1450
  var matched = _.any(this.handlers, function(handler) {
843
1451
  if (handler.route.test(fragment)) {
@@ -848,291 +1456,103 @@
848
1456
  return matched;
849
1457
  },
850
1458
 
851
- // Save a fragment into the hash history. You are responsible for properly
852
- // URL-encoding the fragment in advance. This does not trigger
853
- // a `hashchange` event.
854
- navigate : function(fragment, triggerRoute) {
855
- var frag = (fragment || '').replace(hashStrip, '');
856
- if (this.fragment == frag || this.fragment == decodeURIComponent(frag)) return;
857
- if (this._hasPushState) {
858
- var loc = window.location;
859
- if (frag.indexOf(this.options.root) != 0) frag = this.options.root + frag;
860
- this.fragment = frag;
861
- window.history.pushState({}, document.title, loc.protocol + '//' + loc.host + frag);
862
- } else {
863
- window.location.hash = this.fragment = frag;
864
- if (this.iframe && (frag != this.getFragment(this.iframe.location.hash))) {
865
- this.iframe.document.open().close();
866
- this.iframe.location.hash = frag;
867
- }
868
- }
869
- if (triggerRoute) this.loadUrl(fragment);
870
- }
871
-
872
- });
873
-
874
- // Backbone.View
875
- // -------------
876
-
877
- // Creating a Backbone.View creates its initial element outside of the DOM,
878
- // if an existing element is not provided...
879
- Backbone.View = function(options) {
880
- this.cid = _.uniqueId('view');
881
- this._configure(options || {});
882
- this._ensureElement();
883
- this.delegateEvents();
884
- this.initialize.apply(this, arguments);
885
- };
886
-
887
- // Element lookup, scoped to DOM elements within the current view.
888
- // This should be prefered to global lookups, if you're dealing with
889
- // a specific view.
890
- var selectorDelegate = function(selector) {
891
- return $(selector, this.el);
892
- };
893
-
894
- // Cached regex to split keys for `delegate`.
895
- var eventSplitter = /^(\S+)\s*(.*)$/;
896
-
897
- // List of view options to be merged as properties.
898
- var viewOptions = ['model', 'collection', 'el', 'id', 'attributes', 'className', 'tagName'];
899
-
900
- // Set up all inheritable **Backbone.View** properties and methods.
901
- _.extend(Backbone.View.prototype, Backbone.Events, {
902
-
903
- // The default `tagName` of a View's element is `"div"`.
904
- tagName : 'div',
905
-
906
- // Attach the `selectorDelegate` function as the `$` property.
907
- $ : selectorDelegate,
908
-
909
- // Initialize is an empty function by default. Override it with your own
910
- // initialization logic.
911
- initialize : function(){},
912
-
913
- // **render** is the core function that your view should override, in order
914
- // to populate its element (`this.el`), with the appropriate HTML. The
915
- // convention is for **render** to always return `this`.
916
- render : function() {
917
- return this;
918
- },
919
-
920
- // Remove this view from the DOM. Note that the view isn't present in the
921
- // DOM by default, so calling this method may be a no-op.
922
- remove : function() {
923
- $(this.el).remove();
924
- return this;
925
- },
926
-
927
- // For small amounts of DOM Elements, where a full-blown template isn't
928
- // needed, use **make** to manufacture elements, one at a time.
929
- //
930
- // var el = this.make('li', {'class': 'row'}, this.model.escape('title'));
1459
+ // Save a fragment into the hash history, or replace the URL state if the
1460
+ // 'replace' option is passed. You are responsible for properly URL-encoding
1461
+ // the fragment in advance.
931
1462
  //
932
- make : function(tagName, attributes, content) {
933
- var el = document.createElement(tagName);
934
- if (attributes) $(el).attr(attributes);
935
- if (content) $(el).html(content);
936
- return el;
937
- },
1463
+ // The options object can contain `trigger: true` if you wish to have the
1464
+ // route callback be fired (not usually desirable), or `replace: true`, if
1465
+ // you wish to modify the current URL without adding an entry to the history.
1466
+ navigate: function(fragment, options) {
1467
+ if (!History.started) return false;
1468
+ if (!options || options === true) options = {trigger: options};
1469
+ fragment = this.getFragment(fragment || '');
1470
+ if (this.fragment === fragment) return;
1471
+ this.fragment = fragment;
1472
+ var url = this.root + fragment;
938
1473
 
939
- // Set callbacks, where `this.callbacks` is a hash of
940
- //
941
- // *{"event selector": "callback"}*
942
- //
943
- // {
944
- // 'mousedown .title': 'edit',
945
- // 'click .button': 'save'
946
- // }
947
- //
948
- // pairs. Callbacks will be bound to the view, with `this` set properly.
949
- // Uses event delegation for efficiency.
950
- // Omitting the selector binds the event to `this.el`.
951
- // This only works for delegate-able events: not `focus`, `blur`, and
952
- // not `change`, `submit`, and `reset` in Internet Explorer.
953
- delegateEvents : function(events) {
954
- if (!(events || (events = this.events))) return;
955
- if (_.isFunction(events)) events = events.call(this);
956
- $(this.el).unbind('.delegateEvents' + this.cid);
957
- for (var key in events) {
958
- var method = this[events[key]];
959
- if (!method) throw new Error('Event "' + events[key] + '" does not exist');
960
- var match = key.match(eventSplitter);
961
- var eventName = match[1], selector = match[2];
962
- method = _.bind(method, this);
963
- eventName += '.delegateEvents' + this.cid;
964
- if (selector === '') {
965
- $(this.el).bind(eventName, method);
966
- } else {
967
- $(this.el).delegate(selector, eventName, method);
1474
+ // If pushState is available, we use it to set the fragment as a real URL.
1475
+ if (this._hasPushState) {
1476
+ this.history[options.replace ? 'replaceState' : 'pushState']({}, document.title, url);
1477
+
1478
+ // If hash changes haven't been explicitly disabled, update the hash
1479
+ // fragment to store history.
1480
+ } else if (this._wantsHashChange) {
1481
+ this._updateHash(this.location, fragment, options.replace);
1482
+ if (this.iframe && (fragment !== this.getFragment(this.getHash(this.iframe)))) {
1483
+ // Opening and closing the iframe tricks IE7 and earlier to push a
1484
+ // history entry on hash-tag change. When replace is true, we don't
1485
+ // want this.
1486
+ if(!options.replace) this.iframe.document.open().close();
1487
+ this._updateHash(this.iframe.location, fragment, options.replace);
968
1488
  }
969
- }
970
- },
971
1489
 
972
- // Performs the initial configuration of a View with a set of options.
973
- // Keys with special meaning *(model, collection, id, className)*, are
974
- // attached directly to the view.
975
- _configure : function(options) {
976
- if (this.options) options = _.extend({}, this.options, options);
977
- for (var i = 0, l = viewOptions.length; i < l; i++) {
978
- var attr = viewOptions[i];
979
- if (options[attr]) this[attr] = options[attr];
1490
+ // If you've told us that you explicitly don't want fallback hashchange-
1491
+ // based history, then `navigate` becomes a page refresh.
1492
+ } else {
1493
+ return this.location.assign(url);
980
1494
  }
981
- this.options = options;
1495
+ if (options.trigger) this.loadUrl(fragment);
982
1496
  },
983
1497
 
984
- // Ensure that the View has a DOM element to render into.
985
- // If `this.el` is a string, pass it through `$()`, take the first
986
- // matching element, and re-assign it to `el`. Otherwise, create
987
- // an element from the `id`, `className` and `tagName` proeprties.
988
- _ensureElement : function() {
989
- if (!this.el) {
990
- var attrs = this.attributes || {};
991
- if (this.id) attrs.id = this.id;
992
- if (this.className) attrs['class'] = this.className;
993
- this.el = this.make(this.tagName, attrs);
994
- } else if (_.isString(this.el)) {
995
- this.el = $(this.el).get(0);
1498
+ // Update the hash location, either replacing the current entry, or adding
1499
+ // a new one to the browser history.
1500
+ _updateHash: function(location, fragment, replace) {
1501
+ if (replace) {
1502
+ var href = location.href.replace(/(javascript:|#).*$/, '');
1503
+ location.replace(href + '#' + fragment);
1504
+ } else {
1505
+ // Some browsers require that `hash` contains a leading #.
1506
+ location.hash = '#' + fragment;
996
1507
  }
997
1508
  }
998
1509
 
999
1510
  });
1000
1511
 
1001
- // The self-propagating extend function that Backbone classes use.
1002
- var extend = function (protoProps, classProps) {
1003
- var child = inherits(this, protoProps, classProps);
1004
- child.extend = this.extend;
1005
- return child;
1006
- };
1007
-
1008
- // Set up inheritance for the model, collection, and view.
1009
- Backbone.Model.extend = Backbone.Collection.extend =
1010
- Backbone.Router.extend = Backbone.View.extend = extend;
1011
-
1012
- // Map from CRUD to HTTP for our default `Backbone.sync` implementation.
1013
- var methodMap = {
1014
- 'create': 'POST',
1015
- 'update': 'PUT',
1016
- 'delete': 'DELETE',
1017
- 'read' : 'GET'
1018
- };
1019
-
1020
- // Backbone.sync
1021
- // -------------
1022
-
1023
- // Override this function to change the manner in which Backbone persists
1024
- // models to the server. You will be passed the type of request, and the
1025
- // model in question. By default, uses makes a RESTful Ajax request
1026
- // to the model's `url()`. Some possible customizations could be:
1027
- //
1028
- // * Use `setTimeout` to batch rapid-fire updates into a single request.
1029
- // * Send up the models as XML instead of JSON.
1030
- // * Persist models via WebSockets instead of Ajax.
1031
- //
1032
- // Turn on `Backbone.emulateHTTP` in order to send `PUT` and `DELETE` requests
1033
- // as `POST`, with a `_method` parameter containing the true HTTP method,
1034
- // as well as all requests with the body as `application/x-www-form-urlencoded` instead of
1035
- // `application/json` with the model in a param named `model`.
1036
- // Useful when interfacing with server-side languages like **PHP** that make
1037
- // it difficult to read the body of `PUT` requests.
1038
- Backbone.sync = function(method, model, options) {
1039
- var type = methodMap[method];
1040
-
1041
- // Default JSON-request options.
1042
- var params = _.extend({
1043
- type: type,
1044
- dataType: 'json'
1045
- }, options);
1046
-
1047
- // Ensure that we have a URL.
1048
- if (!params.url) {
1049
- params.url = getUrl(model) || urlError();
1050
- }
1051
-
1052
- // Ensure that we have the appropriate request data.
1053
- if (!params.data && model && (method == 'create' || method == 'update')) {
1054
- params.contentType = 'application/json';
1055
- params.data = JSON.stringify(model.toJSON());
1056
- }
1057
-
1058
- // For older servers, emulate JSON by encoding the request into an HTML-form.
1059
- if (Backbone.emulateJSON) {
1060
- params.contentType = 'application/x-www-form-urlencoded';
1061
- params.data = params.data ? {model : params.data} : {};
1062
- }
1063
-
1064
- // For older servers, emulate HTTP by mimicking the HTTP method with `_method`
1065
- // And an `X-HTTP-Method-Override` header.
1066
- if (Backbone.emulateHTTP) {
1067
- if (type === 'PUT' || type === 'DELETE') {
1068
- if (Backbone.emulateJSON) params.data._method = type;
1069
- params.type = 'POST';
1070
- params.beforeSend = function(xhr) {
1071
- xhr.setRequestHeader('X-HTTP-Method-Override', type);
1072
- };
1073
- }
1074
- }
1075
-
1076
- // Don't process data on a non-GET request.
1077
- if (params.type !== 'GET' && !Backbone.emulateJSON) {
1078
- params.processData = false;
1079
- }
1080
-
1081
- // Make the request.
1082
- return $.ajax(params);
1083
- };
1512
+ // Create the default Backbone.history.
1513
+ Backbone.history = new History;
1084
1514
 
1085
1515
  // Helpers
1086
1516
  // -------
1087
1517
 
1088
- // Shared empty constructor function to aid in prototype-chain creation.
1089
- var ctor = function(){};
1090
-
1091
1518
  // Helper function to correctly set up the prototype chain, for subclasses.
1092
1519
  // Similar to `goog.inherits`, but uses a hash of prototype properties and
1093
1520
  // class properties to be extended.
1094
- var inherits = function(parent, protoProps, staticProps) {
1521
+ var extend = function(protoProps, staticProps) {
1522
+ var parent = this;
1095
1523
  var child;
1096
1524
 
1097
1525
  // The constructor function for the new subclass is either defined by you
1098
1526
  // (the "constructor" property in your `extend` definition), or defaulted
1099
- // by us to simply call `super()`.
1100
- if (protoProps && protoProps.hasOwnProperty('constructor')) {
1527
+ // by us to simply call the parent's constructor.
1528
+ if (protoProps && _.has(protoProps, 'constructor')) {
1101
1529
  child = protoProps.constructor;
1102
1530
  } else {
1103
1531
  child = function(){ return parent.apply(this, arguments); };
1104
1532
  }
1105
1533
 
1106
- // Inherit class (static) properties from parent.
1107
- _.extend(child, parent);
1534
+ // Add static properties to the constructor function, if supplied.
1535
+ _.extend(child, parent, staticProps);
1108
1536
 
1109
1537
  // Set the prototype chain to inherit from `parent`, without calling
1110
1538
  // `parent`'s constructor function.
1111
- ctor.prototype = parent.prototype;
1112
- child.prototype = new ctor();
1539
+ var Surrogate = function(){ this.constructor = child; };
1540
+ Surrogate.prototype = parent.prototype;
1541
+ child.prototype = new Surrogate;
1113
1542
 
1114
1543
  // Add prototype properties (instance properties) to the subclass,
1115
1544
  // if supplied.
1116
1545
  if (protoProps) _.extend(child.prototype, protoProps);
1117
1546
 
1118
- // Add static properties to the constructor function, if supplied.
1119
- if (staticProps) _.extend(child, staticProps);
1120
-
1121
- // Correctly set child's `prototype.constructor`.
1122
- child.prototype.constructor = child;
1123
-
1124
- // Set a convenience property in case the parent's prototype is needed later.
1547
+ // Set a convenience property in case the parent's prototype is needed
1548
+ // later.
1125
1549
  child.__super__ = parent.prototype;
1126
1550
 
1127
1551
  return child;
1128
1552
  };
1129
1553
 
1130
- // Helper function to get a URL from a Model or Collection as a property
1131
- // or as a function.
1132
- var getUrl = function(object) {
1133
- if (!(object && object.url)) return null;
1134
- return _.isFunction(object.url) ? object.url() : object.url;
1135
- };
1554
+ // Set up inheritance for the model, collection, router, view and history.
1555
+ Model.extend = Collection.extend = Router.extend = View.extend = History.extend = extend;
1136
1556
 
1137
1557
  // Throw an error when a URL is needed, and none is supplied.
1138
1558
  var urlError = function() {
@@ -1140,19 +1560,12 @@
1140
1560
  };
1141
1561
 
1142
1562
  // Wrap an optional error callback with a fallback error event.
1143
- var wrapError = function(onError, model, options) {
1144
- return function(resp) {
1145
- if (onError) {
1146
- onError(model, resp, options);
1147
- } else {
1148
- model.trigger('error', model, resp, options);
1149
- }
1563
+ var wrapError = function (model, options) {
1564
+ var error = options.error;
1565
+ options.error = function(resp) {
1566
+ if (error) error(model, resp, options);
1567
+ model.trigger('error', model, resp, options);
1150
1568
  };
1151
1569
  };
1152
1570
 
1153
- // Helper function to escape a string for HTML rendering.
1154
- var escapeHTML = function(string) {
1155
- return string.replace(/&(?!\w+;|#\d+;|#x[\da-f]+;)/gi, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#x27;').replace(/\//g,'&#x2F;');
1156
- };
1157
-
1158
1571
  }).call(this);