poltergeist 1.3.0 → 1.4.0

data/lib/capybara/poltergeist/client.rb

@@ -1,10 +1,11 @@
 require "timeout"
 require "capybara/poltergeist/utility"
+require 'cliver'
 
 module Capybara::Poltergeist
   class Client
     PHANTOMJS_SCRIPT  = File.expand_path('../client/compiled/main.js', __FILE__)
-    PHANTOMJS_VERSION = '1.8.1'
+    PHANTOMJS_VERSION = ['~> 1.8','>= 1.8.1']
     PHANTOMJS_NAME    = 'phantomjs'
 
     KILL_TIMEOUT = 2 # seconds
@@ -15,11 +16,26 @@ module Capybara::Poltergeist
       client
     end
 
+    # Returns a proc, that when called will attempt to kill the given process.
+    # This is because implementing ObjectSpace.define_finalizer is tricky.
+    # Hat-Tip to @mperham for describing in detail:
+    # http://www.mikeperham.com/2010/02/24/the-trouble-with-ruby-finalizers/
+    def self.process_killer(pid)
+      proc do
+        begin
+          Process.kill('KILL', pid)
+        rescue Errno::ESRCH, Errno::ECHILD
+        end
+      end
+    end
+
     attr_reader :pid, :server, :path, :window_size, :phantomjs_options
 
     def initialize(server, options = {})
       @server            = server
-      @path              = options[:path]              || PHANTOMJS_NAME
+      @path              = Cliver::detect!((options[:path] || PHANTOMJS_NAME),
+                                           *PHANTOMJS_VERSION)
+
       @window_size       = options[:window_size]       || [1024, 768]
       @phantomjs_options = options[:phantomjs_options] || []
       @phantomjs_logger  = options[:phantomjs_logger]  || $stdout
@@ -29,16 +45,19 @@ module Capybara::Poltergeist
     end
 
     def start
-      check_phantomjs_version
-      read, write = IO.pipe
+      @read_io, @write_io = IO.pipe
       @out_thread = Thread.new {
-        while !read.eof? && data = read.readpartial(1024)
+        while !@read_io.eof? && data = @read_io.readpartial(1024)
           @phantomjs_logger.write(data)
         end
       }
 
-      redirect_stdout(write) do
-        @pid = Process.spawn(*command.map(&:to_s), pgroup: true)
+      process_options = {}
+      process_options[:pgroup] = true unless Capybara::Poltergeist.windows?
+
+      redirect_stdout do
+        @pid = Process.spawn(*command.map(&:to_s), process_options)
+        ObjectSpace.define_finalizer(self, self.class.process_killer(@pid) )
       end
     end
 
@@ -59,7 +78,9 @@ module Capybara::Poltergeist
         rescue Errno::ESRCH, Errno::ECHILD
           # Zed's dead, baby
         end
-
+        ObjectSpace.undefine_finalizer(self)
+        @write_io.close
+        @read_io.close
         @out_thread.kill
         @pid = nil
       end
@@ -81,33 +102,13 @@ module Capybara::Poltergeist
 
     private
 
-    def check_phantomjs_version
-      return if @phantomjs_version_checked
-
-      version = `#{path} --version` rescue nil
-
-      if version.nil? || $? != 0
-        raise PhantomJSFailed.new($?)
-      else
-        major, minor, build = version.chomp.split('.').map(&:to_i)
-        min_major, min_minor, min_build = PHANTOMJS_VERSION.split('.').map(&:to_i)
-        if major < min_major ||
-            major == min_major && minor < min_minor ||
-            major == min_major && minor == min_minor && build < min_build
-          raise PhantomJSTooOld.new(version)
-        end
-      end
-
-      @phantomjs_version_checked = true
-    end
-
     # This abomination is because JRuby doesn't support the :out option of
     # Process.spawn
-    def redirect_stdout(to)
+    def redirect_stdout
       prev = STDOUT.dup
       prev.autoclose = false
-      $stdout = to
-      STDOUT.reopen(to)
+      $stdout = @write_io
+      STDOUT.reopen(@write_io)
       yield
     ensure
       STDOUT.reopen(prev)

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

@@ -25,7 +25,7 @@ class PoltergeistAgent
         throw error
 
   currentUrl: ->
-    window.location.toString()
+    encodeURI(window.location.href)
 
   find: (method, selector, within = document) ->
     try
@@ -214,11 +214,12 @@ class PoltergeistAgent.Node
     offset = { top: 0, left: 0 }
 
     while win.frameElement
-      rect = window.frameElement.getClientRects()[0]
-      win  = win.parent
-
-      offset.top  += rect.top
-      offset.left += rect.left
+      rect  = win.frameElement.getClientRects()[0]
+      style = win.getComputedStyle(win.frameElement)
+      win   = win.parent
+      
+      offset.top  += rect.top + parseInt(style.getPropertyValue("padding-top"), 10)
+      offset.left += rect.left + parseInt(style.getPropertyValue("padding-left"), 10)
 
     offset
 

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

@@ -82,7 +82,10 @@ class Poltergeist.Browser
   visit: (url) ->
     this.setState 'loading'
 
-    prev_url = @page.currentUrl()
+    # Prevent firing `page.onInitialized` event twice. Calling currentUrl
+    # method before page is actually opened fires this event for the first time.
+    # The second time will be in the right place after `page.open`
+    prev_url = if @page.source() is null then 'about:blank' else @page.currentUrl()
 
     @page.open(url)
 
@@ -171,6 +174,9 @@ class Poltergeist.Browser
       else
         @owner.sendError(new Poltergeist.FrameNotFound(name))
 
+  pages: ->
+    this.sendResponse(@page.pages())
+
   pop_frame: ->
     this.sendResponse(@page.popFrame())
 
@@ -240,21 +246,36 @@ class Poltergeist.Browser
     this.resetPage()
     this.sendResponse(true)
 
-  render: (path, full) ->
+  scroll_to: (left, top) ->
+    @page.setScrollPosition(left: left, top: top)
+    this.sendResponse(true)
+
+  render_base64: (format, full, selector = null)->
+    this.set_clip_rect(full, selector)
+    encoded_image = @page.renderBase64(format)
+    this.sendResponse(encoded_image)
+
+  render: (path, full, selector = null) ->
+    dimensions = this.set_clip_rect(full, selector)
+    @page.setScrollPosition(left: 0, top: 0)
+    @page.render(path)
+    @page.setScrollPosition(left: dimensions.left, top: dimensions.top)
+    this.sendResponse(true)
+
+  set_clip_rect: (full, selector) ->
     dimensions = @page.validatedDimensions()
-    document   = dimensions.document
-    viewport   = dimensions.viewport
-
-    if full
-      @page.setScrollPosition(left: 0, top: 0)
-      @page.setClipRect(left: 0, top: 0, width: document.width, height: document.height)
-      @page.render(path)
-      @page.setScrollPosition(left: dimensions.left, top: dimensions.top)
+    [document, viewport] = [dimensions.document, dimensions.viewport]
+
+    rect = if full
+      left: 0, top: 0, width: document.width, height: document.height
     else
-      @page.setClipRect(left: 0, top: 0, width: viewport.width, height: viewport.height)
-      @page.render(path)
+      if selector?
+        @page.elementBounds(selector)
+      else
+        left: 0, top: 0, width: viewport.width, height: viewport.height
 
-    this.sendResponse(true)
+    @page.setClipRect(rect)
+    dimensions
 
   resize: (width, height) ->
     @page.setViewportSize(width: width, height: height)
@@ -263,12 +284,25 @@ class Poltergeist.Browser
   network_traffic: ->
     this.sendResponse(@page.networkTraffic())
 
+  get_headers: ->
+    this.sendResponse(@page.getCustomHeaders())
+
   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)
 
+  add_headers: (headers) ->
+    allHeaders = @page.getCustomHeaders()
+    for name, value of headers
+      allHeaders[name] = value
+    this.set_headers(allHeaders)
+
+  add_header: (header, permanent) ->
+    @page.addTempHeader(header) unless permanent
+    this.add_headers(header)
+
   response_headers: ->
     this.sendResponse(@page.responseHeaders())
 

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

@@ -8,7 +8,6 @@ PoltergeistAgent = (function() {
 
   PoltergeistAgent.prototype.externalCall = function(name, args) {
     var error;
-
     try {
       return {
         value: this[name].apply(this, args)
@@ -26,7 +25,6 @@ PoltergeistAgent = (function() {
 
   PoltergeistAgent.stringify = function(object) {
     var error;
-
     try {
       return JSON.stringify(object, function(key, value) {
         if (Array.isArray(this[key])) {
@@ -46,12 +44,11 @@ PoltergeistAgent = (function() {
   };
 
   PoltergeistAgent.prototype.currentUrl = function() {
-    return window.location.toString();
+    return encodeURI(window.location.href);
   };
 
   PoltergeistAgent.prototype.find = function(method, selector, within) {
     var el, error, i, results, xpath, _i, _len, _results;
-
     if (within == null) {
       within = document;
     }
@@ -60,7 +57,6 @@ PoltergeistAgent = (function() {
         xpath = document.evaluate(selector, within, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null);
         results = (function() {
           var _i, _ref, _results;
-
           _results = [];
           for (i = _i = 0, _ref = xpath.snapshotLength; 0 <= _ref ? _i < _ref : _i > _ref; i = 0 <= _ref ? ++_i : --_i) {
             _results.push(xpath.snapshotItem(i));
@@ -100,13 +96,11 @@ PoltergeistAgent = (function() {
 
   PoltergeistAgent.prototype.get = function(id) {
     var _base;
-
     return (_base = this.nodes)[id] || (_base[id] = new PoltergeistAgent.Node(this, this.elements[id]));
   };
 
   PoltergeistAgent.prototype.nodeCall = function(id, name, args) {
     var node;
-
     node = this.get(id);
     if (node.isObsolete()) {
       throw new PoltergeistAgent.ObsoleteNode;
@@ -170,7 +164,6 @@ PoltergeistAgent.Node = (function() {
   Node.prototype.isObsolete = function() {
     var obsolete,
       _this = this;
-
     obsolete = function(element) {
       if (element.parentNode != null) {
         if (element.parentNode === document) {
@@ -187,7 +180,6 @@ PoltergeistAgent.Node = (function() {
 
   Node.prototype.changed = function() {
     var event;
-
     event = document.createEvent('HTMLEvents');
     event.initEvent('change', true, false);
     return this.element.dispatchEvent(event);
@@ -195,7 +187,6 @@ PoltergeistAgent.Node = (function() {
 
   Node.prototype.input = function() {
     var event;
-
     event = document.createEvent('HTMLEvents');
     event.initEvent('input', true, false);
     return this.element.dispatchEvent(event);
@@ -203,7 +194,6 @@ PoltergeistAgent.Node = (function() {
 
   Node.prototype.keyupdowned = function(eventName, keyCode) {
     var event;
-
     event = document.createEvent('UIEvents');
     event.initEvent(eventName, true, true);
     event.keyCode = keyCode;
@@ -214,7 +204,6 @@ PoltergeistAgent.Node = (function() {
 
   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;
@@ -258,7 +247,6 @@ PoltergeistAgent.Node = (function() {
 
   Node.prototype.value = function() {
     var option, _i, _len, _ref, _results;
-
     if (this.element.tagName === 'SELECT' && this.element.multiple) {
       _ref = this.element.children;
       _results = [];
@@ -276,7 +264,6 @@ PoltergeistAgent.Node = (function() {
 
   Node.prototype.set = function(value) {
     var char, keyCode, _i, _len;
-
     if (this.element.readOnly) {
       return;
     }
@@ -342,25 +329,24 @@ PoltergeistAgent.Node = (function() {
   };
 
   Node.prototype.frameOffset = function() {
-    var offset, rect, win;
-
+    var offset, rect, style, win;
     win = window;
     offset = {
       top: 0,
       left: 0
     };
     while (win.frameElement) {
-      rect = window.frameElement.getClientRects()[0];
+      rect = win.frameElement.getClientRects()[0];
+      style = win.getComputedStyle(win.frameElement);
       win = win.parent;
-      offset.top += rect.top;
-      offset.left += rect.left;
+      offset.top += rect.top + parseInt(style.getPropertyValue("padding-top"), 10);
+      offset.left += rect.left + parseInt(style.getPropertyValue("padding-left"), 10);
     }
     return offset;
   };
 
   Node.prototype.position = function() {
     var frameOffset, pos, rect;
-
     rect = this.element.getClientRects()[0];
     if (!rect) {
       throw new PoltergeistAgent.ObsoleteNode;
@@ -379,7 +365,6 @@ PoltergeistAgent.Node = (function() {
 
   Node.prototype.trigger = function(name) {
     var event;
-
     if (Node.EVENTS.MOUSE.indexOf(name) !== -1) {
       event = document.createEvent('MouseEvent');
       event.initMouseEvent(name, true, true, window, 0, 0, 0, 0, 0, false, false, false, false, 0, null);
@@ -394,7 +379,6 @@ PoltergeistAgent.Node = (function() {
 
   Node.prototype.mouseEventTest = function(x, y) {
     var el, frameOffset, origEl;
-
     frameOffset = this.frameOffset();
     x -= frameOffset.left;
     y -= frameOffset.top;
@@ -416,7 +400,6 @@ PoltergeistAgent.Node = (function() {
 
   Node.prototype.getSelector = function(el) {
     var className, selector, _i, _len, _ref;
-
     selector = el.tagName !== 'HTML' ? this.getSelector(el.parentNode) + ' ' : '';
     selector += el.tagName.toLowerCase();
     if (el.id) {
@@ -432,7 +415,6 @@ PoltergeistAgent.Node = (function() {
 
   Node.prototype.characterToKeyCode = function(character) {
     var code, specialKeys;
-
     code = character.toUpperCase().charCodeAt(0);
     specialKeys = {
       96: 192,

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

@@ -13,7 +13,6 @@ Poltergeist.Browser = (function() {
 
   Browser.prototype.resetPage = function() {
     var _this = this;
-
     if (this.page != null) {
       this.page.release();
       phantom.clearCookies();
@@ -50,7 +49,6 @@ Poltergeist.Browser = (function() {
     };
     return this.page.onPageCreated = function(sub_page) {
       var name;
-
       if (_this.state === 'awaiting_sub_page') {
         name = _this.page_name;
         _this.page_name = null;
@@ -83,7 +81,6 @@ Poltergeist.Browser = (function() {
 
   Browser.prototype.sendResponse = function(response) {
     var errors;
-
     errors = this.page.errors();
     this.page.clearErrors();
     if (errors.length > 0 && this.js_errors) {
@@ -108,9 +105,8 @@ Poltergeist.Browser = (function() {
 
   Browser.prototype.visit = function(url) {
     var prev_url;
-
     this.setState('loading');
-    prev_url = this.page.currentUrl();
+    prev_url = this.page.source() === null ? 'about:blank' : this.page.currentUrl();
     this.page.open(url);
     if (/#/.test(url) && prev_url.split('#')[0] === url.split('#')[0]) {
       this.setState('default');
@@ -172,7 +168,6 @@ Poltergeist.Browser = (function() {
 
   Browser.prototype.select_file = function(page_id, id, value) {
     var node;
-
     node = this.node(page_id, id);
     this.page.beforeUpload(node.id);
     this.page.uploadFile('[_poltergeist_selected]', value);
@@ -207,7 +202,6 @@ Poltergeist.Browser = (function() {
 
   Browser.prototype.push_frame = function(name, timeout) {
     var _this = this;
-
     if (timeout == null) {
       timeout = new Date().getTime() + 2000;
     }
@@ -228,6 +222,10 @@ Poltergeist.Browser = (function() {
     }
   };
 
+  Browser.prototype.pages = function() {
+    return this.sendResponse(this.page.pages());
+  };
+
   Browser.prototype.pop_frame = function() {
     return this.sendResponse(this.page.popFrame());
   };
@@ -235,7 +233,6 @@ Poltergeist.Browser = (function() {
   Browser.prototype.push_window = function(name) {
     var sub_page,
       _this = this;
-
     sub_page = this.page.getPage(name);
     if (sub_page) {
       if (sub_page.currentUrl() === 'about:blank') {
@@ -257,7 +254,6 @@ Poltergeist.Browser = (function() {
 
   Browser.prototype.pop_window = function() {
     var prev_page;
-
     prev_page = this.page_stack.pop();
     if (prev_page) {
       this.page = prev_page;
@@ -268,7 +264,6 @@ Poltergeist.Browser = (function() {
   Browser.prototype.mouse_event = function(page_id, id, name) {
     var node,
       _this = this;
-
     node = this.node(page_id, id);
     this.setState('mouse_event');
     this.last_mouse_event = node.mouseEvent(name);
@@ -321,40 +316,61 @@ Poltergeist.Browser = (function() {
     return this.sendResponse(true);
   };
 
-  Browser.prototype.render = function(path, full) {
-    var dimensions, document, viewport;
+  Browser.prototype.scroll_to = function(left, top) {
+    this.page.setScrollPosition({
+      left: left,
+      top: top
+    });
+    return this.sendResponse(true);
+  };
 
-    dimensions = this.page.validatedDimensions();
-    document = dimensions.document;
-    viewport = dimensions.viewport;
-    if (full) {
-      this.page.setScrollPosition({
-        left: 0,
-        top: 0
-      });
-      this.page.setClipRect({
-        left: 0,
-        top: 0,
-        width: document.width,
-        height: document.height
-      });
-      this.page.render(path);
-      this.page.setScrollPosition({
-        left: dimensions.left,
-        top: dimensions.top
-      });
-    } else {
-      this.page.setClipRect({
-        left: 0,
-        top: 0,
-        width: viewport.width,
-        height: viewport.height
-      });
-      this.page.render(path);
+  Browser.prototype.render_base64 = function(format, full, selector) {
+    var encoded_image;
+    if (selector == null) {
+      selector = null;
     }
+    this.set_clip_rect(full, selector);
+    encoded_image = this.page.renderBase64(format);
+    return this.sendResponse(encoded_image);
+  };
+
+  Browser.prototype.render = function(path, full, selector) {
+    var dimensions;
+    if (selector == null) {
+      selector = null;
+    }
+    dimensions = this.set_clip_rect(full, selector);
+    this.page.setScrollPosition({
+      left: 0,
+      top: 0
+    });
+    this.page.render(path);
+    this.page.setScrollPosition({
+      left: dimensions.left,
+      top: dimensions.top
+    });
     return this.sendResponse(true);
   };
 
+  Browser.prototype.set_clip_rect = function(full, selector) {
+    var dimensions, document, rect, viewport, _ref;
+    dimensions = this.page.validatedDimensions();
+    _ref = [dimensions.document, dimensions.viewport], document = _ref[0], viewport = _ref[1];
+    rect = full ? {
+      left: 0,
+      top: 0,
+      width: document.width,
+      height: document.height
+    } : selector != null ? this.page.elementBounds(selector) : {
+      left: 0,
+      top: 0,
+      width: viewport.width,
+      height: viewport.height
+    };
+    this.page.setClipRect(rect);
+    return dimensions;
+  };
+
   Browser.prototype.resize = function(width, height) {
     this.page.setViewportSize({
       width: width,
@@ -367,6 +383,10 @@ Poltergeist.Browser = (function() {
     return this.sendResponse(this.page.networkTraffic());
   };
 
+  Browser.prototype.get_headers = function() {
+    return this.sendResponse(this.page.getCustomHeaders());
+  };
+
   Browser.prototype.set_headers = function(headers) {
     if (headers['User-Agent']) {
       this.page.setUserAgent(headers['User-Agent']);
@@ -375,6 +395,23 @@ Poltergeist.Browser = (function() {
     return this.sendResponse(true);
   };
 
+  Browser.prototype.add_headers = function(headers) {
+    var allHeaders, name, value;
+    allHeaders = this.page.getCustomHeaders();
+    for (name in headers) {
+      value = headers[name];
+      allHeaders[name] = value;
+    }
+    return this.set_headers(allHeaders);
+  };
+
+  Browser.prototype.add_header = function(header, permanent) {
+    if (!permanent) {
+      this.page.addTempHeader(header);
+    }
+    return this.add_headers(header);
+  };
+
   Browser.prototype.response_headers = function() {
     return this.sendResponse(this.page.responseHeaders());
   };