Skip to content

Commit

Permalink
.extend(): fix the 'preserve' option bug when replacing with an objec…
Browse files Browse the repository at this point in the history 
…t. New option 'mask' that is the revert of 'preserve': only update an object, but do not create new keys
  • Loading branch information
@cronvel
cronvel committed Sep 17, 2021
1 parent d07a0ec commit 4722ed4
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 35 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@

v0.7.2
------

.extend(): fix the 'preserve' option bug when replacing with an object. New option 'mask' that is the revert of 'preserve': only update an object, but do not create new keys


v0.7.1
------

Expand Down
54 changes: 35 additions & 19 deletions browser/tree-kit.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -515,6 +515,7 @@ dotPath.prepend = ( object , path , value ) => {
* circular: circular references reconnection
* move: move properties to target (delete properties from the sources)
* preserve: existing properties in the target object are not overwritten
* mask: reverse of 'preserve', only update existing properties in the target, do not create new keys
* nofunc: skip functions
* deepFunc: in conjunction with 'deep', this will process sources functions like objects rather than
copying/referencing them directly into the source, thus, the result will not be a function, it forces 'deep'
Expand Down Expand Up @@ -616,8 +617,9 @@ function extendOne( runtime , options , target , source ) {
//console.log( "\nextendOne():\n" , arguments ) ;
//process.exit() ;

var j , jmax , sourceKeys , sourceKey , sourceValue , sourceValueProto ,
value , sourceDescriptor , targetKey , targetPointer , path ,
var j , jmax , path ,
sourceKeys , sourceKey , sourceValue , sourceValueIsObject , sourceValueProto , sourceDescriptor ,
targetKey , targetPointer , targetValue , targetValueIsObject ,
indexOfSource = -1 ;

// Max depth check
Expand Down Expand Up @@ -679,6 +681,11 @@ function extendOne( runtime , options , target , source ) {
}
}

// Again, trigger an eventual getter only once
targetValue = targetPointer[ targetKey ] ;
targetValueIsObject = targetValue && ( typeof targetValue === 'object' || typeof targetValue === 'function' ) ;
sourceValueIsObject = sourceValue && ( typeof sourceValue === 'object' || typeof sourceValue === 'function' ) ;


if ( options.deep // eslint-disable-line no-constant-condition
&& sourceValue
Expand All @@ -688,6 +695,8 @@ function extendOne( runtime , options , target , source ) {
&& ( ( sourceValueProto = Object.getPrototypeOf( sourceValue ) ) || true )
&& ( ! ( options.deep instanceof Set ) || options.deep.has( sourceValueProto ) )
&& ( ! options.immutables || ! options.immutables.has( sourceValueProto ) )
&& ( ! options.preserve || targetValueIsObject )
&& ( ! options.mask || targetValueIsObject )
) {
if ( options.circular ) {
indexOfSource = runtime.references.sources.indexOf( sourceValue ) ;
Expand All @@ -705,65 +714,72 @@ function extendOne( runtime , options , target , source ) {
else {
if ( indexOfSource >= 0 ) {
// Circular references reconnection...
targetValue = runtime.references.targets[ indexOfSource ] ;

if ( options.descriptor ) {
Object.defineProperty( targetPointer , targetKey , {
value: runtime.references.targets[ indexOfSource ] ,
value: targetValue ,
enumerable: sourceDescriptor.enumerable ,
writable: sourceDescriptor.writable ,
configurable: sourceDescriptor.configurable
} ) ;
}
else {
targetPointer[ targetKey ] = runtime.references.targets[ indexOfSource ] ;
targetPointer[ targetKey ] = targetValue ;
}

continue ;
}

if ( ! targetPointer[ targetKey ] || ! Object.prototype.hasOwnProperty.call( targetPointer , targetKey ) || ( typeof targetPointer[ targetKey ] !== 'object' && typeof targetPointer[ targetKey ] !== 'function' ) ) {
if ( Array.isArray( sourceValue ) ) { value = [] ; }
else if ( options.proto ) { value = Object.create( sourceValueProto ) ; } // jshint ignore:line
else if ( options.inherit ) { value = Object.create( sourceValue ) ; }
else { value = {} ; }
if ( ! targetValueIsObject || ! Object.prototype.hasOwnProperty.call( targetPointer , targetKey ) ) {
if ( Array.isArray( sourceValue ) ) { targetValue = [] ; }
else if ( options.proto ) { targetValue = Object.create( sourceValueProto ) ; } // jshint ignore:line
else if ( options.inherit ) { targetValue = Object.create( sourceValue ) ; }
else { targetValue = {} ; }

if ( options.descriptor ) {
Object.defineProperty( targetPointer , targetKey , {
value: value ,
value: targetValue ,
enumerable: sourceDescriptor.enumerable ,
writable: sourceDescriptor.writable ,
configurable: sourceDescriptor.configurable
} ) ;
}
else {
targetPointer[ targetKey ] = value ;
targetPointer[ targetKey ] = targetValue ;
}
}
else if ( options.proto && Object.getPrototypeOf( targetPointer[ targetKey ] ) !== sourceValueProto ) {
Object.setPrototypeOf( targetPointer[ targetKey ] , sourceValueProto ) ;
else if ( options.proto && Object.getPrototypeOf( targetValue ) !== sourceValueProto ) {
Object.setPrototypeOf( targetValue , sourceValueProto ) ;
}
else if ( options.inherit && Object.getPrototypeOf( targetPointer[ targetKey ] ) !== sourceValue ) {
Object.setPrototypeOf( targetPointer[ targetKey ] , sourceValue ) ;
else if ( options.inherit && Object.getPrototypeOf( targetValue ) !== sourceValue ) {
Object.setPrototypeOf( targetValue , sourceValue ) ;
}

if ( options.circular ) {
runtime.references.sources.push( sourceValue ) ;
runtime.references.targets.push( targetPointer[ targetKey ] ) ;
runtime.references.targets.push( targetValue ) ;
}

// Recursively extends sub-object
extendOne(
{ depth: runtime.depth + 1 , prefix: '' , references: runtime.references } ,
options , targetPointer[ targetKey ] , sourceValue
options , targetValue , sourceValue
) ;
}
}
else if ( options.preserve && targetPointer[ targetKey ] !== undefined ) {
else if ( options.mask && ( targetValue === undefined || targetValueIsObject || sourceValueIsObject ) ) {
// Do not create new value, and so do not delete source's properties that were not moved.
// We also do not overwrite object with non-object, and we don't overwrite non-object with object (preserve hierarchy)
continue ;
}
else if ( options.preserve && targetValue !== undefined ) {
// Do not overwrite, and so do not delete source's properties that were not moved
continue ;
}
else if ( ! options.inherit ) {
if ( options.descriptor ) { Object.defineProperty( targetPointer , targetKey , sourceDescriptor ) ; }
else { targetPointer[ targetKey ] = sourceValue ; }
else { targetPointer[ targetKey ] = targetValue = sourceValue ; }
}

// Delete owned property of the source object
Expand Down
2 changes: 1 addition & 1 deletion browser/tree-kit.min.js
View file

Large diffs are not rendered by default.

27 changes: 14 additions & 13 deletions lib/extend.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ function extendOne( runtime , options , target , source ) {
//console.log( "\nextendOne():\n" , arguments ) ;
//process.exit() ;

var j , jmax , path , value ,
var j , jmax , path ,
sourceKeys , sourceKey , sourceValue , sourceValueIsObject , sourceValueProto , sourceDescriptor ,
targetKey , targetPointer , targetValue , targetValueIsObject ,
indexOfSource = -1 ;
Expand Down Expand Up @@ -188,7 +188,6 @@ function extendOne( runtime , options , target , source ) {
}

targetPointer = target ;
console.log( "targetValue1:" , targetPointer , targetKey , targetPointer?.[ targetKey ] ) ;
targetKey = runtime.prefix + sourceKey ;

// Do not copy if property is a function and we don't want them
Expand All @@ -215,8 +214,7 @@ function extendOne( runtime , options , target , source ) {
}

// Again, trigger an eventual getter only once
console.log( "targetValue2:" , targetPointer , targetKey , targetPointer?.[ targetKey ] ) ;
targetValue = targetPointer?.[ targetKey ] ;
targetValue = targetPointer[ targetKey ] ;
targetValueIsObject = targetValue && ( typeof targetValue === 'object' || typeof targetValue === 'function' ) ;
sourceValueIsObject = sourceValue && ( typeof sourceValue === 'object' || typeof sourceValue === 'function' ) ;

Expand All @@ -229,6 +227,8 @@ function extendOne( runtime , options , target , source ) {
&& ( ( sourceValueProto = Object.getPrototypeOf( sourceValue ) ) || true )
&& ( ! ( options.deep instanceof Set ) || options.deep.has( sourceValueProto ) )
&& ( ! options.immutables || ! options.immutables.has( sourceValueProto ) )
&& ( ! options.preserve || targetValueIsObject )
&& ( ! options.mask || targetValueIsObject )
) {
if ( options.circular ) {
indexOfSource = runtime.references.sources.indexOf( sourceValue ) ;
Expand All @@ -246,38 +246,39 @@ function extendOne( runtime , options , target , source ) {
else {
if ( indexOfSource >= 0 ) {
// Circular references reconnection...
targetValue = runtime.references.targets[ indexOfSource ] ;

if ( options.descriptor ) {
Object.defineProperty( targetPointer , targetKey , {
value: runtime.references.targets[ indexOfSource ] ,
value: targetValue ,
enumerable: sourceDescriptor.enumerable ,
writable: sourceDescriptor.writable ,
configurable: sourceDescriptor.configurable
} ) ;
}
else {
targetPointer[ targetKey ] = targetValue = runtime.references.targets[ indexOfSource ] ;
targetPointer[ targetKey ] = targetValue ;
}

continue ;
}

//if ( ! targetValue || ! Object.prototype.hasOwnProperty.call( targetPointer , targetKey ) || ( typeof targetValue !== 'object' && typeof targetValue !== 'function' ) {
if ( ! targetValueIsObject || ! Object.prototype.hasOwnProperty.call( targetPointer , targetKey ) ) {
if ( Array.isArray( sourceValue ) ) { value = [] ; }
else if ( options.proto ) { value = Object.create( sourceValueProto ) ; } // jshint ignore:line
else if ( options.inherit ) { value = Object.create( sourceValue ) ; }
else { value = {} ; }
if ( Array.isArray( sourceValue ) ) { targetValue = [] ; }
else if ( options.proto ) { targetValue = Object.create( sourceValueProto ) ; } // jshint ignore:line
else if ( options.inherit ) { targetValue = Object.create( sourceValue ) ; }
else { targetValue = {} ; }

if ( options.descriptor ) {
Object.defineProperty( targetPointer , targetKey , {
value: value ,
value: targetValue ,
enumerable: sourceDescriptor.enumerable ,
writable: sourceDescriptor.writable ,
configurable: sourceDescriptor.configurable
} ) ;
}
else {
targetPointer[ targetKey ] = targetValue = value ;
targetPointer[ targetKey ] = targetValue ;
}
}
else if ( options.proto && Object.getPrototypeOf( targetValue ) !== sourceValueProto ) {
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "tree-kit",
"version": "0.7.1",
"version": "0.7.2",
"description": "Tree utilities which provides a full-featured extend and object-cloning facility, and various tools to deal with nested object structures.",
"main": "lib/tree.js",
"directories": {
Expand Down
1 change: 0 additions & 1 deletion test/extend-test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,6 @@ describe( "extend()" , () => {
} ) ;
} ) ;


it( "with the 'descriptor' option, it should preserve descriptor as well" , () => {
var r ;

Expand Down

0 comments on commit 4722ed4

Please sign in to comment.