random-student.js

const fs = require('fs');
const gradient = require('gradient-string');
const CFonts = require('cfonts');
const argv = require('minimist')(process.argv.slice(2));

// print extra console.logs
const isVerbose = (argv.v || argv.verbose);
const isHelpEnabled = (argv.help);
const isResetEnabled = (argv.clearCache);
const isInitialEnabled = (argv.initial || !argv.fullname);
const isConsoleClearEnabled = (argv.clearOnCall || argv.c);
const isPlainTextEnabled = (argv.plain || argv.p);
const logFile = __dirname + 
  ((argv.logFile) ? argv.logFile : '/random-student.log');
  
// confirm log file location
if (isVerbose) console.log(logFile);

// cfonts configuration arrays:

const fonts = [
  "block",
  "shade",
  "chrome",
  "simple",
  "simpleBlock",
  "3d",
  "simple3d",
  "huge"//,
  // "console"
];
const clrs = [
  "system",
  // "black",
  "red",
  "green",
  "yellow",
  "blue",
  "magenta",
  "cyan",
  "white",
  "gray",
  "redBright",
  "greenBright",
  "yellowBright",
  "blueBright",
  "magentaBright",
  "cyanBright",
  "whiteBright"
];
const bkgClrs = [
  "transparent",
  "black",
  "red",
  "green",
  "yellow",
  "blue",
  "magenta",
  "cyan",
  "white",
  "blackBright",
  "redBright",
  "greenBright",
  "yellowBright",
  "blueBright",
  "magentaBright",
  "cyanBright",
  "whiteBright"
];


/**
 * Help - displays available options and exit script.
 */
if (isHelpEnabled) {
  console.log('Available Options:')
  console.log('--font random|<font>')
  console.table(fonts)
  console.log('--colors random|<color>')
  console.table(clrs)
  console.log('--background random|<bkg_color>')
  console.table(bkgClrs)
  console.log('--align <left|center|right>')
  console.log('--clearOnCall | -c <true| >', 'clear terminal screen on call');
  console.log(`--logFile='. / test.log' configure custom log file useful for testing`)
  console.log('--plain | -p', 'plain text output')
  console.log('--verbose | -v', 'output extra console logs for debugging')

  return;
}

// students gets re-assigned to studentsAll on reset.
let students = (argv.studentsFile) ? 
  require(argv.studentsFile) : 
  require('./students.js');
const studentsAll = [...students];


/**
 * Read history log file, remove those students from avail students list.
 * Then call, or reset history first.
 */
function readHistoryAndCall() {
  // Read history log on each run.
  fs.readFile(logFile, 'utf-8', (err, history) => {
    if (err) throw err;
    const called = history.trim().split('\n');
    // Removed called students from available students list.
    for (let i = 0; i < called.length; i++) {
      let calledStudent = called[i];
      students.forEach((stu, index) => {
        if (calledStudent === stu) {
          students.splice(index, 1);
        }
      });
    }
    
    if (isVerbose) console.table(students);

    // After all students have been called OR reset argument specified.
    if (students.length === 0 || isResetEnabled) {
      reset(callRandom);
    } else {
      callRandom();
    }

  });

}
/**
 * Call random student from available students list.
 * Using CFonts to output fancy text.
 */
function callRandom() {
  let student = students[Math.floor(Math.random() * students.length)];
  fs.appendFile(logFile, '\n' + student, (err) => {
    if (err) throw err;
    if (isVerbose) console.log('appendFile: ' + student);
  });
  if (isInitialEnabled) {
    // Match firstname + last initial
    student = student.match(/\w+\s+[A-Z]/).toString();
  }

  // TODO: plain logic
  if (!isPlainTextEnabled) {
    
    /**
     * cFonts Options defaults | arguments
     */
    // get color here so we can make it the default.
    let randomColor = clrs[Math.floor(Math.random() * clrs.length)];
    // Options for the cfonts module.
    let cfontsOpts = { 
      align: 'center', 
      colors: [randomColor] 
    };
    
    if (argv.colors) {
      cfontsOpts.colors =  (argv.colors === 'random') ?
        [randomColor] :
        argv.colors.split(',');
    }
    if (argv.font) {// default font is 'block'
      cfontsOpts.font = (argv.font === 'random') ?
        fonts[Math.floor(Math.random() * fonts.length)] : 
        argv.font;
    }
    if (argv.align) {
      cfontsOpts.align = argv.align;
    }
    if (argv.background) {

      // Random backgrounds could clash so...
      if (argv.background === 'random') {
        // Filter out the backgrounds that are the same as the selected foreground.
        bkgClrs.forEach(function(color, index) {
          if (new RegExp(cfontsOpts.colors.join('|')).test(color)) {
            if (isVerbose) {
              console.log('filtering out color ' + color + ' because font is ' + cfontsOpts.colors.toString())
            }
            bkgClrs.splice(index, 1);
          }
        })
      }
      // Background either to random 
      cfontsOpts.background = (argv.background === 'random') ?
        bkgClrs[Math.floor(Math.random() * bkgClrs.length)] :
        argv.background;
    }
    if (isConsoleClearEnabled) {
      console.reset();
    }
  }
  if (isPlainTextEnabled) {
    console.log(student)
  } else {
    CFonts.say(student, cfontsOpts);
    // debug
    if (isVerbose) console.table(cfontsOpts);
  }

}
/**
 * Reset students array to original list
 */
function reset(cb) {
  fs.writeFile(logFile, '', (err) => {
    if (err) throw err;
    console.log(gradient.instagram('All students called! Clearing called log!'));
    students = studentsAll;
    if (cb) cb();
  });
}

console.reset = function () {
  return process.stdout.write('\033c');
}

//-------------------------------------------------

readHistoryAndCall();