casperjs 1.0.0.RC1 → 1.0.0

data/batchbin/casperjs.bat

@@ -0,0 +1,5 @@
+@ECHO OFF
+set CASPER_PATH=%~dp0..
+set CASPER_BIN=%CASPER_PATH%\bin\
+set ARGV=%*
+call phantomjs "%CASPER_BIN%bootstrap.js" --casper-path="%CASPER_PATH%" --cli %ARGV%

data/bin/bootstrap.js

@@ -29,14 +29,155 @@
  */
 
 /*global console phantom require*/
+/*jshint maxstatements:30 maxcomplexity:10*/
 
-if (!phantom || phantom.version.major !== 1 || phantom.version.minor < 5) {
-    console.error('CasperJS needs at least PhantomJS v1.5.0');
+if (!phantom) {
+    console.error('CasperJS needs to be executed in a PhantomJS environment http://phantomjs.org/');
     phantom.exit(1);
 }
 
-(function bootstrap(global) {
+if (phantom.version.major === 1 && phantom.version.minor < 7) {
+    console.error('CasperJS needs at least PhantomJS v1.7 or later.');
+    phantom.exit(1);
+} else {
+    bootstrap(window);
+}
+
+// Polyfills
+if (typeof Function.prototype.bind !== "function") {
+    Function.prototype.bind = function(scope) {
+        "use strict";
+        var _function = this;
+        return function() {
+            return _function.apply(scope, arguments);
+        };
+    };
+}
+
+/**
+ * CasperJS ships with its own implementation of CommonJS' require() because
+ * PhantomJS' native one doesn't allow to specify supplementary, alternative
+ * lookup directories to fetch modules from.
+ *
+ */
+function patchRequire(require, requireDirs) {
+    "use strict";
+    require('webserver'); // force generation of phantomjs' require.cache for the webserver module
+    var fs = require('fs');
+    var phantomBuiltins = ['fs', 'webpage', 'system', 'webserver'];
+    var phantomRequire = phantom.__orig__require = require;
+    var requireCache = {};
+    function possiblePaths(path, requireDir) {
+        var dir, paths = [];
+        if (path[0] === '.') {
+            paths.push.apply(paths, [
+                fs.absolute(path),
+                fs.absolute(fs.pathJoin(requireDir, path))
+            ]);
+        } else if (path[0] === '/') {
+            paths.push(path);
+        } else {
+            dir = fs.absolute(requireDir);
+            while (dir !== '' && dir.lastIndexOf(':') !== dir.length - 1) {
+                paths.push(fs.pathJoin(dir, 'modules', path));
+                // nodejs compatibility
+                paths.push(fs.pathJoin(dir, 'node_modules', path));
+                dir = fs.dirname(dir);
+            }
+            paths.push(fs.pathJoin(requireDir, 'lib', path));
+            paths.push(fs.pathJoin(requireDir, 'modules', path));
+        }
+        return paths;
+    }
+    var patchedRequire = function _require(path) {
+        var i, paths = [],
+            fileGuesses = [],
+            file,
+            module = {
+                exports: {}
+            };
+        if (phantomBuiltins.indexOf(path) !== -1) {
+            return phantomRequire(path);
+        }
+        requireDirs.forEach(function(requireDir) {
+            paths = paths.concat(possiblePaths(path, requireDir));
+        });
+        paths.forEach(function _forEach(testPath) {
+            fileGuesses.push.apply(fileGuesses, [
+                testPath,
+                testPath + '.js',
+                testPath + '.json',
+                testPath + '.coffee',
+                fs.pathJoin(testPath, 'index.js'),
+                fs.pathJoin(testPath, 'index.json'),
+                fs.pathJoin(testPath, 'index.coffee'),
+                fs.pathJoin(testPath, 'lib', fs.basename(testPath) + '.js'),
+                fs.pathJoin(testPath, 'lib', fs.basename(testPath) + '.json'),
+                fs.pathJoin(testPath, 'lib', fs.basename(testPath) + '.coffee')
+            ]);
+        });
+        file = null;
+        for (i = 0; i < fileGuesses.length && !file; ++i) {
+            if (fs.isFile(fileGuesses[i])) {
+                file = fileGuesses[i];
+            }
+        }
+        if (!file) {
+            throw new window.CasperError("CasperJS couldn't find module " + path);
+        }
+        if (file in requireCache) {
+            return requireCache[file].exports;
+        }
+        if (/\.json/i.test(file)) {
+            var parsed = JSON.parse(fs.read(file));
+            requireCache[file] = parsed;
+            return parsed;
+        }
+        var scriptCode = (function getScriptCode(file) {
+            var scriptCode = fs.read(file);
+            if (/\.coffee$/i.test(file)) {
+                /*global CoffeeScript*/
+                scriptCode = CoffeeScript.compile(scriptCode);
+            }
+            return scriptCode;
+        })(file);
+        var fn = new Function('__file__', 'require', 'module', 'exports', scriptCode);
+        try {
+            fn(file, _require, module, module.exports);
+        } catch (e) {
+            var error = new window.CasperError('__mod_error(' + path + ':' + e.line + '):: ' + e);
+            error.file = file;
+            error.line = e.line;
+            error.stack = e.stack;
+            error.stackArray = JSON.parse(JSON.stringify(e.stackArray));
+            if (error.stackArray.length > 0) {
+                error.stackArray[0].sourceURL = file;
+            }
+            throw error;
+        }
+        requireCache[file] = module;
+        return module.exports;
+    };
+    patchedRequire.patched = true;
+    return patchedRequire;
+}
+
+function bootstrap(global) {
     "use strict";
+    var phantomArgs = require('system').args;
+
+    /**
+     * Hooks in default phantomjs error handler to print a hint when a possible
+     * casperjs command misuse is detected.
+     *
+     */
+    phantom.onError = function onPhantomError(msg, trace) {
+        phantom.defaultErrorHandler.apply(phantom, arguments);
+        if (msg.indexOf("ReferenceError: Can't find variable: casper") === 0) {
+            console.error('Hint: you may want to use the `casperjs test` command.');
+        }
+    };
+
     /**
      * Loads and initialize the CasperJS environment.
      */
@@ -93,12 +234,6 @@ if (!phantom || phantom.version.major !== 1 || phantom.version.minor < 5) {
         // custom global CasperError
         global.CasperError = function CasperError(msg) {
             Error.call(this);
-            try {
-                // let's get where this error has been thrown from, if we can
-                this._from = arguments.callee.caller.name;
-            } catch (e) {
-                this._from = "anonymous";
-            }
             this.message = msg;
             this.name = 'CasperError';
         };
@@ -120,7 +255,7 @@ if (!phantom || phantom.version.major !== 1 || phantom.version.minor < 5) {
                 throw new global.CasperError('Cannot read package file contents: ' + e);
             }
             parts  = pkg.version.trim().split(".");
-            if (parts < 3) {
+            if (parts.length < 3) {
                 throw new global.CasperError("Invalid version number");
             }
             patchPart = parts[2].split('-');
@@ -139,100 +274,11 @@ if (!phantom || phantom.version.major !== 1 || phantom.version.minor < 5) {
             };
         })(phantom.casperPath);
 
-        /**
-         * Retrieves the javascript source code from a given .js or .coffee file.
-         *
-         * @param  String         file     The path to the file
-         * @param  Function|null  onError  An error callback (optional)
-         */
-        phantom.getScriptCode = function getScriptCode(file, onError) {
-            var scriptCode = fs.read(file);
-            if (/\.coffee$/i.test(file)) {
-                /*global CoffeeScript*/
-                scriptCode = CoffeeScript.compile(scriptCode);
-            }
-            return scriptCode;
-        };
-
-        /**
-         * Patching require() to allow loading of other modules than PhantomJS'
-         * builtin ones.
-         * Inspired by phantomjs-nodify: https://github.com/jgonera/phantomjs-nodify/
-         * TODO: remove when PhantomJS has full module support
-         */
-        require = (function _require(require, requireDir) {
-            var phantomBuiltins = ['fs', 'webpage', 'webserver', 'system'];
-            var phantomRequire = phantom.__orig__require = require;
-            var requireCache = {};
-            return function _require(path) {
-                var i, dir, paths = [],
-                    fileGuesses = [],
-                    file,
-                    module = {
-                        exports: {}
-                    };
-                if (phantomBuiltins.indexOf(path) !== -1) {
-                    return phantomRequire(path);
-                }
-                if (path[0] === '.') {
-                    paths.push.apply(paths, [
-                        fs.absolute(path),
-                        fs.absolute(fs.pathJoin(requireDir, path))
-                    ]);
-                } else if (path[0] === '/') {
-                    paths.push(path);
-                } else {
-                    dir = fs.absolute(requireDir);
-                    while (dir !== '' && dir.lastIndexOf(':') !== dir.length - 1) {
-                        // nodejs compatibility
-                        paths.push(fs.pathJoin(dir, 'node_modules', path));
-                        dir = fs.dirname(dir);
-                    }
-                    paths.push(fs.pathJoin(requireDir, 'lib', path));
-                    paths.push(fs.pathJoin(requireDir, 'modules', path));
-                }
-                paths.forEach(function _forEach(testPath) {
-                    fileGuesses.push.apply(fileGuesses, [
-                        testPath,
-                        testPath + '.js',
-                        testPath + '.coffee',
-                        fs.pathJoin(testPath, 'index.js'),
-                        fs.pathJoin(testPath, 'index.coffee'),
-                        fs.pathJoin(testPath, 'lib', fs.basename(testPath) + '.js'),
-                        fs.pathJoin(testPath, 'lib', fs.basename(testPath) + '.coffee')
-                    ]);
-                });
-                file = null;
-                for (i = 0; i < fileGuesses.length && !file; ++i) {
-                    if (fs.isFile(fileGuesses[i])) {
-                        file = fileGuesses[i];
-                    }
-                }
-                if (!file) {
-                    throw new Error("CasperJS couldn't find module " + path);
-                }
-                if (file in requireCache) {
-                    return requireCache[file].exports;
-                }
-                var scriptCode = phantom.getScriptCode(file);
-                var fn = new Function('__file__', 'require', 'module', 'exports', scriptCode);
-                try {
-                    fn(file, _require, module, module.exports);
-                } catch (e) {
-                    var error = new global.CasperError('__mod_error(' + path + '):: ' + e);
-                    error.file = file;
-                    throw error;
-                }
-                requireCache[file] = module;
-                return module.exports;
-            };
-        })(require, phantom.casperPath);
-
-        // BC < 0.6
-        phantom.Casper = require('casper').Casper;
+        // patch require
+        global.require = patchRequire(global.require, [phantom.casperPath, fs.workingDirectory]);
 
         // casper cli args
-        phantom.casperArgs = require('cli').parse(phantom.args);
+        phantom.casperArgs = global.require('cli').parse(phantom.args);
 
         // loaded status
         phantom.casperLoaded = true;
@@ -243,13 +289,23 @@ if (!phantom || phantom.version.major !== 1 || phantom.version.minor < 5) {
      */
     phantom.initCasperCli = function initCasperCli() {
         var fs = require("fs");
+        var baseTestsPath = fs.pathJoin(phantom.casperPath, 'tests');
 
         if (!!phantom.casperArgs.options.version) {
             console.log(phantom.casperVersion.toString());
-            phantom.exit(0);
+            return phantom.exit();
         } else if (phantom.casperArgs.get(0) === "test") {
-            phantom.casperScript = fs.absolute(fs.pathJoin(phantom.casperPath, 'tests', 'run.js'));
+            phantom.casperScript = fs.absolute(fs.pathJoin(baseTestsPath, 'run.js'));
+            phantom.casperTest = true;
             phantom.casperArgs.drop("test");
+        } else if (phantom.casperArgs.get(0) === "selftest") {
+            phantom.casperScript = fs.absolute(fs.pathJoin(baseTestsPath, 'run.js'));
+            phantom.casperSelfTest = phantom.casperTest = true;
+            phantom.casperArgs.options.includes = fs.pathJoin(baseTestsPath, 'selftest.js');
+            if (phantom.casperArgs.args.length <= 1) {
+                phantom.casperArgs.args.push(fs.pathJoin(baseTestsPath, 'suites'));
+            }
+            phantom.casperArgs.drop("selftest");
         } else if (phantom.casperArgs.args.length === 0 || !!phantom.casperArgs.options.help) {
             var phantomVersion = [phantom.version.major, phantom.version.minor, phantom.version.patch].join('.');
             var f = require("utils").format;
@@ -257,17 +313,16 @@ if (!phantom || phantom.version.major !== 1 || phantom.version.minor < 5) {
                         phantom.casperVersion.toString(),
                         phantom.casperPath, phantomVersion));
             console.log(fs.read(fs.pathJoin(phantom.casperPath, 'bin', 'usage.txt')));
-            phantom.exit(0);
+            return phantom.exit(0);
         }
 
-
         if (!phantom.casperScript) {
             phantom.casperScript = phantom.casperArgs.get(0);
         }
 
         if (!fs.isFile(phantom.casperScript)) {
             console.error('Unable to open file: ' + phantom.casperScript);
-            phantom.exit(1);
+            return phantom.exit(1);
         }
 
         // filter out the called script name from casper args
@@ -278,15 +333,10 @@ if (!phantom || phantom.version.major !== 1 || phantom.version.minor < 5) {
     };
 
     if (!phantom.casperLoaded) {
-        try {
-            phantom.loadCasper();
-        } catch (e) {
-            console.error("Unable to load casper environment: " + e);
-            phantom.exit();
-        }
+        phantom.loadCasper();
     }
 
     if (true === phantom.casperArgs.get('cli')) {
         phantom.initCasperCli();
     }
-})(window);
+}

data/bin/casperjs

@@ -0,0 +1,84 @@
+#!/usr/bin/env python
+
+import json
+import os
+import subprocess
+import sys
+
+def test_cmd(cmd):
+    try:
+        return subprocess.check_output([__file__] + cmd.split(' '))
+    except subprocess.CalledProcessError as err:
+        sys.stderr.write('FAIL: %s\n' % ' '.join(err.cmd))
+        sys.stderr.write('      %s\n' % err.output)
+        sys.exit(1)
+
+def resolve(path):
+    if os.path.islink(path):
+        path = os.path.join(os.path.dirname(path), os.readlink(path))
+        return resolve(path)
+    return path
+
+PHANTOMJS_NATIVE_ARGS = [
+    'cookies-file',
+    'config',
+    'debug',
+    'disk-cache',
+    'ignore-ssl-errors',
+    'load-images',
+    'load-plugins',
+    'local-storage-path',
+    'local-storage-quota',
+    'local-to-remote-url-access',
+    'max-disk-cache-size',
+    'output-encoding',
+    'proxy',
+    'proxy-auth',
+    'proxy-type',
+    'remote-debugger-port',
+    'remote-debugger-autorun',
+    'script-encoding',
+    'web-security',
+]
+CASPER_ARGS = []
+CASPER_PATH = os.path.abspath(os.path.join(os.path.dirname(resolve(__file__)), '..'))
+PHANTOMJS_ARGS = []
+SYS_ARGS = sys.argv[1:]
+
+if len(SYS_ARGS) and SYS_ARGS[0] == '__selfcommandtest':
+    print('Starting Python executable tests...')
+    pkg_version = json.loads(open('package.json').read()).get('version')
+    scripts_path = os.path.join(CASPER_PATH, 'tests', 'commands')
+    assert(test_cmd('--help').find(pkg_version) > -1)
+    assert(test_cmd('--version').strip() == pkg_version)
+    assert(test_cmd(os.path.join(scripts_path, 'script.js')) == 'it works\n')
+    test_output = test_cmd('test --no-colors ' + os.path.join(scripts_path, 'mytest.js'))
+    assert('PASS ok1' in test_output)
+    assert('PASS ok2' in test_output)
+    assert('PASS ok3' in test_output)
+    print('Python executable tests passed.')
+    sys.exit(0)
+
+for arg in SYS_ARGS:
+    found = False
+    for native in PHANTOMJS_NATIVE_ARGS:
+        if arg.startswith('--%s' % native):
+            PHANTOMJS_ARGS.append(arg)
+            found = True
+    if not found:
+        CASPER_ARGS.append(arg)
+
+CASPER_COMMAND = os.environ.get('PHANTOMJS_EXECUTABLE', 'phantomjs').split(' ')
+CASPER_COMMAND.extend(PHANTOMJS_ARGS)
+CASPER_COMMAND.extend([
+    os.path.join(CASPER_PATH, 'bin', 'bootstrap.js'),
+    '--casper-path=%s' % CASPER_PATH,
+    '--cli'
+])
+CASPER_COMMAND.extend(CASPER_ARGS)
+
+try:
+    os.execvp(CASPER_COMMAND[0], CASPER_COMMAND)
+except OSError as err:
+    print(('Fatal: %s; did you install phantomjs?' % err))
+    sys.exit(1)

data/bin/usage.txt

@@ -1,10 +1,11 @@
 
 Usage: casperjs [options] script.[js|coffee] [script argument [script argument ...]]
        casperjs [options] test [test path [test path ...]]
+       casperjs [options] selftest
 
 Options:
 
 --help      Prints this help
 --version   Prints out CasperJS version
 
-Read the docs http://casperjs.org/
+Read the docs http://casperjs.org/