resin-cli-visuals/build/widgets/progress.js

Resin CLI UI widgets

// Generated by CoffeeScript 2.7.0
/*
Copyright 2016 Resin.io

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
var CARRIAGE_RETURN, Progress, ProgressBarFormatter, _, formatDuration;

_ = require('lodash');

ProgressBarFormatter = require('progress-bar-formatter');

CARRIAGE_RETURN = '\u001b[1A';

formatDuration = function(seconds) {
  var SECONDS_PER_HOUR, SECONDS_PER_MINUTE, hours, minutes, padMinutes, padSeconds;
  SECONDS_PER_MINUTE = 60;
  SECONDS_PER_HOUR = 3600;
  hours = Math.floor(seconds / SECONDS_PER_HOUR);
  seconds %= SECONDS_PER_HOUR;
  minutes = Math.floor(seconds / SECONDS_PER_MINUTE);
  seconds = Math.floor(seconds % SECONDS_PER_MINUTE);
  padSeconds = seconds < 10 ? '0' + seconds : seconds;
  padMinutes = minutes < 10 ? '0' + minutes : minutes;
  if (hours > 0) {
    return `${hours}h${padMinutes}m${padSeconds}s`;
  }
  if (minutes > 0) {
    return `${minutes}m${padSeconds}s`;
  }
  return `${seconds}s`;
};

module.exports = Progress = class Progress {
  /**
   * @summary Create a CLI Progress Bar
   * @name Progress
   * @class
   * @public
   * @memberof visuals
   *
   * @param {String} message - message
   * @returns {Progress} progress bar instance
   *
   * @throws Will throw if no message.
   *
   * @example
   * progress = new visuals.Progress('Hello World')
   */
  constructor(message) {
    if (_.trim(message) === '') {
      throw new Error('Missing message');
    }
    this._message = message;
    this._bar = new ProgressBarFormatter({
      complete: '=',
      incomplete: ' ',
      // Width of the progress bar
      length: 24
    });
  }

  /**
   * @summary Get progress string from a state
   * @name visuals.Progress#_tick
   * @method
   * @private
   *
   * @param {Object} state - progress state
   * @param {Number} state.percentage - percentage
   * @param {String} [state.message] - message
   * @param {Number} [state.eta] - eta in seconds
   *
   * @throws Will throw if no percentage.
   * @throws Will throw if no eta.
   *
   * @returns {String} progress string
   *
   *	@example
   * progress = new visuals.Progress('Hello World')
   * string = progress._tick(percentage: 49, eta: 300)
   * console.log(string)
   */
  _tick(state) {
    var bar, percentage;
    if (state.percentage == null) {
      throw new Error('Missing percentage');
    }
    bar = this._bar.format(state.percentage / 100);
    percentage = Math.floor(state.percentage);
    this._lastLine = `${this._message}`;
    if (state.message != null) {
      this._lastLine = `${state.message}`;
    }
    this._lastLine += ` [${bar}] ${percentage}%`;
    if (state.eta != null) {
      this._lastLine += ` eta ${formatDuration(state.eta)}`;
    }
    return this._lastLine;
  }

  /**
   * @summary Erase last printed line
   * @name visuals.Progress#_eraseLastLine
   * @method
   * @private
   *
   * @example
   * progress = new visuals.Progress('Hello World')
   * progress._eraseLastLine()
   */
  _eraseLastLine() {
    var eraser;
    if (this._lastLine == null) {
      process.stdout.write('\n');
      return;
    }
    eraser = _.repeat(' ', this._lastLine.length);
    return process.stdout.write(CARRIAGE_RETURN + eraser + '\n');
  }

  /**
   * @summary Update the progress bar
   * @name visuals.Progress#update
   * @method
   * @public
   *
   * @param {Object} state - progress state
   * @param {Number} state.percentage - percentage
   * @parm  {String} [state.message] - message
   * @param {Number} [state.eta] - eta in seconds
   *
   * @example
   * progress = new visuals.Progress('Hello World')
   * progress.update(percentage: 49, eta: 300)
   */
  update(state) {
    this._eraseLastLine();
    return process.stdout.write(CARRIAGE_RETURN + this._tick(state) + '\n');
  }

};