test: add cases for array container defaults

Author: etpinard

test/jasmine/tests/annotations_test.js

@@ -10,31 +10,79 @@ var customMatchers = require('../assets/custom_matchers');
 var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
 
+
 describe('Test annotations', function() {
     'use strict';
 
     describe('supplyLayoutDefaults', function() {
+
+        function _supply(layoutIn, layoutOut) {
+            layoutOut = layoutOut || {};
+            layoutOut._has = Plots._hasPlotType.bind(layoutOut);
+
+            Annotations.supplyLayoutDefaults(layoutIn, layoutOut);
+
+            return layoutOut.annotations;
+        }
+
+        it('should skip non-array containers', function() {
+            [null, undefined, {}, 'str', 0, false, true].forEach(function(cont) {
+                var msg = '- ' + JSON.stringify(cont);
+                var layoutIn = { annotations: cont };
+                var out = _supply(layoutIn);
+
+                expect(layoutIn.annotations).toBe(cont, msg);
+                expect(out).toEqual([], msg);
+            });
+        });
+
+        it('should make non-object item visible: false', function() {
+            var annotations = [null, undefined, [], 'str', 0, false, true];
+            var layoutIn = { annotations: annotations };
+            var out = _supply(layoutIn);
+
+            expect(layoutIn.annotations).toEqual(annotations);
+
+            out.forEach(function(item, i) {
+                expect(item).toEqual({
+                    visible: false,
+                    _input: {},
+                    _index: i
+                });
+            });
+        });
+
         it('should default to pixel for axref/ayref', function() {
-            var annotationDefaults = {};
-            annotationDefaults._has = Plots._hasPlotType.bind(annotationDefaults);
+            var layoutIn = {
+                annotations: [{ showarrow: true, arrowhead: 2}]
+            };
 
-            Annotations.supplyLayoutDefaults({ annotations: [{ showarrow: true, arrowhead: 2}] }, annotationDefaults);
+            var out = _supply(layoutIn);
 
-            expect(annotationDefaults.annotations[0].axref).toEqual('pixel');
-            expect(annotationDefaults.annotations[0].ayref).toEqual('pixel');
+            expect(out[0].axref).toEqual('pixel');
+            expect(out[0].ayref).toEqual('pixel');
         });
 
         it('should convert ax/ay date coordinates to milliseconds if tail is in axis terms and axis is a date', function() {
-            var annotationOut = { xaxis: { type: 'date', range: ['2000-01-01', '2016-01-01'] }};
-            annotationOut._has = Plots._hasPlotType.bind(annotationOut);
+            var layoutIn = {
+                annotations: [{
+                    showarrow: true,
+                    axref: 'x',
+                    ayref: 'y',
+                    x: '2008-07-01',
+                    ax: '2004-07-01',
+                    y: 0,
+                    ay: 50
+                }]
+            };
 
-            var annotationIn = {
-                annotations: [{ showarrow: true, axref: 'x', ayref: 'y', x: '2008-07-01', ax: '2004-07-01', y: 0, ay: 50}]
+            var layoutOut = {
+                xaxis: { type: 'date', range: ['2000-01-01', '2016-01-01'] }
             };
 
-            Annotations.supplyLayoutDefaults(annotationIn, annotationOut);
+            _supply(layoutIn, layoutOut);
 
-            expect(annotationIn.annotations[0].ax).toEqual(Dates.dateTime2ms('2004-07-01'));
+            expect(layoutIn.annotations[0].ax).toEqual(Dates.dateTime2ms('2004-07-01'));
         });
     });
 });

test/jasmine/tests/layout_images_test.js

@@ -27,7 +27,11 @@ describe('Layout images', function() {
 
             Images.supplyLayoutDefaults(layoutIn, layoutOut);
 
-            expect(layoutOut.images).toEqual([{ visible: false }]);
+            expect(layoutOut.images).toEqual([{
+                visible: false,
+                _index: 0,
+                _input: layoutIn.images[0]
+            }]);
         });
 
         it('should reject when not an array', function() {
@@ -44,7 +48,9 @@ describe('Layout images', function() {
         });
 
         it('should coerce the correct defaults', function() {
-            layoutIn.images[0] = { source: jsLogo };
+            var image = { source: jsLogo };
+
+            layoutIn.images[0] = image;
 
             var expected = {
                 source: jsLogo,
@@ -59,7 +65,9 @@ describe('Layout images', function() {
                 sizing: 'contain',
                 opacity: 1,
                 xref: 'paper',
-                yref: 'paper'
+                yref: 'paper',
+                _input: image,
+                _index: 0
             };
 
             Images.supplyLayoutDefaults(layoutIn, layoutOut);

test/jasmine/tests/shapes_test.js

@@ -1,9 +1,12 @@
+var Shapes = require('@src/components/shapes');
 var helpers = require('@src/components/shapes/helpers');
 var constants = require('@src/components/shapes/constants');
 
 var Plotly = require('@lib/index');
 var PlotlyInternal = require('@src/plotly');
 var Lib = require('@src/lib');
+
+var Plots = PlotlyInternal.Plots;
 var Axes = PlotlyInternal.Axes;
 
 var d3 = require('d3');
@@ -12,6 +15,47 @@ var createGraphDiv = require('../assets/create_graph_div');
 var destroyGraphDiv = require('../assets/destroy_graph_div');
 
 
+describe('Test shapes defaults:', function() {
+    'use strict';
+
+    function _supply(layoutIn, layoutOut) {
+        layoutOut = layoutOut || {};
+        layoutOut._has = Plots._hasPlotType.bind(layoutOut);
+
+        Shapes.supplyLayoutDefaults(layoutIn, layoutOut);
+
+        return layoutOut.shapes;
+    }
+
+    it('should skip non-array containers', function() {
+        [null, undefined, {}, 'str', 0, false, true].forEach(function(cont) {
+            var msg = '- ' + JSON.stringify(cont);
+            var layoutIn = { shapes: cont };
+            var out = _supply(layoutIn);
+
+            expect(layoutIn.shapes).toBe(cont, msg);
+            expect(out).toEqual([], msg);
+        });
+    });
+
+    it('should make non-object item visible: false', function() {
+        var shapes = [null, undefined, [], 'str', 0, false, true];
+        var layoutIn = { shapes: shapes };
+        var out = _supply(layoutIn);
+
+        expect(layoutIn.shapes).toEqual(shapes);
+
+        out.forEach(function(item, i) {
+            expect(item).toEqual({
+                visible: false,
+                _input: {},
+                _index: i
+            });
+        });
+    });
+
+});
+
 describe('Test shapes:', function() {
     'use strict';
 

test/jasmine/tests/updatemenus_test.js

@@ -21,6 +21,38 @@ describe('update menus defaults', function() {
         layoutOut = {};
     });
 
+    it('should skip non-array containers', function() {
+        [null, undefined, {}, 'str', 0, false, true].forEach(function(cont) {
+            var msg = '- ' + JSON.stringify(cont);
+
+            layoutIn = { updatemenus: cont };
+            layoutOut = {};
+            supply(layoutIn, layoutOut);
+
+            expect(layoutIn.updatemenus).toBe(cont, msg);
+            expect(layoutOut.updatemenus).toEqual([], msg);
+        });
+    });
+
+    it('should make non-object item visible: false', function() {
+        var updatemenus = [null, undefined, [], 'str', 0, false, true];
+
+        layoutIn = { updatemenus: updatemenus };
+        layoutOut = {};
+        supply(layoutIn, layoutOut);
+
+        expect(layoutIn.updatemenus).toEqual(updatemenus);
+
+        layoutOut.updatemenus.forEach(function(item, i) {
+            expect(item).toEqual({
+                visible: false,
+                buttons: [],
+                _input: {},
+                _index: i
+            });
+        });
+    });
+
     it('should set \'visible\' to false when no buttons are present', function() {
         layoutIn.updatemenus = [{
             buttons: [{