ee-core 1.5.1 → 1.5.2-beta.2

package/lib/storage/lowdb/adapters/FileAsync.js

@@ -0,0 +1,41 @@
+// Not using async/await on purpose to avoid adding regenerator-runtime
+// to lowdb dependencies
+const fs = require('graceful-fs')
+const pify = require('pify')
+const steno = require('steno')
+const Base = require('./Base')
+
+const readFile = pify(fs.readFile)
+const writeFile = pify(steno.writeFile)
+
+class FileAsync extends Base {
+  read() {
+    // fs.exists is deprecated but not fs.existsSync
+    if (fs.existsSync(this.source)) {
+      // Read database
+      return readFile(this.source, 'utf-8')
+        .then(data => {
+          // Handle blank file
+          const trimmed = data.trim()
+          return trimmed ? this.deserialize(trimmed) : this.defaultValue
+        })
+        .catch(e => {
+          if (e instanceof SyntaxError) {
+            e.message = `Malformed JSON in file: ${this.source}\n${e.message}`
+          }
+          throw e
+        })
+    } else {
+      // Initialize
+      return writeFile(this.source, this.serialize(this.defaultValue)).then(
+        () => this.defaultValue
+      )
+    }
+  }
+
+  write(data) {
+    return writeFile(this.source, this.serialize(data))
+  }
+}
+
+module.exports = FileAsync

package/lib/storage/lowdb/adapters/FileSync.js

@@ -0,0 +1,39 @@
+const fs = require('graceful-fs')
+const Base = require('./Base')
+const fileSystem = require('fs')
+
+//const readFile = fs.readFileSync
+const writeFile = fs.writeFileSync
+
+// Same code as in FileAsync, minus `await`
+class FileSync extends Base {
+  read() {
+    // fs.exists is deprecated but not fs.existsSync
+    if (fs.existsSync(this.source)) {
+      // Read database
+      try {
+        // 使用 fileSystem的readFileSync
+        //const data = readFile(this.source, 'utf-8').trim()
+        const data = fileSystem.readFileSync(this.source, {encoding: 'utf-8'})
+
+        // Handle blank file
+        return data ? this.deserialize(data) : this.defaultValue
+      } catch (e) {
+        if (e instanceof SyntaxError) {
+          e.message = `Malformed JSON in file: ${this.source}\n${e.message}`
+        }
+        throw e
+      }
+    } else {
+      // Initialize
+      writeFile(this.source, this.serialize(this.defaultValue))
+      return this.defaultValue
+    }
+  }
+
+  write(data) {
+    return writeFile(this.source, this.serialize(data))
+  }
+}
+
+module.exports = FileSync

package/lib/storage/lowdb/adapters/LocalStorage.js

@@ -0,0 +1,20 @@
+/* global localStorage */
+const Base = require('./Base')
+
+class LocalStorage extends Base {
+  read() {
+    const data = localStorage.getItem(this.source)
+    if (data) {
+      return this.deserialize(data)
+    } else {
+      localStorage.setItem(this.source, this.serialize(this.defaultValue))
+      return this.defaultValue
+    }
+  }
+
+  write(data) {
+    localStorage.setItem(this.source, this.serialize(data))
+  }
+}
+
+module.exports = LocalStorage

package/lib/storage/lowdb/adapters/Memory.js

@@ -0,0 +1,8 @@
+const Base = require('./Base')
+
+module.exports = class Memory extends Base {
+  read() {
+    return this.defaultValue
+  }
+  write() {}
+}

package/lib/storage/lowdb/adapters/_stringify.js

@@ -0,0 +1,4 @@
+// Pretty stringify
+module.exports = function stringify(obj) {
+  return JSON.stringify(obj, null, 2)
+}

package/lib/storage/lowdb/common.js

@@ -0,0 +1,33 @@
+const isPromise = require('./isPromise')
+
+const init = (db, key, adapter) => {
+  db.read = () => {
+    const r = adapter.read()
+
+    return isPromise(r) ? r.then(db.plant) : db.plant(r)
+  }
+
+  db.write = (value = db.getState()) => {
+    const w = adapter.write(db.getState())
+
+    return isPromise(w) ? w.then(() => value) : value
+  }
+
+  db.plant = state => {
+    db[key] = state
+    return db
+  }
+
+  db.getState = () => db[key]
+
+  db.setState = state => {
+    db.plant(state)
+    return db
+  }
+
+  return db.read()
+}
+
+module.exports = {
+  init
+}

package/lib/storage/lowdb/fp.js

@@ -0,0 +1,23 @@
+const flow = require('lodash/flow')
+const get = require('lodash/get')
+const set = require('lodash/set')
+const common = require('./common')
+
+module.exports = function(adapter) {
+  function db(path, defaultValue) {
+    function getValue(funcs) {
+      const result = get(db.getState(), path, defaultValue)
+      return flow(funcs)(result)
+    }
+
+    getValue.write = (...funcs) => {
+      const result = getValue(...funcs)
+      set(db.getState(), path, result)
+      return db.write()
+    }
+
+    return getValue
+  }
+
+  return common.init(db, '__state__', adapter)
+}

package/lib/storage/lowdb/isPromise.js

@@ -0,0 +1,6 @@
+module.exports = isPromise;
+module.exports.default = isPromise;
+
+function isPromise(obj) {
+  return !!obj && (typeof obj === 'object' || typeof obj === 'function') && typeof obj.then === 'function';
+}

package/lib/storage/lowdb/main.js

@@ -0,0 +1,46 @@
+const lodash = require('lodash')
+const isPromise = require('./isPromise')
+
+module.exports = function(adapter) {
+  if (typeof adapter !== 'object') {
+    throw new Error(
+      'An adapter must be provided, see https://github.com/typicode/lowdb/#usage'
+    )
+  }
+
+  // Create a fresh copy of lodash
+  const _ = lodash.runInContext()
+  const db = _.chain({})
+
+  // Add write function to lodash
+  // Calls save before returning result
+  _.prototype.write = _.wrap(_.prototype.value, function(func) {
+    const funcRes = func.apply(this)
+    return db.write(funcRes)
+  })
+
+  function plant(state) {
+    db.__wrapped__ = state
+    return db
+  }
+
+  // Lowdb API
+  // Expose _ for mixins
+  db._ = _
+
+  db.read = () => {
+    const r = adapter.read()
+    return isPromise(r) ? r.then(plant) : plant(r)
+  }
+
+  db.write = returnValue => {
+    const w = adapter.write(db.getState())
+    return isPromise(w) ? w.then(() => returnValue) : returnValue
+  }
+
+  db.getState = () => db.__wrapped__
+
+  db.setState = state => plant(state)
+
+  return db.read()
+}

package/lib/storage/lowdb/nano.js

@@ -0,0 +1,5 @@
+const common = require('./common')
+
+module.exports = function(adapter) {
+  return common.init({}, '__state__', adapter)
+}

package/lib/storage/lowdbStorage.js

@@ -1,99 +1,99 @@
-'use strict';
-
-const assert = require('assert');
-const fs = require('fs');
-const path = require('path');
-const lowdb = require('lowdb');
-const FileSync = require('lowdb/adapters/FileSync');
-const _ = require('lodash');
-const constant = require('../constant');
-const utilsCommon = require('../../utils/common');
-
-class LowdbStorage {
-  constructor (name, opt = {}) {
-    assert(name, `db name ${name} Cannot be empty`);
-
-    this.name = name;
-
-    // 数据库key列表
-    this.storageKey = constant.storageKey;
-
-    const storageDir = utilsCommon.getStorageDir();
-    if (!fs.existsSync(storageDir)) {
-      utilsCommon.mkdir(storageDir);
-      utilsCommon.chmodPath(storageDir, '777');
-    }
-
-    this.db = this.table(name);
-  }
-
-  /**
-   * 创建 table
-   */
-  table (name) {
-    assert(name, 'table name is required');
-
-    const dbFile = this.getFilePath(name);
-    const adapter = new FileSync(dbFile);
-    const db = lowdb(adapter);
-
-    assert(fs.existsSync(dbFile), `error: storage ${dbFile} not exists`);
-
-    return db;
-  }
-
-  /**
-   * 获取db文件名
-   */
-  getFileName (name) {
-    return name + ".json";
-  }
-
-  /**
-   * 获取文件绝对路径
-   */
-  getFilePath (name) {
-    const storageDir = utilsCommon.getStorageDir();
-    const dbFile = path.join(storageDir, this.getFileName(name));
-    return dbFile;
-  }
-
-  /**
-   * 为指定的 name 设置一个对应的值
-   */
-  setItem (key, value) {
-    assert(_.isString(key), `key must be a string`);
-    assert(key.length != 0, `key cannot be empty`);
-    assert(!this.storageKey.hasOwnProperty(key), `${key} is not allowed`);
-
-    let cacheKey = this.storageKey.cache;
-    if (!this.db.has(cacheKey).value()) {
-      this.db.set(cacheKey, {}).write();
-    }
-
-    let keyId = cacheKey + "." + key; 
-    this.db
-      .set(keyId, value)
-      .write();
-  
-    return true;
-  }
-  
-  /**
-   * 根据指定的名字 name 获取对应的值
-   */
-  getItem (key) {
-    assert(_.isString(key), `key must be a string`);
-    assert(key.length != 0, `key cannot be empty`);
-
-    let cacheKey = this.storageKey.cache;
-    let keyId = cacheKey + "." + key; 
-    const data = this.db
-      .get(keyId)
-      .value();
-  
-    return data;
-  }   
-}
-
+'use strict';
+
+const assert = require('assert');
+const fs = require('fs');
+const path = require('path');
+const lowdb = require('./lowdb/main');
+const FileSync = require('./lowdb/adapters/FileSync');
+const _ = require('lodash');
+const constant = require('../constant');
+const utilsCommon = require('../../utils/common');
+
+class LowdbStorage {
+  constructor (name, opt = {}) {
+    assert(name, `db name ${name} Cannot be empty`);
+
+    this.name = name;
+
+    // 数据库key列表
+    this.storageKey = constant.storageKey;
+
+    const storageDir = utilsCommon.getStorageDir();
+    if (!fs.existsSync(storageDir)) {
+      utilsCommon.mkdir(storageDir);
+      utilsCommon.chmodPath(storageDir, '777');
+    }
+
+    this.db = this.table(name);
+  }
+
+  /**
+   * 创建 table
+   */
+  table (name) {
+    assert(name, 'table name is required');
+
+    const dbFile = this.getFilePath(name);
+    const adapter = new FileSync(dbFile);
+    const db = lowdb(adapter);
+
+    assert(fs.existsSync(dbFile), `error: storage ${dbFile} not exists`);
+
+    return db;
+  }
+
+  /**
+   * 获取db文件名
+   */
+  getFileName (name) {
+    return name + ".json";
+  }
+
+  /**
+   * 获取文件绝对路径
+   */
+  getFilePath (name) {
+    const storageDir = utilsCommon.getStorageDir();
+    const dbFile = path.join(storageDir, this.getFileName(name));
+    return dbFile;
+  }
+
+  /**
+   * 为指定的 name 设置一个对应的值
+   */
+  setItem (key, value) {
+    assert(_.isString(key), `key must be a string`);
+    assert(key.length != 0, `key cannot be empty`);
+    assert(!this.storageKey.hasOwnProperty(key), `${key} is not allowed`);
+
+    let cacheKey = this.storageKey.cache;
+    if (!this.db.has(cacheKey).value()) {
+      this.db.set(cacheKey, {}).write();
+    }
+
+    let keyId = cacheKey + "." + key; 
+    this.db
+      .set(keyId, value)
+      .write();
+  
+    return true;
+  }
+  
+  /**
+   * 根据指定的名字 name 获取对应的值
+   */
+  getItem (key) {
+    assert(_.isString(key), `key must be a string`);
+    assert(key.length != 0, `key cannot be empty`);
+
+    let cacheKey = this.storageKey.cache;
+    let keyId = cacheKey + "." + key; 
+    const data = this.db
+      .get(keyId)
+      .value();
+  
+    return data;
+  }   
+}
+
 module.exports = LowdbStorage;

package/lib/storage/sqliteStorage.js

@@ -1,128 +1,128 @@
-'use strict';
-
-const assert = require('assert');
-const fs = require('fs');
-const path = require('path');
-const Database = require('better-sqlite3');
-const utilsCommon = require('../../utils/common');
-
-class SqliteStorage {
-  constructor (name, opt = {}) {
-    assert(name, `db name ${name} Cannot be empty`);
-
-    this.name = name;
-    this.mode = this.getMode(name);
-
-    const storageDir = this._createStorageDir();
-    this.storageDir = storageDir;
-
-    const fileName = this._formatFileName(name);
-    this.fileName = fileName;
-
-    this.db = this._initDB(opt);
-  }
-
-  /**
-   * 初始化db
-   */
-  _initDB (opt = {}) {
-    let options = Object.assign({
-      timeout: 5000,
-    }, opt);
-
-    // 存储类型：db文件、内存(:memory:)
-    let dbPath = this.name;
-    if (this.mode != 'memory') {
-      dbPath = this.getFilePath();
-    }
-
-    const db = new Database(dbPath, options);
-
-    // 如果是文件类型，判断文件是否创建成功
-    if (this.mode != 'memory') {
-      assert(fs.existsSync(dbPath), `error: storage ${dbPath} not exists`);
-    }
-
-    return db;
-  }
-
-  /**
-   * 获取文件名
-   */
-  _formatFileName (name) {
-    let fileName = name;
-    if (this.mode != 'memory') {
-      fileName = path.basename(name);
-    }
-
-    return fileName;
-  }
-
-  /**
-   * 创建storage目录
-   */
-  _createStorageDir () {
-    let storageDir = utilsCommon.getStorageDir();
-
-    if (this.mode == 'absolute') {
-      storageDir = path.dirname(this.name); 
-    }
-
-    if (!fs.existsSync(storageDir)) {
-      utilsCommon.mkdir(storageDir);
-      utilsCommon.chmodPath(storageDir, '777');
-    }
-
-    return storageDir;
-  }
-
-  /**
-   * 获取file path 模式
-   */
-  getMode (name) {
-    let mode = '';
-
-    // 内存模式
-    if (name == ':memory:') {
-      mode = 'memory';
-      return mode;
-    }
-
-    assert(path.extname(name) == '.db', `error: storage ${name} file ext name must be .db`);
-
-    // 路径模式
-    name = name.replace(/[/\\]/g, '/');
-    if (name.indexOf('/') !== -1) {
-      const isAbsolute = path.isAbsolute(name);
-      if (isAbsolute) {
-        mode = 'absolute';
-      } else {
-        mode = 'relative';
-      }
-      return mode;
-    }
-
-    // 仅文件名
-    mode = 'onlyName';
-
-    return mode;
-  }
-
-  /**
-   * 获取storage目录
-   */
-  getStorageDir () {
-    return this.storageDir;
-  }
-
-  /**
-   * 获取文件绝对路径
-   */
-  getFilePath () {
-    const dbFile = path.join(this.storageDir, this.fileName);
-
-    return dbFile;
-  }
-}
-
+'use strict';
+
+const assert = require('assert');
+const fs = require('fs');
+const path = require('path');
+const Database = require('better-sqlite3');
+const utilsCommon = require('../../utils/common');
+
+class SqliteStorage {
+  constructor (name, opt = {}) {
+    assert(name, `db name ${name} Cannot be empty`);
+
+    this.name = name;
+    this.mode = this.getMode(name);
+
+    const storageDir = this._createStorageDir();
+    this.storageDir = storageDir;
+
+    const fileName = this._formatFileName(name);
+    this.fileName = fileName;
+
+    this.db = this._initDB(opt);
+  }
+
+  /**
+   * 初始化db
+   */
+  _initDB (opt = {}) {
+    let options = Object.assign({
+      timeout: 5000,
+    }, opt);
+
+    // 存储类型：db文件、内存(:memory:)
+    let dbPath = this.name;
+    if (this.mode != 'memory') {
+      dbPath = this.getFilePath();
+    }
+
+    const db = new Database(dbPath, options);
+
+    // 如果是文件类型，判断文件是否创建成功
+    if (this.mode != 'memory') {
+      assert(fs.existsSync(dbPath), `error: storage ${dbPath} not exists`);
+    }
+
+    return db;
+  }
+
+  /**
+   * 获取文件名
+   */
+  _formatFileName (name) {
+    let fileName = name;
+    if (this.mode != 'memory') {
+      fileName = path.basename(name);
+    }
+
+    return fileName;
+  }
+
+  /**
+   * 创建storage目录
+   */
+  _createStorageDir () {
+    let storageDir = utilsCommon.getStorageDir();
+
+    if (this.mode == 'absolute') {
+      storageDir = path.dirname(this.name); 
+    }
+
+    if (!fs.existsSync(storageDir)) {
+      utilsCommon.mkdir(storageDir);
+      utilsCommon.chmodPath(storageDir, '777');
+    }
+
+    return storageDir;
+  }
+
+  /**
+   * 获取file path 模式
+   */
+  getMode (name) {
+    let mode = '';
+
+    // 内存模式
+    if (name == ':memory:') {
+      mode = 'memory';
+      return mode;
+    }
+
+    assert(path.extname(name) == '.db', `error: storage ${name} file ext name must be .db`);
+
+    // 路径模式
+    name = name.replace(/[/\\]/g, '/');
+    if (name.indexOf('/') !== -1) {
+      const isAbsolute = path.isAbsolute(name);
+      if (isAbsolute) {
+        mode = 'absolute';
+      } else {
+        mode = 'relative';
+      }
+      return mode;
+    }
+
+    // 仅文件名
+    mode = 'onlyName';
+
+    return mode;
+  }
+
+  /**
+   * 获取storage目录
+   */
+  getStorageDir () {
+    return this.storageDir;
+  }
+
+  /**
+   * 获取文件绝对路径
+   */
+  getFilePath () {
+    const dbFile = path.join(this.storageDir, this.fileName);
+
+    return dbFile;
+  }
+}
+
 module.exports = SqliteStorage;