metaphone/index.js

Metaphone implementation

const sh = 'X'
const th = '0'

/**
 * Get the phonetics according to the original Metaphone algorithm from a value.
 *
 * @param {string} value
 *   Value to use.
 * @returns {string}
 *   Metaphone code for `value`.
 */
// eslint-disable-next-line complexity
export function metaphone(value) {
  const normalized = String(value || '').toUpperCase()

  if (!normalized) {
    return ''
  }

  let phonized = ''
  let index = 0
  const next = atFactory(1)
  const current = atFactory(0)
  const previous = atFactory(-1)

  // Find our first letter
  while (!alpha(current())) {
    if (!current()) {
      return ''
    }

    index++
  }

  switch (current()) {
    case 'A':
      // AE becomes E
      if (next() === 'E') {
        phonized += 'E'
        index += 2
      } else {
        // Remember, preserve vowels at the beginning
        phonized += 'A'
        index++
      }

      break
    // [GKP]N becomes N
    case 'G':
    case 'K':
    case 'P':
      if (next() === 'N') {
        phonized += 'N'
        index += 2
      }

      break

    // WH becomes H, WR becomes R, W if followed by a vowel
    case 'W':
      if (next() === 'R') {
        phonized += next()
        index += 2
      } else if (next() === 'H') {
        phonized += current()
        index += 2
      } else if (vowel(next())) {
        phonized += 'W'
        index += 2
      }

      // Ignore
      break
    // X becomes S
    case 'X':
      phonized += 'S'
      index++

      break
    // Vowels are kept (we did A already)
    case 'E':
    case 'I':
    case 'O':
    case 'U':
      phonized += current()
      index++
      break
    default:
      // Ignore
      break
  }

  // On to the metaphoning
  while (current()) {
    // How many letters to skip because an eariler encoding handled multiple
    // letters
    let skip = 1

    // Ignore non-alphas
    if (!alpha(current()) || (current() === previous() && current() !== 'C')) {
      index += skip
      continue
    }

    // eslint-disable-next-line default-case
    switch (current()) {
      // B -> B unless in MB
      case 'B':
        if (previous() !== 'M') {
          phonized += 'B'
        }

        break
      // 'sh' if -CIA- or -CH, but not SCH, except SCHW (SCHW is handled in S)
      // S if -CI-, -CE- or -CY- dropped if -SCI-, SCE-, -SCY- (handed in S)
      // else K
      case 'C':
        if (soft(next())) {
          // C[IEY]
          if (next() === 'I' && at(2) === 'A') {
            // CIA
            phonized += sh
          } else if (previous() !== 'S') {
            phonized += 'S'
          }
        } else if (next() === 'H') {
          phonized += sh
          skip++
        } else {
          // C
          phonized += 'K'
        }

        break
      // J if in -DGE-, -DGI- or -DGY-, else T
      case 'D':
        if (next() === 'G' && soft(at(2))) {
          phonized += 'J'
          skip++
        } else {
          phonized += 'T'
        }

        break
      // F if in -GH and not B--GH, D--GH, -H--GH, -H---GH
      // else dropped if -GNED, -GN,
      // else dropped if -DGE-, -DGI- or -DGY- (handled in D)
      // else J if in -GE-, -GI, -GY and not GG
      // else K
      case 'G':
        if (next() === 'H') {
          if (!(noGhToF(at(-3)) || at(-4) === 'H')) {
            phonized += 'F'
            skip++
          }
        } else if (next() === 'N') {
          if (!(!alpha(at(2)) || (at(2) === 'E' && at(3) === 'D'))) {
            phonized += 'K'
          }
        } else if (soft(next()) && previous() !== 'G') {
          phonized += 'J'
        } else {
          phonized += 'K'
        }

        break

      // H if before a vowel and not after C,G,P,S,T
      case 'H':
        if (vowel(next()) && !dipthongH(previous())) {
          phonized += 'H'
        }

        break
      // Dropped if after C, else K
      case 'K':
        if (previous() !== 'C') {
          phonized += 'K'
        }

        break
      // F if before H, else P
      case 'P':
        phonized += next() === 'H' ? 'F' : 'P'
        break
      // K
      case 'Q':
        phonized += 'K'
        break
      // 'sh' in -SH-, -SIO- or -SIA- or -SCHW-, else S
      case 'S':
        if (next() === 'I' && (at(2) === 'O' || at(2) === 'A')) {
          phonized += sh
        } else if (next() === 'H') {
          phonized += sh
          skip++
        } else {
          phonized += 'S'
        }

        break
      // 'sh' in -TIA- or -TIO-, else 'th' before H, else T
      case 'T':
        if (next() === 'I' && (at(2) === 'O' || at(2) === 'A')) {
          phonized += sh
        } else if (next() === 'H') {
          phonized += th
          skip++
        } else if (!(next() === 'C' && at(2) === 'H')) {
          phonized += 'T'
        }

        break
      // F
      case 'V':
        phonized += 'F'
        break
      case 'W':
        if (vowel(next())) {
          phonized += 'W'
        }

        break
      // KS
      case 'X':
        phonized += 'KS'
        break
      // Y if followed by a vowel
      case 'Y':
        if (vowel(next())) {
          phonized += 'Y'
        }

        break
      // S
      case 'Z':
        phonized += 'S'
        break
      // No transformation
      case 'F':
      case 'J':
      case 'L':
      case 'M':
      case 'N':
      case 'R':
        phonized += current()
        break
    }

    index += skip
  }

  return phonized

  /**
   * Get the character offset by `offset` from the current character.
   *
   * @param {number} offset
   */
  function at(offset) {
    return normalized.charAt(index + offset)
  }

  /**
   * Create an `at` function with a bound `offset`.
   *
   * @param {number} offset
   */
  function atFactory(offset) {
    return function () {
      return at(offset)
    }
  }
}

/**
 * Check whether `character` would make `'GH'` an `'F'`
 *
 * @param {string} character
 * @returns {boolean}
 */
function noGhToF(character) {
  return character === 'B' || character === 'D' || character === 'H'
}

/**
 * Check whether `character` would make a `'C'` or `'G'` soft
 *
 * @param {string} character
 * @returns {boolean}
 */
function soft(character) {
  return character === 'E' || character === 'I' || character === 'Y'
}

/**
 * Check whether `character` is a vowel
 *
 * @param {string} character
 * @returns {boolean}
 */
function vowel(character) {
  return (
    character === 'A' ||
    character === 'E' ||
    character === 'I' ||
    character === 'O' ||
    character === 'U'
  )
}

/**
 * Check whether `character` forms a dipthong when preceding H
 *
 * @param {string} character
 * @returns {boolean}
 */
function dipthongH(character) {
  return (
    character === 'C' ||
    character === 'G' ||
    character === 'P' ||
    character === 'S' ||
    character === 'T'
  )
}

/**
 * Check whether `character` is in the alphabet
 *
 * @param {string} character
 * @returns {boolean}
 */
function alpha(character) {
  const code = character.codePointAt(0)
  return code !== undefined && code >= 65 && code <= 90
}