kojac 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: b718cc81d1c3dedf9f6a4e92a627a92214a0d118
-  data.tar.gz: aec9fe24896b2965108f802c435861f5b7db5f0e
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjYzYzc3ZjM3NmE1ODk3MDE0NDg0MTMwODA0MmUyOGM0OWRkNjY5YQ==
+  data.tar.gz: !binary |-
+    MGQzZDFmYzc4MjUzY2I1MTcwMWI3ODNlZTc1OTQ3YWMzNzk1ZmNlYQ==
 SHA512:
-  metadata.gz: 0bfff9ecf7789c0ad74e4aaf4d90062e8a565d2800199080e7d11daef67b9f0882eff16ddad1d54aef3da9ccfb0af1aa6c75379a6d1dd7d456a95b8db704bc2f
-  data.tar.gz: a8c65fb7708a6eddd730fecbf58984c87528fbca403260a0ca895340058868794f5850755282cd0ec7824b270f55e2926cf70f7f80a1546f38853b8c9124e91d
+  metadata.gz: !binary |-
+    MDEzMDliZTE1YzIwY2FmZTQwMGJlYWUzODA1YjUyNGYzYzA0N2U5M2U4YjAw
+    MjA2MTM3ODhiNjQzZmIwOWZmOTU1NGIwNTQwZjFkYmFiOWViYjQ1Njc1M2Fj
+    ODcxYWM4MGQzMzE5NTBkYWY4ZWRkZmJlNGQwNWNjMTkyZjA1YWM=
+  data.tar.gz: !binary |-
+    YzJlNTE1YTdhNmM3MmZkMTJjZjliZWRiY2Y5ZWMwODdlOGFkZDQ3OTRlMzY1
+    NjU1ZGQ4ZDM5YWVjMjc3OTY2YzJhNzk1NTAwYWY1YWIyMGZiZjg3ZjcxMTRm
+    MGRkM2ZhZTQ5ZWNlNWE1ZjlkNTM1MWY1MmIzMGIxNjVjMzhmMDA=

data/app/assets/javascripts/kojac.js

@@ -1,7 +1,7 @@
 /*--------------------------------------------------------------------------
  *
  *	Key Oriented JSON Application Cache (KOJAC)
- *	(c) 2011-12 Buzzware Solutions
+ *	(c) 2011-14 Buzzware Solutions
  *  https://github.com/buzzware/KOJAC
  *
  *	KOJAC is freely distributable under the terms of an MIT-style license.
@@ -328,7 +328,10 @@ Kojac.interpretValueAsType = function(aValue, aDestType) {
 					return aValue;
 					break;
 				case String:
-					return Number(aValue);
+					if (aValue.trim()=='')
+						return null;
+					var n = Number(aValue);
+					return isFinite(n) ? n : null;
 					break;
 			}
 			break;
@@ -344,13 +347,13 @@ Kojac.interpretValueAsType = function(aValue, aDestType) {
 					return aValue ? 1 : 0;
 					break;
 				case Number:
-					if (isNaN(aValue))
-						return null;
-					else
-						return Math.round(aValue);
+					return isFinite(aValue) ? Math.round(aValue) : null;
 					break;
 				case String:
-					return Math.round(Number(aValue));
+					if (aValue.trim()=='')
+						return null;
+					var n = Number(aValue);
+					return isFinite(n) ? Math.round(n) : null;
 					break;
 			}
 
@@ -452,7 +455,7 @@ keySplit = function(aKey) {
 	parts = ia.split('.');
 	if (parts.length>=1) {    // id
 		id = parts[0];
-		var id_as_i = Number(id);
+		var id_as_i = Number(id); // !!! watch for Number('') => 0
 		if (_.isFinite(id_as_i))
 			id = id_as_i;
 		result.push(id);
@@ -741,8 +744,8 @@ Kojac.Operation = Kojac.Object.extend({
 		} else if (aResponseOp.error) {
 			this.error = aResponseOp.error;
 		} else {
-			var request_key = this.result_key || this.key;
-			var response_key = aResponseOp.result_key || this.key;
+			var request_key = this.key;
+			var response_key = aResponseOp.result_key || aResponseOp.key || this.key;
 			var final_result_key = this.result_key || response_key; // result_key should not be specified unless trying to override
 			var results = _.isObjectStrict(aResponseOp.results) ? aResponseOp.results : _.createObject(response_key,aResponseOp.results); // fix up server mistake
 			var result;
@@ -768,6 +771,7 @@ Kojac.Operation = Kojac.Object.extend({
  */
 Kojac.Request = Kojac.Object.extend({
 		kojac: null,
+		chaining: false,
 		options: {},
 		ops: [],
 		handlers: null,
@@ -811,9 +815,12 @@ Kojac.Request = Kojac.Object.extend({
 					op.key = keyResource(k);
 				if ((i===0) && result_key)
 					op.result_key = result_key;
-				op.value = v;
+				op.value = Kojac.Utils.toJsono(v,op.options);
 			}
-			return this;
+			if (this.chaining)
+				return this;
+			else
+				return this.request();
 		},
 
 		// !!! if aKeys is String, split on ',' into an array
@@ -835,7 +842,10 @@ Kojac.Request = Kojac.Object.extend({
 				else
 					op.result_key = k;
 			});
-			return this;
+			if (this.chaining)
+				return this;
+			else
+				return this.request();
 		},
 
 		cacheRead: function(aKeys,aOptions) {
@@ -862,9 +872,12 @@ Kojac.Request = Kojac.Object.extend({
 					first = false;
 				} else
 					op.result_key = k;
-				op.value = v;
+				op.value = Kojac.Utils.toJsono(v,op.options);
 			};
-			return this;
+			if (this.chaining)
+				return this;
+			else
+				return this.request();
 		},
 
 		destroy: function(aKeys,aOptions) {
@@ -884,7 +897,10 @@ Kojac.Request = Kojac.Object.extend({
 				else
 					op.result_key = k;
 			});
-			return this;
+			if (this.chaining)
+				return this;
+			else
+				return this.request();
 		},
 
 		execute: function(aKey,aValue,aOptions) {
@@ -896,12 +912,20 @@ Kojac.Request = Kojac.Object.extend({
 			op.options = _.extend({cacheResults: false, manufacture: false},aOptions || {});
 			op.params = (params && _.clone(params));
 			op.key = aKey;
-			op.value = aValue;
-			return this;
+			op.value = Kojac.Utils.toJsono(aValue,op.options);
+			if (this.chaining)
+				return this;
+			else
+				return this.request();
 		},
 
-		request: function() {
-			return this.kojac.performRequest(this);
+		request: function(aDone) {
+			var result = this.kojac.performRequest(this);
+			if (aDone)
+				result = result.done(aDone);			
+			if (this.kojac.errorHandler)
+				result = result.fail(this.kojac.errorHandler);
+			return result;
 		}
 });
 
@@ -909,16 +933,58 @@ Kojac.Request = Kojac.Object.extend({
  * The Kojac core object
  * @class Kojac.Core
  * @extends Kojac.Object
+ *
+ * Normal API V2 Usage
+ *
+ * App = {};
+ * App.cache = {};
+ * App.kojac = new Kojac.Core({
+ *  remoteProvider: ...,
+ *  cache: App.cache
+ * });
+ *
+ * App.kojac.read('products').done(...);
+ * App.kojac.chain().create('products').execute('refresh').request(function(aKR){   // using optional done handler
+ *   // handle done here
+ * }).fail(function(aKR){
+ *   // handle fail here
+ * });
+ *
+ * Old API V1 usage
+ *
+ * App = {};
+ * App.cache = {};
+ * App.kojac = new Kojac.Core({
+ *  remoteProvider: ...,
+ *  cache: App.cache,
+ *  apiVersion: 1
+ * });
+ *
+ * App.kojac.readRequest('products').done(...);
+ * App.kojac.create('products').execute('refresh').request().done(function(aKR){
+ *   // handle done here
+ * }).fail(function(aKR){
+ *   // handle fail here
+ * });
+ *
  */
 Kojac.Core = Kojac.Object.extend({
 
 		remoteProvider: null,
 		objectFactory: null,
 		cache: null,
+		errorHandler: null,
 		dependentKeys: {},
-
-		newRequest: function() {
-			return new Kojac.Request({kojac: this});
+		apiVersion: 2,      // set this to 1 for old read() and readRequest()
+
+		newRequest: function(aOptions) {
+			if (!aOptions)
+				aOptions = {};
+			aOptions = _.extend(aOptions,{kojac: this});
+			if (!(this.chaining in aOptions)) {
+				aOptions.chaining = this.apiVersion < 2
+			}
+			return new Kojac.Request(aOptions);
 		},
 
 //			var v;
@@ -960,9 +1026,9 @@ Kojac.Core = Kojac.Object.extend({
 
 					for (var key in op.results) {
 						var value = op.results[key];
-						if ((op.options.atomise!==false) && _.isObjectStrict(value)) {
+						if ((op.options.atomise!==false) && _.isObjectStrict(value)) {  // we are atomising and this is an object
 							var existing = this.cache.retrieve(key);
-							if (_.isObjectStrict(existing)) {
+							if (_.isObjectStrict(existing) && (op.options.cacheResults!==false)) {         // object is already in cache, and we are caching, so update it
 								if (existing.beginPropertyChanges) {
 									existing.beginPropertyChanges();
 									updatedObjects.push(existing);
@@ -972,9 +1038,17 @@ Kojac.Core = Kojac.Object.extend({
 								else
 									_.copyProperties(existing,value);
 								value = existing;
-							} else {
-								if ((op.options.manufacture!==false) && (this.objectFactory))
-									value = this.objectFactory.manufacture(value,key);
+							} else {                                                                      // otherwise manufacture
+								if ((op.options.manufacture!==false) && (this.objectFactory)) {
+									// if primary key & reassigned by result_key then manufacture with original key
+									var mkey = key;   // use the key from results by default
+									if (key === op.result_key) {  // this is the result key, so may have been renamed
+										var has_dot = op.key.indexOf('.') >= 0; // prefer original key unless it contains a dot
+										if (!has_dot)
+											mkey = op.key;
+									}
+									value = this.objectFactory.manufacture(value,mkey);
+								}
 							}
 						}
 						op.results[key] = value;
@@ -1063,28 +1137,21 @@ Kojac.Core = Kojac.Object.extend({
 		// BEGIN User Functions
 
 		// These functions enable the user to build and trigger requests to the server/remote provider
-		// eg. kojac.read('cur_super').read('cur_super_products').request()
-		// or  kojac.readRequest('cur_super','cur_super_products')
+
+		chain: function() {
+			return this.newRequest({chaining: true});
+		},
 
 		create: function(aKeyValues,aOptions) {
 			var req = this.newRequest();
 			return req.create(aKeyValues,aOptions);
 		},
-		createRequest: function(aKeyValues,aOptions) {
-			return this.create(aKeyValues,aOptions).request();
-		},
 
 		read: function(aKeys,aOptions) {
 			var req = this.newRequest();
 			return req.read(aKeys,aOptions);
 		},
-		readRequest: function(aKeys,aOptions) {
-			return this.read(aKeys,aOptions).request();
-		},
-		cacheReadRequest: function(aKeys,aOptions) {
-			aOptions = _.extend({},aOptions,{preferCache: true});
-			return this.read(aKeys,aOptions).request();
-		},
+
 		cacheRead: function(aKeys,aOptions) {
 			aOptions = _.extend({},aOptions,{preferCache: true});
 			return this.read(aKeys,aOptions);
@@ -1094,26 +1161,51 @@ Kojac.Core = Kojac.Object.extend({
 			var req = this.newRequest();
 			return req.update(aKeyValues,aOptions);
 		},
-		updateRequest: function(aKeyValues,aOptions) {
-			return this.update(aKeyValues,aOptions).request();
-		},
 
 		destroy: function(aKeys,aOptions) {
 			var req = this.newRequest();
 			return req.destroy(aKeys,aOptions);
 		},
-		destroyRequest: function(aKeys,aOptions) {
-			return this.destroy(aKeys,aOptions).request();
-		},
 
 		execute: function(aKey,aValue,aOptions) {
 			var req = this.newRequest();
 			return req.execute(aKey,aValue,aOptions);
 		},
+		// END Convenience Functions
+
+		// BEGIN DEPRECATED API V1 FUNCTIONS
+		createRequest: function(aKeyValues,aOptions) {
+			if (this.apiVersion > 1)
+				throw "*Request methods are deprecated, and only supported when apiVersion is 1";
+			return this.create(aKeyValues,aOptions).request();
+		},
+		readRequest: function(aKeys,aOptions) {
+			if (this.apiVersion > 1)
+				throw "*Request methods are deprecated, and only supported when apiVersion is 1";
+			return this.read(aKeys,aOptions).request();
+		},
+		cacheReadRequest: function(aKeys,aOptions) {
+			if (this.apiVersion > 1)
+				throw "*Request methods are deprecated, and only supported when apiVersion is 1";
+			aOptions = _.extend({},aOptions,{preferCache: true});
+			return this.read(aKeys,aOptions).request();
+		},
+		updateRequest: function(aKeyValues,aOptions) {
+			if (this.apiVersion > 1)
+				throw "*Request methods are deprecated, and only supported when apiVersion is 1";
+			return this.update(aKeyValues,aOptions).request();
+		},
+		destroyRequest: function(aKeys,aOptions) {
+			if (this.apiVersion > 1)
+				throw "*Request methods are deprecated, and only supported when apiVersion is 1";
+			return this.destroy(aKeys,aOptions).request();
+		},
 		executeRequest: function(aKey,aValue,aOptions) {
+			if (this.apiVersion > 1)
+				throw "*Request methods are deprecated, and only supported when apiVersion is 1";
 			return this.execute(aKey,aValue,aOptions).request();
 		}
-		// END Convenience Functions
+		// END DEPRECATED API V1 FUNCTIONS
 });
 
 Kojac.Cache = Kojac.Object.extend({
@@ -1438,6 +1530,7 @@ Kojac.LocalStorageRemoteProvider = Kojac.Object.extend({
  */
 Kojac.ObjectFactory = Kojac.Object.extend({
 
+	namespace: null,
 	matchers: null,
 	defaultClass: Object,
 
@@ -1462,7 +1555,13 @@ Kojac.ObjectFactory = Kojac.Object.extend({
 			newClass = pair[1];
 			break;
 		}
-		if (newClass===undefined)
+		if (!newClass) {
+			var ns = this.namespace || Window;
+			var r = keyResource(aKey);
+			if (r && (r[0]==r[0].toUpperCase()) && _.isFunction(ns[r]))
+				newClass = ns[r];
+		}
+		if (!newClass)
 			newClass = this.defaultClass;
 		return newClass;
 	},
@@ -1472,27 +1571,18 @@ Kojac.ObjectFactory = Kojac.Object.extend({
 		return new aClass(aProperties);
 	},
 
-	copyProperties: function(aDest,aSource) {
-		return _.extend(aDest,aSource);
-	},
-
 	manufacture: function(aObject,aKey) {
 		var newClass = this.classFromKey(aKey);
-		var result;
-		var me = this;
+		var result = [];
 		if (_.isArray(aObject)) {
-			result = [];
 			for (var i=0; i<aObject.length; i++) {
-				var newv = me.createInstance(newClass,aObject[i]);
+				var newv = this.createInstance(newClass,aObject[i]);
 				result.push(newv);
 			}
 		} else {
-			var newClass = this.classFromKey(aKey);
-			result = me.createInstance(newClass,aObject);
+			result = this.createInstance(newClass,aObject);
 		}
-		console.log('END manufacture');
 		return result;
 	}
-
 });