Handle weekday strings in rangebreaks

src/plots/cartesian/axis_defaults.js

@@ -21,6 +21,8 @@ var handleCategoryOrderDefaults = require('./category_order_defaults');
 var handleLineGridDefaults = require('./line_grid_defaults');
 var setConvert = require('./set_convert');
 
+var DAY_OF_WEEK = require('./constants').WEEKDAY_PATTERN;
+
 /**
  * options: object containing:
  *
@@ -161,6 +163,27 @@ function rangebreaksDefaults(itemIn, itemOut, containerOut) {
                 itemOut.bounds = itemOut.bounds.slice(0, 2);
             }
 
+            var dfltPattern = '';
+            var i, q;
+            for(i = 0; i < bnds.length; i++) {
+                q = indexOfDay(bnds[i]);
+                if(q) {
+                    dfltPattern = DAY_OF_WEEK;
+                    break;
+                }
+            }
+            var pattern = coerce('pattern', dfltPattern);
+
+            if(pattern === DAY_OF_WEEK) {
+                for(i = 0; i < bnds.length; i++) {
+                    q = indexOfDay(bnds[i]);
+                    if(q) {
+                        // convert to integers i.e 'Sunday' --> 0
+                        itemOut.bounds[i] = bnds[i] = q - 1;
+                    }
+                }
+            }
+
             if(containerOut.autorange === false) {
                 var rng = containerOut.range;
 
@@ -175,8 +198,6 @@ function rangebreaksDefaults(itemIn, itemOut, containerOut) {
                     return;
                 }
             }
-
-            coerce('pattern');
         } else {
             var values = coerce('values');
 
@@ -189,3 +210,21 @@ function rangebreaksDefaults(itemIn, itemOut, containerOut) {
         }
     }
 }
+
+// these numbers are one more than what bounds would be mapped to
+var dayStrToNum = {
+    sun: 1,
+    mon: 2,
+    tue: 3,
+    wed: 4,
+    thu: 5,
+    fri: 6,
+    sat: 7
+};
+
+function indexOfDay(v) {
+    if(typeof v !== 'string') return;
+    return dayStrToNum[
+        String(v).substr(0, 3).toLowerCase()
+    ];
+}

src/plots/cartesian/layout_attributes.js

@@ -280,16 +280,18 @@ module.exports = {
         pattern: {
             valType: 'enumerated',
             values: [DAY_OF_WEEK, HOUR, ''],
-            dflt: '',
             role: 'info',
             editType: 'calc',
             description: [
                 'Determines a pattern on the time line that generates breaks.',
-                'If *' + DAY_OF_WEEK + '* - Sunday-based weekday as a decimal number [0, 6].',
+                'If *' + DAY_OF_WEEK + '* - days of the week in English e.g. \'Sunday\' or `\sun\`',
+                '(matching is case-insensitive and considers only the first three characters),',
+                'as well as Sunday-based integers between 0 and 6.',
                 'If *' + HOUR + '* - hour (24-hour clock) as decimal numbers between 0 and 24.',
                 'for more info.',
                 'Examples:',
-                '- { pattern: \'' + DAY_OF_WEEK + '\', bounds: [6, 0] }',
+                '- { pattern: \'' + DAY_OF_WEEK + '\', bounds: [6, 1] }',
+                ' or simply { bounds: [\'sat\', \'mon\'] }',
                 '  breaks from Saturday to Monday (i.e. skips the weekends).',
                 '- { pattern: \'' + HOUR + '\', bounds: [17, 8] }',
                 '  breaks from 5pm to 8am (i.e. skips non-work hours).'

test/jasmine/tests/axes_test.js

@@ -1135,6 +1135,33 @@ describe('Test axes', function() {
             expect(layoutOut.xaxis2.rangebreaks[0].pattern).toBe('day of week', 'coerced');
             expect(layoutOut.xaxis3.rangebreaks[0].pattern).toBe(undefined, 'not coerce, using *values*');
         });
+
+        it('should auto default rangebreaks.pattern to *day of week* when *bounds* include a weekday string and convert bounds to integer days', function() {
+            layoutIn = {
+                xaxis: {type: 'date', rangebreaks: [
+                    {bounds: ['Saturday', 'Monday']}
+                ]},
+                xaxis2: {type: 'date', rangebreaks: [
+                    {bounds: ['sun', 'thu']},
+                    {bounds: ['mon', 'fri']},
+                    {bounds: ['tue', 'sat']},
+                    {bounds: ['wed', '-1']}
+                ]}
+            };
+            layoutOut._subplots.xaxis.push('x2');
+            supplyLayoutDefaults(layoutIn, layoutOut, fullData);
+
+            expect(layoutOut.xaxis.rangebreaks[0].pattern).toBe('day of week', 'complete Capital');
+            expect(layoutOut.xaxis2.rangebreaks[0].pattern).toBe('day of week', '3-letter case');
+            expect(layoutOut.xaxis2.rangebreaks[0].bounds[0]).toBe(0, 'convert sun');
+            expect(layoutOut.xaxis2.rangebreaks[1].bounds[0]).toBe(1, 'convert mon');
+            expect(layoutOut.xaxis2.rangebreaks[2].bounds[0]).toBe(2, 'convert tue');
+            expect(layoutOut.xaxis2.rangebreaks[3].bounds[0]).toBe(3, 'convert wed');
+            expect(layoutOut.xaxis2.rangebreaks[0].bounds[1]).toBe(4, 'convert thu');
+            expect(layoutOut.xaxis2.rangebreaks[1].bounds[1]).toBe(5, 'convert fri');
+            expect(layoutOut.xaxis2.rangebreaks[2].bounds[1]).toBe(6, 'convert sat');
+            expect(layoutOut.xaxis2.rangebreaks[3].bounds[1]).toBe('-1', 'string');
+        });
     });
 
     describe('constraints relayout', function() {