Merge pull request #13 from zoubin/refactor

Refactor.

Author: zoubin

README.md

@@ -28,7 +28,6 @@ or in `package.json`
 ```
   --no-ansi        Disable ANSI formatting
   --no-progress    Disable progress output during tests
-  --markdown       Format output as markdown
 ```
 
 ## Example

bin/cmd.js

@@ -1,21 +1,18 @@
 #!/usr/bin/env node
-var minimist = require('minimist')
 
-var opts = minimist(process.argv.slice(2), {
-  boolean: true,
-  alias: {
-    ansi: 'a',
-    progress: 'p',
-    markdown: 'm',
-  },
-  default: {
-    ansi: true,
-    progress: true,
-    markdown: false,
-  },
-})
+var Command = require('commander').Command
+var program = new Command('tap-summary')
+
+program
+  .version(require('../package.json').version)
+  .option('--no-ansi', 'Disable ANSI formatting.')
+  .option('--no-progress', 'Disable progress output during tests.')
+  .parse(process.argv)
 
-var reporter = require('..')(opts)
+var reporter = require('..')({
+  ansi: program.ansi,
+  progress: program.progress,
+})
 
 process.stdin
   .pipe(reporter)

example/comment.js

@@ -0,0 +1,16 @@
+var test = require('tape')
+
+test('sync', function (t) {
+  t.ok(true, 'should pass')
+  console.log('Hello, ')
+  t.end()
+})
+
+test('async', function (t) {
+  process.nextTick(function () {
+    t.ok(true, 'should pass')
+    console.log('world!')
+    t.end()
+  })
+})
+

example/error.js

@@ -0,0 +1,17 @@
+var test = require('tape')
+
+test('pass', function (t) {
+  t.ok(true, 'should pass')
+  t.end()
+})
+
+test('fail', function (t) {
+  t.ok(false, 'should fail')
+  t.end()
+})
+
+test('pass and fail', function (t) {
+  t.ok(true, 'should pass')
+  t.ok(false, 'should fail')
+  t.end()
+})

example/empty.js example/no-plan.js

@@ -1,7 +1,7 @@
 var test = require('tape')
 var math = require('./math')
 
-test('t.plan', function(t) {
+test('pass', function(t) {
   t.plan(3)
 
   t.equal(
@@ -20,7 +20,7 @@ test('t.plan', function(t) {
   })
 })
 
-test('t.end', function(t) {
+test('fail', function(t) {
   t.equal(
     math.precision(0),
     0
@@ -39,67 +39,20 @@ test('t.end', function(t) {
       if (plan) {
         NEXT()
       } else {
-        console.log('DONE')
         t.end()
       }
     })
   })()
 })
 
-test('promise support', function(t) {
-  var plan = 10
-  t.equal(
-    math.add(0.34, 0.01),
-    0.35
-  )
-  t.equal(
-    math.add(1.1111, -1.11),
-    0.0011
-  )
-  // the test will end when the returned promise resolves
-  return new Promise(function (rs) {
-    (function NEXT() {
-      next(function () {
-        t.equal(
-          math.add(1, 2),
-          --plan === 5 ? 2 : 3
-        )
-        if (plan) {
-          NEXT()
-        } else {
-          console.log('DONE')
-          rs()
-        }
-      })
-    })()
-  })
-})
-
-test('callback support', function(t, cb) {
+test('comment', function (t) {
   next(function () {
-    t.equal(
-      math.add(0.34, 0.01),
-      0.35
-    )
-    cb()
-  })
-})
-
-test('check `task-tape` for more information', function(t) {
-  t.task(function (cb) {
-    next(function () {
-      t.equal(
-        math.precision(0.1),
-        1
-      )
-      cb()
-    })
+    t.ok(true, 'should pass')
+    console.log('This is something from `console.log`')
+    t.end()
   })
 })
 
 function next(fn) {
-  setTimeout(function() {
-    fn()
-  }, 100)
+  setTimeout(fn, 100)
 }
-

example/test-pass.js example/pass.js

@@ -1,5 +1,5 @@
-var tapSummary = require('..')
 var fs = require('fs')
+var tapSummary = require('..')
 
 fs.createReadStream(__dirname + '/unnamed-test.tap')
   .pipe(tapSummary())

example/run-test.js

@@ -1,2 +1,10 @@
+var reporter = require('./lib/reporter')
+var Formatter = require('./lib/formatter')
+
+module.exports = function (opts) {
+  return reporter(new Formatter(opts))
+}
+module.exports.Formatter = Formatter
+module.exports.reporter = reporter
+module.exports.parser = require('./lib/parser')
 
-module.exports = require('./lib/summary')

example/test-error.js

@@ -0,0 +1,163 @@
+var format = require('ansi-escape')
+var symbols = require('figures')
+var prettyMs = require('pretty-ms')
+var LF = '\n'
+
+module.exports = Formatter
+
+function Formatter(opts) {
+  opts = opts || {}
+  this.needDuration = opts.duration !== false
+  this.needAnsi = opts.ansi !== false
+  this.needProgress = this.needAnsi && opts.progress !== false
+}
+
+Formatter.prototype.init = function (reporter) {
+  var self = this
+
+  reporter.push(LF + this.splitter(' Tests '))
+
+  reporter.on('test.start', function (test) {
+    Object.defineProperty(test, 'title', { get: getTitle })
+  })
+
+  function getTitle() {
+    return this.name + ' [' +
+      'pass: ' + this.pass + ', fail: ' + this.fail +
+      (self.needDuration ? ', duration: ' + prettyMs(this.duration || 0) : '') +
+      ']'
+  }
+
+  if (this.needProgress) {
+    reporter.on('test.start', function (test) {
+      this.push(LF + self.format('# ' + test.title, 'cha.eraseLine'))
+    })
+
+    reporter.on('test.pass', function (test) {
+      this.push(self.format('# ' + test.title, 'cha.eraseLine'))
+    })
+
+    reporter.on('test.fail', function (test) {
+      this.push(self.format('# ' + test.title, 'cha.eraseLine'))
+    })
+  }
+}
+
+Formatter.prototype.summary = function (summary) {
+  var output = [LF]
+  output.push(this.splitter(' Summary '))
+
+  if (this.needDuration) {
+    output.push(this.format(
+      'duration: ' + prettyMs(summary.duration),
+      'cyan'
+    ))
+  }
+  output.push(this.format(
+    'planned: ' + summary.planned,
+    summary.planned instanceof Error ? 'red' : 'cyan'
+  ))
+  output.push(this.format(
+    'assertions: ' + summary.assertions,
+    'cyan'
+  ))
+  output.push(this.format(
+    'pass: ' + summary.pass,
+    summary.pass ? 'green' : 'cyan'
+  ))
+  output.push(this.format(
+    'fail: ' + summary.fail,
+    summary.fail ? 'red' : 'cyan'
+  ))
+
+  return output.join(LF)
+}
+
+Formatter.prototype.comment = function (comments) {
+  var output = [LF]
+  output.push(this.splitter(' Comments '))
+  output.push(Object.keys(comments).map(function (name) {
+    return this.format('# ' + name, 'cyan.underline') + LF + comments[name].join(LF)
+  }, this).join(LF + LF))
+  return output.join(LF)
+}
+
+Formatter.prototype.fail = function (fail) {
+  var output = [LF]
+  output.push(this.splitter(' Fails '))
+  output.push(
+    Object.keys(fail).map(function (name) {
+      var res = [this.format('# ' + name, 'cyan.underline')]
+      fail[name].forEach(function (assertion) {
+        res.push(this.format('  ' + symbols.cross + ' ' + assertion.name, 'red'))
+        res.push(this.prettifyError(assertion))
+      }, this)
+      return res.join(LF)
+    }, this).join(LF + LF)
+  )
+  return output.join(LF)
+}
+
+Formatter.prototype.prettifyError = function (assertion) {
+  var rawError = assertion.error.raw
+  var ret = rawError.split(LF)
+  var stack = assertion.error.stack
+  if (stack) {
+    stack = stack.split(LF)
+    var padding = repeat(' ', ret[ret.length - 1].length)
+    ret = ret.concat(stack.map(function (s) {
+      return padding + s
+    }))
+  }
+  return this.format(ret.join(LF), 'cyan')
+}
+
+Formatter.prototype.splitter = function (s) {
+  var len = s.length
+  var max = 80
+  var left = max - len >> 1
+  return this.format(
+    repeat('-', left) + (s || '') + repeat('-', max - len - left) + LF,
+    'yellow'
+  )
+}
+
+Formatter.prototype.test = function (test) {
+  if (this.needProgress) {
+    if (test.fail) {
+      return this.format(symbols.cross + ' ' + test.title, 'cha.red.eraseLine')
+    }
+    return this.format(symbols.tick + ' ' + test.title, 'cha.green.eraseLine')
+  }
+
+  if (test.fail) {
+    return LF + this.format(symbols.cross + ' ' + test.title, 'cha.red')
+  }
+  return LF + this.format(symbols.tick + ' ' + test.title, 'cha.green')
+}
+
+Formatter.prototype.format = function (str, formats) {
+  if (!this.needAnsi) {
+    return str
+  }
+  // format.cyan.underline.escape(str)
+  return formats.split('.').reduce(function (f, c) {
+    f = f[c]
+    return f
+  }, format).escape(str)
+}
+
+function splitter(s) {
+  var len = s.length
+  var max = 80
+  var left = max - len >> 1
+  return repeat('-', left) + (s || '') + repeat('-', max - len - left) + LF
+}
+
+function repeat(str, n) {
+  if (str.repeat) {
+    return str.repeat(n)
+  }
+  return (new Array(n + 1)).join(str)
+}
+