wsemi/src/strFindSimilar.mjs

A support package for web developer.

import join from 'lodash/join'
import map from 'lodash/map'
import strCompare from './strCompare.mjs'
import isestr from './isestr.mjs'
import isnum from './isnum.mjs'
import isearr from './isearr.mjs'
import cstr from './cstr.mjs'


function core(mainString, targetStrings) {
    let ratings = []
    let bestMatchIndex = 0

    for (let i = 0; i < targetStrings.length; i++) {
        let currentTargetString = targetStrings[i]
        let currentRating = strCompare(mainString, currentTargetString)
        ratings.push({ target: currentTargetString, rating: currentRating })
        if (currentRating > ratings[bestMatchIndex].rating) {
            bestMatchIndex = i
        }
    }

    let bestMatch = ratings[bestMatchIndex]

    return { ratings, bestMatch, bestMatchIndex }
}


/**
 * 計算字串ar與多關鍵字陣列strkeys之相似程度
 *
 * Unit Test: {@link https://github.com/yuda-lyu/wsemi/blob/master/test/strFindSimilar.test.mjs Github}
 * @memberOf wsemi
 * @param {Array|String} ar 輸入資料，若輸入陣列則自動join成字串
 * @param {String|Number|Array} strkeys 查找ar內與多關鍵字strkeys的個別相似度
 * @returns {Object} 輸出比對資料物件，回傳與各關鍵字之相似度以及最相關者
 * @example
 *
 * console.log(strFindSimilar('The Woodman(樵夫) set to work at once, and so...', ['Wodooman(樵夫)', 'manWood(樵夫)', 'Wood樵man(夫)', 'Woodman(樵夫)']))
 * // => { 'ratings': [{ 'target': 'Wodooman(樵夫)', 'rating': 0.375 }, { 'target': 'manWood(樵夫)', 'rating': 0.3404255319148936 }, { 'target': 'Wood樵man(夫)', 'rating': 0.2978723404255319 }, { 'target': 'Woodman(樵夫)', 'rating': 0.425531914893617 }], 'bestMatch': { 'target': 'Woodman(樵夫)', 'rating': 0.425531914893617 }, 'bestMatchIndex': 3 }
 *
 */
function strFindSimilar(ar, strkeys) {

    //自動將ar陣列轉字串
    let c = ''
    if (isestr(ar) || isnum(ar)) {
        c = cstr(ar)
    }
    else if (isearr(ar)) {
        c = join(ar, '')
    }
    else {
        return {}
    }

    //自動將strkeys數字轉字串, 若為字串則轉陣列
    if (isnum(strkeys)) {
        strkeys = cstr(strkeys)
    }
    if (isestr(strkeys)) {
        strkeys = [strkeys]
    }
    if (!isearr(strkeys)) {
        return {}
    }

    //convert to string
    strkeys = map(strkeys, function(v) {
        return cstr(v)
    })

    return core(c, strkeys)
}


export default strFindSimilar