From aad0a08f3ca25a7c8792eceddf2ae4574f0201a6 Mon Sep 17 00:00:00 2001 From: andrzejsliwa Date: Wed, 9 Mar 2011 15:14:36 +0100 Subject: [PATCH] improved documentation of code. --- .couchapprc.example | 4 +- Gemfile.lock | 44 + autopush.watchr | 6 - js/backbone.couch.fn.js | 438 --- js/backbone.couch.js | 547 ++-- js/vendor/backbone.js | 1012 ++++++ js/vendor/jquery.couch.js | 668 ++++ js/vendor/jquery.js | 6240 +++++++++++++++++++++++++++++++++++++ js/vendor/underscore.js | 771 +++++ spec.html | 28 +- spec/spec.helper.js | 2 +- spec/spec.js | 25 +- spec/vendor/LAB.min.js | 5 + 13 files changed, 9102 insertions(+), 688 deletions(-) create mode 100644 Gemfile.lock delete mode 100644 js/backbone.couch.fn.js create mode 100644 js/vendor/backbone.js create mode 100644 js/vendor/jquery.couch.js create mode 100644 js/vendor/jquery.js create mode 100644 js/vendor/underscore.js create mode 100644 spec/vendor/LAB.min.js diff --git a/.couchapprc.example b/.couchapprc.example index fd5dea5..d25de03 100644 --- a/.couchapprc.example +++ b/.couchapprc.example @@ -1,7 +1,7 @@ { "env": { "test": { - "db": "http://localhost:5984/couchwatch-test" - }, + "db": "http://localhost:5984/backbone-couch-test" + } } } diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..decfac4 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,44 @@ +GEM + remote: http://rubygems.org/ + specs: + archive-tar-minitar (0.5.2) + compass (0.10.6) + haml (>= 3.0.4) + downlow (0.1.4) + archive-tar-minitar (>= 0.5.2) + rubyzip (>= 0.9.4) + haml (3.0.25) + jim (0.2.3) + downlow (>= 0.1.3) + version_sorter (>= 1.1.0) + yajl-ruby + json (1.4.6) + mime-types (1.16) + mustache (0.11.2) + rack (1.2.1) + rb-fsevent (0.3.10) + ruby-growl (3.0) + rubyzip (0.9.4) + soca (0.1.2) + compass (~> 0.10.5) + jim (~> 0.2.3) + json (~> 1.4.6) + mime-types (~> 1.16) + mustache (~> 0.11.2) + thor (~> 0.14.0) + typhoeus (~> 0.1.31) + thor (0.14.6) + typhoeus (0.1.31) + rack + version_sorter (1.1.0) + watchr (0.7) + yajl-ruby (0.8.1) + +PLATFORMS + ruby + +DEPENDENCIES + rb-fsevent + ruby-growl + soca (~> 0.1.2) + watchr (~> 0.7) diff --git a/autopush.watchr b/autopush.watchr index a9ceb88..be05941 100755 --- a/autopush.watchr +++ b/autopush.watchr @@ -36,10 +36,6 @@ def run(cmd) system cmd end -# couchapprc = check_file(".couchapprc") -# couchapprc = JSON.parse(File.read(couchapprc)) -# dbname = couchapprc["env"]["test"]["db"].match(/\d\/(\S*)$/m)[1] - configjs = check_file("config.js") configjs = JSON.parse(File.read(configjs)) appname = configjs["id"] @@ -49,8 +45,6 @@ if is_growl growl.notify("CouchApp AutoPush", "backbone-couch", "default & test.", 1, true) end -push(appname, growl) - watch('.*') do |m| unless m[0].match(/\/.idea\//) or m[0].match(/\/.git\//) puts "#{m[0]} was changed." diff --git a/js/backbone.couch.fn.js b/js/backbone.couch.fn.js deleted file mode 100644 index 074fe5e..0000000 --- a/js/backbone.couch.fn.js +++ /dev/null @@ -1,438 +0,0 @@ -// Backbone.couch.js - function based version - (c) 2011 Andrzej Sliwa -// -// Based on Jan Monschke backbone.couchdb.js connector with some improvements. -// -// Example configuration: -// -// Backbone.couch.settings.databaseName = "couchwatch"; -// Backbone.couch.settings.ddocName = "couchwatch"; -// Backbone.couch.settings.enableChangesFeed = true; -// Backbone.sync = Backbone.couch.sync; -// -// Backbone.couch.settings.ddocChange(function(ddocName){ -// console.log("current ddoc: '" + ddocName + "' changed"); -// console.log("restarting..."); -// window.location.reload(); -// }); - -Backbone.couch = new function () { - - var settings = { - debug: false, - enableChangesFeed: true, - databaseName : "", - ddocName : "", - baseUrl : null - }; - - var watchList = []; - var ddocChangeHandler = null; - var changesFeed = null; - var database = null; - - var db = function() { - if (database) return database; - datbase = $.couch.db( settings.databaseName ); - if ( settings.baseUrl ) { - datbase.uri = settings.baseUrl + "/" + settings.databaseName + "/"; - } - return datbase; - }; - - var log = function ( message ) { - if ( settings.debug && console && console.log ) { - console.log( "Backbone.couch - " + message ); - } - }; - - var create = function( model, _success, _error ) { - log( "create" ); - - var data = model.toJSON(); - if ( !data.type ) { data.type = getType( model ); } - if ( !data.id && data._id ) { data.id = data._id; } - db().saveDoc( data, { - success: function( respone ){ - _success( { - "id": respone.id, - "_id": respone.id, - "_rev": respone.rev - }); - }, - error: _error - }); - }; - - var getType = function( model ) { - return model.url; - }; - - var remove = function( model, _success, _error ) { - log( "remove" ); - - var data = model.toJSON(); - - db().removeDoc(data, { - success: _success, - error: function (_nr, _req, e) { - if ( e == "deleted" ) { - _success(); - } else { - _error(); - } - } - }) - }; - - var fetchCollection = function( collection, _success, _error) { - log( "fetchCollection" ); - - var viewName = getView( collection ), - // build query name - query = settings.ddocName + "/" + viewName; - // if descending not defined set default false - collection.descending || ( collection.descending = false ); - - var options = { - descending: collection.descending, - success: function( result ) { - var models = []; - // for each result row, build model - // compilant with backbone - _.each( result.rows, function( row ) { - var model = row.value; - if ( !model.id ) { model.id = row.id } - models.push( model ); - }); - // if no result then should result null - if ( models.length == 0 ) { models = null } - _success( models ); - }, - error: _error - }; - if (collection.limit) { options.limit = collection.limit; } - db().view(query, options); - - var model = new collection.model; - if (! model.url ) { - throw new Error( "No 'url' property on collection.model!" ); - } - - var type = getType(new collection.model); - if ( !watchList[ type ] ) { - watchList[ type ] = collection; - } - }; - - var fetchModel = function( model, _success, _error) { - log( "fetchModel" ); - - db().openDoc( model.id, { - success: function(doc) { _success(doc); }, - error: _error - }); - }; - - var changes = function() { - log( "changesFeed" ); - - var currentDdoc = "_design/" + settings.ddocName; - console.log(db()); - db().info( { - success: function ( data ) { - var since = ( data.update_seq || 0); - changesFeed = db().changes( since, { include_docs: true } ); - changesFeed.onChange( function( changes ) { - _.each( changes.results, function( row ) { - var doc = row.doc; - var handlerDefined = typeof ddocChangeHandler === "function"; - var id = ( doc.id || doc._id ); - - if ( handlerDefined && ( id === currentDdoc )) { - ddocChangeHandler(currentDdoc); - } - - if ( doc.type ) { - var collection = watchList[ doc.type ]; - if ( collection ) { - var model = collection.get( id ); - if ( model ) { - if ( model && doc._rev != model.get( "_rev" ) ) { - model.set(doc); - } - } else { - if ( !doc.id ) { doc.id = doc._id; } - collection.add(doc); - } - } - } - }) - }); - }, - error: function () { - log("problem with db connection"); - } - }) - }; - - var ddocChange = function( callback ) { - log( "ddocChange" ); - ddocChangeHandler = callback; - }; - - var getView = function( collection ) { - log( "getViewName" ); - - if (!( collection && collection.url )) { - throw new Error( "No url property / function!" ); - } - // if url is function evaluate else use as value - return _.isFunction( collection.url ) ? collection.url() : collection.url; - }; - - - - return { - sync: function( method, obj, success, error ) { - if (settings.databaseName === "" || settings.ddocName === "") { - throw new Error("Backbone.couch.settings - Missing database configuration: databaseName / ddocName !" ); - } - - - if ( method === "create" || method === "update" ) { - // triggered on "model.save(...)" - create( obj, success, error ); - } else if ( method === "delete" ) { - // triggered on "model.destroy(...)" - remove( obj, success, error ); - } else if ( method === "read" ) { - // depends from where sync is called - if ( obj.model ) { - // triggered on "collection.fetch(...)" - fetchCollection( obj, success, error ); - } else { - // triggered on "model.fetch(...)" - fetchModel( obj, success, error ); - } - } - - // run changes changes feed handler - if( settings.enableChangesFeed && !changesFeed ) { - changes(); - } - }, - settings: settings - } -}; -// -// -//var test = { -// -// debug: false, -// -// enableChangesFeed: true, -// -// databaseName : "", -// -// ddocName : "", -// -// baseUrl : null, -// -// _watchList : [], -// -// db: function() { -// this.log( "db" ); -// -// var db = $.couch.db( this.databaseName ); -// if ( this.baseUrl ) { -// db.uri = this.baseUrl + "/" + this.databaseName + "/"; -// -// } -// return db; -// }, -// -// log: function ( message ) { -// if ( console && console.log ) { -// console.log( "Backbone.couch - " + message ); -// } -// }, -// -// create: function( model, _success, _error ) { -// this.log( "create" ); -// -// var db = this.db(), -// data = model.toJSON(); -// if ( !data.type ) { data.type = this.getType( model ); } -// if ( !data.id && data._id ) { data.id = data._id; } -// db.saveDoc( data, { -// success: function( respone ){ -// _success( { -// "id": respone.id, -// "_id": respone.id, -// "_rev": respone.rev -// }); -// }, -// error: _error -// }); -// }, -// -// getType: function( model ) { -// return model.url; -// }, -// -// remove: function( model, _success, _error ) { -// this.log( "remove" ); -// -// var db = this.db(), -// data = model.toJSON(); -// -// db.removeDoc(data, { -// success: _success, -// error: function (_nr, _req, e) { -// if ( e == "deleted" ) { -// _success(); -// } else { -// _error(); -// } -// } -// }) -// }, -// -// fetchCollection: function( collection, _success, _error) { -// this.log( "fetchCollection" ); -// -// var db = this.db(), -// // retrive view name from 'url' of collection -// viewName = this.getView( collection ), -// // build query name -// query = this.ddocName + "/" + viewName; -// // if descending not defined set default false -// collection.descending || ( collection.descending = false ); -// -// options = { -// descending: collection.descending, -// success: function( result ) { -// var models = []; -// // for each result row, build model -// // compilant with backbone -// _.each( result.rows, function( row ) { -// var model = row.value; -// if ( !model.id ) { model.id = row.id } -// models.push( model ); -// }); -// // if no result then should result null -// if ( models.length == 0 ) { models = null } -// _success( models ); -// }, -// error: _error -// }; -// if (collection.limit) { options.limit = collection.limit; } -// db.view(query, options); -// -// var model = new collection.model; -// if (! model.url ) { -// throw new Error( "No 'url' property on collection.model!" ); -// } -// -// var type = this.getType(new collection.model); -// if ( !this._watchList[ type ] ) { -// this._watchList[ type ] = collection; -// } -// }, -// -// fetchModel: function( model, _success, _error) { -// this.log( "fetchModel" ); -// -// var db = this.db(); -// db.openDoc( model.id, { -// success: function(doc) { _success(doc); }, -// error: _error -// }); -// }, -// -// _changes: function() { -// this.log( "changesFeed" ); -// -// var db = this.db(), -// that = this, -// currentDdoc = "_design/" + this.ddocName; -// -// db.info( { -// success: function ( data ) { -// var since = ( data.update_seq || 0); -// that.changesFeed = db.changes( since, { include_docs: true } ); -// that.changesFeed.onChange( function( changes ) { -// _.each( changes.results, function( row ) { -// var doc = row.doc; -// var handlerDefined = typeof that.ddocChangeHandler === "function"; -// var id = ( doc.id || doc._id ); -// -// if ( handlerDefined && ( id === currentDdoc )) { -// that.ddocChangeHandler(currentDdoc); -// } -// -// console.log( doc); -// if ( doc.type ) { -// var collection = that._watchList[ doc.type ]; -// console.log(that._watchList); -// if ( collection ) { -// var model = collection.get( id ); -// if ( model ) { -// if ( model && doc._rev != model.get( "_rev" ) ) { -// model.set(doc); -// } -// } else { -// if ( !doc.id ) { doc.id = doc._id; } -// collection.add(doc); -// } -// } -// } -// }) -// }); -// }, -// error: function () { -// that.log("problem with db connection"); -// } -// }) -// }, -// -// ddocChange: function( callback ) { -// this.log( "ddocChange" ); -// this.ddocChangeHandler = callback; -// }, -// -// getView: function( collection ) { -// this.log( "getViewName" ); -// -// if (!( collection && collection.url )) { -// throw new Error( "No url property / function!" ); -// } -// // if url is function evaluate else use as value -// return _.isFunction( collection.url ) ? collection.url() : collection.url; -// } -//}; -// -//Backbone.sync = function(method, obj, success, error) { -// -// if ( method === "create" || method === "update" ) { -// // triggered on "model.save(...)" -// Backbone.couch.create( obj, success, error ); -// } else if ( method === "delete" ) { -// // triggered on "model.destroy(...)" -// Backbone.couch.remove( obj, success, error ); -// } else if ( method === "read" ) { -// // depends from where sync is called -// if ( obj.model ) { -// // triggered on "collection.fetch(...)" -// Backbone.couch.fetchCollection( obj, success, error ); -// } else { -// // triggered on "model.fetch(...)" -// Backbone.couch.fetchModel( obj, success, error ); -// } -// } -// -// // run changes changes feed handler -// if( Backbone.couch.enableChangesFeed && !Backbone.couch.changesFeed ) { -// Backbone.couch.changes(); -// } -//}; diff --git a/js/backbone.couch.js b/js/backbone.couch.js index b9b25b2..dbe54ef 100644 --- a/js/backbone.couch.js +++ b/js/backbone.couch.js @@ -1,223 +1,366 @@ -// Backbone.couch.js - literal version - (c) 2011 Andrzej Sliwa -// -// Based on Jan Monschke backbone.couchdb.js connector with some improvements. -// -// Example configuration: -// -// Backbone.couch.databaseName = "couchwatch"; -// Backbone.couch.ddocName = "couchwatch"; -// Backbone.couch.enableChangesFeed = true; -// Backbone.couch.ddocChange(function(ddocName){ -// console.log("current ddoc: '" + ddocName + "' changed"); -// console.log("restarting..."); -// window.location.reload(); -// }); +/** + * ______ _ _ ______ _ + * (____ \ | | | | / _____) | | + * ____) ) ____ ____| | _| | _ ___ ____ ____ | / ___ _ _ ____| | _ + * | __ ( / _ |/ ___) | / ) || \ / _ \| _ \ / _ ) | | / _ \| | | |/ ___) || \ + * | |__) | ( | ( (___| |< (| |_) ) |_| | | | ( (/ / _| \_____| |_| | |_| ( (___| | | | + * |______/ \_||_|\____)_| \_)____/ \___/|_| |_|\____|_)\______)\___/ \____|\____)_| |_| + * + * Backbone.couch.js v.0.0.1 - (c) 2011 Andrzej Sliwa + * + * May be freely distributed under the MIT license. + * + * Based on Jan Monschke backbone.couchdb.js connector with some improvements, + * reimplemented for learning purposes and for fixing existing problems with + * original connector, added new features required by personal use cases + * + * Example configuration: + * + * Backbone.couch.databaseName = "backbone-couch-test"; + * Backbone.couch.ddocName = "backbone-couch"; + * Backbone.couch.ddocChange(function(ddocName){ + * if (console && console.log) { + * console.log("current ddoc: '" + ddocName + "' changed"); + * console.log("restarting..."); + * } + * window.location.reload(); + * }); + * + * + */ +(function(){ + + if (typeof Backbone === 'undefined') { + new Error("Missing Backbone.js !!"); + } -Backbone.couch = { + Backbone.couch = { - debug: false, + // turn on/off logger + debug: false, - enableChangesFeed: true, + // enable / disable handling changes + enableChangesFeed: true, - databaseName : "", + // define database name + databaseName : null, - ddocName : "", + // define design doc name + ddocName : null, - baseUrl : null, + // define base url + baseUrl : null, - _watchList : [], + // list of collections to keep track + _watchList : {}, - db: function() { - this.log( "db" ); + /** + * return database instance + * + * @return couchdb database object + * @type Object + */ + db: function() { + this.log( "db" ); - var db = $.couch.db( this.databaseName ); - if ( this.baseUrl ) { - db.uri = this.baseUrl + "/" + this.databaseName + "/"; + if ( !this.databaseName ) { new Error("Missing Backbone.couch.databaseName configuration !!!"); } + if ( !this.ddocName ) { new Error("Missing Backbone.couch.ddocName configuration !!!"); } - } - return db; - }, + var db = $.couch.db( this.databaseName ); + if ( this.baseUrl ) { + db.uri = this.baseUrl + "/" + this.databaseName + "/"; - log: function ( message ) { - if ( this.debug && console && console.log ) { - console.log( "Backbone.couch - " + message ); - } - }, - - create: function( model, _success, _error ) { - this.log( "create" ); - - var db = this.db(), - data = model.toJSON(); - if ( !data.type ) { data.type = this.getType( model ); } - if ( !data.id && data._id ) { data.id = data._id; } - db.saveDoc( data, { - success: function( respone ){ - _success( { - "id": respone.id, - "_id": respone.id, - "_rev": respone.rev - }); - }, - error: _error - }); - }, - - getType: function( model ) { - return model.url; - }, - - remove: function( model, _success, _error ) { - this.log( "remove" ); - - var db = this.db(), - data = model.toJSON(); - - db.removeDoc(data, { - success: _success, - error: function (_nr, _req, e) { - if ( e == "deleted" ) { - _success(); - } else { - _error(); + } + return db; + }, + + /** + * show / suppress logger information depends from debug option + * + * @param message - string message + */ + log: function ( message ) { + if ( this.debug && console && console.log ) { + console.log( "Backbone.couch - " + message ); + } + }, + + /** + * create document based on backbone model + * + * @param {Backbone.Model} model backbone model + * @param {function} _success callback + * @param {function} _error callback + */ + create: function( model, _success, _error ) { + this.log( "create" ); + + var db = this.db(), + data = model.toJSON(); + if ( !data.type ) { data.type = this.getType( model ); } + if ( !data.id && data._id ) { data.id = data._id; } + db.saveDoc( data, { + success: function( respone ){ + _success( { + "id": respone.id, + "_id": respone.id, + "_rev": respone.rev + }); + }, + error: _error + }); + }, + + /** + * return type stored in model url property + * + * @param {Backbone.Model} model + * + * @return type of model + * @type String + */ + getType: function( model ) { + return model.url; + }, + + /** + * return view name from collection url property + * + * @param {Backbone.Model} collection + * + * @return name of view + * @type String + */ + getView: function( collection ) { + this.log( "getViewName" ); + + if (!( collection && collection.url )) { + throw new Error( "No url property / function!" ); + } + // if url is function evaluate else use as value + return _.isFunction( collection.url ) ? collection.url() : collection.url; + }, + + /** + * remove document from database based on removed backbone model + * + * @param {Backbone.Model} model + * @param {function} _success callback + * @param {function} _error callback + */ + remove: function( model, _success, _error ) { + this.log( "remove" ); + + var db = this.db(), + data = model.toJSON(); + + db.removeDoc(data, { + success: _success, + error: function (_nr, _req, e) { + if ( e == "deleted" ) { + _success(); + } else { + _error(); + } } + }) + }, + + /** + * fetch collection from couchdb + * + * @param {Backbone.Collection} collection + * @param {function} _success callback + * @param {function} _error callback + */ + fetchCollection: function( collection, _success, _error) { + this.log( "fetchCollection" ); + + var db = this.db(), + // retrive view name from 'url' of collection + viewName = this.getView( collection ), + // build query name + query = this.ddocName + "/" + viewName; + // if descending not defined set default false + collection.descending || ( collection.descending = false ); + + var options = { + descending: collection.descending, + success: function( result ) { + var models = []; + // for each result row, build model + // compilant with backbone + _.each( result.rows, function( row ) { + var model = row.value; + if ( !model.id ) { model.id = row.id } + models.push( model ); + }); + // if no result then should result null + if ( models.length == 0 ) { models = null } + _success( models ); + }, + error: _error + }; + if (collection.limit) { options.limit = collection.limit; } + db.view(query, options); + + var model = new collection.model; + if (! model.url ) { + throw new Error( "No 'url' property on collection.model!" ); } - }) - }, - - fetchCollection: function( collection, _success, _error) { - this.log( "fetchCollection" ); - - var db = this.db(), - // retrive view name from 'url' of collection - viewName = this.getView( collection ), - // build query name - query = this.ddocName + "/" + viewName; - // if descending not defined set default false - collection.descending || ( collection.descending = false ); - - var options = { - descending: collection.descending, - success: function( result ) { - var models = []; - // for each result row, build model - // compilant with backbone - _.each( result.rows, function( row ) { - var model = row.value; - if ( !model.id ) { model.id = row.id } - models.push( model ); - }); - // if no result then should result null - if ( models.length == 0 ) { models = null } - _success( models ); - }, - error: _error - }; - if (collection.limit) { options.limit = collection.limit; } - db.view(query, options); - - var model = new collection.model; - if (! model.url ) { - throw new Error( "No 'url' property on collection.model!" ); - } - var type = this.getType(new collection.model); - if ( !this._watchList[ type ] ) { - this._watchList[ type ] = collection; - } - }, - - fetchModel: function( model, _success, _error) { - this.log( "fetchModel" ); - - var db = this.db(); - db.openDoc( model.id, { - success: function(doc) { _success(doc); }, - error: _error - }); - }, - - _changes: function() { - this.log( "changesFeed" ); - - var db = this.db(), - that = this, - currentDdoc = "_design/" + this.ddocName; - - db.info( { - success: function ( data ) { - var since = ( data.update_seq || 0); - that.changesFeed = db.changes( since, { include_docs: true, limit:1 } ); - that.changesFeed.onChange( function( changes ) { - _.each( changes.results, function( row ) { - var doc = row.doc; - var handlerDefined = typeof that.ddocChangeHandler === "function"; - var id = ( doc.id || doc._id ); - - if ( handlerDefined && ( id === currentDdoc )) { - that.ddocChangeHandler(currentDdoc); - } - - if ( doc.type ) { - var collection = that._watchList[ doc.type ]; - if ( collection ) { - var model = collection.get( id ); - if ( model ) { - if ( model && doc._rev != model.get( "_rev" ) ) { - model.set(doc); + var type = this.getType(new collection.model); + if ( !this._watchList[ type ] ) { + this._watchList[ type ] = collection; + } + }, + + /** + * fetch model from couchdb + * + * @param {Backbone.Model} model + * @param {function} _success callback + * @param {function} _error callback + */ + fetchModel: function( model, _success, _error) { + this.log( "fetchModel" ); + + var db = this.db(); + db.openDoc( model.id, { + success: function(doc) { _success(doc); }, + error: _error + }); + }, + + /** + * run changes feed handler + * + */ + _changes: function() { + this.log( "changesFeed" ); + + var db = this.db(), + that = this, + currentDdoc = "_design/" + this.ddocName; + + db.info( { + success: function ( data ) { + var since = ( data.update_seq || 0); + that.changesFeed = db.changes( since, { include_docs: true, limit:10 } ); + that.changesFeed.onChange( function( changes ) { + _.each( changes.results, function( row ) { + var doc = row.doc; + var handlerDefined = typeof that.ddocChangeHandler === "function"; + var id = ( doc.id || doc._id ); + + if ( handlerDefined && ( id === currentDdoc )) { + that.ddocChangeHandler(currentDdoc); + } + + if ( doc.type ) { + var collection = that._watchList[ doc.type ]; + if ( collection ) { + var model = collection.get( id ); + if ( model ) { + if ( model && doc._rev != model.get( "_rev" ) ) { + model.set(doc); + } + } else { + if ( !doc.id ) { doc.id = doc._id; } + collection.add(doc); } - } else { - if ( !doc.id ) { doc.id = doc._id; } - collection.add(doc); } } - } - }) - }); - }, - error: function () { - that.log("problem with db connection"); + }) + }); + }, + error: function () { + that.log("problem with db connection"); + } + }) + }, + + /** + * add design doc change handler + * + * @param {function} callback + */ + ddocChange: function( callback ) { + this.log( "ddocChange" ); + this.ddocChangeHandler = callback; + // run changes feed handler if you have defined ddocChange callback + if ( this.db() ) { this.runChangesFeed(); } + }, + + /** + * remove all date from couchdb database + * except current design document. + */ + destroyAllData : function() { + this.log( "ddocChange" ); + + var db = this.db(), + currentDoc = "_design/" + this.ddocName; + + db.allDocs({ + success: function( result ) { + var docs = _.select( result.rows, function( doc ) { + return doc.id !== currentDoc; + }); + + if (docs.length > 0) { + var toRemove = _.map( docs, function( doc ) { + return { "_rev": doc.value.rev, "_id": doc.id }; + }); + db.bulkRemove({ docs:toRemove }, { + success: function() {}, + error: function() {} + }); + } + } + }); + }, + + /** + * run changes feed depends from options + */ + runChangesFeed: function() { + // run changes changes feed handler + if( Backbone.couch.enableChangesFeed && !Backbone.couch.changesFeed ) { + Backbone.couch._changes(); } - }) - }, - - ddocChange: function( callback ) { - this.log( "ddocChange" ); - this.ddocChangeHandler = callback; - }, - - getView: function( collection ) { - this.log( "getViewName" ); - - if (!( collection && collection.url )) { - throw new Error( "No url property / function!" ); } - // if url is function evaluate else use as value - return _.isFunction( collection.url ) ? collection.url() : collection.url; - } -}; - -Backbone.sync = function(method, obj, success, error) { - - if ( method === "create" || method === "update" ) { - // triggered on "model.save(...)" - Backbone.couch.create( obj, success, error ); - } else if ( method === "delete" ) { - // triggered on "model.destroy(...)" - Backbone.couch.remove( obj, success, error ); - } else if ( method === "read" ) { - // depends from where sync is called - if ( obj.model ) { - // triggered on "collection.fetch(...)" - Backbone.couch.fetchCollection( obj, success, error ); - } else { - // triggered on "model.fetch(...)" - Backbone.couch.fetchModel( obj, success, error ); + }; + + /** + * Overrides Backbone.sync function to change the manner in which Backbone persists + * models to the server. + * + * @param {String} method "create" | "update" | "delete" | "read" + * @param {Object} obj model or collection which should by synch + * @param {function} success callback + * @param {function} error callback + */ + Backbone.sync = function(method, obj, success, error) { + + if ( method === "create" || method === "update" ) { + // triggered on "model.save(...)" + Backbone.couch.create( obj, success, error ); + } else if ( method === "delete" ) { + // triggered on "model.destroy(...)" + Backbone.couch.remove( obj, success, error ); + } else if ( method === "read" ) { + // depends from where sync is called + if ( obj.model ) { + // triggered on "collection.fetch(...)" + Backbone.couch.fetchCollection( obj, success, error ); + } else { + // triggered on "model.fetch(...)" + Backbone.couch.fetchModel( obj, success, error ); + } } - } + // run changes feed handler if not run yet + Backbone.couch.runChangesFeed(); + }; - // run changes changes feed handler - if( Backbone.couch.enableChangesFeed && !Backbone.couch.changesFeed ) { - Backbone.couch._changes(); - } -}; +})(); diff --git a/js/vendor/backbone.js b/js/vendor/backbone.js new file mode 100644 index 0000000..581fd41 --- /dev/null +++ b/js/vendor/backbone.js @@ -0,0 +1,1012 @@ +// Backbone.js 0.3.3 +// (c) 2010 Jeremy Ashkenas, DocumentCloud Inc. +// Backbone may be freely distributed under the MIT license. +// For all details and documentation: +// http://documentcloud.github.com/backbone + +(function(){ + + // Initial Setup + // ------------- + + // The top-level namespace. All public Backbone classes and modules will + // be attached to this. Exported for both CommonJS and the browser. + var Backbone; + if (typeof exports !== 'undefined') { + Backbone = exports; + } else { + Backbone = this.Backbone = {}; + } + + // Current version of the library. Keep in sync with `package.json`. + Backbone.VERSION = '0.3.3'; + + // Require Underscore, if we're on the server, and it's not already present. + var _ = this._; + if (!_ && (typeof require !== 'undefined')) _ = require("underscore")._; + + // For Backbone's purposes, either jQuery or Zepto owns the `$` variable. + var $ = this.jQuery || this.Zepto; + + // Turn on `emulateHTTP` to use support legacy HTTP servers. Setting this option will + // fake `"PUT"` and `"DELETE"` requests via the `_method` parameter and set a + // `X-Http-Method-Override` header. + Backbone.emulateHTTP = false; + + // Turn on `emulateJSON` to support legacy servers that can't deal with direct + // `application/json` requests ... will encode the body as + // `application/x-www-form-urlencoded` instead and will send the model in a + // form param named `model`. + Backbone.emulateJSON = false; + + // Backbone.Events + // ----------------- + + // A module that can be mixed in to *any object* in order to provide it with + // custom events. You may `bind` or `unbind` a callback function to an event; + // `trigger`-ing an event fires all callbacks in succession. + // + // var object = {}; + // _.extend(object, Backbone.Events); + // object.bind('expand', function(){ alert('expanded'); }); + // object.trigger('expand'); + // + Backbone.Events = { + + // Bind an event, specified by a string name, `ev`, to a `callback` function. + // Passing `"all"` will bind the callback to all events fired. + bind : function(ev, callback) { + var calls = this._callbacks || (this._callbacks = {}); + var list = this._callbacks[ev] || (this._callbacks[ev] = []); + list.push(callback); + return this; + }, + + // Remove one or many callbacks. If `callback` is null, removes all + // callbacks for the event. If `ev` is null, removes all bound callbacks + // for all events. + unbind : function(ev, callback) { + var calls; + if (!ev) { + this._callbacks = {}; + } else if (calls = this._callbacks) { + if (!callback) { + calls[ev] = []; + } else { + var list = calls[ev]; + if (!list) return this; + for (var i = 0, l = list.length; i < l; i++) { + if (callback === list[i]) { + list.splice(i, 1); + break; + } + } + } + } + return this; + }, + + // Trigger an event, firing all bound callbacks. Callbacks are passed the + // same arguments as `trigger` is, apart from the event name. + // Listening for `"all"` passes the true event name as the first argument. + trigger : function(ev) { + var list, calls, i, l; + if (!(calls = this._callbacks)) return this; + if (list = calls[ev]) { + for (i = 0, l = list.length; i < l; i++) { + list[i].apply(this, Array.prototype.slice.call(arguments, 1)); + } + } + if (list = calls['all']) { + for (i = 0, l = list.length; i < l; i++) { + list[i].apply(this, arguments); + } + } + return this; + } + + }; + + // Backbone.Model + // -------------- + + // Create a new model, with defined attributes. A client id (`cid`) + // is automatically generated and assigned for you. + Backbone.Model = function(attributes, options) { + attributes || (attributes = {}); + if (this.defaults) attributes = _.extend({}, this.defaults, attributes); + this.attributes = {}; + this._escapedAttributes = {}; + this.cid = _.uniqueId('c'); + this.set(attributes, {silent : true}); + this._previousAttributes = _.clone(this.attributes); + if (options && options.collection) this.collection = options.collection; + this.initialize(attributes, options); + }; + + // Attach all inheritable methods to the Model prototype. + _.extend(Backbone.Model.prototype, Backbone.Events, { + + // A snapshot of the model's previous attributes, taken immediately + // after the last `"change"` event was fired. + _previousAttributes : null, + + // Has the item been changed since the last `"change"` event? + _changed : false, + + // Initialize is an empty function by default. Override it with your own + // initialization logic. + initialize : function(){}, + + // Return a copy of the model's `attributes` object. + toJSON : function() { + return _.clone(this.attributes); + }, + + // Get the value of an attribute. + get : function(attr) { + return this.attributes[attr]; + }, + + // Get the HTML-escaped value of an attribute. + escape : function(attr) { + var html; + if (html = this._escapedAttributes[attr]) return html; + var val = this.attributes[attr]; + return this._escapedAttributes[attr] = escapeHTML(val == null ? '' : val); + }, + + // Set a hash of model attributes on the object, firing `"change"` unless you + // choose to silence it. + set : function(attrs, options) { + // Extract attributes and options. + options || (options = {}); + if (!attrs) return this; + if (attrs.attributes) attrs = attrs.attributes; + var now = this.attributes, escaped = this._escapedAttributes; + + // Run validation. + if (!options.silent && this.validate && !this._performValidation(attrs, options)) return false; + + // Check for changes of `id`. + if ('id' in attrs) this.id = attrs.id; + + // Update attributes. + for (var attr in attrs) { + var val = attrs[attr]; + + if (!_.isEqual(now[attr], val)) { + now[attr] = val; + delete escaped[attr]; + if (!options.silent) { + this._changed = true; + this.trigger('change:' + attr, this, val, options); + } + } + } + + // Fire the `"change"` event, if the model has been changed. + if (!options.silent && this._changed) this.change(options); + return this; + }, + + // Remove an attribute from the model, firing `"change"` unless you choose + // to silence it. + unset : function(attr, options) { + options || (options = {}); + var value = this.attributes[attr]; + + // Run validation. + var validObj = {}; + validObj[attr] = void 0; + if (!options.silent && this.validate && !this._performValidation(validObj, options)) return false; + + // Remove the attribute. + delete this.attributes[attr]; + delete this._escapedAttributes[attr]; + if (!options.silent) { + this._changed = true; + this.trigger('change:' + attr, this, void 0, options); + this.change(options); + } + return this; + }, + + // Clear all attributes on the model, firing `"change"` unless you choose + // to silence it. + clear : function(options) { + options || (options = {}); + var old = this.attributes; + + // Run validation. + var validObj = {}; + for (attr in old) validObj[attr] = void 0; + if (!options.silent && this.validate && !this._performValidation(validObj, options)) return false; + + this.attributes = {}; + this._escapedAttributes = {}; + if (!options.silent) { + this._changed = true; + for (attr in old) { + this.trigger('change:' + attr, this, void 0, options); + } + this.change(options); + } + return this; + }, + + // 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 = {}); + var model = this; + var success = function(resp) { + if (!model.set(model.parse(resp), options)) return false; + if (options.success) options.success(model, resp); + }; + var error = wrapError(options.error, model, options); + (this.sync || Backbone.sync)('read', this, success, error); + return this; + }, + + // 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(attrs, options) { + options || (options = {}); + if (attrs && !this.set(attrs, options)) return false; + var model = this; + var success = function(resp) { + if (!model.set(model.parse(resp), options)) return false; + if (options.success) options.success(model, resp); + }; + var error = wrapError(options.error, model, options); + var method = this.isNew() ? 'create' : 'update'; + (this.sync || Backbone.sync)(method, this, success, error); + return this; + }, + + // Destroy this model on the server. Upon success, the model is removed + // from its collection, if it has one. + destroy : function(options) { + options || (options = {}); + var model = this; + var success = function(resp) { + if (model.collection) model.collection.remove(model); + if (options.success) options.success(model, resp); + }; + var error = wrapError(options.error, model, options); + (this.sync || Backbone.sync)('delete', this, success, error); + return this; + }, + + // Default URL for the model's representation on the server -- if you're + // using Backbone's restful methods, override this to change the endpoint + // that will be called. + url : function() { + var base = getUrl(this.collection); + if (this.isNew()) return base; + return base + (base.charAt(base.length - 1) == '/' ? '' : '/') + 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) { + return resp; + }, + + // Create a new model with identical attributes to this one. + clone : function() { + return new this.constructor(this); + }, + + // A model is new if it has never been saved to the server, and has a negative + // ID. + isNew : function() { + return !this.id; + }, + + // Call this method to manually fire a `change` event for this model. + // Calling this will cause all objects observing the model to update. + change : function(options) { + this.trigger('change', this, options); + this._previousAttributes = _.clone(this.attributes); + this._changed = false; + }, + + // 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) return this._previousAttributes[attr] != this.attributes[attr]; + return this._changed; + }, + + // 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. + changedAttributes : function(now) { + now || (now = this.attributes); + var old = this._previousAttributes; + var changed = false; + for (var attr in now) { + if (!_.isEqual(old[attr], now[attr])) { + changed = changed || {}; + changed[attr] = now[attr]; + } + } + return changed; + }, + + // Get the previous value of an attribute, recorded at the time the last + // `"change"` event was fired. + previous : function(attr) { + if (!attr || !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); + }, + + // Run validation against a set of incoming attributes, returning `true` + // if all is well. If a specific `error` callback has been passed, + // call that instead of firing the general `"error"` event. + _performValidation : function(attrs, options) { + var error = this.validate(attrs); + if (error) { + if (options.error) { + options.error(this, error); + } else { + this.trigger('error', this, error, options); + } + return false; + } + return true; + } + + }); + + // Backbone.Collection + // ------------------- + + // Provides a standard collection class for our sets of models, ordered + // or unordered. If a `comparator` is specified, the Collection will maintain + // its models in sort order, as they're added and removed. + Backbone.Collection = function(models, options) { + options || (options = {}); + if (options.comparator) { + this.comparator = options.comparator; + delete options.comparator; + } + this._boundOnModelEvent = _.bind(this._onModelEvent, this); + this._reset(); + if (models) this.refresh(models, {silent: true}); + this.initialize(models, options); + }; + + // Define the Collection's inheritable methods. + _.extend(Backbone.Collection.prototype, Backbone.Events, { + + // The default model for a collection is just a **Backbone.Model**. + // This should be overridden in most cases. + model : Backbone.Model, + + // Initialize is an empty function by default. Override it with your own + // initialization logic. + initialize : function(){}, + + // The JSON representation of a Collection is an array of the + // models' attributes. + toJSON : function() { + return this.map(function(model){ return model.toJSON(); }); + }, + + // Add a model, or list of models to the set. Pass **silent** to avoid + // firing the `added` event for every new model. + add : function(models, options) { + if (_.isArray(models)) { + for (var i = 0, l = models.length; i < l; i++) { + this._add(models[i], options); + } + } else { + this._add(models, options); + } + return this; + }, + + // Remove a model, or a list of models from the set. Pass silent to avoid + // firing the `removed` event for every model removed. + remove : function(models, options) { + if (_.isArray(models)) { + for (var i = 0, l = models.length; i < l; i++) { + this._remove(models[i], options); + } + } else { + this._remove(models, options); + } + return this; + }, + + // Get a model from the set by id. + get : function(id) { + if (id == null) return null; + return this._byId[id.id != null ? id.id : id]; + }, + + // Get a model from the set by client id. + getByCid : function(cid) { + return cid && this._byCid[cid.cid || cid]; + }, + + // Get the model at the given index. + at: function(index) { + return this.models[index]; + }, + + // Force the collection to re-sort itself. You don't need to call this under normal + // circumstances, as the set will maintain sort order as each item is added. + sort : function(options) { + options || (options = {}); + if (!this.comparator) throw new Error('Cannot sort a set without a comparator'); + this.models = this.sortBy(this.comparator); + if (!options.silent) this.trigger('refresh', 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); }); + }, + + // When you have more items than you want to add or remove individually, + // you can refresh the entire set with a new list of models, without firing + // any `added` or `removed` events. Fires `refresh` when finished. + refresh : function(models, options) { + models || (models = []); + options || (options = {}); + this._reset(); + this.add(models, {silent: true}); + if (!options.silent) this.trigger('refresh', this, options); + return this; + }, + + // Fetch the default set of models for this collection, refreshing the + // collection when they arrive. + fetch : function(options) { + options || (options = {}); + var collection = this; + var success = function(resp) { + collection.refresh(collection.parse(resp)); + if (options.success) options.success(collection, resp); + }; + var error = wrapError(options.error, collection, options); + (this.sync || Backbone.sync)('read', this, success, error); + return this; + }, + + // Create a new instance of a model in this collection. After the model + // has been created on the server, it will be added to the collection. + create : function(model, options) { + var coll = this; + options || (options = {}); + if (!(model instanceof Backbone.Model)) { + model = new this.model(model, {collection: coll}); + } else { + model.collection = coll; + } + var success = function(nextModel, resp) { + coll.add(nextModel); + if (options.success) options.success(nextModel, resp); + }; + return model.save(null, {success : success, error : options.error}); + }, + + // **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) { + 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(); + }, + + // Reset all internal state. Called when the collection is refreshed. + _reset : function(options) { + this.length = 0; + this.models = []; + this._byId = {}; + this._byCid = {}; + }, + + // Internal implementation of adding a single model to the set, updating + // hash indexes for `id` and `cid` lookups. + _add : function(model, options) { + options || (options = {}); + if (!(model instanceof Backbone.Model)) { + model = new this.model(model, {collection: this}); + } + var already = this.getByCid(model); + if (already) throw new Error(["Can't add the same model to a set twice", already.id]); + this._byId[model.id] = model; + this._byCid[model.cid] = model; + model.collection = this; + var index = this.comparator ? this.sortedIndex(model, this.comparator) : this.length; +// console.log(this.sortedIndex(model, this.comparator)) + this.models.splice(index, 0, model); + model.bind('all', this._boundOnModelEvent); + this.length++; + if (!options.silent) model.trigger('add', model, this, options); + return model; + }, + + // Internal implementation of removing a single model from the set, updating + // hash indexes for `id` and `cid` lookups. + _remove : function(model, options) { + options || (options = {}); + model = this.getByCid(model) || this.get(model); + if (!model) return null; + delete this._byId[model.id]; + delete this._byCid[model.cid]; + delete model.collection; + this.models.splice(this.indexOf(model), 1); + this.length--; + if (!options.silent) model.trigger('remove', model, this, options); + model.unbind('all', this._boundOnModelEvent); + return model; + }, + + // Internal method called every time a model in the set fires an event. + // Sets need to update their indexes when models change ids. All other + // events simply proxy through. + _onModelEvent : function(ev, model) { + if (ev === 'change:id') { + delete this._byId[model.previous('id')]; + this._byId[model.id] = model; + } + this.trigger.apply(this, arguments); + } + + }); + + // 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', + 'invoke', 'max', 'min', 'sortBy', 'sortedIndex', 'toArray', 'size', + 'first', 'rest', 'last', 'without', 'indexOf', 'lastIndexOf', 'isEmpty']; + + // Mix in each Underscore method as a proxy to `Collection#models`. + _.each(methods, function(method) { + Backbone.Collection.prototype[method] = function() { + return _[method].apply(_, [this.models].concat(_.toArray(arguments))); + }; + }); + + // Backbone.Controller + // ------------------- + + // Controllers map faux-URLs to actions, and fire events when routes are + // matched. Creating a new one sets its `routes` hash, if not set statically. + Backbone.Controller = function(options) { + options || (options = {}); + if (options.routes) this.routes = options.routes; + this._bindRoutes(); + this.initialize(options); + }; + + // Cached regular expressions for matching named param parts and splatted + // parts of route strings. + var namedParam = /:([\w\d]+)/g; + var splatParam = /\*([\w\d]+)/g; + + // Set up all inheritable **Backbone.Controller** properties and methods. + _.extend(Backbone.Controller.prototype, Backbone.Events, { + + // Initialize is an empty function by default. Override it with your own + // initialization logic. + initialize : function(){}, + + // Manually bind a single named route to a callback. For example: + // + // this.route('search/:query/p:num', 'search', function(query, num) { + // ... + // }); + // + route : function(route, name, callback) { + Backbone.history || (Backbone.history = new Backbone.History); + if (!_.isRegExp(route)) route = this._routeToRegExp(route); + Backbone.history.route(route, _.bind(function(fragment) { + var args = this._extractParameters(route, fragment); + callback.apply(this, args); + this.trigger.apply(this, ['route:' + name].concat(args)); + }, this)); + }, + + // Simple proxy to `Backbone.history` to save a fragment into the history, + // without triggering routes. + saveLocation : function(fragment) { + Backbone.history.saveLocation(fragment); + }, + + // Bind all defined routes to `Backbone.history`. + _bindRoutes : function() { + if (!this.routes) return; + for (var route in this.routes) { + var name = this.routes[route]; + this.route(route, name, this[name]); + } + }, + + // Convert a route string into a regular expression, suitable for matching + // against the current location fragment. + _routeToRegExp : function(route) { + route = route.replace(namedParam, "([^\/]*)").replace(splatParam, "(.*?)"); + return new RegExp('^' + route + '$'); + }, + + // Given a route, and a URL fragment that it matches, return the array of + // extracted parameters. + _extractParameters : function(route, fragment) { + return route.exec(fragment).slice(1); + } + + }); + + // Backbone.History + // ---------------- + + // Handles cross-browser history management, based on URL hashes. If the + // browser does not support `onhashchange`, falls back to polling. + Backbone.History = function() { + this.handlers = []; + this.fragment = this.getFragment(); + _.bindAll(this, 'checkUrl'); + }; + + // Cached regex for cleaning hashes. + var hashStrip = /^#*/; + + // Set up all inheritable **Backbone.History** properties and methods. + _.extend(Backbone.History.prototype, { + + // The default interval to poll for hash changes, if necessary, is + // twenty times a second. + interval: 50, + + // Get the cross-browser normalized URL fragment. + getFragment : function(loc) { + return (loc || window.location).hash.replace(hashStrip, ''); + }, + + // Start the hash change handling, returning `true` if the current URL matches + // an existing route, and `false` otherwise. + start : function() { + var docMode = document.documentMode; + var oldIE = ($.browser.msie && (!docMode || docMode <= 7)); + if (oldIE) { + this.iframe = $('