validate: add support for is isSubplotObj attributes

Author: etpinard

src/plot_api/validate.js

@@ -107,25 +107,27 @@ function crawl(objIn, objOut, schema, list, path) {
         var valIn = objIn[k],
             valOut = objOut[k];
 
-        if(isPlainObject(valIn) && isPlainObject(valOut)) {
-            crawl(valIn, valOut, schema[k], list, p);
-        }
-        else if(!(k in schema)) {
+        var nestedSchema = getNestedSchema(schema, k);
+
+        if(!isInSchema(schema, k)) {
             list.push(format('schema', p));
         }
-        else if(schema[k].items && Array.isArray(valIn)) {
+        else if(isPlainObject(valIn) && isPlainObject(valOut)) {
+            crawl(valIn, valOut, nestedSchema, list, p);
+        }
+        else if(nestedSchema.items && Array.isArray(valIn)) {
             var itemName = k.substr(0, k.length - 1);
 
             for(var j = 0; j < valIn.length; j++) {
                 p[p.length - 1] = k + '[' + j + ']';
 
-                crawl(valIn[j], valOut[j], schema[k].items[itemName], list, p);
+                crawl(valIn[j], valOut[j], nestedSchema.items[itemName], list, p);
             }
         }
         else if(!(k in objOut)) {
             list.push(format('unused', p, valIn));
         }
-        else if(!Lib.validate(valIn, schema[k])) {
+        else if(!Lib.validate(valIn, nestedSchema)) {
             list.push(format('value', p, valIn));
         }
     }
@@ -154,3 +156,33 @@ function format(code, path, valIn) {
         msg: code2msgFunc[code](path, valIn)
     };
 }
+
+function isInSchema(schema, key) {
+    var parts = splitKey(key),
+        keyMinusId = parts.keyMinusId,
+        id = parts.id;
+
+    if((keyMinusId in schema) && schema[keyMinusId]._isSubplotObj && id) {
+        return true;
+    }
+
+    return (key in schema);
+}
+
+function getNestedSchema(schema, key) {
+    var parts = splitKey(key);
+
+    return schema[parts.keyMinusId];
+}
+
+function splitKey(key) {
+    var idRegex = /([2-9]|[1-9][0-9]+)$/;
+
+    var keyMinusId = key.split(idRegex)[0],
+        id = key.substr(keyMinusId.length, key.length);
+
+    return {
+        keyMinusId: keyMinusId,
+        id: id
+    };
+}

test/jasmine/tests/validate_test.js

@@ -95,15 +95,41 @@ describe('Plotly.validate', function() {
                     }]
                 }
             },
+            xaxis2: {
+                type: 'date',
+                rangeselector: {
+                    buttons: [{
+                        title: '1 month'
+                    }]
+                }
+            },
             shapes: [{
                 opacity: 'none'
             }]
         });
 
-        assertErrorShape(out, [], 4);
+        assertErrorShape(out, [], 5);
         assertErrorContent(out.layout[0], 'schema', ['annotations[1]', 'arrowSymbol'], '');
         assertErrorContent(out.layout[1], 'unused', ['xaxis', 'rangeselector', 'buttons[0]', 'count'], '');
         assertErrorContent(out.layout[2], 'schema', ['xaxis', 'rangeselector', 'buttons[1]', 'title'], '');
-        assertErrorContent(out.layout[3], 'value', ['shapes[0]', 'opacity'], '');
+        assertErrorContent(out.layout[3], 'schema', ['xaxis2', 'rangeselector', 'buttons[0]', 'title'], '');
+        assertErrorContent(out.layout[4], 'value', ['shapes[0]', 'opacity'], '');
+    });
+
+    it('should work with isSubplotObj attributes', function() {
+        var out = Plotly.validate([], {
+            xaxis2: {
+                range: 30
+            },
+            scene10: {
+                bgcolor: 'red'
+            },
+            geo0: {},
+        });
+
+        assertErrorShape(out, [], 4);
+        assertErrorContent(out.layout[0], 'value', ['xaxis2', 'range'], '');
+        assertErrorContent(out.layout[1], 'unused', ['scene10'], '');
+        assertErrorContent(out.layout[2], 'schema', ['geo0'], '');
     });
 });