Files
lodash/test/clone-methods.spec.js
2023-09-16 22:59:56 -07:00

446 lines
15 KiB
JavaScript

import lodashStable from 'lodash';
import {
map,
set,
realm,
body,
asyncFunc,
genFunc,
errors,
_,
LARGE_ARRAY_SIZE,
isNpm,
mapCaches,
arrayBuffer,
stubTrue,
objectProto,
symbol,
defineProperty,
getSymbols,
document,
arrayViews,
slice,
noop,
} from './utils';
import cloneDeep from '../src/cloneDeep';
import cloneDeepWith from '../src/cloneDeepWith';
import last from '../src/last';
xdescribe('clone methods', function () {
function Foo() {
this.a = 1;
}
Foo.prototype.b = 1;
Foo.c = function () {};
if (Map) {
var map = new Map();
map.set('a', 1);
map.set('b', 2);
}
if (Set) {
var set = new Set();
set.add(1);
set.add(2);
}
const objects = {
'`arguments` objects': arguments,
arrays: ['a', ''],
'array-like objects': { 0: 'a', length: 1 },
booleans: false,
'boolean objects': Object(false),
'date objects': new Date(),
'Foo instances': new Foo(),
objects: { a: 0, b: 1, c: 2 },
'objects with object values': { a: /a/, b: ['B'], c: { C: 1 } },
'objects from another document': realm.object || {},
maps: map,
'null values': null,
numbers: 0,
'number objects': Object(0),
regexes: /a/gim,
sets: set,
strings: 'a',
'string objects': Object('a'),
'undefined values': undefined,
};
objects.arrays.length = 3;
const uncloneable = {
'DOM elements': body,
functions: Foo,
'async functions': asyncFunc,
'generator functions': genFunc,
'the `Proxy` constructor': Proxy,
};
lodashStable.each(errors, (error) => {
uncloneable[`${error.name}s`] = error;
});
it('`_.clone` should perform a shallow clone', () => {
const array = [{ a: 0 }, { b: 1 }];
const actual = _.clone(array);
expect(actual).toEqual(array);
expect(actual !== array && actual[0] === array[0])
});
it('`_.cloneDeep` should deep clone objects with circular references', () => {
const object = {
foo: { b: { c: { d: {} } } },
bar: {},
};
object.foo.b.c.d = object;
object.bar.b = object.foo.b;
const actual = cloneDeep(object);
assert.ok(
actual.bar.b === actual.foo.b && actual === actual.foo.b.c.d && actual !== object,
);
});
it('`_.cloneDeep` should deep clone objects with lots of circular references', () => {
const cyclical = {};
lodashStable.times(LARGE_ARRAY_SIZE + 1, (index) => {
cyclical[`v${index}`] = [index ? cyclical[`v${index - 1}`] : cyclical];
});
const clone = cloneDeep(cyclical);
const actual = clone[`v${LARGE_ARRAY_SIZE}`][0];
expect(actual).toBe(clone[`v${LARGE_ARRAY_SIZE - 1}`]);
assert.notStrictEqual(actual, cyclical[`v${LARGE_ARRAY_SIZE - 1}`]);
});
it('`_.cloneDeepWith` should provide `stack` to `customizer`', () => {
let actual;
cloneDeepWith({ a: 1 }, function () {
actual = last(arguments);
});
expect(isNpm ? actual.constructor.name === 'Stack' : actual instanceof mapCaches.Stack)
});
lodashStable.each(['clone', 'cloneDeep'], (methodName) => {
const func = _[methodName];
const isDeep = methodName === 'cloneDeep';
lodashStable.forOwn(objects, (object, kind) => {
it(`\`_.${methodName}\` should clone ${kind}`, () => {
const actual = func(object);
expect(lodashStable.isEqual(actual, object))
if (lodashStable.isObject(object)) {
assert.notStrictEqual(actual, object);
} else {
expect(actual).toBe(object);
}
});
});
it(`\`_.${methodName}\` should clone array buffers`, () => {
if (ArrayBuffer) {
const actual = func(arrayBuffer);
expect(actual.byteLength).toBe(arrayBuffer.byteLength);
assert.notStrictEqual(actual, arrayBuffer);
}
});
it(`\`_.${methodName}\` should clone buffers`, () => {
if (Buffer) {
const buffer = Buffer.from([1, 2]);
const actual = func(buffer);
expect(actual.byteLength).toBe(buffer.byteLength);
expect(actual.inspect()).toBe(buffer.inspect());
assert.notStrictEqual(actual, buffer);
buffer[0] = 2;
expect(actual[0]).toBe(isDeep ? 2 : 1);
}
});
it(`\`_.${methodName}\` should clone \`index\` and \`input\` array properties`, () => {
const array = /c/.exec('abcde');
const actual = func(array);
expect(actual.index).toBe(2);
expect(actual.input).toBe('abcde');
});
it(`\`_.${methodName}\` should clone \`lastIndex\` regexp property`, () => {
const regexp = /c/g;
regexp.exec('abcde');
expect(func(regexp).lastIndex).toBe(3);
});
it(`\`_.${methodName}\` should clone expando properties`, () => {
const values = lodashStable.map([false, true, 1, 'a'], (value) => {
const object = Object(value);
object.a = 1;
return object;
});
const expected = lodashStable.map(values, stubTrue);
const actual = lodashStable.map(values, (value) => func(value).a === 1);
expect(actual).toEqual(expected);
});
it(`\`_.${methodName}\` should clone prototype objects`, () => {
const actual = func(Foo.prototype);
expect((actual instanceof Foo)).toBe(false)
expect(actual).toEqual({ b: 1 });
});
it(`\`_.${methodName}\` should set the \`[[Prototype]]\` of a clone`, () => {
expect(func(new Foo()) instanceof Foo)
});
it(`\`_.${methodName}\` should set the \`[[Prototype]]\` of a clone even when the \`constructor\` is incorrect`, () => {
Foo.prototype.constructor = Object;
expect(func(new Foo()) instanceof Foo)
Foo.prototype.constructor = Foo;
});
it(`\`_.${methodName}\` should ensure \`value\` constructor is a function before using its \`[[Prototype]]\``, () => {
Foo.prototype.constructor = null;
expect((func(new Foo()) instanceof Foo)).toBe(false)
Foo.prototype.constructor = Foo;
});
it(`\`_.${methodName}\` should clone properties that shadow those on \`Object.prototype\``, () => {
const object = {
constructor: objectProto.constructor,
hasOwnProperty: objectProto.hasOwnProperty,
isPrototypeOf: objectProto.isPrototypeOf,
propertyIsEnumerable: objectProto.propertyIsEnumerable,
toLocaleString: objectProto.toLocaleString,
toString: objectProto.toString,
valueOf: objectProto.valueOf,
};
const actual = func(object);
expect(actual).toEqual(object);
assert.notStrictEqual(actual, object);
});
it(`\`_.${methodName}\` should clone symbol properties`, () => {
function Foo() {
this[symbol] = { c: 1 };
}
if (Symbol) {
const symbol2 = Symbol('b');
Foo.prototype[symbol2] = 2;
const symbol3 = Symbol('c');
defineProperty(Foo.prototype, symbol3, {
configurable: true,
enumerable: false,
writable: true,
value: 3,
});
const object = { a: { b: new Foo() } };
object[symbol] = { b: 1 };
const actual = func(object);
if (isDeep) {
assert.notStrictEqual(actual[symbol], object[symbol]);
assert.notStrictEqual(actual.a, object.a);
} else {
expect(actual[symbol]).toBe(object[symbol]);
expect(actual.a).toBe(object.a);
}
expect(actual[symbol]).toEqual(object[symbol]);
expect(getSymbols(actual.a.b)).toEqual([symbol]);
expect(actual.a.b[symbol]).toEqual(object.a.b[symbol]);
expect(actual.a.b[symbol2]).toEqual(object.a.b[symbol2]);
expect(actual.a.b[symbol3]).toEqual(object.a.b[symbol3]);
}
});
it(`\`_.${methodName}\` should clone symbol objects`, () => {
if (Symbol) {
expect(func(symbol)).toBe(symbol);
const object = Object(symbol);
const actual = func(object);
expect(typeof actual).toBe('object');
expect(typeof actual.valueOf()).toBe('symbol');
assert.notStrictEqual(actual, object);
}
});
it(`\`_.${methodName}\` should not clone symbol primitives`, () => {
if (Symbol) {
expect(func(symbol)).toBe(symbol);
}
});
it(`\`_.${methodName}\` should not error on DOM elements`, () => {
if (document) {
const element = document.createElement('div');
try {
expect(func(element)).toEqual({});
} catch (e) {
expect(false, e.message)
}
}
});
it(`\`_.${methodName}\` should create an object from the same realm as \`value\``, () => {
const props = [];
const objects = lodashStable.transform(
_,
(result, value, key) => {
if (
lodashStable.startsWith(key, '_') &&
lodashStable.isObject(value) &&
!lodashStable.isArguments(value) &&
!lodashStable.isElement(value) &&
!lodashStable.isFunction(value)
) {
props.push(lodashStable.capitalize(lodashStable.camelCase(key)));
result.push(value);
}
},
[],
);
const expected = lodashStable.map(objects, stubTrue);
const actual = lodashStable.map(objects, (object) => {
const Ctor = object.constructor;
const result = func(object);
return (
result !== object && (result instanceof Ctor || !(new Ctor() instanceof Ctor))
);
});
expect(actual, expected, props.join(').toEqual('));
});
it(`\`_.${methodName}\` should perform a ${
isDeep ? 'deep' : 'shallow'
} clone when used as an iteratee for methods like \`_.map\``, () => {
const expected = [{ a: [0] }, { b: [1] }];
const actual = lodashStable.map(expected, func);
expect(actual).toEqual(expected);
if (isDeep) {
assert.ok(
actual[0] !== expected[0] &&
actual[0].a !== expected[0].a &&
actual[1].b !== expected[1].b,
);
} else {
assert.ok(
actual[0] !== expected[0] &&
actual[0].a === expected[0].a &&
actual[1].b === expected[1].b,
);
}
});
it(`\`_.${methodName}\` should return a unwrapped value when chaining`, () => {
const object = objects.objects;
const actual = _(object)[methodName]();
expect(actual).toEqual(object);
assert.notStrictEqual(actual, object);
});
lodashStable.each(arrayViews, (type) => {
it(`\`_.${methodName}\` should clone ${type} values`, () => {
const Ctor = root[type];
lodashStable.times(2, (index) => {
if (Ctor) {
const buffer = new ArrayBuffer(24);
const view = index ? new Ctor(buffer, 8, 1) : new Ctor(buffer);
const actual = func(view);
expect(actual).toEqual(view);
assert.notStrictEqual(actual, view);
expect(actual.buffer === view.buffer).toBe(!isDeep);
expect(actual.byteOffset).toBe(view.byteOffset);
expect(actual.length).toBe(view.length);
}
});
});
});
lodashStable.forOwn(uncloneable, (value, key) => {
it(`\`_.${methodName}\` should not clone ${key}`, () => {
if (value) {
const object = { a: value, b: { c: value } };
const actual = func(object);
const expected = value === Foo ? { c: Foo.c } : {};
expect(actual).toEqual(object);
assert.notStrictEqual(actual, object);
expect(func(value)).toEqual(expected);
}
});
});
});
lodashStable.each(['cloneWith', 'cloneDeepWith'], (methodName) => {
const func = _[methodName];
const isDeep = methodName === 'cloneDeepWith';
it(`\`_.${methodName}\` should provide correct \`customizer\` arguments`, () => {
const argsList = [];
const object = new Foo();
func(object, function () {
const length = arguments.length;
const args = slice.call(arguments, 0, length - (length > 1 ? 1 : 0));
argsList.push(args);
});
expect(argsList, isDeep ? [[object], [1, 'a').toEqual(object]] : [[object]]);
});
it(`\`_.${methodName}\` should handle cloning when \`customizer\` returns \`undefined\``, () => {
const actual = func({ a: { b: 'c' } }, noop);
expect(actual).toEqual({ a: { b: 'c' } });
});
lodashStable.forOwn(uncloneable, (value, key) => {
it(`\`_.${methodName}\` should work with a \`customizer\` callback and ${key}`, () => {
const customizer = function (value) {
return lodashStable.isPlainObject(value) ? undefined : value;
};
let actual = func(value, customizer);
expect(actual).toBe(value);
const object = { a: value, b: { c: value } };
actual = func(object, customizer);
expect(actual).toEqual(object);
assert.notStrictEqual(actual, object);
});
});
});
});