Add embeddedResourceName config property and integrate adapted pull request.

#4

Author: guylabs

README.md

@@ -442,6 +442,25 @@ 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
+    * Example if set to true:
+    ```json
+    {
+        ...
+        "_embeddedItems": {
+            "categories": [...]
+        }
+        ...
+    }
+    ```
+    * Example if set to false:
+        ```json
+        {
+            ...
+            "_embeddedItems": [...]
+            ...
+        }
+        ```
 * `hrefKey` (default: `href`): the property name where the url is stored under each specific link.
 * `resourcesKey` (default: `_resources`): the property name where the resource method is stored.
 * `resourcesFunction` (default: `undefined`): the function to use to call the backend. Read more how to do this [here](#exchange-the-underlying-angular-resource-function)
@@ -469,6 +488,7 @@ The config method of the `SpringDataRestAdapterProvider` takes a configuration o
     "linksSelfLinkName": "self",
     "embeddedKey": "_embedded",
     "embeddedNewKey": "_embeddedItems",
+    "embeddedNamedResources": false,
     "resourcesKey": "_resources",
     "resourcesFunction": undefined,
     "fetchFunction": undefined,

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

@@ -15,6 +15,7 @@ angular.module("spring-data-rest").provider("SpringDataRestAdapter", function ()
         'linksSelfLinkName': 'self',
         'embeddedKey': '_embedded',
         'embeddedNewKey': '_embeddedItems',
+        'embeddedNamedResources': false,
         'resourcesKey': '_resources',
         'resourcesFunction': undefined,
         'fetchFunction': undefined,
@@ -239,11 +240,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);
+                        }
                     });
                 }
 

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

@@ -20,19 +20,27 @@ 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];
+
+        if (useSameObject === true) {
+            processedData[destinationKey] = embeddedObject;
+        } else {
+            processedData[destinationKey] = embeddedObject[key];
+        }
 
         object = angular.extend(object, processedData);
         delete object[sourceKey];
@@ -68,7 +76,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
 }

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

@@ -9,6 +9,7 @@ describe("the configuration", function () {
             'linksSelfLinkName': 'self',
             'embeddedKey': '_embedded',
             'embeddedNewKey': '_embeddedItems',
+            'embeddedNamedResources': false,
             'resourcesKey': '_resources',
             'resourcesFunction': undefined,
             'fetchFunction': undefined,
@@ -36,6 +37,7 @@ describe("the configuration", function () {
             'linksSelfLinkName': 'selfNew',
             'embeddedKey': '_embeddedNew',
             'embeddedNewKey': '_embeddedItemsNew',
+            'embeddedNamedResources': true,
             'resourcesKey': '_resourcesNew',
             'resourcesFunction': undefined,
             'fetchFunction': undefined,
@@ -59,6 +61,7 @@ describe("the configuration", function () {
             'linksSelfLinkName': 'self',
             'embeddedKey': '_embedded',
             'embeddedNewKey': '_embeddedItemsNew',
+            'embeddedNamedResources': false,
             'resourcesKey': '_resources',
             'resourcesFunction': undefined,
             'fetchFunction': undefined,

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

@@ -0,0 +1,41 @@
+describe("the response with the embedded values", function () {
+
+    beforeEach(function () {
+        module('ngResource');
+        module('spring-data-rest');
+
+        // initialize the provider by injecting it to a config block of a test module
+        // and assign it to the this scope such that it is available in each test
+        // (see https://jasmine.github.io/2.0/introduction.html#section-The_<code>this</code>_keyword)
+        angular.module('testModule', function () {
+        }).config(function (SpringDataRestAdapterProvider) {
+            SpringDataRestAdapterProvider.config({
+                'embeddedNamedResources': true
+            });
+            springDataRestAdapterProvider = SpringDataRestAdapterProvider;
+        });
+
+        // initialize test module injector
+        module('testModule');
+
+        inject(function (_SpringDataRestAdapter_) {
+            SpringDataRestAdapter = _SpringDataRestAdapter_;
+        });
+
+        // initialize the configuration, the raw and the processed response
+        this.config = springDataRestAdapterProvider.config();
+        this.rawResponse = mockData();
+        this.response = SpringDataRestAdapter.process(this.rawResponse);
+    });
+
+    it("must have the named resources if the embeddedNamedResources is set to true", function () {
+        // 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);
+    });
+
+});