specify-assertions
Version:
Beautiful assertion library.
281 lines (217 loc) • 6.36 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Specify (assertions) Source: divergence.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<a class="brand" href="index.html">Specify (assertions)</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="divergence.Divergence_.html">Divergence</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="divergence.html">specify-assertions/lib/divergence</a>
</li>
<li>
<a href="index_.html">specify-assertions/lib/index</a>
</li>
<li>
<a href="validations.html">specify-assertions/lib/validations</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
<h1 class="page-title">Source: divergence.js</h1>
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/**
* Describes divergent expectations on assertions.
*
* @module specify-assertions/lib/divergence
*/
// -- Dependencies -----------------------------------------------------
var boo = require('boo')
var spice = require('spice')
var show = require('util').inspect
var curry = require('core.lambda').curry
// -- Aliases ----------------------------------------------------------
var keys = Object.keys
// -- Helpers ----------------------------------------------------------
/**
* Maps an object.
*
* @private
* @summary (α → β) → Object[α] → Object[β]
*/
map = curry(2, map)
function map(f, object) {
return keys(object).reduce(function(result, key) {
result[key] = f(object[key])
return result
}, {})
}
/**
* Constructs a divergent expectation constructor.
*
* @method
* @summary String → Divergence
*/
exports.divergence = divergence
function divergence(message) {
return Divergence.derive({
toString: function() {
return spice(message, map(show, this.data))
}
})
}
/**
* Constructs a divergent with an inverse.
*
* @method
* @summary String → String → Divergence
*/
exports.invertibleDivergence = curry(2, invertibleDivergence)
function invertibleDivergence(message, negatedMessage) {
var divergence = Divergence.derive({
inverse: function() {
return negatedDivergence.make(this.data)
}
, toString: function() {
return spice(message, map(show, this.data))
}
})
var negatedDivergence = Divergence.derive({
inverse: function() {
return divergence.make(this.data)
}
, toString: function() {
return spice(negatedMessage, map(show, this.data))
}
})
return divergence
}
// -- Implementation ---------------------------------------------------
/**
* Represents a failed expectation in an assertion.
*
* @namespace
* @summary
* boo.Base <| Divergence
*/
exports.Divergence = Divergence
var Divergence = boo.Base.derive({
/**
* Constructs a new instance of this object.
*
* @name make
* @memberof module:lib/divergence.Divergence
* @method
* @summary Object → Divergence
*/
init: function(a) {
this.data = boo.merge(a)
}
/**
* Clones this object without running the initialisation code.
*
* All properties of the given objects are merged into the new clone, from
* left to right.
*
* @name derive
* @memberof module:lib/divergence.Divergence
* @method
* @summary Object... → Divergence
*/
/**
* Inverses this expectation.
*
* @method
* @name invert
* @memberof module:lib/divergence.Divergence
* @summary Void → Divergence :: partial, throws
*/
, inverse: function() {
throw new Error('This divergence doesn\'t have an inverse.')
}
/**
* Returns a textual representation of the divergence.
*
* @method
* @name toString
* @memberof module:lib/divergence.Divergence
* @summary Void → String
*/
, toString: function() {
return '[object Divergence]'
}
})
</pre>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
© 2014 Origami Tower
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Thu Dec 25 2014 14:27:25 GMT-0200 (BRST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>