Skip to content

Handle weekday strings in rangebreaks #4661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Mar 19, 2020
Merged

Handle weekday strings in rangebreaks #4661

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a03d64d
Handle day of week str - add auto dflt for pattern
archmoj Mar 18, 2020
d52a803
add tests to handle weekday strings
archmoj Mar 18, 2020
05ab23c
mention matching logic in description
archmoj Mar 18, 2020
db2c3a3
attempt improve performance (a bit) by using object lookup, early ret…
archmoj Mar 18, 2020
c48f551
no need to cast string to string
archmoj Mar 18, 2020
550a375
improve matching - only need to test first two bounds - avoid touchin…
archmoj Mar 18, 2020
e481a13
validate numberic bounds when using patterns
archmoj Mar 18, 2020
84c2a6f
simplify default logic
archmoj Mar 18, 2020
9a0416a
correct axes default logic
archmoj Mar 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
correct axes default logic
  • Loading branch information
@archmoj
archmoj committed Mar 19, 2020
commit 9a0416aefb17fd0d5ac3bd26f91abb721b934a6d
24 changes: 18 additions & 6 deletions src/plots/cartesian/axis_defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,23 +188,35 @@ function rangebreaksDefaults(itemIn, itemOut, containerOut) {
q = bnds[i];
switch(pattern) {
case DAY_OF_WEEK :
if(isNumeric(q)) q = Math.floor(q);
if(!isNumeric(q)) {
itemOut.enabled = false;
return;
}
q = +q;

q = Math.floor(+q);
if(!(q >= 0 && q < 7)) {
if(
q !== Math.floor(q) || // don't accept fractional days for mow
q < 0 || q >= 7
) {
itemOut.enabled = false;
return;
}
// use int [0, 7)
// use number
itemOut.bounds[i] = bnds[i] = q;
break;

case HOUR :
if(!(q >= 0 && q <= 24)) { // accept 24
if(!isNumeric(q)) {
itemOut.enabled = false;
return;
}
q = +q;

if(q < 0 || q > 24) { // accept 24
itemOut.enabled = false;
return;
}
// use float [0, 24]
// use number
itemOut.bounds[i] = bnds[i] = q;
break;
}
Expand Down
36 changes: 25 additions & 11 deletions test/jasmine/tests/axes_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1165,15 +1165,19 @@ describe('Test axes', function() {

it('should validate inputs in respect to *day of week* pattern', function() {
layoutIn = {
xaxis: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: ['6.999', '0'] }]},
xaxis: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: ['6', '0'] }]},
xaxis2: {type: 'date', rangebreaks: [{bounds: ['Sunday'] }]},
xaxis3: {type: 'date', rangebreaks: [{bounds: ['sun', 'mon', 'tue'] }]},
xaxis4: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, '-1'] }]},
xaxis5: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, '-.001'] }]},
xaxis5: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, '-.25'] }]},
xaxis6: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, '7'] }]},
xaxis7: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, '6.999'] }]}
xaxis7: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, '6.75'] }]},
xaxis8: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, ''] }]},
xaxis9: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, null] }]},
xaxis10: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, false] }]},
xaxis11: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, true] }]}
};
layoutOut._subplots.xaxis.push('x2', 'x3', 'x4', 'x5', 'x6', 'x7');
layoutOut._subplots.xaxis.push('x2', 'x3', 'x4', 'x5', 'x6', 'x7', 'x8', 'x9', 'x10', 'x11');
supplyLayoutDefaults(layoutIn, layoutOut, fullData);

expect(layoutOut.xaxis.rangebreaks[0].enabled).toBe(true, 'valid');
Expand All @@ -1185,34 +1189,44 @@ describe('Test axes', function() {
expect(layoutOut.xaxis4.rangebreaks[0].enabled).toBe(false, 'reject bound < 0');
expect(layoutOut.xaxis5.rangebreaks[0].enabled).toBe(false, 'reject bound < 0');
expect(layoutOut.xaxis6.rangebreaks[0].enabled).toBe(false, 'reject bound >= 7');
expect(layoutOut.xaxis7.rangebreaks[0].enabled).toBe(true, 'do not reject bound < 7');
expect(layoutOut.xaxis7.rangebreaks[0].enabled).toBe(false, 'reject bound < 7 - not supported yet');
expect(layoutOut.xaxis8.rangebreaks[0].enabled).toBe(false, 'reject blank string');
expect(layoutOut.xaxis9.rangebreaks[0].enabled).toBe(false, 'reject null');
expect(layoutOut.xaxis10.rangebreaks[0].enabled).toBe(false, 'reject false');
expect(layoutOut.xaxis11.rangebreaks[0].enabled).toBe(false, 'reject true');
});

it('should validate inputs in respect to *hour* pattern', function() {
layoutIn = {
xaxis: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: ['23.999', '0'] }]},
xaxis: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: ['24', '1e-3'] }]},
xaxis2: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1] }]},
xaxis3: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1, 2, 3] }]},
xaxis4: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1, '-1'] }]},
xaxis5: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1, '-.001'] }]},
xaxis6: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1, '24.001'] }]},
xaxis7: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1, '23.999'] }]},
xaxis8: {type: 'date', rangebreaks: [{pattern: 'hour', bounds: [1, '24'] }]}
xaxis8: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, ''] }]},
xaxis9: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, null] }]},
xaxis10: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, false] }]},
xaxis11: {type: 'date', rangebreaks: [{pattern: 'day of week', bounds: [1, true] }]}
};
layoutOut._subplots.xaxis.push('x2', 'x3', 'x4', 'x5', 'x6', 'x7', 'x8');
layoutOut._subplots.xaxis.push('x2', 'x3', 'x4', 'x5', 'x6', 'x7', 'x8', 'x9', 'x10', 'x11');
supplyLayoutDefaults(layoutIn, layoutOut, fullData);

expect(layoutOut.xaxis.rangebreaks[0].enabled).toBe(true, 'valid');
expect(layoutOut.xaxis.rangebreaks[0].bounds[0]).toBe('23.999', 'do not cast float to int');
expect(layoutOut.xaxis.rangebreaks[0].bounds[1]).toBe('0', 'do not cast string to int');
expect(layoutOut.xaxis.rangebreaks[0].bounds[0]).toBe(24, 'accept 24');
expect(layoutOut.xaxis.rangebreaks[0].bounds[1]).toBe(0.001, 'cast string to float');
expect(layoutOut.xaxis2.rangebreaks[0].enabled).toBe(false, 'reject bounds.length < 2');
expect(layoutOut.xaxis3.rangebreaks[0].enabled).toBe(true, 'do not reject bounds.length > 2');
expect(layoutOut.xaxis3.rangebreaks[0].bounds.length).toBe(2, 'pick first two');
expect(layoutOut.xaxis4.rangebreaks[0].enabled).toBe(false, 'reject bound < 0');
expect(layoutOut.xaxis5.rangebreaks[0].enabled).toBe(false, 'reject bound < 0');
expect(layoutOut.xaxis6.rangebreaks[0].enabled).toBe(false, 'reject bound > 24');
expect(layoutOut.xaxis7.rangebreaks[0].enabled).toBe(true, 'do not reject bound <= 24');
expect(layoutOut.xaxis8.rangebreaks[0].enabled).toBe(true, 'do not reject 24');
expect(layoutOut.xaxis8.rangebreaks[0].enabled).toBe(false, 'reject blank string');
expect(layoutOut.xaxis9.rangebreaks[0].enabled).toBe(false, 'reject null');
expect(layoutOut.xaxis10.rangebreaks[0].enabled).toBe(false, 'reject false');
expect(layoutOut.xaxis11.rangebreaks[0].enabled).toBe(false, 'reject true');
});
});

Expand Down