lib/util.js

  1. /**
  2.  * @file Miscellaneous utilities; mainly routines for strings
  3.  * @author Antonio Olmo Titos <a@olmo-titos.info>
  4.  * @exports lib/util
  5.  */
  7. // Internal packages:
  8. const LOGGING = require('./logging');
  10. // Constants:
  11. const REGEX_VALID_ID = /^[\w\-.,()][\w \-.,()]*[\w\-.,()]$/,
  12.     DAY_NAMES = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'];
  14. /**
  15.  * Check if a string is a valid ID for an entity
  16.  * @param {String} string - the candidate string
  17.  * @returns {Boolean} whether the string is valid
  18.  */
  20. const isValidID = function(string) {
  21.     if (!string)
  22.         LOGGING.warn(`“isValidID()”: no string to normalise`);
  23.     else
  24.         return (string && string.match(REGEX_VALID_ID));
  25. };
  27. /**
  28.  * “Normalise” a string to use it as the ID of an entity
  29.  * @param {String} string - the candidate string
  30.  * @returns {String} the normalised string
  31.  */
  33. const normaliseID = function(string) {
  34.     if (!string)
  35.         LOGGING.warn(`“util.normaliseID()”: no string to normalise`);
  36.     else if (!string.match(REGEX_VALID_ID))
  37.         LOGGING.warn(`“util.normaliseID()”: “${string}” is not a valid ID string`);
  38.     else
  39.         return string.toLowerCase();
  40. };
  42. /**
  43.  * Format a duration in minutes as a more readable string
  44.  * @param {Number} duration - duration, in min (eg, 150)
  45.  * @returns {String} the equivalent "nice" duration (eg, "1h30'")
  46.  */
  48. const formatDuration = function(duration, forceSign) {
  49.     if ('number' !== typeof duration)
  50.         return '[unknown]';
  51.     else if (0 === duration)
  52.         return '0';
  53.     else {
  54.         const time = Math.abs(Math.round(duration)),
  55.             h = Math.abs(Math.floor(duration / 60)),
  56.             hs = h ? `${h}h` : '',
  57.             m = time % 60,
  58.             ms = m ? `${m}&prime;` : '',
  59.             sign = duration < 0 ? '&minus;' : (forceSign ? '&plus;' : '');
  60.         return `${sign}${hs}${ms}`;
  61.     }
  62. };
  64. /**
  65.  * Pre-process an entity item, or a list of entity items, to extend information
  66.  * @param {Object} data - meeting info
  67.  * @param {Object} the same object, perhaps extended with more info
  68.  */
  70. const processData = function(data) {
  71.     for (const i in data) {
  72.         if (data[i].duration)
  73.             data[i].niceDuration = formatDuration(data[i].duration);
  74.         if (data[i].day)
  75.             data[i].niceDay = DAY_NAMES[data[i].day];
  76.     }
  77. };
  79. // Export stuff
  80. exports.isValidID = isValidID;
  81. exports.normaliseID = normaliseID;
  82. exports.processData = processData;
  83. exports.formatDuration = formatDuration;