first publish

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+package-lock.json
+lib

.npmignore

@@ -0,0 +1,3 @@
+*
+!lib/index.js
+!lib/index.d.ts

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Nicco
+
+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.json

@@ -0,0 +1,32 @@
+{
+  "name": "memiens",
+  "version": "1.0.0",
+  "description": "",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "npm run build && mocha",
+    "prepublish": "npm run test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/CupCakeArmy/memiens.git"
+  },
+  "keywords": [],
+  "author": "Niccolo Bogioli",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/CupCakeArmy/memiens/issues"
+  },
+  "homepage": "https://github.com/CupCakeArmy/memiens#readme",
+  "dependencies": {
+    "yaml": "^1"
+  },
+  "devDependencies": {
+    "@types/node": "^11",
+    "@types/yaml": "^1",
+    "mocha": "^6",
+    "typescript": "^3"
+  }
+}

src/index.ts

@@ -0,0 +1,57 @@
+import { readFileSync, writeFileSync, lstatSync } from 'fs'
+import { resolve } from 'path'
+import yaml from 'yaml'
+
+type AllowedYamlTypes = string | number | boolean
+type AllowedTypes = AllowedYamlTypes | AllowedYamlTypes[]
+
+export default class Memento {
+	private readonly file: string
+	private state: any
+
+	constructor(file: string) {
+		this.file = resolve(file)
+		try {
+			this.read()
+		} catch (e) {
+			this.state = {}
+			this.save()
+		}
+	}
+
+	public get<AllowedTypes>(setting: string, defaultValue: AllowedTypes | undefined = undefined): AllowedTypes {
+		const props = setting.split('.')
+		let root = this.state
+		try {
+			for (const prop of props)
+				root = root[prop]
+		} catch (e) {
+		}
+		if (root) return root
+		if (defaultValue) {
+			// @ts-ignore
+			this.set(setting, defaultValue)
+			return defaultValue
+		}
+		throw new Error('Could not load the setting')
+	}
+
+	public set(setting: string, value: AllowedTypes): void {
+		const props = setting.split('.')
+		let root = this.state
+		for (const prop of props.slice(0, -1)) {
+			if (typeof root[prop] !== 'object') root[prop] = {}
+			root = root[prop]
+		}
+		root[props[props.length - 1]] = value
+		this.save()
+	}
+
+	private read() {
+		this.state = yaml.parse(readFileSync(this.file, 'utf-8'))
+	}
+
+	private save() {
+		writeFileSync(this.file, yaml.stringify(this.state), 'utf-8')
+	}
+}

test/main.js

@@ -0,0 +1,134 @@
+const assert = require('assert')
+const {
+	unlinkSync
+} = require('fs')
+const memento = require('../').default
+
+const filename = 'test.yaml'
+const deleteFile = () => {
+	try {
+		// Remove the test file
+		unlinkSync(filename)
+	} catch (e) {}
+}
+
+describe('Memento', () => {
+
+	after(deleteFile)
+
+	describe('Basics', () => {
+		deleteFile()
+		it('Instantiating without existing file', () => {
+			const Settings = new memento(filename)
+		})
+
+		it('Saving simple string', () => {
+			const Settings = new memento(filename)
+
+			const key = 'test'
+			const value = 'ok'
+			Settings.set(key, value)
+
+			assert.strictEqual(Settings.get(key), value)
+		})
+	})
+
+	describe('Preserve types', () => {
+		const Settings = new memento(filename)
+		const key = 'key'
+
+		const test = (value) => {
+			Settings.set(key, value)
+			const saved = Settings.get(key)
+			assert.strictEqual(saved, value)
+		}
+
+		it('string', () => {
+			test('my string')
+		})
+
+		it('string array', () => {
+			test(['my string', 'ohlala'])
+		})
+
+		it('number', () => {
+			test(42)
+		})
+
+		it('number array', () => {
+			test([42, 8])
+		})
+
+		it('boolean', () => {
+			test(true)
+		})
+
+		it('boolean array', () => {
+			test([true, false])
+		})
+
+		it('mixed', () => {
+			test(['a', 42, true])
+		})
+
+	})
+
+	describe('Persist', () => {
+		deleteFile()
+
+		const key = 'test'
+		const value = 42
+
+		it('Write', () => {
+			const Settings = new memento(filename)
+			Settings.set(key, value)
+		})
+
+		it('Read', () => {
+			const Settings = new memento(filename)
+			assert.strictEqual(Settings.get(key), value)
+		})
+	})
+
+	describe('Nested properties', () => {
+		deleteFile()
+
+		const data = {
+			a: {
+				b: {
+					c: [8, false]
+				}
+			}
+		}
+
+		it('Write', () => {
+			const Settings = new memento(filename)
+			Settings.set('a.b.c', data.a.b.c)
+		})
+
+		it('Read', () => {
+			const Settings = new memento(filename)
+			assert.deepStrictEqual(Settings.get('a'), data.a)
+			assert.deepStrictEqual(Settings.get('a.b'), data.a.b)
+			assert.deepStrictEqual(Settings.get('a.b.c'), data.a.b.c)
+		})
+	})
+
+	describe('Get with initializer', ()=> {
+		deleteFile()
+
+		const key = 'initialized'
+		const value = true
+
+		it('Getting', () => {
+			const Settings = new memento(filename)
+			assert.strictEqual(Settings.get(key, value), value)
+		})
+
+		it('Verify it was written', () => {
+			const Settings = new memento(filename)
+			assert.strictEqual(Settings.get(key), value)
+		})
+	})
+
+})

tsconfig.json

@@ -0,0 +1,60 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "esnext",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./lib",                        /* Redirect output structure to the directory. */
+    "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    "strictNullChecks": true,              /* Enable strict null checks. */
+    "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+  }
+}