file-entry-cache 2.0.0 → 4.0.0

package/cache.js

@@ -1,4 +1,5 @@
 var path = require( 'path' );
+var crypto = require( 'crypto' );
 
 module.exports = {
   createFromFile: function ( filePath ) {
@@ -11,7 +12,6 @@ module.exports = {
     var fs = require( 'fs' );
     var flatCache = require( 'flat-cache' );
     var cache = flatCache.load( cacheId, _path );
-    var assign = require( 'object-assign' );
     var normalizedEntries = { };
 
     var removeNotFoundFiles = function removeNotFoundFiles() {
@@ -36,6 +36,20 @@ module.exports = {
        * @type {Object}
        */
       cache: cache,
+
+      /**
+       * Given a buffer, calculate md5 hash of its content.
+       * @method getHash
+       * @param  {Buffer} buffer   buffer to calculate hash on
+       * @return {String}          content hash digest
+       */
+      getHash: function ( buffer ) {
+        return crypto
+          .createHash( 'md5' )
+          .update( buffer )
+          .digest( 'hex' );
+      },
+
       /**
        * Return whether or not a file has changed since last time reconcile was called.
        * @method hasFileChanged
@@ -82,29 +96,28 @@ module.exports = {
       getFileDescriptor: function ( file ) {
         var meta = cache.getKey( file );
         var cacheExists = !!meta;
-        var fstat;
         var me = this;
+        var contentBuffer;
 
         try {
-          fstat = fs.statSync( file );
+          contentBuffer = fs.readFileSync( file );
         } catch (ex) {
           me.removeEntry( file );
           return { key: file, notFound: true, err: ex };
         }
 
-        var cSize = fstat.size;
-        var cTime = fstat.mtime.getTime();
+        var isDifferent = true;
+        var hash = this.getHash( contentBuffer );
 
         if ( !meta ) {
-          meta = { size: cSize, mtime: cTime };
+          meta = { hash: hash };
         } else {
-          var isDifferentDate = cTime !== meta.mtime;
-          var isDifferentSize = cSize !== meta.size;
+          isDifferent = hash !== meta.hash;
         }
 
         var nEntry = normalizedEntries[ file ] = {
           key: file,
-          changed: !cacheExists || isDifferentDate || isDifferentSize,
+          changed: !cacheExists || isDifferent,
           meta: meta
         };
 
@@ -184,6 +197,7 @@ module.exports = {
 
         var entries = normalizedEntries;
         var keys = Object.keys( entries );
+        var me = this;
 
         if ( keys.length === 0 ) {
           return;
@@ -193,11 +207,9 @@ module.exports = {
           var cacheEntry = entries[ entryName ];
 
           try {
-            var stat = fs.statSync( cacheEntry.key );
-            var meta = assign( cacheEntry.meta, {
-              size: stat.size,
-              mtime: stat.mtime.getTime()
-            } );
+            var contentBuffer = fs.readFileSync( cacheEntry.key );
+            var hash = me.getHash( contentBuffer );
+            var meta = Object.assign( cacheEntry.meta, { hash: hash } );
 
             cache.setKey( entryName, meta );
           } catch (err) {

package/changelog.md

@@ -1,5 +1,52 @@
 
 # file-entry-cache - Changelog
+## v4.0.0
+- **Build Scripts Changes**
+  - use the same node versions eslint use - [563cfee]( https://github.com/royriojas/file-entry-cache/commit/563cfee ), [Roy Riojas](https://github.com/Roy Riojas), 08/01/2019 23:29:34
+
+    
+- **Other changes**
+  - Remove object-assign dependency. - [d0f598e]( https://github.com/royriojas/file-entry-cache/commit/d0f598e ), [Corey Farrell](https://github.com/Corey Farrell), 08/01/2019 23:09:51
+
+    node.js >=4 is required so object-assign is no longer needed, the native
+    Object.assign can be used instead.
+    
+## v3.0.0
+- **Build Scripts Changes**
+  - Upgrade flat-cache dep to latest - [078b0df]( https://github.com/royriojas/file-entry-cache/commit/078b0df ), [Roy Riojas](https://github.com/Roy Riojas), 08/01/2019 21:54:40
+
+    
+  - Commit new package-lock.json file - [245fe62]( https://github.com/royriojas/file-entry-cache/commit/245fe62 ), [Roy Riojas](https://github.com/Roy Riojas), 08/01/2019 20:56:21
+
+    
+- **Refactoring**
+  - add eslintrc file - [6dd32d8]( https://github.com/royriojas/file-entry-cache/commit/6dd32d8 ), [Roy Riojas](https://github.com/Roy Riojas), 22/08/2018 11:58:17
+
+    
+- **Other changes**
+  - Move variable definition out of else block - [ea05441]( https://github.com/royriojas/file-entry-cache/commit/ea05441 ), [Zakhar Shapurau](https://github.com/Zakhar Shapurau), 25/04/2017 13:19:00
+
+    
+  - Add script and cmd to test hash/checksum performance - [7f60e0a]( https://github.com/royriojas/file-entry-cache/commit/7f60e0a ), [Zakhar Shapurau](https://github.com/Zakhar Shapurau), 24/04/2017 16:43:12
+
+    
+  - Calculate md5 hexdigest instead of Adler-32 checksum - [f9e5c69]( https://github.com/royriojas/file-entry-cache/commit/f9e5c69 ), [Zakhar Shapurau](https://github.com/Zakhar Shapurau), 24/04/2017 16:43:12
+
+    
+  - How to reproduce - [4edc2dc]( https://github.com/royriojas/file-entry-cache/commit/4edc2dc ), [Zakhar Shapurau](https://github.com/Zakhar Shapurau), 24/04/2017 15:49:32
+
+    
+  - Test handling of removed files - [09d9ec5]( https://github.com/royriojas/file-entry-cache/commit/09d9ec5 ), [Zakhar Shapurau](https://github.com/Zakhar Shapurau), 19/04/2017 21:51:50
+
+    
+  - Use content checksum instead of mtime and fsize - [343b340]( https://github.com/royriojas/file-entry-cache/commit/343b340 ), [Zakhar Shapurau](https://github.com/Zakhar Shapurau), 19/04/2017 21:51:47
+
+    
+- **Revert**
+  - Revert "How to reproduce" - [4b4e54a]( https://github.com/royriojas/file-entry-cache/commit/4b4e54a ), [Zakhar Shapurau](https://github.com/Zakhar Shapurau), 25/04/2017 13:15:36
+
+    This reverts commit 4edc2dcec01574247bfc2e0a2fe26527332b7df3.
+    
 ## v2.0.0
 - **Features**
   - do not persist and prune removed files from cache. Relates to [#2](https://github.com/royriojas/file-entry-cache/issues/2) - [408374d]( https://github.com/royriojas/file-entry-cache/commit/408374d ), [Roy Riojas](https://github.com/Roy Riojas), 16/08/2016 15:47:58

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "file-entry-cache",
-  "version": "2.0.0",
+  "version": "4.0.0",
   "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",
@@ -13,12 +13,12 @@
     "cache.js"
   ],
   "engines": {
-    "node": ">=0.10.0"
+    "node": ">=4"
   },
   "scripts": {
-    "beautify": "esbeautifier 'cache.js' 'test/**/*.js'",
+    "beautify": "esbeautifier 'cache.js' 'test/**/*.js' 'perf.js'",
     "beautify-check": "npm run beautify -- -k",
-    "eslint": "eslinter 'cache.js' 'specs/**/*.js'",
+    "eslint": "eslinter 'cache.js' 'specs/**/*.js' 'perf.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",
@@ -30,6 +30,7 @@
     "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": "npm run verify --silent && mocha -R spec test/specs",
+    "perf": "node perf.js",
     "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,7 +62,7 @@
   },
   "devDependencies": {
     "chai": "^3.2.0",
-    "changelogx": "^1.0.18",
+    "changelogx": "3.0.0",
     "commander": "^2.6.0",
     "del": "^2.0.2",
     "esbeautifier": "^4.2.11",
@@ -78,7 +79,6 @@
     "write": "^0.3.1"
   },
   "dependencies": {
-    "flat-cache": "^1.2.1",
-    "object-assign": "^4.0.1"
+    "flat-cache": "^2.0.1"
   }
 }