test-buddy/lib/index.js

/// Module index
//
// Just add sugar!
//
//
// Copyright (c) 2013 Quildreen Motta
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation files
// (the "Software"), to deal in the Software without restriction,
// including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software,
// and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//

//// -- Dependencies ---------------------------------------------------
var extend = require('boo').extend
var run    = require('./runner').run
var Test   = require('./test').Test
var Suite  = require('./suite').Suite

//// -- Core implementation --------------------------------------------

// It   :: String, (() -> Promise a) -> Test a
// Spec :: String, (It, Spec) -> Suite

// :: Suite -> It
function it(suite) { return function(title, fun) {
  return Test.make(suite, title, fun)
}}

// :: Suite -> Spec
function describe(parent) { return function(title, fun) {
  var suite = Suite.make(parent, title)
  var ctx   = { it: it(suite)
              , describe: describe(suite)
              , beforeEach: suite.beforeEach
              , beforeAll: suite.beforeAll
              , afterEach: suite.afterEach
              , afterAll: suite.afterAll }


  if (fun)  fun.call(ctx, ctx.it, ctx.describe)

  return suite
}}

// :: String -> Spec
function catchAll(title) {
  var suite = Suite.make(null, title)

  var f = describe(suite)
  f.run = function(reporter){ return run(suite.tests, reporter) }

  return f
}

//// -- Exports --------------------------------------------------------
module.exports = extend( catchAll
                       , { Test:  Test
                         , Suite: Suite
                         , run:   run })