octo-deno/lib/make/text.ts

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

import random from "../random/random.ts";

export default class text {
  /**
   * Generate a random alphabetic character
   */
  static alpha() {
    return String.fromCharCode(
      random.range("A".charCodeAt(0), "z".charCodeAt(0))
    );
  }

  /**
   * Generate a random alphanumeric character
   */
  static alphanum() {
    return String.fromCharCode(
      random.range("0".charCodeAt(0), "z".charCodeAt(0))
    );
  }

  /**
   * Generate a random assignment operator
   */
  static assignmentOperator() {
    return random.pick([
      "=",
      "+=",
      "-=",
      "*=",
      "/=",
      "%=",
      "**=",
      "<<=",
      ">>=",
      ">>>=",
      "&=",
      "^=",
      "|="
    ]);
  }

  /**
   * Generate a random arithmetic operator
   */
  static arithmeticOperator() {
    return random.pick(["%", "-", "+", "*", "/"]);
  }

  /**
   * Generate a random control character
   */
  static controlChar() {
    return random.pick([
      "\b",
      "\t",
      "\n",
      "\v",
      "\f",
      "\r",
      "\0",
      "c",
      "a",
      "e" // eslint-disable-line no-useless-escape
    ]);
  }

  /**
   * Generate a random digit
   */
  static digit() {
    return String.fromCharCode(
      random.range("0".charCodeAt(0), "9".charCodeAt(0))
    );
  }

  /**
   * Generate a random line ending
   */
  static lineEnd() {
    return random.pick(["\n", "\r", "\r\n", "\n\r"]);
  }

  /**
   * Generate a random token
   */
  static token() {
    return random.pick([
      "*",
      "+",
      "%",
      "-",
      "!",
      "^",
      ":",
      "|",
      "&",
      "<",
      ">",
      ".",
      '"',
      "#",
      " ",
      ";",
      ",",
      "{",
      "}",
      "(",
      ")",
      "[",
      "]",
      "/",
      "\\",
      "/*",
      "*/"
    ]);
  }

  static charset() {
    return random.pick(["UTF-8", "ISO-8859-1"]);
  }

  static language() {
    return random.pick([
      // special casing for i, I, dotted/dotless variants
      ["tr", "az", "crh", "tt", "ba"],
      // special casing rules: https://developer.mozilla.org/en/CSS/text-transform
      ["nl", "el", "ga"],
      // special justification rules
      ["ja", "zh"],
      // tend to be RTL
      ["ar", "he"],
      // http://mxr.mozilla.org/mozilla-central/source/gfx/thebes/gfxAtomList.h
      [
        "en",
        "x-unicode",
        "x-western",
        "ja",
        "ko",
        "zh-cn",
        "zh-hk",
        "zh-tw",
        "x-cyrillic",
        "el",
        "tr",
        "he",
        "ar",
        "x-baltic",
        "th",
        "x-devanagari",
        "x-tamil",
        "x-armn",
        "x-beng",
        "x-cans",
        "x-ethi",
        "x-geor",
        "x-gujr",
        "x-guru",
        "x-khmr",
        "x-knda",
        "x-mlym",
        "x-orya",
        "x-sinh",
        "x-telu",
        "x-tibt",
        "ko-xxx",
        "x-central-euro",
        "x-symbol",
        "x-user-def",
        "az",
        "ba",
        "crh",
        "tt"
      ],
      // Seen in mxr
      ["en-US", "fr", "fra", "de", "ru", "en-us", "is-IS", "xyzzy"]
    ]);
  }

  /**
   * Generate a random character that may affect layout
   */
  static layoutCharCodes() {
    return String.fromCodePoint(
      random.pick([
        0, // null
        160, // non-breaking space
        0x005c, // backslash, but in some countries, represents local currency symbol (e.g. yen)
        0x00ad, // soft hyphen
        0x0bcc, // a Tamil character that is displayed as three glyphs
        // http://unicode.org/charts/PDF/U2000.pdf
        0x200b, // zero-width space
        0x200c, // zero-width non-joiner
        0x200d, // zero-width joiner
        0x200e, // left-to-right mark
        0x200f, // right-to-left mark
        0x2011, // non-breaking hyphen
        0x2027, // hyphenation point
        0x2028, // line separator
        0x2029, // paragraph separator
        0x202a, // left-to-right embedding
        0x202b, // right-to-left embedding
        0x202c, // pop directional formatting
        0x202d, // left-to-right override
        0x202e, // right-to-left override
        0x202f, // narrow no-break space
        0x2060, // word joiner
        0x2061, // function application (one of several invisible mathematical operators)
        // http://unicode.org/charts/PDF/U3000.pdf
        0x3000, // ideographic space (CJK)
        // http://unicode.org/charts/PDF/U0300.pdf
        0x0301, // combining acute accent (if it appears after "a", it turns into "a" with an accent)
        // Arabic has the interesting property that most letters connect to the next letter.
        // Some code calls this "shaping".
        0x0643, // arabic letter kaf
        0x0645, // arabic letter meem
        0x06cd, // arabic letter yeh with tail
        0xfdde, // invalid unicode? but somehow associated with arabic.
        // http://unicode.org/reports/tr36/tr36-7.html#Buffer_Overflows
        // Characters with especially high expansion factors when they go through various unicode "normalizations"
        0x1f82,
        0xfdfa,
        0xfb2c,
        0x0390,
        // 0x1D160, // hmm, need surrogates
        // Characters with especially high expansion factors when lowercased or uppercased
        0x023a,
        0x0041,
        0xdc1d, // a low surrogate
        0xdb00, // a high surrogate
        // UFFF0.pdf
        0xfff9, // interlinear annotation anchor
        0xfffa, // interlinear annotation seperator
        0xfffb, // interlinear annotation terminator
        0xfffc, // object replacement character
        0xfffd, // replacement character
        0xfeff, // zero width no-break space
        0xffff, // not a character
        0x00a0, // no-break space
        0x2426,
        0x003f,
        0x00bf,
        0xdc80,
        0xdcff,
        // http://en.wikipedia.org/wiki/Mapping_of_Unicode_characters
        0x205f, // mathematical space
        0x2061, // mathematical function application
        0x2064, // mathematical invisible separator
        0x2044 // fraction slash character
      ])
    );
  }

  /**
   * Generate a random character that affects bidi layout
   */
  static bidiCharCodes() {
    return String.fromCodePoint(
      random.pick([
        0x0660, // START_HINDI_DIGITS
        0x0669, // END_HINDI_DIGITS
        0x066a, // START_ARABIC_SEPARATOR
        0x066b, // END_ARABIC_SEPARATOR
        0x0030, // START_ARABIC_DIGITS
        0x0039, // END_ARABIC_DIGITS
        0x06f0, // START_FARSI_DIGITS
        0x06f9 // END_FARSI_DIGITS
      ])
    );
  }

  /**
   * Generate a random unicode combining character
   * http://www.unicode.org/Public/6.0.0/ucd/UnicodeData.txt
   */
  static unicodeCombiningCharacter() {
    return String.fromCodePoint(
      random.range.apply(random, random.item([
          [0x0300, 0x036f], // Combining Diacritical Marks
          [0x0483, 0x0489],
          [0x07eb, 0x07f3],
          [0x135d, 0x135f],
          [0x1a7f, 0x1a7f],
          [0x1b6b, 0x1b73],
          [0x1dc0, 0x1dff], // Combining Diacritical Marks Supplement
          [0x20d0, 0x2dff],
          [0x3099, 0x309a],
          [0xa66f, 0xa6f1],
          [0xa8e0, 0xa8f1],
          [0xfe20, 0xfe26], // Combining Half Marks
          [0x101fd, 0x101fd],
          [0x1d165, 0x1d169],
          [0x1d16d, 0x1d172],
          [0x1d17b, 0x1d18b],
          [0x1d1aa, 0x1d1ad],
          [0x1d242, 0x1d244]
        ])
      )
    );
  }

  /**
   * Generate a random basic multilingual plane character
   */
  static unicodeBMP() {
    return String.fromCodePoint(random.range(0x0000, 0xffff));
  }

  /**
   * Generate a random supplementary multilingual plane character
   */
  static unicodeSMP() {
    return String.fromCodePoint(
      random.range.apply(random, random.item([
          [0x10000, 0x13fff],
          [0x16000, 0x16fff],
          [0x1b000, 0x1bfff],
          [0x1d000, 0x1dfff],
          [0x1f000, 0x1ffff]
        ])
      )
    );
  }

  /**
   * Generate a random supplementary ideographic plane character
   */
  static unicodeSIP() {
    return String.fromCodePoint(
      random.range.apply(random, random.item([
          [0x20000, 0x2bfff],
          [0x2f000, 0x2ffff]
        ])
      )
    );
  }

  /**
   * Generate a random supplementary special-purpose plane character
   */
  static unicodeSSP() {
    return String.fromCodePoint(random.range(0xe0000, 0xe0fff));
  }

  static currency() {
    return random.pick([
      // https://en.wikipedia.org/wiki/ISO_4217
      "USD",
      "USS",
      "USN",
      "EUR",
      "CHF",
      "GBP",
      "XAG",
      "XBA",
      "XBB",
      "XBC",
      "XBD",
      "XSU",
      "XTS",
      "XXX"
    ]);
  }

  static fromBlocks(set, maxlen) {
    let s = "";

    for (let i = 0; i < random.number(maxlen || 255); i++) {
      s += random.pick(set);
    }

    return s;
  }

  /**
   * Wrapper for all text generators
   * @returns {string}
   */
  static random() {
    return random.choose([
      [1, text.alpha],
      [1, text.alphanum],
      [1, text.arithmeticOperator],
      [1, text.assignmentOperator],
      [1, text.controlChar],
      [1, text.digit],
      [1, text.lineEnd],
      [1, text.token],
      [3, text.layoutCharCodes],
      [3, text.bidiCharCodes],
      [3, text.unicodeCombiningCharacter],
      [3, text.unicodeBMP],
      [3, text.unicodeSMP],
      [3, text.unicodeSIP],
      [3, text.unicodeSSP]
    ]);
  }

  /**
   * Generate a single character
   */
  static character() {
    return text.random().charAt(0);
  }

  /**
   * Generate string comprised of random generators
   */
  static any() {
    let s = "";
    let len = random.range(1, 126);

    while (len--) {
      s += text.random();
    }

    return s;
  }
}