poltergeist 0.6.0 → 0.7.0

data/README.md

@@ -1,6 +1,6 @@
 # Poltergeist - A PhantomJS driver for Capybara #
 
-Version: 0.6.0
+Version: 0.7.0
 
 [![Build Status](https://secure.travis-ci.org/jonleighton/poltergeist.png)](http://travis-ci.org/jonleighton/poltergeist)
 [![Dependency Status](https://gemnasium.com/jonleighton/poltergeist.png)](https://gemnasium.com/jonleighton/poltergeist)
@@ -18,47 +18,31 @@ require 'capybara/poltergeist'
 Capybara.javascript_driver = :poltergeist
 ```
 
-## Important note about Rack versions < 1.3.0 ##
-
-Prior to version 1.3.0, the Rack handlers for Mongrel and Thin wrap your
-app in the `Rack::Chunked` middleware so that it uses
-`Transfer-Encoding: chunked`
-([commit](https://github.com/rack/rack/commit/50cdd0bf000a9ffb3eb3760fda2ff3e1ad18f3a7)).
-This has been observed to cause problems,
-probably due to race conditions in Qt's HTTP handling code, so you are
-recommended to avoid this by specifying your own server setup for
-Capybara:
-
-``` ruby
-Capybara.server do |app, port|
-  require 'rack/handler/thin'
-  Thin::Logging.silent = true
-  Thin::Server.new('0.0.0.0', port, app).start
-end
-```
-
-If you're using Rails 3.0, this affects you. If you're using Rails 3.1+,
-this doesn't affect you.
+If you were previously using the `:rack_test` driver, be aware that
+your app will now run in a separate thread and this can have
+consequences for transactional tests. [See the Capybara README for more
+detail](https://github.com/jnicklas/capybara/blob/master/README.md#transactions-and-database-setup).
 
 ## Installing PhantomJS ##
 
-You need PhantomJS 1.5.0. There are no other dependencies (you don't
-need Qt, or Xvfb, etc.)
+You need at least PhantomJS 1.6.0, but 1.6.1 is recommended as there some issues with the former.
+There are *no other external dependencies* (you don't need Qt, or a running X
+server, etc.)
 
 ### Mac ###
 
-* *With homebrew*: `brew install phantomjs`
-* *Without homebrew*: [Download this](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.5.0-macosx-static.zip&can=2&q=)
+* *Manual install*: [Download this](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.6.1-macosx-static.zip&can=2&q=)
+* *Homebrew*: `brew install phantomjs`
 
 ### Linux ###
 
 * Download the [32
-bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.5.0-linux-x86-dynamic.tar.gz&can=2&q=)
+bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.6.1-linux-i686-dynamic.tar.bz2&can=2&q=)
 or [64
-bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.5.0-linux-x86_64-dynamic.tar.gz&can=2&q=)
+bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.6.1-linux-x86_64-dynamic.tar.bz2&can=2&q=)
 binary.
-* Extract it: `sudo tar xvzf phantomjs-1.5.0-linux-*-dynamic.tar.gz -C /usr/local`
-* Link it: `sudo ln -s /usr/local/phantomjs/bin/phantomjs /usr/local/bin/phantomjs`
+* Extract it: `sudo tar xvjf phantomjs-1.6.1-linux-*-dynamic.tar.gz -C /usr/local`
+* Link it: `sudo ln -s /usr/local/phantomjs-1.6.1-linux*/bin/phantomjs /usr/local/bin/phantomjs`
 
 (Note that you cannot copy the `/usr/local/phantomjs/bin/phantomjs`
 binary elsewhere on its own as it dynamically links with other files in
@@ -69,7 +53,7 @@ binary elsewhere on its own as it dynamically links with other files in
 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.5.0-source.tar.gz&can=2&q=)
+* Download [the source tarball](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.6.1-source.zip&can=2&q=)
 * Extract and cd in
 * `./build.sh`
 
@@ -79,7 +63,7 @@ Supported: MRI 1.8.7, MRI 1.9.2, MRI 1.9.3, JRuby 1.8, JRuby 1.9.
 
 Not supported:
 
-* Rubinius (due to some unknown socket related issues)
+* Rubinius
 * Windows
 
 Contributions are welcome in order to move 'unsupported'
@@ -90,11 +74,11 @@ items into the 'supported' list.
 There are no special steps to take. You don't need Xvfb or any running X
 server at all.
 
-[Travis CI](http://travis-ci.org/) has PhantomJS 1.5.0 installed.
-
-You may like to use their [chef
-cookbook](https://github.com/travis-ci/travis-cookbooks/tree/master/ci_environment/phantomjs)
-on your own servers.
+Depending on your tests, one thing that you may need is some fonts. If
+you're getting errors on a CI that don't occur during development then
+try taking some screenshots - it may well be missing fonts throwing
+things off kilter. Your distro will have various font packages available
+to install.
 
 ## What's supported? ##
 
@@ -126,9 +110,28 @@ When this option is enabled, you can insert `page.driver.debug` into
 your tests to pause the test and launch a browser which gives you the
 WebKit inspector to view your test run with.
 
-(This feature is considered experimental - it needs more polish
-and [apparently will only work on
-Linux](http://code.google.com/p/phantomjs/issues/detail?id=430).)
+[Read more
+here](http://jonathanleighton.com/articles/2012/poltergeist-0-6-0/)
+
+### Setting request headers ###
+
+Additional HTTP request headers can be set like so:
+
+``` ruby
+page.driver.headers = {
+  "Cookie" => "foo=bar",
+  "Host"   => "foo.com"
+}
+```
+
+They will be cleared between tests, so you do not have to do this manually.
+
+### Inspecting network traffic ###
+
+You can inspect the network traffic (i.e. what resources have been
+loaded) on the current page by calling `page.driver.network_traffic`.
+This returns an array of request objects. A request object has a
+`response_parts` method containing data about the response chunks.
 
 ## Customization ##
 
@@ -150,6 +153,11 @@ end
     when communicating with PhantomJS. `nil` means wait forever. 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)
+    to be passed to PhantomJS, e.g. `['--load-images=no', '--ignore-ssl-errors=yes']`
 
 ## Bugs ##
 
@@ -173,6 +181,35 @@ makes debugging easier). Running `rake autocompile` will watch the
 
 ## Changes ##
 
+### 0.7.0 ###
+
+#### Features ####
+
+*   Added an option `:js_errors`, allowing poltergeist to continue
+    running after JS errors. (John Griffin & Tom Stuart) [Issue #62] [Issue #69]
+*   Added an option `:window_size`, allowing users to specify
+    dimensions to which the browser window will be resized.
+    (Tom Stuart) [Issue #53]
+*   Capybara 1.0 is no longer supported. Capybara ~> 1.1 is required.
+*   Added ability to set arbitrary http request headers
+*   Inspect network traffic on the page via
+    `page.driver.network_traffic` (Doug McInnes) [Issue #77]
+*   Added an option `:phantomjs_options`, allowing users to specify
+    additional command-line options passed to phantomjs executable.
+    (wynst) [Issue #97]
+*   Scroll element into viewport if needed on click (Gabriel Sobrinho)
+    [Issue #83]
+*   Added status code support. (Dmitriy Nesteryuk and Jon Leighton) [Issue #37]
+
+#### Bug fixes ###
+
+*   Fix issue with `ClickFailed` exception happening with a negative
+    co-ordinate (which should be impossible). (Jon Leighton, Gabriel
+    Sobrinho, Tom Stuart) [Issue #60]
+*   Fix issue with `undefined method map for "[]":String`, which
+    happened when dealing with pages that include JS rewriting
+    Array.prototype.toJSON. (Tom Stuart) [Issue #63]
+
 ### 0.6.0 ###
 
 #### Features ####

data/lib/capybara/poltergeist.rb

@@ -2,17 +2,17 @@ require 'capybara'
 
 module Capybara
   module Poltergeist
-    autoload :Driver,          'capybara/poltergeist/driver'
-    autoload :Browser,         'capybara/poltergeist/browser'
-    autoload :Node,            'capybara/poltergeist/node'
-    autoload :ServerManager,   'capybara/poltergeist/server_manager'
-    autoload :Server,          'capybara/poltergeist/server'
-    autoload :WebSocketServer, 'capybara/poltergeist/web_socket_server'
-    autoload :Client,          'capybara/poltergeist/client'
-    autoload :Util,            'capybara/poltergeist/util'
-    autoload :Inspector,       'capybara/poltergeist/inspector'
-    autoload :Spawn,           'capybara/poltergeist/spawn'
-
+    require 'capybara/poltergeist/driver'
+    require 'capybara/poltergeist/browser'
+    require 'capybara/poltergeist/node'
+    require 'capybara/poltergeist/server'
+    require 'capybara/poltergeist/web_socket_server'
+    require 'capybara/poltergeist/client'
+    require 'capybara/poltergeist/util'
+    require 'capybara/poltergeist/inspector'
+    require 'capybara/poltergeist/spawn'
+    require 'capybara/poltergeist/json'
+    require 'capybara/poltergeist/network_traffic'
     require 'capybara/poltergeist/errors'
   end
 end

data/lib/capybara/poltergeist/browser.rb

@@ -2,12 +2,13 @@ require 'multi_json'
 
 module Capybara::Poltergeist
   class Browser
-    attr_reader :server, :client, :logger
+    attr_reader :server, :client, :logger, :js_errors
 
-    def initialize(server, client, logger = nil)
-      @server = server
-      @client = client
-      @logger = logger
+    def initialize(server, client, logger = nil, js_errors = true)
+      @server     = server
+      @client     = client
+      @logger     = logger
+      @js_errors  = js_errors
     end
 
     def restart
@@ -15,14 +16,18 @@ module Capybara::Poltergeist
       client.restart
     end
 
-    def visit(url)
-      command 'visit', url
+    def visit(url, headers)
+      command 'visit', url, headers
     end
 
     def current_url
       command 'current_url'
     end
 
+    def status_code
+      command 'status_code'
+    end
+
     def body
       command 'body'
     end
@@ -79,6 +84,7 @@ module Capybara::Poltergeist
     def within_frame(id, &block)
       command 'push_frame', id
       yield
+    ensure
       command 'pop_frame'
     end
 
@@ -103,29 +109,46 @@ module Capybara::Poltergeist
     end
 
     def render(path, options = {})
-      command 'render', path, !!options[:full]
+      command 'render', path.to_s, !!options[:full]
     end
 
     def resize(width, height)
       command 'resize', width, height
     end
 
+    def network_traffic
+      command('network_traffic').values.map do |event|
+        NetworkTraffic::Request.new(
+          event['request'],
+          event['responseParts'].map { |response| NetworkTraffic::Response.new(response) }
+        )
+      end
+    end
+
+    def equals(page_id, id, other_id)
+      command('equals', page_id, id, other_id)
+    end
+
     def command(name, *args)
       message = { 'name' => name, 'args' => args }
       log message.inspect
 
-      json = MultiJson.decode(server.send(MultiJson.encode(message)))
+      json = JSON.load(server.send(JSON.dump(message)))
       log json.inspect
 
       if json['error']
         if json['error']['name'] == 'Poltergeist.JavascriptError'
-          raise JavascriptError.new(json['error'])
+          error = JavascriptError.new(json['error'])
+          if js_errors
+            raise error
+          else
+            log error
+          end
         else
           raise BrowserError.new(json['error'])
         end
-      else
-        json['response']
       end
+      json['response']
 
     rescue DeadClient
       restart

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.5.0'
+    PHANTOMJS_VERSION = '1.6.0'
     PHANTOMJS_NAME    = 'phantomjs'
 
     def self.start(*args)
@@ -10,12 +10,13 @@ module Capybara::Poltergeist
       client
     end
 
-    attr_reader :pid, :port, :path, :inspector
+    attr_reader :pid, :port, :path, :window_size, :phantomjs_options
 
-    def initialize(port, inspector = nil, path = nil)
-      @port      = port
-      @inspector = inspector
-      @path      = path || PHANTOMJS_NAME
+    def initialize(port, options = {})
+      @port              = port
+      @path              = options[:path]              || PHANTOMJS_NAME
+      @window_size       = options[:window_size]       || [1024, 768]
+      @phantomjs_options = options[:phantomjs_options] || []
 
       pid = Process.pid
       at_exit { stop if Process.pid == pid }
@@ -47,14 +48,10 @@ module Capybara::Poltergeist
     def command
       @command ||= begin
         parts = [path]
-
-        if inspector
-          parts << "--remote-debugger-port=#{inspector.port}"
-          parts << "--remote-debugger-autorun=yes"
-        end
-
+        parts.concat phantomjs_options
         parts << PHANTOMJS_SCRIPT
         parts << port
+        parts.concat window_size
         parts
       end
     end

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

@@ -7,8 +7,18 @@ class PoltergeistAgent
     @windows  = []
     this.pushWindow(window)
 
-  externalCall: (name, arguments) ->
-    { value: this[name].apply(this, arguments) }
+  externalCall: (name, args) ->
+    try
+      { value: this[name].apply(this, args) }
+    catch error
+      { error: { message: error.toString(), stack: error.stack } }
+
+  @stringify: (object) ->
+    JSON.stringify object, (key, value) ->
+      if Array.isArray(this[key])
+        return this[key]
+      else
+        return value
 
   pushWindow: (new_window) ->
     @windows.push(new_window)
@@ -55,10 +65,10 @@ class PoltergeistAgent
   get: (id) ->
     @nodes[id] or= new PoltergeistAgent.Node(this, @elements[id])
 
-  nodeCall: (id, name, arguments) ->
+  nodeCall: (id, name, args) ->
     node = this.get(id)
     throw new PoltergeistAgent.ObsoleteNode if node.isObsolete()
-    node[name].apply(node, arguments)
+    node[name].apply(node, args)
 
 class PoltergeistAgent.ObsoleteNode
   toString: -> "PoltergeistAgent.ObsoleteNode"
@@ -91,7 +101,33 @@ class PoltergeistAgent.Node
 
   changed: ->
     event = document.createEvent('HTMLEvents')
-    event.initEvent("change", true, false)
+    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: ->
@@ -120,6 +156,9 @@ class PoltergeistAgent.Node
     else
       @element.getAttribute(name)
 
+  scrollIntoView: ->
+    @element.scrollIntoViewIfNeeded()
+
   value: ->
     if @element.tagName == 'SELECT' && @element.multiple
       option.value for option in @element.children when option.selected
@@ -130,8 +169,20 @@ class PoltergeistAgent.Node
     if (@element.maxLength >= 0)
       value = value.substr(0, @element.maxLength)
 
-    @element.value = value
+    @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
@@ -209,6 +260,48 @@ 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
+
 window.__poltergeist = new PoltergeistAgent
 
 document.addEventListener(