pacc 1.0.0

package/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2023 by pacc
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,28 @@
+[![npm](https://img.shields.io/npm/v/pacc.svg)](https://www.npmjs.com/package/pacc)
+[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![bundlejs](https://deno.bundlejs.com/?q=pacc\&badge=detailed)](https://bundlejs.com/?q=pacc)
+[![downloads](http://img.shields.io/npm/dm/pacc.svg?style=flat-square)](https://npmjs.org/package/pacc)
+[![GitHub Issues](https://img.shields.io/github/issues/arlac77/pacc.svg?style=flat-square)](https://github.com/arlac77/pacc/issues)
+[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Fpacc%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/pacc/goto)
+[![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/pacc/badge.svg)](https://snyk.io/test/github/arlac77/pacc)
+[![Coverage Status](https://coveralls.io/repos/arlac77/pacc/badge.svg)](https://coveralls.io/github/arlac77/pacc)
+
+# pacc
+
+propetty path utils
+
+# API
+
+# install
+
+With [npm](http://npmjs.org) do:
+
+```shell
+npm install pacc
+```
+
+# license
+
+BSD-2-Clause

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "pacc",
+  "version": "1.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "property path utils",
+  "contributors": [
+    {
+      "name": "Markus Felten",
+      "email": "markus.felten@gmx.de"
+    }
+  ],
+  "exports": {
+    ".": "./src/attribute.mjs"
+  },
+  "license": "BSD-2-Clause",
+  "scripts": {
+    "test": "npm run test:browser-ava && npm run test:ava",
+    "test:browser-ava": "browser-ava --headless --no-keep-open tests/*-ava.mjs tests/*-ava-browser.mjs",
+    "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
+    "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
+    "docs": "documentation readme --section=API ./src/**/*.mjs",
+    "lint": "npm run lint:docs",
+    "lint:docs": "documentation lint ./src/**/*.mjs"
+  },
+  "devDependencies": {
+    "ava": "^5.3.1",
+    "browser-ava": "^2.0.0",
+    "c8": "^8.0.1",
+    "documentation": "^14.0.2",
+    "semantic-release": "^22.0.6"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/arlac77/pacc"
+  },
+  "bugs": {
+    "url": "https://github.com/arlac77/pacc/issues"
+  },
+  "homepage": "https://github.com/arlac77/pacc#readme",
+  "template": {
+    "inheritFrom": [
+      "arlac77/template-arlac77-github",
+      "arlac77/template-browser-ava",
+      "arlac77/template-esm-only"
+    ]
+  }
+}

package/src/attribute.mjs

@@ -0,0 +1,295 @@
+/**
+ * @typedef {Object} AttributeDefinition
+ *
+ * @property {string} type
+ * @property {boolean} writable
+ * @property {boolean} [private] should the value be shown
+ * @property {string} [depends] name of an attribute we depend on
+ * @property {string[]} additionalAttributes extra attributes that are present in case our attribute is set
+ * @property {string} description
+ * @property {any} [default] the default value
+ * @property {Function} [set] set the value
+ * @property {Function} [get] get the value can be used to calculate default values
+ * @property {string[]|string} [env] environment variable use to provide the value
+ */
+
+/**
+ * Split property path into tokens
+ * @generator
+ * @param {string} string
+ * @yields {string}
+ */
+export function* tokens(string) {
+  let state, buffer;
+
+  for (const c of string) {
+    switch (state) {
+      case "string-escaping":
+        const esc = {
+          "\\": "\\",
+          t: "\t",
+          b: "\b",
+          r: "\r",
+          n: "\n",
+          f: "\f"
+        };
+        buffer += esc[c];
+        state = "string";
+        continue;
+    }
+
+    switch (c) {
+      case "\t":
+      case " ":
+        switch (state) {
+          case undefined:
+            break;
+          case "string":
+            buffer += c;
+            break;
+          case "identifier":
+            yield buffer;
+            buffer = "";
+            state = undefined;
+            break;
+          default:
+            yield state;
+            state = undefined;
+        }
+        break;
+
+      case "\\":
+        switch (state) {
+          case "string":
+            state = "string-escaping";
+            break;
+        }
+        break;
+      case '"':
+      case "'":
+        switch (state) {
+          case undefined:
+            buffer = "";
+            state = "string";
+            break;
+          case "string":
+            yield buffer;
+            state = undefined;
+            break;
+          case "identifier":
+            yield buffer;
+            buffer = "";
+            state = "string";
+            break;
+          default:
+            yield state;
+            buffer = "";
+            state = "string";
+        }
+        break;
+      case "!":
+      case ">":
+      case "<":
+        switch (state) {
+          case undefined:
+            state = c;
+            break;
+          case "string":
+            buffer += c;
+            break;
+          case "identifier":
+            yield buffer;
+            state = c;
+            break;
+          default:
+            yield state;
+            state = c;
+        }
+        break;
+
+      case "=":
+        switch (state) {
+          case undefined:
+            state = c;
+            break;
+          case "string":
+            buffer += c;
+            break;
+          case "identifier":
+            yield buffer;
+            state = c;
+            break;
+          default:
+            state += c;
+        }
+        break;
+      case ".":
+      case "+":
+      case "-":
+      case "*":
+      case "/":
+      case "(":
+      case ")":
+      case "[":
+      case "]":
+        switch (state) {
+          case undefined:
+            state = c;
+            break;
+          case "string":
+            buffer += c;
+            break;
+          case "identifier":
+            yield buffer;
+            state = c;
+            break;
+          default:
+            yield state;
+            state = c;
+        }
+        break;
+      default:
+        switch (state) {
+          case undefined:
+            buffer = c;
+            state = "identifier";
+            break;
+          case "string":
+          case "identifier":
+            buffer += c;
+            break;
+          default:
+            if (
+              (c >= "a" && c <= "z") ||
+              (c >= "A" && c <= "Z") ||
+              (c >= "0" && c <= "9") ||
+              c === "_"
+            ) {
+              yield state;
+              state = "identifier";
+              buffer = c;
+            } else {
+              state += c;
+            }
+        }
+    }
+  }
+
+  switch (state) {
+    case undefined:
+      break;
+    case "string":
+      throw new Error("unterminated string");
+    case "identifier":
+      yield buffer;
+      break;
+    default:
+      yield state;
+  }
+}
+
+/**
+ * Set Object attribute.
+ * The name may be a property path like 'a.b.c'.
+ * @param {Object} object
+ * @param {string} expression
+ * @param {any} value
+ */
+export function setAttribute(object, expression, value) {
+  let lastObject = object;
+  let lastKey;
+
+  for (const token of tokens(expression)) {
+    switch (token) {
+      case ">":
+      case "<":
+      case ".":
+      case "[":
+      case "]":
+        break;
+
+      default:
+        if (object[token] === undefined || typeof object[token] !== "object") {
+          object[token] = {};
+        }
+
+        lastObject = object;
+        lastKey = token;
+
+        object = object[token];
+    }
+  }
+
+  if (lastKey) {
+    lastObject[lastKey] = value;
+  }
+}
+
+/**
+ * Deliver attribute value.
+ * The name may be a property path like 'a.b.c' or a[2]
+ * @param {Object} object
+ * @param {string} expression
+ * @returns {any} value associated with the given property name
+ */
+export function getAttribute(object, expression) {
+  return getAttributeAndOperator(object, expression)[0];
+}
+
+/**
+ * Deliver attribute value and operator.
+ * The name may be a property path like 'a.b.c <='.
+ * @param {Object} object
+ * @param {string} expression
+ * @returns {[any,string]} value associated with the given property name
+ */
+export function getAttributeAndOperator(object, expression, getters = {}) {
+  let op = "=";
+  let predicateTokens;
+
+  for (const token of tokens(expression)) {
+    switch (token) {
+      case ">=":
+      case "<=":
+      case ">":
+      case "<":
+      case "=":
+      case "!=":
+        op = token;
+        break;
+      case ".":
+      case "[":
+        predicateTokens = [];
+        break;
+      case "]":
+        // TODO: should loop over array actually getAttribute api should deliver iterators
+        if (object[Symbol.iterator]) {
+          object = [...object][0];
+        }
+
+        predicateTokens = undefined;
+        break;
+      case "*":
+        predicateTokens.push(token);
+        break;
+
+      default:
+        if (object === undefined) {
+          break;
+        }
+
+        const g = getters[token];
+        if (g) {
+          object = g(object);
+        } else {
+          if (object[token] !== undefined) {
+            object = object[token];
+          } else {
+            return [undefined, op];
+          }
+        }
+    }
+  }
+
+  return [object, op];
+}