Merge pull request #17 from testdouble/name-td

Allow naming test doubles for better output

Author: searls

lib/create.coffee

@@ -1,7 +1,13 @@
+_ = require('lodash')
+store = require('./store')
 calls = require('./store/calls')
 stubbings = require('./store/stubbings')
 
-module.exports = ->
-  testDouble = (args...) -> #<-- return a test double
+module.exports = (name) ->
+  _.tap createTestDoubleFunction(), (testDouble) ->
+    if name? then store.for(testDouble).name = name
+
+createTestDoubleFunction = ->
+  testDouble = (args...) ->
     calls.log(testDouble, args, this)
     stubbings.get(testDouble, args)

lib/explain.coffee

@@ -1,5 +1,6 @@
 _ = require('lodash')
 
+store = require('./store')
 callsStore = require('./store/calls')
 stubbingsStore = require('./store/stubbings')
 stringifyArgs = require('./stringify-args')
@@ -11,7 +12,7 @@ module.exports = (testDouble) ->
   callCount: calls.length
   calls: calls
   description: """
-  This test double has #{stubs.length} stubbings and #{calls.length} invocations.
+  This test double #{stringifyName(testDouble)}has #{stubs.length} stubbings and #{calls.length} invocations.
   """ + stubbingDescription(stubs) + callDescription(calls)
 
 stubbingDescription = (stubs) ->
@@ -26,4 +27,8 @@ callDescription = (calls) ->
     desc + "\n  - called with `(#{stringifyArgs(call.args)})`."
   , "\n\nInvocations:"
 
-
+stringifyName = (testDouble) ->
+  if name = store.for(testDouble).name
+    "`#{name}` "
+  else
+    ""

lib/verify.coffee

@@ -1,4 +1,5 @@
 _ = require('lodash')
+store = require('./store')
 callsStore = require('./store/calls')
 stringifyArgs = require('./stringify-args')
 
@@ -10,15 +11,15 @@ module.exports = ->
       throw new Error(unsatisfiedErrorMessage(last.testDouble, last.args))
   else
     throw new Error """
-      No test double invocation call detected for `verify()`.
+      No test double invocation detected for `verify()`.
 
         Usage:
           verify(myTestDouble('foo'))
       """
 
 unsatisfiedErrorMessage = (testDouble, args) ->
   """
-  Unsatisfied test double verification.
+  Unsatisfied verification on test double#{stringifyName(testDouble)}.
 
     Wanted:
       - called with `(#{stringifyArgs(args)})`.
@@ -32,3 +33,9 @@ invocationSummary = (testDouble) ->
     _.reduce calls, (desc, call) ->
       desc + "\n    - called with `(#{stringifyArgs(call.args)})`."
     , "\n\n  But was actually called:"
+
+stringifyName = (testDouble) ->
+  if name = store.for(testDouble).name
+    " `#{name}`"
+  else
+    ""

test/helper.coffee

@@ -7,14 +7,16 @@ global.xThen = ->
 global.shouldNotThrow = (func) ->
   func()
 
-global.shouldThrow = (func, message) ->
+global.shouldThrow = (func, expectedMessage) ->
   threw = null
+  actualMessage = null
   try
     func()
     threw = false
   catch e
-    expect(e.message).to.eq(message) if message?
+    actualMessage = e.message
+    expect(actualMessage).to.eq(expectedMessage) if expectedMessage?
     threw = true
   expect(threw, "Expected function to throw an error").to.be.true
-
+  actualMessage
 

test/lib/explain-test.coffee

@@ -14,6 +14,12 @@ describe '.explain', ->
       This test double has 0 stubbings and 0 invocations.
       """
 
+  context 'a named test double', ->
+    Given -> @testDouble = @create("foobaby")
+    Then -> expect(@result.description).to.deep.eq """
+      This test double `foobaby` has 0 stubbings and 0 invocations.
+      """
+
   context 'a double with some interactions', ->
     Given -> @when(@testDouble(88)).thenReturn(5)
     Given -> @when(@testDouble("two things!")).thenReturn("woah", "such")

test/lib/verify-test.coffee

@@ -9,7 +9,7 @@ describe '.verify', ->
 
   context 'an unsatisfied verification - no interactions', ->
     Then -> shouldThrow (=> @verify(@testDouble("WOAH"))), """
-      Unsatisfied test double verification.
+      Unsatisfied verification on test double.
 
         Wanted:
           - called with `("WOAH")`.
@@ -20,7 +20,7 @@ describe '.verify', ->
   context 'unsatisfied verify - other interactions', ->
     When -> @testDouble("the wrong WOAH")
     Then -> shouldThrow (=> @verify(@testDouble("WOAH"))), """
-      Unsatisfied test double verification.
+      Unsatisfied verification on test double.
 
         Wanted:
           - called with `("WOAH")`.
@@ -29,9 +29,14 @@ describe '.verify', ->
           - called with `("the wrong WOAH")`.
       """
 
-  context 'a double-free verification', ->
+  context 'with a named double', ->
+    Given -> @testDouble = @create("#footime")
+    When -> @result = (shouldThrow => @verify(@testDouble()))
+    Then -> expect(@result).to.contain("verification on test double `#footime`.")
+
+  context 'a double-free verification error', ->
     Then -> shouldThrow (=> @verify()), """
-      No test double invocation call detected for `verify()`.
+      No test double invocation detected for `verify()`.
 
         Usage:
           verify(myTestDouble('foo'))