feat(atom): re-import atom package from MBP2010, update main readme

thi-ng · Jan 28, 2018 · fefc283 · fefc283
1 parent bddd5ce
commit fefc283
Show file tree

Hide file tree

Showing 9 changed files with 222 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,7 @@ Mono-repository for thi.ng TypeScript/ES6 projects.
 | Projects | Version | |
 |----|----|----|
 | [`@thi.ng/api`](./packages/api) | [![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/api.svg)](https://www.npmjs.com/package/@thi.ng/api) | [changelog](./packages/api/CHANGELOG.md) |
+| [`@thi.ng/atom`](./packages/atom) | [![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/atom.svg)](https://www.npmjs.com/package/@thi.ng/atom) | [changelog](./packages/atom/CHANGELOG.md) |
 | [`@thi.ng/bitstream`](./packages/bitstream) | [![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/bitstream.svg)](https://www.npmjs.com/package/@thi.ng/bitstream) | [changelog](./packages/bitstream/CHANGELOG.md) |
 | [`@thi.ng/checks`](./packages/checks) | [![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/checks.svg)](https://www.npmjs.com/package/@thi.ng/checks) | [changelog](./packages/checks/CHANGELOG.md) |
 | [`@thi.ng/csp`](./packages/csp) | [![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/csp.svg)](https://www.npmjs.com/package/@thi.ng/csp) | [changelog](./packages/csp/CHANGELOG.md) |

diff --git a/packages/atom/.gitignore b/packages/atom/.gitignore
@@ -0,0 +1,11 @@
+/bench
+/build
+/dev
+/doc
+/node_modules
+.DS_Store
+/bundle.*
+*.log
+*.tgz
+*.js
+*.d.ts
diff --git a/packages/atom/.npmignore b/packages/atom/.npmignore
@@ -0,0 +1,14 @@
+bench/*
+build/*
+dev/*
+node_modules
+src*
+test*
+bundle.*
+tsconfig.json
+webpack.config.js
+*.html
+*.tgz
+!doc/*
+!*.d.ts
+!*.js
diff --git a/packages/atom/README.md b/packages/atom/README.md
@@ -0,0 +1,43 @@
+# @thi.ng/atom
+
+[![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/atom.svg)](https://www.npmjs.com/package/@thi.ng/atom)
+
+## About
+
+Clojure inspired mutable wrapper for (usually) immutable values, with support for watches.
+
+## Installation
+
+```
+yarn add @thi.ng/atom
+```
+
+## Usage examples
+
+```typescript
+import { Atom } from "@thi.ng/atom";
+
+const a = new Atom(23);
+
+// obtain value via deref()
+a.deref();
+// 23
+
+// add watch to observe value changes
+a.addWatch("foo", (id, prev, curr) => console.log(`${id}: ${prev} -> ${curr}`));
+// true
+
+a.swap((val)=> val + 1);
+// foo: 23 -> 24
+
+a.reset(42);
+// foo: 24 -> 42
+```
+
+## Authors
+
+- Karsten Schmidt
+
+## License
+
+&copy; 2018 Karsten Schmidt // Apache Software License 2.0
diff --git a/packages/atom/package.json b/packages/atom/package.json
@@ -0,0 +1,35 @@
+{
+    "name": "@thi.ng/atom",
+    "version": "0.0.1",
+    "description": "Mutable wrapper for a immutable values",
+    "main": "./index.js",
+    "typings": "./index.d.ts",
+    "repository": "https://github.com/thi-ng/umbrella",
+    "author": "Karsten Schmidt <k+npm@thi.ng>",
+    "license": "Apache-2.0",
+    "scripts": {
+        "build": "yarn run clean && tsc --declaration",
+        "test": "yarn run clean && tsc -p test && mocha build/test/*.js",
+        "clean": "rm -rf *.js *.d.ts build doc",
+        "pub": "yarn run build && yarn publish --access public"
+    },
+    "devDependencies": {
+        "@types/mocha": "^2.2.46",
+        "@types/node": "^9.3.0",
+        "mocha": "^5.0.0",
+        "ts-loader": "^3.3.1",
+        "typedoc": "^0.9.0",
+        "typescript": "^2.6.2",
+        "webpack": "^3.10.0"
+    },
+    "dependencies": {
+        "@thi.ng/api": "^1.3.0"
+    },
+    "keywords": [
+        "ES6",
+        "typescript"
+    ],
+    "publishConfig": {
+        "access": "public"
+    }
+}
diff --git a/packages/atom/src/index.ts b/packages/atom/src/index.ts
@@ -0,0 +1,55 @@
+import * as api from "@thi.ng/api/api";
+import { IWatch } from "@thi.ng/api/mixins/iwatch";
+
+/**
+ * Mutable wrapper for an (usually) immutable value.
+ * Support for watches.
+ */
+@IWatch
+export class Atom<T> implements
+    api.IDeref<T>,
+    api.IEquiv,
+    api.IWatch<T> {
+
+    protected value: T;
+
+    constructor(val?: T) {
+        this.value = val;
+    }
+
+    public deref() {
+        return this.value;
+    }
+
+    public equiv(o: any) {
+        return this === o;
+    }
+
+    public reset(val: T) {
+        const old = this.value;
+        this.value = val;
+        this.notifyWatches(old, val);
+        return this.value;
+    }
+
+    public swap(fn: (curr: T, ...args: any[]) => T, ...args: any[]) {
+        const old = this.value;
+        args.unshift(old);
+        this.value = fn.apply(null, args);
+        this.notifyWatches(old, this.value);
+        return this.value;
+    }
+
+    // mixin stub
+    public addWatch(id: string, fn: (id: string, oldState: T, newState: T) => void) {
+        return false;
+    }
+
+    // mixin stub
+    public removeWatch(id: string) {
+        return false;
+    }
+
+    // mixin stub
+    public notifyWatches(oldState: T, newState: T) { }
+}
diff --git a/packages/atom/test/index.ts b/packages/atom/test/index.ts
@@ -0,0 +1,42 @@
+import * as assert from "assert";
+import { Atom } from "../src/index";
+
+describe("atom", function () {
+
+    let a: Atom<any>;
+
+    beforeEach(() => {
+        a = new Atom(23);
+    });
+
+    it("can be deref'd", () => {
+        assert.equal(a.deref(), 23);
+    });
+
+    it("can be reset", () => {
+        assert.equal(a.reset(24), 24);
+        assert.equal(a.deref(), 24);
+    });
+
+    it("can be swapped", () => {
+        assert.equal(a.swap((x) => x + 1), 24);
+        assert.equal(a.deref(), 24);
+    });
+
+    it("can add & remove watch", () => {
+        assert(a.addWatch("foo", () => { }), "can't add watch");
+        assert((<any>a)._watches && (<any>a)._watches.foo, "watch missing");
+        assert(a.removeWatch("foo"), "can't remove watch");
+        assert(!a.removeWatch("foo"), "should fail to remove invalid watch id");
+    });
+
+    it("can be watched", () => {
+        a.addWatch("foo", (id, prev, curr) => {
+            assert.equal(id, "foo", "wrong id");
+            assert.equal(prev, 23, "wrong prev");
+            assert.equal(curr, 24, "wrong curr");
+        });
+        a.swap((x) => x + 1);
+    });
+
+});
diff --git a/packages/atom/test/tsconfig.json b/packages/atom/test/tsconfig.json
@@ -0,0 +1,11 @@
+{
+    "extends": "../../../tsconfig.json",
+    "compilerOptions": {
+        "outDir": "../build",
+        "noUnusedParameters": false
+    },
+    "include": [
+        "./**/*.ts",
+        "../src/**/*.ts"
+    ]
+}
diff --git a/packages/atom/tsconfig.json b/packages/atom/tsconfig.json
@@ -0,0 +1,10 @@
+{
+    "extends": "../../tsconfig.json",
+    "compilerOptions": {
+        "outDir": ".",
+        "noUnusedParameters": false,
+    },
+    "include": [
+        "./src/**/*.ts",
+    ]
+}