Initial commit

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..427c101
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,5 @@
+/ndcode-emailjs_cache-*.tgz
+/node_modules
+/package-lock.json
+/yarn.lock
+/yarn-error.log

diff --git a/JSONCache.js b/JSONCache.js
new file mode 100644 (file)
index 0000000..b38fc14
--- /dev/null
+++ b/JSONCache.js
@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2018 Nick Downing <nick@ndcode.org>
+ * SPDX-License-Identifier: MIT
+ *
+ * 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.
+ */
+
+let BuildCache = require('@ndcode/build_cache')
+let fs = require('fs')
+let util = require('util')
+
+let fs_readFile = util.promisify(fs.readFile)
+
+let JSONCache = function(diag) {
+  if (!this instanceof JSONCache)
+    throw Error('JSONCache is a constructor')
+  this.diag = diag || false
+
+  this.build_cache = new BuildCache()
+}
+
+JSONCache.prototype.get = function(key) {
+  return /*await*/ this.build_cache.get(
+    key,
+    async result => {
+      let text = await fs_readFile(key, {encoding: 'utf-8'})
+      if (this.diag)
+        console.log(`loaded json file ${key}`)
+      result.value = JSON.parse(text)
+    }
+  )
+}
+
+module.exports = JSONCache

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..aa360c1
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,20 @@
+Copyright (C) 2018 Nick Downing <nick@ndcode.org>
+SPDX-License-Identifier: MIT
+
+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.

diff --git a/package.json b/package.json
new file mode 100644 (file)
index 0000000..3696d3d
--- /dev/null
+++ b/package.json
@@ -0,0 +1,30 @@
+{
+  "name": "@ndcode/json_cache",
+  "version": "0.1.1",
+  "description": "Load JSON files which can be changed while system is live.",
+  "keywords": [
+    "json",
+    "persistent",
+    "cache",
+    "live"
+  ],
+  "homepage": "https://www.ndcode.org",
+  "repository": {
+    "type": "git",
+    "url": "https://git.ndcode.org/public/json_cache.git"
+  },
+  "bugs": {
+    "email": "nick@ndcode.org"
+  },
+  "main": "JSONCache.js",
+  "engines": {
+    "node": ">=0.4.0"
+  },
+  "directories": {},
+  "dependencies": {
+    "@ndcode/build_cache": "^0.1.0"
+  },
+  "devDependencies": {},
+  "maintainers": "Nick Downing <nick@ndcode.org>",
+  "license": "MIT"
+}