poltergeist 1.0.3 → 1.1.0

data/README.md

@@ -1,13 +1,16 @@
 # Poltergeist - A PhantomJS driver for Capybara #
 
-Version: 1.0.3
-
 [![Build Status](https://secure.travis-ci.org/jonleighton/poltergeist.png)](http://travis-ci.org/jonleighton/poltergeist)
 
 Poltergeist is a driver for [Capybara](https://github.com/jnicklas/capybara). It allows you to
 run your Capybara tests on a headless [WebKit](http://webkit.org) browser,
 provided by [PhantomJS](http://www.phantomjs.org/).
 
+**If you're viewing this at https://github.com/jonleighton/poltergeist,
+you're reading the documentation for the master branch.
+[View documentation for the latest release
+(1.1.0).](https://github.com/jonleighton/poltergeist/tree/v1.1.0)**
+
 ## Installation ##
 
 Add `poltergeist` to your Gemfile, and in your test setup add:
@@ -24,20 +27,21 @@ detail](https://github.com/jnicklas/capybara/blob/master/README.md#transactions-
 
 ## Installing PhantomJS ##
 
-You need at least PhantomJS 1.7.0.  There are *no other external
+You need at least PhantomJS 1.8.1.  There are *no other external
 dependencies* (you don't need Qt, or a running X server, etc.)
 
 ### Mac ###
 
 * *Homebrew*: `brew install phantomjs`
-* *Manual install*: [Download this](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.7.0-macosx.zip&can=2&q=)
+* *MacPorts*: `sudo port install phantomjs`
+* *Manual install*: [Download this](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.8.1-macosx.zip&can=2&q=)
 
 ### Linux ###
 
 * Download the [32
-bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.7.0-linux-i686.tar.bz2&can=2&q=)
+bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.8.1-linux-i686.tar.bz2&can=2&q=)
 or [64
-bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.7.0-linux-x86_64.tar.bz2&can=2&q=)
+bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.8.1-linux-x86_64.tar.bz2&can=2&q=)
 binary.
 * Extract the tarball and copy `bin/phantomjs` into your `PATH`
 
@@ -46,7 +50,7 @@ binary.
 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.
 
-* Download [the source tarball](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.7.0-source.zip&can=2&q=)
+* Download [the source tarball](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.8.1-source.zip&can=2&q=)
 * Extract and cd in
 * `./build.sh`
 
@@ -55,13 +59,12 @@ guide](http://phantomjs.org/build.html).)
 
 ## Compatibility ##
 
-Supported: MRI 1.8.7, MRI 1.9.2, MRI 1.9.3, JRuby 1.8, JRuby 1.9,
-Rubinius 1.8 on UNIX platforms.
+Poltergeist runs on MRI 1.9, JRuby 1.9 and Rubinius 1.9.
 
-Not supported: Rubinius 1.9, Windows.
+Ruby 1.8 is no longer supported. The last release to support Ruby 1.8
+was 1.0.2, so you should use that if you still need Ruby 1.8 support.
 
-Contributions are welcome in order to move 'unsupported'
-items into the 'supported' list.
+Poltergeist does not currently support the Windows operating system.
 
 ## Running on a CI ##
 
@@ -108,6 +111,11 @@ 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)`.
 
+### Clicking precise coordinates ###
+
+Sometimes its desirable to click a very specific area of the screen. You can accomplish this with
+`page.driver.click(x, y)`, where x and y are the screen coordinates.
+
 ### Remote debugging (experimental) ###
 
 If you use the `:inspector => true` option (see below), remote debugging
@@ -167,17 +175,22 @@ end
 `options` is a hash of options. The following options are supported:
 
 *   `:phantomjs` (String) - A custom path to the phantomjs executable
-*   `:debug` (Boolean) - When true, debug output is logged to `STDERR`
+*   `:debug` (Boolean) - When true, debug output is logged to `STDERR`.
+    Some debug info from the PhantomJS portion of Poltergeist is also
+    output, but this goes to `STDOUT` due to technical limitations.
 *   `:logger` (Object responding to `puts`) - When present, debug output is written to this object
+*   `:phantomjs_logger` (`IO` object) - Where the `STDOUT` from PhantomJS is written to. This is
+    where you `console.log` statements will show up. Default: `STDOUT`
 *   `:timeout` (Numeric) - The number of seconds we'll wait for a response
-    when communicating with PhantomJS. `nil` means wait forever. Default
-    is 30.
+    when communicating with PhantomJS. Default is 30.
 *   `:inspector` (Boolean, String) - See 'Remote Debugging', above.
 *   `:js_errors` (Boolean) - When false, Javascript errors do not get re-raised in Ruby.
 *   `:window_size` (Array) - The dimensions of the browser window in which to test, expressed
     as a 2-element array, e.g. [1024, 768]. Default: [1024, 768]
-*   `:phantomjs_options` (Array) - Additional [command line options](http://code.google.com/p/phantomjs/wiki/Interface#Command-line_Options)
+*   `:phantomjs_options` (Array) - Additional [command line options](https://github.com/ariya/phantomjs/wiki/API-Reference)
     to be passed to PhantomJS, e.g. `['--load-images=no', '--ignore-ssl-errors=yes']`
+*   `:extensions` (Array) - An array of JS files to be preloaded into
+    the phantomjs browser. Useful for faking unsupported APIs.
 *   `:port` (Fixnum) - The port which should be used to communicate
     with the PhantomJS process. Default: 44678.
 
@@ -286,11 +299,50 @@ Include as much information as possible. For example:
 
 ## Changes ##
 
-### 1.0.3 ###
+### 1.1.0 ###
+
+#### Features ####
+
+*   Add support for custom phantomjs loggers via `:phantomjs_logger` option.
+    (Gabe Bell)
+*   Add `page.driver.click(x, y)` to click precise coordinates.
+    (Micah Geisel)
+*   Add Capybara 2.0 support. Capybara 1.1 and Ruby 1.8 are *no
+    longer supported*. (Mauro Asprea) [Issue #163]
+*   Add `node.base.double_click` to double click the node.
+    (Andy Shen)
+*   The `:debug` option now causes the PhantomJS portion of Poltergeist
+    to output some additional debug info, which may be useful in
+    figuring out timeout errors.
 
 #### Bug fixes ####
 
-*   Tied to faye-websocket 0.4, as 0.5 introduces incompatibilities.
+*   Fix timing issue when using `within_frame` that could cause errors.
+    [Issue #183, #211] (@errm, @motemen)
+*   Fix bug with `within_frame` not properly switching the context back
+    after the block has executed. [Issue #242]
+*   Fix calculation of click position when clicking within a frame.
+    [Issue #222, #225]
+*   Fix error raising when calling `expires` if not set on cookie.
+    [Issue #203] (@arnvald)
+*   Fix the `:js_errors` option. Previously errors were not being
+    reported, but would still cause commands to fail. [Issue #229]
+*   Fix incorrect time zone handling when setting cookie expiry time
+    [Issue #228]
+*   Send SIGKILL to PhantomJS if it doesn't exit within 2 seconds
+    [Issue #196]
+*   Provide a more informative message for the `ObsoleteNode` error.
+    [Issue #192]
+*   Fix `ObsoleteNode` error when using `attach_file` with the `jQuery
+    File Upload` plugin. [Issue #115]
+*   Add the ability to extend the phantomjs environment via browser
+    options. e.g.
+    `Capybara::Poltergeist::Driver.new( app, :extensions => ['file.js', 'another.js'])`
+    (@JonRowe)
+*   Ensure that a `String` is passed over-the-wire to PhantomJS for
+    file input paths, allowing `attach_file` to be called with arbitry
+    objects such as a Pathname. (@mjtko) [Issue #215]
+*   Cookies can now be set before the first request. [Issue #193]
 
 ### 1.0.2 ###
 

data/lib/capybara/poltergeist.rb

@@ -1,3 +1,8 @@
+if RUBY_VERSION < "1.9.2"
+  raise "This version of Capybara/Poltergeist does not support Ruby versions " \
+        "less than 1.9.2."
+end
+
 require 'capybara'
 
 module Capybara
@@ -9,12 +14,9 @@ module Capybara
     require 'capybara/poltergeist/web_socket_server'
     require 'capybara/poltergeist/client'
     require 'capybara/poltergeist/inspector'
-    require 'capybara/poltergeist/spawn'
-    require 'capybara/poltergeist/json'
     require 'capybara/poltergeist/network_traffic'
     require 'capybara/poltergeist/errors'
     require 'capybara/poltergeist/cookie'
-    require 'capybara/poltergeist/util'
   end
 end
 

data/lib/capybara/poltergeist/browser.rb

@@ -1,20 +1,21 @@
-require 'multi_json'
+require 'json'
 require 'time'
 
 module Capybara::Poltergeist
   class Browser
-    attr_reader :server, :client, :logger, :js_errors
+    attr_reader :server, :client, :logger
 
-    def initialize(server, client, logger = nil, js_errors = true)
-      @server     = server
-      @client     = client
-      @logger     = logger
-      @js_errors  = js_errors
+    def initialize(server, client, logger = nil)
+      @server = server
+      @client = client
+      @logger = logger
     end
 
     def restart
       server.restart
       client.restart
+
+      self.debug = @debug if @debug
     end
 
     def visit(url)
@@ -74,6 +75,10 @@ module Capybara::Poltergeist
       command 'visible', page_id, id
     end
 
+    def click_coordinates(x, y)
+      command 'click_coordinates', x, y
+    end
+
     def evaluate(script)
       command 'evaluate', script
     end
@@ -100,6 +105,10 @@ module Capybara::Poltergeist
       command 'click', page_id, id
     end
 
+    def double_click(page_id, id)
+      command 'double_click', page_id, id
+    end
+
     def drag(page_id, id, other_id)
       command 'drag', page_id, id, other_id
     end
@@ -150,8 +159,8 @@ module Capybara::Poltergeist
     end
 
     def set_cookie(cookie)
-      if cookie[:expires].respond_to?(:httpdate)
-        cookie[:expires] = cookie[:expires].httpdate
+      if cookie[:expires]
+        cookie[:expires] = cookie[:expires].to_i * 1000
       end
 
       command 'set_cookie', cookie
@@ -161,21 +170,31 @@ module Capybara::Poltergeist
       command 'remove_cookie', name
     end
 
+    def js_errors=(val)
+      command 'set_js_errors', !!val
+    end
+
+    def extensions=(names)
+      Array(names).each do |name|
+        command 'add_extension', name
+      end
+    end
+
+    def debug=(val)
+      @debug = val
+      command 'set_debug', !!val
+    end
+
     def command(name, *args)
       message = { 'name' => name, 'args' => args }
       log message.inspect
 
-      json = JSON.load(server.send(JSON.dump(message)))
+      json = JSON.load(server.send(JSON.generate(message)))
       log json.inspect
 
       if json['error']
         if json['error']['name'] == 'Poltergeist.JavascriptError'
-          error = JavascriptError.new(json['error'])
-          if js_errors
-            raise error
-          else
-            log error
-          end
+          raise JavascriptError.new(json['error'])
         else
           raise BrowserError.new(json['error'])
         end

data/lib/capybara/poltergeist/client.rb

@@ -1,22 +1,27 @@
+require "timeout"
+
 module Capybara::Poltergeist
   class Client
     PHANTOMJS_SCRIPT  = File.expand_path('../client/compiled/main.js', __FILE__)
-    PHANTOMJS_VERSION = '1.7.0'
+    PHANTOMJS_VERSION = '1.8.1'
     PHANTOMJS_NAME    = 'phantomjs'
 
+    KILL_TIMEOUT = 2 # seconds
+
     def self.start(*args)
       client = new(*args)
       client.start
       client
     end
 
-    attr_reader :pid, :port, :path, :window_size, :phantomjs_options
+    attr_reader :pid, :server, :path, :window_size, :phantomjs_options
 
-    def initialize(port, options = {})
-      @port              = port
+    def initialize(server, options = {})
+      @server            = server
       @path              = options[:path]              || PHANTOMJS_NAME
       @window_size       = options[:window_size]       || [1024, 768]
       @phantomjs_options = options[:phantomjs_options] || []
+      @phantomjs_logger  = options[:phantomjs_logger]  || $stdout
 
       pid = Process.pid
       at_exit { stop if Process.pid == pid }
@@ -24,18 +29,34 @@ module Capybara::Poltergeist
 
     def start
       check_phantomjs_version
-      @pid = Spawn.spawn(*command)
+      read, write = IO.pipe
+      @out_thread = Thread.new {
+        while !read.eof? && data = read.readpartial(1024)
+          @phantomjs_logger.write(data)
+        end
+      }
+
+      redirect_stdout(write) do
+        @pid = Process.spawn(*command.map(&:to_s))
+      end
     end
 
     def stop
       if pid
         begin
           Process.kill('TERM', pid)
-          Process.wait(pid)
+
+          begin
+            Timeout.timeout(KILL_TIMEOUT) { Process.wait(pid) }
+          rescue Timeout::Error
+            Process.kill('KILL', pid)
+            Process.wait(pid)
+          end
         rescue Errno::ESRCH, Errno::ECHILD
           # Zed's dead, baby
         end
 
+        @out_thread.kill
         @pid = nil
       end
     end
@@ -46,14 +67,12 @@ module Capybara::Poltergeist
     end
 
     def command
-      @command ||= begin
-        parts = [path]
-        parts.concat phantomjs_options
-        parts << PHANTOMJS_SCRIPT
-        parts << port
-        parts.concat window_size
-        parts
-      end
+      parts = [path]
+      parts.concat phantomjs_options
+      parts << PHANTOMJS_SCRIPT
+      parts << server.port
+      parts.concat window_size
+      parts
     end
 
     private
@@ -71,5 +90,18 @@ module Capybara::Poltergeist
 
       @phantomjs_version_checked = true
     end
+
+    # This abomination is because JRuby doesn't support the :out option of
+    # Process.spawn
+    def redirect_stdout(to)
+      prev = STDOUT.dup
+      prev.autoclose = false
+      $stdout = to
+      STDOUT.reopen(to)
+      yield
+    ensure
+      STDOUT.reopen(prev)
+      $stdout = STDOUT
+    end
   end
 end

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

@@ -52,6 +52,12 @@ class PoltergeistAgent
     throw new PoltergeistAgent.ObsoleteNode if node.isObsolete()
     node[name].apply(node, args)
 
+  beforeUpload: (id) ->
+    this.get(id).setAttribute('_poltergeist_selected', '')
+
+  afterUpload: (id) ->
+    this.get(id).removeAttribute('_poltergeist_selected')
+
 class PoltergeistAgent.ObsoleteNode
   toString: -> "PoltergeistAgent.ObsoleteNode"
 
@@ -141,19 +147,35 @@ class PoltergeistAgent.Node
     else
       true
 
+  frameOffset: ->
+    win    = window
+    offset = { top: 0, left: 0 }
+
+    while win.frameElement
+      rect = window.frameElement.getClientRects()[0]
+      win  = win.parent
+
+      offset.top  += rect.top
+      offset.left += rect.left
+
+    offset
+
   position: ->
     rect = @element.getClientRects()[0]
     throw new PoltergeistAgent.ObsoleteNode unless rect
+    frameOffset = this.frameOffset()
 
-    {
-      top:    rect.top,
-      right:  rect.right,
-      left:   rect.left,
-      bottom: rect.bottom,
+    pos = {
+      top:    rect.top    + frameOffset.top,
+      right:  rect.right  + frameOffset.left,
+      left:   rect.left   + frameOffset.left,
+      bottom: rect.bottom + frameOffset.top,
       width:  rect.width,
       height: rect.height
     }
 
+    pos
+
   trigger: (name) ->
     if Node.EVENTS.MOUSE.indexOf(name) != -1
       event = document.createEvent('MouseEvent')
@@ -177,6 +199,11 @@ class PoltergeistAgent.Node
     @element.blur()
 
   clickTest: (x, y) ->
+    frameOffset = this.frameOffset()
+
+    x -= frameOffset.left
+    y -= frameOffset.top
+
     el = origEl = document.elementFromPoint(x, y)
 
     while el