fix and test layout.calendar inheritance

alexcjohnson · alexcjohnson · commit 00ae2dd3f8e7 · 2016-12-06T13:34:36.000-05:00
diff --git a/src/components/colorbar/draw.js b/src/components/colorbar/draw.js
@@ -174,7 +174,8 @@ module.exports = function draw(gd, id) {
             axisOptions = {
                 letter: 'y',
                 font: fullLayout.font,
-                noHover: true
+                noHover: true,
+                calendar: fullLayout.calendar  // not really necessary (yet?)
             };
 
         // Coerce w.r.t. Axes layoutAttributes:
diff --git a/src/plots/cartesian/axis_defaults.js b/src/plots/cartesian/axis_defaults.js
@@ -74,7 +74,7 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,
         }
     }
 
-    if(axType === 'date') coerce('calendar');
+    if(axType === 'date') coerce('calendar', options.calendar);
 
     setConvert(containerOut);
 
diff --git a/src/plots/cartesian/layout_defaults.js b/src/plots/cartesian/layout_defaults.js
@@ -126,7 +126,8 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
                 showGrid: !noGrids[axName],
                 name: axName,
                 data: fullData,
-                bgColor: bgColor
+                bgColor: bgColor,
+                calendar: layoutOut.calendar
             },
             positioningOptions = {
                 letter: axLetter,
@@ -140,7 +141,7 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
             return Lib.coerce(axLayoutIn, axLayoutOut, layoutAttributes, attr, dflt);
         }
 
-        handleAxisDefaults(axLayoutIn, axLayoutOut, coerce, defaultOptions);
+        handleAxisDefaults(axLayoutIn, axLayoutOut, coerce, defaultOptions, layoutOut);
         handlePositionDefaults(axLayoutIn, axLayoutOut, coerce, positioningOptions);
 
         layoutOut[axName] = axLayoutOut;
diff --git a/src/plots/gl3d/layout/axis_defaults.js b/src/plots/gl3d/layout/axis_defaults.js
@@ -46,7 +46,8 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, options) {
                 letter: axName[0],
                 data: options.data,
                 showGrid: true,
-                bgColor: options.bgColor
+                bgColor: options.bgColor,
+                calendar: options.calendar
             });
 
         coerce('gridcolor', colorMix(containerOut.color, options.bgColor, gridLightness).toRgbString());
diff --git a/src/plots/gl3d/layout/defaults.js b/src/plots/gl3d/layout/defaults.js
@@ -41,7 +41,8 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         font: layoutOut.font,
         fullData: fullData,
         getDfltFromLayout: getDfltFromLayout,
-        paper_bgcolor: layoutOut.paper_bgcolor
+        paper_bgcolor: layoutOut.paper_bgcolor,
+        calendar: layoutOut.calendar
     });
 };
 
@@ -97,7 +98,8 @@ function handleGl3dDefaults(sceneLayoutIn, sceneLayoutOut, coerce, opts) {
         font: opts.font,
         scene: opts.id,
         data: opts.fullData,
-        bgColor: bgColorCombined
+        bgColor: bgColorCombined,
+        calendar: opts.calendar
     });
 
     coerce('dragmode', opts.getDfltFromLayout('dragmode'));
diff --git a/src/traces/contour/defaults.js b/src/traces/contour/defaults.js
@@ -22,7 +22,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
     }
 
-    var len = handleXYZDefaults(traceIn, traceOut, coerce);
+    var len = handleXYZDefaults(traceIn, traceOut, coerce, layout);
     if(!len) {
         traceOut.visible = false;
         return;
diff --git a/src/traces/heatmap/defaults.js b/src/traces/heatmap/defaults.js
@@ -22,7 +22,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
     }
 
-    var len = handleXYZDefaults(traceIn, traceOut, coerce);
+    var len = handleXYZDefaults(traceIn, traceOut, coerce, layout);
     if(!len) {
         traceOut.visible = false;
         return;
diff --git a/src/traces/heatmap/xyz_defaults.js b/src/traces/heatmap/xyz_defaults.js
@@ -14,7 +14,7 @@ var isNumeric = require('fast-isnumeric');
 var hasColumns = require('./has_columns');
 
 
-module.exports = function handleXYZDefaults(traceIn, traceOut, coerce) {
+module.exports = function handleXYZDefaults(traceIn, traceOut, coerce, layout) {
     var z = coerce('z');
     var x, y;
 
@@ -37,8 +37,9 @@ module.exports = function handleXYZDefaults(traceIn, traceOut, coerce) {
         coerce('transpose');
     }
 
-    coerce('xcalendar');
-    coerce('ycalendar');
+    var dfltCalendar = layout.calendar;
+    coerce('xcalendar', dfltCalendar);
+    coerce('ycalendar', dfltCalendar);
 
     return traceOut.z.length;
 };
diff --git a/src/traces/histogram/defaults.js b/src/traces/histogram/defaults.js
@@ -26,9 +26,6 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
     var x = coerce('x'),
         y = coerce('y');
 
-    coerce('xcalendar');
-    coerce('ycalendar');
-
     coerce('text');
 
     var orientation = coerce('orientation', (y && !x) ? 'h' : 'v'),
@@ -39,6 +36,10 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         return;
     }
 
+    var dfltCalendar = layout.calendar;
+    coerce('xcalendar', dfltCalendar);
+    coerce('ycalendar', dfltCalendar);
+
     var hasAggregationData = traceOut[orientation === 'h' ? 'x' : 'y'];
     if(hasAggregationData) coerce('histfunc');
 
diff --git a/src/traces/histogram2d/defaults.js b/src/traces/histogram2d/defaults.js
@@ -16,12 +16,12 @@ var colorscaleDefaults = require('../../components/colorscale/defaults');
 var attributes = require('./attributes');
 
 
-module.exports = function supplyDefaults(traceIn, traceOut, layout) {
+module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
     function coerce(attr, dflt) {
         return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
     }
 
-    handleSampleDefaults(traceIn, traceOut, coerce);
+    handleSampleDefaults(traceIn, traceOut, coerce, layout);
 
     var zsmooth = coerce('zsmooth');
     if(zsmooth === false) {
diff --git a/src/traces/histogram2d/sample_defaults.js b/src/traces/histogram2d/sample_defaults.js
@@ -12,12 +12,13 @@
 var handleBinDefaults = require('../histogram/bin_defaults');
 
 
-module.exports = function handleSampleDefaults(traceIn, traceOut, coerce) {
+module.exports = function handleSampleDefaults(traceIn, traceOut, coerce, layout) {
     var x = coerce('x'),
         y = coerce('y');
 
-    coerce('xcalendar');
-    coerce('ycalendar');
+    var dfltCalendar = layout.calendar;
+    coerce('xcalendar', dfltCalendar);
+    coerce('ycalendar', dfltCalendar);
 
     // we could try to accept x0 and dx, etc...
     // but that's a pretty weird use case.
diff --git a/src/traces/histogram2dcontour/defaults.js b/src/traces/histogram2dcontour/defaults.js
@@ -21,7 +21,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
         return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);
     }
 
-    handleSampleDefaults(traceIn, traceOut, coerce);
+    handleSampleDefaults(traceIn, traceOut, coerce, layout);
 
     var contourStart = Lib.coerce2(traceIn, traceOut, attributes, 'contours.start'),
         contourEnd = Lib.coerce2(traceIn, traceOut, attributes, 'contours.end'),
diff --git a/test/jasmine/tests/axes_test.js b/test/jasmine/tests/axes_test.js
@@ -385,6 +385,34 @@ describe('Test axes', function() {
             expect(layoutOut.yaxis2.gridcolor)
                 .toEqual(tinycolor.mix('#444', bgColor, frac).toRgbString());
         });
+
+        it('should inherit calendar from the layout', function() {
+            layoutOut.calendar = 'nepali';
+            layoutIn = {
+                calendar: 'nepali',
+                xaxis: {type: 'date'},
+                yaxis: {type: 'date'}
+            };
+
+            supplyLayoutDefaults(layoutIn, layoutOut, fullData);
+
+            expect(layoutOut.xaxis.calendar).toBe('nepali');
+            expect(layoutOut.yaxis.calendar).toBe('nepali');
+        });
+
+        it('should allow its own calendar', function() {
+            layoutOut.calendar = 'nepali';
+            layoutIn = {
+                calendar: 'nepali',
+                xaxis: {type: 'date', calendar: 'coptic'},
+                yaxis: {type: 'date', calendar: 'thai'}
+            };
+
+            supplyLayoutDefaults(layoutIn, layoutOut, fullData);
+
+            expect(layoutOut.xaxis.calendar).toBe('coptic');
+            expect(layoutOut.yaxis.calendar).toBe('thai');
+        });
     });
 
     describe('categoryorder', function() {
diff --git a/test/jasmine/tests/bar_test.js b/test/jasmine/tests/bar_test.js
@@ -106,7 +106,7 @@ describe('Bar.supplyDefaults', function() {
             font: {family: 'arial', color: '#AAA', size: 13}
         };
 
-        supplyDefaults(traceIn, traceOut, defaultColor, layout, {});
+        supplyDefaults(traceIn, traceOut, defaultColor, layout);
 
         expect(traceOut.textposition).toBe('inside');
         expect(traceOut.textfont).toEqual(layout.font);
@@ -116,6 +116,32 @@ describe('Bar.supplyDefaults', function() {
         expect(traceOut.insidetextfont).not.toBe(traceOut.textfont);
         expect(traceOut.outsidetexfont).toBeUndefined();
     });
+
+    it('should inherit layout.calendar', function() {
+        traceIn = {
+            x: [1, 2, 3],
+            y: [1, 2, 3]
+        };
+        supplyDefaults(traceIn, traceOut, defaultColor, {calendar: 'islamic'});
+
+        // we always fill calendar attributes, because it's hard to tell if
+        // we're on a date axis at this point.
+        expect(traceOut.xcalendar).toBe('islamic');
+        expect(traceOut.ycalendar).toBe('islamic');
+    });
+
+    it('should take its own calendars', function() {
+        traceIn = {
+            x: [1, 2, 3],
+            y: [1, 2, 3],
+            xcalendar: 'coptic',
+            ycalendar: 'ethiopian'
+        };
+        supplyDefaults(traceIn, traceOut, defaultColor, {calendar: 'islamic'});
+
+        expect(traceOut.xcalendar).toBe('coptic');
+        expect(traceOut.ycalendar).toBe('ethiopian');
+    });
 });
 
 describe('heatmap calc / setPositions', function() {
diff --git a/test/jasmine/tests/box_test.js b/test/jasmine/tests/box_test.js
@@ -81,6 +81,32 @@ describe('Test boxes', function() {
 
         });
 
+        it('should inherit layout.calendar', function() {
+            traceIn = {
+                y: [1, 2, 3]
+            };
+            supplyDefaults(traceIn, traceOut, defaultColor, {calendar: 'islamic'});
+
+            // we always fill calendar attributes, because it's hard to tell if
+            // we're on a date axis at this point.
+            expect(traceOut.xcalendar).toBe('islamic');
+            expect(traceOut.ycalendar).toBe('islamic');
+        });
+
+        it('should take its own calendars', function() {
+            traceIn = {
+                y: [1, 2, 3],
+                xcalendar: 'coptic',
+                ycalendar: 'ethiopian'
+            };
+            supplyDefaults(traceIn, traceOut, defaultColor, {calendar: 'islamic'});
+
+            // we always fill calendar attributes, because it's hard to tell if
+            // we're on a date axis at this point.
+            expect(traceOut.xcalendar).toBe('coptic');
+            expect(traceOut.ycalendar).toBe('ethiopian');
+        });
+
     });
 
 });
diff --git a/test/jasmine/tests/contour_test.js b/test/jasmine/tests/contour_test.js
@@ -51,6 +51,36 @@ describe('contour defaults', function() {
         supplyDefaults(traceIn, traceOut, defaultColor, layout);
         expect(traceOut.autocontour).toBe(true);
     });
+
+    it('should inherit layout.calendar', function() {
+        traceIn = {
+            x: [1, 2],
+            y: [1, 2],
+            z: [[1, 2], [3, 4]]
+        };
+        supplyDefaults(traceIn, traceOut, defaultColor, {calendar: 'islamic'});
+
+        // we always fill calendar attributes, because it's hard to tell if
+        // we're on a date axis at this point.
+        expect(traceOut.xcalendar).toBe('islamic');
+        expect(traceOut.ycalendar).toBe('islamic');
+    });
+
+    it('should take its own calendars', function() {
+        traceIn = {
+            x: [1, 2],
+            y: [1, 2],
+            z: [[1, 2], [3, 4]],
+            xcalendar: 'coptic',
+            ycalendar: 'ethiopian'
+        };
+        supplyDefaults(traceIn, traceOut, defaultColor, {calendar: 'islamic'});
+
+        // we always fill calendar attributes, because it's hard to tell if
+        // we're on a date axis at this point.
+        expect(traceOut.xcalendar).toBe('coptic');
+        expect(traceOut.ycalendar).toBe('ethiopian');
+    });
 });
 
 describe('contour makeColorMap', function() {
diff --git a/test/jasmine/tests/finance_test.js b/test/jasmine/tests/finance_test.js
@@ -331,6 +331,42 @@ describe('finance charts defaults:', function() {
         expect(out1.layout.xaxis.rangeslider).toBeDefined();
         expect(out1._fullLayout.xaxis.rangeslider.visible).toBe(false);
     });
+
+    it('pushes layout.calendar to all output traces', function() {
+        var trace0 = Lib.extendDeep({}, mock0, {
+            type: 'ohlc'
+        });
+
+        var trace1 = Lib.extendDeep({}, mock1, {
+            type: 'candlestick'
+        });
+
+        var out = _supply([trace0, trace1], {calendar: 'nanakshahi'});
+
+
+        out._fullData.forEach(function(fullTrace) {
+            expect(fullTrace.xcalendar).toBe('nanakshahi');
+        });
+    });
+
+    it('accepts a calendar per input trace', function() {
+        var trace0 = Lib.extendDeep({}, mock0, {
+            type: 'ohlc',
+            xcalendar: 'hebrew'
+        });
+
+        var trace1 = Lib.extendDeep({}, mock1, {
+            type: 'candlestick',
+            xcalendar: 'julian'
+        });
+
+        var out = _supply([trace0, trace1], {calendar: 'nanakshahi'});
+
+
+        out._fullData.forEach(function(fullTrace, i) {
+            expect(fullTrace.xcalendar).toBe(i < 2 ? 'hebrew' : 'julian');
+        });
+    });
 });
 
 describe('finance charts calc transforms:', function() {
diff --git a/test/jasmine/tests/gl3daxes_test.js b/test/jasmine/tests/gl3daxes_test.js
@@ -75,5 +75,35 @@ describe('Test Gl3dAxes', function() {
                 checkKeys(expected[axis], layoutOut[axis]);
             });
         });
+
+        it('should inherit layout.calendar', function() {
+            layoutIn = {
+                xaxis: {type: 'date'},
+                yaxis: {type: 'date'},
+                zaxis: {type: 'date'}
+            };
+            options.calendar = 'taiwan';
+
+            supplyLayoutDefaults(layoutIn, layoutOut, options);
+
+            expect(layoutOut.xaxis.calendar).toBe('taiwan');
+            expect(layoutOut.yaxis.calendar).toBe('taiwan');
+            expect(layoutOut.zaxis.calendar).toBe('taiwan');
+        });
+
+        it('should accept its own calendar', function() {
+            layoutIn = {
+                xaxis: {type: 'date', calendar: 'hebrew'},
+                yaxis: {type: 'date', calendar: 'ummalqura'},
+                zaxis: {type: 'date', calendar: 'discworld'}
+            };
+            options.calendar = 'taiwan';
+
+            supplyLayoutDefaults(layoutIn, layoutOut, options);
+
+            expect(layoutOut.xaxis.calendar).toBe('hebrew');
+            expect(layoutOut.yaxis.calendar).toBe('ummalqura');
+            expect(layoutOut.zaxis.calendar).toBe('discworld');
+        });
     });
 });
diff --git a/test/jasmine/tests/heatmap_test.js b/test/jasmine/tests/heatmap_test.js
diff --git a/test/jasmine/tests/histogram2d_test.js b/test/jasmine/tests/histogram2d_test.js
diff --git a/test/jasmine/tests/histogram_test.js b/test/jasmine/tests/histogram_test.js
diff --git a/test/jasmine/tests/range_selector_test.js b/test/jasmine/tests/range_selector_test.js
diff --git a/test/jasmine/tests/scatter3d_test.js b/test/jasmine/tests/scatter3d_test.js
diff --git a/test/jasmine/tests/scatter_test.js b/test/jasmine/tests/scatter_test.js
diff --git a/test/jasmine/tests/surface_test.js b/test/jasmine/tests/surface_test.js

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,`
`74`	`74`	`}`
`75`	`75`	`}`
`76`	`76`
`77`		`- if(axType === 'date') coerce('calendar');`
	`77`	`+ if(axType === 'date') coerce('calendar', options.calendar);`
`78`	`78`
`79`	`79`	`setConvert(containerOut);`
`80`	`80`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout`
`22`	`22`	`return Lib.coerce(traceIn, traceOut, attributes, attr, dflt);`
`23`	`23`	`}`
`24`	`24`
`25`		`- var len = handleXYZDefaults(traceIn, traceOut, coerce);`
	`25`	`+ var len = handleXYZDefaults(traceIn, traceOut, coerce, layout);`
`26`	`26`	`if(!len) {`
`27`	`27`	`traceOut.visible = false;`
`28`	`28`	`return;`