Fix: Avoid mutating the options passed in (closes #75)

phated · phated · commit f369978f2c86 · 2017-02-21T16:55:40.000-07:00
diff --git a/index.js b/index.js
@@ -17,23 +17,26 @@ function globStream(globs, opt) {
   if (!opt) {
     opt = {};
   }
-  if (typeof opt.cwd !== 'string') {
-    opt.cwd = process.cwd();
+
+  var ourOpt = extend({}, opt);
+
+  if (typeof ourOpt.cwd !== 'string') {
+    ourOpt.cwd = process.cwd();
   }
-  if (typeof opt.dot !== 'boolean') {
-    opt.dot = false;
+  if (typeof ourOpt.dot !== 'boolean') {
+    ourOpt.dot = false;
   }
-  if (typeof opt.silent !== 'boolean') {
-    opt.silent = true;
+  if (typeof ourOpt.silent !== 'boolean') {
+    ourOpt.silent = true;
   }
-  if (typeof opt.nonull !== 'boolean') {
-    opt.nonull = false;
+  if (typeof ourOpt.nonull !== 'boolean') {
+    ourOpt.nonull = false;
   }
-  if (typeof opt.cwdbase !== 'boolean') {
-    opt.cwdbase = false;
+  if (typeof ourOpt.cwdbase !== 'boolean') {
+    ourOpt.cwdbase = false;
   }
-  if (opt.cwdbase) {
-    opt.base = opt.cwd;
+  if (ourOpt.cwdbase) {
+    ourOpt.base = ourOpt.cwd;
   }
 
   // Only one glob no need to aggregate
@@ -79,7 +82,7 @@ function globStream(globs, opt) {
   function streamFromPositive(positive) {
     var negativeGlobs = negatives.filter(indexGreaterThan(positive.index))
       .map(toGlob);
-    return createStream(positive.glob, negativeGlobs, opt);
+    return createStream(positive.glob, negativeGlobs, ourOpt);
   }
 }
 
diff --git a/test/main.js b/test/main.js
@@ -625,52 +625,74 @@ describe('glob-stream', function() {
   });
 });
 
-describe('ignore option', function() {
+describe('options', function() {
 
-  it('should support the ignore option instead of negation', function(done) {
-    var expectedPath = join(__dirname, './fixtures/stuff/run.dmc');
-    var glob = join(__dirname, './fixtures/stuff/*.dmc');
-    var stream = globStream(glob, { cwd: __dirname, ignore: ['./fixtures/stuff/test.dmc'] });
+  it('avoids mutation of options', function(done) {
 
-    var files = [];
-    stream.on('error', done);
-    stream.on('data', function(file) {
-      should.exist(file);
-      should.exist(file.path);
-      files.push(file);
-    });
-    stream.on('end', function() {
-      files.length.should.equal(1);
-      files[0].path.should.equal(expectedPath);
-      done();
-    });
+    var defaultedOpts = {
+      cwd: process.cwd(),
+      dot: false,
+      silent: true,
+      nonull: false,
+      cwdbase: false,
+    };
+
+    var opts = {};
+
+    var stream = globStream(join(__dirname, './fixtures/stuff/run.dmc'), opts);
+    Object.keys(opts).length.should.equal(0);
+    opts.should.not.eql(defaultedOpts);
+    stream.on('data', function() {});
+    stream.on('end', done);
   });
 
-  it('should support the ignore option with dot option', function(done) {
-    var stream = globStream('./fixtures/*swag', { cwd: __dirname, dot: true, ignore: ['./fixtures/**'] });
-    should.exist(stream);
-    stream.on('error', function(err) {
-      throw err;
-    });
-    stream.once('data', function(file) {
-      throw new Error('file ' + file.path + ' should have been negated');
+  describe('ignore', function() {
+
+    it('should support the ignore option instead of negation', function(done) {
+      var expectedPath = join(__dirname, './fixtures/stuff/run.dmc');
+      var glob = join(__dirname, './fixtures/stuff/*.dmc');
+      var stream = globStream(glob, { cwd: __dirname, ignore: ['./fixtures/stuff/test.dmc'] });
+
+      var files = [];
+      stream.on('error', done);
+      stream.on('data', function(file) {
+        should.exist(file);
+        should.exist(file.path);
+        files.push(file);
+      });
+      stream.on('end', function() {
+        files.length.should.equal(1);
+        files[0].path.should.equal(expectedPath);
+        done();
+      });
     });
-    stream.once('end', done);
-  });
 
-  it('should merge ignore option and negative globs', function(done) {
-    var globArray = [
-      './fixtures/stuff/*.dmc',
-      '!./fixtures/stuff/test.dmc',
-    ];
-    var stream = globStream(globArray, { cwd: __dirname, ignore: ['./fixtures/stuff/run.dmc'] });
-    should.exist(stream);
-    stream.on('error', function(err) {
-      throw err;
+    it('should support the ignore option with dot option', function(done) {
+      var stream = globStream('./fixtures/*swag', { cwd: __dirname, dot: true, ignore: ['./fixtures/**'] });
+      should.exist(stream);
+      stream.on('error', function(err) {
+        throw err;
+      });
+      stream.once('data', function(file) {
+        throw new Error('file ' + file.path + ' should have been negated');
+      });
+      stream.once('end', done);
     });
-    stream.once('data', function(file) {
-      throw new Error('file ' + file.path + ' should have been negated');
+
+    it('should merge ignore option and negative globs', function(done) {
+      var globArray = [
+        './fixtures/stuff/*.dmc',
+        '!./fixtures/stuff/test.dmc',
+      ];
+      var stream = globStream(globArray, { cwd: __dirname, ignore: ['./fixtures/stuff/run.dmc'] });
+      should.exist(stream);
+      stream.on('error', function(err) {
+        throw err;
+      });
+      stream.once('data', function(file) {
+        throw new Error('file ' + file.path + ' should have been negated');
+      });
+      stream.once('end', done);
     });
-    stream.once('end', done);
   });
 });

Original file line number	Diff line number	Diff line change
`@@ -17,23 +17,26 @@ function globStream(globs, opt) {`
`17`	`17`	`if (!opt) {`
`18`	`18`	`opt = {};`
`19`	`19`	`}`
`20`		`- if (typeof opt.cwd !== 'string') {`
`21`		`- opt.cwd = process.cwd();`
	`20`	`+`
	`21`	`+ var ourOpt = extend({}, opt);`
	`22`	`+`
	`23`	`+ if (typeof ourOpt.cwd !== 'string') {`
	`24`	`+ ourOpt.cwd = process.cwd();`
`22`	`25`	`}`
`23`		`- if (typeof opt.dot !== 'boolean') {`
`24`		`- opt.dot = false;`
	`26`	`+ if (typeof ourOpt.dot !== 'boolean') {`
	`27`	`+ ourOpt.dot = false;`
`25`	`28`	`}`
`26`		`- if (typeof opt.silent !== 'boolean') {`
`27`		`- opt.silent = true;`
	`29`	`+ if (typeof ourOpt.silent !== 'boolean') {`
	`30`	`+ ourOpt.silent = true;`
`28`	`31`	`}`
`29`		`- if (typeof opt.nonull !== 'boolean') {`
`30`		`- opt.nonull = false;`
	`32`	`+ if (typeof ourOpt.nonull !== 'boolean') {`
	`33`	`+ ourOpt.nonull = false;`
`31`	`34`	`}`
`32`		`- if (typeof opt.cwdbase !== 'boolean') {`
`33`		`- opt.cwdbase = false;`
	`35`	`+ if (typeof ourOpt.cwdbase !== 'boolean') {`
	`36`	`+ ourOpt.cwdbase = false;`
`34`	`37`	`}`
`35`		`- if (opt.cwdbase) {`
`36`		`- opt.base = opt.cwd;`
	`38`	`+ if (ourOpt.cwdbase) {`
	`39`	`+ ourOpt.base = ourOpt.cwd;`
`37`	`40`	`}`
`38`	`41`
`39`	`42`	`// Only one glob no need to aggregate`
`@@ -79,7 +82,7 @@ function globStream(globs, opt) {`
`79`	`82`	`function streamFromPositive(positive) {`
`80`	`83`	`var negativeGlobs = negatives.filter(indexGreaterThan(positive.index))`
`81`	`84`	`.map(toGlob);`
`82`		`- return createStream(positive.glob, negativeGlobs, opt);`
	`85`	`+ return createStream(positive.glob, negativeGlobs, ourOpt);`
`83`	`86`	`}`
`84`	`87`	`}`
`85`	`88`