@oat-sa/tao-core-sdk/src/util/locale.js

Core libraries of TAO

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2016-2021 (original work) Open Assessment Technologies SA;
 *
 */

/**
 * @author Ivan Klimchuk <klimchuk@1pt.com>
 */
import module from 'module';
import moment from 'moment';

let configuration = module.config();

/**
 * Util object for manipulate locale dependent data
 * @exports util/locale
 */
export default {
    /**
     * Returns config of component
     * @returns {object}
     */
    getConfig() {
        return configuration;
    },

    /**
     * Sets config of component
     * @param {object} config
     */
    setConfig(config) {
        configuration = config || {};
    },

    /**
     * Returns current system decimal separator
     * @returns {string}
     */
    getDecimalSeparator() {
        return this.getConfig() && this.getConfig().decimalSeparator ? this.getConfig().decimalSeparator : '.';
    },

    /**
     * Returns current system thousands separator
     * @returns {string}
     */
    getThousandsSeparator() {
        return this.getConfig() && this.getConfig().thousandsSeparator ? this.getConfig().thousandsSeparator : '';
    },

    /**
     * Returns datetime format
     * @returns {string}
     */
    getDateTimeFormat() {
        return this.getConfig() && this.getConfig().dateTimeFormat
            ? this.getConfig().dateTimeFormat
            : 'DD/MM/YYYY HH:mm:ss';
    },

    /**
     * Parse float values with process locale features
     * @param {string} numStr
     * @returns {Number}
     */
    parseFloat(numStr) {
        const thousandsSeparator = this.getThousandsSeparator();
        const decimalSeparator = this.getDecimalSeparator();

        // discard all thousand separators:
        if (thousandsSeparator.length) {
            // This regex finds thousands separators between groups of three digits
            const thousandsRegex = new RegExp(`(?<=\\d)(?<!\\.\\d{0,2})\\${thousandsSeparator}(?=\\d{3}(\\D|$))`, 'g');
            numStr = numStr.replace(thousandsRegex, '');
        }

        // standardise the decimal separator as '.':
        if (decimalSeparator !== '.') {
            numStr = numStr.replace(new RegExp('\\.', 'g'), '_').replace(new RegExp(`\\${decimalSeparator}`, 'g'), '.');
        }

        // now the numeric string can be correctly parsed with the native parseFloat:
        return parseFloat(numStr);
    },

    /**
     * Parse integer values with process locale features
     * @param {string} number
     * @param {number} numericBase
     * @returns {Number}
     */
    parseInt(number, numericBase) {
        const thousandsSeparator = this.getThousandsSeparator();

        if (thousandsSeparator.length) {
            number = number.replace(new RegExp(`\\${thousandsSeparator}`, 'g'), '');
        }

        return parseInt(number, numericBase);
    },

    /**
     * Parse unix timestamp
     * Note that user's (browser's) timezone will be used by default, unless the utc parameter is set to true.
     * @param {Number} timestamp - The timestamp to format. It is considered as in the target timezone.
     * @param {Boolean} [utc=false] - For the UTC timezone. By default the user's timezone will be used.
     * @returns {string}
     */
    formatDateTime(timestamp, utc = false) {
        const datetime = utc ? moment.utc(timestamp, 'X') : moment(timestamp, 'X');
        return datetime.format(this.getDateTimeFormat());
    },

    /**
     * Determine direction for language
     * @param {String} lang
     * @returns {boolean}
     */
    isLanguageRTL(lang) {
        if (!(this.getConfig() && this.getConfig().rtl) || !lang) {
            return false;
        }

        return this.getConfig().rtl.some(function (lng) {
            return String(lng).toLowerCase() === lang.toLowerCase();
        });
    },

    /**
     * Determine direction for language
     * @param {String} lang
     * @returns {String} rtl|ltr
     */
    getLanguageDirection(lang) {
        return this.isLanguageRTL(lang) ? 'rtl' : 'ltr';
    }
};