Initial implementation, tests, readme

ljharb · ljharb · commit 1e91d918b2ab · 2025-04-26T22:16:08.000-07:00
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,14 @@
+{
+	"root": true,
+
+	"extends": "@ljharb",
+
+	"rules": {
+		"id-length": "off",
+		"new-cap": ["error", {
+			"capIsNewExceptions": [
+				"CanBeHeldWeakly",
+			],
+		}]
+	},
+}
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [ljharb]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: npm/weakmap.prototype.getorinsert
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
diff --git a/.github/workflows/node-aught.yml b/.github/workflows/node-aught.yml
@@ -0,0 +1,18 @@
+name: 'Tests: node.js < 10'
+
+on: [pull_request, push]
+
+jobs:
+  tests:
+    uses: ljharb/actions/.github/workflows/node.yml@main
+    with:
+      range: '< 10'
+      type: minors
+      command: npm run tests-only
+
+  node:
+    name: 'node < 10'
+    needs: [tests]
+    runs-on: ubuntu-latest
+    steps:
+      - run: 'echo tests completed'
diff --git a/.github/workflows/node-pretest.yml b/.github/workflows/node-pretest.yml
@@ -0,0 +1,7 @@
+name: 'Tests: pretest/posttest'
+
+on: [pull_request, push]
+
+jobs:
+  tests:
+    uses: ljharb/actions/.github/workflows/pretest.yml@main
diff --git a/.github/workflows/node-tens.yml b/.github/workflows/node-tens.yml
@@ -0,0 +1,18 @@
+name: 'Tests: node.js >= 10'
+
+on: [pull_request, push]
+
+jobs:
+  tests:
+    uses: ljharb/actions/.github/workflows/node.yml@main
+    with:
+      range: '>= 10'
+      type: minors
+      command: npm run tests-only
+
+  node:
+    name: 'node >= 10'
+    needs: [tests]
+    runs-on: ubuntu-latest
+    steps:
+      - run: 'echo tests completed'
diff --git a/.github/workflows/rebase.yml b/.github/workflows/rebase.yml
@@ -0,0 +1,9 @@
+name: Automatic Rebase
+
+on: [pull_request_target]
+
+jobs:
+  _:
+    uses: ljharb/actions/.github/workflows/rebase.yml@main
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/require-allow-edits.yml b/.github/workflows/require-allow-edits.yml
@@ -0,0 +1,12 @@
+name: Require “Allow Edits”
+
+on: [pull_request_target]
+
+jobs:
+  _:
+    name: "Require “Allow Edits”"
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: ljharb/require-allow-edits@main
diff --git a/.gitignore b/.gitignore
@@ -139,3 +139,5 @@ dist
 npm-shrinkwrap.json
 package-lock.json
 yarn.lock
+
+.npmignore
diff --git a/.npmrc b/.npmrc
@@ -1 +1,3 @@
 package-lock=false
+allow-same-version=true
+message=v%s
diff --git a/.nycrc b/.nycrc
@@ -0,0 +1,8 @@
+{
+	"all": true,
+	"check-coverage": false,
+	"reporter": ["text-summary", "text", "html", "json"],
+	"exclude": [
+		"coverage"
+	]
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## v1.0.0 - 2025-04-23
+
+### Commits
+
+- Initial implementation, tests, readme [`fed15f1`](https://github.com/es-shims/Map.prototype.getOrInsert/commit/fed15f14dcc406ecd49adf39c507523ff3e23342)
+- Initial commit [`7cb9162`](https://github.com/es-shims/Map.prototype.getOrInsert/commit/7cb9162a21e4772b3b22cb80f3ee1bf71ed437ff)
+- npm init [`5078c46`](https://github.com/es-shims/Map.prototype.getOrInsert/commit/5078c46d8208b81f934cdf4d9fb0b084d7de4412)
+- Only apps should have lockfiles [`b4cb4f2`](https://github.com/es-shims/Map.prototype.getOrInsert/commit/b4cb4f2ac2209ee55495d873548519f93aa84171)
diff --git a/README.md b/README.md
@@ -1,2 +1,88 @@
-# WeakMap.prototype.getOrInsert
-ES Proposal spec-compliant shim for Map.prototype.getOrInsertComputed
+# weakmap.prototype.getorinsert <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
+
+[![github actions][actions-image]][actions-url]
+[![coverage][codecov-image]][codecov-url]
+[![License][license-image]][license-url]
+[![Downloads][downloads-image]][downloads-url]
+
+[![npm badge][npm-badge-png]][package-url]
+
+An ESnext spec-compliant `WeakMap.prototype.getOrInsert` shim/polyfill/replacement that works as far down as ES3.
+
+This package implements the [es-shim API](https://github.com/es-shims/api) v3 interface. It works in an ES3-supported environment and complies with the proposed [spec](https://tc39.github.io/proposal-array-grouping/).
+
+## Getting started
+
+```sh
+npm install --save weakmap.prototype.getorinsert
+```
+
+## Usage/Examples
+
+```js
+var getOrInsert = require('weakmap.prototype.getorinsert');
+var assert = require('assert');
+
+var map = new WeakMap();
+var key = {};
+var value = {};
+
+assert.equal(map.has(key), false);
+assert.equal(getOrInsert(map, key, value), value);
+assert.equal(map.has(key), true);
+```
+
+```js
+var getPolyfill = require('weakmap.prototype.getorinsert/polyfill');
+var shim = require('weakmap.prototype.getorinsert/shim');
+var assert = require('assert');
+/* when WeakMap.prototype.getOrInsert is not present */
+delete WeakMap.prototype.getOrInsert;
+var shimmed = shim();
+
+assert.equal(shimmed, getPolyfill());
+
+var map = new WeakMap();
+var key = {};
+var value = {};
+
+assert.equal(map.has(key), false);
+assert.equal(map.getOrInsert(key, value), value);
+assert.equal(map.has(key), true);
+```
+
+```js
+var shim = require('weakmap.prototype.getorinsert/shim');
+var assert = require('assert');
+/* when WeakMap.prototype.getOrInsert is present */
+var shimmed = shim();
+
+assert.equal(shimmed, WeakMap.prototype.getOrInsert);
+
+var map = new WeakMap();
+var key = {};
+var value = {};
+
+assert.equal(map.has(key), false);
+assert.equal(map.getOrInsert(key, value), value);
+assert.equal(map.has(key), true);
+```
+
+## Tests
+Simply clone the repo, `npm install`, and run `npm test`
+
+[package-url]: https://npmjs.org/package/weakmap.prototype.getorinsert
+[npm-version-svg]: https://versionbadg.es/es-shims/WeakMap.prototype.getOrInsert.svg
+[deps-svg]: https://david-dm.org/es-shims/WeakMap.prototype.getOrInsert.svg
+[deps-url]: https://david-dm.org/es-shims/WeakMap.prototype.getOrInsert
+[dev-deps-svg]: https://david-dm.org/es-shims/WeakMap.prototype.getOrInsert/dev-status.svg
+[dev-deps-url]: https://david-dm.org/es-shims/WeakMap.prototype.getOrInsert#info=devDependencies
+[npm-badge-png]: https://nodei.co/npm/weakmap.prototype.getorinsert.png?downloads=true&stars=true
+[license-image]: https://img.shields.io/npm/l/weakmap.prototype.getorinsert.svg
+[license-url]: LICENSE
+[downloads-image]: https://img.shields.io/npm/dm/weakmap.prototype.getorinsert.svg
+[downloads-url]: https://npm-stat.com/charts.html?package=weakmap.prototype.getorinsert
+[codecov-image]: https://codecov.io/gh/es-shims/WeakMap.prototype.getOrInsert/branch/main/graphs/badge.svg
+[codecov-url]: https://app.codecov.io/gh/es-shims/WeakMap.prototype.getOrInsert/
+[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/es-shims/WeakMap.prototype.getOrInsert
+[actions-url]: https://github.com/es-shims/WeakMap.prototype.getOrInsert/actions
diff --git a/auto.js b/auto.js
@@ -0,0 +1,3 @@
+'use strict';
+
+require('./shim')();
diff --git a/implementation.js b/implementation.js
@@ -0,0 +1,34 @@
+'use strict';
+
+var callBound = require('call-bound');
+var $SyntaxError = require('es-errors/syntax');
+var $TypeError = require('es-errors/type');
+
+var CanBeHeldWeakly = require('es-abstract/2024/CanBeHeldWeakly');
+
+var $weakMapHas = callBound('WeakMap.prototype.has', true);
+var $weakMapGet = callBound('WeakMap.prototype.get', true);
+var $weakMapSet = callBound('WeakMap.prototype.set', true);
+
+module.exports = function getOrInsert(key, value) {
+	if (!$weakMapHas) {
+		throw new $SyntaxError('`getOrInsert` is not supported unless a native WeakMap exists');
+	}
+
+	var M = this; // step 1
+
+	// 2. Perform ? RequireInternalSlot(M, [[WeakMapData]]).
+	$weakMapHas(M, M); // step 2
+
+	if (!CanBeHeldWeakly(key)) {
+		throw new $TypeError('Key can not be held weakly: ' + key); // step 3
+	}
+
+	if ($weakMapHas(M, key)) { // step 4
+		return $weakMapGet(M, key); // step 4.a
+	}
+
+	$weakMapSet(M, key, value); // step 5, 6
+
+	return value; // step 7
+};
diff --git a/index.js b/index.js
@@ -0,0 +1,7 @@
+'use strict';
+
+var callBind = require('call-bind');
+
+var getPolyfill = require('./polyfill');
+
+module.exports = callBind(getPolyfill());
diff --git a/package.json b/package.json
@@ -0,0 +1,93 @@
+{
+	"name": "weakmap.prototype.getorinsert",
+	"version": "0.0.0",
+	"description": "ES Proposal spec-compliant shim for WeakMap.prototype.getOrInsert",
+	"main": "index.js",
+	"exports": {
+		".": "./index.js",
+		"./auto": "./auto.js",
+		"./polyfill": "./polyfill.js",
+		"./implementation": "./implementation.js",
+		"./shim": "./shim.js",
+		"./package.json": "./package.json"
+	},
+	"scripts": {
+		"prepack": "npmignore --auto --commentLines=autogenerated",
+		"prepublish": "not-in-publish || npm run prepublishOnly",
+		"prepublishOnly": "safe-publish-latest",
+		"pretest": "npm run --silent lint",
+		"test": "npm run tests-only",
+		"posttest": "npx npm@\">= 10.2\" audit --production",
+		"tests-only": "nyc tape 'test/**/*.js'",
+		"lint": "eslint --ext=js,mjs .",
+		"postlint": "es-shim-api && evalmd README.md",
+		"version": "auto-changelog && git add CHANGELOG.md",
+		"postversion": "auto-changelog && git add CHANGELOG.md && git commit --no-edit --amend && git tag -f \"v$(node -e \"console.log(require('./package.json').version)\")\""
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/es-shims/WeakMap.prototype.getOrInsert.git"
+	},
+	"keywords": [
+		"javascript",
+		"ecmascript",
+		"polyfill",
+		"shim",
+		"es-shims",
+		"API",
+		"WeakMap",
+		"upsert",
+		"getorinsert",
+		"insert",
+		"get"
+	],
+	"author": "Jordan Harband <ljharb@gmail.com>",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/es-shims/WeakMap.prototype.getOrInsert/issues"
+	},
+	"homepage": "https://github.com/es-shims/WeakMap.prototype.getOrInsert#readme",
+	"devDependencies": {
+		"@es-shims/api": "^3.0.2",
+		"@ljharb/eslint-config": "^21.1.1",
+		"auto-changelog": "^2.5.0",
+		"encoding": "^0.1.13",
+		"es-value-fixtures": "^1.7.1",
+		"eslint": "=8.8.0",
+		"evalmd": "^0.0.19",
+		"for-each": "^0.3.5",
+		"functions-have-names": "^1.2.3",
+		"in-publish": "^2.0.1",
+		"npmignore": "^0.3.1",
+		"nyc": "^10.3.2",
+		"object-inspect": "^1.13.4",
+		"safe-publish-latest": "^2.0.0",
+		"tape": "^5.9.0"
+	},
+	"auto-changelog": {
+		"output": "CHANGELOG.md",
+		"template": "keepachangelog",
+		"unreleased": false,
+		"commitLimit": false,
+		"backfillLimit": false,
+		"hideCredit": true
+	},
+	"publishConfig": {
+		"ignore": [
+			".github/workflows"
+		]
+	},
+	"engines": {
+		"node": ">= 0.4"
+	},
+	"testling": {
+		"files": "test/shimmed.js"
+	},
+	"dependencies": {
+		"call-bind": "^1.0.8",
+		"call-bound": "^1.0.4",
+		"define-properties": "^1.2.1",
+		"es-abstract": "^1.23.9",
+		"es-errors": "^1.3.0"
+	}
+}
diff --git a/polyfill.js b/polyfill.js
@@ -0,0 +1,7 @@
+'use strict';
+
+var implementation = require('./implementation');
+
+module.exports = function getPolyfill() {
+	return (typeof WeakMap === 'function' && WeakMap.prototype.getOrInsert) || implementation;
+};
diff --git a/shim.js b/shim.js
@@ -0,0 +1,19 @@
+'use strict';
+
+var define = require('define-properties');
+
+var getPolyfill = require('./polyfill');
+
+module.exports = function shim() {
+	var polyfill = getPolyfill();
+
+	if (typeof WeakMap === 'function') {
+		define(
+			WeakMap.prototype,
+			{ getOrInsert: polyfill },
+			{ getOrInsert: function () { return WeakMap.prototype.getOrInsert !== polyfill; } }
+		);
+	}
+
+	return polyfill;
+};
diff --git a/test/implementation.js b/test/implementation.js
diff --git a/test/index.js b/test/index.js
diff --git a/test/shimmed.js b/test/shimmed.js
diff --git a/test/tests.js b/test/tests.js

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`package-lock=false`
	`2`	`+allow-same-version=true`
	`3`	`+message=v%s`