prevent non-gregorian month/year todate range selectors

Author: alexcjohnson

src/components/rangeselector/button_attributes.js

@@ -33,7 +33,9 @@ module.exports = {
             '*step* milliseconds back.',
             'For example, with `step` set to *year* and `count` set to *1*',
             'the range update shifts the start of the range back to',
-            'January 01 of the current year.'
+            'January 01 of the current year.',
+            'Month and year *todate* are currently available only',
+            'for the built-in (Gregorian) calendar.'
         ].join(' ')
     },
     count: {

src/components/rangeselector/defaults.js

@@ -16,15 +16,15 @@ var buttonAttrs = require('./button_attributes');
 var constants = require('./constants');
 
 
-module.exports = function handleDefaults(containerIn, containerOut, layout, counterAxes) {
+module.exports = function handleDefaults(containerIn, containerOut, layout, counterAxes, calendar) {
     var selectorIn = containerIn.rangeselector || {},
         selectorOut = containerOut.rangeselector = {};
 
     function coerce(attr, dflt) {
         return Lib.coerce(selectorIn, selectorOut, attributes, attr, dflt);
     }
 
-    var buttons = buttonsDefaults(selectorIn, selectorOut);
+    var buttons = buttonsDefaults(selectorIn, selectorOut, calendar);
 
     var visible = coerce('visible', buttons.length > 0);
     if(!visible) return;
@@ -45,7 +45,7 @@ module.exports = function handleDefaults(containerIn, containerOut, layout, coun
     coerce('borderwidth');
 };
 
-function buttonsDefaults(containerIn, containerOut) {
+function buttonsDefaults(containerIn, containerOut, calendar) {
     var buttonsIn = containerIn.buttons || [],
         buttonsOut = containerOut.buttons = [];
 
@@ -63,7 +63,13 @@ function buttonsDefaults(containerIn, containerOut) {
 
         var step = coerce('step');
         if(step !== 'all') {
-            coerce('stepmode');
+            if(calendar && calendar !== 'gregorian' && (step === 'month' || step === 'year')) {
+                buttonOut.stepmode = 'backward';
+            }
+            else {
+                coerce('stepmode');
+            }
+
             coerce('count');
         }
 

src/plots/cartesian/layout_defaults.js

@@ -167,7 +167,8 @@ module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
         rangeSliderDefaults(layoutIn, layoutOut, axName, counterAxes);
 
         if(axLetter === 'x' && axLayoutOut.type === 'date') {
-            rangeSelectorDefaults(axLayoutIn, axLayoutOut, layoutOut, counterAxes);
+            rangeSelectorDefaults(axLayoutIn, axLayoutOut, layoutOut, counterAxes,
+                axLayoutOut.calendar);
         }
     });
 };

test/jasmine/tests/range_selector_test.js

@@ -17,7 +17,7 @@ describe('range selector defaults:', function() {
 
     var handleDefaults = RangeSelector.handleDefaults;
 
-    function supply(containerIn, containerOut) {
+    function supply(containerIn, containerOut, calendar) {
         containerOut.domain = [0, 1];
 
         var layout = {
@@ -26,7 +26,7 @@ describe('range selector defaults:', function() {
 
         var counterAxes = ['yaxis'];
 
-        handleDefaults(containerIn, containerOut, layout, counterAxes);
+        handleDefaults(containerIn, containerOut, layout, counterAxes, calendar);
     }
 
     it('should set \'visible\' to false when no buttons are present', function() {
@@ -94,7 +94,7 @@ describe('range selector defaults:', function() {
         };
         var containerOut = {};
 
-        supply(containerIn, containerOut, {}, []);
+        supply(containerIn, containerOut);
 
         expect(containerOut.rangeselector.visible).toBe(true);
         expect(containerOut.rangeselector.buttons).toEqual([
@@ -114,7 +114,7 @@ describe('range selector defaults:', function() {
         };
         var containerOut = {};
 
-        supply(containerIn, containerOut, {}, []);
+        supply(containerIn, containerOut);
 
         expect(containerOut.rangeselector.buttons).toEqual([{
             step: 'all',
@@ -176,6 +176,53 @@ describe('range selector defaults:', function() {
         expect(containerOut.rangeselector.x).toEqual(0.5);
         expect(containerOut.rangeselector.y).toBeCloseTo(0.87);
     });
+
+    it('should not allow month/year todate with calendars other than Gregorian', function() {
+        var containerIn = {
+            rangeselector: {
+                buttons: [{
+                    step: 'year',
+                    count: 1,
+                    stepmode: 'todate'
+                }, {
+                    step: 'month',
+                    count: 6,
+                    stepmode: 'todate'
+                }, {
+                    step: 'day',
+                    count: 1,
+                    stepmode: 'todate'
+                }, {
+                    step: 'hour',
+                    count: 1,
+                    stepmode: 'todate'
+                }]
+            }
+        };
+        var containerOut;
+        function getStepmode(button) { return button.stepmode; }
+
+        containerOut = {};
+        supply(containerIn, containerOut);
+
+        expect(containerOut.rangeselector.buttons.map(getStepmode)).toEqual([
+            'todate', 'todate', 'todate', 'todate'
+        ]);
+
+        containerOut = {};
+        supply(containerIn, containerOut, 'gregorian');
+
+        expect(containerOut.rangeselector.buttons.map(getStepmode)).toEqual([
+            'todate', 'todate', 'todate', 'todate'
+        ]);
+
+        containerOut = {};
+        supply(containerIn, containerOut, 'chinese');
+
+        expect(containerOut.rangeselector.buttons.map(getStepmode)).toEqual([
+            'backward', 'backward', 'todate', 'todate'
+        ]);
+    });
 });
 
 describe('range selector getUpdateObject:', function() {