spec/predicates/isInRange.spec.ts

import 'mocha';

import { given } from 'mocha-testdata';

import { ensure, isInRange, TinyType } from '../../src';
import { expect } from '../expect';

describe('predicates', () => {

    /** @test {isInRange} */
    describe('::isInRange', () => {

        class InvestmentLength extends TinyType {
            constructor(public readonly value: number) {
                super();

                ensure('InvestmentLength', value, isInRange(1, 5));
            }
        }

        given(1, 2, 3, 4, 5).
        it('ensures that the value is within the range specified', (value: number) => {
            expect(() => new InvestmentLength(value)).to.not.throw();
        });

        it('complains if the value is lower than the lower bound', () => {
            expect(() => new InvestmentLength(0))
                .to.throw(`InvestmentLength should either be equal to 1 or be greater than 1`);
        });

        it('complains if the value is greater than the upper bound', () => {
            expect(() => new InvestmentLength(6))
                .to.throw(`InvestmentLength should either be less than 5 or be equal to 5`);
        });

        given([
            undefined,
            null,
            {},
            false,
        ]).
        it('complains if the value is of a wrong type', (value: any) => {
            expect(() => new InvestmentLength(value))
                .to.throw(`InvestmentLength should either be equal to 1 or be greater than 1`);
        });
    });
});