poltergeist 0.7.0 → 1.0.0

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.6.0'
+    PHANTOMJS_VERSION = '1.7.0'
     PHANTOMJS_NAME    = 'phantomjs'
 
     def self.start(*args)
@@ -61,11 +61,11 @@ module Capybara::Poltergeist
     def check_phantomjs_version
       return if @phantomjs_version_checked
 
-      version = `#{path} --version`.chomp
+      version = `#{path} --version` rescue nil
 
-      if $? != 0
+      if version.nil? || $? != 0
         raise PhantomJSFailed.new($?)
-      elsif version < PHANTOMJS_VERSION
+      elsif version.chomp < PHANTOMJS_VERSION
         raise PhantomJSTooOld.new(version)
       end
 

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

@@ -4,8 +4,6 @@ class PoltergeistAgent
   constructor: ->
     @elements = []
     @nodes    = {}
-    @windows  = []
-    this.pushWindow(window)
 
   externalCall: (name, args) ->
     try
@@ -14,39 +12,23 @@ class PoltergeistAgent
       { error: { message: error.toString(), stack: error.stack } }
 
   @stringify: (object) ->
-    JSON.stringify object, (key, value) ->
-      if Array.isArray(this[key])
-        return this[key]
+    try
+      JSON.stringify object, (key, value) ->
+        if Array.isArray(this[key])
+          return this[key]
+        else
+          return value
+    catch error
+      if error instanceof TypeError
+        '"(cyclic structure)"'
       else
-        return value
-
-  pushWindow: (new_window) ->
-    @windows.push(new_window)
-
-    @window   = new_window
-    @document = @window.document
-
-    null
-
-  popWindow: ->
-    @windows.pop()
-
-    @window   = @windows[@windows.length - 1]
-    @document = @window.document
-
-    null
-
-  pushFrame: (id) ->
-    this.pushWindow @document.getElementById(id).contentWindow
-
-  popFrame: ->
-    this.popWindow()
+        throw error
 
   currentUrl: ->
     window.location.toString()
 
-  find: (selector, within = @document) ->
-    results = @document.evaluate(selector, within, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null)
+  find: (selector, within = document) ->
+    results = document.evaluate(selector, within, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null)
     ids     = []
 
     for i in [0...results.snapshotLength]
@@ -59,8 +41,8 @@ class PoltergeistAgent
     @elements.length - 1
 
   documentSize: ->
-    height: @document.documentElement.scrollHeight,
-    width:  @document.documentElement.scrollWidth
+    height: document.documentElement.scrollHeight,
+    width:  document.documentElement.scrollWidth
 
   get: (id) ->
     @nodes[id] or= new PoltergeistAgent.Node(this, @elements[id])
@@ -91,7 +73,7 @@ class PoltergeistAgent.Node
   isObsolete: ->
     obsolete = (element) =>
       if element.parentNode?
-        if element.parentNode == @agent.document
+        if element.parentNode == document
           false
         else
           obsolete element.parentNode
@@ -104,51 +86,15 @@ class PoltergeistAgent.Node
     event.initEvent('change', true, false)
     @element.dispatchEvent(event)
 
-  input: ->
-    event = document.createEvent('HTMLEvents')
-    event.initEvent('input', true, false)
-    @element.dispatchEvent(event)
-
-  keyupdowned: (eventName, keyCode) ->
-    event = document.createEvent('UIEvents')
-    event.initEvent(eventName, true, true)
-    event.keyCode  = keyCode
-    event.which    = keyCode
-    event.charCode = 0
-    @element.dispatchEvent(event)
-
-  keypressed: (altKey, ctrlKey, shiftKey, metaKey, keyCode, charCode) ->
-    event = document.createEvent('UIEvents')
-    event.initEvent('keypress', true, true)
-    event.window   = @agent.window
-    event.altKey   = altKey
-    event.ctrlKey  = ctrlKey
-    event.shiftKey = shiftKey
-    event.metaKey  = metaKey
-    event.keyCode  = keyCode
-    event.charCode = charCode
-    event.which    = keyCode
-    @element.dispatchEvent(event)
-
   insideBody: ->
-    @element == @agent.document.body ||
-    @agent.document.evaluate('ancestor::body', @element, null, XPathResult.BOOLEAN_TYPE, null).booleanValue
+    @element == document.body ||
+    document.evaluate('ancestor::body', @element, null, XPathResult.BOOLEAN_TYPE, null).booleanValue
 
   text: ->
-    return '' unless this.isVisible()
-
-    if this.insideBody()
-      el = @element
+    if @element.tagName == 'TEXTAREA'
+      @element.textContent
     else
-      el = @agent.document.body
-
-    results = @agent.document.evaluate('.//text()[not(ancestor::script)]', el, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null)
-    text    = ''
-
-    for i in [0...results.snapshotLength]
-      node = results.snapshotItem(i)
-      text += node.textContent if this.isVisible(node.parentNode)
-    text
+      @element.innerText
 
   getAttribute: (name) ->
     if name == 'checked' || name == 'selected'
@@ -165,25 +111,6 @@ class PoltergeistAgent.Node
     else
       @element.value
 
-  set: (value) ->
-    if (@element.maxLength >= 0)
-      value = value.substr(0, @element.maxLength)
-
-    @element.value = ''
-    this.trigger('focus')
-
-    for char in value
-      @element.value += char
-
-      keyCode = this.characterToKeyCode(char)
-      this.keyupdowned('keydown', keyCode)
-      this.keypressed(false, false, false, false, char.charCodeAt(0), char.charCodeAt(0))
-      this.keyupdowned('keyup', keyCode)
-
-    this.changed()
-    this.input()
-    this.trigger('blur')
-
   isMultiple: ->
     @element.multiple
 
@@ -207,7 +134,7 @@ class PoltergeistAgent.Node
   isVisible: (element) ->
     element = @element unless element
 
-    if @agent.window.getComputedStyle(element).display == 'none'
+    if window.getComputedStyle(element).display == 'none'
       false
     else if element.parentElement
       this.isVisible element.parentElement
@@ -216,6 +143,7 @@ class PoltergeistAgent.Node
 
   position: ->
     rect = @element.getClientRects()[0]
+    throw new PoltergeistAgent.ObsoleteNode unless rect
 
     {
       top:    rect.top,
@@ -230,7 +158,7 @@ class PoltergeistAgent.Node
     if Node.EVENTS.MOUSE.indexOf(name) != -1
       event = document.createEvent('MouseEvent')
       event.initMouseEvent(
-        name, true, true, @agent.window, 0, 0, 0, 0, 0,
+        name, true, true, window, 0, 0, 0, 0, 0,
         false, false, false, false, 0, null
       )
     else if Node.EVENTS.FOCUS.indexOf(name) != -1
@@ -241,6 +169,13 @@ class PoltergeistAgent.Node
 
     @element.dispatchEvent(event)
 
+  focusAndHighlight: ->
+    @element.focus()
+    @element.select()
+
+  blur: ->
+    @element.blur()
+
   clickTest: (x, y) ->
     el = origEl = document.elementFromPoint(x, y)
 
@@ -260,45 +195,6 @@ class PoltergeistAgent.Node
       selector += ".#{className}"
     selector
 
-  characterToKeyCode: (character) ->
-    code = character.toUpperCase().charCodeAt(0)
-    specialKeys =
-      96: 192  #`
-      45: 189  #-
-      61: 187  #=
-      91: 219  #[
-      93: 221  #]
-      92: 220  #\
-      59: 186  #;
-      39: 222  #'
-      44: 188  #,
-      46: 190  #.
-      47: 191  #/
-      127: 46  #delete
-      126: 192 #~
-      33: 49   #!
-      64: 50   #@
-      35: 51   ##
-      36: 52   #$
-      37: 53   #%
-      94: 54   #^
-      38: 55   #&
-      42: 56   #*
-      40: 57   #(
-      41: 48   #)
-      95: 189  #_
-      43: 187  #+
-      123: 219 #{
-      125: 221 #}
-      124: 220 #|
-      58: 186  #:
-      34: 222  #"
-      60: 188  #<
-      62: 190  #>
-      63: 191 #?
-
-    specialKeys[code] || code
-
   isDOMEqual: (other_id) ->
     @element == @agent.get(other_id).element
 

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

@@ -1,15 +1,20 @@
 class Poltergeist.Browser
   constructor: (@owner, width, height) ->
-    @width   = width || 1024
-    @height  = height || 768
-    @state   = 'default'
-    @page_id = 0
+    @width      = width || 1024
+    @height     = height || 768
+    @state      = 'default'
+    @page_stack = []
+    @page_id    = 0
 
     this.resetPage()
 
   resetPage: ->
-    @page.release() if @page?
-    @page = new Poltergeist.WebPage(@width, @height)
+    if @page?
+      @page.release()
+      phantom.clearCookies()
+
+    @page = new Poltergeist.WebPage
+    @page.setViewportSize(width: @width, height: @height)
 
     @page.onLoadStarted = =>
       @state = 'loading' if @state == 'clicked'
@@ -19,18 +24,32 @@ class Poltergeist.Browser
 
     @page.onLoadFinished = (status) =>
       if @state == 'loading'
-        this.sendResponse(status)
+        this.sendResponse(status: status, click: @last_click)
+        @state = 'default'
+      else if @state == 'awaiting_frame_load'
+        this.sendResponse(true)
         @state = 'default'
 
     @page.onInitialized = =>
       @page_id += 1
 
+    @page.onPageCreated = (sub_page) =>
+      if @state == 'awaiting_sub_page'
+        name       = @page_name
+        @state     = 'default'
+        @page_name = null
+
+        # At this point subpage isn't fully initialized, so we can't check
+        # its name. Instead, we just schedule another attempt to push the
+        # window.
+        setTimeout((=> this.push_window(name)), 0)
+
   sendResponse: (response) ->
     errors = @page.errors()
 
     if errors.length > 0
       @page.clearErrors()
-      throw new Poltergeist.JavascriptError(errors)
+      @owner.sendError(new Poltergeist.JavascriptError(errors))
     else
       @owner.sendResponse(response)
 
@@ -40,9 +59,16 @@ class Poltergeist.Browser
     else
       throw new Poltergeist.ObsoleteNode
 
-  visit: (url, headers) ->
-    @state = 'loading'
-    @page.open(url, operation: "get", headers: headers)
+  visit: (url) ->
+    @state   = 'loading'
+    prev_url = @page.currentUrl()
+
+    @page.open(url)
+
+    if /#/.test(url) && prev_url.split('#')[0] == url.split('#')[0]
+      # hashchange occurred, so there will be no onLoadFinished
+      @state = 'default'
+      this.sendResponse 'success'
 
   current_url: ->
     this.sendResponse @page.currentUrl()
@@ -103,12 +129,40 @@ class Poltergeist.Browser
     @page.execute("function() { #{script} }")
     this.sendResponse(true)
 
-  push_frame: (id) ->
-    @page.pushFrame(id)
-    this.sendResponse(true)
+  push_frame: (name) ->
+    if @page.pushFrame(name)
+      if @page.currentUrl() == 'about:blank'
+        @state = 'awaiting_frame_load'
+      else
+        this.sendResponse(true)
+    else
+      # There's currently no PhantomJS callback available for frame creation,
+      # so we have to poll
+      setTimeout((=> this.push_frame(name)), 50)
 
   pop_frame: ->
-    @page.popFrame()
+    this.sendResponse(@page.popFrame())
+
+  push_window: (name) ->
+    sub_page = @page.getPage(name)
+
+    if sub_page
+      if sub_page.currentUrl() == 'about:blank'
+        sub_page.onLoadFinished = =>
+          sub_page.onLoadFinished = null
+          this.push_window(name)
+      else
+        @page_stack.push(@page)
+        @page = sub_page
+        @page_id += 1
+        this.sendResponse(true)
+    else
+      @page_name = name
+      @state     = 'awaiting_sub_page'
+
+  pop_window: ->
+    prev_page = @page_stack.pop()
+    @page = prev_page if prev_page
     this.sendResponse(true)
 
   click: (page_id, id) ->
@@ -119,11 +173,13 @@ class Poltergeist.Browser
     # state and wait for onLoadFinished before sending a response.
     @state = 'clicked'
 
-    node.click()
+    @last_click = node.click()
 
-    if @state != 'loading'
-      @state = 'default'
-      this.sendResponse(true)
+    setTimeout =>
+      if @state != 'loading'
+        @state = 'default'
+        this.sendResponse(@last_click)
+    , 5
 
   drag: (page_id, id, other_id) ->
     this.node(page_id, id).dragTo this.node(page_id, other_id)
@@ -163,6 +219,28 @@ class Poltergeist.Browser
   network_traffic: ->
     this.sendResponse(@page.networkTraffic())
 
+  set_headers: (headers) ->
+    # Workaround for https://code.google.com/p/phantomjs/issues/detail?id=745
+    @page.setUserAgent(headers['User-Agent']) if headers['User-Agent']
+    @page.setCustomHeaders(headers)
+    this.sendResponse(true)
+
+  response_headers: ->
+    this.sendResponse(@page.responseHeaders())
+
+  cookies: ->
+    this.sendResponse(@page.cookies())
+
+  # We're using phantom.addCookie so that cookies can be set
+  # before the first page load has taken place.
+  set_cookie: (cookie) ->
+    phantom.addCookie(cookie)
+    this.sendResponse(true)
+
+  remove_cookie: (name) ->
+    @page.deleteCookie(name)
+    this.sendResponse(true)
+
   exit: ->
     phantom.exit()
 

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

@@ -5,8 +5,6 @@ PoltergeistAgent = (function() {
   function PoltergeistAgent() {
     this.elements = [];
     this.nodes = {};
-    this.windows = [];
-    this.pushWindow(window);
   }
 
   PoltergeistAgent.prototype.externalCall = function(name, args) {
@@ -25,35 +23,21 @@ PoltergeistAgent = (function() {
   };
 
   PoltergeistAgent.stringify = function(object) {
-    return JSON.stringify(object, function(key, value) {
-      if (Array.isArray(this[key])) {
-        return this[key];
+    try {
+      return JSON.stringify(object, function(key, value) {
+        if (Array.isArray(this[key])) {
+          return this[key];
+        } else {
+          return value;
+        }
+      });
+    } catch (error) {
+      if (error instanceof TypeError) {
+        return '"(cyclic structure)"';
       } else {
-        return value;
+        throw error;
       }
-    });
-  };
-
-  PoltergeistAgent.prototype.pushWindow = function(new_window) {
-    this.windows.push(new_window);
-    this.window = new_window;
-    this.document = this.window.document;
-    return null;
-  };
-
-  PoltergeistAgent.prototype.popWindow = function() {
-    this.windows.pop();
-    this.window = this.windows[this.windows.length - 1];
-    this.document = this.window.document;
-    return null;
-  };
-
-  PoltergeistAgent.prototype.pushFrame = function(id) {
-    return this.pushWindow(this.document.getElementById(id).contentWindow);
-  };
-
-  PoltergeistAgent.prototype.popFrame = function() {
-    return this.popWindow();
+    }
   };
 
   PoltergeistAgent.prototype.currentUrl = function() {
@@ -63,9 +47,9 @@ PoltergeistAgent = (function() {
   PoltergeistAgent.prototype.find = function(selector, within) {
     var i, ids, results, _i, _ref;
     if (within == null) {
-      within = this.document;
+      within = document;
     }
-    results = this.document.evaluate(selector, within, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);
+    results = document.evaluate(selector, within, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);
     ids = [];
     for (i = _i = 0, _ref = results.snapshotLength; 0 <= _ref ? _i < _ref : _i > _ref; i = 0 <= _ref ? ++_i : --_i) {
       ids.push(this.register(results.snapshotItem(i)));
@@ -80,8 +64,8 @@ PoltergeistAgent = (function() {
 
   PoltergeistAgent.prototype.documentSize = function() {
     return {
-      height: this.document.documentElement.scrollHeight,
-      width: this.document.documentElement.scrollWidth
+      height: document.documentElement.scrollHeight,
+      width: document.documentElement.scrollWidth
     };
   };
 
@@ -140,7 +124,7 @@ PoltergeistAgent.Node = (function() {
       _this = this;
     obsolete = function(element) {
       if (element.parentNode != null) {
-        if (element.parentNode === _this.agent.document) {
+        if (element.parentNode === document) {
           return false;
         } else {
           return obsolete(element.parentNode);
@@ -159,61 +143,16 @@ PoltergeistAgent.Node = (function() {
     return this.element.dispatchEvent(event);
   };
 
-  Node.prototype.input = function() {
-    var event;
-    event = document.createEvent('HTMLEvents');
-    event.initEvent('input', true, false);
-    return this.element.dispatchEvent(event);
-  };
-
-  Node.prototype.keyupdowned = function(eventName, keyCode) {
-    var event;
-    event = document.createEvent('UIEvents');
-    event.initEvent(eventName, true, true);
-    event.keyCode = keyCode;
-    event.which = keyCode;
-    event.charCode = 0;
-    return this.element.dispatchEvent(event);
-  };
-
-  Node.prototype.keypressed = function(altKey, ctrlKey, shiftKey, metaKey, keyCode, charCode) {
-    var event;
-    event = document.createEvent('UIEvents');
-    event.initEvent('keypress', true, true);
-    event.window = this.agent.window;
-    event.altKey = altKey;
-    event.ctrlKey = ctrlKey;
-    event.shiftKey = shiftKey;
-    event.metaKey = metaKey;
-    event.keyCode = keyCode;
-    event.charCode = charCode;
-    event.which = keyCode;
-    return this.element.dispatchEvent(event);
-  };
-
   Node.prototype.insideBody = function() {
-    return this.element === this.agent.document.body || this.agent.document.evaluate('ancestor::body', this.element, null, XPathResult.BOOLEAN_TYPE, null).booleanValue;
+    return this.element === document.body || document.evaluate('ancestor::body', this.element, null, XPathResult.BOOLEAN_TYPE, null).booleanValue;
   };
 
   Node.prototype.text = function() {
-    var el, i, node, results, text, _i, _ref;
-    if (!this.isVisible()) {
-      return '';
-    }
-    if (this.insideBody()) {
-      el = this.element;
+    if (this.element.tagName === 'TEXTAREA') {
+      return this.element.textContent;
     } else {
-      el = this.agent.document.body;
+      return this.element.innerText;
     }
-    results = this.agent.document.evaluate('.//text()[not(ancestor::script)]', el, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);
-    text = '';
-    for (i = _i = 0, _ref = results.snapshotLength; 0 <= _ref ? _i < _ref : _i > _ref; i = 0 <= _ref ? ++_i : --_i) {
-      node = results.snapshotItem(i);
-      if (this.isVisible(node.parentNode)) {
-        text += node.textContent;
-      }
-    }
-    return text;
   };
 
   Node.prototype.getAttribute = function(name) {
@@ -245,26 +184,6 @@ PoltergeistAgent.Node = (function() {
     }
   };
 
-  Node.prototype.set = function(value) {
-    var char, keyCode, _i, _len;
-    if (this.element.maxLength >= 0) {
-      value = value.substr(0, this.element.maxLength);
-    }
-    this.element.value = '';
-    this.trigger('focus');
-    for (_i = 0, _len = value.length; _i < _len; _i++) {
-      char = value[_i];
-      this.element.value += char;
-      keyCode = this.characterToKeyCode(char);
-      this.keyupdowned('keydown', keyCode);
-      this.keypressed(false, false, false, false, char.charCodeAt(0), char.charCodeAt(0));
-      this.keyupdowned('keyup', keyCode);
-    }
-    this.changed();
-    this.input();
-    return this.trigger('blur');
-  };
-
   Node.prototype.isMultiple = function() {
     return this.element.multiple;
   };
@@ -295,7 +214,7 @@ PoltergeistAgent.Node = (function() {
     if (!element) {
       element = this.element;
     }
-    if (this.agent.window.getComputedStyle(element).display === 'none') {
+    if (window.getComputedStyle(element).display === 'none') {
       return false;
     } else if (element.parentElement) {
       return this.isVisible(element.parentElement);
@@ -307,6 +226,9 @@ PoltergeistAgent.Node = (function() {
   Node.prototype.position = function() {
     var rect;
     rect = this.element.getClientRects()[0];
+    if (!rect) {
+      throw new PoltergeistAgent.ObsoleteNode;
+    }
     return {
       top: rect.top,
       right: rect.right,
@@ -321,7 +243,7 @@ PoltergeistAgent.Node = (function() {
     var event;
     if (Node.EVENTS.MOUSE.indexOf(name) !== -1) {
       event = document.createEvent('MouseEvent');
-      event.initMouseEvent(name, true, true, this.agent.window, 0, 0, 0, 0, 0, false, false, false, false, 0, null);
+      event.initMouseEvent(name, true, true, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null);
     } else if (Node.EVENTS.FOCUS.indexOf(name) !== -1) {
       event = document.createEvent('HTMLEvents');
       event.initEvent(name, true, true);
@@ -331,6 +253,15 @@ PoltergeistAgent.Node = (function() {
     return this.element.dispatchEvent(event);
   };
 
+  Node.prototype.focusAndHighlight = function() {
+    this.element.focus();
+    return this.element.select();
+  };
+
+  Node.prototype.blur = function() {
+    return this.element.blur();
+  };
+
   Node.prototype.clickTest = function(x, y) {
     var el, origEl;
     el = origEl = document.elementFromPoint(x, y);
@@ -364,47 +295,6 @@ PoltergeistAgent.Node = (function() {
     return selector;
   };
 
-  Node.prototype.characterToKeyCode = function(character) {
-    var code, specialKeys;
-    code = character.toUpperCase().charCodeAt(0);
-    specialKeys = {
-      96: 192,
-      45: 189,
-      61: 187,
-      91: 219,
-      93: 221,
-      92: 220,
-      59: 186,
-      39: 222,
-      44: 188,
-      46: 190,
-      47: 191,
-      127: 46,
-      126: 192,
-      33: 49,
-      64: 50,
-      35: 51,
-      36: 52,
-      37: 53,
-      94: 54,
-      38: 55,
-      42: 56,
-      40: 57,
-      41: 48,
-      95: 189,
-      43: 187,
-      123: 219,
-      125: 221,
-      124: 220,
-      58: 186,
-      34: 222,
-      60: 188,
-      62: 190,
-      63: 191
-    };
-    return specialKeys[code] || code;
-  };
-
   Node.prototype.isDOMEqual = function(other_id) {
     return this.element === this.agent.get(other_id).element;
   };