Add LocalStorage store, fix more unit tests on other browsers, fix caching

of queries

Author: kriszyp

LocalDB.js

@@ -1,4 +1,4 @@
-define(['./db/has!indexeddb?./db/IndexedDB:./db/SQL'],
+define(['./db/has!indexeddb?./db/IndexedDB:sql?./db/SQL:./db/LocalStorage'],
 	function(LocalDB){
 	//	module:
 	//		./store/LocalDB

QueryResults.js

@@ -2,7 +2,7 @@ define(['dojo/_base/lang', 'dojo/when'], function (lang, when) {
 	function forEach(callback, instance) {
 		return when(this, function(data) {
 			for (var i = 0, l = data.length; i < l; i++){
-				callback.call(instance, data[i], data);
+				callback.call(instance, data[i], i, data);
 			}
 		});
 	}
@@ -18,7 +18,9 @@ define(['dojo/_base/lang', 'dojo/when'], function (lang, when) {
 						data.totalLength || data.length;
 				// make it available on the resolved data
 				data.totalLength = totalLength;
-				return totalLength;
+				// don't return the totalLength promise unless we need to, to avoid
+				// triggering a lazy promise
+				return !hasTotalLength && totalLength;
 			});
 			// make the totalLength available on the promise (whether through the options or the enventual
 			// access to the resolved data)

Store.js

@@ -121,8 +121,8 @@ define([
 		forEach: function (callback, thisObject) {
 			var collection = this;
 			return when(this.fetch(), function (data) {
-				for (var i = 0, l = data.length; i < l; i++) {
-					callback.call(thisObject, data[i], i, collection);
+				for (var i = 0, item; (item = data[i]) !== undefined; i++) {
+					callback.call(thisObject, item, i, collection);
 				}
 				return data;
 			});

db/IndexedDB.js

@@ -447,12 +447,14 @@ define([
 			var filter;
 			var union;
 			var filterQuery = {};
+			var filterOperator;
 			var sortOption;
 			// iterate through the query log, applying each querier
 			this.queryLog.forEach(function (entry) {
 				var type = entry.type;
 				var args = entry.normalizedArguments;
 				if (type === 'filter') {
+					filterOperator = args;
 					var oldFilter = filter;
 					filter = oldFilter ? function (data) {
 						return entry.querier(oldFilter(data));
@@ -583,6 +585,7 @@ define([
 			return {
 				filter: union || filterQuery,
 				filterFunction: filter,
+				filterOperator: filterOperator || null,
 				sort: sortOption
 			};
 		},
@@ -646,7 +649,7 @@ define([
 				var value = filterQuery[key];
 				tryIndex(key, null, value && (value.from || value.to) ? 0.1 : 1);
 			}
-			var queryId = JSON.stringify(filterQuery) + '-' + JSON.stringify(sortOption);
+			var queryId = JSON.stringify(query.filterOperator) + '-' + JSON.stringify(sortOption);
 
 			var descending;
 			if (sortOption) {

db/LocalStorage.js

@@ -0,0 +1,36 @@
+define([
+	'dojo/_base/declare',
+	'../Memory'
+],
+function(declare, Memory) {
+	// a very simple localStorage-based store, that basically loads everything
+	// in memory and executes on it there. localStorage doesn't really provide
+	// any real querying functionality, so might just as well do it all in memory
+	return declare([Memory], {
+		dbPrefix: 'dojo-db',
+		storeName: 'default',
+		constructor: function () {
+			// load all the data from the local storage
+			var data = [];
+			var prefix = this.prefix = this.dbPrefix + '-' + this.storeName + '-';
+			for (var i = 0, l = localStorage.length; i < l; i++) {
+				var key = localStorage.key(i);
+				if (key.slice(0, prefix.length) === prefix) {
+					data.push(JSON.parse(localStorage.getItem(key)));
+				}
+			}
+			this.setData(data);
+		},
+		putSync: function (object) {
+			// addSync and all the async update methods eventually go through this
+			var result = this.inherited(arguments);
+			// prefix and store
+			localStorage.setItem(this.prefix + this.getIdentity(object), JSON.stringify(object));
+			return result;
+		},
+		removeSync: function (id) {
+			localStorage.removeItem(this.prefix + id);
+			return this.inherited(arguments);
+		}
+	});
+});

tests/LocalStorage.js

@@ -2,10 +2,11 @@ define([
 	'intern!object',
 	'intern/chai!assert',
 	'../db/has!indexeddb?../db/IndexedDB',
-	'../db/SQL',
+	'../db/has!sql?../db/SQL',
+	'../db/LocalStorage',
 	'dojo/promise/all',
 	'dojo/sniff'
-], function (registerSuite, assert, IndexedDB, SQL, all, has) {
+], function (registerSuite, assert, IndexedDB, SQL, LocalStorage, all, has) {
 	var data = [
 		{id: 1, name: 'one', prime: false, mappedTo: 'E', words: ['banana']},
 		{id: 2, name: 'two', even: true, prime: true, mappedTo: 'D', words: ['banana', 'orange']},
@@ -39,6 +40,7 @@ define([
 	if (window.openDatabase) {
 		registerSuite(testsForDB('dstore/db/SQL', SQL));
 	}
+	registerSuite(testsForDB('dstore/db/LocalStorage', LocalStorage));
 	function testsForDB(name, DB) {
 		// need to reset availability
 		dbConfig.available = null;
@@ -73,15 +75,15 @@ define([
 						});
 					}
 				}
-				var forEachResults = collection.forEach(function(object) {
+				var forEachResults = collection.forEach(function (object) {
 					console.log("id check", i, results[i], object.id);
 					assert.strictEqual(results[i++], object.id);
 				});
 				return forEachResults.then(function () {
 					console.log("results", results);
 					assert.strictEqual(results.length, i);
 					if (options && options.range) {
-						return forEachResults.totalLength.then(function(total) {
+						return forEachResults.totalLength.then(function (total) {
 							assert.strictEqual(results.length, total);
 						});
 					}
@@ -92,10 +94,12 @@ define([
 			name: name,
 			setup: function () {
 				var results = [];
-				return db.forEach(function(object) {
-					// clear the data
-					results.push(db.remove(object.id));
-				}).then(function() {
+				return db.fetch().then(function (data) {
+					// make a copy
+					data = data.slice(0);
+					for (var i = 0, l = data.length; i < l; i++) {
+						results.push(db.remove(data[i].id));
+					}
 					return all(results);
 				}).then(function() {
 					results = [];
@@ -158,11 +162,26 @@ define([
 							db.add({id: 6, name: 'six', prime: false, words: ['pineapple', 'orange juice']})
 						]).then(function() {
 						return all([
-							testQuery(new Filter().gte('name', 's').lte('name', 'u'), [6, 3])(),
+							testQuery(new Filter().gte('name', 's').lte('name', 'u'), {sort:[{property: 'id'}]}, [3, 6])(),
 							testQuery(new Filter().contains('words', [new Filter().match('words', /^orange/)]), {multi: true}, [3, 6])()
 						]);
 					});
 				});
+			},
+			'reload db': function () {
+				// reload the DB store and make sure the data is still there
+				dbConfig.openRequest = null;
+				db = new DB({dbConfig: dbConfig, storeName: 'test'});
+				return db.get(1).then(function(one) {
+					assert.strictEqual(one.id, 1);
+					assert.strictEqual(one.name, 'one');
+					assert.strictEqual(one.prime, false);
+					assert.strictEqual(one.mappedTo, 'E');
+					return all([
+						testQuery(new Filter().gte('name', 's').lte('name', 'u'), {sort:[{property: 'id'}]}, [3, 6])(),
+						testQuery(new Filter().contains('words', [new Filter().match('words', /^orange/)]), {multi: true}, [3, 6])()
+					]);
+				});
 			}
 
 		};