Backport js-data/js-data-angular#145.

Backport js-data/js-data-angular#156.
Backport js-data/js-data-angular#167.

Author: jmdobry

CHANGELOG.md

@@ -0,0 +1,8 @@
+##### 0.1.0 - xx September 2014
+
+###### Backwards compatible API changes
+- jmdobry/angular-data#145 - Add "useClass" option to inject, find, findAll, create
+- jmdobry/angular-data#167 - Default params argument of bindAll to empty object
+
+###### Backwards compatible bug fixes
+- jmdobry/angular-data#156 - cached findAll pending query doesn't get removed sometimes

dist/js-data.js

@@ -3994,6 +3994,7 @@ function errorPrefix(resourceName) {
  * @param {object} attrs The attributes with which to create the item of the type specified by `resourceName`.
  * @param {object=} options Configuration options. Also passed along to the adapter's `create` method. Properties:
  *
+ * - `{boolean=}` - `useClass` - Whether to wrap the injected item with the resource's instance constructor.
  * - `{boolean=}` - `cacheResponse` - Inject the data returned by the adapter into the data store. Default: `true`.
  * - `{boolean=}` - `upsert` - If `attrs` already contains a primary key, then attempt to call `DS.update` instead. Default: `true`.
  * - `{function=}` - `beforeValidate` - Override the resource or global lifecycle hook.
@@ -4076,7 +4077,7 @@ function create(resourceName, attrs, options) {
           resource.saved[id] = DSUtils.updateTimestamp(resource.saved[id]);
           return DS.get(definition.name, id);
         } else {
-          return data;
+          return DS.createInstance(resourceName, data, options);
         }
       });
   }
@@ -4292,6 +4293,7 @@ function errorPrefix(resourceName, id) {
  * @param {string|number} id The primary key of the item to retrieve.
  * @param {object=} options Optional configuration. Also passed along to the adapter's `find` method. Properties:
  *
+ * - `{boolean=}` - `useClass` - Whether to wrap the injected item with the resource's instance constructor.
  * - `{boolean=}` - `bypassCache` - Bypass the cache. Default: `false`.
  * - `{boolean=}` - `cacheResponse` - Inject the data returned by the adapter into the data store. Default: `true`.
  *
@@ -4347,7 +4349,7 @@ function find(resourceName, id, options) {
                 resource.completedQueries[id] = new Date().getTime();
                 return DS.inject(resourceName, data, options);
               } else {
-                return data;
+                return DS.createInstance(resourceName, data, options);
               }
             }).catch(function (err) {
               delete resource.pendingQueries[id];
@@ -4447,6 +4449,7 @@ function processResults(data, resourceName, queryHash, options) {
  *
  * @param {object=} options Optional configuration. Also passed along to the adapter's `findAll` method. Properties:
  *
+ * - `{boolean=}` - `useClass` - Whether to wrap the injected item with the resource's instance constructor.
  * - `{boolean=}` - `bypassCache` - Bypass the cache. Default: `false`.
  * - `{boolean=}` - `cacheResponse` - Inject the data returned by the adapter into the data store. Default: `true`.
  *
@@ -4509,6 +4512,9 @@ function findAll(resourceName, params, options) {
                   throw err;
                 }
               } else {
+                DS.utils.forEach(data, function (item, i) {
+                  data[i] = DS.createInstance(resourceName, item, options);
+                });
                 return data;
               }
             }).catch(function (err) {
@@ -5432,7 +5438,7 @@ Defaults.prototype.defaultFilter = function (collection, resourceName, params, o
 };
 Defaults.prototype.baseUrl = '';
 Defaults.prototype.endpoint = '';
-Defaults.prototype.useClass = false;
+Defaults.prototype.useClass = true;
 /**
  * @doc property
  * @id DSProvider.properties:defaults.beforeValidate
@@ -6134,7 +6140,7 @@ function errorPrefix(resourceName) {
  * @param {object=} attrs Optional attributes to mix in to the new instance.
  * @param {object=} options Optional configuration. Properties:
  *
- * - `{boolean=}` - `useClass` - Whether to use the resource's wrapper class. Default: `true`.
+ * - `{boolean=}` - `useClass` - Whether to wrap the injected item with the resource's instance constructor.
  *
  * @returns {object} The new instance.
  */
@@ -6156,7 +6162,7 @@ function createInstance(resourceName, attrs, options) {
   }
 
   if (!('useClass' in options)) {
-    options.useClass = true;
+    options.useClass = definition.useClass;
   }
 
   var item;
@@ -7077,7 +7083,7 @@ function errorPrefix(resourceName) {
   return 'DS.inject(' + resourceName + ', attrs[, options]): ';
 }
 
-function _inject(definition, resource, attrs) {
+function _inject(definition, resource, attrs, options) {
   var DS = this;
 
   function _react(added, removed, changed, oldValueFn, firstTime) {
@@ -7108,7 +7114,7 @@ function _inject(definition, resource, attrs) {
         });
         compute = compute || !fn.deps.length;
         if (compute) {
-          _compute.call(item, fn, field);
+          _compute.call(item, fn, field, DS.utils);
         }
       });
     }
@@ -7133,7 +7139,7 @@ function _inject(definition, resource, attrs) {
   if (DS.utils.isArray(attrs)) {
     injected = [];
     for (var i = 0; i < attrs.length; i++) {
-      injected.push(_inject.call(DS, definition, resource, attrs[i]));
+      injected.push(_inject.call(DS, definition, resource, attrs[i], options));
     }
   } else {
     // check if "idAttribute" is a computed property
@@ -7157,7 +7163,7 @@ function _inject(definition, resource, attrs) {
         var item = DS.get(definition.name, id);
 
         if (!item) {
-          if (definition.methods || definition.useClass) {
+          if (options.useClass) {
             if (attrs instanceof definition[definition.class]) {
               item = attrs;
             } else {
@@ -7279,6 +7285,7 @@ function _injectRelations(definition, injected, options) {
  * @param {object|array} attrs The item or collection of items to inject into the data store.
  * @param {object=} options The item or collection of items to inject into the data store. Properties:
  *
+ * - `{boolean=}` - `useClass` - Whether to wrap the injected item with the resource's instance constructor.
  * - `{boolean=}` - `findBelongsTo` - Find and attach any existing "belongsTo" relationships to the newly injected item. Potentially expensive if enabled. Default: `false`.
  * - `{boolean=}` - `findHasMany` - Find and attach any existing "hasMany" relationships to the newly injected item. Potentially expensive if enabled. Default: `false`.
  * - `{boolean=}` - `findHasOne` - Find and attach any existing "hasOne" relationships to the newly injected item. Potentially expensive if enabled. Default: `false`.
@@ -7308,7 +7315,10 @@ function inject(resourceName, attrs, options) {
   stack++;
 
   try {
-    injected = _inject.call(DS, definition, resource, attrs);
+    if (!('useClass' in options)) {
+      options.useClass = definition.useClass;
+    }
+    injected = _inject.call(DS, definition, resource, attrs, options);
     if (definition.relations) {
       _injectRelations.call(DS, definition, injected, options);
     }

dist/js-data.min.js

@@ -32,6 +32,7 @@ function errorPrefix(resourceName) {
  * @param {object} attrs The attributes with which to create the item of the type specified by `resourceName`.
  * @param {object=} options Configuration options. Also passed along to the adapter's `create` method. Properties:
  *
+ * - `{boolean=}` - `useClass` - Whether to wrap the injected item with the resource's instance constructor.
  * - `{boolean=}` - `cacheResponse` - Inject the data returned by the adapter into the data store. Default: `true`.
  * - `{boolean=}` - `upsert` - If `attrs` already contains a primary key, then attempt to call `DS.update` instead. Default: `true`.
  * - `{function=}` - `beforeValidate` - Override the resource or global lifecycle hook.
@@ -114,7 +115,7 @@ function create(resourceName, attrs, options) {
           resource.saved[id] = DSUtils.updateTimestamp(resource.saved[id]);
           return DS.get(definition.name, id);
         } else {
-          return data;
+          return DS.createInstance(resourceName, data, options);
         }
       });
   }

src/datastore/async_methods/create.js

@@ -31,6 +31,7 @@ function errorPrefix(resourceName, id) {
  * @param {string|number} id The primary key of the item to retrieve.
  * @param {object=} options Optional configuration. Also passed along to the adapter's `find` method. Properties:
  *
+ * - `{boolean=}` - `useClass` - Whether to wrap the injected item with the resource's instance constructor.
  * - `{boolean=}` - `bypassCache` - Bypass the cache. Default: `false`.
  * - `{boolean=}` - `cacheResponse` - Inject the data returned by the adapter into the data store. Default: `true`.
  *
@@ -86,7 +87,7 @@ function find(resourceName, id, options) {
                 resource.completedQueries[id] = new Date().getTime();
                 return DS.inject(resourceName, data, options);
               } else {
-                return data;
+                return DS.createInstance(resourceName, data, options);
               }
             }).catch(function (err) {
               delete resource.pendingQueries[id];

src/datastore/async_methods/find.js

@@ -81,6 +81,7 @@ function processResults(data, resourceName, queryHash, options) {
  *
  * @param {object=} options Optional configuration. Also passed along to the adapter's `findAll` method. Properties:
  *
+ * - `{boolean=}` - `useClass` - Whether to wrap the injected item with the resource's instance constructor.
  * - `{boolean=}` - `bypassCache` - Bypass the cache. Default: `false`.
  * - `{boolean=}` - `cacheResponse` - Inject the data returned by the adapter into the data store. Default: `true`.
  *
@@ -143,6 +144,9 @@ function findAll(resourceName, params, options) {
                   throw err;
                 }
               } else {
+                DS.utils.forEach(data, function (item, i) {
+                  data[i] = DS.createInstance(resourceName, item, options);
+                });
                 return data;
               }
             }).catch(function (err) {

src/datastore/async_methods/findAll.js

@@ -194,7 +194,7 @@ Defaults.prototype.defaultFilter = function (collection, resourceName, params, o
 };
 Defaults.prototype.baseUrl = '';
 Defaults.prototype.endpoint = '';
-Defaults.prototype.useClass = false;
+Defaults.prototype.useClass = true;
 /**
  * @doc property
  * @id DSProvider.properties:defaults.beforeValidate

src/datastore/index.js

@@ -57,7 +57,7 @@ function errorPrefix(resourceName) {
  * @param {object=} attrs Optional attributes to mix in to the new instance.
  * @param {object=} options Optional configuration. Properties:
  *
- * - `{boolean=}` - `useClass` - Whether to use the resource's wrapper class. Default: `true`.
+ * - `{boolean=}` - `useClass` - Whether to wrap the injected item with the resource's instance constructor.
  *
  * @returns {object} The new instance.
  */
@@ -79,7 +79,7 @@ function createInstance(resourceName, attrs, options) {
   }
 
   if (!('useClass' in options)) {
-    options.useClass = true;
+    options.useClass = definition.useClass;
   }
 
   var item;

src/datastore/sync_methods/createInstance.js

@@ -9,7 +9,7 @@ function errorPrefix(resourceName) {
   return 'DS.inject(' + resourceName + ', attrs[, options]): ';
 }
 
-function _inject(definition, resource, attrs) {
+function _inject(definition, resource, attrs, options) {
   var DS = this;
 
   function _react(added, removed, changed, oldValueFn, firstTime) {
@@ -40,7 +40,7 @@ function _inject(definition, resource, attrs) {
         });
         compute = compute || !fn.deps.length;
         if (compute) {
-          _compute.call(item, fn, field);
+          _compute.call(item, fn, field, DS.utils);
         }
       });
     }
@@ -65,7 +65,7 @@ function _inject(definition, resource, attrs) {
   if (DS.utils.isArray(attrs)) {
     injected = [];
     for (var i = 0; i < attrs.length; i++) {
-      injected.push(_inject.call(DS, definition, resource, attrs[i]));
+      injected.push(_inject.call(DS, definition, resource, attrs[i], options));
     }
   } else {
     // check if "idAttribute" is a computed property
@@ -89,7 +89,7 @@ function _inject(definition, resource, attrs) {
         var item = DS.get(definition.name, id);
 
         if (!item) {
-          if (definition.methods || definition.useClass) {
+          if (options.useClass) {
             if (attrs instanceof definition[definition.class]) {
               item = attrs;
             } else {
@@ -211,6 +211,7 @@ function _injectRelations(definition, injected, options) {
  * @param {object|array} attrs The item or collection of items to inject into the data store.
  * @param {object=} options The item or collection of items to inject into the data store. Properties:
  *
+ * - `{boolean=}` - `useClass` - Whether to wrap the injected item with the resource's instance constructor.
  * - `{boolean=}` - `findBelongsTo` - Find and attach any existing "belongsTo" relationships to the newly injected item. Potentially expensive if enabled. Default: `false`.
  * - `{boolean=}` - `findHasMany` - Find and attach any existing "hasMany" relationships to the newly injected item. Potentially expensive if enabled. Default: `false`.
  * - `{boolean=}` - `findHasOne` - Find and attach any existing "hasOne" relationships to the newly injected item. Potentially expensive if enabled. Default: `false`.
@@ -240,7 +241,10 @@ function inject(resourceName, attrs, options) {
   stack++;
 
   try {
-    injected = _inject.call(DS, definition, resource, attrs);
+    if (!('useClass' in options)) {
+      options.useClass = definition.useClass;
+    }
+    injected = _inject.call(DS, definition, resource, attrs, options);
     if (definition.relations) {
       _injectRelations.call(DS, definition, injected, options);
     }