diff --git a/htdocs/css/problemsetlist.css b/htdocs/css/problemsetlist.css index 25a53e4c4..3caa7a1a8 100644 --- a/htdocs/css/problemsetlist.css +++ b/htdocs/css/problemsetlist.css @@ -48,8 +48,8 @@ label.checklist {display: inline; margin-left: 8px;} .hw-assigned {color: blue;} -#probSetList {margin:0;} - +#probSetList {margin:0} +.prob-set-container {overflow-y: scroll;} .prob-value {width: 20px;} .loading {background-color: orange;} diff --git a/htdocs/html-templates/homework-manager.html b/htdocs/html-templates/homework-manager.html index f71494ebe..731adc950 100644 --- a/htdocs/html-templates/homework-manager.html +++ b/htdocs/html-templates/homework-manager.html @@ -106,9 +106,14 @@

Help for the Homework Manager

+ + + + + - diff --git a/htdocs/js/apps/HomeworkManager/HWDetailView.js b/htdocs/js/apps/HomeworkManager/HWDetailView.js index dd709c3ad..d48fed57e 100644 --- a/htdocs/js/apps/HomeworkManager/HWDetailView.js +++ b/htdocs/js/apps/HomeworkManager/HWDetailView.js @@ -12,21 +12,62 @@ define(['Backbone', '../../lib/webwork/views/EditableCell', '../../lib/webwork/views/ProblemListView', '../../lib/webwork/models/ProblemList', - '../../lib/webwork/views/UserListView','config'], + '../../lib/webwork/views/UserListView','config','bootstrap'], function(Backbone, _,EditableCell,ProblemListView,ProblemList,UserListView,config){ var HWDetailView = Backbone.View.extend({ className: "set-detail-view", tagName: "div", initialize: function () { - _.bindAll(this,'render','changeHWSet','renderProblems','updateNumProblems'); + _.bindAll(this,'render','changeHWSet','updateNumProblems'); this.parent = this.options.parent; - this.dispatcher = _.clone(Backbone.Events); - this.render(); + this.problemsView = new ProblemsView({parent: this}); + this.usersAssignedView = new AssignUsersView({parent: this}); + this.propertiesView = new PropertySetDetailView({parent: this}); + this.customizeUserAssignView = new CustomizeUserAssignView({parent: this}); + + }, + render: function () { + var self = this; + + // all of the details of a problem set are in tabs. + // problems : #list-of-problems + // properties: #property-tab + // Assign to Users: #user-assign-tab + // customize set to users: #user-customize-tab + // + // render the set only when it is visible. + + this.$el.html(_.template($("#HW-detail-template").html())); + // activate the tabs + this.problemsView = new ProblemsView({parent: this, el: $("#problem-list-tab")}); + this.usersAssignedView = new AssignUsersView({parent: this, el: $("#user-assign-tab")}); + this.propertiesView = new PropertySetDetailView({parent: this, el: $("#property-tab")}); + this.customizeUserAssignView = new CustomizeUserAssignView({parent: this, el: $("#user-customize-tab")}); + + $('#problem-set-tabs a').click(function (evt) { + evt.preventDefault(); + $(this).tab('show'); + }); + + $('a[href="#property-tab"]').on('shown', function (evt) { + self.propertiesView.render(); + }); + $('a[href="#user-assign-tab"]').on('shown', function (evt) { + self.usersAssignedView.render(); + }); + + $('a[href="#user-customize-tab"]').on('shown', function (evt) { + self.customizeUserAssignView.render(); + }); + + + return this; + }, changeHWSet: function (setName) { var self = this; - $("#view-header-list div[data-view='problem-set']").html("Problem Set Details for " + setName); + $("#view-header-list div[data-view='problem-set']").html("Problem Set Details for " + setName) $("#problem-set-tabs a:first").tab("show"); // shows the problems @@ -36,22 +77,15 @@ define(['Backbone', if(this.model.problems){ console.log("changing the HW Set to " + setName); - this.renderProblems(); + this.problemsView.render(); this.model.problems.on("add",function (){ console.log("Added a Problem"); self.parent.announce.addMessage("Problem Added to set: " + self.model.get("set_id")); }); - self.propertyView = new HWPropertiesView({el: $("#property-tab"), model: this.model}); - self.usersAssignedView = new AssignUsersView({users: self.parent.users, model: self.model}); - self.customizeUserAssignView = new CustomizeUserAssignView({users: self.parent.users, model: self.model}); - $("#num-users-assigned").html(length + " of " + self.parent.users.length); - $("#user-assign-tab").html(self.usersAssignedView.el); - $("#user-customize-tab").html(self.customizeUserAssignView.el); - // This sets messages this.model.problems.on("deleteProblem",function (setName,place) { - var str = "Problem #" + (place +1) + " Deleted from set: " + setName + "
" + var str = "Problem #" + (place +1) + " deleted from set: " + setName + "
" + "To undo this, click the Undo button above the problem list. "; self.parent.announce.addMessage(str); }); @@ -69,45 +103,15 @@ define(['Backbone', console.log(self.model.assignedUsers); self.usersAssignedView.updateUserList(); }); + + this.model.problems.on("num-problems-shown", self.updateNumProblems); } else { this.model.problems = new ProblemList({type: "Problem Set", setName: setName}); this.model.problems.on("fetchSuccess",function() {self.changeHWSet(setName)}); } - this.dispatcher.off("num-problems-shown"); - this.dispatcher.on("num-problems-shown", self.updateNumProblems); - }, - render: function () { - var self = this; - this.$el.html(_.template($("#HW-detail-template").html())); - // activate the tabs - $('#problem-set-tabs a').click(function (evt) { - evt.preventDefault(); - - switch($(evt.target).attr("href")){ - case "#user-assign-tab": - self.usersAssignedView.render(); - break; - case "#user-customize-tab": - self.customizeUserAssignView.render(); - break; - } - - - $(this).tab('show'); - }); - - return this; - - }, - renderProblems: function (){ - console.log("showing the problems for problem set " + this.model.get("set_id")); - $("#prob-tab").html(_.template($("#problem-set-header").html(),{set: this.model.get("set_id")})); - var plv = new ProblemListView({el: this.$("#list-of-problems"), parent: this, collection: this.model.problems, - reorderable: true, deletable: true, draggable: false, showPoints: true}); - plv.render(); }, updateNumProblems: function () { console.log("firing num-problems-shown"); @@ -116,26 +120,33 @@ define(['Backbone', } }); - var HWPropertiesView = Backbone.View.extend({ + var ProblemsView = Backbone.View.extend({ initialize: function () { _.bindAll(this,'render'); - _.extend(this,this.options); - this.render(); + this.parent = this.options.parent; }, render: function () { - // Update the HW Properties Tab - - console.log("in HWPropertiesView render"); + console.log("showing the problems for problem set " + this.parent.model.get("set_id")); + $("#prob-tab").html(_.template($("#problem-set-header").html(),{set: this.parent.model.get("set_id")})); + var plv = new ProblemListView({el: this.el, parent: this, collection: this.parent.model.problems, + reorderable: true, deletable: true, draggable: false, showPoints: true}); + plv.render(); + } + }); + var PropertySetDetailView = Backbone.View.extend({ + initialize: function () { + _.bindAll(this,'render'); + this.parent = this.options.parent; + }, + render: function () { + console.log(this.parent.model); this.$el.html(_.template($("#hwset-dates-tmpl").html())); - - - this.$(".due-date-row").append( (new EditableCell({model : this.model, type: "datetime", property: "open_date"})).render().el); - this.$(".due-date-row").append( (new EditableCell({model : this.model, type: "datetime", property: "due_date"})).render().el); - this.$(".due-date-row").append( (new EditableCell({model : this.model, type: "datetime", property: "answer_date"})).render().el); - - this.$(".hwset-visible").html((new EditableCell({model: this.model, property: "visible"})).render().el); - this.$(".reduced-credit").html((new EditableCell({model: this.model, property: "enable_reduced_scoring"})).render().el); + this.$(".due-date-row").append( (new EditableCell({model : this.parent.model, type: "datetime", property: "open_date"})).render().el); + this.$(".due-date-row").append( (new EditableCell({model : this.parent.model, type: "datetime", property: "due_date"})).render().el); + this.$(".due-date-row").append( (new EditableCell({model : this.parent.model, type: "datetime", property: "answer_date"})).render().el); + this.$(".hwset-visible").html((new EditableCell({model: this.parent.model, property: "visible"})).render().el); + this.$(".reduced-credit").html((new EditableCell({model: this.parent.model, property: "enable_reduced_scoring"})).render().el); } }); @@ -144,13 +155,13 @@ define(['Backbone', tagName: "div", initialize: function () { _.bindAll(this,'render','selectAll','assignToSelected','updateUserList'); - _.extend(this,this.options); + this.parent = this.options.parent; }, render: function () { var self = this; this.$el.html($("#users-assigned-tmpl").html()); - var allUsers = this.users.sortBy(function(_user) { return _user.get("last_name");}); + var allUsers = this.parent.parent.users.sortBy(function(_user) { return _user.get("last_name");}); this.usersListView = new UserListView({users: allUsers, checked: false, el: this.$("#users-assigned-row")}); this.updateUserList(); @@ -161,8 +172,8 @@ define(['Backbone', "click #classlist-select-all": "selectAll"}, updateUserList: function () { this.usersListView.render(); - this.usersListView.highlightUsers(this.model.assignedUsers); - this.usersListView.disableCheckboxForUsers(this.model.assignedUsers); + this.usersListView.highlightUsers(this.parent.model.assignedUsers); + this.usersListView.disableCheckboxForUsers(this.parent.model.assignedUsers); }, assignToSelected: function () { @@ -170,12 +181,12 @@ define(['Backbone', console.log(selectedUsers) console.log("assigning to selected users"); - this.model.assignToUsers(_.difference(selectedUsers,this.model.assignedUsers)); - this.model.assignedUsers = selectedUsers; + this.parent.model.assignToUsers(_.difference(selectedUsers,this.parent.model.assignedUsers)); + this.parent.model.assignedUsers = selectedUsers; }, selectAll: function (){ this.$(".classlist-li").attr("checked",this.$("#classlist-select-all").attr("checked")==="checked"); - _(this.model.assignedUsers).each(function(_user){ + _(this.parent.model.assignedUsers).each(function(_user){ self.$(".classlist-li[data-username='"+ _user + "']").prop("checked",true); }); } @@ -186,8 +197,7 @@ define(['Backbone', tagName: "div", initialize: function () { _.bindAll(this,'render','selectAll','customizeSelected','unassignUsers'); - _.extend(this,this.options); - this.render(); + this.parent = this.options.parent; }, @@ -217,10 +227,6 @@ define(['Backbone', }, selectAll: function (){ this.usersListView.checkAll(this.$("#custom-select-all").prop("checked")); -/* this.$(".classlist-li").attr("checked",); - _(this.assignedUsers).each(function(_user){ - self.$(".classlist-li[data-username='"+ _user + "']").prop("checked",true); - });*/ }, unassignUsers: function(){ var users = this.usersListView.getSelectedUsers(); diff --git a/htdocs/js/apps/HomeworkManager/HomeworkManager.js b/htdocs/js/apps/HomeworkManager/HomeworkManager.js index 70142c327..0e91629a7 100644 --- a/htdocs/js/apps/HomeworkManager/HomeworkManager.js +++ b/htdocs/js/apps/HomeworkManager/HomeworkManager.js @@ -5,7 +5,7 @@ require.config({ paths: { - "Backbone": "/webwork2_files/js/lib/vendor/backbone-0.9.9", + "Backbone": "/webwork2_files/js/lib/vendor/backbone", "backbone-validation": "/webwork2_files/js/lib/vendor/backbone-validation", "jquery-ui": "/webwork2_files/js/lib/vendor/jquery-ui", "underscore": "/webwork2_files/js/lib/vendor/underscore/underscore", @@ -63,13 +63,16 @@ function(Backbone, _, UserList, ProblemSetList, Settings, CalendarView, HWDetai tagName: "div", initialize: function(){ this.constructor.__super__.initialize.apply(this, {el: this.el}); - _.bindAll(this, 'render','postHWLoaded','setDropToEdit','setupMessages'); // include all functions that need the this object + _.bindAll(this, 'render','postHWLoaded','setDropToEdit','setupMessages','postSettingsFetched', + 'postProblemSetsFetched',"showHWdetails"); // include all functions that need the this object var self = this; this.dispatcher = _.clone(Backbone.Events); this.settings = new Settings(); // need to get other settings from the server. - this.problemSets = new ProblemSetList({type: "Instructor"}); this.settings.fetch(); + this.settings.on("fetchSuccess",this.postSettingsFetched); + this.problemSets = new ProblemSetList({type: "Instructor"}); + this.preloading(); /* There's a lot of things that need to be loaded as the App starts: @@ -83,38 +86,8 @@ function(Backbone, _, UserList, ProblemSetList, Settings, CalendarView, HWDetai */ - this.settings.on("fetchSuccess", function (data){ - self.render(); - self.problemSets.fetch(); - config.timezone = self.settings.find(function(v) { return v.get("var")==="timezone"}).get("value"); - self.HWSettingsView.render(); - }); - this.dispatcher.on("calendar-change", self.setDropToEdit); - - this.setupMessages(); - - this.problemSets.on("fetchSuccess",function() { - var setsLoaded = []; - $("#progressbar").progressbar({max: self.problemSets.size()}); - self.problemSets.each(function(_set,i){ - setsLoaded.push({set: _set.get("set_id"), loaded: false, pos: i}); - _set.getAssignedUsers(); - _set.on("usersLoaded", function(set){ - - console.log("users Loaded for set " + set.get("set_id")); - var foundSet = _(setsLoaded).find(function(obj){ return obj["set"]===set.get("set_id")}); - setsLoaded[foundSet.pos].loaded = true; - $("#progressbar").progressbar( - {value: _(_(setsLoaded).pluck("loaded")).countBy(function(el) { return el===true;}).true}); - if(_(_(setsLoaded).pluck("loaded")).all()) {self.postHWLoaded();} - }); - }); - self.probSetListView.render(); - }); - - this.users = new UserList(); this.users.fetch(); this.users.on("fetchSuccess", function (data){ console.log("users loaded");}); @@ -122,6 +95,62 @@ function(Backbone, _, UserList, ProblemSetList, Settings, CalendarView, HWDetai }, preloading: function() { + }, + postSettingsFetched: function (collection, response, options){ + this.render(); + this.problemSets.fetch(); + this.problemSets.on("fetchSuccess",this.postProblemSetsFetched); + config.timezone = this.settings.find(function(v) { return v.get("var")==="timezone"}).get("value"); + this.HWSettingsView.render(); + }, + postProblemSetsFetched: function (data){ + var self=this; + var setsLoaded = []; + $("#progressbar").progressbar({max: this.problemSets.size()}); + this.problemSets.each(function(_set,i){ + setsLoaded.push({set: _set.get("set_id"), loaded: false, pos: i}); + _set.getAssignedUsers(); + _set.on("usersLoaded", function(set){ + + console.log("users Loaded for set " + set.get("set_id")); + var foundSet = _(setsLoaded).find(function(obj){ return obj["set"]===set.get("set_id")}); + setsLoaded[foundSet.pos].loaded = true; + $("#progressbar").progressbar( + {value: _(_(setsLoaded).pluck("loaded")).countBy(function(el) { return el===true;}).true}); + if(_(_(setsLoaded).pluck("loaded")).all()) {self.postHWLoaded();} + }); + }); + this.problemSets.on("problem-set-added", function (set){ + this.probSetListView.render(); + }); + + // set up messages associated with problem Sets. + this.setupMessages(); + + + this.problemSets.on("rendered",function(){ + console.log("after rendering"); + // This allows the Problem Sets (in the left column) to accept problems to add a problem to a set. + $(".problem-set").droppable({ + hoverClass: "btn-info", + accept: ".problem", + tolerance: "pointer", + drop: function( event, ui ) { + console.log("Adding a Problem to HW set " + $(event.target).data("setname")); + console.log($(ui.draggable).data("path")); + var source = $(ui.draggable).data("source"); + console.log(source); + var set = self.problemSets.find(function (set) { return set.get("set_id")===""+$(event.target).data("setname");}); + var prob = self[source].problemList.find(function(prob) { return prob.get("path")===$(ui.draggable).data("path");}) + set.addProblem(prob); + } + }); + // When the HW sets are clicked, open the HW details tab. + $(".problem-set").on('click', self.showHWdetails); + + }); + + this.probSetListView.render(); }, render: function(){ this.constructor.__super__.render.apply(this); // Call WebPage.render(); @@ -149,7 +178,12 @@ function(Backbone, _, UserList, ProblemSetList, Settings, CalendarView, HWDetai this.assignUsersView = new AssignUsersView({el: $("#assign-users"), id: "view-assign-users", parent: this}); this.HWSettingsView = new HWSettingsView({parent: self, el: $("#settings-table")}); - + }, + showHWdetails: function(evt){ + if (this.objectDragging) return; + this.changeView("problem-set"); + this.HWDetails.render(); + this.HWDetails.changeHWSet($(evt.target).data("setname")); }, changeView: function (linkname){ $(".view-header").removeClass("active"); @@ -157,40 +191,14 @@ function(Backbone, _, UserList, ProblemSetList, Settings, CalendarView, HWDetai $(".view-pane").removeClass("active"); $("#"+linkname).addClass("active"); }, - addHWSet: function(_set){ + /*addHWSet: function(_set){ var self = this; // Allow problems to be dropped onto homework sets console.log("in addHWSet"); - // This allows the Problem Sets (in the left column) to accept problems to add a problem to a set. - - $(".problem-set").droppable({ - hoverClass: "btn-info", - accept: ".problem", - tolerance: "pointer", - drop: function( event, ui ) { - console.log("Adding a Problem to HW set " + $(event.target).data("setname")); - console.log($(ui.draggable).data("path")); - var source = $(ui.draggable).data("source"); - console.log(source); - var set = self.problemSets.find(function (set) { return set.get("set_id")===""+$(event.target).data("setname");}); - var prob = self[source].problemList.find(function(prob) { return prob.get("path")===$(ui.draggable).data("path");}) - set.addProblem(prob); - } - }); - - // When the HW sets are clicked, open the HW details tab. - - $(".problem-set").on('click', function(evt) { - if (self.objectDragging) return; - self.changeView("problem-set"); - self.HWDetails.changeHWSet($(evt.target).data("setname")); - - }); - if (_set) {self.setListView.addSet(_set)}; - }, + }, */ setupMessages: function () { var self = this; @@ -202,15 +210,12 @@ function(Backbone, _, UserList, ProblemSetList, Settings, CalendarView, HWDetai self.setDropToEdit(); var keys = _.keys(_set.changed); _(keys).each(function(key) { - self.announce.addMessage("The value of " + key + " in problem set " + _set.get("set_id") + " has changed to " + _set.changed[key]+ "
"); + self.announce.addMessage("The value of " + key + " in problem set " + _set.get("set_id") + " has changed to " + _set.changed[key]); }) }); - this.dispatcher.on("problem-set-added", function (set){ - console.log("this.dispatcher"); + this.problemSets.on("problem-set-added", function (set){ self.announce.addMessage("The HW set with name " + set.get("set_id") + " was created."); - self.addHWSet(set); // update all other parts of the part with the new set. - }); this.problemSets.on("problem-set-deleted",function(set){ @@ -222,22 +227,19 @@ function(Backbone, _, UserList, ProblemSetList, Settings, CalendarView, HWDetai { var self = this; - this.addHWSet(); + // this.addHWSet(); self.calendarView = new CalendarView({el: $("#calendar"), parent: this, collection: this.problemSets, view: "instructor"}); self.setDropToEdit(); - // Set the popover on the set name $("span.pop").popover({title: "Homework Set Details", placement: "top", offset: 10}); - - + // Create the HW details pane. - - $("#details").html(_.template($("#HW-detail-template").html())); + // $("#details").html(_.template($("#HW-detail-template").html())); this.assignUsersView.initializeModel(); this.assignUsersView.render(); @@ -258,6 +260,7 @@ function(Backbone, _, UserList, ProblemSetList, Settings, CalendarView, HWDetai accept: ".problem-set", greedy: true, drop: function(ev,ui) { + ev.stopPropagation(); var setName = $(ui.draggable).data("setname"); var timeAssignDue = self.settings.getSettingValue("pg{timeAssignDue}"); var theDueDate = /date-(\d{4})-(\d\d)-(\d\d)/.exec($(this).attr("id")); @@ -272,11 +275,10 @@ function(Backbone, _, UserList, ProblemSetList, Settings, CalendarView, HWDetai var _answerDate = new XDate(wwDueDate); _answerDate.addMinutes(answerAfterDueDate); var tz = config.timezone; - var wwOpenDate = _openDate.toString("MM/dd/yyyy") + " at " + _openDate.toString("hh:mmtt")+ " " + tz[1]; - var wwAnswerDate = _answerDate.toString("MM/dd/yyyy") + " at " + _answerDate.toString("hh:mmtt") + " " + tz[1]; + var wwOpenDate = _openDate.toString("MM/dd/yyyy") + " at " + _openDate.toString("hh:mmtt")+ " " + tz; + var wwAnswerDate = _answerDate.toString("MM/dd/yyyy") + " at " + _answerDate.toString("hh:mmtt") + " " + tz; HWset.set({due_date:wwDueDate, open_date: wwOpenDate, answer_date: wwAnswerDate}); - ev.stopPropagation(); }, }); @@ -308,32 +310,6 @@ var HWSettingsView = WWSettingsView.extend({ } }); - - -// The following is probably not needed. - -/* -var HWProblemView = Backbone.View.extend({ - className: "set-detail-problem-view", - tagName: "div", - - initialize: function () { - _.bindAll(this,"render"); - var self = this; - this.render(); - this.model.on('rendered', function () { - self.$el.html(self.model.get("data")); - }) - }, - render: function () { - this.$el.html(this.model.get("path")); - this.model.render(); - } - - -}); */ - - var App = new HomeworkEditorView({el: $("div#mainDiv")}); }); diff --git a/htdocs/js/lib/vendor/backbone.js b/htdocs/js/lib/vendor/backbone.js index 3373c952b..9682be585 100644 --- a/htdocs/js/lib/vendor/backbone.js +++ b/htdocs/js/lib/vendor/backbone.js @@ -1,4 +1,4 @@ -// Backbone.js 0.9.2 +// Backbone.js 0.9.10 // (c) 2010-2012 Jeremy Ashkenas, DocumentCloud Inc. // Backbone may be freely distributed under the MIT license. @@ -10,7 +10,7 @@ // Initial Setup // ------------- - // Save a reference to the global object (`window` in the browser, `global` + // Save a reference to the global object (`window` in the browser, `exports` // on the server). var root = this; @@ -18,9 +18,11 @@ // restored later on, if `noConflict` is used. var previousBackbone = root.Backbone; - // Create a local reference to slice/splice. - var slice = Array.prototype.slice; - var splice = Array.prototype.splice; + // Create a local reference to array methods. + var array = []; + var push = array.push; + var slice = array.slice; + var splice = array.splice; // The top-level namespace. All public Backbone classes and modules will // be attached to this. Exported for both CommonJS and the browser. @@ -32,23 +34,14 @@ } // Current version of the library. Keep in sync with `package.json`. - Backbone.VERSION = '0.9.2'; + Backbone.VERSION = '0.9.10'; // Require Underscore, if we're on the server, and it's not already present. var _ = root._; if (!_ && (typeof require !== 'undefined')) _ = require('underscore'); // For Backbone's purposes, jQuery, Zepto, or Ender owns the `$` variable. - var $ = root.jQuery || root.Zepto || root.ender; - - // Set the JavaScript library that will be used for DOM manipulation and - // Ajax calls (a.k.a. the `$` variable). By default Backbone will use: jQuery, - // Zepto, or Ender; but the `setDomLibrary()` method lets you inject an - // alternate JavaScript library (or a mock library for testing your views - // outside of a browser). - Backbone.setDomLibrary = function(lib) { - $ = lib; - }; + Backbone.$ = root.jQuery || root.Zepto || root.ender; // Runs Backbone.js in *noConflict* mode, returning the `Backbone` variable // to its previous owner. Returns a reference to this Backbone object. @@ -69,14 +62,51 @@ Backbone.emulateJSON = false; // Backbone.Events - // ----------------- + // --------------- - // Regular expression used to split event strings + // Regular expression used to split event strings. var eventSplitter = /\s+/; + // Implement fancy features of the Events API such as multiple event + // names `"change blur"` and jQuery-style event maps `{change: action}` + // in terms of the existing API. + var eventsApi = function(obj, action, name, rest) { + if (!name) return true; + if (typeof name === 'object') { + for (var key in name) { + obj[action].apply(obj, [key, name[key]].concat(rest)); + } + } else if (eventSplitter.test(name)) { + var names = name.split(eventSplitter); + for (var i = 0, l = names.length; i < l; i++) { + obj[action].apply(obj, [names[i]].concat(rest)); + } + } else { + return true; + } + }; + + // Optimized internal dispatch function for triggering events. Tries to + // keep the usual cases speedy (most Backbone events have 3 arguments). + var triggerEvents = function(events, args) { + var ev, i = -1, l = events.length; + switch (args.length) { + case 0: while (++i < l) (ev = events[i]).callback.call(ev.ctx); + return; + case 1: while (++i < l) (ev = events[i]).callback.call(ev.ctx, args[0]); + return; + case 2: while (++i < l) (ev = events[i]).callback.call(ev.ctx, args[0], args[1]); + return; + case 3: while (++i < l) (ev = events[i]).callback.call(ev.ctx, args[0], args[1], args[2]); + return; + default: while (++i < l) (ev = events[i]).callback.apply(ev.ctx, args); + } + }; + // A module that can be mixed in to *any object* in order to provide it with - // custom events. You may bind with `on` or remove with `off` callback functions - // to an event; trigger`-ing an event fires all callbacks in succession. + // custom events. You may bind with `on` or remove with `off` callback + // functions to an event; `trigger`-ing an event fires all callbacks in + // succession. // // var object = {}; // _.extend(object, Backbone.Events); @@ -85,58 +115,59 @@ // var Events = Backbone.Events = { - // Bind one or more space separated events, `events`, to a `callback` - // function. Passing `"all"` will bind the callback to all events fired. - on: function(events, callback, context) { - - var calls, event, node, tail, list; - if (!callback) return this; - events = events.split(eventSplitter); - calls = this._callbacks || (this._callbacks = {}); - - // Create an immutable callback list, allowing traversal during - // modification. The tail is an empty object that will always be used - // as the next node. - while (event = events.shift()) { - list = calls[event]; - node = list ? list.tail : {}; - node.next = tail = {}; - node.context = context; - node.callback = callback; - calls[event] = {tail: tail, next: list ? list.next : node}; - } - + // Bind one or more space separated events, or an events map, + // to a `callback` function. Passing `"all"` will bind the callback to + // all events fired. + on: function(name, callback, context) { + if (!(eventsApi(this, 'on', name, [callback, context]) && callback)) return this; + this._events || (this._events = {}); + var list = this._events[name] || (this._events[name] = []); + list.push({callback: callback, context: context, ctx: context || this}); return this; }, - // Remove one or many callbacks. If `context` is null, removes all callbacks - // with that function. If `callback` is null, removes all callbacks for the - // event. If `events` is null, removes all bound callbacks for all events. - off: function(events, callback, context) { - var event, calls, node, tail, cb, ctx; + // Bind events to only be triggered a single time. After the first time + // the callback is invoked, it will be removed. + once: function(name, callback, context) { + if (!(eventsApi(this, 'once', name, [callback, context]) && callback)) return this; + var self = this; + var once = _.once(function() { + self.off(name, once); + callback.apply(this, arguments); + }); + once._callback = callback; + this.on(name, once, context); + return this; + }, - // No events, or removing *all* events. - if (!(calls = this._callbacks)) return; - if (!(events || callback || context)) { - delete this._callbacks; + // Remove one or many callbacks. If `context` is null, removes all + // callbacks with that function. If `callback` is null, removes all + // callbacks for the event. If `name` is null, removes all bound + // callbacks for all events. + off: function(name, callback, context) { + var list, ev, events, names, i, l, j, k; + if (!this._events || !eventsApi(this, 'off', name, [callback, context])) return this; + if (!name && !callback && !context) { + this._events = {}; return this; } - // Loop through the listed events and contexts, splicing them out of the - // linked list of callbacks if appropriate. - events = events ? events.split(eventSplitter) : _.keys(calls); - while (event = events.shift()) { - node = calls[event]; - delete calls[event]; - if (!node || !(callback || context)) continue; - // Create a new list, omitting the indicated callbacks. - tail = node.tail; - while ((node = node.next) !== tail) { - cb = node.callback; - ctx = node.context; - if ((callback && cb !== callback) || (context && ctx !== context)) { - this.on(event, cb, ctx); + names = name ? [name] : _.keys(this._events); + for (i = 0, l = names.length; i < l; i++) { + name = names[i]; + if (list = this._events[name]) { + events = []; + if (callback || context) { + for (j = 0, k = list.length; j < k; j++) { + ev = list[j]; + if ((callback && callback !== ev.callback && + callback !== ev.callback._callback) || + (context && context !== ev.context)) { + events.push(ev); + } + } } + this._events[name] = events; } } @@ -147,40 +178,54 @@ // passed the same arguments as `trigger` is, apart from the event name // (unless you're listening on `"all"`, which will cause your callback to // receive the true name of the event as the first argument). - trigger: function(events) { - var event, node, calls, tail, args, all, rest; - if (!(calls = this._callbacks)) return this; - all = calls.all; - events = events.split(eventSplitter); - rest = slice.call(arguments, 1); - - // For each event, walk through the linked list of callbacks twice, - // first to trigger the event, then to trigger any `"all"` callbacks. - while (event = events.shift()) { - if (node = calls[event]) { - tail = node.tail; - while ((node = node.next) !== tail) { - node.callback.apply(node.context || this, rest); - } - } - if (node = all) { - tail = node.tail; - args = [event].concat(rest); - while ((node = node.next) !== tail) { - node.callback.apply(node.context || this, args); - } + trigger: function(name) { + if (!this._events) return this; + var args = slice.call(arguments, 1); + if (!eventsApi(this, 'trigger', name, args)) return this; + var events = this._events[name]; + var allEvents = this._events.all; + if (events) triggerEvents(events, args); + if (allEvents) triggerEvents(allEvents, arguments); + return this; + }, + + // An inversion-of-control version of `on`. Tell *this* object to listen to + // an event in another object ... keeping track of what it's listening to. + listenTo: function(obj, name, callback) { + var listeners = this._listeners || (this._listeners = {}); + var id = obj._listenerId || (obj._listenerId = _.uniqueId('l')); + listeners[id] = obj; + obj.on(name, typeof name === 'object' ? this : callback, this); + return this; + }, + + // Tell this object to stop listening to either specific events ... or + // to every object it's currently listening to. + stopListening: function(obj, name, callback) { + var listeners = this._listeners; + if (!listeners) return; + if (obj) { + obj.off(name, typeof name === 'object' ? this : callback, this); + if (!name && !callback) delete listeners[obj._listenerId]; + } else { + if (typeof name === 'object') callback = this; + for (var id in listeners) { + listeners[id].off(name, callback, this); } + this._listeners = {}; } - return this; } - }; // Aliases for backwards compatibility. Events.bind = Events.on; Events.unbind = Events.off; + // Allow the `Backbone` object to serve as a global event bus, for folks who + // want global "pubsub" in a convenient place. + _.extend(Backbone, Events); + // Backbone.Model // -------------- @@ -188,24 +233,16 @@ // is automatically generated and assigned for you. var Model = Backbone.Model = function(attributes, options) { var defaults; - attributes || (attributes = {}); - if (options && options.parse) attributes = this.parse(attributes); - if (defaults = getValue(this, 'defaults')) { - attributes = _.extend({}, defaults, attributes); - } - if (options && options.collection) this.collection = options.collection; - this.attributes = {}; - this._escapedAttributes = {}; + var attrs = attributes || {}; this.cid = _.uniqueId('c'); + this.attributes = {}; + if (options && options.collection) this.collection = options.collection; + if (options && options.parse) attrs = this.parse(attrs, options) || {}; + if (defaults = _.result(this, 'defaults')) { + attrs = _.defaults({}, attrs, defaults); + } + this.set(attrs, options); this.changed = {}; - this._silent = {}; - this._pending = {}; - this.set(attributes, {silent: true}); - // Reset change tracking. - this.changed = {}; - this._silent = {}; - this._pending = {}; - this._previousAttributes = _.clone(this.attributes); this.initialize.apply(this, arguments); }; @@ -215,14 +252,6 @@ // A hash of attributes whose current and previous value differ. changed: null, - // A hash of attributes that have silently changed since the last time - // `change` was called. Will become pending attributes on the next call. - _silent: null, - - // A hash of attributes that have changed since the last `'change'` event - // began. - _pending: null, - // The default name for the JSON `id` attribute is `"id"`. MongoDB and // CouchDB users may want to set this to `"_id"`. idAttribute: 'id', @@ -236,6 +265,11 @@ return _.clone(this.attributes); }, + // Proxy `Backbone.sync` by default. + sync: function() { + return Backbone.sync.apply(this, arguments); + }, + // Get the value of an attribute. get: function(attr) { return this.attributes[attr]; @@ -243,10 +277,7 @@ // Get the HTML-escaped value of an attribute. escape: function(attr) { - var html; - if (html = this._escapedAttributes[attr]) return html; - var val = this.get(attr); - return this._escapedAttributes[attr] = _.escape(val == null ? '' : '' + val); + return _.escape(this.get(attr)); }, // Returns `true` if the attribute contains a value that is not null @@ -255,146 +286,192 @@ return this.get(attr) != null; }, + // ---------------------------------------------------------------------- + // Set a hash of model attributes on the object, firing `"change"` unless // you choose to silence it. - set: function(key, value, options) { - var attrs, attr, val; + set: function(key, val, options) { + var attr, attrs, unset, changes, silent, changing, prev, current; + if (key == null) return this; // Handle both `"key", value` and `{key: value}` -style arguments. - if (_.isObject(key) || key == null) { + if (typeof key === 'object') { attrs = key; - options = value; + options = val; } else { - attrs = {}; - attrs[key] = value; + (attrs = {})[key] = val; } - // Extract attributes and options. options || (options = {}); - if (!attrs) return this; - if (attrs instanceof Model) attrs = attrs.attributes; - if (options.unset) for (attr in attrs) attrs[attr] = void 0; // Run validation. if (!this._validate(attrs, options)) return false; + // Extract attributes and options. + unset = options.unset; + silent = options.silent; + changes = []; + changing = this._changing; + this._changing = true; + + if (!changing) { + this._previousAttributes = _.clone(this.attributes); + this.changed = {}; + } + current = this.attributes, prev = this._previousAttributes; + // Check for changes of `id`. if (this.idAttribute in attrs) this.id = attrs[this.idAttribute]; - var changes = options.changes = {}; - var now = this.attributes; - var escaped = this._escapedAttributes; - var prev = this._previousAttributes || {}; - - // For each `set` attribute... + // For each `set` attribute, update or delete the current value. for (attr in attrs) { val = attrs[attr]; - - // If the new and current value differ, record the change. - if (!_.isEqual(now[attr], val) || (options.unset && _.has(now, attr))) { - delete escaped[attr]; - (options.silent ? this._silent : changes)[attr] = true; - } - - // Update or delete the current value. - options.unset ? delete now[attr] : now[attr] = val; - - // If the new and previous value differ, record the change. If not, - // then remove changes for this attribute. - if (!_.isEqual(prev[attr], val) || (_.has(now, attr) != _.has(prev, attr))) { + if (!_.isEqual(current[attr], val)) changes.push(attr); + if (!_.isEqual(prev[attr], val)) { this.changed[attr] = val; - if (!options.silent) this._pending[attr] = true; } else { delete this.changed[attr]; - delete this._pending[attr]; + } + unset ? delete current[attr] : current[attr] = val; + } + + // Trigger all relevant attribute changes. + if (!silent) { + if (changes.length) this._pending = true; + for (var i = 0, l = changes.length; i < l; i++) { + this.trigger('change:' + changes[i], this, current[changes[i]], options); } } - // Fire the `"change"` events. - if (!options.silent) this.change(options); + if (changing) return this; + if (!silent) { + while (this._pending) { + this._pending = false; + this.trigger('change', this, options); + } + } + this._pending = false; + this._changing = false; return this; }, // Remove an attribute from the model, firing `"change"` unless you choose // to silence it. `unset` is a noop if the attribute doesn't exist. unset: function(attr, options) { - (options || (options = {})).unset = true; - return this.set(attr, null, options); + return this.set(attr, void 0, _.extend({}, options, {unset: true})); }, // Clear all attributes on the model, firing `"change"` unless you choose // to silence it. clear: function(options) { - (options || (options = {})).unset = true; - return this.set(_.clone(this.attributes), options); + var attrs = {}; + for (var key in this.attributes) attrs[key] = void 0; + return this.set(attrs, _.extend({}, options, {unset: true})); + }, + + // Determine if the model has changed since the last `"change"` event. + // If you specify an attribute name, determine if that attribute has changed. + hasChanged: function(attr) { + if (attr == null) return !_.isEmpty(this.changed); + return _.has(this.changed, attr); + }, + + // Return an object containing all the attributes that have changed, or + // false if there are no changed attributes. Useful for determining what + // parts of a view need to be updated and/or what attributes need to be + // persisted to the server. Unset attributes will be set to undefined. + // You can also pass an attributes object to diff against the model, + // determining if there *would be* a change. + changedAttributes: function(diff) { + if (!diff) return this.hasChanged() ? _.clone(this.changed) : false; + var val, changed = false; + var old = this._changing ? this._previousAttributes : this.attributes; + for (var attr in diff) { + if (_.isEqual(old[attr], (val = diff[attr]))) continue; + (changed || (changed = {}))[attr] = val; + } + return changed; }, + // Get the previous value of an attribute, recorded at the time the last + // `"change"` event was fired. + previous: function(attr) { + if (attr == null || !this._previousAttributes) return null; + return this._previousAttributes[attr]; + }, + + // Get all of the attributes of the model at the time of the previous + // `"change"` event. + previousAttributes: function() { + return _.clone(this._previousAttributes); + }, + + // --------------------------------------------------------------------- + // Fetch the model from the server. If the server's representation of the // model differs from its current attributes, they will be overriden, // triggering a `"change"` event. fetch: function(options) { options = options ? _.clone(options) : {}; - var model = this; + if (options.parse === void 0) options.parse = true; var success = options.success; - options.success = function(resp, status, xhr) { - if (!model.set(model.parse(resp, xhr), options)) return false; - if (success) success(model, resp); + options.success = function(model, resp, options) { + if (!model.set(model.parse(resp, options), options)) return false; + if (success) success(model, resp, options); }; - options.error = Backbone.wrapError(options.error, model, options); - return (this.sync || Backbone.sync).call(this, 'read', this, options); + return this.sync('read', this, options); }, // Set a hash of model attributes, and sync the model to the server. // If the server returns an attributes hash that differs, the model's // state will be `set` again. - save: function(key, value, options) { - var attrs, current; + save: function(key, val, options) { + var attrs, success, method, xhr, attributes = this.attributes; - // Handle both `("key", value)` and `({key: value})` -style calls. - if (_.isObject(key) || key == null) { + // Handle both `"key", value` and `{key: value}` -style arguments. + if (key == null || typeof key === 'object') { attrs = key; - options = value; + options = val; } else { - attrs = {}; - attrs[key] = value; + (attrs = {})[key] = val; } - options = options ? _.clone(options) : {}; - // If we're "wait"-ing to set changed attributes, validate early. - if (options.wait) { - if (!this._validate(attrs, options)) return false; - current = _.clone(this.attributes); - } + // If we're not waiting and attributes exist, save acts as `set(attr).save(null, opts)`. + if (attrs && (!options || !options.wait) && !this.set(attrs, options)) return false; - // Regular saves `set` attributes before persisting to the server. - var silentOptions = _.extend({}, options, {silent: true}); - if (attrs && !this.set(attrs, options.wait ? silentOptions : options)) { - return false; + options = _.extend({validate: true}, options); + + // Do not persist invalid models. + if (!this._validate(attrs, options)) return false; + + // Set temporary attributes if `{wait: true}`. + if (attrs && options.wait) { + this.attributes = _.extend({}, attributes, attrs); } // After a successful server-side save, the client is (optionally) // updated with the server-side state. - var model = this; - var success = options.success; - options.success = function(resp, status, xhr) { - var serverAttrs = model.parse(resp, xhr); - if (options.wait) { - delete options.wait; - serverAttrs = _.extend(attrs || {}, serverAttrs); - } - if (!model.set(serverAttrs, options)) return false; - if (success) { - success(model, resp); - } else { - model.trigger('sync', model, resp, options); + if (options.parse === void 0) options.parse = true; + success = options.success; + options.success = function(model, resp, options) { + // Ensure attributes are restored during synchronous saves. + model.attributes = attributes; + var serverAttrs = model.parse(resp, options); + if (options.wait) serverAttrs = _.extend(attrs || {}, serverAttrs); + if (_.isObject(serverAttrs) && !model.set(serverAttrs, options)) { + return false; } + if (success) success(model, resp, options); }; // Finish configuring and sending the Ajax request. - options.error = Backbone.wrapError(options.error, model, options); - var method = this.isNew() ? 'create' : 'update'; - var xhr = (this.sync || Backbone.sync).call(this, method, this, options); - if (options.wait) this.set(current, silentOptions); + method = this.isNew() ? 'create' : (options.patch ? 'patch' : 'update'); + if (method === 'patch') options.attrs = attrs; + xhr = this.sync(method, this, options); + + // Restore attributes. + if (attrs && options.wait) this.attributes = attributes; + return xhr; }, @@ -406,27 +483,22 @@ var model = this; var success = options.success; - var triggerDestroy = function() { + var destroy = function() { model.trigger('destroy', model, model.collection, options); }; + options.success = function(model, resp, options) { + if (options.wait || model.isNew()) destroy(); + if (success) success(model, resp, options); + }; + if (this.isNew()) { - triggerDestroy(); + options.success(this, null, options); return false; } - options.success = function(resp) { - if (options.wait) triggerDestroy(); - if (success) { - success(model, resp); - } else { - model.trigger('sync', model, resp, options); - } - }; - - options.error = Backbone.wrapError(options.error, model, options); - var xhr = (this.sync || Backbone.sync).call(this, 'delete', this, options); - if (!options.wait) triggerDestroy(); + var xhr = this.sync('delete', this, options); + if (!options.wait) destroy(); return xhr; }, @@ -434,14 +506,14 @@ // using Backbone's restful methods, override this to change the endpoint // that will be called. url: function() { - var base = getValue(this, 'urlRoot') || getValue(this.collection, 'url') || urlError(); + var base = _.result(this, 'urlRoot') || _.result(this.collection, 'url') || urlError(); if (this.isNew()) return base; - return base + (base.charAt(base.length - 1) == '/' ? '' : '/') + encodeURIComponent(this.id); + return base + (base.charAt(base.length - 1) === '/' ? '' : '/') + encodeURIComponent(this.id); }, // **parse** converts a response into the hash of attributes to be `set` on // the model. The default implementation is just to pass the response along. - parse: function(resp, xhr) { + parse: function(resp, options) { return resp; }, @@ -455,96 +527,20 @@ return this.id == null; }, - // Call this method to manually fire a `"change"` event for this model and - // a `"change:attribute"` event for each changed attribute. - // Calling this will cause all objects observing the model to update. - change: function(options) { - options || (options = {}); - var changing = this._changing; - this._changing = true; - - // Silent changes become pending changes. - for (var attr in this._silent) this._pending[attr] = true; - - // Silent changes are triggered. - var changes = _.extend({}, options.changes, this._silent); - this._silent = {}; - for (var attr in changes) { - this.trigger('change:' + attr, this, this.get(attr), options); - } - if (changing) return this; - - // Continue firing `"change"` events while there are pending changes. - while (!_.isEmpty(this._pending)) { - this._pending = {}; - this.trigger('change', this, options); - // Pending and silent changes still remain. - for (var attr in this.changed) { - if (this._pending[attr] || this._silent[attr]) continue; - delete this.changed[attr]; - } - this._previousAttributes = _.clone(this.attributes); - } - - this._changing = false; - return this; - }, - - // Determine if the model has changed since the last `"change"` event. - // If you specify an attribute name, determine if that attribute has changed. - hasChanged: function(attr) { - if (!arguments.length) return !_.isEmpty(this.changed); - return _.has(this.changed, attr); - }, - - // Return an object containing all the attributes that have changed, or - // false if there are no changed attributes. Useful for determining what - // parts of a view need to be updated and/or what attributes need to be - // persisted to the server. Unset attributes will be set to undefined. - // You can also pass an attributes object to diff against the model, - // determining if there *would be* a change. - changedAttributes: function(diff) { - if (!diff) return this.hasChanged() ? _.clone(this.changed) : false; - var val, changed = false, old = this._previousAttributes; - for (var attr in diff) { - if (_.isEqual(old[attr], (val = diff[attr]))) continue; - (changed || (changed = {}))[attr] = val; - } - return changed; - }, - - // Get the previous value of an attribute, recorded at the time the last - // `"change"` event was fired. - previous: function(attr) { - if (!arguments.length || !this._previousAttributes) return null; - return this._previousAttributes[attr]; - }, - - // Get all of the attributes of the model at the time of the previous - // `"change"` event. - previousAttributes: function() { - return _.clone(this._previousAttributes); - }, - - // Check if the model is currently in a valid state. It's only possible to - // get into an *invalid* state if you're using silent changes. - isValid: function() { - return !this.validate(this.attributes); + // Check if the model is currently in a valid state. + isValid: function(options) { + return !this.validate || !this.validate(this.attributes, options); }, // Run validation against the next complete set of model attributes, - // returning `true` if all is well. If a specific `error` callback has - // been passed, call that instead of firing the general `"error"` event. + // returning `true` if all is well. Otherwise, fire a general + // `"error"` event and call the error callback, if specified. _validate: function(attrs, options) { - if (options.silent || !this.validate) return true; + if (!options.validate || !this.validate) return true; attrs = _.extend({}, this.attributes, attrs); - var error = this.validate(attrs, options); + var error = this.validationError = this.validate(attrs, options) || null; if (!error) return true; - if (options && options.error) { - options.error(this, error, options); - } else { - this.trigger('error', this, error, options); - } + this.trigger('invalid', this, error, options || {}); return false; } @@ -559,10 +555,11 @@ var Collection = Backbone.Collection = function(models, options) { options || (options = {}); if (options.model) this.model = options.model; - if (options.comparator) this.comparator = options.comparator; + if (options.comparator !== void 0) this.comparator = options.comparator; + this.models = []; this._reset(); this.initialize.apply(this, arguments); - if (models) this.reset(models, {silent: true, parse: options.parse}); + if (models) this.reset(models, _.extend({silent: true}, options)); }; // Define the Collection's inheritable methods. @@ -582,68 +579,86 @@ return this.map(function(model){ return model.toJSON(options); }); }, - // Add a model, or list of models to the set. Pass **silent** to avoid - // firing the `add` event for every new model. + // Proxy `Backbone.sync` by default. + sync: function() { + return Backbone.sync.apply(this, arguments); + }, + + // Add a model, or list of models to the set. add: function(models, options) { - var i, index, length, model, cid, id, cids = {}, ids = {}, dups = []; - options || (options = {}); models = _.isArray(models) ? models.slice() : [models]; - - // Begin by turning bare objects into model references, and preventing - // invalid models or duplicate models from being added. - for (i = 0, length = models.length; i < length; i++) { - if (!(model = models[i] = this._prepareModel(models[i], options))) { - throw new Error("Can't add an invalid model to a collection"); + options || (options = {}); + var i, l, model, attrs, existing, doSort, add, at, sort, sortAttr; + add = []; + at = options.at; + sort = this.comparator && (at == null) && options.sort != false; + sortAttr = _.isString(this.comparator) ? this.comparator : null; + + // Turn bare objects into model references, and prevent invalid models + // from being added. + for (i = 0, l = models.length; i < l; i++) { + if (!(model = this._prepareModel(attrs = models[i], options))) { + this.trigger('invalid', this, attrs, options); + continue; } - cid = model.cid; - id = model.id; - if (cids[cid] || this._byCid[cid] || ((id != null) && (ids[id] || this._byId[id]))) { - dups.push(i); + + // If a duplicate is found, prevent it from being added and + // optionally merge it into the existing model. + if (existing = this.get(model)) { + if (options.merge) { + existing.set(attrs === model ? model.attributes : attrs, options); + if (sort && !doSort && existing.hasChanged(sortAttr)) doSort = true; + } continue; } - cids[cid] = ids[id] = model; - } - // Remove duplicates. - i = dups.length; - while (i--) { - models.splice(dups[i], 1); - } + // This is a new model, push it to the `add` list. + add.push(model); - // Listen to added models' events, and index models for lookup by - // `id` and by `cid`. - for (i = 0, length = models.length; i < length; i++) { - (model = models[i]).on('all', this._onModelEvent, this); - this._byCid[model.cid] = model; + // Listen to added models' events, and index models for lookup by + // `id` and by `cid`. + model.on('all', this._onModelEvent, this); + this._byId[model.cid] = model; if (model.id != null) this._byId[model.id] = model; } - // Insert models into the collection, re-sorting if needed, and triggering - // `add` events unless silenced. - this.length += length; - index = options.at != null ? options.at : this.models.length; - splice.apply(this.models, [index, 0].concat(models)); - if (this.comparator) this.sort({silent: true}); + // See if sorting is needed, update `length` and splice in new models. + if (add.length) { + if (sort) doSort = true; + this.length += add.length; + if (at != null) { + splice.apply(this.models, [at, 0].concat(add)); + } else { + push.apply(this.models, add); + } + } + + // Silently sort the collection if appropriate. + if (doSort) this.sort({silent: true}); + if (options.silent) return this; - for (i = 0, length = this.models.length; i < length; i++) { - if (!cids[(model = this.models[i]).cid]) continue; - options.index = i; - model.trigger('add', model, this, options); + + // Trigger `add` events. + for (i = 0, l = add.length; i < l; i++) { + (model = add[i]).trigger('add', model, this, options); } + + // Trigger `sort` if the collection was sorted. + if (doSort) this.trigger('sort', this, options); + return this; }, - // Remove a model, or a list of models from the set. Pass silent to avoid - // firing the `remove` event for every model removed. + // Remove a model, or a list of models from the set. remove: function(models, options) { - var i, l, index, model; - options || (options = {}); models = _.isArray(models) ? models.slice() : [models]; + options || (options = {}); + var i, l, index, model; for (i = 0, l = models.length; i < l; i++) { - model = this.getByCid(models[i]) || this.get(models[i]); + model = this.get(models[i]); if (!model) continue; delete this._byId[model.id]; - delete this._byCid[model.cid]; + delete this._byId[model.cid]; index = this.indexOf(model); this.models.splice(index, 1); this.length--; @@ -659,7 +674,7 @@ // Add a model to the end of the collection. push: function(model, options) { model = this._prepareModel(model, options); - this.add(model, options); + this.add(model, _.extend({at: this.length}, options)); return model; }, @@ -684,15 +699,16 @@ return model; }, - // Get a model from the set by id. - get: function(id) { - if (id == null) return void 0; - return this._byId[id.id != null ? id.id : id]; + // Slice out a sub-array of models from the collection. + slice: function(begin, end) { + return this.models.slice(begin, end); }, - // Get a model from the set by client id. - getByCid: function(cid) { - return cid && this._byCid[cid.cid || cid]; + // Get a model from the set by id. + get: function(obj) { + if (obj == null) return void 0; + this._idAttr || (this._idAttr = this.model.prototype.idAttribute); + return this._byId[obj.id || obj.cid || obj[this._idAttr] || obj]; }, // Get the model at the given index. @@ -715,71 +731,106 @@ // normal circumstances, as the set will maintain sort order as each item // is added. sort: function(options) { + if (!this.comparator) { + throw new Error('Cannot sort a set without a comparator'); + } options || (options = {}); - if (!this.comparator) throw new Error('Cannot sort a set without a comparator'); - var boundComparator = _.bind(this.comparator, this); - if (this.comparator.length == 1) { - this.models = this.sortBy(boundComparator); + + // Run sort based on type of `comparator`. + if (_.isString(this.comparator) || this.comparator.length === 1) { + this.models = this.sortBy(this.comparator, this); } else { - this.models.sort(boundComparator); + this.models.sort(_.bind(this.comparator, this)); } - if (!options.silent) this.trigger('reset', this, options); + + if (!options.silent) this.trigger('sort', this, options); return this; }, // Pluck an attribute from each model in the collection. pluck: function(attr) { - return _.map(this.models, function(model){ return model.get(attr); }); + return _.invoke(this.models, 'get', attr); + }, + + // Smartly update a collection with a change set of models, adding, + // removing, and merging as necessary. + update: function(models, options) { + options = _.extend({add: true, merge: true, remove: true}, options); + if (options.parse) models = this.parse(models, options); + var model, i, l, existing; + var add = [], remove = [], modelMap = {}; + + // Allow a single model (or no argument) to be passed. + if (!_.isArray(models)) models = models ? [models] : []; + + // Proxy to `add` for this case, no need to iterate... + if (options.add && !options.remove) return this.add(models, options); + + // Determine which models to add and merge, and which to remove. + for (i = 0, l = models.length; i < l; i++) { + model = models[i]; + existing = this.get(model); + if (options.remove && existing) modelMap[existing.cid] = true; + if ((options.add && !existing) || (options.merge && existing)) { + add.push(model); + } + } + if (options.remove) { + for (i = 0, l = this.models.length; i < l; i++) { + model = this.models[i]; + if (!modelMap[model.cid]) remove.push(model); + } + } + + // Remove models (if applicable) before we add and merge the rest. + if (remove.length) this.remove(remove, options); + if (add.length) this.add(add, options); + return this; }, // When you have more items than you want to add or remove individually, // you can reset the entire set with a new list of models, without firing // any `add` or `remove` events. Fires `reset` when finished. reset: function(models, options) { - models || (models = []); options || (options = {}); + if (options.parse) models = this.parse(models, options); for (var i = 0, l = this.models.length; i < l; i++) { this._removeReference(this.models[i]); } + options.previousModels = this.models.slice(); this._reset(); - this.add(models, _.extend({silent: true}, options)); + if (models) this.add(models, _.extend({silent: true}, options)); if (!options.silent) this.trigger('reset', this, options); return this; }, // Fetch the default set of models for this collection, resetting the - // collection when they arrive. If `add: true` is passed, appends the - // models to the collection instead of resetting. + // collection when they arrive. If `update: true` is passed, the response + // data will be passed through the `update` method instead of `reset`. fetch: function(options) { options = options ? _.clone(options) : {}; - if (options.parse === undefined) options.parse = true; - var collection = this; + if (options.parse === void 0) options.parse = true; var success = options.success; - options.success = function(resp, status, xhr) { - collection[options.add ? 'add' : 'reset'](collection.parse(resp, xhr), options); - if (success) success(collection, resp); + options.success = function(collection, resp, options) { + var method = options.update ? 'update' : 'reset'; + collection[method](resp, options); + if (success) success(collection, resp, options); }; - options.error = Backbone.wrapError(options.error, collection, options); - return (this.sync || Backbone.sync).call(this, 'read', this, options); + return this.sync('read', this, options); }, // Create a new instance of a model in this collection. Add the model to the // collection immediately, unless `wait: true` is passed, in which case we // wait for the server to agree. create: function(model, options) { - var coll = this; options = options ? _.clone(options) : {}; - model = this._prepareModel(model, options); - if (!model) return false; - if (!options.wait) coll.add(model, options); + if (!(model = this._prepareModel(model, options))) return false; + if (!options.wait) this.add(model, options); + var collection = this; var success = options.success; - options.success = function(nextModel, resp, xhr) { - if (options.wait) coll.add(nextModel, options); - if (success) { - success(nextModel, resp); - } else { - nextModel.trigger('sync', model, resp, options); - } + options.success = function(model, resp, options) { + if (options.wait) collection.add(model, options); + if (success) success(model, resp, options); }; model.save(null, options); return model; @@ -787,44 +838,38 @@ // **parse** converts a response into a list of models to be added to the // collection. The default implementation is just to pass it through. - parse: function(resp, xhr) { + parse: function(resp, options) { return resp; }, - // Proxy to _'s chain. Can't be proxied the same way the rest of the - // underscore methods are proxied because it relies on the underscore - // constructor. - chain: function () { - return _(this.models).chain(); + // Create a new collection with an identical list of models as this one. + clone: function() { + return new this.constructor(this.models); }, // Reset all internal state. Called when the collection is reset. - _reset: function(options) { + _reset: function() { this.length = 0; - this.models = []; + this.models.length = 0; this._byId = {}; - this._byCid = {}; }, // Prepare a model or hash of attributes to be added to this collection. - _prepareModel: function(model, options) { - options || (options = {}); - if (!(model instanceof Model)) { - var attrs = model; - options.collection = this; - model = new this.model(attrs, options); - if (!model._validate(model.attributes, options)) model = false; - } else if (!model.collection) { - model.collection = this; + _prepareModel: function(attrs, options) { + if (attrs instanceof Model) { + if (!attrs.collection) attrs.collection = this; + return attrs; } + options || (options = {}); + options.collection = this; + var model = new this.model(attrs, options); + if (!model._validate(attrs, options)) return false; return model; }, // Internal method to remove a model's ties to a collection. _removeReference: function(model) { - if (this == model.collection) { - delete model.collection; - } + if (this === model.collection) delete model.collection; model.off('all', this._onModelEvent, this); }, @@ -833,35 +878,57 @@ // events simply proxy through. "add" and "remove" events that originate // in other collections are ignored. _onModelEvent: function(event, model, collection, options) { - if ((event == 'add' || event == 'remove') && collection != this) return; - if (event == 'destroy') { - this.remove(model, options); - } + if ((event === 'add' || event === 'remove') && collection !== this) return; + if (event === 'destroy') this.remove(model, options); if (model && event === 'change:' + model.idAttribute) { delete this._byId[model.previous(model.idAttribute)]; - this._byId[model.id] = model; + if (model.id != null) this._byId[model.id] = model; } this.trigger.apply(this, arguments); + }, + + sortedIndex: function (model, value, context) { + value || (value = this.comparator); + var iterator = _.isFunction(value) ? value : function(model) { + return model.get(value); + }; + return _.sortedIndex(this.models, model, iterator, context); } }); // Underscore methods that we want to implement on the Collection. - var methods = ['forEach', 'each', 'map', 'reduce', 'reduceRight', 'find', - 'detect', 'filter', 'select', 'reject', 'every', 'all', 'some', 'any', - 'include', 'contains', 'invoke', 'max', 'min', 'sortBy', 'sortedIndex', - 'toArray', 'size', 'first', 'initial', 'rest', 'last', 'without', 'indexOf', - 'shuffle', 'lastIndexOf', 'isEmpty', 'groupBy']; + var methods = ['forEach', 'each', 'map', 'collect', 'reduce', 'foldl', + 'inject', 'reduceRight', 'foldr', 'find', 'detect', 'filter', 'select', + 'reject', 'every', 'all', 'some', 'any', 'include', 'contains', 'invoke', + 'max', 'min', 'toArray', 'size', 'first', 'head', 'take', 'initial', 'rest', + 'tail', 'drop', 'last', 'without', 'indexOf', 'shuffle', 'lastIndexOf', + 'isEmpty', 'chain']; // Mix in each Underscore method as a proxy to `Collection#models`. _.each(methods, function(method) { Collection.prototype[method] = function() { - return _[method].apply(_, [this.models].concat(_.toArray(arguments))); + var args = slice.call(arguments); + args.unshift(this.models); + return _[method].apply(_, args); + }; + }); + + // Underscore methods that take a property name as an argument. + var attributeMethods = ['groupBy', 'countBy', 'sortBy']; + + // Use attributes instead of properties. + _.each(attributeMethods, function(method) { + Collection.prototype[method] = function(value, context) { + var iterator = _.isFunction(value) ? value : function(model) { + return model.get(value); + }; + return _[method](this.models, iterator, context); }; }); // Backbone.Router - // ------------------- + // --------------- // Routers map faux-URLs to actions, and fire events when routes are // matched. Creating a new one sets its `routes` hash, if not set statically. @@ -874,9 +941,10 @@ // Cached regular expressions for matching named param parts and splatted // parts of route strings. - var namedParam = /:\w+/g; + var optionalParam = /\((.*?)\)/g; + var namedParam = /(\(\?)?:\w+/g; var splatParam = /\*\w+/g; - var escapeRegExp = /[-[\]{}()+?.,\\^$|#\s]/g; + var escapeRegExp = /[\-{}\[\]+?.,\\\^$|#\s]/g; // Set up all inheritable **Backbone.Router** properties and methods. _.extend(Router.prototype, Events, { @@ -892,13 +960,13 @@ // }); // route: function(route, name, callback) { - Backbone.history || (Backbone.history = new History); if (!_.isRegExp(route)) route = this._routeToRegExp(route); if (!callback) callback = this[name]; Backbone.history.route(route, _.bind(function(fragment) { var args = this._extractParameters(route, fragment); callback && callback.apply(this, args); this.trigger.apply(this, ['route:' + name].concat(args)); + this.trigger('route', name, args); Backbone.history.trigger('route', this, name, args); }, this)); return this; @@ -907,6 +975,7 @@ // Simple proxy to `Backbone.history` to save a fragment into the history. navigate: function(fragment, options) { Backbone.history.navigate(fragment, options); + return this; }, // Bind all defined routes to `Backbone.history`. We have to reverse the @@ -914,12 +983,9 @@ // routes can be defined at the bottom of the route map. _bindRoutes: function() { if (!this.routes) return; - var routes = []; - for (var route in this.routes) { - routes.unshift([route, this.routes[route]]); - } - for (var i = 0, l = routes.length; i < l; i++) { - this.route(routes[i][0], routes[i][1], this[routes[i][1]]); + var route, routes = _.keys(this.routes); + while ((route = routes.pop()) != null) { + this.route(route, this.routes[route]); } }, @@ -927,7 +993,10 @@ // against the current location hash. _routeToRegExp: function(route) { route = route.replace(escapeRegExp, '\\$&') - .replace(namedParam, '([^\/]+)') + .replace(optionalParam, '(?:$1)?') + .replace(namedParam, function(match, optional){ + return optional ? match : '([^\/]+)'; + }) .replace(splatParam, '(.*?)'); return new RegExp('^' + route + '$'); }, @@ -948,14 +1017,26 @@ var History = Backbone.History = function() { this.handlers = []; _.bindAll(this, 'checkUrl'); + + // Ensure that `History` can be used outside of the browser. + if (typeof window !== 'undefined') { + this.location = window.location; + this.history = window.history; + } }; - // Cached regex for cleaning leading hashes and slashes . - var routeStripper = /^[#\/]/; + // Cached regex for stripping a leading hash/slash and trailing space. + var routeStripper = /^[#\/]|\s+$/g; + + // Cached regex for stripping leading and trailing slashes. + var rootStripper = /^\/+|\/+$/g; // Cached regex for detecting MSIE. var isExplorer = /msie [\w.]+/; + // Cached regex for removing a trailing slash. + var trailingSlash = /\/$/; + // Has the history handling already been started? History.started = false; @@ -968,9 +1049,8 @@ // Gets the true hash value. Cannot use location.hash directly due to bug // in Firefox where location.hash will always be decoded. - getHash: function(windowOverride) { - var loc = windowOverride ? windowOverride.location : window.location; - var match = loc.href.match(/#(.*)$/); + getHash: function(window) { + var match = (window || this).location.href.match(/#(.*)$/); return match ? match[1] : ''; }, @@ -978,15 +1058,14 @@ // the hash, or the override. getFragment: function(fragment, forcePushState) { if (fragment == null) { - if (this._hasPushState || forcePushState) { - fragment = window.location.pathname; - var search = window.location.search; - if (search) fragment += search; + if (this._hasPushState || !this._wantsHashChange || forcePushState) { + fragment = this.location.pathname; + var root = this.root.replace(trailingSlash, ''); + if (!fragment.indexOf(root)) fragment = fragment.substr(root.length); } else { fragment = this.getHash(); } } - if (!fragment.indexOf(this.options.root)) fragment = fragment.substr(this.options.root.length); return fragment.replace(routeStripper, ''); }, @@ -999,24 +1078,28 @@ // Figure out the initial configuration. Do we need an iframe? // Is pushState desired ... is it available? this.options = _.extend({}, {root: '/'}, this.options, options); + this.root = this.options.root; this._wantsHashChange = this.options.hashChange !== false; this._wantsPushState = !!this.options.pushState; - this._hasPushState = !!(this.options.pushState && window.history && window.history.pushState); + this._hasPushState = !!(this.options.pushState && this.history && this.history.pushState); var fragment = this.getFragment(); var docMode = document.documentMode; var oldIE = (isExplorer.exec(navigator.userAgent.toLowerCase()) && (!docMode || docMode <= 7)); - if (oldIE) { - this.iframe = $('