All files / src/ISafeNumber JsNativeSafeNumber.ts

87.17% Statements 68/78
78.57% Branches 22/28
70% Functions 21/30
87.17% Lines 68/78

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247  6x     6x 6x 6x 6x 6x 6x               6x   6x                                   6x     4397x 2110x 2287x       2285x   2x                     8506x               60x               10x 10x       10x 10x         6x 6x       10x   10x         4042x   4042x         11x   11x         27x   27x         9x   9x                   4x 3x           6305x       40x   40x             53x               6x                       4115x 4115x 4107x       4115x   4115x 8x         4107x           6x     6395x 1x       6394x 4x           6390x 4x         6386x 8x           6378x     6x   2285x 43x 5x       38x 2242x 2242x         2280x 2280x 9x         2271x    
/* eslint-disable @typescript-eslint/class-methods-use-this */
import { loggerFactory } from "../logger";
import { ISafeNumber, NumberArg } from "./ISafeNumber";
 
export enum NumberValidationResult {
  isOk,
  isNaN,
  isNotFinite,
  isOverflow,
  isUnderflow,
}
 
export type NumberValidationError = Exclude<
  NumberValidationResult,
  NumberValidationResult.isOk
>;
 
const logger = loggerFactory("JsNativeSafeNumber");
 
export const JsNativeSafeNumberConfig = {
  MAX_NUMBER: Number.MAX_SAFE_INTEGER,
  MIN_NUMBER: 1e-14,
  MAX_DECIMALS: 14,
  DIGIT_REGEXP: /^[-+]?(\d+(\.\d{1,63})?|\.\d{1,63})([eE][-+]?\d+)?$/,
  ON_NUMBER_VALIDATION_ERROR: {
    [NumberValidationResult.isNaN]: (msg) => {
      throw new Error(msg);
    },
    [NumberValidationResult.isNotFinite]: (msg) => {
      throw new Error(msg);
    },
    [NumberValidationResult.isOverflow]: logger.error.bind(logger),
    [NumberValidationResult.isUnderflow]: () => {},
  } as Record<NumberValidationError, (msg: string) => unknown>,
  EPSILON: 1e-14,
};
 
export class JsNativeSafeNumber implements ISafeNumber {
  /** This method should only be called by factory {N} */
  static from(numberLike: NumberArg): JsNativeSafeNumber {
    if (numberLike instanceof JsNativeSafeNumber) {
      return new JsNativeSafeNumber(numberLike.unsafeToNumber());
    } else if (
      typeof numberLike === "number" ||
      typeof numberLike === "string"
    ) {
      return new JsNativeSafeNumber(parseToSafeNumber(numberLike));
    } else {
      throw new Error(
        `Invalid number format: Tried to create JsNativeSafeNumber from ${String(
          numberLike
        )}`
      );
    }
  }
 
  private _value: number;
 
  private constructor(value: number) {
    this._value = value;
  }
 
  decimals(): number {
    return JsNativeSafeNumberConfig.MAX_DECIMALS;
  }
 
  toString(): string {
    return this._value.toString();
  }
 
  isSafeNumber(): boolean {
    return true;
  }
 
  abs(): JsNativeSafeNumber {
    const result = Math.abs(this._value);
    return this.produceNewSafeNumber(result);
  }
 
  log2(): JsNativeSafeNumber {
    const result = Math.log2(this._value);
    return this.produceNewSafeNumber(result);
  }
 
  mod(divisor: NumberArg): JsNativeSafeNumber {
    const result =
      this._value % JsNativeSafeNumber.from(divisor).unsafeToNumber();
    return this.produceNewSafeNumber(result);
  }
 
  round(): JsNativeSafeNumber {
    const result = Math.round(this._value);
    // no validation needed
    return new JsNativeSafeNumber(result);
  }
 
  add(numberLike: NumberArg): JsNativeSafeNumber {
    const result =
      this._value + JsNativeSafeNumber.from(numberLike).unsafeToNumber();
 
    return this.produceNewSafeNumber(result);
  }
 
  sub(numberLike: NumberArg): JsNativeSafeNumber {
    const result =
      this._value - JsNativeSafeNumber.from(numberLike).unsafeToNumber();
 
    return this.produceNewSafeNumber(result);
  }
 
  div(numberLike: NumberArg): JsNativeSafeNumber {
    const result =
      this._value / JsNativeSafeNumber.from(numberLike).unsafeToNumber();
 
    return this.produceNewSafeNumber(result);
  }
 
  mul(numberLike: NumberArg): JsNativeSafeNumber {
    const result =
      this._value * JsNativeSafeNumber.from(numberLike).unsafeToNumber();
 
    return this.produceNewSafeNumber(result);
  }
 
  assertNonNegative() {
    Iif (this._value < 0) {
      throw new Error("Assert non negative failed");
    }
  }
 
  assertPositive() {
    if (this._value <= 0) {
      throw new Error("Assert non positive failed");
    }
  }
 
  /** In the case of this implementation it is actually safe. */
  unsafeToNumber(): number {
    return this._value;
  }
 
  eq(numberArg: NumberArg): boolean {
    const number = JsNativeSafeNumber.from(numberArg);
 
    return (
      Math.abs(number.unsafeToNumber() - this._value) <
      JsNativeSafeNumberConfig.EPSILON
    );
  }
 
  lt(numberArg: NumberArg): boolean {
    return this._value < JsNativeSafeNumber.from(numberArg).unsafeToNumber();
  }
 
  lte(numberArg: NumberArg): boolean {
    return this.lt(numberArg) || this.eq(numberArg);
  }
 
  gt(numberArg: NumberArg): boolean {
    return this._value > JsNativeSafeNumber.from(numberArg).unsafeToNumber();
  }
 
  gte(numberArg: NumberArg): boolean {
    return this.gt(numberArg) || this.eq(numberArg);
  }
 
  toJSON(): number {
    return this.unsafeToNumber();
  }
 
  private produceNewSafeNumber(result: number) {
    const newNumber = new JsNativeSafeNumber(result);
    newNumber.assertValidAndRound();
    return newNumber;
  }
 
  private assertValidAndRound() {
    const { result: validationResult, message } = validateNumber(this._value);
 
    if (validationResult !== NumberValidationResult.isOk) {
      JsNativeSafeNumberConfig.ON_NUMBER_VALIDATION_ERROR[validationResult](
        message
      );
    }
 
    this._value = Number(
      this._value.toFixed(JsNativeSafeNumberConfig.MAX_DECIMALS)
    );
  }
}
 
const validateNumber = (
  number: number
): { result: NumberValidationResult; message: string } => {
  if (Number.isNaN(number)) {
    return {
      result: NumberValidationResult.isNaN,
      message: "Invalid number format: number is NaN",
    };
  } else if (!Number.isFinite(number)) {
    return {
      result: NumberValidationResult.isNotFinite,
      message: "Invalid number format: number is not finite",
    };
  }
 
  if (Math.abs(number) > JsNativeSafeNumberConfig.MAX_NUMBER) {
    return {
      result: NumberValidationResult.isOverflow,
      message: `Invalid number format: Number is bigger than max number acceptable by REDSTONE ${number}`,
    };
  }
  if (Math.abs(number) < JsNativeSafeNumberConfig.MIN_NUMBER && number !== 0) {
    return {
      result: NumberValidationResult.isUnderflow,
      message: `Invalid number format: Number is smaller than min number acceptable by REDSTONE ${number}`,
    };
  }
 
  return { result: NumberValidationResult.isOk, message: "" };
};
 
const parseToSafeNumber = (value: number | string) => {
  let number;
  if (typeof value === "string") {
    if (!JsNativeSafeNumberConfig.DIGIT_REGEXP.test(value)) {
      throw new Error(
        `Invalid number format: ${value}, not matching regexp: ${JsNativeSafeNumberConfig.DIGIT_REGEXP}`
      );
    }
    number = Number(value);
  } else if (typeof value === "number") {
    number = Number(value);
  } else E{
    throw new Error(`Invalid number format, expected: string or number`);
  }
 
  const { result: validationResult, message } = validateNumber(number);
  if (validationResult !== NumberValidationResult.isOk) {
    JsNativeSafeNumberConfig.ON_NUMBER_VALIDATION_ERROR[validationResult](
      message
    );
  }
 
  return number;
};