rename methods from the Array grouping proposal

zloirock · zloirock · commit 19a7298e9c16 · 2022-06-11T20:48:15.000+07:00
tc39/proposal-array-grouping#39
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,13 @@
 ## Changelog
 ##### Unreleased
-- [`Array` find from last](https://github.com/tc39/proposal-array-find-from-last) moved to the stable ES, per June 2022 TC39 meeting
+- [`Array` find from last](https://github.com/tc39/proposal-array-find-from-last) moved to the stable ES, per June 2022 TC39 meeting:
   - `Array.prototype.findLast`
   - `Array.prototype.findLastIndex`
   - `%TypedArray%.prototype.findLast`
   - `%TypedArray%.prototype.findLastIndex`
+- Methods from [the `Array` grouping proposal](https://github.com/tc39/proposal-array-grouping) [renamed](https://github.com/tc39/proposal-array-grouping/pull/39), per June 2022 TC39 meeting:
+  - `Array.prototype.groupBy` -> `Array.prototype.group`
+  - `Array.prototype.groupByToMap` -> `Array.prototype.groupToMap`
 - Changed the order of operations in `%TypedArray%.prototype.with` following [proposal-change-array-by-copy/86](https://github.com/tc39/proposal-change-array-by-copy/issues/86), per June 2022 TC39 meeting
 - [Decorator Metadata proposal](https://github.com/tc39/proposal-decorator-metadata) extracted from [Decorators proposal](https://github.com/tc39/proposal-decorators) as a separate stage 2 proposal, `Symbol.metadataKey` replaces `Symbol.metadata`
 - Added `Array.prototype.push` polyfill with some fixes for modern engines
diff --git a/README.md b/README.md
@@ -2103,24 +2103,24 @@ core-js/proposals/well-formed-stringify
 core-js(-pure)/stage/3
 ```
 ##### [`Array` grouping](https://github.com/tc39/proposal-array-grouping)[⬆](#index)
-Modules [`esnext.array.group-by`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.group-by.js), [`esnext.array.group-by-to-map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.group-by-to-map.js).
+Modules [`esnext.array.group`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.group.js), [`esnext.array.group-to-map`](https://github.com/zloirock/core-js/blob/master/packages/core-js/modules/esnext.array.group-to-map.js).
 ```js
 class Array {
-  groupBy(callbackfn: (value: any, index: number, target: any) => key, thisArg?: any): { [key]: Array<mixed> };
-  groupByToMap(callbackfn: (value: any, index: number, target: any) => key, thisArg?: any): Map<key, Array<mixed>>;
+  group(callbackfn: (value: any, index: number, target: any) => key, thisArg?: any): { [key]: Array<mixed> };
+  groupToMap(callbackfn: (value: any, index: number, target: any) => key, thisArg?: any): Map<key, Array<mixed>>;
 }
 ```
 [*CommonJS entry points:*](#commonjs-api)
 ```
-core-js/proposals/array-grouping-stage-3
-core-js(-pure)/actual|full/array(/virtual)/group-by
-core-js(-pure)/actual|full/array(/virtual)/group-by-to-map
+core-js/proposals/array-grouping-stage-3-2
+core-js(-pure)/actual|full/array(/virtual)/group
+core-js(-pure)/actual|full/array(/virtual)/group-to-map
 ```
-[*Examples*](https://t.ly/xEqc):
+[*Examples*](https://is.gd/3a0PbH):
 ```js
-[1, 2, 3, 4, 5].groupBy(it => it % 2); // => { 1: [1, 3, 5], 0: [2, 4] }
+[1, 2, 3, 4, 5].group(it => it % 2); // => { 1: [1, 3, 5], 0: [2, 4] }
 
-const map = [1, 2, 3, 4, 5].groupByToMap(it => it % 2);
+const map = [1, 2, 3, 4, 5].groupToMap(it => it % 2);
 map.get(1); // => [1, 3, 5]
 map.get(0); // => [2, 4]
 ````
diff --git a/packages/core-js-compat/src/data.mjs b/packages/core-js-compat/src/data.mjs
@@ -1606,10 +1606,16 @@ export const data = {
   'esnext.array.find-last': null,
   // TODO: Remove from `core-js@4`
   'esnext.array.find-last-index': null,
+  'esnext.array.group': {
+  },
+  // TODO: Remove from `core-js@4`
   'esnext.array.group-by': {
   },
+  // TODO: Remove from `core-js@4`
   'esnext.array.group-by-to-map': {
   },
+  'esnext.array.group-to-map': {
+  },
   'esnext.array.is-template-object': {
   },
   // TODO: Remove from `core-js@4`
diff --git a/packages/core-js-compat/src/modules-by-versions.mjs b/packages/core-js-compat/src/modules-by-versions.mjs
@@ -146,6 +146,8 @@ export default {
     'es.array.unshift',
     'es.typed-array.find-last',
     'es.typed-array.find-last-index',
+    'esnext.array.group',
+    'esnext.array.group-to-map',
     'esnext.symbol.metadata-key',
   ],
 };
diff --git a/packages/core-js/actual/array/group-to-map.js b/packages/core-js/actual/array/group-to-map.js
@@ -0,0 +1,6 @@
+require('../../modules/es.map');
+require('../../modules/es.object.to-string');
+require('../../modules/esnext.array.group-to-map');
+var entryUnbind = require('../../internals/entry-unbind');
+
+module.exports = entryUnbind('Array', 'groupToMap');
diff --git a/packages/core-js/actual/array/group.js b/packages/core-js/actual/array/group.js
@@ -0,0 +1,4 @@
+require('../../modules/esnext.array.group');
+var entryUnbind = require('../../internals/entry-unbind');
+
+module.exports = entryUnbind('Array', 'group');
diff --git a/packages/core-js/actual/array/index.js b/packages/core-js/actual/array/index.js
@@ -3,8 +3,10 @@ require('../../modules/es.map');
 require('../../modules/es.object.to-string');
 require('../../modules/esnext.array.find-last');
 require('../../modules/esnext.array.find-last-index');
+require('../../modules/esnext.array.group');
 require('../../modules/esnext.array.group-by');
 require('../../modules/esnext.array.group-by-to-map');
+require('../../modules/esnext.array.group-to-map');
 require('../../modules/esnext.array.to-reversed');
 require('../../modules/esnext.array.to-sorted');
 require('../../modules/esnext.array.to-spliced');
diff --git a/packages/core-js/actual/array/virtual/group-to-map.js b/packages/core-js/actual/array/virtual/group-to-map.js
@@ -0,0 +1,6 @@
+require('../../../modules/es.map');
+require('../../../modules/es.object.to-string');
+require('../../../modules/esnext.array.group-to-map');
+var entryVirtual = require('../../../internals/entry-virtual');
+
+module.exports = entryVirtual('Array').groupToMap;
diff --git a/packages/core-js/actual/array/virtual/group.js b/packages/core-js/actual/array/virtual/group.js
@@ -0,0 +1,4 @@
+require('../../../modules/esnext.array.group');
+var entryVirtual = require('../../../internals/entry-virtual');
+
+module.exports = entryVirtual('Array').group;
diff --git a/packages/core-js/actual/array/virtual/index.js b/packages/core-js/actual/array/virtual/index.js
@@ -3,8 +3,10 @@ require('../../../modules/es.map');
 require('../../../modules/es.object.to-string');
 require('../../../modules/esnext.array.find-last');
 require('../../../modules/esnext.array.find-last-index');
+require('../../../modules/esnext.array.group');
 require('../../../modules/esnext.array.group-by');
 require('../../../modules/esnext.array.group-by-to-map');
+require('../../../modules/esnext.array.group-to-map');
 require('../../../modules/esnext.array.to-reversed');
 require('../../../modules/esnext.array.to-sorted');
 require('../../../modules/esnext.array.to-spliced');
diff --git a/packages/core-js/actual/instance/group-to-map.js b/packages/core-js/actual/instance/group-to-map.js
@@ -0,0 +1,9 @@
+var isPrototypeOf = require('../../internals/object-is-prototype-of');
+var method = require('../array/virtual/group-to-map');
+
+var ArrayPrototype = Array.prototype;
+
+module.exports = function (it) {
+  var own = it.groupToMap;
+  return it === ArrayPrototype || (isPrototypeOf(ArrayPrototype, it) && own === ArrayPrototype.groupToMap) ? method : own;
+};
diff --git a/packages/core-js/actual/instance/group.js b/packages/core-js/actual/instance/group.js
@@ -0,0 +1,9 @@
+var isPrototypeOf = require('../../internals/object-is-prototype-of');
+var method = require('../array/virtual/group');
+
+var ArrayPrototype = Array.prototype;
+
+module.exports = function (it) {
+  var own = it.group;
+  return it === ArrayPrototype || (isPrototypeOf(ArrayPrototype, it) && own === ArrayPrototype.group) ? method : own;
+};
diff --git a/packages/core-js/full/array/group-to-map.js b/packages/core-js/full/array/group-to-map.js
@@ -0,0 +1,3 @@
+var parent = require('../../actual/array/group-to-map');
+
+module.exports = parent;
diff --git a/packages/core-js/full/array/group.js b/packages/core-js/full/array/group.js
@@ -0,0 +1,3 @@
+var parent = require('../../actual/array/group');
+
+module.exports = parent;
diff --git a/packages/core-js/full/array/virtual/group-to-map.js b/packages/core-js/full/array/virtual/group-to-map.js
@@ -0,0 +1,3 @@
+var parent = require('../../../actual/array/virtual/group-to-map');
+
+module.exports = parent;
diff --git a/packages/core-js/full/array/virtual/group.js b/packages/core-js/full/array/virtual/group.js
@@ -0,0 +1,3 @@
+var parent = require('../../../actual/array/virtual/group');
+
+module.exports = parent;
diff --git a/packages/core-js/full/instance/group-to-map.js b/packages/core-js/full/instance/group-to-map.js
@@ -0,0 +1,3 @@
+var parent = require('../../actual/instance/group-to-map');
+
+module.exports = parent;
diff --git a/packages/core-js/full/instance/group.js b/packages/core-js/full/instance/group.js
@@ -0,0 +1,3 @@
+var parent = require('../../actual/instance/group');
+
+module.exports = parent;
diff --git a/packages/core-js/internals/array-group-to-map.js b/packages/core-js/internals/array-group-to-map.js
@@ -0,0 +1,32 @@
+'use strict';
+var getBuiltIn = require('../internals/get-built-in');
+var bind = require('../internals/function-bind-context');
+var uncurryThis = require('../internals/function-uncurry-this');
+var IndexedObject = require('../internals/indexed-object');
+var toObject = require('../internals/to-object');
+var lengthOfArrayLike = require('../internals/length-of-array-like');
+
+var Map = getBuiltIn('Map');
+var MapPrototype = Map.prototype;
+var mapGet = uncurryThis(MapPrototype.get);
+var mapHas = uncurryThis(MapPrototype.has);
+var mapSet = uncurryThis(MapPrototype.set);
+var push = uncurryThis([].push);
+
+// `Array.prototype.groupToMap` method
+// https://github.com/tc39/proposal-array-grouping
+module.exports = function groupToMap(callbackfn /* , thisArg */) {
+  var O = toObject(this);
+  var self = IndexedObject(O);
+  var boundFunction = bind(callbackfn, arguments.length > 1 ? arguments[1] : undefined);
+  var map = new Map();
+  var length = lengthOfArrayLike(self);
+  var index = 0;
+  var key, value;
+  for (;length > index; index++) {
+    value = self[index];
+    key = boundFunction(value, index, O);
+    if (mapHas(map, key)) push(mapGet(map, key), value);
+    else mapSet(map, key, [value]);
+  } return map;
+};
diff --git a/packages/core-js/internals/array-group.js b/packages/core-js/internals/array-group.js
diff --git a/packages/core-js/modules/esnext.array.group-by-to-map.js b/packages/core-js/modules/esnext.array.group-by-to-map.js
@@ -1,40 +1,14 @@
-'use strict';
+// TODO: Remove from `core-js@4`
 var $ = require('../internals/export');
-var getBuiltIn = require('../internals/get-built-in');
-var bind = require('../internals/function-bind-context');
-var uncurryThis = require('../internals/function-uncurry-this');
-var IndexedObject = require('../internals/indexed-object');
-var toObject = require('../internals/to-object');
-var lengthOfArrayLike = require('../internals/length-of-array-like');
 var arrayMethodIsStrict = require('../internals/array-method-is-strict');
 var addToUnscopables = require('../internals/add-to-unscopables');
-
-var Map = getBuiltIn('Map');
-var MapPrototype = Map.prototype;
-var mapGet = uncurryThis(MapPrototype.get);
-var mapHas = uncurryThis(MapPrototype.has);
-var mapSet = uncurryThis(MapPrototype.set);
-var push = uncurryThis([].push);
+var $groupToMap = require('../internals/array-group-to-map');
 
 // `Array.prototype.groupByToMap` method
 // https://github.com/tc39/proposal-array-grouping
 // https://bugs.webkit.org/show_bug.cgi?id=236541
-$({ target: 'Array', proto: true, forced: !arrayMethodIsStrict('groupByToMap') }, {
-  groupByToMap: function groupByToMap(callbackfn /* , thisArg */) {
-    var O = toObject(this);
-    var self = IndexedObject(O);
-    var boundFunction = bind(callbackfn, arguments.length > 1 ? arguments[1] : undefined);
-    var map = new Map();
-    var length = lengthOfArrayLike(self);
-    var index = 0;
-    var key, value;
-    for (;length > index; index++) {
-      value = self[index];
-      key = boundFunction(value, index, O);
-      if (mapHas(map, key)) push(mapGet(map, key), value);
-      else mapSet(map, key, [value]);
-    } return map;
-  }
+$({ target: 'Array', proto: true, name: 'groupToMap', forced: !arrayMethodIsStrict('groupByToMap') }, {
+  groupByToMap: $groupToMap
 });
 
 addToUnscopables('groupByToMap');
diff --git a/packages/core-js/modules/esnext.array.group-by.js b/packages/core-js/modules/esnext.array.group-by.js
@@ -1,6 +1,7 @@
 'use strict';
+// TODO: Remove from `core-js@4`
 var $ = require('../internals/export');
-var $groupBy = require('../internals/array-group-by');
+var $group = require('../internals/array-group');
 var arrayMethodIsStrict = require('../internals/array-method-is-strict');
 var addToUnscopables = require('../internals/add-to-unscopables');
 
@@ -10,7 +11,7 @@ var addToUnscopables = require('../internals/add-to-unscopables');
 $({ target: 'Array', proto: true, forced: !arrayMethodIsStrict('groupBy') }, {
   groupBy: function groupBy(callbackfn /* , thisArg */) {
     var thisArg = arguments.length > 1 ? arguments[1] : undefined;
-    return $groupBy(this, callbackfn, thisArg);
+    return $group(this, callbackfn, thisArg);
   }
 });
 
diff --git a/packages/core-js/modules/esnext.array.group-to-map.js b/packages/core-js/modules/esnext.array.group-to-map.js
@@ -0,0 +1,11 @@
+var $ = require('../internals/export');
+var addToUnscopables = require('../internals/add-to-unscopables');
+var $groupToMap = require('../internals/array-group-to-map');
+
+// `Array.prototype.groupToMap` method
+// https://github.com/tc39/proposal-array-grouping
+$({ target: 'Array', proto: true }, {
+  groupToMap: $groupToMap
+});
+
+addToUnscopables('groupToMap');
diff --git a/packages/core-js/modules/esnext.array.group.js b/packages/core-js/modules/esnext.array.group.js
@@ -0,0 +1,15 @@
+'use strict';
+var $ = require('../internals/export');
+var $group = require('../internals/array-group');
+var addToUnscopables = require('../internals/add-to-unscopables');
+
+// `Array.prototype.group` method
+// https://github.com/tc39/proposal-array-grouping
+$({ target: 'Array', proto: true }, {
+  group: function group(callbackfn /* , thisArg */) {
+    var thisArg = arguments.length > 1 ? arguments[1] : undefined;
+    return $group(this, callbackfn, thisArg);
+  }
+});
+
+addToUnscopables('group');
diff --git a/packages/core-js/modules/esnext.typed-array.group-by.js b/packages/core-js/modules/esnext.typed-array.group-by.js
@@ -1,7 +1,7 @@
 'use strict';
 // TODO: Remove from `core-js@4`
 var ArrayBufferViewCore = require('../internals/array-buffer-view-core');
-var $groupBy = require('../internals/array-group-by');
+var $group = require('../internals/array-group');
 var typedArraySpeciesConstructor = require('../internals/typed-array-species-constructor');
 
 var aTypedArray = ArrayBufferViewCore.aTypedArray;
@@ -11,5 +11,5 @@ var exportTypedArrayMethod = ArrayBufferViewCore.exportTypedArrayMethod;
 // https://github.com/tc39/proposal-array-grouping
 exportTypedArrayMethod('groupBy', function groupBy(callbackfn /* , thisArg */) {
   var thisArg = arguments.length > 1 ? arguments[1] : undefined;
-  return $groupBy(aTypedArray(this), callbackfn, thisArg, typedArraySpeciesConstructor);
+  return $group(aTypedArray(this), callbackfn, thisArg, typedArraySpeciesConstructor);
 }, true);
diff --git a/packages/core-js/proposals/array-grouping-stage-3-2.js b/packages/core-js/proposals/array-grouping-stage-3-2.js
@@ -0,0 +1,3 @@
+// https://github.com/tc39/proposal-array-grouping
+require('../modules/esnext.array.group');
+require('../modules/esnext.array.group-to-map');
diff --git a/packages/core-js/proposals/array-grouping-stage-3.js b/packages/core-js/proposals/array-grouping-stage-3.js
@@ -1,3 +1,4 @@
 // https://github.com/tc39/proposal-array-grouping
+// TODO: Remove from `core-js@4`
 require('../modules/esnext.array.group-by');
 require('../modules/esnext.array.group-by-to-map');
diff --git a/packages/core-js/stage/3.js b/packages/core-js/stage/3.js
@@ -1,6 +1,8 @@
 require('../proposals/array-find-from-last');
-require('../proposals/array-grouping-stage-3');
+require('../proposals/array-grouping-stage-3-2');
 require('../proposals/change-array-by-copy');
+// TODO: Obsolete versions, remove from `core-js@4`
+require('../proposals/array-grouping-stage-3');
 var parent = require('./4');
 
 module.exports = parent;
diff --git a/scripts/check-compat-tests.mjs b/scripts/check-compat-tests.mjs
@@ -15,6 +15,8 @@ const ignore = new Set([
   'es.weak-set',
   'esnext.aggregate-error',
   'esnext.array.filter-out',
+  'esnext.array.group-by',
+  'esnext.array.group-by-to-map',
   'esnext.array.last-index',
   'esnext.array.last-item',
   'esnext.map.update-or-insert',
diff --git a/tests/commonjs.mjs b/tests/commonjs.mjs
@@ -595,19 +595,35 @@ for (PATH of ['core-js-pure', 'core-js']) {
   }
 
   for (const NS of ['actual', 'full', 'features']) {
+    ok(typeof load(NS, 'array/group') == 'function');
+    ok(typeof load(NS, 'array/group-to-map') == 'function');
     ok(typeof load(NS, 'array/group-by') == 'function');
     ok(typeof load(NS, 'array/group-by-to-map') == 'function');
     ok(load(NS, 'array/with')([1, 2, 3], 1, 4));
     ok(load(NS, 'array/to-reversed')([1, 2, 3])[0] === 3);
     ok(load(NS, 'array/to-sorted')([3, 2, 1])[0] === 1);
     ok(load(NS, 'array/to-spliced')([3, 2, 1], 1, 1, 4, 5).length === 4);
+    ok(typeof load(NS, 'array/virtual/group') == 'function');
+    ok(typeof load(NS, 'array/virtual/group-to-map') == 'function');
     ok(typeof load(NS, 'array/virtual/group-by') == 'function');
     ok(typeof load(NS, 'array/virtual/group-by-to-map') == 'function');
     ok(load(NS, 'array/virtual/with').call([1, 2, 3], 1, 4));
     ok(load(NS, 'array/virtual/to-reversed').call([1, 2, 3])[0] === 3);
     ok(load(NS, 'array/virtual/to-sorted').call([3, 2, 1])[0] === 1);
     ok(load(NS, 'array/virtual/to-spliced').call([3, 2, 1], 1, 1, 4, 5).length === 4);
 
+    const instanceGroup = load(NS, 'instance/group');
+    ok(typeof instanceGroup == 'function');
+    ok(instanceGroup({}) === undefined);
+    ok(typeof instanceGroup([]) == 'function');
+    ok(instanceGroup([]).call([1, 2, 3], it => it % 2)[1].length === 2);
+
+    const instanceGroupToMap = load(NS, 'instance/group-to-map');
+    ok(typeof instanceGroupToMap == 'function');
+    ok(instanceGroupToMap({}) === undefined);
+    ok(typeof instanceGroupToMap([]) == 'function');
+    ok(instanceGroupToMap([]).call([1, 2, 3], it => it % 2).get(1).length === 2);
+
     const instanceGroupBy = load(NS, 'instance/group-by');
     ok(typeof instanceGroupBy == 'function');
     ok(instanceGroupBy({}) === undefined);
@@ -825,6 +841,7 @@ for (PATH of ['core-js-pure', 'core-js']) {
   load('proposals/array-from-async-stage-2');
   load('proposals/array-grouping');
   load('proposals/array-grouping-stage-3');
+  load('proposals/array-grouping-stage-3-2');
   load('proposals/array-includes');
   load('proposals/array-is-template-object');
   load('proposals/array-last');
diff --git a/tests/compat/tests.js b/tests/compat/tests.js
diff --git a/tests/pure/esnext.array.group-to-map.js b/tests/pure/esnext.array.group-to-map.js
diff --git a/tests/pure/esnext.array.group.js b/tests/pure/esnext.array.group.js
diff --git a/tests/tests/esnext.array.group-by-to-map.js b/tests/tests/esnext.array.group-by-to-map.js
diff --git a/tests/tests/esnext.array.group-to-map.js b/tests/tests/esnext.array.group-to-map.js
diff --git a/tests/tests/esnext.array.group.js b/tests/tests/esnext.array.group.js
