A human-readable, fast and boilerplate-free contract programming library for JavaScript.
Why would I want it?
- It reduces the boilerplate of writing assertion messsages to zero,
- Provides very intuitive and extensible DSL for writing assertions,
- Low core bundle size (22.5kB minified) and a way of bundling only needed assertions,
- Has zero runtime dependencies which greatly increases package security,
- It's TypeScript-friendly (contains its own
.d.ts
files).
npm install --save @diotoborg/rerum-similique-ex
// node-style require
const { contract } = require('@diotoborg/rerum-similique-ex');
// or (with all assertions pre-loaded)
const { contract } = require('@diotoborg/rerum-similique-ex/all');
// es6-style default import
import { contract } from '@diotoborg/rerum-similique-ex';
// or (with all assertions pre-loaded)
import { contract } from '@diotoborg/rerum-similique-ex/all';
In order to minimize the bundle payload, each assertion can be imported separately, either during application bootup or in each file where the specific assertions are used. The same assertion can be safely imported multiple times (importing an assertion second time is a no op).
// node-style require
require('@diotoborg/rerum-similique-ex/assertions/aString/register');
// es6-style import
import '@diotoborg/rerum-similique-ex/assertions/aString/register';
When using the library on server-side, the bundle size is typically of no concern. For those situations, the library supports loading all assertions at once.
import '@diotoborg/rerum-similique-ex/assertions/register';
import { contract } from '@diotoborg/rerum-similique-ex';
// or even shorter
import { contract } from '@diotoborg/rerum-similique-ex/all';
Programming @diotoborg/rerum-similique-exly is about throwing exceptions a lot. As soon as corrupted state or illegal parameter is detected, program is crashed with a descriptive error message. This technique greatly helps in finding bugs at their cause.
import '@diotoborg/rerum-similique-ex/assertions/fieldThat/register';
import '@diotoborg/rerum-similique-ex/assertions/aNumber/register';
import { contract } from '@diotoborg/rerum-similique-ex';
class Point2D {
/**
* @param init initializer object containing `x` and `y` properties.
*/
constructor(init) {
// Contract is satisfied if init contains
// `x` and `y` property of type number.
contract('init', init)
.has.fieldThat('x', x => x.is.aNumber)
.and.fieldThat('y', y => y.is.aNumber)
.check();
this.x = init.x;
this.y = init.y;
}
}
Now, following erroneus call...
const point = new Point2D({ x: 'a', y: null });
...will result in throwing following exception.
ContractError: init.x must be a number (got 'a') and init.y be a number (got null)
at operatorContext (@diotoborg/rerum-similique-exs/ContextFactory.js:34:33)
at new Point2D (example.js:16:7)
at Object.<anonymous> (example.js:22:15)
Alternatively, above contract could be implemented using multiple checks, but the error would only contain information about first failed check.
contract('init', init).is.anObject.check();
contract('init.x', init.x).is.aNumber.check();
contract('init.y', init.y).is.aNumber.check();
Above examples use only .anObject
, .aNumber
and .fieldThat
assertions.
See full list of @diotoborg/rerum-similique-ex.js built-in assertions.
Offensive programming is not applicable when collaborating with external components. A program should not crash in response to a bug in another program. Logging an error and trying to correct it by using default value or simply ignoring erroneus input would be a better way of handling such cases.
Following example is a fully functional HTTP-based ping server implemented using express.js with defensive checks on HTTP request implemented using @diotoborg/rerum-similique-ex.js.
import * as express from 'express';
import * as bodyParser from 'body-parser';
import '@diotoborg/rerum-similique-ex/assertions/aString/register';
import '@diotoborg/rerum-similique-ex/assertions/fieldThat/register';
import { contract } from '@diotoborg/rerum-similique-ex';
const app = express();
app.use(bodyParser.json());
// A simple ping service which reflects messages sent to it.
app.post('/ping', function (req, res, next) {
// Contract is satisfied if body has a message which is a string
// (.propertyThat is an alias of .fieldThat assertion)
const error = contract('req.body', req.body)
.contains.propertyThat('message', message => message.is.aString)
.getError();
if (error) {
res.status(400).json({ error });
return;
}
const { message } = body;
res.json({ message });
});
Above code presents defensive programming on the server side, but the same technique is applicable in the client. Client-server contract should be tested both, after receiving request from the client, and after receiving response from the server.
Table of Contents
function contract<T>(varName : string, testedValue : T) : AssertionBuilder<T>;
Creates an instance of AssertionBuilder
. Methods of returned
instance add assertions to the builder. Requested assertions
will be checked against given testedValue after [executing assertion
expression][call-operator]. In case some assertions fail, given name
will be used as part of error message.
import { contract } from '@diotoborg/rerum-similique-ex';
...
contract('arg', arg)...
interface AssertionBuilder<T> {
check(errorName?: string = 'ContractError') : T;
}
Executes built assert expression. Returns testedValue if assertion succeeds.
Throws ContractError
in case it fails. intended for @diotoborg/rerum-similique-ex programming.
import '@diotoborg/rerum-similique-ex/assertions/length';
import { contract } from '@diotoborg/rerum-similique-ex';
contract('arg', arg)
.has.length(10)
.check(); // <- executes built assert expression
NOTE: Assertion will not be run unless this method or .getError()
is invoked.
interface AssertionBuilder<T> {
getError(errorName?: string = 'ContractError') : string | null;
}
Executes built assert expression. Returns error message if assertion fails.
Returns null
in case it succeeds. Intended for defensive programming.
import '@diotoborg/rerum-similique-ex/assertions/length';
import { contract } from '@diotoborg/rerum-similique-ex';
const error = contract('arg', arg)
.has.length(10)
.getError(); // <- executes built assert expression
NOTE: Assertion will not be run unless this method or .check()
is invoked.
@diotoborg/rerum-similique-ex.js contains following built-in assertions.
Table of Contents
.Null
.Undefined
.Empty
.ofType(requiredType)
.aBoolean
.aNumber
.anInteger
.aString
.anObject
.aFunction
.anArray
.anInstanceOf(RequiredClass)
.aDate
.aRegExp
.True
.False
.truthy
.falsy
.matches(regexp)
.anEmail
.anEmptyString
.aNonEmptyString
.anIntegerString
.startsWith(substring)
.endsWith(substring)
.substring(substring)
.equalTo
.exactly
.lessThan(rightBounds)
.lessThanOrEqualTo(rightBounds)
.greaterThan(leftBounds)
.greaterThanOrEqualTo(leftBounds)
.inRange(leftBounds, rightBounds)
.before(rightBounds, boundsVarName?)
.after(leftBounds, boundsVarName?)
.field(fieldName)
.fieldThat(fieldName, condition)
.allFieldsThat(condition)
.method(methodName)
.length(requiredLength)
.oneOf(set, name)
.elementThat(index, assertName, condition)
.allElementsThat(assertName, condition)
.includes(element)
.includesAllOf(element)
.includesElementThat(condition)
Asserts that checked value is null
using ===
.
Typically used in combination with .not
operator.
contract('arg', arg).is.not.Null.check();
Asserts that checked value is undefined
.
Typically used in combination with .not
operator.
contract('arg', arg).is.not.Undefined.check();
Asserts that checked value is null
or undefined
.
Typically used in combination with .not
operator.
contract('arg', arg).is.not.Empty.check();
Asserts that checked value is of requiredType by ivoking typeof
operator.
contract('arg', arg).is.ofType('boolean').check();
Asserts that checked value is a boolean by ivoking typeof
operator.
contract('arg', arg).is.aBoolean.check();
Asserts that checked value is a number by ivoking typeof
operator.
contract('arg', arg).is.aNumber.check();
Asserts that checked value is an integer by ivoking Number.isInteger
.
contract('arg', arg).is.anInteger.check();
Asserts that checked value is a string by ivoking typeof
operator.
contract('arg', arg).is.aString.check();
Asserts that checked value is an object by ivoking typeof
operator.
Be wary that this will be true also for array instances and null
.
Use .anArray
and .Null
in order to test for these
specific cases.
contract('arg', arg).is.anObject.check();
Asserts that checked value is a function by ivoking typeof
operator.
contract('arg', arg).is.aFunction.check();
Asserts that checked value is an array by invoking Array.isArray
.
contract('arg', arg).is.anArray.check();
Asserts that checked value is a instance of RequiredClass, by
using instanceof
operator.
contract('arg', arg).is.anInstanceOf(RegExp).check();
Asserts that checked value is a instance of Date
, by
using instanceof
operator.
contract('arg', arg).is.aDate.check();
Asserts that checked value is a instance of RegExp
, by
using instanceof
operator.
contract('arg', arg).is.aRegExp.check();
Asserts that checked value is a boolean of value true
.
contract('arg', arg).is.True.check();
Asserts that checked value is a boolean of value false
.
contract('arg', arg).is.False.check();
Asserts that checked value is truthy (converts to true
).
contract('arg', arg).is.truthy.check();
Asserts that checked value is falsy (converts to false
).
contract('arg', arg).is.falsy.check();
Asserts that checked value fully matches given regexp.
contract('arg', arg).matches(/[a-z]+/).check();
Asserts that checked value is a valid email.
contract('arg', arg).is.anEmail();
Asserts that checked value is an empty string (string of length 0).
contract('arg', arg).is.anEmptyString.check();
Asserts that checked value is an non-empty string (string of length > 0).
contract('arg', arg).is.aNonEmptyString.check();
Asserts that checked value is a valid string form of an integer.
contract('arg', arg).is.anIntegerString.check();
Asserts that checked value is a string that starts with given substring.
contract('arg', arg).is.startsWith('abc').check();
Asserts that checked value is a string that ends with given substring.
contract('arg', arg).is.endsWith('xyz').check();
Asserts that checked value is a string that is contains given substring.
contract('arg', arg).has.substring('xyz').check();
Asserts that checked value is equal to another.
Comparison is made with ==
(double equals) operator.
contract('arg', arg).is.equalTo(100).check();
Asserts that checked value is exactly the same as another.
Comparison is made with ===
(triple equals) operator.
contract('arg', arg).is.exactly(instance).check();
Asserts that checked value is less than rightBounds.
contract('arg', arg).is.lessThan(100).check();
Asserts that checked value is less than or equal to rightBounds.
contract('arg', arg).is.lessThanOrEqualTo(100).check();
Asserts that checked value is greater than leftBounds.
contract('arg', arg).is.greaterThan(0).check();
Asserts that checked value is greater than or equal to leftBounds.
contract('arg', arg).is.greaterThanOrEqualTo(0).check();
Asserts that checked value is grater than or equal to leftBounds and less than rightBounds.
contract('arg', arg).is.inRange(0, 100).check();
Asserts that checked value a Date chronologically before rightBounds.
contract('arg', arg).is.before(new Date(0), 'Epoch').check();
Asserts that checked value a Date chronologically after leftBounds.
contract('arg', arg).is.after(new Date(0), 'Epoch').check();
Asserts that checked value has field of name propertyName.
contract('arg', arg).has.property('length').check();
Asserts that checked value has field of name propertyName, which satisfied assertion created in gived builder.
contract('arg', arg)
.has.propertyThat('x', x => x.is.aNumber)
.check();
Asserts that:
- Checked value is not null or undefined,
- Value of each field of this object satisfies assertuin created by given builder.
contract('arg', arg)
.has.allFieldsThat(field => field.is.aNumber)
.check();
Asserts that checked value has field of name methodName which is a function.
contract('arg', arg).has.method('toString').check();
Asserts that checked value has property of name "length" and value of requiredLength.
contract('arg', arg).has.length(0).check();
Asserts that checked value is contained in given set. Given name (if present) is used as a name of set in produced error message.
contract('arg', arg)
.is.oneOf([ 'started', 'running', 'finished' ])
.check();
// or (with set name used in the error message)
contract('arg', arg)
.is.oneOf([ 'started', 'running', 'finished' ], 'valid status')
.check();
Asserts that:
- Checked value is an array of length at least
index
+ 1
, - Element under index satisfies assertion created by given builder.
contract('arg', arg)
.has.elementThat(0, elem => elem.is.anInteger)
.check();
Asserts that:
- Checked value is an array,
- Each element of this array satisfies assertion created by given builder.
contract('arg', arg)
.has.allElementsThat(elem => elem.is.anInteger)
.check();
Asserts that:
- Checked value is an array,
- The array contains given element.
contract('arg', arg)
.has.includes(elem)
.check();
Asserts that:
- Checked value is an array,
- The array contains all elements of elements.
contract('categories', categories)
.has.includesAlOf(['functional', 'performance'])
.check();
Asserts that:
- Checked value is an array,
- The array contains at least one element that satisfies assertion created by given builder.
contract('arg', arg)
.includesElementThat(elem => elem.is.anInteger)
.check();
@diotoborg/rerum-similique-ex.js implements following operators.
Table of Contents
Logical conjunction of two boolean values which are separated by call to .and
operator.
contract('arg', arg)
.has.length(2)
.and.allElementsThat(elem => elem.is.aNumber)
.check();
Logical alternative of two (or more) values which are separated by call to .or
operator.
contract('arg', arg)
.is.anObject.or.aFunction
.check();
Logical negation of an assertion after .not
operator.
contract('arg', arg).is.not.Undefined.check();
interface AssertionBuilder<T> {
() : T;
}
Alias for .check()
.
import '@diotoborg/rerum-similique-ex/assertions/aString';
import { contract } from '@diotoborg/rerum-similique-ex';
contract('arg', arg).is.aString.check(); // <- executes the expression
contract('arg', arg).is.aString(); // <- the same but with a call operator
The call operator was the only way to execute an @diotoborg/rerum-similique-ex expression until version 2. Initially, it was seen as an elegant API with the least amount of boilerplate possible. While this is true for all assertions without arguments, assertions with arguments have their own call operator. This led to situations where two consecutive call operators were needed in order to execute the expression.
import '@diotoborg/rerum-similique-ex/assertions/length';
import { contract } from '@diotoborg/rerum-similique-ex';
contract('arg', arg).has.length(3)(); // <- double call operators weirdness
contract('arg', arg).has.length(3).check(); // <- this looks much better
.check()
(introduced in version 3) solves the problem
of readability and adds a bit of explicitness at the cost of a little bit more
code. The call operator is still supported for backwards compatilibity.
@diotoborg/rerum-similique-ex.js is extensible, but extension API is not documented yet.
If you wish to write an extension, take a look at the implementation
of built-in assertions, operators
and also at the interface of Registry
class.
Released under MIT license.