poltergeist 0.4.0 → 0.5.0

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

@@ -7,8 +7,8 @@ Poltergeist.WebPage = (function() {
   function WebPage() {
     var callback, _i, _len, _ref;
     this["native"] = require('webpage').create();
-    this.nodes = {};
     this._source = "";
+    this._errors = [];
     this.setViewportSize({
       width: 1024,
       height: 768
@@ -54,7 +54,8 @@ Poltergeist.WebPage = (function() {
     if (this.evaluate(function() {
       return typeof __poltergeist;
     }) === "undefined") {
-      return this["native"].injectJs('agent.js');
+      this["native"].injectJs('agent.js');
+      return this.nodes = {};
     }
   };
   WebPage.prototype.onConsoleMessageNative = function(message) {
@@ -66,8 +67,12 @@ Poltergeist.WebPage = (function() {
   WebPage.prototype.onLoadFinishedNative = function() {
     return this._source || (this._source = this["native"].content);
   };
-  WebPage.prototype.onConsoleMessage = function(message) {
-    return console.log(message);
+  WebPage.prototype.onConsoleMessage = function(message, line, file) {
+    if (line === 0 && file === "undefined") {
+      return this._errors.push(message);
+    } else {
+      return console.log(message);
+    }
   };
   WebPage.prototype.content = function() {
     return this["native"].content;
@@ -75,6 +80,12 @@ Poltergeist.WebPage = (function() {
   WebPage.prototype.source = function() {
     return this._source;
   };
+  WebPage.prototype.errors = function() {
+    return this._errors;
+  };
+  WebPage.prototype.clearErrors = function() {
+    return this._errors = [];
+  };
   WebPage.prototype.viewportSize = function() {
     return this["native"].viewportSize;
   };
@@ -135,7 +146,7 @@ Poltergeist.WebPage = (function() {
   WebPage.prototype.evaluate = function() {
     var args, fn;
     fn = arguments[0], args = 2 <= arguments.length ? __slice.call(arguments, 1) : [];
-    return this["native"].evaluate("function() { return " + (this.stringifyCall(fn, args)) + " }");
+    return JSON.parse(this["native"].evaluate("function() { return JSON.stringify(" + (this.stringifyCall(fn, args)) + ") }"));
   };
   WebPage.prototype.execute = function() {
     var args, fn;
@@ -163,9 +174,21 @@ Poltergeist.WebPage = (function() {
     };
   };
   WebPage.prototype.runCommand = function(name, arguments) {
-    return this.evaluate(function(name, arguments) {
-      return __poltergeist[name].apply(__poltergeist, arguments);
+    var result;
+    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 WebPage;
 }).call(this);

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

@@ -7,13 +7,36 @@ class Poltergeist
     try
       @browser[command.name].apply(@browser, command.args)
     catch error
-      @connection.send({ error: error.toString() })
+      this.sendError(error)
 
   sendResponse: (response) ->
-    @connection.send({ response: response })
+    @connection.send(response: response)
+
+  sendError: (error) ->
+    @connection.send(
+      error:
+        name: error.name || 'Generic',
+        args: error.args && error.args() || [error.toString()]
+    )
+
+# 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
-  toString: -> "Poltergeist.ObsoleteNode"
+  name: "Poltergeist.ObsoleteNode"
+  args: -> []
+
+class Poltergeist.ClickFailed
+  constructor: (@selector, @position) ->
+  name: "Poltergeist.ClickFailed"
+  args: -> [@selector, @position]
+
+class Poltergeist.JavascriptError
+  constructor: (@errors) ->
+  name: "Poltergeist.JavascriptError"
+  args: -> [@errors]
 
 phantom.injectJs('web_page.js')
 phantom.injectJs('node.js')

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

@@ -1,26 +1,21 @@
 # Proxy object for forwarding method calls to the node object inside the page.
 
 class Poltergeist.Node
-  @DELEGATES = ['text', 'getAttribute', 'value', 'set', 'setAttribute', 'removeAttribute',
-                'isMultiple', 'select', 'tagName', 'isVisible', 'position', 'trigger', 'parentId']
+  @DELEGATES = ['text', 'getAttribute', 'value', 'set', 'setAttribute',
+                'removeAttribute', 'isMultiple', 'select', 'tagName', 'find',
+                'isVisible', 'position', 'trigger', 'parentId', 'clickTest']
 
   constructor: (@page, @id) ->
 
   parent: ->
     new Poltergeist.Node(@page, this.parentId())
 
-  isObsolete: ->
-    @page.nodeCall(@id, 'isObsolete')
-
   for name in @DELEGATES
     do (name) =>
       this.prototype[name] = (arguments...) ->
-        if this.isObsolete()
-          throw new Poltergeist.ObsoleteNode
-        else
-          @page.nodeCall(@id, name, arguments)
+        @page.nodeCall(@id, name, arguments)
 
-  scrollIntoView: ->
+  clickPosition: (scrollIntoView = true) ->
     dimensions = @page.validatedDimensions()
     document   = dimensions.document
     viewport   = dimensions.viewport
@@ -41,23 +36,35 @@ class Poltergeist.Node
           scroll[coord] + pos[coord] - viewport[measurement] + (viewport[measurement] / 2)
         )
 
-    adjust('left', 'width')
-    adjust('top',  'height')
+    if scrollIntoView
+      adjust('left', 'width')
+      adjust('top',  'height')
+
+      if scroll.left != dimensions.left || scroll.top != dimensions.top
+        @page.setScrollPosition(scroll)
+        pos = this.position()
 
-    if scroll.left != dimensions.left || scroll.top != dimensions.top
-      @page.setScrollPosition(scroll)
-      pos = this.position()
+    middle = (start, end, size) ->
+      start + ((Math.min(end, size) - start) / 2)
 
-    pos
+    {
+      x: middle(pos.left, pos.right,  viewport.width),
+      y: middle(pos.top,  pos.bottom, viewport.height)
+    }
 
   click: ->
-    position = this.scrollIntoView()
-    @page.sendEvent('click', position.left, position.top)
+    pos  = this.clickPosition()
+    test = this.clickTest(pos.x, pos.y)
+
+    if test.status == 'success'
+      @page.sendEvent('click', pos.x, pos.y)
+    else
+      throw new Poltergeist.ClickFailed(test.selector, pos)
 
   dragTo: (other) ->
-    position      = this.scrollIntoView()
-    otherPosition = other.position()
+    position      = this.clickPosition()
+    otherPosition = other.clickPosition(false)
 
-    @page.sendEvent('mousedown', position.left,      position.top)
-    @page.sendEvent('mousemove', otherPosition.left, otherPosition.top)
-    @page.sendEvent('mouseup',   otherPosition.left, otherPosition.top)
+    @page.sendEvent('mousedown', position.x,      position.y)
+    @page.sendEvent('mousemove', otherPosition.x, otherPosition.y)
+    @page.sendEvent('mouseup',   otherPosition.x, otherPosition.y)

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

@@ -1,13 +1,15 @@
 class Poltergeist.WebPage
   @CALLBACKS = ['onAlert', 'onConsoleMessage', 'onLoadFinished', 'onInitialized',
                 'onLoadStarted', 'onResourceRequested', 'onResourceReceived']
+
   @DELEGATES = ['open', 'sendEvent', 'uploadFile', 'release', 'render']
+
   @COMMANDS  = ['currentUrl', 'find', 'nodeCall', 'pushFrame', 'popFrame', 'documentSize']
 
   constructor: ->
     @native  = require('webpage').create()
-    @nodes   = {}
     @_source = ""
+    @_errors = []
 
     this.setViewportSize(width: 1024, height: 768)
 
@@ -29,11 +31,12 @@ class Poltergeist.WebPage
   onInitializedNative: ->
     @_source = null
     this.injectAgent()
-    this.setScrollPosition({ left: 0, top: 0 })
+    this.setScrollPosition(left: 0, top: 0)
 
   injectAgent: ->
     if this.evaluate(-> typeof __poltergeist) == "undefined"
       @native.injectJs('agent.js')
+      @nodes = {}
 
   onConsoleMessageNative: (message) ->
     if message == '__DOMContentLoaded'
@@ -43,8 +46,14 @@ class Poltergeist.WebPage
   onLoadFinishedNative: ->
     @_source or= @native.content
 
-  onConsoleMessage: (message) ->
-    console.log(message)
+  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!
+      console.log(message)
 
   content: ->
     @native.content
@@ -52,6 +61,12 @@ class Poltergeist.WebPage
   source: ->
     @_source
 
+  errors: ->
+    @_errors
+
+  clearErrors: ->
+    @_errors = []
+
   viewportSize: ->
     @native.viewportSize
 
@@ -104,7 +119,7 @@ class Poltergeist.WebPage
     @nodes[id] or= new Poltergeist.Node(this, id)
 
   evaluate: (fn, args...) ->
-    @native.evaluate("function() { return #{this.stringifyCall(fn, args)} }")
+    JSON.parse @native.evaluate("function() { return JSON.stringify(#{this.stringifyCall(fn, args)}) }")
 
   execute: (fn, args...) ->
     @native.evaluate("function() { #{this.stringifyCall(fn, args)} }")
@@ -129,7 +144,16 @@ class Poltergeist.WebPage
         that[name].apply(that, arguments)
 
   runCommand: (name, arguments) ->
-    this.evaluate(
-      (name, arguments) -> __poltergeist[name].apply(__poltergeist, 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

data/lib/capybara/poltergeist/driver.rb

@@ -1,34 +1,65 @@
 module Capybara::Poltergeist
   class Driver < Capybara::Driver::Base
-    attr_reader :app, :server, :browser, :options
+    DEFAULT_TIMEOUT = 30
+
+    attr_reader :app, :app_server, :server, :client, :browser, :options
 
     def initialize(app, options = {})
-      @app     = app
-      @options = options
-      @server  = Capybara::Server.new(app)
-      @browser = nil
+      @app       = app
+      @options   = options
+      @browser   = nil
+      @inspector = nil
+      @server    = nil
+      @client    = nil
 
-      @server.boot if Capybara.run_server
+      @app_server = Capybara::Server.new(app)
+      @app_server.boot if Capybara.run_server
     end
 
     def browser
-      @browser ||= Browser.new(
-        :logger    => logger,
-        :phantomjs => options[:phantomjs]
-      )
+      @browser ||= Browser.new(server, client, logger)
+    end
+
+    def inspector
+      @inspector ||= options[:inspector] && Inspector.new(options[:inspector])
+    end
+
+    def server
+      @server ||= Server.new(options.fetch(:timeout, DEFAULT_TIMEOUT))
+    end
+
+    def client
+      @client ||= Client.start(server.port, inspector, options[:phantomjs])
+    end
+
+    def client_pid
+      client.pid
+    end
+
+    def timeout
+      server.timeout
+    end
+
+    def timeout=(sec)
+      server.timeout = sec
     end
 
     def restart
       browser.restart
     end
 
+    def quit
+      server.stop
+      client.stop
+    end
+
     # logger should be an object that responds to puts, or nil
     def logger
       options[:logger] || (options[:debug] && STDERR)
     end
 
-    def visit(path, attributes = {})
-      browser.visit(url(path), attributes)
+    def visit(path)
+      browser.visit app_server.url(path)
     end
 
     def current_url
@@ -44,7 +75,7 @@ module Capybara::Poltergeist
     end
 
     def find(selector)
-      browser.find(selector).map { |node| Capybara::Poltergeist::Node.new(self, node) }
+      browser.find(selector).map { |page_id, id| Capybara::Poltergeist::Node.new(self, page_id, id) }
     end
 
     def evaluate_script(script)
@@ -72,6 +103,16 @@ module Capybara::Poltergeist
       browser.resize(width, height)
     end
 
+    def debug
+      inspector.open
+      pause
+    end
+
+    def pause
+      STDERR.puts "Poltergeist execution paused. Press enter to continue."
+      STDIN.gets
+    end
+
     def wait?
       true
     end
@@ -79,11 +120,5 @@ module Capybara::Poltergeist
     def invalid_element_errors
       [Capybara::Poltergeist::ObsoleteNode]
     end
-
-    private
-
-    def url(path)
-      server.url(path)
-    end
   end
 end

data/lib/capybara/poltergeist/errors.rb

@@ -3,11 +3,21 @@ module Capybara
     class Error < StandardError
     end
 
-    class BrowserError < Error
-      attr_reader :text
+    class ClientError < Error
+      attr_reader :response
 
-      def initialize(text)
-        @text = text
+      def initialize(response)
+        @response = response
+      end
+    end
+
+    class BrowserError < ClientError
+      def name
+        response['name']
+      end
+
+      def text
+        response['args'].first
       end
 
       def message
@@ -15,11 +25,44 @@ module Capybara
       end
     end
 
-    class ObsoleteNode < Error
+    class JavascriptError < ClientError
+      def javascript_messages
+        response['args'].first
+      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."
+      end
+    end
+
+    class NodeError < ClientError
       attr_reader :node
 
-      def initialize(node)
+      def initialize(node, response)
         @node = node
+        super(response)
+      end
+    end
+
+    class ObsoleteNode < NodeError
+    end
+
+    class ClickFailed < NodeError
+      def selector
+        response['args'][0]
+      end
+
+      def position
+        [response['args'][1]['x'], response['args'][1]['y']]
+      end
+
+      def message
+        "Click at co-ordinates [#{position.join(', ')}] failed. Poltergeist detected " \
+          "another element with CSS selector '#{selector}' at this position. " \
+          "It may be overlapping the element you are trying to click."
       end
     end
 
@@ -54,5 +97,19 @@ module Capybara
         "PhantomJS version #{version} is too old. You must use at least version #{Client::PHANTOMJS_VERSION}"
       end
     end
+
+    class PhantomJSFailed < Error
+      attr_reader :status
+
+      def initialize(status)
+        @status = status
+      end
+
+      def message
+        "PhantomJS returned non-zero exit status #{status.exitstatus}. Ensure there is an X display available and " \
+          "that DISPLAY is set. (See the Poltergeist README for details.) Make sure 'phantomjs --version' " \
+          "runs successfully on your system."
+      end
+    end
   end
 end