coerce: add 'freeLength' val object option for 'info_array'

etpinard · etpinard · commit 081bec493885 · 2016-08-03T19:02:04.000-04:00
- by default, input info array must have same length as the
  declared version, now with 'freeLength' this doesn't have to be.
- set freeLength to true for the updatem menus 'args' attribute
diff --git a/src/components/updatemenus/attributes.js b/src/components/updatemenus/attributes.js
@@ -27,6 +27,7 @@ var buttonsAttrs = {
     args: {
         valType: 'info_array',
         role: 'info',
+        freeLength: true,
         items: [
             { valType: 'any' },
             { valType: 'any' },
diff --git a/src/lib/coerce.js b/src/lib/coerce.js
@@ -233,7 +233,7 @@ exports.valObjects = {
             'An {array} of plot information.'
         ].join(' '),
         requiredOpts: ['items'],
-        otherOpts: ['dflt'],
+        otherOpts: ['dflt', 'noFixLength'],
         coerceFunction: function(v, propOut, dflt, opts) {
             if(!Array.isArray(v)) {
                 propOut.set(dflt);
@@ -255,10 +255,11 @@ exports.valObjects = {
 
             var items = opts.items;
 
-            if(v.length !== items.length) return false;
+            // when free length is off, input and declared lengths must match
+            if(!opts.freeLength && v.length !== items.length) return false;
 
-            // valid when all items are valid
-            for(var i = 0; i < items.length; i++) {
+            // valid when all input items are valid
+            for(var i = 0; i < v.length; i++) {
                 var isItemValid = exports.validate(v[i], opts.items[i]);
 
                 if(!isItemValid) return false;
diff --git a/test/jasmine/tests/lib_test.js b/test/jasmine/tests/lib_test.js
@@ -985,6 +985,29 @@ describe('Test lib.js:', function() {
                 }]
             });
         });
+
+        it('should work for valType \'info_array\' (freeLength case)', function() {
+            var shouldPass = [
+                ['marker.color', 'red'],
+                [{ 'marker.color': 'red' }, [1, 2]]
+            ];
+            var shouldFail = [
+                ['marker.color', 'red', 'red'],
+                [{ 'marker.color': 'red' }, [1, 2], 'blue']
+            ];
+
+            assert(shouldPass, shouldFail, {
+                valType: 'info_array',
+                freeLength: true,
+                items: [{
+                    valType: 'any'
+                }, {
+                    valType: 'any'
+                }, {
+                    valType: 'number'
+                }]
+            });
+        });
     });
 
     describe('setCursor', function() {
