poltergeist 0.6.0 → 0.7.0

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

@@ -3,7 +3,8 @@
 class Poltergeist.Node
   @DELEGATES = ['text', 'getAttribute', 'value', 'set', 'setAttribute', 'isObsolete',
                 'removeAttribute', 'isMultiple', 'select', 'tagName', 'find',
-                'isVisible', 'position', 'trigger', 'parentId', 'clickTest']
+                'isVisible', 'position', 'trigger', 'parentId', 'clickTest',
+                'scrollIntoView', 'isDOMEqual']
 
   constructor: (@page, @id) ->
 
@@ -12,37 +13,12 @@ class Poltergeist.Node
 
   for name in @DELEGATES
     do (name) =>
-      this.prototype[name] = (arguments...) ->
-        @page.nodeCall(@id, name, arguments)
+      this.prototype[name] = (args...) ->
+        @page.nodeCall(@id, name, args)
 
-  clickPosition: (scrollIntoView = true) ->
-    dimensions = @page.validatedDimensions()
-    document   = dimensions.document
-    viewport   = dimensions.viewport
-    pos        = this.position()
-
-    scroll = { left: dimensions.left, top: dimensions.top }
-
-    adjust = (coord, measurement) ->
-      if pos[coord] < 0
-        scroll[coord] = Math.max(
-          0,
-          scroll[coord] + pos[coord] - (viewport[measurement] / 2)
-        )
-
-      else if pos[coord] >= viewport[measurement]
-        scroll[coord] = Math.min(
-          document[measurement] - viewport[measurement],
-          scroll[coord] + pos[coord] - viewport[measurement] + (viewport[measurement] / 2)
-        )
-
-    if scrollIntoView
-      adjust('left', 'width')
-      adjust('top',  'height')
-
-      if scroll.left != dimensions.left || scroll.top != dimensions.top
-        @page.setScrollPosition(scroll)
-        pos = this.position()
+  clickPosition: ->
+    viewport = @page.viewportSize()
+    pos      = this.position()
 
     middle = (start, end, size) ->
       start + ((Math.min(end, size) - start) / 2)
@@ -53,18 +29,25 @@ class Poltergeist.Node
     }
 
   click: ->
+    this.scrollIntoView()
+
     pos  = this.clickPosition()
     test = this.clickTest(pos.x, pos.y)
 
     if test.status == 'success'
       @page.sendEvent('click', pos.x, pos.y)
     else
-      new Poltergeist.ClickFailed(test.selector, pos)
+      throw new Poltergeist.ClickFailed(test.selector, pos)
 
   dragTo: (other) ->
+    this.scrollIntoView()
+
     position      = this.clickPosition()
-    otherPosition = other.clickPosition(false)
+    otherPosition = other.clickPosition()
 
     @page.sendEvent('mousedown', position.x,      position.y)
     @page.sendEvent('mousemove', otherPosition.x, otherPosition.y)
     @page.sendEvent('mouseup',   otherPosition.x, otherPosition.y)
+
+  isEqual: (other) ->
+    @page == other.page && this.isDOMEqual(other.id)

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

@@ -1,18 +1,19 @@
 class Poltergeist.WebPage
   @CALLBACKS = ['onAlert', 'onConsoleMessage', 'onLoadFinished', 'onInitialized',
                 'onLoadStarted', 'onResourceRequested', 'onResourceReceived',
-                'onError']
+                'onError', 'onNavigationRequested', 'onUrlChanged']
 
   @DELEGATES = ['open', 'sendEvent', 'uploadFile', 'release', 'render']
 
   @COMMANDS  = ['currentUrl', 'find', 'nodeCall', 'pushFrame', 'popFrame', 'documentSize']
 
-  constructor: ->
-    @native  = require('webpage').create()
-    @_source = ""
-    @_errors = []
+  constructor: (width, height) ->
+    @native          = require('webpage').create()
+    @_source         = ""
+    @_errors         = []
+    @_networkTraffic = {}
 
-    this.setViewportSize(width: 1024, height: 768)
+    this.setViewportSize(width: width, height: height)
 
     for callback in WebPage.CALLBACKS
       this.bindCallback(callback)
@@ -22,7 +23,7 @@ class Poltergeist.WebPage
   for command in @COMMANDS
     do (command) =>
       this.prototype[command] =
-        (arguments...) -> this.runCommand(command, arguments)
+        (args...) -> this.runCommand(command, args)
 
   for delegate in @DELEGATES
     do (delegate) =>
@@ -35,7 +36,7 @@ class Poltergeist.WebPage
     this.setScrollPosition(left: 0, top: 0)
 
   injectAgent: ->
-    if this.evaluate(-> typeof __poltergeist) == "undefined"
+    if @native.evaluate(-> typeof __poltergeist) == "undefined"
       @native.injectJs("#{phantom.libraryPath}/agent.js")
       @nodes = {}
 
@@ -44,19 +45,44 @@ class Poltergeist.WebPage
       @_source = @native.content
       false
 
+  onLoadStartedNative: ->
+    @requestId = @lastRequestId
+
   onLoadFinishedNative: ->
     @_source or= @native.content
 
-  onConsoleMessage: (message, line, file) ->
-    # 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)
+  onConsoleMessage: (message) ->
+    console.log(message)
 
   onErrorNative: (message, stack) ->
-    @_errors.push(message: message, stack: stack)
+    stackString = message
+
+    stack.forEach (frame) ->
+      stackString += "\n"
+      stackString += "    at #{frame.file}:#{frame.line}"
+      stackString += " in #{frame.function}" if frame.function && frame.function != ''
+
+    @_errors.push(message: message, stack: stackString)
+
+  onResourceRequestedNative: (request) ->
+    @lastRequestId = request.id
+
+    @_networkTraffic[request.id] = {
+      request:       request,
+      responseParts: []
+    }
+
+  onResourceReceivedNative: (response) ->
+    @_networkTraffic[response.id].responseParts.push(response)
+
+    if @requestId == response.id
+      if response.redirectURL
+        @requestId = response.id
+      else
+        @_statusCode = response.status
+
+  networkTraffic: ->
+    @_networkTraffic
 
   content: ->
     @native.content
@@ -70,6 +96,9 @@ class Poltergeist.WebPage
   clearErrors: ->
     @_errors = []
 
+  statusCode: ->
+    @_statusCode
+
   viewportSize: ->
     @native.viewportSize
 
@@ -102,9 +131,6 @@ class Poltergeist.WebPage
     dimensions = this.dimensions()
     document   = dimensions.document
 
-    orig_left = dimensions.left
-    orig_top  = dimensions.top
-
     if dimensions.right > document.width
       dimensions.left  = Math.max(0, dimensions.left - (dimensions.right - document.width))
       dimensions.right = document.width
@@ -113,8 +139,7 @@ class Poltergeist.WebPage
       dimensions.top    = Math.max(0, dimensions.top - (dimensions.bottom - document.height))
       dimensions.bottom = document.height
 
-    if dimensions.left != orig_left || dimensions.top != orig_top
-      this.setScrollPosition(left: dimensions.left, top: dimensions.top)
+    this.setScrollPosition(left: dimensions.left, top: dimensions.top)
 
     dimensions
 
@@ -122,7 +147,7 @@ class Poltergeist.WebPage
     @nodes[id] or= new Poltergeist.Node(this, id)
 
   evaluate: (fn, args...) ->
-    JSON.parse @native.evaluate("function() { return JSON.stringify(#{this.stringifyCall(fn, args)}) }")
+    JSON.parse @native.evaluate("function() { return PoltergeistAgent.stringify(#{this.stringifyCall(fn, args)}) }")
 
   execute: (fn, args...) ->
     @native.evaluate("function() { #{this.stringifyCall(fn, args)} }")
@@ -149,10 +174,16 @@ class Poltergeist.WebPage
   # 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) ->
+  runCommand: (name, args) ->
     result = this.evaluate(
-      (name, arguments) -> __poltergeist.externalCall(name, arguments),
-      name, arguments
+      (name, args) -> __poltergeist.externalCall(name, args),
+      name, args
     )
 
-    result && result.value
+    if result.error?
+      if result.error.message == 'PoltergeistAgent.ObsoleteNode'
+        throw new Poltergeist.ObsoleteNode
+      else
+        throw new Poltergeist.JavascriptError([result.error])
+    else
+      result.value

data/lib/capybara/poltergeist/driver.rb

@@ -3,6 +3,7 @@ module Capybara::Poltergeist
     DEFAULT_TIMEOUT = 30
 
     attr_reader :app, :app_server, :server, :client, :browser, :options
+    attr_accessor :headers
 
     def initialize(app, options = {})
       @app       = app
@@ -11,13 +12,14 @@ module Capybara::Poltergeist
       @inspector = nil
       @server    = nil
       @client    = nil
+      @headers   = {}
 
       @app_server = Capybara::Server.new(app)
       @app_server.boot if Capybara.run_server
     end
 
     def browser
-      @browser ||= Browser.new(server, client, logger)
+      @browser ||= Browser.new(server, client, logger, js_errors)
     end
 
     def inspector
@@ -29,7 +31,17 @@ module Capybara::Poltergeist
     end
 
     def client
-      @client ||= Client.start(server.port, inspector, options[:phantomjs])
+      @client ||= Client.start(server.port,
+        :path              => options[:phantomjs],
+        :window_size       => options[:window_size],
+        :phantomjs_options => phantomjs_options
+      )
+    end
+
+    def phantomjs_options
+      list = options[:phantomjs_options] || []
+      list += ["--remote-debugger-port=#{inspector.port}", "--remote-debugger-autorun=yes"] if inspector
+      list
     end
 
     def client_pid
@@ -58,14 +70,22 @@ module Capybara::Poltergeist
       options[:logger] || (options[:debug] && STDERR)
     end
 
+    def js_errors
+      options.fetch(:js_errors, true)
+    end
+
     def visit(path)
-      browser.visit app_server.url(path)
+      browser.visit app_server.url(path), @headers
     end
 
     def current_url
       browser.current_url
     end
 
+    def status_code
+      browser.status_code
+    end
+
     def body
       browser.body
     end
@@ -93,6 +113,7 @@ module Capybara::Poltergeist
 
     def reset!
       browser.reset
+      @headers = {}
     end
 
     def render(path, options = {})
@@ -103,9 +124,18 @@ module Capybara::Poltergeist
       browser.resize(width, height)
     end
 
+    def network_traffic
+      browser.network_traffic
+    end
+
     def debug
-      inspector.open
-      pause
+      if @options[:inspector]
+        inspector.open
+        pause
+      else
+        raise Error, "To use the remote debugging, you have to launch the driver " \
+                     "with `:inspector => true` configuration option"
+      end
     end
 
     def pause
@@ -118,7 +148,7 @@ module Capybara::Poltergeist
     end
 
     def invalid_element_errors
-      [Capybara::Poltergeist::ObsoleteNode]
+      [Capybara::Poltergeist::ObsoleteNode, Capybara::Poltergeist::ClickFailed]
     end
   end
 end

data/lib/capybara/poltergeist/errors.rb

@@ -20,18 +20,7 @@ module Capybara
       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")
+        stack
       end
     end
 
@@ -128,9 +117,9 @@ module Capybara
       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."
+        "PhantomJS returned non-zero exit status #{status.exitstatus}. Make sure phantomjs runs successfully " \
+          "on your system. You can test this by just running the `phantomjs` command which should give you " \
+          "a Javascript REPL."
       end
     end
   end

data/lib/capybara/poltergeist/json.rb

@@ -0,0 +1,25 @@
+module Capybara::Poltergeist
+  module JSON
+    def self.load(message)
+      if dumpy_multi_json?
+        MultiJson.load(message)
+      else
+        MultiJson.decode(message)
+      end
+    end
+
+    def self.dump(message)
+      if dumpy_multi_json?
+        MultiJson.dump(message)
+      else
+        MultiJson.encode(message)
+      end
+    end
+
+    private
+
+    def self.dumpy_multi_json?
+      MultiJson.respond_to?(:dump) && MultiJson.respond_to?(:load)
+    end
+  end
+end

data/lib/capybara/poltergeist/network_traffic.rb

@@ -0,0 +1,6 @@
+module Capybara::Poltergeist
+  module NetworkTraffic
+    require 'capybara/poltergeist/network_traffic/request'
+    require 'capybara/poltergeist/network_traffic/response'
+  end
+end

data/lib/capybara/poltergeist/network_traffic/request.rb

@@ -0,0 +1,26 @@
+module Capybara::Poltergeist::NetworkTraffic
+  class Request
+    attr_reader :response_parts
+
+    def initialize(data, response_parts = [])
+      @data           = data
+      @response_parts = response_parts
+    end
+
+    def url
+      @data['url']
+    end
+
+    def method
+      @data['method']
+    end
+
+    def headers
+      @data['headers']
+    end
+
+    def time
+      @data['time'] && Time.parse(@data['time'])
+    end
+  end
+end

data/lib/capybara/poltergeist/network_traffic/response.rb

@@ -0,0 +1,40 @@
+module Capybara::Poltergeist::NetworkTraffic
+  class Response
+    def initialize(data)
+      @data = data
+    end
+
+    def url
+      @data['url']
+    end
+
+    def status
+      @data['status']
+    end
+
+    def status_text
+      @data['statusText']
+    end
+
+    def headers
+      @data['headers']
+    end
+
+    def redirect_url
+      @data['redirectUrl']
+    end
+
+    def body_size
+      @data['bodySize']
+    end
+
+    def content_type
+      @data['contentType']
+    end
+
+    def time
+      @data['time'] && Time.parse(@data['time'])
+    end
+  end
+end
+