isexe 1.0.0 → 1.1.2

package/LICENSE

@@ -0,0 +1,15 @@
+The ISC License
+
+Copyright (c) Isaac Z. Schlueter and Contributors
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -40,3 +40,12 @@ unless `options.ignoreErrors` is set to true.
 ### `isexe.sync(path, [options])`
 
 Same as `isexe` but returns the value and throws any errors raised.
+
+### Options
+
+* `ignoreErrors` Treat all errors as "no, this is not executable", but
+  don't raise them.
+* `uid` Number to use as the user id when using the `mode` approach.
+* `gid` Number to use as the group id when using the `mode` approach.
+* `pathExt` List of path extensions to use instead of `PATHEXT`
+  environment variable on Windows.

package/access.js

@@ -3,13 +3,13 @@ isexe.sync = sync
 
 var fs = require('fs')
 
-function isexe (path, cb) {
+function isexe (path, _, cb) {
   fs.access(path, fs.X_OK, function (er) {
     cb(er, !er)
   })
 }
 
-function sync (path) {
+function sync (path, _) {
   fs.accessSync(path, fs.X_OK)
   return true
 }

package/index.js

@@ -23,7 +23,7 @@ function isexe (path, options, cb) {
     }
 
     return new Promise(function (resolve, reject) {
-      isexe(path, options, function (er, is) {
+      isexe(path, options || {}, function (er, is) {
         if (er) {
           reject(er)
         } else {
@@ -33,7 +33,7 @@ function isexe (path, options, cb) {
     })
   }
 
-  core(path, function (er, is) {
+  core(path, options || {}, function (er, is) {
     // ignore EACCES because that just means we aren't allowed to run it
     if (er) {
       if (er.code === 'EACCES' || options && options.ignoreErrors) {
@@ -48,7 +48,7 @@ function isexe (path, options, cb) {
 function sync (path, options) {
   // my kingdom for a filtered catch
   try {
-    return core.sync(path)
+    return core.sync(path, options || {})
   } catch (er) {
     if (options && options.ignoreErrors || er.code === 'EACCES') {
       return false

package/mode.js

@@ -3,29 +3,35 @@ isexe.sync = sync
 
 var fs = require('fs')
 
-function isexe (path, cb) {
+function isexe (path, options, cb) {
   fs.stat(path, function (er, st) {
-    cb(er, er ? false : checkMode(st))
+    cb(er, er ? false : checkMode(st, options))
   })
 }
 
-function sync (path) {
-  return checkMode(fs.statSync(path))
+function sync (path, options) {
+  return checkMode(fs.statSync(path), options)
 }
 
-function checkMode (stat) {
+function checkMode (stat, options) {
   var mod = stat.mode
   var uid = stat.uid
   var gid = stat.gid
+
+  var myUid = options.uid !== undefined ?
+    options.uid : process.getuid && process.getuid()
+  var myGid = options.gid !== undefined ?
+    options.gid : process.getgid && process.getgid()
+
   var u = parseInt('100', 8)
   var g = parseInt('010', 8)
   var o = parseInt('001', 8)
   var ug = u | g
 
   var ret = (mod & o) ||
-    (mod & g) && process.getgid && gid === process.getgid() ||
-    (mod & u) && process.getuid && uid === process.getuid() ||
-    (mod & ug) && process.getuid && process.getuid() === 0
+    (mod & g) && gid === myGid ||
+    (mod & u) && uid === myUid ||
+    (mod & ug) && myUid === 0
 
   return ret
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isexe",
-  "version": "1.0.0",
+  "version": "1.1.2",
   "description": "Minimal module to check if a file is executable.",
   "main": "index.js",
   "directories": {
@@ -9,11 +9,20 @@
   "devDependencies": {
     "mkdirp": "^0.5.1",
     "rimraf": "^2.5.0",
-    "tap": "^5.0.1"
+    "tap": "^5.1.2"
   },
   "scripts": {
-    "test": "tap test/*.js --cov"
+    "test": "tap test/*.js --branches=100 --statements=100 --functions=100 --lines=100"
   },
   "author": "Isaac Z. Schlueter <i@izs.me> (http://blog.izs.me/)",
-  "license": "ISC"
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/isaacs/isexe.git"
+  },
+  "keywords": [],
+  "bugs": {
+    "url": "https://github.com/isaacs/isexe/issues"
+  },
+  "homepage": "https://github.com/isaacs/isexe#readme"
 }

package/test/basic.js

@@ -3,6 +3,8 @@ var fs = require('fs')
 var path = require('path')
 var fixture = path.resolve(__dirname, 'fixtures')
 var meow = fixture + '/meow.cat'
+var mine = fixture + '/mine.cat'
+var ours = fixture + '/ours.cat'
 var fail = fixture + '/fail.false'
 var noent = fixture + '/enoent.exe'
 var mkdirp = require('mkdirp')
@@ -27,11 +29,15 @@ t.test('setup fixtures', function (t) {
   fs.chmodSync(meow, parseInt('0755', 8))
   fs.writeFileSync(fail, '#!/usr/bin/env false\n')
   fs.chmodSync(fail, parseInt('0644', 8))
+  fs.writeFileSync(mine, '#!/usr/bin/env cat\nmine\n')
+  fs.chmodSync(mine, parseInt('0744', 8))
+  fs.writeFileSync(ours, '#!/usr/bin/env cat\nours\n')
+  fs.chmodSync(ours, parseInt('0754', 8))
   t.end()
 })
 
 t.test('promise', { skip: promiseSkip }, function (t) {
-  isexe = reset()
+  var isexe = reset()
   t.test('meow async', function (t) {
     isexe(meow).then(function (is) {
       t.ok(is)
@@ -59,6 +65,15 @@ t.test('promise', { skip: promiseSkip }, function (t) {
   t.end()
 })
 
+t.test('no promise', function (t) {
+  global.Promise = null
+  var isexe = reset()
+  t.throws('try to meow a promise', function () {
+    isexe(meow)
+  })
+  t.end()
+})
+
 t.test('access', { skip: accessSkip || winSkip }, function (t) {
   runTest(t)
 })
@@ -66,13 +81,33 @@ t.test('access', { skip: accessSkip || winSkip }, function (t) {
 t.test('mode', { skip: winSkip }, function (t) {
   delete fs.access
   delete fs.accessSync
+  var isexe = reset()
+  t.ok(isexe.sync(ours, { uid: 0, gid: 0 }))
+  t.ok(isexe.sync(mine, { uid: 0, gid: 0 }))
   runTest(t)
 })
 
 t.test('windows', function (t) {
   global.TESTING_WINDOWS = true
-  process.env.PATHEXT = '.EXE;.CAT;.CMD;.COM'
-  runTest(t)
+  var pathExt = '.EXE;.CAT;.CMD;.COM'
+  t.test('pathExt option', function (t) {
+    runTest(t, { pathExt: '.EXE;.CAT;.CMD;.COM' })
+  })
+  t.test('pathExt env', function (t) {
+    process.env.PATHEXT = pathExt
+    runTest(t)
+  })
+  t.test('no pathExt', function (t) {
+    // with a pathExt of '', any filename is fine.
+    // so the "fail" one would still pass.
+    runTest(t, { pathExt: '', skipFail: true })
+  })
+  t.test('pathext with empty entry', function (t) {
+    // with a pathExt of '', any filename is fine.
+    // so the "fail" one would still pass.
+    runTest(t, { pathExt: ';' + pathExt, skipFail: true })
+  })
+  t.end()
 })
 
 t.test('cleanup', function (t) {
@@ -80,18 +115,50 @@ t.test('cleanup', function (t) {
   t.end()
 })
 
-function runTest (t) {
+function runTest (t, options) {
   var isexe = reset()
 
-  t.notOk(isexe.sync(fail))
-  t.notOk(isexe.sync(noent, { ignoreErrors: true }))
-  t.ok(isexe.sync(meow))
+  var optionsIgnore = Object.create(options || {})
+  optionsIgnore.ignoreErrors = true
+
+  if (!options || !options.skipFail) {
+    t.notOk(isexe.sync(fail, options))
+  }
+  t.notOk(isexe.sync(noent, optionsIgnore))
+  if (!options) {
+    t.ok(isexe.sync(meow))
+  } else {
+    t.ok(isexe.sync(meow, options))
+  }
+
+  t.ok(isexe.sync(mine, options))
+  t.ok(isexe.sync(ours, options))
   t.throws(function () {
-    isexe.sync(noent)
+    isexe.sync(noent, options)
   })
 
   t.test('meow async', function (t) {
-    isexe(meow, function (er, is) {
+    if (!options) {
+      isexe(meow, function (er, is) {
+        if (er) {
+          throw er
+        }
+        t.ok(is)
+        t.end()
+      })
+    } else {
+      isexe(meow, options, function (er, is) {
+        if (er) {
+          throw er
+        }
+        t.ok(is)
+        t.end()
+      })
+    }
+  })
+
+  t.test('mine async', function (t) {
+    isexe(mine, options, function (er, is) {
       if (er) {
         throw er
       }
@@ -100,18 +167,30 @@ function runTest (t) {
     })
   })
 
-  t.test('fail async', function (t) {
-    isexe(fail, function (er, is) {
+  t.test('ours async', function (t) {
+    isexe(ours, options, function (er, is) {
       if (er) {
         throw er
       }
-      t.notOk(is)
+      t.ok(is)
       t.end()
     })
   })
 
+  if (!options || !options.skipFail) {
+    t.test('fail async', function (t) {
+      isexe(fail, options, function (er, is) {
+        if (er) {
+          throw er
+        }
+        t.notOk(is)
+        t.end()
+      })
+    })
+  }
+
   t.test('noent async', function (t) {
-    isexe(noent, function (er, is) {
+    isexe(noent, options, function (er, is) {
       t.ok(er)
       t.notOk(is)
       t.end()
@@ -119,7 +198,7 @@ function runTest (t) {
   })
 
   t.test('noent ignore async', function (t) {
-    isexe(noent, { ignoreErrors: true }, function (er, is) {
+    isexe(noent, optionsIgnore, function (er, is) {
       if (er) {
         throw er
       }

package/windows.js

@@ -3,12 +3,18 @@ isexe.sync = sync
 
 var fs = require('fs')
 
-function checkPathExt (path) {
-  var pathext = process.env.PATHEXT
+function checkPathExt (path, options) {
+  var pathext = options.pathExt !== undefined ?
+    options.pathExt : process.env.PATHEXT
+
   if (!pathext) {
     return true
   }
+
   pathext = pathext.split(';')
+  if (pathext.indexOf('') !== -1) {
+    return true
+  }
   for (var i = 0; i < pathext.length; i++) {
     var p = pathext[i].toLowerCase()
     if (p && path.substr(-p.length).toLowerCase() === p) {
@@ -18,13 +24,13 @@ function checkPathExt (path) {
   return false
 }
 
-function isexe (path, cb) {
+function isexe (path, options, cb) {
   fs.stat(path, function (er, st) {
-    cb(er, er ? false : checkPathExt(path))
+    cb(er, er ? false : checkPathExt(path, options))
   })
 }
 
-function sync (path) {
+function sync (path, options) {
   fs.statSync(path)
-  return checkPathExt(path)
+  return checkPathExt(path, options)
 }