stringify-depute.js

/**
 * This file gets a string on which tweets are based.
 *
 * Authors : Corentin Forler, 2021.
 */

/** @typedef {import("./fetch-informations-depute").Depute} Depute */
/** @typedef {Depute['mandats'][number]} Mandat */

/**
 * @param {string} s
 * @returns {number | undefined}
 */
function trouverNombreDansOrdinal(s) {
  if (s.match(/prem/ui)) { return 1; }
  else if (s.match(/deux/ui)) { return 2; }
  else if (s.match(/second/ui)) { return 2; }
  else if (s.match(/trois/ui)) { return 3; }
  else if (s.match(/quatr/ui)) { return 4; }
  else if (s.match(/cinq/ui)) { return 5; }
}

/**
 *
 * @param {number | string} num
 * @param {'F' | 'M' | undefined} genre
 */
function formatOrdinal(num, genre) {
  switch (num) {
    case 1:
    case 'I':
      return genre === 'F' ? `${num}re` : `${num}er`;
    case 2:
    case 'II':
      return genre === 'F' ? `${num}nde` : `${num}nd`;
    default: return `${num}e`;
  }
}

function numToSmallRoman(num) {
  const roman = [
    ['X', 10], ['IX', 9],
    ['V', 5], ['IV', 4],
    ['I', 1],
  ];
  let str = '';

  for (const [letter, value] of roman) {
    const q = Math.floor(num / value);
    num -= q * value;
    str += letter.repeat(q);
  }
  return str;
}

function formatRegime(regime = '') {
  const fmt = (abrev, genre) => {
    const numero = trouverNombreDansOrdinal(regime);
    if (numero === undefined) { return regime; } // failsafe
    return `${formatOrdinal(numToSmallRoman(numero), genre)} ${abrev}`;
  };
  if (regime.match(/Gouvernement provisoire/ui)) {
    return 'GPRF';
  } else if (regime.match(/République/ui)) {
    return fmt('Rép.', 'F');
  } else if (regime.match(/Restauration/ui)) {
    return fmt('Rest.', 'F');
  } else if (regime.match(/Empire/ui)) {
    return fmt('Emp.', 'M');
  } else {
    return regime;
  }
}

function formatInstance(instance = '') {
  instance = instance.replace(/Assemblée nationale/ui, 'A.N.'); // https://www.youtube.com/watch?v=jwMFYcXjTbQ
  instance = instance.replace(/Chambre des députés des départements/ui, 'Chambre des députés des dépt.');
  instance = instance.replace(/Convention nationale/ui, 'Conv. nat.');
  instance = instance.replace(/constituante?/ui, 'const.');
  instance = instance.replace(/législati(ve|f)/ui, 'législ.');
  instance = instance.replace(/nationale?/ui, 'nat.');
  return instance;
}

function formatLégislature(leg = '') {
  leg = leg.replace(/législature/ui, 'lég.');
  return leg;
}

/**
 * @param {Mandat} mandat
 */
function getOccupationPolitique(mandat) {
  if (mandat.regimePolitique.match(/ - /ui)) {
    const [regime, instance] = mandat.regimePolitique.split(' - ');
    const legislature = mandat.legislature;
    return {
      regime: formatRegime(regime),
      instance: formatInstance(instance),
      legislature: formatLégislature(legislature),
    };
  } else {
    return {
      regime: formatRegime(mandat.regimePolitique),
      instance: formatInstance(mandat.legislature), // yes, it's weird but it's like that
    };
  }
}


// Date de naissance et de décès
function datesDeVieToString(depute) {
  if (depute.anneeDeces) { // est mort
    return `${depute.anneeNaissance}–${depute.anneeDeces}`;
  } else if (depute.anneeNaissance) { // a une année de naissance
    return `${depute.anneeNaissance}–`;
  }
  return ''; // else missing data
}


/**
 * @param {Depute} depute
 * @returns {string}
 */
function deputeToString(depute) {
  let str = '';

  // Nom complet et dates
  if (depute.anneeNaissance || depute.anneeDeces) {
    str += `${depute.nomComplet} (${datesDeVieToString(depute)})`;
  } else {
    str += `${depute.nomComplet}`;
  }

  str += '\n\n';

  // Mandats (dans l'ordre donné par le fetcher)
  if (depute.mandats.length > 0) {
    str += depute.mandats.length === 1 ? 'Mandat :\n' : 'Mandats :\n';

    for (const mandat of depute.mandats) {
      const { anneeDebut, anneeFin } = mandat;

      const { regime, instance, legislature } = getOccupationPolitique(mandat);

      str += '•'; // puce
      if (regime && instance) {
        if (legislature) {
          str += ` ${regime} (${instance}), ${legislature}`;
        } else {
          str += ` ${regime} (${instance})`;
        }
      } else if (regime || legislature || instance) {
        // fallback if at least one field
        str += ' ' + [regime, legislature, instance].filter(Boolean).join(', ');
      }

      if (anneeDebut && anneeDebut === anneeFin) { // mandat d'un an
        str += ` ${anneeDebut}`;
      } else if (anneeFin) { // a un début et une fin
        str += ` ${anneeDebut}–${anneeFin}`;
      } else if (anneeDebut) { // n'a qu'un début
        str += ` ${anneeDebut}–`;
      } // else missing data

      str += '\n';

      if (mandat.groupe) {
        str += `  ⁃ Groupe : ${mandat.groupe}\n`;
      }
      if (mandat.departement) {
        str += `  ⁃ Département : ${mandat.departement}\n`;
      }

      str = str.trim() + '\n\n'; // space
    }
  }

  str += '\n';
  str += `Source ${depute.hasBio ? 'et biographie(s) ' : ''}: ${depute.bdUrl}`;
  str += '\n';

  return str;
}


/**
 * strlen but counting whole unicode glyphs
 * @param {string} s The string to measure
 */
function glyphCount(s) {
  return [...s.replace(/https?:\S+/g, 'U'.repeat(23)).replace('•', '12')].length;
}

/**
 * @param {string[]} blocks
 * @returns {string[]}
 */
function splitStringToTweets(str) {
  // split lines but keep lines starting with spaces with previous lines
  const blocks = str.split(/\n(?!  )/g); // split + lookahead
  const tweetTexts = [];

  // TODO: split groups of lines bigger than 280 chars

  let currentText = '';
  for (const block of blocks) {
    const willBeTooBig = (glyphCount(currentText + block) + 10) >= 280;
    const shouldSplitHere = willBeTooBig;

    if (shouldSplitHere) {
      tweetTexts.push(currentText.trim());
      currentText = '';
    }

    currentText += block + '\n';
  }
  if (currentText.length > 0) {
    tweetTexts.push(currentText.trim());
  }

  // Add counter
  const n = tweetTexts.length;
  if (n >= 2) {
    for (let i = 0; i < n; i++) {
      tweetTexts[i] += '\n\n' + `(${i + 1}/${n})`;
    }
  }

  return tweetTexts;
}

function deputeToTweets(depute) {
  return splitStringToTweets(deputeToString(depute));
}

module.exports = { deputeToTweets };