mem-fs-editor 2.0.4 → 2.3.0

package/README.md

@@ -44,6 +44,12 @@ Optionally pass `replacer` and `space` as the last two arguments, as defined by
 
 Default value for `space` is `2`, when not specified.
 
+### `#extendJSON(filepath, contents[, replacer [, space]])`
+
+Extend the content of an existing JSON file with the partial objects provided as argument.
+
+Optionally take the same JSON formatting arguments than `#writeJSON()`.
+
 ### `#delete(filepath, [options])`
 
 Delete a file or a directory.
@@ -58,11 +64,13 @@ Optionally, pass an `options.process` function (`process(contents)`) returning a
 
 `from` can be a glob pattern that'll be match against the file system. If that's the case, then `to` must be an output directory. For a globified `from`, you can optionally pass in an `options.globOptions` object to change its pattern matching behavior. The full list of options are being described [here](https://github.com/isaacs/node-glob#options). The `nodir` flag is forced to be `true` in `globOptions` to ensure a vinyl object representing each matching directory is marked as `deleted` in the `mem-fs` store.
 
-### `#copyTpl(from, to, context, [options])`
+### `#copyTpl(from, to, context[, templateOptions [, copyOptions]])`
 
 Copy the `from` file and parse its content as an [ejs](http://ejs.co/) template where `context` is the template context (the variable names available inside the template).
 
-You can optionally pass a template `options` object. `mem-fs-editor` automatically setup the filename option so you can easily use partials.
+You can optionally pass a `templateOptions` object. `mem-fs-editor` automatically setup the filename option so you can easily use partials.
+
+You can also optionally pass a `copyOptions` object (see [copy() documentation for more details](https://github.com/SBoudrias/mem-fs-editor#copyfrom-to-options).
 
 Templates syntax looks like this:
 

package/{actions → lib/actions}/commit.js

@@ -2,7 +2,6 @@
 
 var fs = require('fs');
 var path = require('path');
-var _ = require('lodash');
 var through = require('through2');
 var mkdirp = require('mkdirp');
 var rimraf = require('rimraf');
@@ -30,9 +29,11 @@ module.exports = function (filters, cb) {
   }
 
   var modifiedFilter = through.obj(function (file, enc, cb) {
-    if (['modified', 'deleted'].indexOf(file.state) >= 0) {
+    // Don't process deleted file who haven't been commited yet.
+    if (file.state === 'modified' || (file.state === 'deleted' && !file.isNew)) {
       this.push(file);
     }
+
     cb();
   });
 
@@ -43,7 +44,9 @@ module.exports = function (filters, cb) {
     } else if (file.state === 'deleted') {
       remove(file);
     }
+
     delete file.state;
+    delete file.isNew;
     cb();
   });
 

package/lib/actions/copy-tpl.js

@@ -0,0 +1,20 @@
+'use strict';
+
+var path = require('path');
+var extend = require('deep-extend');
+var ejs = require('ejs');
+
+module.exports = function (from, to, context, tplSettings, options) {
+  context = context || {};
+
+  this.copy(from, to, extend(options || {}, {
+    process: function (contents, filename) {
+      return ejs.render(
+        contents.toString(),
+        context,
+        // Setting filename by default allow including partials.
+        extend({filename: filename}, tplSettings || {})
+      );
+    }
+  }));
+};

package/{actions → lib/actions}/copy.js

@@ -5,12 +5,12 @@ var fs = require('fs');
 var path = require('path');
 var glob = require('glob');
 var globby = require('globby');
-var _ = require('lodash');
+var extend = require('deep-extend');
 var File = require('vinyl');
-var util = require('../util/util');
+var util = require('../util');
 
-function applyProcessingFunc(process, contents) {
-  var output = process(contents);
+function applyProcessingFunc(process, contents, filename) {
+  var output = process(contents, filename);
   return output instanceof Buffer ? output : new Buffer(output);
 }
 
@@ -28,7 +28,7 @@ exports.copy = function(from, to, options) {
     'When copying with glob patterns, provide a directory as destination'
   );
 
-  var globOptions = _.extend(options.globOptions || {}, { nodir: true });
+  var globOptions = extend(options.globOptions || {}, { nodir: true });
   var files = globby.sync(from, globOptions);
   var root = util.getCommonPath(from);
 
@@ -46,15 +46,10 @@ exports._copySingle = function (from, to, options) {
 
   var file = this.store.get(from);
 
-  var newFile = file.clone();
-  newFile.cwd = process.cwd();
-  newFile.base = path.basename(to);
-  newFile.path = to;
-  newFile.state = 'modified';
-
+  var contents = file.contents;
   if (options.process) {
-    newFile.contents = applyProcessingFunc(options.process, file.contents);
+    contents = applyProcessingFunc(options.process, file.contents, file.path);
   }
 
-  this.store.add(newFile);
+  this.write(to, contents, file.stat);
 };

package/{actions → lib/actions}/delete.js

@@ -2,15 +2,14 @@
 
 var assert = require('assert');
 var path = require('path');
-var _ = require('lodash');
 var globby = require('globby');
 var multimatch = require('multimatch');
-var util = require('../util/util');
+var util = require('../util');
 
 function deleteFile(path, store) {
   var file = store.get(path);
   file.state = 'deleted';
-  file.contents = new Buffer('');
+  file.contents = null;
   store.add(file);
 }
 

package/lib/actions/exists.js

@@ -0,0 +1,7 @@
+'use strict';
+
+module.exports = function (filepath) {
+	var file = this.store.get(filepath);
+
+	return file.contents !== null && file.state !== 'deleted';
+};

package/lib/actions/extend-json.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var extend = require('deep-extend');
+
+module.exports = function (filepath, contents, replacer, space) {
+  var originalContent = this.readJSON(filepath, {});
+  var newContent = extend({}, originalContent, contents);
+
+  this.writeJSON(filepath, newContent, replacer, space);
+};

package/lib/actions/read-json.js

@@ -0,0 +1,13 @@
+'use strict';
+
+module.exports = function (filepath, defaults) {
+  if (this.exists(filepath)) {
+    try {
+      return JSON.parse(this.read(filepath));
+    } catch (error) {
+      throw new Error('Could not parse JSON in file: ' + filepath + '. Detail: ' + error.message);
+    }
+  } else {
+    return defaults;
+  }
+};

package/{actions → lib/actions}/read.js

@@ -2,9 +2,9 @@
 
 var assert = require('assert');
 
-module.exports = function (path, options) {
+module.exports = function (filepath, options) {
   options = options || { raw: false };
-  var file = this.store.get(path);
+  var file = this.store.get(filepath);
 
   if (file.state === 'deleted' || file.contents === null) {
     if (typeof options.defaults === 'string' || options.defaults instanceof Buffer) {
@@ -15,7 +15,7 @@ module.exports = function (path, options) {
     }
   }
 
-  assert(file.contents !== null, path + ' doesn\'t exist');
+  assert(file.contents !== null, filepath + ' doesn\'t exist');
 
   return options.raw ? file.contents : file.contents.toString();
 };

package/{actions → lib/actions}/write-json.js

@@ -2,8 +2,8 @@
 
 var DEFAULT_INDENTATION = 2;
 
-module.exports = function (path, contents, replacer, space) {
+module.exports = function (filepath, contents, replacer, space) {
   var jsonStr = JSON.stringify(contents, replacer || null, space || DEFAULT_INDENTATION) + '\n';
 
-  return this.write(path, jsonStr);
+  return this.write(filepath, jsonStr);
 };

package/{actions → lib/actions}/write.js

@@ -2,14 +2,18 @@
 
 var assert = require('assert');
 
-module.exports = function (path, contents) {
+module.exports = function (filepath, contents, stat) {
   assert(
     typeof contents === 'string' || contents instanceof Buffer,
     'Expected `contents` to be a String or a Buffer'
   );
-  var file = this.store.get(path);
-  file.contents = typeof contents === 'string' ? new Buffer(contents) : contents;
+
+  var file = this.store.get(filepath);
+  file.isNew = file.contents === null;
   file.state = 'modified';
+  file.contents = typeof contents === 'string' ? new Buffer(contents) : contents;
+  file.stat = stat;
   this.store.add(file);
+
   return file.contents.toString();
 };

package/{index.js → lib/index.js}

@@ -9,6 +9,7 @@ EditionInterface.prototype.readJSON = require('./actions/read-json.js');
 EditionInterface.prototype.exists = require( './actions/exists' );
 EditionInterface.prototype.write = require('./actions/write.js');
 EditionInterface.prototype.writeJSON = require('./actions/write-json.js');
+EditionInterface.prototype.extendJSON = require('./actions/extend-json.js');
 EditionInterface.prototype.delete = require('./actions/delete.js');
 EditionInterface.prototype.copy = require('./actions/copy.js').copy;
 EditionInterface.prototype._copySingle = require('./actions/copy.js')._copySingle;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mem-fs-editor",
-  "version": "2.0.4",
+  "version": "2.3.0",
   "description": "File edition helpers working on top of mem-fs",
   "scripts": {
     "test": "mocha"
@@ -8,27 +8,26 @@
   "repository": "SBoudrias/mem-fs-editor",
   "author": "Simon Boudrias",
   "license": "MIT",
+  "main": "lib/index.js",
   "files": [
-    "actions",
-    "util",
-    "index.js"
+    "lib"
   ],
   "dependencies": {
     "commondir": "^1.0.1",
+    "deep-extend": "^0.4.0",
     "ejs": "^2.3.1",
-    "glob": "^5.0.3",
-    "globby": "^2.0.0",
-    "lodash": "^3.6.0",
+    "glob": "^7.0.3",
+    "globby": "^4.0.0",
     "mkdirp": "^0.5.0",
     "multimatch": "^2.0.0",
     "rimraf": "^2.2.8",
-    "sinon": "^1.12.2",
     "through2": "^2.0.0",
-    "vinyl": "^0.5.0"
+    "vinyl": "^1.1.0"
   },
   "devDependencies": {
     "escape-regexp": "0.0.1",
     "mem-fs": "^1.0.0",
-    "mocha": "^2.1.0"
+    "mocha": "^2.1.0",
+    "sinon": "^1.12.2"
   }
 }

package/actions/copy-tpl.js

@@ -1,21 +0,0 @@
-'use strict';
-
-var path = require('path');
-var _ = require('lodash');
-var ejs = require('ejs');
-
-module.exports = function (from, to, context, tplSettings) {
-  context = context || {};
-  tplSettings = tplSettings || {};
-
-  _.defaults(tplSettings, {
-    // Setting filename by default allow including partials.
-    filename: from
-  });
-
-  this.copy(from, to, {
-    process: function (contents) {
-      return ejs.render(contents.toString(), context, tplSettings);
-    }
-  });
-};

package/actions/exists.js

@@ -1,7 +0,0 @@
-'use strict';
-
-module.exports = function (path) {
-	var file = this.store.get(path);
-
-	return file.contents !== null && file.state !== 'deleted';
-};

package/actions/read-json.js

@@ -1,13 +0,0 @@
-'use strict';
-
-module.exports = function (path, defaults) {
-  if (this.exists(path)) {
-    try {
-      return JSON.parse(this.read(path));
-    } catch (error) {
-      throw new Error('Could not parse JSON in file: ' + path + '. Detail: ' + error.message);
-    }
-  } else {
-    return defaults;
-  }
-};