file-entry-cache 1.2.0 → 1.3.1

package/README.md

@@ -1,5 +1,5 @@
 # file-entry-cache
-> Super simple cache for file metadata, useful for process that work o a given series of files 
+> Super simple cache for file metadata, useful for process that work o a given series of files
 > and that only need to repeat the job on the changed ones since the previous run of the process — Edit
 
 [![NPM Version](http://img.shields.io/npm/v/file-entry-cache.svg?style=flat)](https://npmjs.org/package/file-entry-cache)
@@ -14,7 +14,7 @@ npm i --save file-entry-cache
 ## Usage
 
 ```js
-// loads the cache, if one does not exists for the given 
+// loads the cache, if one does not exists for the given
 // Id a new one will be prepared to be created
 var fileEntryCache = require('file-entry-cache');
 
@@ -25,18 +25,23 @@ var files = expand('../fixtures/*.txt');
 // the first time this method is called, will return all the files
 var oFiles = cache.getUpdatedFiles(files);
 
-// this will persist this to disk checking each file stats and 
+// this will persist this to disk checking each file stats and
 // updating the meta attributes `size` and `mtime`.
 // custom fields could also be added to the meta object and will be persisted
 // in order to retrieve them later
-cache.reconcile(); 
+cache.reconcile();
+
+// use this if you want the non visited file entries to be kept in the cache
+// for more than one execution
+//
+// cache.reconcile( true /* noPrune */)
 
 // on a second run
 var cache2 = fileEntryCache.create('testCache');
 
 // will return now only the files that were modified or none
 // if no files were modified previous to the execution of this function
-var oFiles = cache.getUpdatedFiles(files);  
+var oFiles = cache.getUpdatedFiles(files);
 
 // if you want to prevent a file from being considered non modified
 // something useful if a file failed some sort of validation
@@ -64,21 +69,21 @@ entry = {
 
 ## Motivation for this module
 
-I needed a super simple and dumb **in-memory cache** with optional disk persistence (write-back cache) in order to make 
+I needed a super simple and dumb **in-memory cache** with optional disk persistence (write-back cache) in order to make
 a script that will beautify files with `esformatter` to execute only on the files that were changed since the last run.
 
 In doing so the process of beautifying files was reduced from several seconds to a small fraction of a second.
 
-This module uses [flat-cache](https://www.npmjs.com/package/flat-cache) a super simple `key/value` cache storage with 
+This module uses [flat-cache](https://www.npmjs.com/package/flat-cache) a super simple `key/value` cache storage with
 optional file persistance.
 
-The main idea is to read the files when the task begins, apply the transforms required, and if the process succeed, 
-then store the new state of the files. The next time this module request for `getChangedFiles` will return only 
+The main idea is to read the files when the task begins, apply the transforms required, and if the process succeed,
+then store the new state of the files. The next time this module request for `getChangedFiles` will return only
 the files that were modified. Making the process to end faster.
 
 This module could also be used by processes that modify the files applying a transform, in that case the result of the
-transform could be stored in the `meta` field, of the entries. Anything added to the meta field will be persisted. 
-Those processes won't need to call `getChangedFiles` they will instead call `normalizeEntries` that will return the 
+transform could be stored in the `meta` field, of the entries. Anything added to the meta field will be persisted.
+Those processes won't need to call `getChangedFiles` they will instead call `normalizeEntries` that will return the
 entries with a `changed` field that can be used to determine if the file was changed or not. If it was not changed
 the transformed stored data could be used instead of actually applying the transformation, saving time in case of only
 a few files changed.
@@ -86,10 +91,16 @@ a few files changed.
 In the worst case scenario all the files will be processed. In the best case scenario only a few of them will be processed.
 
 ## Important notes
-- The values set on the meta attribute of the entries should be `stringify-able` ones, meaning no circular references
-- All the changes to the cache state are done to memory first and only persisted after reconcile
+- The values set on the meta attribute of the entries should be `stringify-able` ones if possible, flat-cache uses `circular-json` to try to persist circular structures, but this should be considered experimental. The best results are always obtained with non circular values
+- All the changes to the cache state are done to memory first and only persisted after reconcile.
+- By default non visited entries are removed from the cache. This is done to prevent the file from growing too much. If this is not an issue and
+  you prefer to do a manual pruning of the cache files, you can pass `true` to the `reconcile` call. Like this:
+
+  ```javascript
+  cache.reconcile( true /* noPrune */ );
+  ```
 
-## License 
+## License
 
 MIT
 

package/cache.js

@@ -11,10 +11,15 @@ module.exports = {
     var fs = require( 'fs' );
     var flatCache = require( 'flat-cache' );
     var cache = flatCache.load( cacheId, _path );
-    var assign = require( 'lodash.assign' );
+    var assign = require( 'object-assign' );
     var normalizedEntries = { };
 
     return {
+      /**
+       * the flat cache storage used to persist the metadata of the `files
+       * @type {Object}
+       */
+      cache: cache,
       /**
        * Return whether or not a file has changed since last time reconcile was called.
        * @method hasFileChanged
@@ -145,7 +150,6 @@ module.exports = {
        */
       deleteCacheFile: function () {
         cache.removeCacheFile();
-      //flatCache.clearCacheById(cacheId);
       },
 
       /**
@@ -157,16 +161,18 @@ module.exports = {
       },
       /**
        * Sync the files and persist them to the cache
-       *
+       * @param [noPrune=false] {Boolean} whether to remove non visited/saved entries
        * @method reconcile
        */
-      reconcile: function () {
+      reconcile: function ( noPrune ) {
         var entries = normalizedEntries;
 
         var keys = Object.keys( entries );
+
         if ( keys.length === 0 ) {
           return;
         }
+
         keys.forEach( function ( entryName ) {
           var cacheEntry = entries[ entryName ];
           var stat = fs.statSync( cacheEntry.key );
@@ -179,7 +185,7 @@ module.exports = {
           cache.setKey( entryName, meta );
         } );
 
-        cache.save();
+        cache.save( noPrune );
       }
     };
   }

package/changelog.md

@@ -1,35 +1,69 @@
 
 # file-entry-cache - Changelog
+## v1.3.1
+- **Build Scripts Changes**
+  - remove older node version - [0a26ac4]( https://github.com/royriojas/file-entry-cache/commit/0a26ac4 ), [Roy Riojas](https://github.com/Roy Riojas), 01/08/2016 06:09:17
+
+    
+## v1.3.0
+- **Features**
+  - Add an option to not prune non visited keys. Closes [#2](https://github.com/royriojas/file-entry-cache/issues/2) - [b1a64db]( https://github.com/royriojas/file-entry-cache/commit/b1a64db ), [Roy Riojas](https://github.com/Roy Riojas), 01/08/2016 05:52:12
+
+    
+## v1.2.4
+- **Enhancements**
+  - Expose the flat-cache instance - [f34c557]( https://github.com/royriojas/file-entry-cache/commit/f34c557 ), [royriojas](https://github.com/royriojas), 23/09/2015 20:26:33
+
+    
+## v1.2.3
+- **Build Scripts Changes**
+  - update flat-cache dep - [cc7b9ce]( https://github.com/royriojas/file-entry-cache/commit/cc7b9ce ), [royriojas](https://github.com/royriojas), 11/09/2015 18:04:44
+
+    
+## v1.2.2
+- **Build Scripts Changes**
+  - Add changelogx section to package.json - [a3916ff]( https://github.com/royriojas/file-entry-cache/commit/a3916ff ), [royriojas](https://github.com/royriojas), 11/09/2015 18:00:26
+
+    
+## v1.2.1
+- **Build Scripts Changes**
+  - update flat-cache dep - [e49b0d4]( https://github.com/royriojas/file-entry-cache/commit/e49b0d4 ), [royriojas](https://github.com/royriojas), 11/09/2015 17:55:25
+
+    
+- **Other changes**
+  - Update dependencies Replaced lodash.assign with smaller object-assign Fixed tests for windows - [0ad3000]( https://github.com/royriojas/file-entry-cache/commit/0ad3000 ), [Bogdan Chadkin](https://github.com/Bogdan Chadkin), 11/09/2015 17:44:18
+
+    
 ## v1.2.0
 - **Features**
-  - analyzeFiles now returns also the files that were removed - [6ac2431]( https://github.com/[object Object]/file-entry-cache/commit/6ac2431 ), [royriojas](https://github.com/royriojas), 04/09/2015 12:40:53
+  - analyzeFiles now returns also the files that were removed - [6ac2431]( https://github.com/royriojas/file-entry-cache/commit/6ac2431 ), [royriojas](https://github.com/royriojas), 04/09/2015 14:40:53
 
     
 ## v1.1.1
 - **Features**
-  - Add method to check if a file hasChanged - [3640e2b]( https://github.com/[object Object]/file-entry-cache/commit/3640e2b ), [Roy Riojas](https://github.com/Roy Riojas), 30/08/2015 05:33:32
+  - Add method to check if a file hasChanged - [3640e2b]( https://github.com/royriojas/file-entry-cache/commit/3640e2b ), [Roy Riojas](https://github.com/Roy Riojas), 30/08/2015 07:33:32
 
     
 ## v1.1.0
 - **Features**
-  - Create the cache directly from a file path - [a23de61]( https://github.com/[object Object]/file-entry-cache/commit/a23de61 ), [Roy Riojas](https://github.com/Roy Riojas), 30/08/2015 04:41:33
+  - Create the cache directly from a file path - [a23de61]( https://github.com/royriojas/file-entry-cache/commit/a23de61 ), [Roy Riojas](https://github.com/Roy Riojas), 30/08/2015 06:41:33
 
     
-  - Add a method to remove an entry from the filecache - [7af29fc]( https://github.com/[object Object]/file-entry-cache/commit/7af29fc ), [Roy Riojas](https://github.com/Roy Riojas), 02/03/2015 23:25:32
+  - Add a method to remove an entry from the filecache - [7af29fc]( https://github.com/royriojas/file-entry-cache/commit/7af29fc ), [Roy Riojas](https://github.com/Roy Riojas), 03/03/2015 02:25:32
 
     
-  - cache module finished - [1f95544]( https://github.com/[object Object]/file-entry-cache/commit/1f95544 ), [Roy Riojas](https://github.com/Roy Riojas), 02/03/2015 01:08:08
+  - cache module finished - [1f95544]( https://github.com/royriojas/file-entry-cache/commit/1f95544 ), [Roy Riojas](https://github.com/Roy Riojas), 02/03/2015 04:08:08
 
     
 - **Build Scripts Changes**
-  - set the version for the first release - [7472eaa]( https://github.com/[object Object]/file-entry-cache/commit/7472eaa ), [Roy Riojas](https://github.com/Roy Riojas), 02/03/2015 01:29:54
+  - set the version for the first release - [7472eaa]( https://github.com/royriojas/file-entry-cache/commit/7472eaa ), [Roy Riojas](https://github.com/Roy Riojas), 02/03/2015 04:29:54
 
     
 - **Documentation**
-  - Updated documentation - [557358f]( https://github.com/[object Object]/file-entry-cache/commit/557358f ), [Roy Riojas](https://github.com/Roy Riojas), 02/03/2015 01:29:29
+  - Updated documentation - [557358f]( https://github.com/royriojas/file-entry-cache/commit/557358f ), [Roy Riojas](https://github.com/Roy Riojas), 02/03/2015 04:29:29
 
     
 - **Other changes**
-  - Initial commit - [3d5f42b]( https://github.com/[object Object]/file-entry-cache/commit/3d5f42b ), [Roy Riojas](https://github.com/Roy Riojas), 01/03/2015 21:58:29
+  - Initial commit - [3d5f42b]( https://github.com/royriojas/file-entry-cache/commit/3d5f42b ), [Roy Riojas](https://github.com/Roy Riojas), 02/03/2015 00:58:29
 
     

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "file-entry-cache",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "Super simple cache for file metadata, useful for process that work o a given series of files and that only need to repeat the job on the changed ones since the previous run of the process",
   "repository": "royriojas/file-entry-cache",
   "license": "MIT",
@@ -16,20 +16,20 @@
     "node": ">=0.10.0"
   },
   "scripts": {
-    "beautify": "esbeautifier 'cache.js' 'specs/**/*.js'",
-    "beautify-check": "esbeautifier -k 'cache.js' 'specs/**/*.js'",
+    "beautify": "esbeautifier 'cache.js' 'test/**/*.js'",
+    "beautify-check": "npm run beautify -- -k",
     "eslint": "eslinter 'cache.js' 'specs/**/*.js'",
     "lint": "npm run beautify && npm run eslint",
     "verify": "npm run beautify-check && npm run eslint",
     "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",
-    "pre-v": "npm run verify",
+    "pre-v": "npm run test",
     "post-v": "npm run do-changelog && git push --no-verify && git push --tags --no-verify",
     "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": "npm run verify && mocha -R spec test/specs",
     "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"
   },
@@ -47,27 +47,38 @@
     "key value",
     "cache"
   ],
+  "changelogx": {
+    "ignoreRegExp": [
+      "BLD: Release",
+      "DOC: Generate Changelog",
+      "Generated Changelog"
+    ],
+    "issueIDRegExp": "#(\\d+)",
+    "commitURL": "https://github.com/royriojas/file-entry-cache/commit/{0}",
+    "authorURL": "https://github.com/{0}",
+    "issueIDURL": "https://github.com/royriojas/file-entry-cache/issues/{0}",
+    "projectName": "file-entry-cache"
+  },
   "devDependencies": {
-    "chai": "^2.1.0",
+    "chai": "^3.2.0",
     "changelogx": "^1.0.18",
     "commander": "^2.6.0",
-    "del": "^1.1.1",
+    "del": "^2.0.2",
     "esbeautifier": "^4.2.11",
     "eslinter": "^2.3.3",
-    "glob-expand": "0.0.2",
+    "glob-expand": "^0.1.0",
     "istanbul": "^0.3.6",
     "mocha": "^2.1.0",
     "precommit": "^1.1.5",
     "prepush": "^3.1.4",
     "proxyquire": "^1.3.1",
-    "read-file": "^0.1.2",
     "sinon": "^1.12.2",
     "sinon-chai": "^2.7.0",
     "watch-run": "^1.2.1",
-    "write": "^0.1.1"
+    "write": "^0.3.1"
   },
   "dependencies": {
-    "flat-cache": "^1.0.4",
-    "lodash.assign": "^3.0.0"
+    "flat-cache": "^1.2.1",
+    "object-assign": "^4.0.1"
   }
 }