Add custom prop names to keyedContainer

Author: rreusser

src/components/legend/draw.js

@@ -418,7 +418,7 @@ function drawTexts(g, gd) {
                         }
                     }
 
-                    var carr = Lib.keyedContainer(fullInput, 'transforms[' + i + '].groupnames');
+                    var carr = Lib.keyedContainer(fullInput, 'transforms[' + i + '].groupnames', 'group', 'name');
 
                     if(BLANK_STRING_REGEX.test(origText)) {
                         carr.remove(legendItem.trace._group);

src/lib/keyed_container.js

@@ -16,7 +16,10 @@ var NAME = 1;
 var VALUE = 2;
 var BOTH = 3;
 
-module.exports = function keyedContainer(baseObj, path) {
+module.exports = function keyedContainer(baseObj, path, keyName, valueName) {
+
+    keyName = keyName || 'name';
+    valueName = valueName || 'value';
     var i, arr;
     var changeTypes = {};
 
@@ -31,7 +34,7 @@ module.exports = function keyedContainer(baseObj, path) {
     // Construct an index:
     var indexLookup = {};
     for(i = 0; i < arr.length; i++) {
-        indexLookup[arr[i].name] = i;
+        indexLookup[arr[i][keyName]] = i;
     }
 
     var obj = {
@@ -43,18 +46,21 @@ module.exports = function keyedContainer(baseObj, path) {
                 changeType = BOTH;
                 idx = arr.length;
                 indexLookup[name] = idx;
-            } else if(value !== arr[idx].value) {
+            } else if(value !== arr[idx][valueName]) {
                 changeType = VALUE;
             }
-            arr[idx] = {name: name, value: value};
+            var newValue = {};
+            newValue[keyName] = name;
+            newValue[valueName] = value;
+            arr[idx] = newValue;
 
             changeTypes[idx] = changeTypes[idx] | changeType;
 
             return obj;
         },
         get: function(name) {
             var idx = indexLookup[name];
-            return idx === undefined ? undefined : arr[idx].value;
+            return idx === undefined ? undefined : arr[idx][valueName];
         },
         rename: function(name, newName) {
             var idx = indexLookup[name];
@@ -65,7 +71,7 @@ module.exports = function keyedContainer(baseObj, path) {
             indexLookup[newName] = idx;
             delete indexLookup[name];
 
-            arr[idx].name = newName;
+            arr[idx][keyName] = newName;
 
             return obj;
         },
@@ -76,7 +82,7 @@ module.exports = function keyedContainer(baseObj, path) {
                 changeTypes[i] = changeTypes[i] | BOTH;
             }
             for(i = idx; i < arr.length; i++) {
-                indexLookup[arr[i].name]--;
+                indexLookup[arr[i][keyName]]--;
             }
             arr.splice(idx, 1);
             delete(indexLookup[name]);
@@ -92,10 +98,10 @@ module.exports = function keyedContainer(baseObj, path) {
                 astr = path + '[' + idx + ']';
                 if(arr[idx]) {
                     if(changeTypes[idx] & NAME) {
-                        update[astr + '.name'] = arr[idx].name;
+                        update[astr + '.' + keyName] = arr[idx][keyName];
                     }
                     if(changeTypes[idx] & VALUE) {
-                        update[astr + '.value'] = arr[idx].value;
+                        update[astr + '.' + valueName] = arr[idx][valueName];
                     }
                 } else {
                     update[astr] = null;

src/transforms/groupby.js

@@ -180,7 +180,7 @@ function transformOne(trace, state) {
     }
 
     if(opts.groupnames) {
-        groupNameObj = Lib.keyedContainer(opts, 'groupnames');
+        groupNameObj = Lib.keyedContainer(opts, 'groupnames', 'group', 'name');
     }
 
     // An index to map group name --> expanded trace index

test/jasmine/tests/lib_test.js

@@ -1666,7 +1666,7 @@ describe('Test lib.js:', function() {
                 });
             });
 
-            describe('constrcting updates', function() {
+            describe('constructing updates', function() {
                 it('constructs updates for addition and modification', function() {
                     carr.set('foo', 'bar');
                     carr.set('name1', 'value3');
@@ -1700,6 +1700,33 @@ describe('Test lib.js:', function() {
                 });
             });
         });
+
+        describe('with custom named properties', function() {
+            it('performs standard operations', function() {
+                var container = {styles: [
+                    {foo: 'name1', bar: 'value1'},
+                    {foo: 'name2', bar: 'value2'}
+                ]};
+
+                var carr = Lib.keyedContainer(container, 'styles', 'foo', 'bar');
+
+                carr.set('name3', 'value3');
+                carr.remove('name2');
+                carr.rename('name1', 'name2');
+
+                expect(container).toEqual({styles: [
+                    {foo: 'name2', bar: 'value1'},
+                    {foo: 'name3', bar: 'value3'}
+                ]});
+
+                expect(carr.constructUpdate()).toEqual({
+                    'styles[0].foo': 'name2',
+                    'styles[1].foo': 'name3',
+                    'styles[1].bar': 'value3',
+                    'styles[2]': null
+                });
+            });
+        });
     });
 });