File: ../src/datehelper.js

define(['aeris/util'], function(_) {
  var MILLISECOND = 1;
  var SECOND = MILLISECOND * 1000;
  var MINUTE = SECOND * 60;
  var HOUR = MINUTE * 60;
  var DAY = HOUR * 24;
  var WEEK = DAY * 7;


  /**
   * Manipulates a {Date} object.
   *
   * @publicApi
   * @class aeris.DateHelper
   *
   * @param {Date=} opt_date Defaults to current date.
   * @constructor
   */
  var DateHelper = function(opt_date) {
    this.date_ = opt_date || new Date();
  };


  /**
   * @param {number} ms
   * @return {Date} Modified date object.
   * @method addMilliseconds
   */
  DateHelper.prototype.addMilliseconds = function(ms) {
    this.date_.setTime(this.date_.getTime() + ms);

    return this;
  };


  /**
   * @param {number} seconds
   * @return {Date} Modified date object.
   * @method addSeconds
   */
  DateHelper.prototype.addSeconds = function(seconds) {
    return this.addMilliseconds(seconds * SECOND);
  };


  /**
   * @param {number} minutes
   * @return {Date} Modified date object.
   * @method addMinutes
   */
  DateHelper.prototype.addMinutes = function(minutes) {
    return this.addMilliseconds(minutes * MINUTE);
  };


  /**
   * @param {number} hours
   * @return {Date} Modified date object.
   * @method addHours
   */
  DateHelper.prototype.addHours = function(hours) {
    return this.addMilliseconds(hours * HOUR);
  };


  /**
   * @param {number} days
   * @return {Date} Modified date object.
   * @method addDays
   */
  DateHelper.prototype.addDays = function(days) {
    return this.addMilliseconds(days * DAY);
  };


  /**
   * @param {number} weeks
   * @return {Date} Modified date object.
   * @method addWeeks
   */
  DateHelper.prototype.addWeeks = function(weeks) {
    return this.addMilliseconds(weeks * WEEK);
  };

  /**
   * @method add
   * @param {number} hours
   * @param {number=} opt_minutes
   * @param {number=} opt_seconds
   * @param {number=} opt_milliseconds
   */
  DateHelper.prototype.addTime = function(hours, opt_minutes, opt_seconds, opt_milliseconds) {
    var minutes = _.isUndefined(opt_minutes) ? 0 : opt_minutes;
    var seconds = _.isUndefined(opt_seconds) ? 0 : opt_seconds;
    var milliseconds = _.isUndefined(opt_milliseconds) ? 0 : opt_milliseconds;

    return this.addHours(hours).
      addMinutes(minutes).
      addSeconds(seconds).
      addMilliseconds(milliseconds);
  };


  /**
   * @return {Date}
   * @method getDate
   */
  DateHelper.prototype.getDate = function() {
    return this.date_;
  };


  /**
   * @method getTime
   */
  DateHelper.prototype.getTime = function() {
    return this.date_.getTime();
  };


  /**
   * @param {Date} opt_date Defaults to current date.
   * @method setDate
   */
  DateHelper.prototype.setDate = function(opt_date) {
    this.date_ = opt_date || new Date();

    return this;
  };


  return _.expose(DateHelper, 'aeris.DateHelper');
});