flat-cache 3.0.3 → 3.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Roy Riojas
+Copyright (c) Roy Riojas and Jared Wray
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,8 +1,10 @@
 # flat-cache
 > A stupidly simple key/value storage using files to persist the data
 
-[![NPM Version](http://img.shields.io/npm/v/flat-cache.svg?style=flat)](https://npmjs.org/package/flat-cache)
-[![Build Status](https://api.travis-ci.org/royriojas/flat-cache.svg?branch=master)](https://travis-ci.org/royriojas/flat-cache)
+[![NPM Version](https://img.shields.io/npm/v/flat-cache.svg?style=flat)](https://npmjs.org/package/flat-cache)
+[![tests](https://github.com/jaredwray/flat-cache/actions/workflows/tests.yaml/badge.svg?branch=master)](https://github.com/jaredwray/flat-cache/actions/workflows/tests.yaml)
+[![codecov](https://codecov.io/github/jaredwray/flat-cache/branch/master/graph/badge.svg?token=KxR95XT3NF)](https://codecov.io/github/jaredwray/flat-cache)
+[![npm](https://img.shields.io/npm/dm/flat-cache)](https://npmjs.com/package/flat-cache)
 
 ## install
 

package/changelog.md

@@ -1,5 +1,10 @@
 
 # flat-cache - Changelog
+## v3.0.4
+- **Refactoring**
+  - add files by name to the list of exported files - [89a2698]( https://github.com/royriojas/flat-cache/commit/89a2698 ), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 02:35:39
+
+    
 ## v3.0.3
 - **Bug Fixes**
   - Fix wrong eslint command - [f268e42]( https://github.com/royriojas/flat-cache/commit/f268e42 ), [Roy Riojas](https://github.com/Roy Riojas), 08/11/2020 02:15:04

package/package.json

@@ -1,19 +1,21 @@
 {
   "name": "flat-cache",
-  "version": "3.0.3",
+  "version": "3.1.0",
   "description": "A stupidly simple key/value storage using files to persist some data",
-  "repository": "royriojas/flat-cache",
+  "repository": "jaredwray/flat-cache",
   "license": "MIT",
   "author": {
-    "name": "Roy Riojas",
-    "url": "http://royriojas.com"
+    "name": "Jared Wray",
+    "url": "https://jaredwray.com"
   },
   "main": "src/cache.js",
   "files": [
-    "./src/"
+    "src/cache.js",
+    "src/del.js",
+    "src/utils.js"
   ],
   "engines": {
-    "node": "^10.12.0 || >=12.0.0"
+    "node": ">=12.0.0"
   },
   "precommit": [
     "npm run verify --silent"
@@ -35,7 +37,8 @@
     "bump-major": "npm run pre-v && npm version major -m 'BLD: Release v%s' && npm run post-v",
     "bump-minor": "npm run pre-v && npm version minor -m 'BLD: Release v%s' && npm run post-v",
     "bump-patch": "npm run pre-v && npm version patch -m 'BLD: Release v%s' && npm run post-v",
-    "test:cache": "mocha -R spec test/specs",
+    "test:cache": "c8 mocha -R spec test/specs",
+    "test:ci:cache": "c8 --reporter=lcov mocha -R spec test/specs",
     "test": "npm run verify --silent",
     "cover": "istanbul cover test/runner.js html text-summary",
     "watch": "watch-run -i -p 'test/specs/**/*.js' istanbul cover test/runner.js html text-summary"
@@ -61,22 +64,23 @@
     "projectName": "flat-cache"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
+    "c8": "^8.0.1",
+    "chai": "^4.3.7",
     "changelogx": "^5.0.6",
     "eslint": "^7.13.0",
     "eslint-config-prettier": "^6.15.0",
     "eslint-plugin-mocha": "^8.0.0",
     "eslint-plugin-prettier": "^3.1.4",
     "glob-expand": "^0.2.1",
-    "istanbul": "^0.4.5",
-    "mocha": "^8.2.1",
+    "mocha": "^10.2.0",
     "precommit": "^1.2.2",
     "prepush": "^3.1.11",
     "prettier": "^2.1.2",
     "watch-run": "^1.2.5"
   },
   "dependencies": {
-    "flatted": "^3.1.0",
+    "flatted": "^3.2.7",
+    "keyv": "^4.5.3",
     "rimraf": "^3.0.2"
   }
 }

package/src/cache.js

@@ -1,5 +1,6 @@
 var path = require('path');
 var fs = require('fs');
+var Keyv = require('keyv');
 var utils = require('./utils');
 var del = require('./del');
 var writeJSON = utils.writeJSON;
@@ -17,8 +18,10 @@ var cache = {
   load: function (docId, cacheDir) {
     var me = this;
 
-    me._visited = {};
-    me._persisted = {};
+    me.keyv = new Keyv();
+
+    me.__visited = {};
+    me.__persisted = {};
     me._pathToFile = cacheDir ? path.resolve(cacheDir, docId) : path.resolve(__dirname, '../.cache/', docId);
 
     if (fs.existsSync(me._pathToFile)) {
@@ -26,6 +29,24 @@ var cache = {
     }
   },
 
+  get _persisted() {
+    return this.__persisted;
+  },
+
+  set _persisted(value) {
+    this.__persisted = value;
+    this.keyv.set('persisted', value);
+  },
+
+  get _visited() {
+    return this.__visited;
+  },
+
+  set _visited(value) {
+    this.__visited = value;
+    this.keyv.set('visited', value);
+  },
+
   /**
    * Load the cache from the provided file
    * @method loadFile

package/src/del.js

@@ -0,0 +1,13 @@
+var rimraf = require('rimraf').sync;
+var fs = require('fs');
+
+module.exports = function del(file) {
+  if (fs.existsSync(file)) {
+    //if rimraf doesn't throw then the file has been deleted or didn't exist
+    rimraf(file, {
+      glob: false,
+    });
+    return true;
+  }
+  return false;
+};

package/src/utils.js

@@ -0,0 +1,44 @@
+var fs = require('fs');
+var path = require('path');
+var flatted = require('flatted');
+
+module.exports = {
+  tryParse: function (filePath, defaultValue) {
+    var result;
+    try {
+      result = this.readJSON(filePath);
+    } catch (ex) {
+      result = defaultValue;
+    }
+    return result;
+  },
+
+  /**
+   * Read json file synchronously using flatted
+   *
+   * @method readJSON
+   * @param  {String} filePath Json filepath
+   * @returns {*} parse result
+   */
+  readJSON: function (filePath) {
+    return flatted.parse(
+      fs.readFileSync(filePath, {
+        encoding: 'utf8',
+      })
+    );
+  },
+
+  /**
+   * Write json file synchronously using circular-json
+   *
+   * @method writeJSON
+   * @param  {String} filePath Json filepath
+   * @param  {*} data Object to serialize
+   */
+  writeJSON: function (filePath, data) {
+    fs.mkdirSync(path.dirname(filePath), {
+      recursive: true,
+    });
+    fs.writeFileSync(filePath, flatted.stringify(data));
+  },
+};