Skip to content

Fix regression in lib/clean_number #1184

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

Closed
wants to merge 2 commits into from
Closed

Fix regression in lib/clean_number #1184

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6852f28
fix regression in lib/clean_number
etpinard Nov 21, 2016
0341916
test: add more clean number cases
etpinard Nov 21, 2016
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
7 changes: 3 additions & 4 deletions src/lib/clean_number.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,16 @@ var isNumeric = require('fast-isnumeric');

var BADNUM = require('../constants/numerical').BADNUM;

// precompile these regex's for speed
var FRONTJUNK = /^['"%,$#\s']+/;
var ENDJUNK = /['"%,$#\s']+$/;
// precompile for speed
var JUNK = /['"%,$#\s]/g;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Back to what it was pre #1078 on

https://github.com/plotly/plotly.js/pull/1078/files#diff-9664b6a57e7771275ffd0c8805ea5917L30


/**
* cleanNumber: remove common leading and trailing cruft
* Always returns either a number or BADNUM.
*/
module.exports = function cleanNumber(v) {
if(typeof v === 'string') {
v = v.replace(FRONTJUNK, '').replace(ENDJUNK, '');
v = v.replace(JUNK, '');
}

if(isNumeric(v)) return Number(v);
Expand Down
14 changes: 10 additions & 4 deletions test/jasmine/tests/lib_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1514,24 +1514,30 @@ describe('Test lib.js:', function() {
});
});

it('should accept number strings with arbitrary cruft on the outside', function() {
it('should accept number strings with arbitrary cruft', function() {
[
['0', 0],
['1', 1],
['1.23', 1.23],
['-100.001', -100.001],
[' $4.325 #%\t', 4.325],
[' " #1" ', 1],
[' \'\n \r -9.2e7 \t\' ', -9.2e7]
[' \'\n \r -9.2e7 \t\' ', -9.2e7],

// post https://github.com/plotly/plotly.js/issues/1183
['2 2', 22],
['2%2', 22],
['2$2', 22],
['1,690,000', 1690000]
Copy link
Member

@chriddyp chriddyp Nov 21, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could we add one for '$5,162,000.00' to 5162000?

Copy link
Member

@chriddyp chriddyp Nov 21, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also: " $1,410,000.00 " to 1410000?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right that this is what we had before - which is exactly why I changed it, though obviously I forgot about commas in the middle! I really think we should consider interpreting '2 2', '2%2', '2$2' etc as numbers to be bugs we should fix, unless someone can show me a legitimate use case for them to be interpreted as 22.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about '1 000 000' ?

].forEach(function(v) {
expect(Lib.cleanNumber(v[0])).toBe(v[1], v[0]);
});
});

it('should not accept other objects or cruft in the middle', function() {
it('should not accept other objects', function() {
[
NaN, Infinity, -Infinity, null, undefined, new Date(), '',
' ', '\t', '2 2', '2%2', '2$2', {1: 2}, [1], ['1'], {}, []
' ', '\t', , {1: 2}, [1], ['1'], {}, []
].forEach(function(v) {
expect(Lib.cleanNumber(v)).toBeUndefined(v);
});
Expand Down