RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-05-20 14:25:08 +00:00
Code Issues Activity Actions

LibJS: Rename Array.prototype.groupBy{,ToMap} => group{,ToMap}

Browse source 
This is a normative change in the Array Grouping spec.

See: 0cf4077
This commit is contained in:
Linus Groh 2022-06-13 19:47:04 +01:00
parent c10d48b72c
commit 013e2df858
6 changed files with 45 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

20
Userland/Libraries/LibJS/Runtime/ArrayPrototype.cpp
View file

@ -73,8 +73,8 @@ void ArrayPrototype::initialize(GlobalObject& global_object)
define_native_function(vm.names.keys, keys, 0, attr); define_native_function(vm.names.keys, keys, 0, attr);
define_native_function(vm.names.entries, entries, 0, attr); define_native_function(vm.names.entries, entries, 0, attr);
define_native_function(vm.names.copyWithin, copy_within, 2, attr); define_native_function(vm.names.copyWithin, copy_within, 2, attr);
define_native_function(vm.names.groupBy, group_by, 1, attr); define_native_function(vm.names.group, group, 1, attr);
define_native_function(vm.names.groupByToMap, group_by_to_map, 1, attr); define_native_function(vm.names.groupToMap, group_to_map, 1, attr);
// Use define_direct_property here instead of define_native_function so that // Use define_direct_property here instead of define_native_function so that
// Object.is(Array.prototype[Symbol.iterator], Array.prototype.values) // Object.is(Array.prototype[Symbol.iterator], Array.prototype.values)
@ -96,8 +96,8 @@ void ArrayPrototype::initialize(GlobalObject& global_object)
MUST(unscopable_list->create_data_property_or_throw(vm.names.findLastIndex, Value(true))); MUST(unscopable_list->create_data_property_or_throw(vm.names.findLastIndex, Value(true)));
MUST(unscopable_list->create_data_property_or_throw(vm.names.flat, Value(true))); MUST(unscopable_list->create_data_property_or_throw(vm.names.flat, Value(true)));
MUST(unscopable_list->create_data_property_or_throw(vm.names.flatMap, Value(true))); MUST(unscopable_list->create_data_property_or_throw(vm.names.flatMap, Value(true)));
MUST(unscopable_list->create_data_property_or_throw(vm.names.groupBy, Value(true))); MUST(unscopable_list->create_data_property_or_throw(vm.names.group, Value(true)));
MUST(unscopable_list->create_data_property_or_throw(vm.names.groupByToMap, Value(true))); MUST(unscopable_list->create_data_property_or_throw(vm.names.groupToMap, Value(true)));
MUST(unscopable_list->create_data_property_or_throw(vm.names.includes, Value(true))); MUST(unscopable_list->create_data_property_or_throw(vm.names.includes, Value(true)));
MUST(unscopable_list->create_data_property_or_throw(vm.names.keys, Value(true))); MUST(unscopable_list->create_data_property_or_throw(vm.names.keys, Value(true)));
MUST(unscopable_list->create_data_property_or_throw(vm.names.values, Value(true))); MUST(unscopable_list->create_data_property_or_throw(vm.names.values, Value(true)));
@ -1673,7 +1673,7 @@ static void add_value_to_keyed_group(GlobalObject& global_object, GroupsType& gr
{ {
// 1. For each Record { [[Key]], [[Elements]] } g of groups, do // 1. For each Record { [[Key]], [[Elements]] } g of groups, do
// a. If SameValue(g.[[Key]], key) is true, then // a. If SameValue(g.[[Key]], key) is true, then
// NOTE: This is performed in KeyedGroupTraits::equals for groupByToMap and Traits<JS::PropertyKey>::equals for groupBy. // NOTE: This is performed in KeyedGroupTraits::equals for groupToMap and Traits<JS::PropertyKey>::equals for group.
auto existing_elements_iterator = groups.find(key); auto existing_elements_iterator = groups.find(key);
if (existing_elements_iterator != groups.end()) { if (existing_elements_iterator != groups.end()) {
// i. Assert: exactly one element of groups meets this criteria. // i. Assert: exactly one element of groups meets this criteria.
@ -1695,8 +1695,9 @@ static void add_value_to_keyed_group(GlobalObject& global_object, GroupsType& gr
VERIFY(result == AK::HashSetResult::InsertedNewEntry); VERIFY(result == AK::HashSetResult::InsertedNewEntry);
} }
// 2.1 Array.prototype.groupBy ( callbackfn [ , thisArg ] ), https://tc39.es/proposal-array-grouping/#sec-array.prototype.groupby // FIXME: Spec has incorrect function ID
JS_DEFINE_NATIVE_FUNCTION(ArrayPrototype::group_by) // 2.1 Array.prototype.group ( callbackfn [ , thisArg ] ), https://tc39.es/proposal-array-grouping/#sec-array.prototype.groupby
JS_DEFINE_NATIVE_FUNCTION(ArrayPrototype::group)
{ {
auto callback_function = vm.argument(0); auto callback_function = vm.argument(0);
auto this_arg = vm.argument(1); auto this_arg = vm.argument(1);
@ -1749,8 +1750,9 @@ JS_DEFINE_NATIVE_FUNCTION(ArrayPrototype::group_by)
return object; return object;
} }
// 2.2 Array.prototype.groupByToMap ( callbackfn [ , thisArg ] ), https://tc39.es/proposal-array-grouping/#sec-array.prototype.groupbymap // FIXME: Spec has incorrect function ID
JS_DEFINE_NATIVE_FUNCTION(ArrayPrototype::group_by_to_map) // 2.2 Array.prototype.groupToMap ( callbackfn [ , thisArg ] ), https://tc39.es/proposal-array-grouping/#sec-array.prototype.groupbymap
JS_DEFINE_NATIVE_FUNCTION(ArrayPrototype::group_to_map)
{ {
auto callback_function = vm.argument(0); auto callback_function = vm.argument(0);
auto this_arg = vm.argument(1); auto this_arg = vm.argument(1);

4
Userland/Libraries/LibJS/Runtime/ArrayPrototype.h
View file

@ -54,8 +54,8 @@ private:
JS_DECLARE_NATIVE_FUNCTION(keys); JS_DECLARE_NATIVE_FUNCTION(keys);
JS_DECLARE_NATIVE_FUNCTION(entries); JS_DECLARE_NATIVE_FUNCTION(entries);
JS_DECLARE_NATIVE_FUNCTION(copy_within); JS_DECLARE_NATIVE_FUNCTION(copy_within);
JS_DECLARE_NATIVE_FUNCTION(group_by); JS_DECLARE_NATIVE_FUNCTION(group);
JS_DECLARE_NATIVE_FUNCTION(group_by_to_map); JS_DECLARE_NATIVE_FUNCTION(group_to_map);
}; };
} }

3
Userland/Libraries/LibJS/Runtime/CommonPropertyNames.h
View file

@ -243,11 +243,10 @@ namespace JS {
P(globalThis) \ P(globalThis) \
P(granularity) \ P(granularity) \
P(group) \ P(group) \
P(groupBy) \
P(groupByToMap) \
P(groupCollapsed) \ P(groupCollapsed) \
P(groupEnd) \ P(groupEnd) \
P(groups) \ P(groups) \
P(groupToMap) \
P(has) \ P(has) \
P(hasIndices) \ P(hasIndices) \
P(hasOwn) \ P(hasOwn) \

8
Userland/Libraries/LibJS/Tests/builtins/Array/Array.prototype-generic-functions.js
View file

@ -305,10 +305,10 @@ describe("ability to work with generic non-array objects", () => {
]); ]);
}); });
test("groupBy", () => { test("group", () => {
const visited = []; const visited = [];
const o = { length: 5, 0: "foo", 1: "bar", 3: "baz" }; const o = { length: 5, 0: "foo", 1: "bar", 3: "baz" };
const result = Array.prototype.groupBy.call(o, (value, _, object) => { const result = Array.prototype.group.call(o, (value, _, object) => {
expect(object).toBe(o); expect(object).toBe(o);
visited.push(value); visited.push(value);
return value !== undefined ? value.startsWith("b") : false; return value !== undefined ? value.startsWith("b") : false;
@ -318,12 +318,12 @@ describe("ability to work with generic non-array objects", () => {
expect(result.true).toEqual(["bar", "baz"]); expect(result.true).toEqual(["bar", "baz"]);
}); });
test("groupByToMap", () => { test("groupToMap", () => {
const visited = []; const visited = [];
const o = { length: 5, 0: "foo", 1: "bar", 3: "baz" }; const o = { length: 5, 0: "foo", 1: "bar", 3: "baz" };
const falseObject = { false: false }; const falseObject = { false: false };
const trueObject = { true: true }; const trueObject = { true: true };
const result = Array.prototype.groupByToMap.call(o, (value, _, object) => { const result = Array.prototype.groupToMap.call(o, (value, _, object) => {
expect(object).toBe(o); expect(object).toBe(o);
visited.push(value); visited.push(value);
return value !== undefined return value !== undefined

26
Userland/Libraries/LibJS/Tests/builtins/Array/Array.prototype.groupBy.js → Userland/Libraries/LibJS/Tests/builtins/Array/Array.prototype.group.js
View file

@ -1,25 +1,25 @@
test("length is 1", () => { test("length is 1", () => {
expect(Array.prototype.groupBy).toHaveLength(1); expect(Array.prototype.group).toHaveLength(1);
}); });
describe("errors", () => { describe("errors", () => {
test("callback must be a function", () => { test("callback must be a function", () => {
expect(() => { expect(() => {
[].groupBy(undefined); [].group(undefined);
}).toThrowWithMessage(TypeError, "undefined is not a function"); }).toThrowWithMessage(TypeError, "undefined is not a function");
}); });
test("null or undefined this value", () => { test("null or undefined this value", () => {
expect(() => { expect(() => {
Array.prototype.groupBy.call(); Array.prototype.group.call();
}).toThrowWithMessage(TypeError, "ToObject on null or undefined"); }).toThrowWithMessage(TypeError, "ToObject on null or undefined");
expect(() => { expect(() => {
Array.prototype.groupBy.call(undefined); Array.prototype.group.call(undefined);
}).toThrowWithMessage(TypeError, "ToObject on null or undefined"); }).toThrowWithMessage(TypeError, "ToObject on null or undefined");
expect(() => { expect(() => {
Array.prototype.groupBy.call(null); Array.prototype.group.call(null);
}).toThrowWithMessage(TypeError, "ToObject on null or undefined"); }).toThrowWithMessage(TypeError, "ToObject on null or undefined");
}); });
}); });
@ -29,7 +29,7 @@ describe("normal behavior", () => {
const array = [1, 2, 3, 4, 5, 6]; const array = [1, 2, 3, 4, 5, 6];
const visited = []; const visited = [];
const firstResult = array.groupBy(value => { const firstResult = array.group(value => {
visited.push(value); visited.push(value);
return value % 2 === 0; return value % 2 === 0;
}); });
@ -43,7 +43,7 @@ describe("normal behavior", () => {
expect(firstKeys[0]).toBe("false"); expect(firstKeys[0]).toBe("false");
expect(firstKeys[1]).toBe("true"); expect(firstKeys[1]).toBe("true");
const secondResult = array.groupBy((_, index) => { const secondResult = array.group((_, index) => {
return index < array.length / 2; return index < array.length / 2;
}); });
@ -56,7 +56,7 @@ describe("normal behavior", () => {
expect(secondKeys[1]).toBe("false"); expect(secondKeys[1]).toBe("false");
const thisArg = [7, 8, 9, 10, 11, 12]; const thisArg = [7, 8, 9, 10, 11, 12];
const thirdResult = array.groupBy(function (_, __, arrayVisited) { const thirdResult = array.group(function (_, __, arrayVisited) {
expect(arrayVisited).toBe(array); expect(arrayVisited).toBe(array);
expect(this).toBe(thisArg); expect(this).toBe(thisArg);
}, thisArg); }, thisArg);
@ -71,19 +71,19 @@ describe("normal behavior", () => {
}); });
test("is unscopable", () => { test("is unscopable", () => {
expect(Array.prototype[Symbol.unscopables].groupBy).toBeTrue(); expect(Array.prototype[Symbol.unscopables].group).toBeTrue();
const array = []; const array = [];
with (array) { with (array) {
expect(() => { expect(() => {
groupBy; group;
}).toThrowWithMessage(ReferenceError, "'groupBy' is not defined"); }).toThrowWithMessage(ReferenceError, "'group' is not defined");
} }
}); });
test("never calls callback with empty array", () => { test("never calls callback with empty array", () => {
var callbackCalled = 0; var callbackCalled = 0;
expect( expect(
[].groupBy(() => { [].group(() => {
callbackCalled++; callbackCalled++;
}) })
).toEqual({}); ).toEqual({});
@ -92,7 +92,7 @@ describe("normal behavior", () => {
test("calls callback once for every item", () => { test("calls callback once for every item", () => {
var callbackCalled = 0; var callbackCalled = 0;
const result = [1, 2, 3].groupBy(() => { const result = [1, 2, 3].group(() => {
callbackCalled++; callbackCalled++;
}); });
expect(result.undefined).toEqual([1, 2, 3]); expect(result.undefined).toEqual([1, 2, 3]);

28
Userland/Libraries/LibJS/Tests/builtins/Array/Array.prototype.groupByToMap.js → Userland/Libraries/LibJS/Tests/builtins/Array/Array.prototype.groupToMap.js
View file

@ -1,25 +1,25 @@
test("length is 1", () => { test("length is 1", () => {
expect(Array.prototype.groupByToMap).toHaveLength(1); expect(Array.prototype.groupToMap).toHaveLength(1);
}); });
describe("errors", () => { describe("errors", () => {
test("callback must be a function", () => { test("callback must be a function", () => {
expect(() => { expect(() => {
[].groupByToMap(undefined); [].groupToMap(undefined);
}).toThrowWithMessage(TypeError, "undefined is not a function"); }).toThrowWithMessage(TypeError, "undefined is not a function");
}); });
test("null or undefined this value", () => { test("null or undefined this value", () => {
expect(() => { expect(() => {
Array.prototype.groupByToMap.call(); Array.prototype.groupToMap.call();
}).toThrowWithMessage(TypeError, "ToObject on null or undefined"); }).toThrowWithMessage(TypeError, "ToObject on null or undefined");
expect(() => { expect(() => {
Array.prototype.groupByToMap.call(undefined); Array.prototype.groupToMap.call(undefined);
}).toThrowWithMessage(TypeError, "ToObject on null or undefined"); }).toThrowWithMessage(TypeError, "ToObject on null or undefined");
expect(() => { expect(() => {
Array.prototype.groupByToMap.call(null); Array.prototype.groupToMap.call(null);
}).toThrowWithMessage(TypeError, "ToObject on null or undefined"); }).toThrowWithMessage(TypeError, "ToObject on null or undefined");
}); });
}); });
@ -31,7 +31,7 @@ describe("normal behavior", () => {
const trueObject = { true: true }; const trueObject = { true: true };
const falseObject = { false: false }; const falseObject = { false: false };
const firstResult = array.groupByToMap(value => { const firstResult = array.groupToMap(value => {
visited.push(value); visited.push(value);
return value % 2 === 0 ? trueObject : falseObject; return value % 2 === 0 ? trueObject : falseObject;
}); });
@ -42,7 +42,7 @@ describe("normal behavior", () => {
expect(firstResult.get(trueObject)).toEqual([2, 4, 6]); expect(firstResult.get(trueObject)).toEqual([2, 4, 6]);
expect(firstResult.get(falseObject)).toEqual([1, 3, 5]); expect(firstResult.get(falseObject)).toEqual([1, 3, 5]);
const secondResult = array.groupByToMap((_, index) => { const secondResult = array.groupToMap((_, index) => {
return index < array.length / 2 ? trueObject : falseObject; return index < array.length / 2 ? trueObject : falseObject;
}); });
@ -52,7 +52,7 @@ describe("normal behavior", () => {
expect(secondResult.get(falseObject)).toEqual([4, 5, 6]); expect(secondResult.get(falseObject)).toEqual([4, 5, 6]);
const thisArg = [7, 8, 9, 10, 11, 12]; const thisArg = [7, 8, 9, 10, 11, 12];
const thirdResult = array.groupByToMap(function (_, __, arrayVisited) { const thirdResult = array.groupToMap(function (_, __, arrayVisited) {
expect(arrayVisited).toBe(array); expect(arrayVisited).toBe(array);
expect(this).toBe(thisArg); expect(this).toBe(thisArg);
}, thisArg); }, thisArg);
@ -65,18 +65,18 @@ describe("normal behavior", () => {
}); });
test("is unscopable", () => { test("is unscopable", () => {
expect(Array.prototype[Symbol.unscopables].groupByToMap).toBeTrue(); expect(Array.prototype[Symbol.unscopables].groupToMap).toBeTrue();
const array = []; const array = [];
with (array) { with (array) {
expect(() => { expect(() => {
groupByToMap; groupToMap;
}).toThrowWithMessage(ReferenceError, "'groupByToMap' is not defined"); }).toThrowWithMessage(ReferenceError, "'groupToMap' is not defined");
} }
}); });
test("never calls callback with empty array", () => { test("never calls callback with empty array", () => {
var callbackCalled = 0; var callbackCalled = 0;
const result = [].groupByToMap(() => { const result = [].groupToMap(() => {
callbackCalled++; callbackCalled++;
}); });
expect(result).toBeInstanceOf(Map); expect(result).toBeInstanceOf(Map);
@ -86,7 +86,7 @@ describe("normal behavior", () => {
test("calls callback once for every item", () => { test("calls callback once for every item", () => {
var callbackCalled = 0; var callbackCalled = 0;
const result = [1, 2, 3].groupByToMap(() => { const result = [1, 2, 3].groupToMap(() => {
callbackCalled++; callbackCalled++;
}); });
expect(result).toBeInstanceOf(Map); expect(result).toBeInstanceOf(Map);
@ -97,7 +97,7 @@ describe("normal behavior", () => {
test("still returns a Map even if the global Map constructor was changed", () => { test("still returns a Map even if the global Map constructor was changed", () => {
globalThis.Map = null; globalThis.Map = null;
const result = [1, 2].groupByToMap(value => { const result = [1, 2].groupToMap(value => {
return value % 2 === 0; return value % 2 === 0;
}); });
expect(result.size).toBe(2); expect(result.size).toBe(2);