unit.js/src/asserters/object.js

Simple, intuitive and flexible unit testing framework for javascript / Node.js (browser and server). Integrates awesome assertions libraries like Must.js, Should.js, Assert of Node.js, Sinon.js and other friendly features (promise, IoC, plugins, ...).

/**
 * This file is part of the Unit.js testing framework.
 *
 * (c) Nicolas Tallefourtane <dev@nicolab.net>
 *
 * For the full copyright and license information, please view
 * the LICENSE file distributed with this source code
 * or visit http://unitjs.com.
 *
 * @author Nicolas Tallefourtane <dev@nicolab.net>
 */

'use strict';

var _                = require('lodash');

// constructor
var RawControlFlow     = require('../control-flow');

// object
var rawAssertions    = require('../assertions');

// array
var commonAssertions = require('../common-assertions');

var util             = require('../util');

// list the assertions to the current asserter (specific and common)
var useAssertions = commonAssertions.concat([

  // matchers
  'matchEach', 'notMatchEach',

  // types
  'isArray',

  // types augmented
  'isRegExp', 'isNotRegExp', 'isDate', 'isNotDate',
  'isArguments', 'isNotArguments', 'isEmpty', 'isNotEmpty',

  // quantifications
  'hasLength', 'hasNotLength',

  // containers
  'isInstanceOf', 'isNotInstanceOf', 'isEnumerable', 'isNotEnumerable',
  'isFrozen', 'isNotFrozen', 'hasProperty', 'hasNotProperty',
  'hasOwnProperty', 'hasNotOwnProperty', 'hasProperties', 'hasNotProperties',
  'hasOwnProperties', 'hasKey', 'notHasKey', 'hasKeys', 'notHasKeys',
  'hasValue', 'notHasValue', 'hasValues', 'notHasValues',
  'contains', 'notContains'
]);

function getName(obj) {

  if (typeof obj === 'undefined'){
    return 'undefined';
  }

  if (obj === null){
    return 'null';
  }

  return Object.prototype.toString.call(obj).match(/^\[object\s(.*)\]$/)[1];
}

var asserter = {

  hasName: function(expected){
    this.value(getName(this.actual)).isIdenticalTo(expected);

    return this;
  }
};

/**
 * Expose all assertions
 * @type {function}
 * @param  {mixed} actual Actual value tested
 * @return {Object}        The current asserter
 */
module.exports = function ObjectAsserter(actual) {

  // actual value tested
  this.actual = actual;

  // assertions with the current context
  var assertions = rawAssertions.call(this, actual);

  // Build the common API with the current context
  var ControlFlow = RawControlFlow.bind(this);
  var commonApi = new ControlFlow();

  // provides the common API in the current asserter
  for (var method in commonApi) {
    this[method] = commonApi[method];
  }

  // assert the type
  assertions.isObject(this.actual);

  // provides the assertions to the current asserter (specific and common)
  var asserterAssertions = util.merge(
    _.pick(assertions, useAssertions), asserter
  );

  for (var method in asserterAssertions) {
    this[method] = asserterAssertions[method];
  }

  // return this asserter
  return this;
};