General utilities methods

JavaScript_Utils

/**
 * UTILS module - contains a number of general methods.
 * Inspired by http://javascript.crockford.com/remedial.html
 * */
var UTILS = (function (utils, $) {
    "use strict";

    /**
     * Improved typeof method, distinguishes <array> and <null> from object
     */
    utils.typeOf = function (value) {
        var s = typeof value;
        if (s === 'object') {
            if (value) {
                if (Object.prototype.toString.call(value) === '[object Array]') {
                    s = 'array';
                }
            } else {
                s = 'null';
            }
        }
        return s;
    };

    /**
     * Check if the object/array/string is empty.
     */
    utils.isEmpty = function (o) {
        var i, v, t = utils.typeOf(o);
        if (t === 'object') {
            for (i in o) {
                v = o[i];
                if (v !== undefined && utils.typeOf(v) !== 'function') {
                    return false;
                }
            }
            return true;
        }
        if (t === 'string' || t === 'array') {
            return o.length === 0;
        }
        if (t === 'number') {
            return false;
        }
        if (t === 'undefined') {
            return undefined;
        }
        return t === 'null';
    };

    /***
     * Detect is the element is in the viewport
     * @param viewportSelector - selector for viewport
     * @param ele - selector for the element in question
     * @returns {boolean}
     */
    utils.isElementInViewPort = function(viewportSelector, ele) {
      var eleBoundaries, viewport, $win;
      $win = $(viewportSelector);
      viewport = {
        top: $win.scrollTop(),
        left: $win.scrollLeft(),
        right: $win.scrollLeft() + $win.width(),
        bottom: $win.scrollTop() + $win.height()
      };
      ele = $(ele);
      eleBoundaries = ele.offset();
      eleBoundaries.right = eleBoundaries.left + ele.outerWidth();
      eleBoundaries.bottom = eleBoundaries.top + ele.outerHeight();
      return !(viewport.right < eleBoundaries.left || viewport.left > eleBoundaries.right || viewport.bottom < eleBoundaries.top || viewport.top > eleBoundaries.bottom);
    };

    /***
     * Check if mouse is hovering over the element
     * @param ele - DOM node to be checked
     * @param event - event object, needed to get mouse position
     * @returns {boolean}
     */
    utils.isHover = function(ele, event) {
      var eleRect, x, y;
      eleRect = ele.getBoundingClientRect();
      x = event.pageX || event.clientX;
      y = event.pageY || event.clientY;
      if (((eleRect.left < x && x < eleRect.right)) && ((eleRect.top < y && y < eleRect.bottom))) {
        return true;
      }
      return false;
    };

    return utils;
}(UTILS || {}, jQuery));

if (!String.prototype.supplant) {
    /**
     * Python like string formatting
     *
     * i.e.:
     *
     * >>> s = 'hello {name}'
     * >>> s.supplan({name: 'ana'})
     * >>> 'hello ana'
     * */
    String.prototype.supplant = function (o) {
        return this.replace(
            /\{([^{}]*)\}/g,
            function (a, b) {
                var r = o[b];
                return typeof r === 'string' || typeof r === 'number' ? r : a;
            }
        );
    };
}