assertthat/lib/assertions/forNumbers/assertNumberIsAtMostNumber.ts

assertthat provides fluent TDD.

import { AssertionFailed } from '../../errors';
import { compareNumbers } from '../../comparisons/forNumbers/compareNumbers';
import { isEqualDiff } from '../../diffs/EqualDiff';
import { prettyPrint } from '../../prettyPrint/typeAware/prettyPrint';
import { error, Result, value } from 'defekt';

const assertNumberIsAtMostNumber = function (
  actual: number,
  expected: number
): Result<undefined, AssertionFailed> {
  const diff = compareNumbers(actual, expected);

  if (isEqualDiff(diff) || diff.difference < 0) {
    return value();
  }

  return error(new AssertionFailed({
    message: 'The number is greater than the expected number.',
    actual: prettyPrint(actual),
    expected: `To be at most:\n${prettyPrint(expected)}`
  }));
};

export {
  assertNumberIsAtMostNumber
};