-
Notifications
You must be signed in to change notification settings - Fork 79
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.
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
fix(formatting): Date/RegExp values output by formatComplexDataStructure #250
Merged
armandabric
merged 2 commits into
algolia:master
from
lahmatiy:fix-format-complex-data-structure
Nov 15, 2017
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -70,7 +70,6 @@ | |
}, | ||
"dependencies": { | ||
"is-plain-object": "2.0.4", | ||
"sortobject": "1.1.1", | ||
"stringify-object": "3.2.1" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
/* @flow */ | ||
|
||
export default function sortObject(value: any): any { | ||
// return non-object value as is | ||
if (value === null || typeof value !== 'object') { | ||
return value; | ||
} | ||
|
||
// return date and regexp values as is | ||
if (value instanceof Date || value instanceof RegExp) { | ||
return value; | ||
} | ||
|
||
// make a copy of array with each item passed through sortObject() | ||
if (Array.isArray(value)) { | ||
return value.map(sortObject); | ||
} | ||
|
||
// make a copy of object with key sorted | ||
return Object.keys(value) | ||
.sort() | ||
.reduce((result, key) => { | ||
// eslint-disable-next-line no-param-reassign | ||
result[key] = sortObject(value[key]); | ||
return result; | ||
}, {}); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
/* @flow */ | ||
|
||
import sortObject from './sortObject'; | ||
|
||
describe('sortObject', () => { | ||
it('should sort keys in objects', () => { | ||
const fixture = { | ||
c: 2, | ||
b: { x: 1, c: 'ccc' }, | ||
a: [{ foo: 1, bar: 2 }], | ||
}; | ||
|
||
expect(JSON.stringify(sortObject(fixture))).toEqual( | ||
JSON.stringify({ | ||
a: [{ bar: 2, foo: 1 }], | ||
b: { c: 'ccc', x: 1 }, | ||
c: 2, | ||
}) | ||
); | ||
}); | ||
|
||
it('should process an array', () => { | ||
const fixture = [{ foo: 1, bar: 2 }, null, { b: 1, c: 2, a: 3 }]; | ||
|
||
expect(JSON.stringify(sortObject(fixture))).toEqual( | ||
JSON.stringify([{ bar: 2, foo: 1 }, null, { a: 3, b: 1, c: 2 }]) | ||
); | ||
}); | ||
|
||
it('should not break special values', () => { | ||
const date = new Date(); | ||
const regexp = /test/g; | ||
const fixture = { | ||
a: [date, regexp], | ||
b: regexp, | ||
c: date, | ||
}; | ||
|
||
expect(sortObject(fixture)).toEqual({ | ||
a: [date, regexp], | ||
b: regexp, | ||
c: date, | ||
}); | ||
}); | ||
}); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could you add a test that validate that There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess theses tests are more related to
sortObject
behavior than theformatComplexDataStructure
one. We should move then in thesortObject.spec.js
fileThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sortObject
has its own test for that. I think left it here since not onlysortObject
is used to process objects and other logic can break things too.