pacc 1.0.0 → 1.0.2

package/README.md

@@ -15,6 +15,82 @@ propetty path utils
 
 # API
 
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+*   [AttributeDefinition](#attributedefinition)
+    *   [Properties](#properties)
+*   [tokens](#tokens)
+    *   [Parameters](#parameters)
+*   [setAttribute](#setattribute)
+    *   [Parameters](#parameters-1)
+*   [getAttribute](#getattribute)
+    *   [Parameters](#parameters-2)
+*   [getAttributeAndOperator](#getattributeandoperator)
+    *   [Parameters](#parameters-3)
+
+## AttributeDefinition
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+### Properties
+
+*   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+*   `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
+*   `depends` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of an attribute we depend on
+*   `additionalAttributes` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** extra attributes that are present in case our attribute is set
+*   `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `default` **any?** the default value
+*   `set` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** set the value
+*   `get` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** get the value can be used to calculate default values
+*   `env` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))?** environment variable use to provide the value
+
+## tokens
+
+Split property path into tokens
+
+### Parameters
+
+*   `string` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
+## setAttribute
+
+Set Object attribute.
+The name may be a property path like 'a.b.c'.
+
+### Parameters
+
+*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+*   `expression` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `value` **any**&#x20;
+
+## getAttribute
+
+Deliver attribute value.
+The name may be a property path like 'a.b.c' or a\[2]
+
+### Parameters
+
+*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+*   `expression` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
+Returns **any** value associated with the given property name
+
+## getAttributeAndOperator
+
+Deliver attribute value and operator.
+The name may be a property path like 'a.b.c <='.
+
+### Parameters
+
+*   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+*   `expression` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `getters`   (optional, default `{}`)
+
+Returns **\[any, [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)]** value associated with the given property name
+
 # install
 
 With [npm](http://npmjs.org) do:

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "pacc",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "publishConfig": {
     "access": "public"
   },
+  "exports": {
+    ".": "./src/attribute.mjs"
+  },
   "description": "property path utils",
   "contributors": [
     {
@@ -11,9 +14,6 @@
       "email": "markus.felten@gmx.de"
     }
   ],
-  "exports": {
-    ".": "./src/attribute.mjs"
-  },
   "license": "BSD-2-Clause",
   "scripts": {
     "test": "npm run test:browser-ava && npm run test:ava",
@@ -29,7 +29,7 @@
     "browser-ava": "^2.0.0",
     "c8": "^8.0.1",
     "documentation": "^14.0.2",
-    "semantic-release": "^22.0.6"
+    "semantic-release": "^22.0.7"
   },
   "repository": {
     "type": "git",

package/src/attribute.mjs

@@ -13,180 +13,9 @@
  * @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;
-            }
-        }
-    }
-  }
+import { tokens } from "./tokens.mjs";
 
-  switch (state) {
-    case undefined:
-      break;
-    case "string":
-      throw new Error("unterminated string");
-    case "identifier":
-      yield buffer;
-      break;
-    default:
-      yield state;
-  }
-}
+export { tokens };
 
 /**
  * Set Object attribute.
@@ -233,6 +62,10 @@ export function setAttribute(object, expression, value) {
  * @returns {any} value associated with the given property name
  */
 export function getAttribute(object, expression) {
+  if (object?.[expression] !== undefined) {
+    return object[expression];
+  }
+
   return getAttributeAndOperator(object, expression)[0];
 }
 

package/src/tokens.mjs

@@ -0,0 +1,189 @@
+/**
+ * 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 = {
+          "\\": "\\",
+          b: "\b",
+          f: "\f",
+          n: "\n",
+          r: "\r",
+          t: "\t"
+        };
+        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 "<":
+      case "&":
+      case "|":
+        switch (state) {
+          case '&':
+          case '|':
+            if(state === c) {
+              yield state + c;
+              state = undefined;
+            }
+            else {
+              yield state;
+              state = c;
+            }
+          break;
+          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 "]":
+      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;
+  }
+}