/*
 * Copyright 2015 IBM Corp.
 *
 * 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.
 */
(function() {
  'use strict';

  /**
    * @ngdoc service
    * @name toastService
    *
    * @description
    * This service can be used to display user messages, toasts, in Horizon.
    * To create a new toast, inject the 'horizon.framework.widgets.toast.service'
    * module into your current module. Then, use the service methods.
    *
    * For example to add a 'success' message:
    *     toastService.add('success', 'User successfully created.');
    *
    * All actions (add, clearAll, etc.) taken on the data are automatically
    * sync-ed with the HTML.
    */
  angular
    .module('horizon.framework.widgets.toast')
    .factory('horizon.framework.widgets.toast.service', toastService);

  function toastService() {

    var toasts = [];
    var service = {
      types: {},
      add: add,
      get: get,
      cancel: cancel,
      clearAll: clearAll,
      clearErrors: clearErrors,
      clearSuccesses: clearSuccesses
    };

    /**
      * There are 5 types of toasts, which are based off Bootstrap alerts.
      */
    service.types = {
      danger: gettext('Danger'),
      warning: gettext('Warning'),
      info: gettext('Info'),
      success: gettext('Success'),
      error: gettext('Error')
    };

    return service;

    ///////////////////////

    /**
      * Helper method used to remove all the toasts matching the 'type'
      * passed in.
      */
    function clear(type) {
      for (var i = toasts.length - 1; i >= 0; i--) {
        if (toasts[i].type === type) {
          toasts.splice(i, 1);
        }
      }
    }

    /**
     * Remove a single toast.
     */
    function cancel(index) {
      toasts.splice(index, 1);
    }

    /**
      * Create a toast object and push it to the toasts array.
      */
    function add(type, msg) {
      var toast = {
        type: type === 'error' ? 'danger' : type,
        /* jshint validthis:true */
        typeMsg: this.types[type],
        msg: msg,
        cancel: cancel
      };
      toasts.push(toast);
    }

    /**
     * Return all toasts.
     */
    function get() {
      return toasts;
    }

    /**
     * Remove all toasts.
     */
    function clearAll() {
      toasts = [];
    }

    /**
     * Remove all toasts of type 'danger.'
     */
    function clearErrors() {
      clear('danger');
    }

    /**
     * Remove all toasts of type 'success.'
     */
    function clearSuccesses() {
      clear('success');
    }
  }
})();