Add ability to have multiple embedded items with embeddedResourceName set to true.

Author: guylabs

README.md

@@ -442,7 +442,8 @@ The `SpringDataRestAdapter` is designed to be configurable and you are able to c
 * `linksSelfLinkName` (default: `self`): the name of the self link in the links object.
 * `embeddedKey` (default: `_embedded`): the property name where the embedded items are stored.
 * `embeddedNewKey` (default: `_embeddedItems`): the property name where the array of embedded items are stored.
-* `embeddedNamedResources` (default: `false`): true if the embedded resources names should be left as is, false if they should be removed
+* `embeddedNamedResources` (default: `false`): true if the embedded resources names (can be more than one) should be
+left as is, false if they should be removed and be replaced by the value of the first embedded resource
     * Example if set to true:
     ```json
     {

dist/angular-spring-data-rest.js

@@ -27,6 +27,7 @@ angular.module("spring-data-rest").provider("SpringDataRestAdapter", function ()
         'linksSelfLinkName': 'self',
         'embeddedKey': '_embedded',
         'embeddedNewKey': '_embeddedItems',
+        'embeddedNamedResources': false,
         'resourcesKey': '_resources',
         'resourcesFunction': undefined,
         'fetchFunction': undefined,
@@ -251,11 +252,23 @@ angular.module("spring-data-rest").provider("SpringDataRestAdapter", function ()
                     }
 
                     // process the embedded key and move it to an embedded value key
-                    processedData = moveArray(processedData, config.embeddedKey, config.embeddedNewKey);
+                    processedData = moveArray(processedData, config.embeddedKey, config.embeddedNewKey, config.embeddedNamedResources);
 
                     // recursively process all contained objects in the embedded value array
                     angular.forEach(processedData[config.embeddedNewKey], function (value, key) {
-                        processedData[config.embeddedNewKey][key] = processDataFunction(value, fetchLinkNames, recursive);
+
+                        // if the embeddedResourceName config variable is set to true, process each resource name array
+                        if (value instanceof Array) {
+                            var processedDataArray = [];
+                            angular.forEach(value, function (arrayValue, arrayKey) {
+                                processedDataArray[arrayKey] = processDataFunction(arrayValue, fetchLinkNames, recursive);
+                            });
+                            processedData[config.embeddedNewKey][key] = processedDataArray;
+                        }
+                        else {
+                            // single objects are processed directly
+                            processedData[config.embeddedNewKey][key] = processDataFunction(value, fetchLinkNames, recursive);
+                        }
                     });
                 }
 
@@ -372,19 +385,32 @@ function deepExtend(destination) {
 }
 
 /**
- * Moves a key with an array value to the destination key.
+ * Moves a key with an array value to the destination key. It is also possible to specify to use the value of the
+ * first key of the object[sourceKey] object instead of the same object.
  *
  * @param {object} object the object in which the source key exists and destination key is created
  * @param {string} sourceKey the source key from which the array is moved
  * @param {string} destinationKey the destination key to which the array is moved
+ * @param {boolean} useSameObject true if the same object is used for the destinationKey, false if the value of the
+ * first key is used
  * @returns {object} the processed object
  */
-function moveArray(object, sourceKey, destinationKey) {
+function moveArray(object, sourceKey, destinationKey, useSameObject) {
     var embeddedObject = object[sourceKey];
     if (embeddedObject) {
-        var key = Object.keys(embeddedObject)[0];
         var processedData = {};
-        processedData[destinationKey] = embeddedObject[key];
+        processedData[destinationKey] = {};
+
+        if (useSameObject === true) {
+            // loop over all items in the embedded object and add them to the processed data
+            angular.forEach(Object.keys(embeddedObject), function (key) {
+                processedData[destinationKey][key] = embeddedObject[key];
+            });
+        } else {
+            // remove the key and replace it with the value of it
+            var key = Object.keys(embeddedObject)[0];
+            processedData[destinationKey] = embeddedObject[key];
+        }
 
         object = angular.extend(object, processedData);
         delete object[sourceKey];
@@ -420,7 +446,7 @@ function extractUrl(url, templated) {
 function checkUrl(url, resourceName, hrefKey) {
     if (url == undefined || !url) {
         throw new Error("The provided resource name '" + resourceName + "' has no valid URL in the '" +
-            hrefKey + "' property.");
+        hrefKey + "' property.");
     }
     return url
 }

dist/angular-spring-data-rest.min.js

@@ -1,6 +1,6 @@
 /*!
  * angular-spring-data-rest 0.3.1
- * Copyright 2014 Guy Brûlé (@guy_labs)
+ * Copyright 2015 Guy Brûlé (@guy_labs)
  * https://github.com/guylabs/angular-spring-data-rest
  */
 !function () {
@@ -13,11 +13,17 @@
         }), angular.copy(b)
     }
 
-    function b(a, b, c) {
-        var d = a[b];
-        if (d) {
-            var e = Object.keys(d)[0], f = {};
-            f[c] = d[e], a = angular.extend(a, f), delete a[b]
+    function b(a, b, c, d) {
+        var e = a[b];
+        if (e) {
+            var f = {};
+            if (f[c] = {}, d === !0)angular.forEach(Object.keys(e), function (a) {
+                f[c][a] = e[a]
+            }); else {
+                var g = Object.keys(e)[0];
+                f[c] = e[g]
+            }
+            a = angular.extend(a, f), delete a[b]
         }
         return a
     }
@@ -49,6 +55,7 @@
             linksSelfLinkName: "self",
             embeddedKey: "_embedded",
             embeddedNewKey: "_embeddedItems",
+            embeddedNamedResources: !1,
             resourcesKey: "_resources",
             resourcesFunction: void 0,
             fetchFunction: void 0,
@@ -109,8 +116,13 @@
                             c != e.linksSelfLinkName && (i == e.fetchAllKey || "string" == typeof i && c == i || i instanceof Array && i.indexOf(c) >= 0) && h(l(a, c), c, n, i, j)
                         }))
                     }
-                    return e.embeddedKey in a && (n || (n = angular.copy(a)), n = b(n, e.embeddedKey, e.embeddedNewKey), angular.forEach(n[e.embeddedNewKey], function (a, b) {
-                        n[e.embeddedNewKey][b] = k(a, i, j)
+                    return e.embeddedKey in a && (n || (n = angular.copy(a)), n = b(n, e.embeddedKey, e.embeddedNewKey, e.embeddedNamedResources), angular.forEach(n[e.embeddedNewKey], function (a, b) {
+                        if (a instanceof Array) {
+                            var c = [];
+                            angular.forEach(a, function (a, b) {
+                                c[b] = k(a, i, j)
+                            }), n[e.embeddedNewKey][b] = c
+                        } else n[e.embeddedNewKey][b] = k(a, i, j)
                     })), n ? n : a
                 }, j = function (b, c, d) {
                     var e = a.get("$q").when(b), f = a.get("$q").defer();

src/angular-spring-data-rest-utils.js

@@ -33,12 +33,17 @@ function deepExtend(destination) {
 function moveArray(object, sourceKey, destinationKey, useSameObject) {
     var embeddedObject = object[sourceKey];
     if (embeddedObject) {
-        var key = Object.keys(embeddedObject)[0];
         var processedData = {};
+        processedData[destinationKey] = {};
 
         if (useSameObject === true) {
-            processedData[destinationKey] = embeddedObject;
+            // loop over all items in the embedded object and add them to the processed data
+            angular.forEach(Object.keys(embeddedObject), function (key) {
+                processedData[destinationKey][key] = embeddedObject[key];
+            });
         } else {
+            // remove the key and replace it with the value of it
+            var key = Object.keys(embeddedObject)[0];
             processedData[destinationKey] = embeddedObject[key];
         }
 

test/angular-spring-data-rest-provider.embedded-named-resources.spec.js

@@ -60,4 +60,44 @@ describe("the response with the embedded values", function () {
         }
     });
 
+    it("must have the named resources if the embeddedNamedResources is set to true", function () {
+        // set the new fetch function which throws an error if it is called
+        springDataRestAdapterProvider.config({
+            'embeddedNamedResources': true
+        });
+        this.response = SpringDataRestAdapter.process(this.rawResponse);
+
+        // expect that the first key of the embedded items is categories
+        var key = Object.keys(this.response[this.config.embeddedNewKey])[0];
+        expect(key).toBe("categories");
+
+        // expect that the embedded key value is an array of the size 2
+        expect(this.response[this.config.embeddedNewKey]['categories'] instanceof Array).toBe(true);
+        expect(this.response[this.config.embeddedNewKey]['categories'].length).toBe(2);
+    });
+
+    it("must have multiple named resources if the embeddedNamedResources is set to true", function () {
+        // set the new fetch function which throws an error if it is called
+        springDataRestAdapterProvider.config({
+            'embeddedNamedResources': true
+        });
+        this.response = SpringDataRestAdapter.process(mockDataWithoutLinksKeyAndMultipleEmbeddedKeys());
+
+        // expect that the first key of the embedded items is categories
+        var key = Object.keys(this.response[this.config.embeddedNewKey])[0];
+        expect(key).toBe("categories");
+
+        // expect that the second key of the embedded items is item
+        var secondKey = Object.keys(this.response[this.config.embeddedNewKey])[1];
+        expect(secondKey).toBe("item");
+
+        // expect that the first embedded key value is an array of the size 2
+        expect(this.response[this.config.embeddedNewKey]['categories'] instanceof Array).toBe(true);
+        expect(this.response[this.config.embeddedNewKey]['categories'].length).toBe(2);
+
+        // expect that the second embedded key value is an object
+        expect(this.response[this.config.embeddedNewKey]['item'] instanceof Object).toBe(true);
+        expect(this.response[this.config.embeddedNewKey]['item'].name).toBe('Test item 1');
+    });
+
 });

test/angular-spring-data-rest-provider.embedded.spec.js

@@ -164,6 +164,62 @@ var mockDataWithoutLinksKey = function () {
     );
 };
 
+var mockDataWithoutLinksKeyAndMultipleEmbeddedKeys = function () {
+    return angular.copy(
+        {
+            "_embedded": {
+                "categories": [
+                    {
+                        "version": 0,
+                        "creationDate": 1406219870650,
+                        "modificationDate": 1406219870650,
+                        "name": "Test category 1",
+                        "_links": {
+                            "self": {
+                                "href": "http://localhost:8080/categories/f974f5ef-a951-43b4-9027-4d2163216e54"
+                            },
+                            "parentCategory": {
+                                "href": "http://localhost:8080/categories/f974f5ef-a951-43b4-9027-4d2163216e54/parentCategory"
+                            }
+                        }
+                    },
+                    {
+                        "version": 0,
+                        "creationDate": 1406219884502,
+                        "modificationDate": 1406219884502,
+                        "name": "Test category 2",
+                        "_links": {
+                            "self": {
+                                "href": "http://localhost:8080/categories/b5ba38d5-98d3-4579-8709-a28549406697"
+                            },
+                            "parentCategory": {
+                                "href": "http://localhost:8080/categories/b5ba38d5-98d3-4579-8709-a28549406697/parentCategory"
+                            }
+                        }
+                    }
+                ],
+                "item": {
+                    "version": 0,
+                    "creationDate": 1406219870650,
+                    "modificationDate": 1406219870650,
+                    "name": "Test item 1",
+                    "_links": {
+                        "self": {
+                            "href": "http://localhost:8080/item/f974f5ef-a951-43b4-9027-4d2163216e54"
+                        }
+                    }
+                }
+            },
+            "page": {
+                "size": 20,
+                "totalElements": 2,
+                "totalPages": 1,
+                "number": 0
+            }
+        }
+    );
+};
+
 var mockDataWithoutEmbeddedKey = function () {
     return angular.copy(
         {