flat-cache 1.0.9 → 1.2.2

package/README.md

@@ -29,6 +29,7 @@ cache.removeKey('key'); // removes a key from the cache
 
 // save it to disk
 cache.save(); // very important, if you don't save no changes will be persisted.
+// cache.save( true /* noPrune */) // can be used to prevent the removal of non visited keys
 
 // loads the cache from a given directory, if one does
 // not exists for the given Id a new one will be prepared to be created
@@ -57,6 +58,8 @@ storage was needed and Bam! this module was born.
 - All the changes to the cache state are done to memory
 - I could have used a timer or `Object.observe` to deliver the changes to disk, but I wanted to keep this module
   intentionally dumb and simple
+- Non visited keys are removed when `cache.save()` is called. If this is not desired, you can pass `true` to the save call
+  like: `cache.save( true /* noPrune */ )`.
 
 ## License
 

package/cache.js

@@ -1,8 +1,8 @@
 var path = require( 'path' );
 var fs = require( 'graceful-fs' );
-var readJSON = require( 'read-json-sync' );
-var write = require( 'write' );
 var del = require( 'del' ).sync;
+var utils = require( './utils' );
+var writeJSON = utils.writeJSON;
 
 var cache = {
   /**
@@ -22,7 +22,7 @@ var cache = {
     me._pathToFile = cacheDir ? path.resolve( cacheDir, docId ) : path.resolve( __dirname, './.cache/', docId );
 
     if ( fs.existsSync( me._pathToFile ) ) {
-      me._persisted = readJSON( me._pathToFile );
+      me._persisted = utils.tryParse( me._pathToFile, { } );
     }
   },
 
@@ -58,8 +58,8 @@ var cache = {
    * @param key {String} the key to remove from the object
    */
   removeKey: function ( key ) {
-    delete this._visited[ key ];
-    delete this._persisted[ key ];
+    delete this._visited[ key ]; // esfmt-ignore-line
+    delete this._persisted[ key ]; // esfmt-ignore-line
   },
   /**
    * Return the value of the provided key
@@ -100,13 +100,14 @@ var cache = {
   /**
    * Save the state of the cache identified by the docId to disk
    * as a JSON structure
+   * @param [noPrune=false] {Boolean} whether to remove from cache the non visited files
    * @method save
    */
-  save: function () {
+  save: function ( noPrune ) {
     var me = this;
 
-    me._prune();
-    write.sync( me._pathToFile, JSON.stringify( me._persisted ) );
+    (!noPrune) && me._prune();
+    writeJSON( me._pathToFile, me._persisted );
   },
 
   /**
@@ -180,9 +181,8 @@ module.exports = {
    * @method clearAll
    * @returns {Boolean} true if the cache folder was deleted. False otherwise
    */
-  clearAll: function () {
-    return del( path.resolve( __dirname, './.cache/' ), {
-        force: true
-      } ).length > 0;
+  clearAll: function ( cacheDir ) {
+    var filePath = cacheDir ? path.resolve( cacheDir ) : path.resolve( __dirname, './.cache/' );
+    return del( filePath, { force: true } ).length > 0;
   }
 };

package/changelog.md

@@ -1,5 +1,79 @@
 
 # flat-cache - Changelog
+## v1.2.2
+- **Bug Fixes**
+  - Do not crash if cache file is invalid JSON. ([#13](https://github.com/royriojas/flat-cache/issues/13)) - [87beaa6]( https://github.com/royriojas/flat-cache/commit/87beaa6 ), [Roy Riojas](https://github.com/Roy Riojas), 19/12/2016 21:03:35
+
+    Fixes <a target="_blank" class="info-link" href="https://github.com/royriojas/flat-cache/issues/12"><span>#12</span></a>
+    
+    Not sure under which situations a cache file might exist that does
+    not contain a valid JSON structure, but just in case to cover
+    the possibility of this happening a try catch block has been added
+    
+    If the cache is somehow not valid the cache will be discarded an a
+    a new cache will be stored instead
+- **Other changes**
+  - Added travis ci support for modern node versions ([#11](https://github.com/royriojas/flat-cache/issues/11)) - [1c2b1f7]( https://github.com/royriojas/flat-cache/commit/1c2b1f7 ), [Amila Welihinda](https://github.com/Amila Welihinda), 11/11/2016 02:47:52
+
+    
+  - Bumping `circular-son` version ([#10](https://github.com/royriojas/flat-cache/issues/10)) - [4d5e861]( https://github.com/royriojas/flat-cache/commit/4d5e861 ), [Andrea Giammarchi](https://github.com/Andrea Giammarchi), 02/08/2016 09:13:52
+
+    As mentioned in https://github.com/WebReflection/circular-json/issues/25 `circular-json` wan't rightly implementing the license field.
+    
+    Latest version bump changed only that bit so that ESLint should now be happy.
+## v1.2.1
+- **Bug Fixes**
+  - Add missing utils.js file to the package. closes [#8](https://github.com/royriojas/flat-cache/issues/8) - [ec10cf2]( https://github.com/royriojas/flat-cache/commit/ec10cf2 ), [Roy Riojas](https://github.com/Roy Riojas), 01/08/2016 04:18:57
+
+    
+## v1.2.0
+- **Documentation**
+  - Add documentation about noPrune option - [23e11f9]( https://github.com/royriojas/flat-cache/commit/23e11f9 ), [Roy Riojas](https://github.com/Roy Riojas), 01/08/2016 04:06:49
+
+    
+## v1.0.11
+- **Features**
+  - Add noPrune option to cache.save() method. closes [#7](https://github.com/royriojas/flat-cache/issues/7) - [2c8016a]( https://github.com/royriojas/flat-cache/commit/2c8016a ), [Roy Riojas](https://github.com/Roy Riojas), 01/08/2016 04:00:29
+
+    
+  - Add json read and write utility based on circular-json - [c31081e]( https://github.com/royriojas/flat-cache/commit/c31081e ), [Jean Ponchon](https://github.com/Jean Ponchon), 28/07/2016 10:58:17
+
+    
+- **Bug Fixes**
+  - Remove UTF16 BOM stripping - [4a41e22]( https://github.com/royriojas/flat-cache/commit/4a41e22 ), [Jean Ponchon](https://github.com/Jean Ponchon), 29/07/2016 04:18:06
+
+    Since we control both writing and reading of JSON stream, there no needs 
+    to handle unicode BOM.
+  - Use circular-json to handle circular references (fix [#5](https://github.com/royriojas/flat-cache/issues/5)) - [cd7aeed]( https://github.com/royriojas/flat-cache/commit/cd7aeed ), [Jean Ponchon](https://github.com/Jean Ponchon), 25/07/2016 13:11:59
+
+    
+- **Tests Related fixes**
+  - Add missing file from eslint test - [d6fa3c3]( https://github.com/royriojas/flat-cache/commit/d6fa3c3 ), [Jean Ponchon](https://github.com/Jean Ponchon), 29/07/2016 04:15:51
+
+    
+  - Add test for circular json serialization / deserialization - [07d2ddd]( https://github.com/royriojas/flat-cache/commit/07d2ddd ), [Jean Ponchon](https://github.com/Jean Ponchon), 28/07/2016 10:59:36
+
+    
+- **Refactoring**
+  - Remove unused read-json-sync - [2be1c24]( https://github.com/royriojas/flat-cache/commit/2be1c24 ), [Jean Ponchon](https://github.com/Jean Ponchon), 28/07/2016 10:59:18
+
+    
+- **Build Scripts Changes**
+  - travis tests on 0.12 and 4x - [3a613fd]( https://github.com/royriojas/flat-cache/commit/3a613fd ), [royriojas](https://github.com/royriojas), 15/11/2015 17:34:40
+
+    
+## v1.0.10
+- **Build Scripts Changes**
+  - add eslint-fix task - [fd29e52]( https://github.com/royriojas/flat-cache/commit/fd29e52 ), [royriojas](https://github.com/royriojas), 01/11/2015 18:04:08
+
+    
+  - make sure the test script also verify beautification and linting of files before running tests - [e94e176]( https://github.com/royriojas/flat-cache/commit/e94e176 ), [royriojas](https://github.com/royriojas), 01/11/2015 14:54:48
+
+    
+- **Other changes**
+  - add clearAll for cacheDir - [97383d9]( https://github.com/royriojas/flat-cache/commit/97383d9 ), [xieyaowu](https://github.com/xieyaowu), 31/10/2015 23:02:18
+
+    
 ## v1.0.9
 - **Bug Fixes**
   - wrong default values for changelogx user repo name - [7bb52d1]( https://github.com/royriojas/flat-cache/commit/7bb52d1 ), [royriojas](https://github.com/royriojas), 11/09/2015 17:59:30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flat-cache",
-  "version": "1.0.9",
+  "version": "1.2.2",
   "description": "A stupidly simple key/value storage using files to persist some data",
   "repository": "royriojas/flat-cache",
   "license": "MIT",
@@ -10,7 +10,8 @@
   },
   "main": "cache.js",
   "files": [
-    "cache.js"
+    "cache.js",
+    "utils.js"
   ],
   "engines": {
     "node": ">=0.10.0"
@@ -22,11 +23,13 @@
     "npm run verify --silent"
   ],
   "scripts": {
-    "beautify": "esbeautifier 'cache.js' 'specs/**/*.js'",
-    "beautify-check": "esbeautifier -k 'cache.js' 'specs/**/*.js'",
-    "eslint": "eslinter 'cache.js' 'specs/**/*.js'",
-    "lint": "npm run beautify && npm run eslint",
-    "verify": "npm run beautify-check && npm run eslint",
+    "beautify": "esbeautifier 'cache.js' 'test/specs/**/*.js'",
+    "beautify-check": "npm run beautify -- -k",
+    "eslint": "eslinter 'cache.js' 'utils.js' 'specs/**/*.js'",
+    "eslint-fix": "npm run eslint -- --fix",
+    "autofix": "npm run beautify && npm run eslint-fix",
+    "check": "npm run beautify-check && npm run eslint",
+    "verify": "npm run check && npm run test:cache",
     "install-hooks": "prepush install && changelogx install-hook && precommit install",
     "changelog": "changelogx -f markdown -o ./changelog.md",
     "do-changelog": "npm run changelog && git add ./changelog.md && git commit -m 'DOC: Generate changelog' --no-verify",
@@ -35,7 +38,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": "mocha -R spec test/specs",
+    "test:cache": "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"
   },
@@ -62,8 +66,8 @@
   "devDependencies": {
     "chai": "^3.2.0",
     "changelogx": "^1.0.18",
-    "esbeautifier": "^4.2.11",
-    "eslinter": "^2.3.3",
+    "esbeautifier": "^6.1.8",
+    "eslinter": "^3.2.1",
     "glob-expand": "^0.1.0",
     "istanbul": "^0.3.19",
     "mocha": "^2.3.2",
@@ -75,9 +79,9 @@
     "watch-run": "^1.2.2"
   },
   "dependencies": {
+    "circular-json": "^0.3.1",
     "del": "^2.0.2",
     "graceful-fs": "^4.1.2",
-    "read-json-sync": "^1.1.0",
     "write": "^0.2.1"
   }
 }

package/utils.js

@@ -0,0 +1,39 @@
+var fs = require( 'graceful-fs' );
+var write = require( 'write' );
+var circularJson = require( 'circular-json' );
+
+module.exports = {
+
+  tryParse: function ( filePath, defaultValue) {
+    var result;
+    try {
+      result = this.readJSON( filePath );
+    } catch (ex) {
+      result = defaultValue;
+    }
+    return result;
+  },
+
+  /**
+   * Read json file synchronously using circular-json
+   *
+   * @method readJSON
+   * @param  {String} filePath Json filepath
+   * @returns {*} parse result
+   */
+  readJSON: function ( filePath ) {
+    return circularJson.parse( fs.readFileSync( filePath ).toString() );
+  },
+
+  /**
+   * Write json file synchronously using circular-json
+   *
+   * @method writeJSON
+   * @param  {String} filePath Json filepath
+   * @param  {*} data Object to serialize
+   */
+  writeJSON: function (filePath, data ) {
+    write.sync( filePath, circularJson.stringify( data ) );
+  }
+
+};