utils.js 13.4 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
/*!
 * Casper is a navigation utility for PhantomJS.
 *
 * Documentation: http://casperjs.org/
 * Repository:    http://github.com/n1k0/casperjs
 *
 * Copyright (c) 2011-2012 Nicolas Perriault
 *
 * Part of source code is Copyright Joyent, Inc. and other Node contributors.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 */

/*global CasperError console exports phantom require*/

(function(exports) {
    "use strict";

    /**
     * Provides a better typeof operator equivalent, able to retrieve the array
     * type.
     *
     * @param  mixed  input
     * @return String
     * @see    http://javascriptweblog.wordpress.com/2011/08/08/fixing-the-javascript-typeof-operator/
     */
    function betterTypeOf(input) {
        try {
            return Object.prototype.toString.call(input).match(/^\[object\s(.*)\]$/)[1].toLowerCase();
        } catch (e) {
            return typeof input;
        }
    }
    exports.betterTypeOf = betterTypeOf;

    /**
     * Cleans a passed URL if it lacks a slash at the end when a sole domain is used.
     *
     * @param  String  url An HTTP URL
     * @return String
     */
    function cleanUrl(url) {
        var match = /(https?):\/\/(.*)/i.exec(url);
        if (!match || match.length !== 3) {
            return url;
        }
        return format("%s://%s/", match[1], match[2]); // notice the trailing slash
    }
    exports.cleanUrl = cleanUrl;

    /**
     * Dumps a JSON representation of passed value to the console. Used for
     * debugging purpose only.
     *
     * @param  Mixed  value
     */
    function dump(value) {
        console.log(serialize(value, 4));
    }
    exports.dump = dump;

    /**
     * Tests equality between the two passed arguments.
     *
     * @param  Mixed  v1
     * @param  Mixed  v2
     * @param  Boolean
     */
    function equals(v1, v2) {
        if (betterTypeOf(v1) !== betterTypeOf(v2)) {
            return false;
        }
        if (isFunction(v1)) {
            return v1.toString() === v2.toString();
        }
        if (v1 instanceof Object) {
            if (Object.keys(v1).length !== Object.keys(v2).length) {
                return false;
            }
            for (var k in v1) {
                if (!equals(v1[k], v2[k])) {
                    return false;
                }
            }
            return true;
        }
        return v1 === v2;
    }
    exports.equals = equals;

    /**
     * Returns the file extension in lower case.
     *
     * @param  String  file  File path
     * @return string
     */
    function fileExt(file) {
        try {
            return file.split('.').pop().toLowerCase().trim();
        } catch(e) {
            return '';
        }
    }
    exports.fileExt = fileExt;

    /**
     * Takes a string and append blanks until the pad value is reached.
     *
     * @param  String  text
     * @param  Number  pad   Pad value (optional; default: 80)
     * @return String
     */
    function fillBlanks(text, pad) {
        pad = pad || 80;
        if (text.length < pad) {
            text += new Array(pad - text.length + 1).join(' ');
        }
        return text;
    }
    exports.fillBlanks = fillBlanks;

    /**
     * Formats a string with passed parameters. Ported from nodejs `util.format()`.
     *
     * @return String
     */
    function format(f) {
        var i = 1;
        var args = arguments;
        var len = args.length;
        var str = String(f).replace(/%[sdj%]/g, function _replace(x) {
            if (i >= len) return x;
            switch (x) {
            case '%s':
                return String(args[i++]);
            case '%d':
                return Number(args[i++]);
            case '%j':
                return JSON.stringify(args[i++]);
            case '%%':
                return '%';
            default:
                return x;
            }
        });
        for (var x = args[i]; i < len; x = args[++i]) {
            if (x === null || typeof x !== 'object') {
                str += ' ' + x;
            } else {
                str += '[obj]';
            }
        }
        return str;
    }
    exports.format = format;

    /**
     * Retrieves the value of an Object foreign property using a dot-separated
     * path string.
     *
     * Beware, this function doesn't handle object key names containing a dot.
     *
     * @param  Object  obj   The source object
     * @param  String  path  Dot separated path, eg. "x.y.z"
     */
    function getPropertyPath(obj, path) {
        if (!isObject(obj) || !isString(path)) {
            return undefined;
        }
        var value = obj;
        path.split('.').forEach(function(property) {
            if (typeof value === "object" && property in value) {
                value = value[property];
            } else {
                value = undefined;
            }
        });
        return value;
    }
    exports.getPropertyPath = getPropertyPath;

    /**
     * Inherit the prototype methods from one constructor into another.
     *
     * @param {function} ctor Constructor function which needs to inherit the
     *     prototype.
     * @param {function} superCtor Constructor function to inherit prototype from.
     */
    function inherits(ctor, superCtor) {
        ctor.super_ = ctor.__super__ = superCtor;
        ctor.prototype = Object.create(superCtor.prototype, {
            constructor: {
                value: ctor,
                enumerable: false,
                writable: true,
                configurable: true
            }
        });
    }
    exports.inherits = inherits;

    /**
     * Checks if value is a javascript Array
     *
     * @param  mixed  value
     * @return Boolean
     */
    function isArray(value) {
        return Array.isArray(value) || isType(value, "array");
    }
    exports.isArray = isArray;

    /**
     * Checks if passed argument is an instance of Capser object.
     *
     * @param  mixed  value
     * @return Boolean
     */
    function isCasperObject(value) {
        return value instanceof require('casper').Casper;
    }
    exports.isCasperObject = isCasperObject;

    /**
     * Checks if value is a phantomjs clipRect-compatible object
     *
     * @param  mixed  value
     * @return Boolean
     */
    function isClipRect(value) {
        return isType(value, "cliprect") || (
            isObject(value) &&
            isNumber(value.top) && isNumber(value.left) &&
            isNumber(value.width) && isNumber(value.height)
        );
    }
    exports.isClipRect = isClipRect;

    /**
     * Checks if value is a javascript Function
     *
     * @param  mixed  value
     * @return Boolean
     */
    function isFunction(value) {
        return isType(value, "function");
    }
    exports.isFunction = isFunction;

    /**
     * Checks if passed resource involves an HTTP url.
     *
     * @param  Object  resource The PhantomJS HTTP resource object
     * @return Boolean
     */
    function isHTTPResource(resource) {
        return isObject(resource) && /^http/i.test(resource.url);
    }
    exports.isHTTPResource = isHTTPResource;

    /**
     * Checks if a file is apparently javascript compatible (.js or .coffee).
     *
     * @param  String  file  Path to the file to test
     * @return Boolean
     */
    function isJsFile(file) {
        var ext = fileExt(file);
        return isString(ext, "string") && ['js', 'coffee'].indexOf(ext) !== -1;
    }
    exports.isJsFile = isJsFile;

    /**
     * Checks if the provided value is null
     *
     * @return Boolean
     */
    function isNull(value) {
        return isType(value, "null");
    }
    exports.isNull = isNull;

    /**
     * Checks if value is a javascript Number
     *
     * @param  mixed  value
     * @return Boolean
     */
    function isNumber(value) {
        return isType(value, "number");
    }
    exports.isNumber = isNumber;

    /**
     * Checks if value is a javascript Object
     *
     * @param  mixed  value
     * @return Boolean
     */
    function isObject(value) {
        var objectTypes = ["array", "object", "qtruntimeobject"];
        return objectTypes.indexOf(betterTypeOf(value)) >= 0;
    }
    exports.isObject = isObject;

    /**
     * Checks if value is a javascript String
     *
     * @param  mixed  value
     * @return Boolean
     */
    function isString(value) {
        return isType(value, "string");
    }
    exports.isString = isString;

    /**
     * Shorthands for checking if a value is of the given type. Can check for
     * arrays.
     *
     * @param  mixed   what      The value to check
     * @param  String  typeName  The type name ("string", "number", "function", etc.)
     * @return Boolean
     */
    function isType(what, typeName) {
        if (typeof typeName !== "string" || !typeName) {
            throw new CasperError("You must pass isType() a typeName string");
        }
        return betterTypeOf(what).toLowerCase() === typeName.toLowerCase();
    }
    exports.isType = isType;

    /**
     * Checks if the provided value is undefined
     *
     * @return Boolean
     */
    function isUndefined(value) {
        return isType(value, "undefined");
    }
    exports.isUndefined = isUndefined;

    /**
     * Checks if value is a valid selector Object.
     *
     * @param  mixed  value
     * @return Boolean
     */
    function isValidSelector(value) {
        if (isString(value)) {
            try {
                // phantomjs env has a working document object, let's use it
                document.querySelector(value);
            } catch(e) {
                if ('name' in e && e.name === 'SYNTAX_ERR') {
                    return false;
                }
            }
            return true;
        } else if (isObject(value)) {
            if (!value.hasOwnProperty('type')) {
                return false;
            }
            if (!value.hasOwnProperty('path')) {
                return false;
            }
            if (['css', 'xpath'].indexOf(value.type) === -1) {
                return false;
            }
            return true;
        }
        return false;
    }
    exports.isValidSelector = isValidSelector;

    /**
     * Checks if the provided var is a WebPage instance
     *
     * @param  mixed  what
     * @return Boolean
     */
    function isWebPage(what) {
        return betterTypeOf(what) === "qtruntimeobject" && what.objectName === 'WebPage';
    }
    exports.isWebPage = isWebPage;

    /**
     * Object recursive merging utility.
     *
     * @param  Object  origin  the origin object
     * @param  Object  add     the object to merge data into origin
     * @return Object
     */
    function mergeObjects(origin, add) {
        for (var p in add) {
            try {
                if (add[p].constructor === Object) {
                    origin[p] = mergeObjects(origin[p], add[p]);
                } else {
                    origin[p] = add[p];
                }
            } catch(e) {
              origin[p] = add[p];
            }
        }
        return origin;
    }
    exports.mergeObjects = mergeObjects;

    /**
     * Creates an (SG|X)ML node element.
     *
     * @param  String  name        The node name
     * @param  Object  attributes  Optional attributes
     * @return HTMLElement
     */
    function node(name, attributes) {
        var _node = document.createElement(name);
        for (var attrName in attributes) {
            var value = attributes[attrName];
            if (attributes.hasOwnProperty(attrName) && isString(attrName)) {
                _node.setAttribute(attrName, value);
            }
        }
        return _node;
    }
    exports.node = node;

    /**
     * Serializes a value using JSON.
     *
     * @param  Mixed  value
     * @return String
     */
    function serialize(value, indent) {
        if (isArray(value)) {
            value = value.map(function _map(prop) {
                return isFunction(prop) ? prop.toString().replace(/\s{2,}/, '') : prop;
            });
        }
        return JSON.stringify(value, null, indent);
    }
    exports.serialize = serialize;

    /**
     * Returns unique values from an array.
     *
     * Note: ugly code is ugly, but efficient: http://jsperf.com/array-unique2/8
     *
     * @param  Array  array
     * @return Array
     */
    function unique(array) {
        var o = {},
            r = [];
        for (var i = 0, len = array.length; i !== len; i++) {
            var d = array[i];
            if (o[d] !== 1) {
                o[d] = 1;
                r[r.length] = d;
            }
        }
        return r;
    }
    exports.unique = unique;
})(exports);