-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Lodash: Refactor away from _.set()
in core-data
#48784
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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,33 @@ | ||
/** | ||
* Sets the value at path of object. | ||
* If a portion of path doesn’t exist, it’s created. | ||
* Arrays are created for missing index properties while objects are created | ||
* for all other missing properties. | ||
* | ||
* This function intentionally mutates the input object. | ||
* | ||
* Inspired by _.set(). | ||
* | ||
* @see https://lodash.com/docs/4.17.15#set | ||
* | ||
* @param {Object} object Object to modify | ||
* @param {Array} path Path of the property to set. | ||
* @param {*} value Value to set. | ||
*/ | ||
export default function setNestedValue( object, path, value ) { | ||
path.reduce( ( acc, key, idx ) => { | ||
if ( acc[ key ] === undefined ) { | ||
if ( Number.isInteger( path[ idx + 1 ] ) ) { | ||
acc[ key ] = []; | ||
} else { | ||
acc[ key ] = {}; | ||
} | ||
} | ||
if ( idx === path.length - 1 ) { | ||
acc[ key ] = value; | ||
} | ||
return acc[ key ]; | ||
}, object ); | ||
|
||
return object; | ||
} |
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,51 @@ | ||
/** | ||
* Internal dependencies | ||
*/ | ||
import setNestedValue from '../set-nested-value'; | ||
|
||
describe( 'setNestedValue', () => { | ||
it( 'should return the same object unmodified if path is an empty array', () => { | ||
const input = { x: 'y' }; | ||
const result = setNestedValue( input, [], 123 ); | ||
|
||
expect( result ).toBe( input ); | ||
expect( result ).toEqual( { x: 'y' } ); | ||
} ); | ||
|
||
it( 'should set values at deep level', () => { | ||
const input = { x: { y: { z: 123 } } }; | ||
const result = setNestedValue( input, [ 'x', 'y', 'z' ], 456 ); | ||
|
||
expect( result ).toEqual( { x: { y: { z: 456 } } } ); | ||
} ); | ||
|
||
it( 'should create nested objects if necessary', () => { | ||
const result = setNestedValue( {}, [ 'x', 'y', 'z' ], 123 ); | ||
|
||
expect( result ).toEqual( { x: { y: { z: 123 } } } ); | ||
} ); | ||
|
||
it( 'should create nested arrays when keys are numeric', () => { | ||
const result = setNestedValue( {}, [ 'x', 0, 'z' ], 123 ); | ||
|
||
expect( result ).toEqual( { x: [ { z: 123 } ] } ); | ||
} ); | ||
|
||
it( 'should keep remaining properties unaffected', () => { | ||
const input = { x: { y: { z: 123, z1: 'z1' }, y1: 'y1' }, x1: 'x1' }; | ||
const result = setNestedValue( input, [ 'x', 'y', 'z' ], 456 ); | ||
|
||
expect( result ).toEqual( { | ||
x: { y: { z: 456, z1: 'z1' }, y1: 'y1' }, | ||
x1: 'x1', | ||
} ); | ||
} ); | ||
|
||
it( 'should intentionally mutate the original object', () => { | ||
const input = { x: 'y' }; | ||
const result = setNestedValue( input, [ 'x' ], 'z' ); | ||
|
||
expect( result ).toBe( input ); | ||
expect( result ).toEqual( { x: 'z' } ); | ||
} ); | ||
} ); |
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.
We should probably add some tests to ensure that it behaves correctly if input is not an object, e.g.
null
orundefined
. I'll leave it to your judgement what "behaves correctly" should mean;lodash
simply does nothing, but throwing an error may be a good alternative as well.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.
Good point. Happy to alter it to do nothing as well - it's a simple condition. I've done it in 37cf182 where I also added some additional unit tests.
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.
Looks great, thank you!