superlock 0.0.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2022 Kiko Beats <josefrancisco.verdu@gmail.com> (kikobeats.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,106 @@
+![Last version](https://img.shields.io/github/tag/superlock.svg?style=flat-square)
+[![Coverage Status](https://img.shields.io/coveralls/superlock.svg?style=flat-square)](https://coveralls.io/github/superlock)
+[![NPM Status](https://img.shields.io/npm/dm/superlock.svg?style=flat-square)](https://www.npmjs.org/package/superlock)
+
+> A mutex/semaphore implementation made easy to use.
+
+## Why
+
+**superlock** aims to be:
+
+- **Simple**: Designed for usage with `async` and `await`
+- **Powerful**: Mutex & Semaphore patterns supported
+- **Secure**: Auto lock release toa void dead locks
+- **Lightweight**: No dependencies, just ~50 LOC
+- **Well-tested**: 100% code coverage
+
+## Install
+
+```bash
+$ npm install superlock --save
+```
+
+## Usage
+
+### as mutex
+
+The lock is a mutex by default:
+
+```js
+const { withLock } = require('superlock')
+const delay = require('delay')
+
+const lock = withLock()
+
+const promiseOne = lock.then(() => {
+  console.log('mutual exclusion is guaranteed')
+  return delay(50)
+})
+
+const promiseTwo = lock.then(() => {
+  console.log('do something')
+  return delay(100)
+})
+
+Promise.all([promiseOne, promiseTwo])
+```
+
+### as semaphore
+
+Just pass the desired concurrency as first argument:
+
+```js
+const { withLock } = require('superlock')
+const delay = require('delay')
+
+const lock = withLock(2)
+
+const executions = []
+
+Promise.all(
+  [...Array(100).keys()].map(async index => {
+    await delay(Math.random() * 100)
+    return index
+  })
+)
+
+console.log(executions)
+```
+
+## API
+
+### withLock([concurrency=1])
+
+It returns a function that can be used to wrap any code you want to execute with concurrency control:
+
+```js
+const { withLock } = require('superlock')
+
+const lock = createLock()
+
+lock().then(() => {
+  /* your code execution */
+})
+```
+
+The lock will be automatically released after your code execution is done even if an error occurred, avoiding [deadlock](https://en.wikipedia.org/wiki/Deadlock) situations.
+
+#### concurrency
+
+Type: `number`<br>
+Default: `1`
+
+It sets the maximum of concurrency allowed for the lock.
+
+### .isLocked()
+
+Type: `boolean`
+
+It indicates if there is at least one free concurrency slots in the lock.
+
+## License
+
+**superlock** © [Kiko Beats](https://kikobeats.com), released under the [MIT](https://github.com/Kikobeats/lock/blob/master/LICENSE.md) License.<br>
+Authored and maintained by [Kiko Beats](https://kikobeats.com) with help from [contributors](https://github.com/Kikobeats/lock/contributors).
+
+> [kikobeats.com](https://kikobeats.com) · GitHub [Kiko Beats](https://github.com/Kikobeats) · Twitter [@Kikobeats](https://twitter.com/Kikobeats)

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "superlock",
+  "description": "The most simple mutex/semaphore implementation",
+  "homepage": "https://nicedoc.io/Kikobeats/lock",
+  "version": "0.0.0",
+  "main": "src/index.js",
+  "author": {
+    "email": "josefrancisco.verdu@gmail.com",
+    "name": "Kiko Beats",
+    "url": "https://kikobeats.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Kikobeats/lock.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Kikobeats/lock/issues"
+  },
+  "keywords": [
+    "async",
+    "await",
+    "concurrency",
+    "critical",
+    "lock",
+    "mutex",
+    "section",
+    "semaphore"
+  ],
+  "devDependencies": {
+    "@commitlint/cli": "latest",
+    "@commitlint/config-conventional": "latest",
+    "ava": "latest",
+    "c8": "latest",
+    "conventional-github-releaser": "latest",
+    "finepack": "latest",
+    "git-authors-cli": "latest",
+    "nano-staged": "latest",
+    "npm-check-updates": "latest",
+    "prettier-standard": "latest",
+    "simple-git-hooks": "latest",
+    "standard": "latest",
+    "standard-markdown": "latest",
+    "standard-version": "latest"
+  },
+  "engines": {
+    "node": ">= 14"
+  },
+  "files": [
+    "src"
+  ],
+  "license": "MIT",
+  "ava": {
+    "files": [
+      "!test/helpers.js",
+      "test/**/*.js"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "exports": {
+    ".": "./src/index.js",
+    "./create": "./src/create.js"
+  },
+  "nano-staged": {
+    "*.js,!*.min.js,": [
+      "prettier-standard"
+    ],
+    "*.md": [
+      "standard-markdown"
+    ],
+    "package.json": [
+      "finepack"
+    ]
+  },
+  "simple-git-hooks": {
+    "commit-msg": "npx commitlint --edit",
+    "pre-commit": "npx nano-staged"
+  },
+  "scripts": {
+    "clean": "rm -rf node_modules",
+    "contributors": "(git-authors-cli && finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
+    "coverage": "c8 report --reporter=text-lcov > coverage/lcov.info",
+    "lint": "standard-markdown README.md && standard",
+    "postrelease": "npm run release:tags && npm run release:github && npm publish",
+    "prerelease": "npm run update:check && npm run contributors",
+    "pretest": "npm run lint",
+    "release": "standard-version -a",
+    "release:github": "conventional-github-releaser -p angular",
+    "release:tags": "git push --follow-tags origin HEAD:master",
+    "test": "c8 ava",
+    "update": "ncu -u",
+    "update:check": "ncu -- --error-level 2"
+  }
+}

package/src/create.js

@@ -0,0 +1,34 @@
+'use strict'
+
+module.exports = (slots = 1) => {
+  const queue = []
+
+  const release = () => {
+    ++slots
+    if (queue.length > 0) queue.shift()()
+  }
+
+  const acquire = resolve => () => {
+    --slots
+    resolve(release)
+  }
+
+  const lock = () =>
+    new Promise(resolve => {
+      const fn = acquire(resolve)
+      lock.isLocked() ? queue.push(fn) : fn()
+    })
+
+  lock.withLock = async fn => {
+    const release = await lock()
+    try {
+      return await fn()
+    } finally {
+      release()
+    }
+  }
+
+  lock.isLocked = () => slots === 0
+
+  return lock
+}

package/src/index.js

@@ -0,0 +1,22 @@
+'use strict'
+
+const createLock = require('./create')
+
+const withLock = opts => {
+  const lock = createLock(opts)
+
+  const withLock = async fn => {
+    const release = await lock()
+    try {
+      return await fn()
+    } finally {
+      release()
+    }
+  }
+
+  withLock.isLocked = lock.isLocked
+
+  return withLock
+}
+
+module.exports = { withLock, createLock }