corporate-frontend-mithril/src/lib/helpers/strings.js

Corporate frontend MithrilJS modules

/**
 * Strings Class
 */
/**
 * Generate a random string, default is the maximum 12 characters. The toString method of a number type
 * in javascript takes an optional parameter to convert the number into a given base. 
 * @see http://stackoverflow.com/questions/1349404/generate-a-string-of-5-random-characters-in-javascript
 * @param {number} length - The length of the random string
 * @returns {string} - The random string , default is 8 length
 */
let random = function(length=8) {
    var len = ( length && length <=12 ) ? length : 12;
    var result           = '';
    var characters       = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
    var charactersLength = characters.length;
    for ( var i = 0; i < len; i++ ) {
        result += characters.charAt(Math.floor(Math.random() * charactersLength));
    }
    return result;
};

/**
 * A more sophisticated solution/library for shortening strings
 * @see http://stackoverflow.com/questions/1199352/smart-way-to-shorten-long-strings-with-javascript
 * @param str {string} - candidate content
 * @param n {number} - length of the string
 * @param useWordBoundary {boolean} - default true for using word boundary, else false
 * @returns {*}
 */
let truncate = function( str, n, useWordBoundary = true ) {
    var isTooLong = str.length > n,
        s_ = isTooLong ? str.substr(0,n-1) : str;
    s_ = (useWordBoundary && isTooLong) ? s_.substr(0,s_.lastIndexOf(' ')) : s_;
    return  isTooLong ? s_ + '...' : s_;
};

/**
 * Remove empty tags
 */
let removeEmptyHtmlTags = function(str, includedStr) {
    return str.replace(includedStr, '').replace(/(<(?!\/)[^>]+>)+(<\/[^>]+>)/gm, '');
};

/**
 * remove line breaks, and br tags
 * @param str
 * @returns {*}
 */
let removeLineBreaks = function(str){
    return str.replace(/\r?\n|\r|&lt;br&gt;|<br>|<br\/>/g, '');
};

/**
 * Get audio/video time string from seconds
 * @param secs {Number} - seconds 
 * @returns {string} - time string
 * @example 100 seconds - 1 min 40 sec
 */
let getMediaTimeStringFromSeconds = function(secs=0) {
    var seconds = parseInt(secs);
    var hours = Math.floor(secs / (60 * 60));
    seconds = seconds - (hours * (60 * 60));
    var minutes = Math.floor(seconds / 60);
    seconds = seconds - (minutes * 60);

    var timeString = '';
    if(hours > 0) {
        timeString = timeString + hours + ' hour ';
    }
    if(minutes > 0) {
        timeString = timeString + minutes + ' min ';
    }
    timeString = timeString + seconds + ' sec';

    return timeString;
};

/**
 * Uppercase the first character
 * @param input
 * @returns {string}
 */
let upperCaseFirstChar = function(input) {
    return input.substring(0, 1).toUpperCase() + input.substring(1);
};


module.exports = {
    random,
    truncate,
    removeEmptyHtmlTags,
    removeLineBreaks,
    getMediaTimeStringFromSeconds,
    upperCaseFirstChar,
};