Merge pull request #2 from nalch/master

Add support for arbitrary deep keys

Author: diegohb

src/aurelia-configuration.ts

@@ -166,6 +166,29 @@ export class AureliaConfiguration {
         return this.environment in this.obj;
     }
 
+    /**
+     * GetDictValue
+     * Gets a value from a dict in an arbitrary depth or throws
+     * an error, if the key does not exist
+     *
+     * @param baseObject
+     * @param key
+     * @returns {*}
+     */
+    getDictValue(baseObject: {} | any, key: string) {
+        let splitKey = key.split('.');
+        let currentObject = baseObject;
+
+        splitKey.forEach((key) => {
+            if (currentObject[key]) {
+                currentObject = currentObject[key];
+            } else {
+                throw 'Key ' + key + ' not found';
+            }
+        });
+        return currentObject;
+    }
+
     /**
      * Get
      * Gets a configuration value from the main config object
@@ -197,25 +220,25 @@ export class AureliaConfiguration {
 
                 return returnVal;
             }
-        }
-
-        if (key.indexOf('.') !== -1) {
-            let splitKey = key.split('.');
-            let parent = splitKey[0];
-            let child = splitKey[1];
-
-            if (!this.environmentEnabled()) {
-                if (this.obj[parent]) {
-                    return this.obj[parent][child] ? this.obj[parent][child] : defaultValue;
+        } else {
+            // nested key and environment is enabled
+            if (this.environmentEnabled()) {
+                if (this.environmentExists()) {
+                    try {
+                        return this.getDictValue(this.obj[this.environment], key);
+                    } catch {
+                        // nested key, env exists, key is not in environment
+                        if (this.cascade_mode) {
+                            try {
+                                return this.getDictValue(this.obj, key);
+                            } catch {}
+                        }
+                    }
                 }
             } else {
-                if (this.environmentExists() && this.obj[this.environment][parent] && this.obj[this.environment][parent][child]) {
-                    returnVal = this.obj[this.environment][parent][child];
-                } else if (this.cascade_mode && this.obj[parent] && this.obj[parent][child]) {
-                    returnVal = this.obj[parent][child];
-                }
-
-                return returnVal;
+                try {
+                    return this.getDictValue(this.obj, key);
+                } catch {}
             }
         }
 

test/unit/aurelia-configuration.spec.ts

@@ -104,4 +104,100 @@ describe('Configuration class', () => {
         const test = configInstance.get('test');
         expect(test).toEqual('dev2');
     });
+
+    it('should get nested values from dicts', () => {
+        let nestedDict = {
+            'level1': 'level1',
+            'nested1': {
+                'nested12': 'nested12',
+                'nested2': {
+                    'nested21': 'nested21'
+                }
+            }
+        };
+        configInstance.setAll(nestedDict);
+
+        expect(configInstance.getDictValue(nestedDict, 'level1')).toEqual('level1');
+        expect(configInstance.getDictValue(nestedDict, 'nested1.nested12')).toEqual('nested12');
+        expect(configInstance.getDictValue(nestedDict, 'nested1.nested2.nested21')).toEqual('nested21');
+
+        expect(
+            configInstance.getDictValue(nestedDict['nested1'], 'nested2.nested21'),
+        ).toEqual('nested21');
+
+        expect(
+            configInstance.getDictValue(nestedDict['nested1']['nested2'], 'nested21'),
+        ).toEqual('nested21');
+
+        expect(
+            function () { configInstance.getDictValue(nestedDict, 'nonExisting') }
+        ).toThrow();
+    });
+
+    it('should get nested values from configs', () => {
+        let nestedDict = {
+            'level1': 'level1',
+            'nested1': {
+                'nested12': 'nested12',
+                'nested2': {
+                    'nested21': 'nested21'
+                }
+            }
+        };
+        configInstance.setAll(nestedDict);
+
+        expect(configInstance.get('level1')).toEqual('level1');
+        expect(configInstance.get('nested1.nested12')).toEqual('nested12');
+        expect(configInstance.get('nested1.nested2.nested21')).toEqual('nested21');
+        expect(
+            configInstance.get('nested1.nested2')
+        ).toEqual({'nested21': 'nested21'});
+        expect(
+            configInstance.get('nested1.nested2.nested21')
+        ).toEqual('nested21');
+        expect(
+            function () { configInstance.getDictValue(nestedDict, 'nonExisting') }
+        ).toThrow();
+    });
+
+    it('should prefer environment values from configs', () => {
+        let nestedDict = {
+            'level1': 'level1',
+            'nested1': {
+                'nested12': 'nested12',
+                'nested2': {
+                    'nested21': 'nested21'
+                },
+                'nested13': 'nested13'
+            },
+            'dev2': {
+                'level1': 'level1e',
+                'nested1': {
+                    'nested12': 'nested12e',
+                    'nested2': {
+                        'nested21': 'nested21e'
+                    }
+                }
+            }
+        };
+        configInstance.setAll(nestedDict);
+        configInstance.setEnvironment('dev2');
+
+        expect(configInstance.get('level1')).toEqual('level1e');
+        expect(configInstance.get('nested1.nested12')).toEqual('nested12e');
+        expect(configInstance.get('nested1.nested2.nested21')).toEqual('nested21e');
+        expect(
+            configInstance.get('nested1.nested2')
+        ).toEqual({'nested21': 'nested21e'});
+        expect(
+            configInstance.get('nested1.nested2.nested21')
+        ).toEqual('nested21e');
+        expect(
+            configInstance.get('nested1.nested13')
+        ).toEqual('nested13');
+        expect(configInstance.get('nonExisting', 'default')).toEqual('default');
+        expect(
+            function () { configInstance.getDictValue(nestedDict, 'nonExisting') }
+        ).toThrow();
+    });
 });