1.1.5

Author: iobaixas

CHANGELOG.md

@@ -1,3 +1,19 @@
+<a name="1.1.5"></a>
+### 1.1.5 (2014-12-10)
+
+
+#### Bug Fixes
+
+* **guides.integration:** fixes deprecated notation references ([7bdb2569](http://github.com/angular-platanus/restmod/commit/7bdb256972786ba5c007b84c6bf122fe5b093d65), closes [#215](http://github.com/angular-platanus/restmod/issues/215))
+* **service:** fixes wrong warning message refering to `$mix` instead of `mix` ([09b1f352](http://github.com/angular-platanus/restmod/commit/09b1f352357aa3fe34e4c86f60b57d8af63eb589), closes [#178](http://github.com/angular-platanus/restmod/issues/178))
+
+
+#### Features
+
+* adds the List type and namespace. ([7ee7b9ce](http://github.com/angular-platanus/restmod/commit/7ee7b9cee197c235eeba2b28fbbd9cf6be4f57ca), closes [#169](http://github.com/angular-platanus/restmod/issues/169))
+* improves PATCH logic, now refering to an object containing property will automatically include it's subproperties.
+
+
 <a name="1.1.4"></a>
 ### 1.1.4 (2014-11-26)
 

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-restmod",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "authors": [
     "Ignacio Baixas <[email protected]>"
   ],

dist/angular-restmod-bundle.js

@@ -1,6 +1,6 @@
 /**
  * API Bound Models for AngularJS
- * @version v1.1.4 - 2014-11-26
+ * @version v1.1.5 - 2014-12-10
  * @link https://github.com/angular-platanus/restmod
  * @author Ignacio Baixas <[email protected]>
  * @license MIT License, http://www.opensource.org/licenses/MIT
@@ -373,7 +373,7 @@ RMModule.provider('restmod', [function() {
 
           if(arguments.length > 1) {
             model.mix(arraySlice.call(arguments, 1));
-            $log.warn('Passing mixins and difinitions in the model method will be deprecated in restmod 1.2, use restmod.model().$mix() instead.');
+            $log.warn('Passing mixins and difinitions in the model method will be deprecated in restmod 1.2, use restmod.model().mix() instead.');
           }
 
           return model;
@@ -1231,6 +1231,43 @@ RMModule.factory('RMExtendedApi', ['$q', 'RMPackerCache', function($q, packerCac
     }
   };
 
+}]);
+RMModule.factory('RMListApi', [function() {
+
+  /**
+   * @class ListApi
+   *
+   * @description Common methods for Lists and Collections.
+   */
+  return {
+
+    /**
+     * @memberof ListApi#
+     *
+     * @description Generates a new list from this one.
+     *
+     * If called without arguments, the list is popupated with the same contents as this list.
+     *
+     * If there is a pending async operation on the host collection/list, then this method will
+     * return an empty list and fill it when the async operation finishes. If you don't need the async behavior
+     * then use `$type.list` directly to generate a new list.
+     *
+     * @param {function} _filter A filter function that should return the list contents as an array.
+     * @return {ListApi} list
+     */
+    $asList: function(_filter) {
+      var list = this.$type.list(),
+          promise = this.$asPromise();
+
+      // set the list initial promise to the resolution of the parent promise.
+      list.$promise = promise.then(function(_this) {
+        list.push.apply(list, _filter ? _filter(_this) : _this);
+      });
+
+      return list;
+    }
+  };
+
 }]);
 RMModule.factory('RMRecordApi', ['RMUtils', function(Utils) {
 
@@ -1524,7 +1561,16 @@ RMModule.factory('RMRecordApi', ['RMUtils', function(Utils) {
               method: this.$type.getProperty('patchMethod', 'PATCH'), // allow user to override patch method
               url: url,
               // Use special mask for patches, mask everything that is not in the patch list.
-              data: this.$wrap(function(_name) { return _patch.indexOf(_name) === -1; })
+              data: this.$wrap(function(_name) {
+                for(var i = 0, l = _patch.length; i < l; i++) {
+                  if(_name === _patch[i] ||
+                    _name.indexOf(_patch[i] + '.') === 0 ||
+                    _patch[i].indexOf(_name + '.') === 0
+                  ) { return false; }
+                }
+
+                return true;
+              })
             };
           } else {
             request = { method: 'PUT', url: url, data: this.$wrap(Utils.UPDATE_MASK) };
@@ -1781,74 +1827,6 @@ RMModule.factory('RMScopeApi', ['RMUtils', function(Utils) {
     }
   };
 
-}]);
-RMModule.factory('RMViewApi', [function() {
-
-  /**
-   * @class CollectionApi
-   *
-   * @extends ScopeApi
-   * @extends CommonApi
-   *
-   * @description
-   *
-   * A restmod collection is an extended array type bound REST resource route.
-   *
-   * Every time a new restmod model is created, an associated collection type is created too.
-   *
-   * TODO: talk about fetch/refresh behaviour, lifecycles, collection scopes, adding/removing
-   *
-   * For `$fetch` on a collection:
-   *
-   * * before-fetch-many
-   * * before-request
-   * * after-request[-error]
-   * * after-feed (called for every record if no errors)
-   * * after-feed-many (only called if no errors)
-   * * after-fetch-many[-error]
-   *
-   * @property {boolean} $isCollection Helper flag to separate collections from the main type
-   * @property {object} $scope The collection scope (hierarchical scope, not angular scope)
-   * @property {object} $params The collection query parameters
-   *
-   */
-  var API = {
-
-    $isCollection: true,
-
-    /**
-     * @memberof CollectionApi#
-     *
-     * @description Called by collection constructor on initialization.
-     *
-     * Note: Is better to add a hook on after-init than overriding this method.
-     */
-    $initialize: function() {
-
-      this.$collection.on('after-add', function() {
-
-      }).on('after-remove', function() {
-
-      }).on('after-clear', function() {
-
-      });
-    },
-
-    $reload: function() {
-
-    }
-  };
-
-  // Proxy common collection methods to collection
-
-  angular.forEach(['$fetch', '$create', '$new', '$build', '$buildRaw'], function(_method) {
-    API[_method] = function() {
-      return this.$collection[_method].apply(this.$collection, arguments);
-    };
-  });
-
-  return API;
-
 }]);
 RMModule.factory('RMBuilder', ['$injector', 'inflector', '$log', 'RMUtils', function($injector, inflector, $log, Utils) {
 
@@ -2711,8 +2689,8 @@ RMModule.factory('RMBuilderRelations', ['$injector', 'inflector', '$log', 'RMUti
   });
 
 }]);
-RMModule.factory('RMModelFactory', ['$injector', 'inflector', 'RMUtils', 'RMScopeApi', 'RMCommonApi', 'RMRecordApi', 'RMCollectionApi', 'RMExtendedApi', 'RMSerializer', 'RMBuilder',
-  function($injector, inflector, Utils, ScopeApi, CommonApi, RecordApi, CollectionApi, ExtendedApi, Serializer, Builder) {
+RMModule.factory('RMModelFactory', ['$injector', 'inflector', 'RMUtils', 'RMScopeApi', 'RMCommonApi', 'RMRecordApi', 'RMListApi', 'RMCollectionApi', 'RMExtendedApi', 'RMSerializer', 'RMBuilder',
+  function($injector, inflector, Utils, ScopeApi, CommonApi, RecordApi, ListApi, CollectionApi, ExtendedApi, Serializer, Builder) {
 
   var NAME_RGX = /(.*?)([^\/]+)\/?$/,
       extend = Utils.extendOverriden;
@@ -2752,15 +2730,16 @@ RMModule.factory('RMModelFactory', ['$injector', 'inflector', 'RMUtils', 'RMScop
     }
 
     var Collection = Utils.buildArrayType(),
+        List = Utils.buildArrayType(),
         Dummy = function(_asCollection) {
           this.$isCollection = _asCollection;
-          this.$initialize();
+          this.$initialize(); // TODO: deprecate this
         };
 
-    // Collection factory (since a constructor cant be provided...)
-    function newCollection(_scope, _params) {
+    // Collection factory
+    function newCollection(_params, _scope) {
       var col = new Collection();
-      col.$scope = _scope;
+      col.$scope = _scope || Model;
       col.$params = _params;
       col.$initialize();
       return col;
@@ -2804,9 +2783,7 @@ RMModule.factory('RMModelFactory', ['$injector', 'inflector', 'RMUtils', 'RMScop
       },
 
       // creates a new collection bound by default to the static scope
-      $collection: function(_params, _scope) {
-        return newCollection(_scope || Model, _params);
-      },
+      $collection: newCollection,
 
       // gets scope url
       $url: function() {
@@ -2914,6 +2891,21 @@ RMModule.factory('RMModelFactory', ['$injector', 'inflector', 'RMUtils', 'RMScop
         return new Dummy(_asCollection);
       },
 
+      /**
+       * Creates a new record list.
+       *
+       * A list is a ordered set of records not bound to a particular scope.
+       *
+       * Contained records can belong to any scope.
+       *
+       * @return {List} the new list
+       */
+      list: function(_items) {
+        var list = new List();
+        if(_items) list.push.apply(list, _items);
+        return list;
+      },
+
       /**
        * @memberof StaticApi#
        *
@@ -3072,10 +3064,18 @@ RMModule.factory('RMModelFactory', ['$injector', 'inflector', 'RMUtils', 'RMScop
       // provide collection constructor
       $collection: function(_params, _scope) {
         _params = this.$params ? angular.extend({}, this.$params, _params) : _params;
-        return newCollection(_scope || this.$scope, _params);
+        return newCollection(_params, _scope || this.$scope);
       }
 
-    }, ScopeApi, CommonApi, CollectionApi, ExtendedApi);
+    }, ListApi, ScopeApi, CommonApi, CollectionApi, ExtendedApi);
+
+    ///// Setup list api
+
+    extend(List.prototype, {
+
+      $type: Model
+
+    }, ListApi, CommonApi);
 
     ///// Setup dummy api
 
@@ -3095,6 +3095,7 @@ RMModule.factory('RMModelFactory', ['$injector', 'inflector', 'RMUtils', 'RMScop
       Model: Model,
       Record: Model.prototype,
       Collection: Collection.prototype,
+      List: List.prototype,
       Dummy: Dummy.prototype
     };
 
@@ -3242,13 +3243,18 @@ RMModule.factory('RMModelFactory', ['$injector', 'inflector', 'RMUtils', 'RMScop
 
         switch(api) {
         // Virtual API's
+        case 'List':
+          helpDefine('Collection', name, _fun);
+          helpDefine('List', name, _fun);
+          break;
         case 'Scope':
           helpDefine('Model', name, _fun);
           helpDefine('Collection', name, _fun);
           break;
         case 'Resource':
           helpDefine('Record', name, _fun);
           helpDefine('Collection', name, _fun);
+          helpDefine('List', name, _fun);
           helpDefine('Dummy', name, _fun);
           break;
         default: