From f9f6eb1e9224b4ed91bacdff797b6a7790ebecfe Mon Sep 17 00:00:00 2001 From: Karsten Schmidt Date: Sat, 17 Mar 2018 22:30:04 +0000 Subject: [PATCH] feat(paths): add/extract @thi.ng/paths from @thi.ng/atom --- packages/paths/.npmignore | 10 ++ packages/paths/LICENSE | 201 ++++++++++++++++++++++++++ packages/paths/README.md | 103 +++++++++++++ packages/paths/package.json | 42 ++++++ packages/paths/src/index.ts | 232 ++++++++++++++++++++++++++++++ packages/paths/test/index.ts | 6 + packages/paths/test/tsconfig.json | 10 ++ packages/paths/tsconfig.json | 9 ++ 8 files changed, 613 insertions(+) create mode 100644 packages/paths/.npmignore create mode 100644 packages/paths/LICENSE create mode 100644 packages/paths/README.md create mode 100644 packages/paths/package.json create mode 100644 packages/paths/src/index.ts create mode 100644 packages/paths/test/index.ts create mode 100644 packages/paths/test/tsconfig.json create mode 100644 packages/paths/tsconfig.json diff --git a/packages/paths/.npmignore b/packages/paths/.npmignore new file mode 100644 index 0000000000..d703bda97a --- /dev/null +++ b/packages/paths/.npmignore @@ -0,0 +1,10 @@ +build +coverage +dev +doc +src* +test +.nyc_output +tsconfig.json +*.tgz +*.html diff --git a/packages/paths/LICENSE b/packages/paths/LICENSE new file mode 100644 index 0000000000..8dada3edaf --- /dev/null +++ b/packages/paths/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/paths/README.md b/packages/paths/README.md new file mode 100644 index 0000000000..d9769f0ed7 --- /dev/null +++ b/packages/paths/README.md @@ -0,0 +1,103 @@ +# @thi.ng/paths + +[![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/paths.svg)](https://www.npmjs.com/package/@thi.ng/paths) + +## About + +This library provides immutable, optimized path-based accessors for +vanilla JS objects. + +## Installation + +``` +yarn add @thi.ng/paths +``` + +## Usage + +``` +import * as paths from "@thi.ng/paths"; +``` + +The `getter()` and `setter()` functions transform a path like `a.b.c` +into a function operating directly at the value the path points to in +nested object. For getters, this essentially compiles to `val = +obj.a.b.c`, with the important difference that the function returns +`undefined` if any intermediate values along the lookup path are +undefined (and doesn't throw an error). + +The resulting setter function too accepts a single object to operate on +and when called, **immutably** replaces the value at the given path, +i.e. it produces a selective deep copy of obj up until given path. If +any intermediate key is not present in the given object, it creates a +plain empty object for that missing key and descends further along the +path. + +```typescript +s = setter("a.b.c"); +// or +s = setter(["a","b","c"]); + +s({a: {b: {c: 23}}}, 24) +// {a: {b: {c: 24}}} + +s({x: 23}, 24) +// { x: 23, a: { b: { c: 24 } } } + +s(null, 24) +// { a: { b: { c: 24 } } } +``` + +In addition to these higher-order functions, the module also provides +immediate-use wrappers: `getIn()`, `setIn()`, `updateIn()` and +`deleteIn()`. These functions are using `getter` / `setter` internally, +so have same behaviors. + +```typescript +state = {a: {b: {c: 23}}}; + +getIn(state, "a.b.c") +// 23 + +setIn(state, "a.b.c", 24) +// {a: {b: {c: 24}}} + +// apply given function to path value +updateIn(state, "a.b.c", x => x + 1) +// {a: {b: {c: 24}}} + +// immutably remove path key +deleteIn(state, "a.b.c.") +// {a: {b: {}}} +``` + +Only keys in the path will be updated, all other keys present in the +given object retain their original/identical values to provide efficient +structural sharing / re-use. This is the same *behavior* as in Clojure's +immutable maps or those provided by ImmutableJS (albeit those +implementation are completely different - they're using trees, we're +using the ES6 spread op and recursive functional composition to produce +the setter/updater). + +```typescript +s = setter("a.b.c"); + +// original +a = { x: { y: { z: 1 } }, u: { v: 2 } }; +// updated version +b = s(a, 3); +// { x: { y: { z: 1 } }, u: { v: 2 }, a: { b: { c: 3 } } } + +// verify anything under keys `x` & `u` is still identical +a.x === b.x // true +a.x.y === b.x.y // true +a.u === b.u; // true +``` + +## Authors + +- Karsten Schmidt + +## License + +© 2016 - 2018 Karsten Schmidt // Apache Software License 2.0 diff --git a/packages/paths/package.json b/packages/paths/package.json new file mode 100644 index 0000000000..d4fef69d14 --- /dev/null +++ b/packages/paths/package.json @@ -0,0 +1,42 @@ +{ + "name": "@thi.ng/paths", + "version": "1.0.0", + "description": "immutable, optimized path-based object accessors", + "main": "./index.js", + "typings": "./index.d.ts", + "repository": "https://github.com/thi-ng/umbrella", + "author": "Karsten Schmidt ", + "license": "Apache-2.0", + "scripts": { + "build": "yarn run clean && tsc --declaration", + "clean": "rm -rf *.js *.d.ts build doc", + "doc": "node_modules/.bin/typedoc --mode modules --out doc src", + "pub": "yarn run build && yarn publish --access public", + "test": "rm -rf build && tsc -p test && mocha build/test/*.js" + }, + "devDependencies": { + "@types/mocha": "^2.2.48", + "@types/node": "^9.4.6", + "mocha": "^5.0.0", + "ts-loader": "^3.5.0", + "typedoc": "^0.10.0", + "typescript": "^2.7.2", + "webpack": "^3.11.0" + }, + "dependencies": { + "@thi.ng/checks": "^1.3.0" + }, + "keywords": [ + "data structure", + "ES6", + "getter", + "nested", + "object", + "path", + "setter", + "typescript" + ], + "publishConfig": { + "access": "public" + } +} \ No newline at end of file diff --git a/packages/paths/src/index.ts b/packages/paths/src/index.ts new file mode 100644 index 0000000000..ed6062a83d --- /dev/null +++ b/packages/paths/src/index.ts @@ -0,0 +1,232 @@ +import { isArray } from "@thi.ng/checks/is-array"; +import { isString } from "@thi.ng/checks/is-string"; + +export type Path = PropertyKey | PropertyKey[]; + +export type UpdateFn = (curr: T, ...args: any[]) => T; + +function compS(k, f) { + return (s, v) => ({ ...s, [k]: f((s || {})[k], v) }); +} + +function compG(k, f) { + return (s) => s ? f(s[k]) : undefined; +} + +/** + * Converts the given key path to canonical form (array). + * + * ``` + * toPath("a.b.c"); + * // ["a", "b", "c"] + * + * toPath(0) + * // [0] + * + * toPath(["a", "b", "c"]) + * // ["a", "b", "c"] + * ``` + * + * @param path + */ +export function toPath(path: Path) { + return isArray(path) ? path : isString(path) ? path.length > 0 ? path.split(".") : [] : path != null ? [path] : []; +} + +/** + * Composes a getter function for given nested lookup path. Optimized + * fast execution paths are provided for path lengths less than 5. + * + * If `path` is given as string, it will be split using `.`. Returns + * function which accepts single object and when called, returns value + * at given path. + * + * If any intermediate key is not present in the given obj, descent + * stops and the function returns `undefined`. + * + * If `path` is an empty string or array, the returned getter will + * simply return the given state arg (identity function). + * + * Also see: `getIn()` + * + * ``` + * g = getter("a.b.c"); + * // or + * g = getter(["a","b","c"]); + * + * g({a: {b: {c: 23}}}) // 23 + * g({x: 23}) // undefined + * g() // undefined + * ``` + * + * @param path + */ +export function getter(path: Path) { + const ks = toPath(path); + let [a, b, c, d] = ks; + switch (ks.length) { + case 0: + return (s) => s; + case 1: + return (s) => s ? s[a] : undefined; + case 2: + return (s) => s ? (s = s[a]) ? s[b] : undefined : undefined; + case 3: + return (s) => s ? (s = s[a]) ? (s = s[b]) ? s[c] : undefined : undefined : undefined; + case 4: + return (s) => s ? (s = s[a]) ? (s = s[b]) ? (s = s[c]) ? s[d] : undefined : undefined : undefined : undefined; + default: + const kl = ks[ks.length - 1]; + let f = (s) => s ? s[kl] : undefined; + for (let i = ks.length - 2; i >= 0; i--) { + f = compG(ks[i], f); + } + return f; + } +} + +/** + * Composes a setter function for given nested lookup path. Optimized + * fast execution paths are provided for path lengths less than 5. + * + * If `path` is given as string, it will be split using `.`. Returns + * function which accepts single object and when called, **immutably** + * updates value at given path, i.e. produces a partial deep copy of obj + * up until given path. + * + * If any intermediate key is not present in the given obj, creates a + * plain empty object for that key and descends further. + * + * If `path` is an empty string or array, the returned setter will + * simply return the new value. + * + * Also see: `setIn()`, `updateIn()`, `deleteIn()` + * + * ``` + * s = setter("a.b.c"); + * // or + * s = setter(["a","b","c"]); + * + * s({a: {b: {c: 23}}}, 24) + * // {a: {b: {c: 24}}} + * + * s({x: 23}, 24) + * // { x: 23, a: { b: { c: 24 } } } + * + * s(null, 24) + * // { a: { b: { c: 24 } } } + * ``` + * + * Only keys in the path will be modied, all other keys present in the + * given object retain their original values to provide efficient + * structural sharing / re-use. + * + * ``` + * s = setter("a.b.c"); + * + * a = {x: {y: {z: 1}}}; + * b = s(a, 2); + * // { x: { y: { z: 1 } }, a: { b: { c: 2 } } } + * + * a.x === b.x // true + * a.x.y === b.x.y // true + * ``` + * + * @param path + */ +export function setter(path: Path) { + const ks = toPath(path); + // (s, v) => ({ ...s, [k]: f((s || {})[k], v) }); + let [a, b, c, d] = ks; + switch (ks.length) { + case 0: + return (_, v) => v; + case 1: + return (s, v) => ({ ...s, [a]: v }); + case 2: + return (s, v) => ({ ...s, [a]: { ...s[a], [b]: v } }); + case 3: + return (s, v) => ({ ...s, [a]: { ...s[a], [b]: { ...s[b], [c]: v } } }); + case 4: + return (s, v) => ({ ...s, [a]: { ...s[a], [b]: { ...s[b], [c]: { ...s[c], [d]: v } } } }); + default: + const kl = ks[ks.length - 1]; + let f = (s, v) => ({ ...(s || {}), [kl]: v }); + for (let i = ks.length - 2; i >= 0; i--) { + f = compS(ks[i], f); + } + return f; + } +} + +/** + * Immediate use getter, i.e. same as: `getter(path)(state)`. + * + * ``` + * getIn({a: {b: {c: 23}}}, "a.b.c"); + * // 23 + * ``` + * + * @param state + * @param path + */ +export function getIn(state: any, path: Path) { + return getter(path)(state); +} + +/** + * Immediate use setter, i.e. same as: `setter(path)(state, val)`. + * + * ``` + * setIn({}, "a.b.c", 23); + * // {a: {b: {c: 23}}} + * ``` + * + * @param state + * @param path + */ +export function setIn(state: any, path: Path, val: any) { + return setter(path)(state, val); +} + +/** + * Similar to `setIn()`, but applies given function to current path + * value (incl. any additional/optional arguments passed to `updateIn`) + * and uses result as new value. Does not modify original state (unless + * given function does so itself). + * + * ``` + * add = (x, y) => x + y; + * updateIn({a: {b: {c: 23}}}, "a.b.c", add, 10); + * // {a: {b: {c: 33}}} + * ``` + * + * @param state + * @param path + */ +export function updateIn(state: any, path: Path, fn: UpdateFn, ...args: any[]) { + args.unshift(getIn(state, path)); + return setter(path)(state, fn.apply(null, args)); +} + +/** + * Uses `updateIn()` and returns updated state with key for given path + * removed. Does not modify original state. + * + * Returns `undefined` if `path` is an empty string or array. + * + * ``` + * deleteIn({a:{b:{c: 23}}}, "a.b.c"); + * // {a: {b: {}}} + * ``` + * + * @param state + * @param path + */ +export function deleteIn(state: any, path: Path) { + const ks = [...toPath(path)]; + if (ks.length > 0) { + const k = ks.pop(); + return updateIn(state, ks, (x) => { x = { ...x }; delete x[k]; return x; }); + } +} diff --git a/packages/paths/test/index.ts b/packages/paths/test/index.ts new file mode 100644 index 0000000000..25ebd0f04d --- /dev/null +++ b/packages/paths/test/index.ts @@ -0,0 +1,6 @@ +// import * as assert from "assert"; +// import * as paths from "../src/index"; + +describe("paths", () => { + it("tests pending"); +}); diff --git a/packages/paths/test/tsconfig.json b/packages/paths/test/tsconfig.json new file mode 100644 index 0000000000..bcf29ace54 --- /dev/null +++ b/packages/paths/test/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "outDir": "../build" + }, + "include": [ + "./**/*.ts", + "../src/**/*.ts" + ] +} diff --git a/packages/paths/tsconfig.json b/packages/paths/tsconfig.json new file mode 100644 index 0000000000..bd6481a5a6 --- /dev/null +++ b/packages/paths/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": "." + }, + "include": [ + "./src/**/*.ts" + ] +}