poltergeist 1.1.2 → 1.2.0

data/README.md

@@ -9,7 +9,16 @@ 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.2).](https://github.com/jonleighton/poltergeist/tree/v1.1.2)**
+(1.2.0).](https://github.com/jonleighton/poltergeist/tree/v1.2.0)**
+
+## Getting help ##
+
+Questions should be posted [on Stack
+Overflow, using the 'poltergeist' tag](http://stackoverflow.com/questions/tagged/poltergeist).
+
+Bug reports should be posted [on
+GitHub](https://github.com/jonleighton/poltergeist/issues) (and be sure
+to read the bug reporting guidance below).
 
 ## Installation ##
 
@@ -45,6 +54,9 @@ bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.8.1-li
 binary.
 * Extract the tarball and copy `bin/phantomjs` into your `PATH`
 
+### Windows ###
+* Download the [precompiled binary](http://phantomjs.org/download.html) for Windows
+
 ### Manual compilation ###
 
 Do this as a last resort if the binaries don't work for you. It will
@@ -59,13 +71,13 @@ guide](http://phantomjs.org/build.html).)
 
 ## Compatibility ##
 
-Poltergeist runs on MRI 1.9, JRuby 1.9 and Rubinius 1.9.
+Poltergeist runs on MRI 1.9, JRuby 1.9 and Rubinius 1.9. Poltergeist
+and PhantomJS are currently supported on Mac OS X, Linux, and Windows
+platforms.
 
 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.
 
-Poltergeist does not currently support the Windows operating system.
-
 ## Running on a CI ##
 
 There are no special steps to take. You don't need Xvfb or any running X
@@ -92,19 +104,20 @@ and the following optional features:
 * `page.within_window`
 * `page.status_code`
 * `page.response_headers`
+* `page.save_screenshot`
 * cookie handling
 * drag-and-drop
 
 There are some additional features:
 
-### Taking screenshots ###
+### Taking screenshots with some extensions ###
 
 You can grab screenshots of the page at any point by calling
-`page.driver.render('/path/to/file.png')` (this works the same way as the PhantomJS
+`save_screenshot('/path/to/file.png')` (this works the same way as the PhantomJS
 render feature, so you can specify other extensions like `.pdf`, `.gif`, etc.)
 
 By default, only the viewport will be rendered (the part of the page that is in view). To render
-the entire page, use `page.driver.render('/path/to/file.png', :full => true)`.
+the entire page, use `save_screenshot('/path/to/file.png', :full => true)`.
 
 ### Resizing the window ###
 
@@ -125,6 +138,18 @@ 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.
 
+You can register this debugger driver with a different name and set it
+as the current javascript driver. By example, in your helper file:
+
+```ruby
+Capybara.register_driver :poltergeist_debug do |app|
+  Capybara::Poltergeist::Driver.new(app, :inspector => true)
+end
+
+# Capybara.javascript_driver = :poltergeist
+Capybara.javascript_driver = :poltergeist_debug
+```
+
 [Read more
 here](http://jonathanleighton.com/articles/2012/poltergeist-0-6-0/)
 
@@ -225,7 +250,7 @@ If you experience sporadic crashes a lot, it may be worth configuring
 your CI to automatically re-run failing tests before reporting a failed
 build.
 
-### ClickFailed errors ###
+### MouseEventFailed errors ###
 
 When Poltergeist clicks on an element, rather than generating a DOM
 click event, it actually generates a "proper" click. This is much closer
@@ -238,7 +263,7 @@ your user won't be able to click a covered up element either).
 Sometimes there can be issues with this behavior. If you have problems,
 it's worth taking screenshots of the page and trying to work out what's
 going on. If your click is failing, but you're not getting a
-`ClickFailed` error, then you can turn on the `:debug` option and look
+`MouseEventFailed` error, then you can turn on the `:debug` option and look
 in the output to see what co-ordinates Poltergeist is using for the
 click. You can then cross-reference this with a screenshot to see if
 something is obviously wrong.
@@ -299,18 +324,22 @@ Include as much information as possible. For example:
 
 ## Changes ##
 
-### 1.1.2 ###
+### 1.2.0 ###
 
-#### Bug fixes #####
-
-*   Tie to faye-websocket 0.4 as 0.5 introduces incompatibilities.
+#### Features ####
 
-### 1.1.1 ###
+*   Support for Windows hosted Poltergeist (Aaron Tull).
+*   Capybara 2.1 support
 
-#### Features ####
+#### Bug fixes ####
 
-*   Changed Capybara dependency to `~> 2.0.1` because Poltergeist 1.1 is
-    not compatible with Capybara 2.1.
+*   Reverted the "native" implementation for filling in form fields,
+    which was introduced in 1.0. This implementation caused various bugs
+    and in general doesn't seem to be worth the trouble at the moment.
+    It can be reconsidered in the future when PhantomJS has upgraded its
+    WebKit version. [Issue #176, #223]
+*   Run phantomjs in a new process group so ^C doesn't trigger a
+    DeadClient error [Issue #252]
 
 ### 1.1.0 ###
 
@@ -327,6 +356,10 @@ Include as much information as possible. For example:
 *   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.
+*   Add the ability to extend the phantomjs environment via browser
+    options. e.g.
+    `Capybara::Poltergeist::Driver.new( app, :extensions => ['file.js', 'another.js'])`
+    (Jon Rowe)
 
 #### Bug fixes ####
 
@@ -348,10 +381,6 @@ Include as much information as possible. For example:
     [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]

data/lib/capybara/poltergeist.rb

@@ -7,6 +7,7 @@ require 'capybara'
 
 module Capybara
   module Poltergeist
+    require 'capybara/poltergeist/utility'
     require 'capybara/poltergeist/driver'
     require 'capybara/poltergeist/browser'
     require 'capybara/poltergeist/node'

data/lib/capybara/poltergeist/browser.rb

@@ -1,8 +1,14 @@
+require "capybara/poltergeist/errors"
 require 'json'
 require 'time'
 
 module Capybara::Poltergeist
   class Browser
+    ERROR_MAPPINGS = {
+      "Poltergeist.JavascriptError" => JavascriptError,
+      "Poltergeist.FrameNotFound"   => FrameNotFound
+    }
+
     attr_reader :server, :client, :logger
 
     def initialize(server, client, logger = nil)
@@ -38,17 +44,25 @@ module Capybara::Poltergeist
       command 'source'
     end
 
-    def find(selector)
-      result = command('find', selector)
+    def title
+      command 'title'
+    end
+
+    def find(method, selector)
+      result = command('find', method, selector)
       result['ids'].map { |id| [result['page_id'], id] }
     end
 
-    def find_within(page_id, id, selector)
-      command 'find_within', page_id, id, selector
+    def find_within(page_id, id, method, selector)
+      command 'find_within', page_id, id, method, selector
     end
 
-    def text(page_id, id)
-      command 'text', page_id, id
+    def all_text(page_id, id)
+      command 'all_text', page_id, id
+    end
+
+    def visible_text(page_id, id)
+      command 'visible_text', page_id, id
     end
 
     def attribute(page_id, id, name)
@@ -75,6 +89,10 @@ module Capybara::Poltergeist
       command 'visible', page_id, id
     end
 
+    def disabled?(page_id, id)
+      command 'disabled', page_id, id
+    end
+
     def click_coordinates(x, y)
       command 'click_coordinates', x, y
     end
@@ -87,8 +105,13 @@ module Capybara::Poltergeist
       command 'execute', script
     end
 
-    def within_frame(name, &block)
-      command 'push_frame', name
+    def within_frame(handle, &block)
+      if handle.is_a?(Capybara::Node::Base)
+        command 'push_frame', handle['id']
+      else
+        command 'push_frame', handle
+      end
+
       yield
     ensure
       command 'pop_frame'
@@ -109,6 +132,10 @@ module Capybara::Poltergeist
       command 'double_click', page_id, id
     end
 
+    def hover(page_id, id)
+      command 'hover', page_id, id
+    end
+
     def drag(page_id, id, other_id)
       command 'drag', page_id, id, other_id
     end
@@ -193,14 +220,11 @@ module Capybara::Poltergeist
       log json.inspect
 
       if json['error']
-        if json['error']['name'] == 'Poltergeist.JavascriptError'
-          raise JavascriptError.new(json['error'])
-        else
-          raise BrowserError.new(json['error'])
-        end
+        klass = ERROR_MAPPINGS[json['error']['name']] || BrowserError
+        raise klass.new(json['error'])
+      else
+        json['response']
       end
-      json['response']
-
     rescue DeadClient
       restart
       raise

data/lib/capybara/poltergeist/client.rb

@@ -1,4 +1,5 @@
 require "timeout"
+require "capybara/poltergeist/utility"
 
 module Capybara::Poltergeist
   class Client
@@ -37,20 +38,23 @@ module Capybara::Poltergeist
       }
 
       redirect_stdout(write) do
-        @pid = Process.spawn(*command.map(&:to_s))
+        @pid = Process.spawn(*command.map(&:to_s), pgroup: true)
       end
     end
 
     def stop
       if pid
         begin
-          Process.kill('TERM', pid)
-
-          begin
-            Timeout.timeout(KILL_TIMEOUT) { Process.wait(pid) }
-          rescue Timeout::Error
+          if Capybara::Poltergeist.windows?
             Process.kill('KILL', pid)
-            Process.wait(pid)
+          else
+            Process.kill('TERM', pid)
+            begin
+              Timeout.timeout(KILL_TIMEOUT) { Process.wait(pid) }
+            rescue Timeout::Error
+              Process.kill('KILL', pid)
+              Process.wait(pid)
+            end
           end
         rescue Errno::ESRCH, Errno::ECHILD
           # Zed's dead, baby

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

@@ -27,14 +27,14 @@ class PoltergeistAgent
   currentUrl: ->
     window.location.toString()
 
-  find: (selector, within = document) ->
-    results = document.evaluate(selector, within, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null)
-    ids     = []
-
-    for i in [0...results.snapshotLength]
-      ids.push(this.register(results.snapshotItem(i)))
+  find: (method, selector, within = document) ->
+    if method == "xpath"
+      xpath   = document.evaluate(selector, within, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null)
+      results = (xpath.snapshotItem(i) for i in [0...xpath.snapshotLength])
+    else
+      results = within.querySelectorAll(selector)
 
-    ids
+    this.register(el) for el in results
 
   register: (element) ->
     @elements.push(element)
@@ -73,8 +73,8 @@ class PoltergeistAgent.Node
   parentId: ->
     @agent.register(@element.parentNode)
 
-  find: (selector) ->
-    @agent.find(selector, @element)
+  find: (method, selector) ->
+    @agent.find(method, selector, @element)
 
   isObsolete: ->
     obsolete = (element) =>
@@ -92,12 +92,41 @@ 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 == document.body ||
     document.evaluate('ancestor::body', @element, null, XPathResult.BOOLEAN_TYPE, null).booleanValue
 
-  text: ->
-    if @element.tagName == 'TEXTAREA'
+  allText: ->
+    @element.textContent
+
+  visibleText: ->
+    if @element.nodeName == "TEXTAREA"
       @element.textContent
     else
       @element.innerText
@@ -117,6 +146,27 @@ class PoltergeistAgent.Node
     else
       @element.value
 
+  set: (value) ->
+    return if @element.readOnly
+
+    if (@element.maxLength >= 0)
+      value = value.substr(0, @element.maxLength)
+
+    @element.value = ''
+    this.trigger('focus')
+
+    for char in value
+      keyCode = this.characterToKeyCode(char)
+      this.keyupdowned('keydown', keyCode)
+      @element.value += char
+
+      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
 
@@ -147,6 +197,9 @@ class PoltergeistAgent.Node
     else
       true
 
+  isDisabled: ->
+    @element.disabled || @element.tagName == 'OPTION' && @element.parentNode.disabled
+
   frameOffset: ->
     win    = window
     offset = { top: 0, left: 0 }
@@ -191,14 +244,7 @@ class PoltergeistAgent.Node
 
     @element.dispatchEvent(event)
 
-  focusAndHighlight: ->
-    @element.focus()
-    @element.select()
-
-  blur: ->
-    @element.blur()
-
-  clickTest: (x, y) ->
+  mouseEventTest: (x, y) ->
     frameOffset = this.frameOffset()
 
     x -= frameOffset.left
@@ -222,6 +268,45 @@ 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