Merge branch 'promise-support'

Author: jonschlinkert

examples/promise.js

@@ -0,0 +1,11 @@
+'use strict';
+
+var glob = require('..');
+
+glob.on('files', function(files) {
+  console.log(files);
+});
+
+glob.promise(['**/*.js', '**/*.md'])
+  .then(null, console.error)
+

index.js

@@ -3,7 +3,7 @@
 var fs = require('fs');
 var path = require('path');
 var isGlob = require('is-glob');
-var each = require('async-each');
+var each = require('each-parallel-async');
 var spawn = require('cross-spawn');
 var isExtglob = require('is-extglob');
 var extend = require('extend-shallow');
@@ -38,7 +38,10 @@ function glob(pattern, options, cb) {
   }
 
   if (typeof cb !== 'function') {
-    throw new TypeError('expected callback to be a function');
+    if (typeof cb !== 'undefined') {
+      throw new TypeError('expected callback to be a function');
+    }
+    return glob.promise.apply(glob, arguments);
   }
 
   if (typeof pattern !== 'string') {
@@ -57,7 +60,7 @@ function glob(pattern, options, cb) {
       files = err;
     }
 
-    if (Array.isArray(files) && !files.length && opts.nullglob) {
+    if (opts.nullglob === true && Array.isArray(files) && !files.length) {
       files = [pattern];
     }
 
@@ -207,6 +210,22 @@ glob.sync = function(pattern, options) {
   return files;
 };
 
+/**
+ * Emit `end` and remove listeners
+ */
+
+glob.promise = function(pattern, options, cb) {
+  return new Promise(function(resolve, reject) {
+    glob(pattern, options, function(err, files) {
+      if (err) {
+        reject(err);
+      } else {
+        resolve(files);
+      }
+    });
+  });
+};
+
 /**
  * Emit `end` and remove listeners
  */
@@ -261,8 +280,6 @@ function bash(pattern, options, cb) {
       cb(code, getFiles(buf.toString(), pattern, options));
     });
   });
-
-  return glob;
 }
 
 /**
@@ -271,12 +288,7 @@ function bash(pattern, options, cb) {
 
 function normalize(val) {
   if (Array.isArray(val)) {
-    var len = val.length;
-    var idx = -1;
-    while (++idx < len) {
-      val[idx] = normalize(val[idx]);
-    }
-    return val.join(' ');
+    val = val.join(' ');
   }
   return val.split(' ').join('\\ ');
 }
@@ -287,14 +299,25 @@ function normalize(val) {
 
 function cmd(patterns, options) {
   var str = normalize(patterns);
-  var valid = ['dotglob', 'extglob', 'failglob', 'globstar', 'nocaseglob', 'nullglob'];
+  var keys = Object.keys(options);
   var args = [];
-  for (var key in options) {
-    if (options.hasOwnProperty(key) && valid.indexOf(key) !== -1) {
+  var valid = [
+    'dotglob',
+    'extglob',
+    'failglob',
+    'globstar',
+    'nocaseglob',
+    'nullglob'
+  ];
+
+  for (var i = 0; i < keys.length; i++) {
+    var key = keys[i];
+    if (valid.indexOf(key) !== -1) {
       args.push('-O', key);
     }
   }
-  args.push('-c', `for i in ${str}; do echo $i; done`);
+
+  args.push('-c', 'for i in ' + str + '; do echo $i; done');
   return args;
 }
 
@@ -368,7 +391,10 @@ function getFiles(res, pattern, options) {
       return new Error('no matches:' + pattern);
     }
   }
-  return files;
+
+  return files.filter(function(filepath) {
+    return filepath !== '.' && filepath !== '..';
+  });
 }
 
 /**

package.json

@@ -20,10 +20,10 @@
     "test": "mocha"
   },
   "dependencies": {
-    "async-each": "^1.0.1",
     "bash-path": "^1.0.1",
     "component-emitter": "^1.2.1",
     "cross-spawn": "^5.1.0",
+    "each-parallel-async": "^1.0.0",
     "extend-shallow": "^2.0.1",
     "is-extglob": "^2.1.1",
     "is-glob": "^4.0.0"

test/_setup.js

@@ -0,0 +1,39 @@
+'use strict';
+
+require('mocha');
+var del = require('delete');
+var path = require('path');
+var symlinks = require('./support/symlinks');
+var setup = require('./support/setup');
+var home = require('./support/home');
+
+var fixtures = path.join(__dirname, 'fixtures');
+var files = [
+  'a/.abcdef/x/y/z/a',
+  'a/abcdef/g/h',
+  'a/abcfed/g/h',
+  'a/b/c/d',
+  'a/bc/e/f',
+  'a/c/d/c/b',
+  'a/cb/e/f',
+  'a/x/.y/b',
+  'a/z/.y/b'
+];
+
+describe('setup', function() {
+  it('should remove fixtures', function(cb) {
+    del([fixtures, '/tmp/glob-test'], {force: true}, cb);
+  });
+
+  it('should create test fixtures', function(cb) {
+    setup(files, fixtures, cb);
+  });
+
+  it('should setup symlinks', function(cb) {
+    symlinks(fixtures, cb);
+  });
+
+  it('should setup fixtures in user home', function(cb) {
+    home(['foo', 'bar', 'baz', 'asdf', 'quux', 'qwer', 'rewq'], cb);
+  });
+});

test/glob.js renamed to test/api.js

@@ -11,15 +11,15 @@ describe('bash-glob', function() {
       assert.equal(typeof glob, 'function');
     });
 
-    it('should export a `.sync` method', function() {
+    it('should expose a `.sync` method', function() {
       assert.equal(typeof glob.sync, 'function');
     });
   });
 
   describe('async: errors', function() {
     it('should throw an error when a callback is not passed', function(cb) {
       try {
-        glob();
+        glob('*', {}, null);
         cb(new Error('expected an error'));
       } catch (err) {
         assert(err);

test/async.js

@@ -35,8 +35,7 @@ describe('set up broken symlink', function() {
     process.chdir(__dirname);
     cleanup();
     mkdirp.sync('fixtures/a/broken-link');
-    fs.symlinkSync('this-does-not-exist', 'fixtures/a/broken-link/link');
-    cb();
+    fs.symlink('this-does-not-exist', 'fixtures/a/broken-link/link', cb);
   });
 
   after(function(cb) {
@@ -45,7 +44,7 @@ describe('set up broken symlink', function() {
     cb();
   });
 
-  describe('async test', function() {
+  describe('async', function() {
     patterns.forEach(function(pattern) {
       it(pattern, function(cb) {
         if (isWindows) {
@@ -76,7 +75,61 @@ describe('set up broken symlink', function() {
     });
   });
 
-  describe('sync test', function() {
+  describe('promise - implied (no callback)', function() {
+    patterns.forEach(function(pattern) {
+      it(pattern, function(cb) {
+        if (isWindows) {
+          this.skip();
+          return;
+        }
+
+        each(options, function(opts, next) {
+          glob(pattern, opts)
+            .then(function(files) {
+              var msg = pattern + ' options=' + JSON.stringify(opts);
+              if (opts && opts.follow === true) {
+                assert.equal(files.indexOf(link), -1, msg);
+              } else if (pattern !== link || (opts && opts.nonull)) {
+                assert.notEqual(files.indexOf(link), -1, msg);
+              } else {
+                assert(!files.length);
+              }
+              setImmediate(next);
+            })
+            .catch(next);
+        }, cb);
+      });
+    });
+  });
+
+  describe('promise - explicit', function() {
+    patterns.forEach(function(pattern) {
+      it(pattern, function(cb) {
+        if (isWindows) {
+          this.skip();
+          return;
+        }
+
+        each(options, function(opts, next) {
+          glob.promise(pattern, opts)
+            .then(function(files) {
+              var msg = pattern + ' options=' + JSON.stringify(opts);
+              if (opts && opts.follow === true) {
+                assert.equal(files.indexOf(link), -1, msg);
+              } else if (pattern !== link || (opts && opts.nonull)) {
+                assert.notEqual(files.indexOf(link), -1, msg);
+              } else {
+                assert(!files.length);
+              }
+              setImmediate(next);
+            })
+            .catch(next);
+        }, cb);
+      });
+    });
+  });
+
+  describe('sync', function() {
     patterns.forEach(function(pattern) {
       it(pattern, function() {
         if (isWindows) {

test/broken-symlink.js

@@ -13,12 +13,24 @@ var patterns = [
 
 describe('empty sets', function() {
   patterns.forEach(function(pattern) {
-    it(JSON.stringify(pattern), function(cb) {
+    it('async: ' + JSON.stringify(pattern), function(cb) {
       glob(pattern, function(err, files) {
         if (err) return cb(err);
         assert.deepEqual(files, [], 'expected an empty array');
         cb();
       });
     });
+
+    it('promise: ' + JSON.stringify(pattern), function() {
+      return glob(pattern)
+        .then(function(files) {
+          assert.deepEqual(files, [], 'expected an empty array');
+        });
+    });
+
+    it('sync: ' + JSON.stringify(pattern), function() {
+      var files = glob.sync(pattern);
+      assert.deepEqual(files, [], 'expected an empty array');
+    });
   });
 });

test/empty-set.js

@@ -71,14 +71,10 @@ describe('options.cwd', function() {
     var notdir = 'a/b/c/d';
     var expected = 'cwd is not a directory: ' + notdir;
 
-    it('sync', function(cb) {
-      try {
+    it('sync', function() {
+      assert.throws(function() {
         glob.sync('*', {cwd: notdir});
-        cb(new Error('expected an error'));
-      } catch (err) {
-        assert.equal(err.message, expected);
-        cb();
-      }
+      });
     });
 
     it('async', function(cb) {
@@ -87,6 +83,16 @@ describe('options.cwd', function() {
         cb();
       });
     });
+
+    it('promise', function() {
+      return glob('*', {cwd: notdir})
+        .then(function() {
+          return Promise.reject(new Error('expected glob error to be thrown'));
+        })
+        .catch(function(err) {
+          assert.equal(err.message, expected);
+        });
+    });
   });
 });