Extract functions

.gitignore

@@ -9,6 +9,7 @@ npm-debug.log
 
 results
 coverage
+.nyc_output
 
 *.swp
 .idea

index.js

@@ -1,58 +1,35 @@
 const Assert = require('assert')
-const Child = require('child_process')
-const FS = require('fs')
-const Parallel = require('run-parallel')
 const Path = require('path')
+const Parallel = require('run-parallel')
+const { command, project } = require('./lib')
 
 // get details about package and environment
-module.exports = (options, done) => {
-  if (typeof options === 'function') {
-    done = options
-    options = {}
-  }
+module.exports = (commands, done) => {
+  if (isFunction(commands)) [ commands, done ] = [ {}, commands ]
 
-  Assert.equal(typeof options, 'object', 'Options must be an object')
-  Assert.equal(typeof done, 'function', 'Must pass in a callback function')
+  Assert(isObject(commands), '`commands` must be an object')
+  Assert(isFunction(done), 'Must pass in a callback function')
 
   Parallel([
-    packageDetails,
     (next) => process.nextTick(next, null, { env: process.env.NODE_ENV }),
-    (next) => {
-      const cmds = Object.assign({ node: 'node -v', npm: 'npm -v' }, options)
-
-      commandDetails(cmds, next)
-    }
+    (next) => project(Path.dirname(require.main.filename), next),
+    (next) => commandDetails(commands, next)
   ], (err, results) => {
-    if (err) done(err)
-    else done(null, Object.assign({}, ...results))
+    done(err, Object.assign({}, ...results))
   })
 }
 
-// get name and version from package
-const packageDetails = (done) => {
-  const packagePath = Path.join(process.cwd(), 'package.json')
-
-  FS.readFile(packagePath, 'utf8', (err, data) => {
-    if (err) return done(err)
-
-    const { name, version } = JSON.parse(data)
+const isObject = (value) => typeof value === 'object' && !Array.isArray(value)
 
-    done(null, { name, version })
-  })
-}
+const isFunction = (value) => typeof value === 'function'
 
 // execute all passed commands and yield results
-const commandDetails = (cmds, done) => {
+const commandDetails = (commands, done) => {
+  const cmds = Object.assign({ node: 'node -v', npm: 'npm -v' }, commands)
   const tasks = Object.keys(cmds)
-    .reduce((acc, key) => Object.assign(acc, { [key]: proc(cmds[key]) }), {})
+    .reduce((acc, key) => Object.assign(acc, {
+      [key]: (next) => command(cmds[key], next)
+    }), {})
 
   Parallel(tasks, done)
 }
-
-// curry command, return function that yields error string or result
-const proc = (cmd) => (done) => {
-  Child.exec(cmd, (err, stdout) => {
-    if (err) done(null, err.toString())
-    else done(null, stdout.replace(/\n/g, ''))
-  })
-}

lib.js

@@ -0,0 +1,24 @@
+const { exec } = require('child_process')
+const ReadPkgUp = require('read-pkg-up')
+
+// yield name and version from closest package.json, or empty object
+exports.project = (cwd, done) => {
+  const resolved = ({ pkg }) => {
+    if (!pkg) return done(null, {})
+
+    const { name, version } = pkg
+
+    done(null, { name, version })
+  }
+  const rejected = () => done(null, {})
+
+  ReadPkgUp({ cwd }).then(resolved, rejected)
+}
+
+// execute command and yield trimmed output
+exports.command = (cmd, done) => {
+  exec(cmd, (err, stdout, stderr) => {
+    if (err || stderr) done(null, err ? err.toString() : stderr.trim())
+    else done(null, stdout ? stdout.trim() : '')
+  })
+}

package.json

@@ -13,13 +13,16 @@
     "Fran Varney <fran.varn@gmail.com>"
   ],
   "dependencies": {
+    "read-pkg-up": "2.0.0",
     "run-parallel": "1.1.6"
   },
   "devDependencies": {
-    "code": "2.0.1",
-    "lab": "10.9.0",
-    "sinon": "1.17.2",
-    "standard": "~10.0.2"
+    "code": "~4.0.0",
+    "mkdirp": "~0.5.1",
+    "standard": "~10.0.2",
+    "tap": "~10.3.2",
+    "temporary-directory": "~1.0.2",
+    "testdouble": "~2.1.2"
   },
   "engines": {
     "node": "^6"
@@ -36,9 +39,9 @@
     "url": "git+https://github.com/jackboberg/knock-knock.git"
   },
   "scripts": {
-    "coverage": "lab --coverage --reporter lcov --output coverage/lcov.info",
+    "cov": "npm run unit -- --cov --coverage-report=lcov",
     "lint": "standard -v",
-    "posttest": "npm run lint",
-    "test": "lab -cvv"
+    "test": "npm run lint && npm run unit",
+    "unit": "tap test/*.js -R spec --100"
   }
 }

test/command.js

@@ -0,0 +1,71 @@
+const TD = require('testdouble')
+const { EOL } = require('os')
+const { exec } = TD.replace('child_process')
+const { expect } = require('code')
+const { test: describe } = require('tap')
+
+const { command } = require('../lib')
+
+describe('lib.command', ({ afterEach, beforeEach, plan, test }) => {
+  const cmd = 'test'
+  const output = `\toutput${EOL}`
+
+  plan(5)
+
+  beforeEach((done) => {
+    TD.when(exec(cmd)).thenCallback(null, output)
+    done()
+  })
+
+  afterEach((done) => {
+    TD.reset()
+    done()
+  })
+
+  test('executes the given command', (t) => {
+    command(cmd, () => {
+      const { callCount, calls } = TD.explain(exec)
+
+      expect(callCount).to.equal(1)
+      expect(calls[0].args).to.include(cmd)
+      t.end()
+    })
+  })
+
+  test('yields trimmed stdout', (t) => {
+    command(cmd, (err, out) => {
+      expect(err).to.not.exist()
+      expect(out).to.equal('output')
+      t.end()
+    })
+  })
+
+  test('yields trimmed stderr', (t) => {
+    TD.when(exec(cmd)).thenCallback(null, null, output)
+    command(cmd, (err, out) => {
+      expect(err).to.not.exist()
+      expect(out).to.equal('output')
+      t.end()
+    })
+  })
+
+  test('when errors yields the error string', (t) => {
+    const error = new Error('fail')
+
+    TD.when(exec(cmd)).thenCallback(error)
+    command(cmd, (err, out) => {
+      expect(err).to.not.exist()
+      expect(out).to.equal('Error: fail')
+      t.end()
+    })
+  })
+
+  test('whithout output yields an empty string', (t) => {
+    TD.when(exec(cmd)).thenCallback()
+    command(cmd, (err, out) => {
+      expect(err).to.not.exist()
+      expect(out).to.equal('')
+      t.end()
+    })
+  })
+})

test/fixtures/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@test/module",
+  "version": "1.2.3",
+  "description": "an empty test module",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "Jack Boberg <hello@jackboberg.info> (http://jackboberg.info/)",
+  "license": "MIT"
+}