poltergeist 0.5.0 → 0.6.0

data/README.md

@@ -1,6 +1,6 @@
 # Poltergeist - A PhantomJS driver for Capybara #
 
-Version: 0.5.0
+Version: 0.6.0
 
 [![Build Status](https://secure.travis-ci.org/jonleighton/poltergeist.png)](http://travis-ci.org/jonleighton/poltergeist)
 [![Dependency Status](https://gemnasium.com/jonleighton/poltergeist.png)](https://gemnasium.com/jonleighton/poltergeist)
@@ -42,59 +42,59 @@ this doesn't affect you.
 
 ## Installing PhantomJS ##
 
-You need PhantomJS 1.4.1+, built against Qt 4.8, on your system.
+You need PhantomJS 1.5.0. There are no other dependencies (you don't
+need Qt, or Xvfb, etc.)
 
-### Pre-built binaries ##
+### Mac ###
 
-There are [pre-built
-binaries](http://code.google.com/p/phantomjs/downloads/list) of
-PhantomJS for Linux, Mac and Windows. This is the easiest and best way
-to install it. The binaries including a patched version of Qt 4.8 so you
-don't need to install that separately.
+* *With homebrew*: `brew install phantomjs`
+* *Without homebrew*: [Download this](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.5.0-macosx-static.zip&can=2&q=)
 
-Note that if you have a 'dynamic' package, it's important to maintain
-the relationship between `bin/phantomjs` and `lib/`. This is because the
-`bin/phantomjs` binary looks in `../lib/` for its library files. So the
-best thing to do is to link (rather than copy) it into your `PATH`:
+### Linux ###
 
-    ln -s /path/to/phantomjs/bin/phantomjs /usr/local/bin/phantomjs
+* Download the [32
+bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.5.0-linux-x86-dynamic.tar.gz&can=2&q=)
+or [64
+bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.5.0-linux-x86_64-dynamic.tar.gz&can=2&q=)
+binary.
+* Extract it: `sudo tar xvzf phantomjs-1.5.0-linux-*-dynamic.tar.gz -C /usr/local`
+* Link it: `sudo ln -s /usr/local/phantomjs/bin/phantomjs /usr/local/bin/phantomjs`
 
-### Compiling PhantomJS ###
+(Note that you cannot copy the `/usr/local/phantomjs/bin/phantomjs`
+binary elsewhere on its own as it dynamically links with other files in
+`/usr/local/phantomjs/lib`.)
 
-If you're having trouble with a pre-built binary package, you can
-compile PhantomJS yourself. PhantomJS must be built against Qt 4.8, and
-some patches must be applied, so note that you cannot build it against
-your system install of Qt.
+### Manual compilation ###
 
-[Download the tarball](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.4.1-source.tar.gz&can=2&q=)
-and run either `deploy/build-linux.sh --qt-4.8` or `cd deploy; ./build-mac.sh`.
-The script will
-download Qt, apply some patches, build it, and then build PhantomJS
-against the patched build of Qt. It takes quite a while, around 30
-minutes on a modern computer with two hyperthreaded cores. Afterwards,
-you should copy (or link) the `bin/phantomjs` binary into your `PATH`.
+Do this as a last resort if the binaries don't work for you. It will
+take quite a long time as it has to build WebKit.
 
-## Running on a CI ##
+* Download [the source tarball](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.5.0-source.tar.gz&can=2&q=)
+* Extract and cd in
+* `./build.sh`
 
-Currently PhantomJS is not yet 'truly headless' (but that's planned for the future),
-so to run it on a continuous integration
-server you will need to install [Xvfb](http://en.wikipedia.org/wiki/Xvfb).
+## Compatibility ##
 
-### On any generic server ###
+Supported: MRI 1.8.7, MRI 1.9.2, MRI 1.9.3, JRuby 1.8, JRuby 1.9.
 
-Install PhantomJS and invoke your tests with `xvfb-run`, (e.g. `xvfb-run
-rake`).
+Not supported:
 
-### Using [Travis CI](http://travis-ci.org/) ###
+* Rubinius (due to some unknown socket related issues)
+* Windows
 
-Travis CI has PhantomJS installed already! So all you need to do is add
-the following to your `.travis.yml`:
+Contributions are welcome in order to move 'unsupported'
+items into the 'supported' list.
 
-``` yaml
-before_script:
-  - "export DISPLAY=:99.0"
-  - "sh -e /etc/init.d/xvfb start"
-```
+## Running on a CI ##
+
+There are no special steps to take. You don't need Xvfb or any running X
+server at all.
+
+[Travis CI](http://travis-ci.org/) has PhantomJS 1.5.0 installed.
+
+You may like to use their [chef
+cookbook](https://github.com/travis-ci/travis-cookbooks/tree/master/ci_environment/phantomjs)
+on your own servers.
 
 ## What's supported? ##
 
@@ -117,6 +117,19 @@ the entire page, use `page.driver.render('/path/to/file.png', :full => true)`.
 Sometimes the window size is important to how things are rendered. Poltergeist sets the window
 size to 1024x768 by default, but you can set this yourself with `page.driver.resize(width, height)`.
 
+### Remote debugging (experimental) ###
+
+If you use the `:inspector => true` option (see below), remote debugging
+will be enabled.
+
+When this option is enabled, you can insert `page.driver.debug` into
+your tests to pause the test and launch a browser which gives you the
+WebKit inspector to view your test run with.
+
+(This feature is considered experimental - it needs more polish
+and [apparently will only work on
+Linux](http://code.google.com/p/phantomjs/issues/detail?id=430).)
+
 ## Customization ##
 
 You can customize the way that Capybara sets up Poltegeist via the following code in your
@@ -136,6 +149,7 @@ end
 *   `:timeout` (Numeric) - The number of seconds we'll wait for a response
     when communicating with PhantomJS. `nil` means wait forever. Default
     is 30.
+*   `:inspector` (Boolean, String) - See 'Remote Debugging', above.
 
 ## Bugs ##
 
@@ -143,20 +157,6 @@ Please file bug reports on Github and include example code to reproduce the prob
 possible. (Tests are even better.) Please also provide the output with
 `:debug` turned on, and screenshots if you think it's relevant.
 
-## Differences from [capybara-webkit](https://github.com/thoughtbot/capybara-webkit) ##
-
-Poltergeist is similar to capybara-webkit, but here are the key
-differences:
-
-*   It's more hackable. Poltergeist is written in Ruby + CoffeeScript.
-    We only have to worry about C++ when dealing with issues in
-    PhantomJS itself. In contrast, the majority of capybara-webkit is
-    written in C++.
-
-*   We're able to tap into the PhantomJS community. When PhantomJS
-    improves, Poltergeist improves. User's don't have to install Qt
-    because self-contained PhantomJS binary packages are available.
-
 ## Hacking ##
 
 Contributions are very welcome and I will happily give commit access to
@@ -173,6 +173,13 @@ makes debugging easier). Running `rake autocompile` will watch the
 
 ## Changes ##
 
+### 0.6.0 ###
+
+#### Features ####
+
+*   Updated to PhantomJS 1.5.0, giving us proper support for reporting
+    Javascript exception backtraces.
+
 ### 0.5.0 ###
 
 #### Features ####
@@ -199,6 +206,8 @@ makes debugging easier). Running `rake autocompile` will watch the
 *   Errors produced by Javascript on the page will now generate an
     exception within Ruby. [Issue #27]
 
+*   JRuby support. [Issue #20]
+
 #### Bug fixes ####
 
 *   Fix bug where we could end up interacting with an obsolete element. [Issue #30]

data/lib/capybara/poltergeist/client.rb

@@ -1,7 +1,7 @@
 module Capybara::Poltergeist
   class Client
     PHANTOMJS_SCRIPT  = File.expand_path('../client/compiled/main.js', __FILE__)
-    PHANTOMJS_VERSION = '1.4.1'
+    PHANTOMJS_VERSION = '1.5.0'
     PHANTOMJS_NAME    = 'phantomjs'
 
     def self.start(*args)

data/lib/capybara/poltergeist/client/agent.coffee

@@ -8,10 +8,7 @@ class PoltergeistAgent
     this.pushWindow(window)
 
   externalCall: (name, arguments) ->
-    try
-      { value: this[name].apply(this, arguments) }
-    catch error
-      { error: error.toString() }
+    { value: this[name].apply(this, arguments) }
 
   pushWindow: (new_window) ->
     @windows.push(new_window)

data/lib/capybara/poltergeist/client/browser.coffee

@@ -29,11 +29,25 @@ class Poltergeist.Browser
     else
       @owner.sendResponse(response)
 
-  node: (page_id, id) ->
+  getNode: (page_id, id, callback) ->
     if page_id == @page_id
-      @page.get(id)
+      callback.call this, @page.get(id)
     else
-      throw new Poltergeist.ObsoleteNode
+      @owner.sendError(new Poltergeist.ObsoleteNode)
+
+  nodeCall: (page_id, id, fn, args...) ->
+    callback = args.pop()
+
+    this.getNode(
+      page_id, id,
+      (node) ->
+        result = node[fn](args...)
+
+        if result instanceof Poltergeist.ObsoleteNode
+          @owner.sendError(result)
+        else
+          callback.call(this, result, node)
+    )
 
   visit: (url) ->
     @state = 'loading'
@@ -52,20 +66,19 @@ class Poltergeist.Browser
     this.sendResponse(page_id: @page_id, ids: @page.find(selector))
 
   find_within: (page_id, id, selector) ->
-    this.sendResponse this.node(page_id, id).find(selector)
+    this.nodeCall(page_id, id, 'find', selector, this.sendResponse)
 
   text: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).text()
+    this.nodeCall(page_id, id, 'text', this.sendResponse)
 
   attribute: (page_id, id, name) ->
-    this.sendResponse this.node(page_id, id).getAttribute(name)
+    this.nodeCall(page_id, id, 'getAttribute', name, this.sendResponse)
 
   value: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).value()
+    this.nodeCall(page_id, id, 'value', this.sendResponse)
 
   set: (page_id, id, value) ->
-    this.node(page_id, id).set(value)
-    this.sendResponse(true)
+    this.nodeCall(page_id, id, 'set', value, -> this.sendResponse(true))
 
   # PhantomJS only allows us to reference the element by CSS selector, not XPath,
   # so we have to add an attribute to the element to identify it, then remove it
@@ -75,28 +88,28 @@ class Poltergeist.Browser
   # by temporarily changing it to a single-file input. This obviously could break
   # things in various ways, which is not ideal, but it works in the simplest case.
   select_file: (page_id, id, value) ->
-    element = this.node(page_id, id)
-
-    multiple = element.isMultiple()
+    this.nodeCall(
+      page_id, id, 'isMultiple',
+      (multiple, node) ->
+        node.removeAttribute('multiple') if multiple
+        node.setAttribute('_poltergeist_selected', '')
 
-    element.removeAttribute('multiple') if multiple
-    element.setAttribute('_poltergeist_selected', '')
+        @page.uploadFile('[_poltergeist_selected]', value)
 
-    @page.uploadFile('[_poltergeist_selected]', value)
+        node.removeAttribute('_poltergeist_selected')
+        node.setAttribute('multiple', 'multiple') if multiple
 
-    element.removeAttribute('_poltergeist_selected')
-    element.setAttribute('multiple', 'multiple') if multiple
-
-    this.sendResponse(true)
+        this.sendResponse(true)
+    )
 
   select: (page_id, id, value) ->
-    this.sendResponse this.node(page_id, id).select(value)
+    this.nodeCall(page_id, id, 'select', value, this.sendResponse)
 
   tag_name: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).tagName()
+    this.nodeCall(page_id, id, 'tagName', this.sendResponse)
 
   visible: (page_id, id) ->
-    this.sendResponse this.node(page_id, id).isVisible()
+    this.nodeCall(page_id, id, 'isVisible', this.sendResponse)
 
   evaluate: (script) ->
     this.sendResponse JSON.parse(@page.evaluate("function() { return JSON.stringify(#{script}) }"))
@@ -114,30 +127,43 @@ class Poltergeist.Browser
     this.sendResponse(true)
 
   click: (page_id, id) ->
-    # If the click event triggers onLoadStarted, we will transition to the 'loading'
-    # state and wait for onLoadFinished before sending a response.
-    @state = 'clicked'
-
-    this.node(page_id, id).click()
-
-    # Use a timeout in order to let the stack clear, so that the @page.onLoadStarted
-    # callback can (possibly) fire, before we decide whether to send a response.
-    setTimeout(
-      =>
-        if @state == 'clicked'
-          @state = 'default'
-          this.sendResponse(true)
-      ,
-      10
+    # We just check the node is not obsolete before proceeding. If it is,
+    # the callback will not fire.
+    this.nodeCall(
+      page_id, id, 'isObsolete',
+      (obsolete, node) ->
+        # If the click event triggers onLoadStarted, we will transition to the 'loading'
+        # state and wait for onLoadFinished before sending a response.
+        @state = 'clicked'
+
+        click = node.click()
+
+        # Use a timeout in order to let the stack clear, so that the @page.onLoadStarted
+        # callback can (possibly) fire, before we decide whether to send a response.
+        setTimeout(
+          =>
+            if @state == 'clicked'
+              @state = 'default'
+
+              if click instanceof Poltergeist.ClickFailed
+                @owner.sendError(click)
+              else
+                this.sendResponse(true)
+          ,
+          10
+        )
     )
 
   drag: (page_id, id, other_id) ->
-    this.node(page_id, id).dragTo(@page.get(other_id))
-    this.sendResponse(true)
+    this.nodeCall(
+      page_id, id, 'isObsolete'
+      (obsolete, node) ->
+        node.dragTo(@page.get(other_id))
+        this.sendResponse(true)
+    )
 
   trigger: (page_id, id, event) ->
-    this.node(page_id, id).trigger(event)
-    this.sendResponse(event)
+    this.nodeCall(page_id, id, 'trigger', event, -> this.sendResponse(event))
 
   reset: ->
     this.resetPage()

data/lib/capybara/poltergeist/client/compiled/agent.js

@@ -8,15 +8,9 @@ PoltergeistAgent = (function() {
     this.pushWindow(window);
   }
   PoltergeistAgent.prototype.externalCall = function(name, arguments) {
-    try {
-      return {
-        value: this[name].apply(this, arguments)
-      };
-    } catch (error) {
-      return {
-        error: error.toString()
-      };
-    }
+    return {
+      value: this[name].apply(this, arguments)
+    };
   };
   PoltergeistAgent.prototype.pushWindow = function(new_window) {
     this.windows.push(new_window);

data/lib/capybara/poltergeist/client/compiled/browser.js

@@ -1,4 +1,4 @@
-var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
+var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; }, __slice = Array.prototype.slice;
 Poltergeist.Browser = (function() {
   function Browser(owner) {
     this.owner = owner;
@@ -36,13 +36,27 @@ Poltergeist.Browser = (function() {
       return this.owner.sendResponse(response);
     }
   };
-  Browser.prototype.node = function(page_id, id) {
+  Browser.prototype.getNode = function(page_id, id, callback) {
     if (page_id === this.page_id) {
-      return this.page.get(id);
+      return callback.call(this, this.page.get(id));
     } else {
-      throw new Poltergeist.ObsoleteNode;
+      return this.owner.sendError(new Poltergeist.ObsoleteNode);
     }
   };
+  Browser.prototype.nodeCall = function() {
+    var args, callback, fn, id, page_id;
+    page_id = arguments[0], id = arguments[1], fn = arguments[2], args = 4 <= arguments.length ? __slice.call(arguments, 3) : [];
+    callback = args.pop();
+    return this.getNode(page_id, id, function(node) {
+      var result;
+      result = node[fn].apply(node, args);
+      if (result instanceof Poltergeist.ObsoleteNode) {
+        return this.owner.sendError(result);
+      } else {
+        return callback.call(this, result, node);
+      }
+    });
+  };
   Browser.prototype.visit = function(url) {
     this.state = 'loading';
     return this.page.open(url);
@@ -63,44 +77,44 @@ Poltergeist.Browser = (function() {
     });
   };
   Browser.prototype.find_within = function(page_id, id, selector) {
-    return this.sendResponse(this.node(page_id, id).find(selector));
+    return this.nodeCall(page_id, id, 'find', selector, this.sendResponse);
   };
   Browser.prototype.text = function(page_id, id) {
-    return this.sendResponse(this.node(page_id, id).text());
+    return this.nodeCall(page_id, id, 'text', this.sendResponse);
   };
   Browser.prototype.attribute = function(page_id, id, name) {
-    return this.sendResponse(this.node(page_id, id).getAttribute(name));
+    return this.nodeCall(page_id, id, 'getAttribute', name, this.sendResponse);
   };
   Browser.prototype.value = function(page_id, id) {
-    return this.sendResponse(this.node(page_id, id).value());
+    return this.nodeCall(page_id, id, 'value', this.sendResponse);
   };
   Browser.prototype.set = function(page_id, id, value) {
-    this.node(page_id, id).set(value);
-    return this.sendResponse(true);
+    return this.nodeCall(page_id, id, 'set', value, function() {
+      return this.sendResponse(true);
+    });
   };
   Browser.prototype.select_file = function(page_id, id, value) {
-    var element, multiple;
-    element = this.node(page_id, id);
-    multiple = element.isMultiple();
-    if (multiple) {
-      element.removeAttribute('multiple');
-    }
-    element.setAttribute('_poltergeist_selected', '');
-    this.page.uploadFile('[_poltergeist_selected]', value);
-    element.removeAttribute('_poltergeist_selected');
-    if (multiple) {
-      element.setAttribute('multiple', 'multiple');
-    }
-    return this.sendResponse(true);
+    return this.nodeCall(page_id, id, 'isMultiple', function(multiple, node) {
+      if (multiple) {
+        node.removeAttribute('multiple');
+      }
+      node.setAttribute('_poltergeist_selected', '');
+      this.page.uploadFile('[_poltergeist_selected]', value);
+      node.removeAttribute('_poltergeist_selected');
+      if (multiple) {
+        node.setAttribute('multiple', 'multiple');
+      }
+      return this.sendResponse(true);
+    });
   };
   Browser.prototype.select = function(page_id, id, value) {
-    return this.sendResponse(this.node(page_id, id).select(value));
+    return this.nodeCall(page_id, id, 'select', value, this.sendResponse);
   };
   Browser.prototype.tag_name = function(page_id, id) {
-    return this.sendResponse(this.node(page_id, id).tagName());
+    return this.nodeCall(page_id, id, 'tagName', this.sendResponse);
   };
   Browser.prototype.visible = function(page_id, id) {
-    return this.sendResponse(this.node(page_id, id).isVisible());
+    return this.nodeCall(page_id, id, 'isVisible', this.sendResponse);
   };
   Browser.prototype.evaluate = function(script) {
     return this.sendResponse(JSON.parse(this.page.evaluate("function() { return JSON.stringify(" + script + ") }")));
@@ -118,22 +132,32 @@ Poltergeist.Browser = (function() {
     return this.sendResponse(true);
   };
   Browser.prototype.click = function(page_id, id) {
-    this.state = 'clicked';
-    this.node(page_id, id).click();
-    return setTimeout(__bind(function() {
-      if (this.state === 'clicked') {
-        this.state = 'default';
-        return this.sendResponse(true);
-      }
-    }, this), 10);
+    return this.nodeCall(page_id, id, 'isObsolete', function(obsolete, node) {
+      var click;
+      this.state = 'clicked';
+      click = node.click();
+      return setTimeout(__bind(function() {
+        if (this.state === 'clicked') {
+          this.state = 'default';
+          if (click instanceof Poltergeist.ClickFailed) {
+            return this.owner.sendError(click);
+          } else {
+            return this.sendResponse(true);
+          }
+        }
+      }, this), 10);
+    });
   };
   Browser.prototype.drag = function(page_id, id, other_id) {
-    this.node(page_id, id).dragTo(this.page.get(other_id));
-    return this.sendResponse(true);
+    return this.nodeCall(page_id, id, 'isObsolete', function(obsolete, node) {
+      node.dragTo(this.page.get(other_id));
+      return this.sendResponse(true);
+    });
   };
   Browser.prototype.trigger = function(page_id, id, event) {
-    this.node(page_id, id).trigger(event);
-    return this.sendResponse(event);
+    return this.nodeCall(page_id, id, 'trigger', event, function() {
+      return this.sendResponse(event);
+    });
   };
   Browser.prototype.reset = function() {
     this.resetPage();

data/lib/capybara/poltergeist/client/compiled/main.js

@@ -1,41 +1,77 @@
 var Poltergeist;
+var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; }, __hasProp = Object.prototype.hasOwnProperty, __extends = function(child, parent) {
+  for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; }
+  function ctor() { this.constructor = child; }
+  ctor.prototype = parent.prototype;
+  child.prototype = new ctor;
+  child.__super__ = parent.prototype;
+  return child;
+};
 Poltergeist = (function() {
   function Poltergeist(port) {
+    this.onError = __bind(this.onError, this);
+    var that;
     this.browser = new Poltergeist.Browser(this);
     this.connection = new Poltergeist.Connection(this, port);
+    that = this;
+    phantom.onError = function(message, stack) {
+      return that.onError(message, stack);
+    };
+    this.running = false;
   }
   Poltergeist.prototype.runCommand = function(command) {
-    try {
-      return this.browser[command.name].apply(this.browser, command.args);
-    } catch (error) {
-      return this.sendError(error);
-    }
+    this.running = true;
+    return this.browser[command.name].apply(this.browser, command.args);
   };
   Poltergeist.prototype.sendResponse = function(response) {
-    return this.connection.send({
+    return this.send({
       response: response
     });
   };
   Poltergeist.prototype.sendError = function(error) {
-    return this.connection.send({
+    return this.send({
       error: {
         name: error.name || 'Generic',
         args: error.args && error.args() || [error.toString()]
       }
     });
   };
+  Poltergeist.prototype.onError = function(message, stack) {
+    if (message === 'PoltergeistAgent.ObsoleteNode') {
+      return this.sendError(new Poltergeist.ObsoleteNode);
+    } else {
+      return this.sendError(new Poltergeist.BrowserError(message, stack));
+    }
+  };
+  Poltergeist.prototype.send = function(data) {
+    if (this.running) {
+      this.connection.send(data);
+      return this.running = false;
+    }
+  };
   return Poltergeist;
 })();
 window.Poltergeist = Poltergeist;
+Poltergeist.Error = (function() {
+  function Error() {}
+  return Error;
+})();
 Poltergeist.ObsoleteNode = (function() {
-  function ObsoleteNode() {}
+  __extends(ObsoleteNode, Poltergeist.Error);
+  function ObsoleteNode() {
+    ObsoleteNode.__super__.constructor.apply(this, arguments);
+  }
   ObsoleteNode.prototype.name = "Poltergeist.ObsoleteNode";
   ObsoleteNode.prototype.args = function() {
     return [];
   };
+  ObsoleteNode.prototype.toString = function() {
+    return this.name;
+  };
   return ObsoleteNode;
 })();
 Poltergeist.ClickFailed = (function() {
+  __extends(ClickFailed, Poltergeist.Error);
   function ClickFailed(selector, position) {
     this.selector = selector;
     this.position = position;
@@ -47,6 +83,7 @@ Poltergeist.ClickFailed = (function() {
   return ClickFailed;
 })();
 Poltergeist.JavascriptError = (function() {
+  __extends(JavascriptError, Poltergeist.Error);
   function JavascriptError(errors) {
     this.errors = errors;
   }
@@ -56,8 +93,20 @@ Poltergeist.JavascriptError = (function() {
   };
   return JavascriptError;
 })();
-phantom.injectJs('web_page.js');
-phantom.injectJs('node.js');
-phantom.injectJs('connection.js');
-phantom.injectJs('browser.js');
+Poltergeist.BrowserError = (function() {
+  __extends(BrowserError, Poltergeist.Error);
+  function BrowserError(message, stack) {
+    this.message = message;
+    this.stack = stack;
+  }
+  BrowserError.prototype.name = "Poltergeist.BrowserError";
+  BrowserError.prototype.args = function() {
+    return [this.message, this.stack];
+  };
+  return BrowserError;
+})();
+phantom.injectJs("" + phantom.libraryPath + "/web_page.js");
+phantom.injectJs("" + phantom.libraryPath + "/node.js");
+phantom.injectJs("" + phantom.libraryPath + "/connection.js");
+phantom.injectJs("" + phantom.libraryPath + "/browser.js");
 new Poltergeist(phantom.args[0]);

data/lib/capybara/poltergeist/client/compiled/node.js

@@ -1,7 +1,7 @@
 var __slice = Array.prototype.slice, __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
 Poltergeist.Node = (function() {
   var name, _fn, _i, _len, _ref;
-  Node.DELEGATES = ['text', 'getAttribute', 'value', 'set', 'setAttribute', 'removeAttribute', 'isMultiple', 'select', 'tagName', 'find', 'isVisible', 'position', 'trigger', 'parentId', 'clickTest'];
+  Node.DELEGATES = ['text', 'getAttribute', 'value', 'set', 'setAttribute', 'isObsolete', 'removeAttribute', 'isMultiple', 'select', 'tagName', 'find', 'isVisible', 'position', 'trigger', 'parentId', 'clickTest'];
   function Node(page, id) {
     this.page = page;
     this.id = id;
@@ -64,7 +64,7 @@ Poltergeist.Node = (function() {
     if (test.status === 'success') {
       return this.page.sendEvent('click', pos.x, pos.y);
     } else {
-      throw new Poltergeist.ClickFailed(test.selector, pos);
+      return new Poltergeist.ClickFailed(test.selector, pos);
     }
   };
   Node.prototype.dragTo = function(other) {

data/lib/capybara/poltergeist/client/compiled/web_page.js

@@ -1,7 +1,7 @@
 var __slice = Array.prototype.slice, __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
 Poltergeist.WebPage = (function() {
   var command, delegate, _fn, _fn2, _i, _j, _len, _len2, _ref, _ref2;
-  WebPage.CALLBACKS = ['onAlert', 'onConsoleMessage', 'onLoadFinished', 'onInitialized', 'onLoadStarted', 'onResourceRequested', 'onResourceReceived'];
+  WebPage.CALLBACKS = ['onAlert', 'onConsoleMessage', 'onLoadFinished', 'onInitialized', 'onLoadStarted', 'onResourceRequested', 'onResourceReceived', 'onError'];
   WebPage.DELEGATES = ['open', 'sendEvent', 'uploadFile', 'release', 'render'];
   WebPage.COMMANDS = ['currentUrl', 'find', 'nodeCall', 'pushFrame', 'popFrame', 'documentSize'];
   function WebPage() {
@@ -54,7 +54,7 @@ Poltergeist.WebPage = (function() {
     if (this.evaluate(function() {
       return typeof __poltergeist;
     }) === "undefined") {
-      this["native"].injectJs('agent.js');
+      this["native"].injectJs("" + phantom.libraryPath + "/agent.js");
       return this.nodes = {};
     }
   };
@@ -68,12 +68,16 @@ Poltergeist.WebPage = (function() {
     return this._source || (this._source = this["native"].content);
   };
   WebPage.prototype.onConsoleMessage = function(message, line, file) {
-    if (line === 0 && file === "undefined") {
-      return this._errors.push(message);
-    } else {
+    if (!(this._errors.length && this._errors[this._errors.length - 1].message === message)) {
       return console.log(message);
     }
   };
+  WebPage.prototype.onErrorNative = function(message, stack) {
+    return this._errors.push({
+      message: message,
+      stack: stack
+    });
+  };
   WebPage.prototype.content = function() {
     return this["native"].content;
   };
@@ -178,17 +182,7 @@ Poltergeist.WebPage = (function() {
     result = this.evaluate(function(name, arguments) {
       return __poltergeist.externalCall(name, arguments);
     }, name, arguments);
-    if (result.error) {
-      switch (result.error) {
-        case "PoltergeistAgent.ObsoleteNode":
-          throw new Poltergeist.ObsoleteNode;
-          break;
-        default:
-          throw result.error;
-      }
-    } else {
-      return result.value;
-    }
+    return result && result.value;
   };
   return WebPage;
 }).call(this);

data/lib/capybara/poltergeist/client/main.coffee

@@ -3,44 +3,85 @@ class Poltergeist
     @browser    = new Poltergeist.Browser(this)
     @connection = new Poltergeist.Connection(this, port)
 
+    # The QtWebKit bridge doesn't seem to like Function.prototype.bind
+    that = this
+    phantom.onError = (message, stack) -> that.onError(message, stack)
+
+    @running = false
+
   runCommand: (command) ->
-    try
-      @browser[command.name].apply(@browser, command.args)
-    catch error
-      this.sendError(error)
+    @running = true
+    @browser[command.name].apply(@browser, command.args)
 
   sendResponse: (response) ->
-    @connection.send(response: response)
+    this.send(response: response)
 
   sendError: (error) ->
-    @connection.send(
+    this.send(
       error:
         name: error.name || 'Generic',
         args: error.args && error.args() || [error.toString()]
     )
 
+  # This is a bit of a mess. We can't wrap the runCommand code in
+  # a try ... catch, because that will prevent stack traces being
+  # reported, and there is no error.stack property.
+  #
+  # And thrown errors get toString() called, which becomes the
+  # value of the message variable here. So we can basically only
+  # use strings as exceptions at the moment, which means we throw
+  # exceptions with extra data and then retrieve it here.
+  #
+  # The solution will be for PhantomJS to support an e.stack
+  # property on exceptions.
+  #
+  # See http://code.google.com/p/phantomjs/issues/detail?id=166.
+  onError: (message, stack) =>
+    if message == 'PoltergeistAgent.ObsoleteNode'
+      this.sendError(new Poltergeist.ObsoleteNode)
+    else
+      this.sendError(new Poltergeist.BrowserError(message, stack))
+
+  send: (data) ->
+    # Prevents more than one response being sent for a single
+    # command. This can happen in some scenarios where an error
+    # is raised but the script can still continue.
+    if @running
+      @connection.send(data)
+      @running = false
+
 # This is necessary because the remote debugger will wrap the
 # script in a function, causing the Poltergeist variable to
 # become local.
 window.Poltergeist = Poltergeist
 
-class Poltergeist.ObsoleteNode
+class Poltergeist.Error
+
+class Poltergeist.ObsoleteNode extends Poltergeist.Error
   name: "Poltergeist.ObsoleteNode"
   args: -> []
+  toString: -> this.name
 
-class Poltergeist.ClickFailed
+class Poltergeist.ClickFailed extends Poltergeist.Error
   constructor: (@selector, @position) ->
   name: "Poltergeist.ClickFailed"
   args: -> [@selector, @position]
 
-class Poltergeist.JavascriptError
+class Poltergeist.JavascriptError extends Poltergeist.Error
   constructor: (@errors) ->
   name: "Poltergeist.JavascriptError"
   args: -> [@errors]
 
-phantom.injectJs('web_page.js')
-phantom.injectJs('node.js')
-phantom.injectJs('connection.js')
-phantom.injectJs('browser.js')
+class Poltergeist.BrowserError extends Poltergeist.Error
+  constructor: (@message, @stack) ->
+  name: "Poltergeist.BrowserError"
+  args: -> [@message, @stack]
+
+# We're using phantom.libraryPath so that any stack traces
+# report the full path.
+phantom.injectJs("#{phantom.libraryPath}/web_page.js")
+phantom.injectJs("#{phantom.libraryPath}/node.js")
+phantom.injectJs("#{phantom.libraryPath}/connection.js")
+phantom.injectJs("#{phantom.libraryPath}/browser.js")
 
 new Poltergeist(phantom.args[0])

data/lib/capybara/poltergeist/client/node.coffee

@@ -1,7 +1,7 @@
 # Proxy object for forwarding method calls to the node object inside the page.
 
 class Poltergeist.Node
-  @DELEGATES = ['text', 'getAttribute', 'value', 'set', 'setAttribute',
+  @DELEGATES = ['text', 'getAttribute', 'value', 'set', 'setAttribute', 'isObsolete',
                 'removeAttribute', 'isMultiple', 'select', 'tagName', 'find',
                 'isVisible', 'position', 'trigger', 'parentId', 'clickTest']
 
@@ -59,7 +59,7 @@ class Poltergeist.Node
     if test.status == 'success'
       @page.sendEvent('click', pos.x, pos.y)
     else
-      throw new Poltergeist.ClickFailed(test.selector, pos)
+      new Poltergeist.ClickFailed(test.selector, pos)
 
   dragTo: (other) ->
     position      = this.clickPosition()

data/lib/capybara/poltergeist/client/web_page.coffee

@@ -1,6 +1,7 @@
 class Poltergeist.WebPage
   @CALLBACKS = ['onAlert', 'onConsoleMessage', 'onLoadFinished', 'onInitialized',
-                'onLoadStarted', 'onResourceRequested', 'onResourceReceived']
+                'onLoadStarted', 'onResourceRequested', 'onResourceReceived',
+                'onError']
 
   @DELEGATES = ['open', 'sendEvent', 'uploadFile', 'release', 'render']
 
@@ -35,7 +36,7 @@ class Poltergeist.WebPage
 
   injectAgent: ->
     if this.evaluate(-> typeof __poltergeist) == "undefined"
-      @native.injectJs('agent.js')
+      @native.injectJs("#{phantom.libraryPath}/agent.js")
       @nodes = {}
 
   onConsoleMessageNative: (message) ->
@@ -47,14 +48,16 @@ class Poltergeist.WebPage
     @_source or= @native.content
 
   onConsoleMessage: (message, line, file) ->
-    if line == 0 && file == "undefined"
-      # file:line will always be "undefined:0" in current release of
-      # PhantomJS ;(
-      @_errors.push(message)
-    else
-      # here line == 1 && file == "". don't ask me why!
+    # The conditional works around a PhantomJS bug where an error can
+    # get wrongly reported to be onError and onConsoleMessage:
+    #
+    # http://code.google.com/p/phantomjs/issues/detail?id=166#c18
+    unless @_errors.length && @_errors[@_errors.length - 1].message == message
       console.log(message)
 
+  onErrorNative: (message, stack) ->
+    @_errors.push(message: message, stack: stack)
+
   content: ->
     @native.content
 
@@ -143,17 +146,13 @@ class Poltergeist.WebPage
       if result != false && that[name]? # For externally set callbacks
         that[name].apply(that, arguments)
 
+  # Any error raised here or inside the evaluate will get reported to
+  # phantom.onError. If result is null, that means there was an error
+  # inside the agent.
   runCommand: (name, arguments) ->
     result = this.evaluate(
       (name, arguments) -> __poltergeist.externalCall(name, arguments),
       name, arguments
     )
 
-    if result.error
-      switch result.error
-        when "PoltergeistAgent.ObsoleteNode"
-          throw new Poltergeist.ObsoleteNode
-        else
-          throw result.error
-    else
-      result.value
+    result && result.value

data/lib/capybara/poltergeist/errors.rb

@@ -11,30 +11,52 @@ module Capybara
       end
     end
 
+    class JSErrorItem
+      attr_reader :message, :stack
+
+      def initialize(message, stack)
+        @message = message
+        @stack   = stack
+      end
+
+      def to_s
+        message + "\n\n" + formatted_stack
+      end
+
+      private
+
+      def formatted_stack
+        stack = self.stack.map do |item|
+          s = "  #{item['file']}:#{item['line']}"
+          s << " in #{item['function']}" if item['function'] && !item['function'].empty?
+          s
+        end
+        stack.join("\n")
+      end
+    end
+
     class BrowserError < ClientError
       def name
         response['name']
       end
 
-      def text
-        response['args'].first
+      def javascript_error
+        JSErrorItem.new(*response['args'])
       end
 
       def message
-        "Received error from PhantomJS client: #{text}"
+        "There was an error inside the PhantomJS portion of Poltergeist:\n\n#{javascript_error}"
       end
     end
 
     class JavascriptError < ClientError
-      def javascript_messages
-        response['args'].first
+      def javascript_errors
+        response['args'].first.map { |data| JSErrorItem.new(data['message'], data['stack']) }
       end
 
       def message
-        "One or more errors were raised in the Javascript code on the page: #{javascript_messages.inspect} " \
-          "Unfortunately, it is not currently possible to provide a stack trace, or even the line/file where " \
-          "the error occurred. (This is due to lack of support within QtWebKit.) Fixing this is a high " \
-          "priority, but we're not there yet."
+        "One or more errors were raised in the Javascript code on the page:\n\n" +
+          javascript_errors.map(&:to_s).join("\n")
       end
     end
 

data/lib/capybara/poltergeist/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Poltergeist
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: poltergeist
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-18 00:00:00.000000000 Z
+date: 2012-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &20962640 !ruby/object:Gem::Requirement
+  requirement: &13258700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *20962640
+  version_requirements: *13258700
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &20960260 !ruby/object:Gem::Requirement
+  requirement: &13258160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *20960260
+  version_requirements: *13258160
 - !ruby/object:Gem::Dependency
   name: childprocess
-  requirement: &20958720 !ruby/object:Gem::Requirement
+  requirement: &13257680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.3'
   type: :runtime
   prerelease: false
-  version_requirements: *20958720
+  version_requirements: *13257680
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
-  requirement: &20957520 !ruby/object:Gem::Requirement
+  requirement: &13257220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *20957520
+  version_requirements: *13257220
 - !ruby/object:Gem::Dependency
   name: faye-websocket
-  requirement: &21890060 !ruby/object:Gem::Requirement
+  requirement: &13256720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,21 +68,21 @@ dependencies:
         version: 0.4.4
   type: :runtime
   prerelease: false
-  version_requirements: *21890060
+  version_requirements: *13256720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &21888340 !ruby/object:Gem::Requirement
+  requirement: &13255860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *21888340
+  version_requirements: *13255860
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &21886720 !ruby/object:Gem::Requirement
+  requirement: &13255300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,10 +90,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *21886720
+  version_requirements: *13255300
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &21886100 !ruby/object:Gem::Requirement
+  requirement: &13254740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -101,10 +101,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *21886100
+  version_requirements: *13254740
 - !ruby/object:Gem::Dependency
   name: image_size
-  requirement: &21212360 !ruby/object:Gem::Requirement
+  requirement: &13253860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -112,7 +112,7 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *21212360
+  version_requirements: *13253860
 description: PhantomJS driver for Capybara
 email:
 - j@jonathanleighton.com