README.md in poltergeist-0.7.0 vs README.md in poltergeist-1.0.0
- old
+ new
@@ -1,11 +1,10 @@
# Poltergeist - A PhantomJS driver for Capybara #
-Version: 0.7.0
+Version: 1.0
[](http://travis-ci.org/jonleighton/poltergeist)
-[](https://gemnasium.com/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/).
@@ -23,70 +22,78 @@
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 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.)
+You need at least PhantomJS 1.7.0. There are *no other external
+dependencies* (you don't need Qt, or a running X server, etc.)
### Mac ###
-* *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`
+* *Manual install*: [Download this](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.7.0-macosx.zip&can=2&q=)
### Linux ###
* Download the [32
-bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.6.1-linux-i686-dynamic.tar.bz2&can=2&q=)
+bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.7.0-linux-i686.tar.bz2&can=2&q=)
or [64
-bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.6.1-linux-x86_64-dynamic.tar.bz2&can=2&q=)
+bit](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.7.0-linux-x86_64.tar.bz2&can=2&q=)
binary.
-* 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`
+* Extract the tarball and copy `bin/phantomjs` into your `PATH`
-(Note that you cannot copy the `/usr/local/phantomjs/bin/phantomjs`
-binary elsewhere on its own as it dynamically links with other files in
-`/usr/local/phantomjs/lib`.)
-
### Manual compilation ###
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.6.1-source.zip&can=2&q=)
+* Download [the source tarball](http://code.google.com/p/phantomjs/downloads/detail?name=phantomjs-1.7.0-source.zip&can=2&q=)
* Extract and cd in
* `./build.sh`
+(See also the [PhantomJS building
+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.
+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.
-Not supported:
+Not supported: Rubinius 1.9, Windows.
-* Rubinius
-* Windows
-
Contributions are welcome in order to move 'unsupported'
items into the 'supported' list.
## Running on a CI ##
There are no special steps to take. You don't need Xvfb or any running X
server at all.
+[Travis CI](https://travis-ci.org/) has PhantomJS pre-installed, but it
+might not be the latest version. If you need to install the latest
+version, [check out the .travis.yml that Poltergeist
+uses](https://github.com/jonleighton/poltergeist/blob/master/.travis.yml).
+
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? ##
-Poltergeist supports basically everything that is supported by the stock Selenium driver,
-including Javascript, drag-and-drop, etc.
+Poltergeist supports all the mandatory features for a Capybara driver,
+and the following optional features:
+* `page.evaluate_script` and `page.execute_script`
+* `page.within_frame`
+* `page.within_window`
+* `page.status_code`
+* `page.response_headers`
+* cookie handling
+* drag-and-drop
+
There are some additional features:
### Taking screenshots ###
You can grab screenshots of the page at any point by calling
@@ -116,25 +123,38 @@
### Setting request headers ###
Additional HTTP request headers can be set like so:
``` ruby
-page.driver.headers = {
- "Cookie" => "foo=bar",
- "Host" => "foo.com"
-}
+page.driver.headers = { "User-Agent" => "Poltergeist" }
```
-They will be cleared between tests, so you do not have to do this manually.
+The extra headers will apply to all subsequent HTTP requests (including
+requests for assets, AJAX, etc). They will be automatically cleared at
+the end of the test.
### 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.
+### Manipulating cookies ###
+
+The following methods are used to inspect and manipulate cookies:
+
+* `page.driver.cookies` - a hash of cookies accessible to the current
+ page. The keys are cookie names. The values are `Cookie` objects, with
+ the following methods: `name`, `value`, `domain`, `path`, `secure?`,
+ `httponly?`, `expires`.
+* `page.driver.set_cookie(name, value, options = {})` - set a cookie.
+ The options hash can take the following keys: `:domain`, `:path`,
+ `:secure`, `:httponly`, `:expires`. `:expires` should be a `Time`
+ object.
+* `page.driver.remove_cookie(name)` - remove a cookie
+
## Customization ##
You can customize the way that Capybara sets up Poltegeist via the following code in your
test setup:
@@ -156,37 +176,170 @@
* `: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']`
+* `:port` (Fixnum) - The port which should be used to communicate
+ with the PhantomJS process. Default: 44678.
-## Bugs ##
+## Troubleshooting ##
-Please file bug reports on Github and include example code to reproduce the problem wherever
-possible. (Tests are even better.) Please also provide the output with
-`:debug` turned on, and screenshots if you think it's relevant.
+Unfortunately, the nature of full-stack testing is that things can and
+do go wrong from time to time. This section aims to highlight a number
+of common problems and provide ideas about how you can work around them.
-## Hacking ##
+### DeadClient errors ###
-Contributions are very welcome and I will happily give commit access to
-anyone who does a few good pull requests.
+Sometimes PhantomJS crashes during a test. There are basically two kinds
+of crashes: those that can be reproduced every time, and those that
+occur sporadically and are not easily reproduced.
-To get setup, run `bundle install`. You can run the full test suite with
-`rspec spec/` or `rake`.
+If your crash happens every time, you should read the [PhantomJS crash
+reporting
+guide](https://github.com/ariya/phantomjs/wiki/Crash-Reporting) and file
+a bug against PhantomJS. Feel free to also file a bug against
+Poltergeist in case there are workarounds that can be implemented within
+Poltergeist. Also, if lots of Poltergeist users are experiencing the
+same crash then fixing it will move up the priority list.
-While PhantomJS is capable of compiling and running CoffeeScript code
-directly, I prefer to compile the code myself and distribute that (it
-makes debugging easier). Running `rake autocompile` will watch the
-`.coffee` files for changes, and compile them into
-`lib/capybara/client/compiled`.
+If your crash is sporadic, there is less that can be done. Often these
+issues are very complicated and difficult to track down. It may be that
+the crash has already been fixed in a newer version of WebKit that will
+eventually find its way into PhantomJS. It's still worth reporting your
+bug against PhantomJS, but it's probably not worth filing a bug against
+Poltergeist as there's not much we can do.
+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 ###
+
+When Poltergeist clicks on an element, rather than generating a DOM
+click event, it actually generates a "proper" click. This is much closer
+to what happens when a real user clicks on the page - but it means that
+Poltergeist must scroll the page to where the element is, and work out
+the correct co-ordinates to click. If the element is covered up by
+another element, the click will fail (this is a good thing - because
+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
+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.
+
+If you can't figure out what's going on and just want to work around the
+problem so you can get on with life, consider using a DOM click
+event. For example, if this code is failing:
+
+``` ruby
+click_button "Save"
+```
+
+Then try:
+
+``` ruby
+find_button("Save").trigger('click')
+```
+
+### Timing problems ###
+
+Sometimes tests pass and fail sporadically. This is often because there
+is some problem synchronising events properly. It's often
+straightforward to verify this by adding `sleep` statements into your
+test to allow sufficient time for the page to settle.
+
+If you have these types of problems, read through the [Capybara
+documentation on asynchronous
+Javascript](https://github.com/jnicklas/capybara#asynchronous-javascript-ajax-and-friends)
+which explains the tools that Capybara provides for dealing with this.
+
+### General troubleshooting hints ###
+
+* Configure Poltergeist with `:debug` turned on so you can see its
+ communication with PhantomJS.
+* Take screenshots to figure out what the state of your page is when the
+ problem occurs.
+* Use the remote web inspector in case it provides any useful insight
+* Consider downloading the Poltergeist source and using `console.log`
+ debugging to figure out what's going on inside PhantomJS. (This will
+ require an understanding of the Poltergeist source code and PhantomJS,
+ so it's only for the committed!)
+
+### Filing a bug ###
+
+If you can provide specific steps to reproduce your problem, or have
+specific information that might help other help you track down the
+problem, then please file a bug on Github.
+
+Include as much information as possible. For example:
+
+* Specific steps to reproduce where possible (failing tests are even
+ better)
+* The output obtained from running Poltergeist with `:debug` turned on
+* Screenshots
+* Stack traces if there are any Ruby on Javascript exceptions generated
+* The Poltergeist and PhantomJS version numbers used
+* The operating system name and version used
+
## Changes ##
-### 0.7.0 ###
+### 1.0 ###
#### Features ####
+* Click co-ordinates are shown in the debug log. You can use this in
+ combination with `page.driver.render` to work out where clicks are
+ actually happening if you are having trouble.
+* Added `:port` configuration option and made the default port 44678
+ rather than a random available port.
+* Support for Capybara's `page.response_headers` API to retrieve the
+ headers of the last page load.
+* Support for cookie manipulation. [Issue #12]
+* Frame switching support now uses native PhantomJS APIs. (This might
+ make it work better, but in general it's a badly tested area both in
+ Capybara and Poltergeist.)
+* Support for the Capybara window switching API (`page.within_window`).
+
+#### Bug fixes ####
+
+* Prevent `TypeError: 'undefined' is not an object (evaluating
+ 'rect.top')` error when clicking an element with `display: none`.
+ The click will fail, but an obsolete node error will be raised, meaning
+ that Capybara's retry mechanisms will kick in. [Issue #130]
+* Mouse over the element we will click, before clicking it. This
+ enables `:hover` effects etc to trigger before the click happens,
+ which can affect the click in some cases. [Issue #120]
+* Don't blow up when `evaluate_script` is called with a cyclic
+ structure.
+* Fix the text method for title elements, so it doesn't return an
+ empty string.
+* Fixed problem with cookies not being clearer between tests on
+ PhantomJS 1.7
+* Fixed Javascript errors during page load causes TimeoutErrors.
+ [Issue #124]
+* Ensure the User-Agent header can be set successfully. (Klaus Hartl)
+ [Issue #127]
+* Use `el.innerText` for `Node#text`. This ensures that e.g. `<br>` is
+ returned as a space. It also simplifies the method. [Issue #139]
+* Fix status code support when a response redirects to another URL.
+ This was previously tested to ensure it would return the status code
+ of the redirected URL, but the test was falsely broken and the
+ implementation was also broken.
+* Fixed visiting URLs where only a hash change occurs (no HTTP
+ request). [Issue #79]
+* Setting `page.driver.headers` now applies the headers to all
+ requests, not just calls to `visit`. (So XHR, asset requests, etc
+ will all receive the headers.) [Issue #149]
+
+### 0.7 ###
+
+#### 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]
@@ -208,102 +361,88 @@
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 ###
+### 0.6 ###
#### Features ####
* Updated to PhantomJS 1.5.0, giving us proper support for reporting
Javascript exception backtraces.
-### 0.5.0 ###
+### 0.5 ###
#### Features ####
* Detect if clicking an element will fail. If the click will actually
hit another element (because that element is in front of the one we
want to click), the user will now see an exception explaining what
happened and which element would actually be targeted by the click. This
should aid debugging. [Issue #25]
-
* Click elements at their middle position rather than the top-left.
This is presumed to be more likely to succeed because the top-left
may be obscured by overlapping elements, negative margins, etc. [Issue #26]
-
* Add experimental support for using the remote WebKit web inspector.
This will only work with PhantomJS 1.5, which is not yet released,
so it won't be officially supported by Poltergeist until 1.5 is
released. [Issue #31]
-
* Add `page.driver.quit` method. If you spawn additional Capybara
sessions, you might want to use this to reap the child phantomjs
process. [Issue #24]
-
* Errors produced by Javascript on the page will now generate an
exception within Ruby. [Issue #27]
-
* JRuby support. [Issue #20]
#### Bug fixes ####
* Fix bug where we could end up interacting with an obsolete element. [Issue #30]
-
* Raise an suitable error if PhantomJS returns a non-zero exit status.
Previously a version error would be raised, indicating that the
PhantomJS version was too old when in fact it did not start at all. [Issue #23]
-
* Ensure the `:timeout` option is actually used. [Issue #36]
-
* Nodes need to know which page they are associated with. Before this,
if Javascript caused a new page to load, existing node references
would be wrong, but wouldn't raise an ObsoleteNode error. [Issue #39]
-
* In some circumstances, we could end up missing an inline element
when attempting to click it. This is due to the use of
`getBoundingClientRect()`. We're now using `getClientRects()` to
address this.
-### 0.4.0 ###
+### 0.4 ###
* Element click position is now calculated using the native
`getBoundingClientRect()` method, which will be faster and less
buggy.
-
* Handle `window.confirm()`. Always returns true, which is the same
as capybara-webkit. [Issue #10]
-
* Handle `window.prompt()`. Returns the default value, if present, or
null.
-
* Fix bug with page Javascript page loading causing problems. [Issue #19]
-### 0.3.0 ###
+### 0.3 ###
* There was a bad bug to do with clicking elements in a page where the
page is smaller than the window. The incorrect position would be
calculated, and so the click would happen in the wrong place. This is
fixed. [Issue #8]
-
* Poltergeist didn't work in conjunction with the Thin web server,
because that server uses Event Machine, and Poltergeist was assuming
that it was the only thing in the process using EventMachine.
To solve this, EventMachine usage has been completely removed, which
has the welcome side-effect of being more efficient because we
no longer have the overhead of running a mostly-idle event loop.
[Issue #6]
-
* Added the `:timeout` option to configure the timeout when talking to
PhantomJS.
-### 0.2.0 ###
+### 0.2 ###
* First version considered 'ready', hopefully fewer problems.
-### 0.1.0 ###
+### 0.1 ###
* First version, various problems.
## License ##