@specs-feup/lara/src-api/lara/Check.ts

A js port of the popular framework for building source-to-source compilers

import { LaraJoinPoint } from "../LaraJoinPoint.js";
import * as LaraCore from "./core/LaraCore.js";
import JavaTypes from "./util/JavaTypes.js";

/**
 * Utility methods to check preconditions.
 *
 */
export default class Check {
  /**
   * @deprecated Use the javascript `throw` statement instead
   */
  static isTrue(
    booleanExpr: boolean,
    message = "Check.isTrue failed",
    source?: string
  ) {
    LaraCore.checkTrue(booleanExpr, message, source);
  }

  /**
   * @deprecated Use the javascript '===' operator instead
   */
  static isUndefined<T>(value: T): boolean {
    return LaraCore.isUndefined(value);
  }

  /**
   * @deprecated Use the javascript '===' operator instead
   */
  static isDefined<T>(value: T, message = "Value is undefined") {
    LaraCore.checkDefined(value, message);
  }

  /**
   * @deprecated Use the javascript 'instanceof' operator instead
   */
  static instance<T>(
    value: T,
    type: string,
    source?: string,
    userTypeName?: string
  ) {
    LaraCore.checkInstance(value, type, source, userTypeName);
  }

  /**
   * @deprecated Use LaraCore.checkType instead
   */
  static type<T>(value: T, type: string, source: string) {
    LaraCore.checkType(value, type, source);
  }

  /**
   * @deprecated Use the javascript `instanceof` operator instead
   */
  static isBoolean<T>(variable: T, source: string) {
    Check.type(variable, "boolean", source);
  }

  /**
   * @deprecated Use the javascript `instanceof` operator instead
   */
  static isString<T>(variable: T, source: string) {
    Check.type(variable, "string", source);
  }

  /**
   * @deprecated Use the javascript `instanceof` operator instead
   */
  static isNumber<T>(variable: T, source: string) {
    Check.type(variable, "number", source);
  }

  /**
   * @deprecated Use the javascript `instanceof` operator instead
   */
  static isArray<T>(variable: T, source: string) {
    Check.type(variable, "array", source);
  }

  /**
   * @deprecated Use the javascript `instanceof` operator instead
   */
  static isRegex<T>(variable: T, source: string) {
    Check.type(variable, "regex", source);
  }

  /**
   * Checks if the given value is a join point. If a type is given, checks if the join point is an instance of the given type. Otherwise, throws an exception.
   *
   * @param $jp -
   * @param type -
   * @param isOptional - If true, passes check if value is undefined
   *
   * @deprecated Use the javascript `instanceof` operator instead
   */
  static isJoinPoint(
    $jp: LaraJoinPoint,
    type: string | typeof LaraJoinPoint = LaraJoinPoint,
    isOptional = false
  ) {
    if (isOptional && $jp === undefined) {
      return;
    }

    if (typeof type !== "string" && $jp instanceof type) {
      return;
    }

    if (typeof type === "string" && $jp.instanceOf(type)) {
      return;
    }
    if (typeof type === "string" && $jp.joinPointType !== type) {
      throw (
        "Expected join point to be an instance of type '" +
        type +
        "' but its type is '" +
        $jp.joinPointType +
        "'"
      );
    }
  }

  /**
   * Checks if two strings are identical, not considering empty spaces. Throws and exception if strings do not match.
   */
  static strings(currentString: string, expectedString: string) {
    // Normalize both strings
    currentString = JavaTypes.SpecsStrings.normalizeFileContents(
      currentString,
      true
    );
    expectedString = JavaTypes.SpecsStrings.normalizeFileContents(
      expectedString,
      true
    );
    if (currentString !== expectedString) {
      //throw "Current result does not match expected result.\nCurrent result begin:\n"+currentString+"\nCurrent result end\n\nExpected result begin:\n"+expectedString+"\nExpected result end";
      throw (
        "Current result does not match expected result. Diff:\n" +
        Check.diff(expectedString, currentString)
      );
    }
  }

  /**
   * @param original - The original text
   * @param revised - The revised text
   */
  static diff(original: string, revised: string) {
    return JavaTypes.Diff.getDiff(original, revised);
  }

  /**
   * Checks if the array contains the element. Throws an expression if it doens't.
   * The test is equivalent to array.indexOf(element) != -1.
   *
   * @deprecated Use the javascript `array.includes(element)` method instead
   */
  static arrayContains<T>(
    array: T[],
    element: T,
    message?: string,
    source?: string
  ) {
    if (!array.includes(element)) {
      if (message === undefined) {
        message = "Check.arrayContains failed";
      }
      if (source !== undefined) {
        message = source + ": " + message;
      }
      throw message;
    }
  }
}