2011-02-28 16:01:34 +00:00
capybara-webkit
===============
2013-03-25 15:51:10 +00:00
[![Build Status ](https://secure.travis-ci.org/thoughtbot/capybara-webkit.png?branch=master )](https://travis-ci.org/thoughtbot/capybara-webkit)
[![Code Climate ](https://codeclimate.com/github/thoughtbot/capybara-webkit.png )](https://codeclimate.com/github/thoughtbot/capybara-webkit)
2012-10-12 16:56:48 +00:00
2013-12-04 01:08:36 +00:00
A [capybara ](https://github.com/jnicklas/capybara ) driver that uses [WebKit ](http://webkit.org ) via [QtWebKit ](http://trac.webkit.org/wiki/QtWebKit ).
2011-02-28 16:01:34 +00:00
2012-02-24 14:30:57 +00:00
Qt Dependency and Installation Issues
2012-11-14 16:00:58 +00:00
-------------------------------------
2011-02-28 16:01:34 +00:00
2011-08-28 00:35:58 +00:00
capybara-webkit depends on a WebKit implementation from Qt, a cross-platform
development toolkit. You'll need to download the Qt libraries to build and
2016-07-27 00:28:02 +00:00
install the gem. You can find instructions for downloading and installing Qt on
2012-11-14 16:00:58 +00:00
the
[capybara-webkit wiki ](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit ).
2014-07-13 16:10:13 +00:00
capybara-webkit requires Qt version 4.8 or greater.
2011-04-13 18:55:54 +00:00
2012-03-16 16:09:05 +00:00
Windows Support
---------------
2013-12-20 15:20:00 +00:00
Currently 32-bit Windows will compile capybara-webkit. Support for Windows is
provided by the open source community and Windows related issues should be
posted to [Stack Overflow].
[Stack Overflow]: http://stackoverflow.com/questions/tagged/capybara-webkit
2012-03-16 16:09:05 +00:00
2011-10-01 17:03:07 +00:00
Reporting Issues
----------------
Without access to your application code we can't easily debug most crashes or
2011-10-06 22:56:20 +00:00
generic failures, so we've included a debug version of the driver that prints a
2011-10-01 17:03:07 +00:00
log of what happened during each test. Before filing a crash bug, please see
2013-12-20 15:20:00 +00:00
[Reporting Crashes]. You're much more likely to get a fix if you follow those
instructions.
2011-10-01 17:03:07 +00:00
2013-12-20 15:20:00 +00:00
If you're having trouble compiling or installing, please check out the [wiki].
If you don't have any luck there, please post to [Stack Overflow]. Please don't
2012-02-24 14:30:57 +00:00
open a Github issue for a system-specific compiler issue.
2012-01-13 16:44:20 +00:00
2014-02-09 04:13:09 +00:00
[Reporting Crashes]: https://github.com/thoughtbot/capybara-webkit/wiki/Reporting-Crashes
2016-05-16 00:33:07 +00:00
[wiki]: https://github.com/thoughtbot/capybara-webkit/wiki
2013-12-20 15:20:00 +00:00
[Stack Overflow]: http://stackoverflow.com/questions/tagged/capybara-webkit
2011-06-05 21:49:16 +00:00
CI
--
If you're like us, you'll be using capybara-webkit on CI.
2011-04-13 18:55:54 +00:00
2014-07-13 16:10:13 +00:00
On Linux platforms, capybara-webkit requires an X server to run, although it doesn't create any visible windows. Xvfb works fine for this. You can setup Xvfb yourself and set a DISPLAY variable, try out the [headless gem ](https://github.com/leonid-shevtsov/headless ), or use the xvfb-run utility as follows:
```
xvfb-run -a bundle exec spec
```
This automatically sets up a virtual X server on a free server number.
2011-04-13 16:17:59 +00:00
2011-03-09 22:55:40 +00:00
Usage
-----
Add the capybara-webkit gem to your Gemfile:
2013-03-07 01:07:55 +00:00
```ruby
gem "capybara-webkit"
```
2011-03-09 22:55:40 +00:00
Set your Capybara Javascript driver to webkit:
2013-03-07 01:07:55 +00:00
```ruby
Capybara.javascript_driver = :webkit
```
2011-03-09 22:55:40 +00:00
2011-11-01 19:36:24 +00:00
In cucumber, tag scenarios with @javascript to run them using a headless WebKit browser.
2011-03-09 22:55:40 +00:00
2013-12-20 21:23:51 +00:00
In RSpec, use the `:js => true` flag. See the [capybara documentation ](http://rubydoc.info/gems/capybara#Using_Capybara_with_RSpec ) for more information about using capybara with RSpec.
2011-11-01 19:36:24 +00:00
2012-01-13 18:10:02 +00:00
Take note of the transactional fixtures section of the [capybara README ](https://github.com/jnicklas/capybara/blob/master/README.md ).
2011-11-01 19:19:28 +00:00
2012-04-17 22:29:28 +00:00
If you're using capybara-webkit with Sinatra, don't forget to set
2013-03-07 01:07:55 +00:00
```ruby
Capybara.app = MySinatraApp.new
```
2012-04-17 22:29:28 +00:00
2015-04-10 21:00:32 +00:00
Configuration
-------------
You can configure global options using `Capybara::Webkit.configure` :
``` ruby
Capybara::Webkit.configure do |config|
# Enable debug mode. Prints a log of everything the driver is doing.
config.debug = true
# By default, requests to outside domains (anything besides localhost) will
# result in a warning. Several methods allow you to change this behavior.
# Silently return an empty 200 response for any requests to unknown URLs.
config.block_unknown_urls
# Allow pages to make requests to any URL without issuing a warning.
config.allow_unknown_urls
2015-09-17 13:40:57 +00:00
# Allow a specific domain without issuing a warning.
2015-04-10 21:00:32 +00:00
config.allow_url("example.com")
2015-09-17 13:40:57 +00:00
# Allow a specific URL and path without issuing a warning.
2015-04-10 21:00:32 +00:00
config.allow_url("example.com/some/path")
# Wildcards are allowed in URL expressions.
config.allow_url("*.example.com")
# Silently return an empty 200 response for any requests to the given URL.
config.block_url("example.com")
# Timeout if requests take longer than 5 seconds
config.timeout = 5
# Don't raise errors when SSL certificates can't be validated
config.ignore_ssl_errors
# Don't load images
config.skip_image_loading
# Use a proxy
config.use_proxy(
host: "example.com",
port: 1234,
user: "proxy",
pass: "secret"
)
2017-03-17 14:54:36 +00:00
# Raise JavaScript errors as exceptions
config.raise_javascript_errors = true
2015-04-10 21:00:32 +00:00
end
```
These options will take effect for all future sessions and only need to be set
once. It's recommended that you configure these in your `spec_helper.rb` or
`test_helper.rb` rather than a `before` or `setup` block.
2013-05-02 07:54:09 +00:00
Offline Application Cache
-------------------------
The offline application cache needs a directory to write to for the cached files. Capybara-webkit
will look at if the working directory has a tmp directory and when it exists offline application
cache will be enabled.
2012-04-03 23:23:42 +00:00
Non-Standard Driver Methods
---------------------------
capybara-webkit supports a few methods that are not part of the standard capybara API. You can access these by calling `driver` on the capybara session. When using the DSL, that will look like `page.driver.method_name` .
**console_messages**: returns an array of messages printed using console.log
2013-03-07 01:07:55 +00:00
```js
// In Javascript:
console.log("hello")
```
```ruby
# In Ruby:
page.driver.console_messages
2013-12-20 21:22:15 +00:00
=> [{:source=>"http://example.com", :line_number=>1, :message=>"hello"}]
2013-03-07 01:07:55 +00:00
```
2012-04-03 23:23:42 +00:00
**error_messages**: returns an array of Javascript errors that occurred
2013-03-07 01:07:55 +00:00
```ruby
page.driver.error_messages
2013-12-20 21:22:15 +00:00
=> [{:source=>"http://example.com", :line_number=>1, :message=>"SyntaxError: Parse error"}]
2013-03-07 01:07:55 +00:00
```
2012-04-03 23:23:42 +00:00
**cookies**: allows read-only access of cookies for the current session
2013-03-07 01:07:55 +00:00
```ruby
page.driver.cookies["alpha"]
=> "abc"
```
2012-04-03 23:23:42 +00:00
2012-11-09 18:29:32 +00:00
**header**: set the given HTTP header for subsequent requests
2013-03-07 01:07:55 +00:00
```ruby
page.driver.header 'Referer', 'https://www.thoughtbot.com'
```
2012-11-09 18:29:32 +00:00
2011-07-22 20:59:13 +00:00
Contributing
------------
2015-03-09 17:00:23 +00:00
See the [CONTRIBUTING] document.
Thank you, [contributors]!
[CONTRIBUTING]: CONTRIBUTING.md
[contributors]: https://github.com/thoughtbot/capybara-webkit/graphs/contributors
License
-------
capybara-webkit is Copyright (c) 2010-2015 thoughtbot, inc. It is free software,
and may be redistributed under the terms specified in the [LICENSE] file.
[LICENSE]: /LICENSE
2011-07-22 20:59:13 +00:00
2011-03-09 22:55:40 +00:00
About
-----
2015-03-09 17:00:23 +00:00
The capybara WebKit driver is maintained by Joe Ferris and Matt Horan.
2011-03-09 22:55:40 +00:00
2015-03-09 17:00:23 +00:00
Code for rendering the current webpage to a PNG is borrowed from Phantom.js'
implementation.
2011-07-03 13:39:47 +00:00
2017-03-10 15:22:23 +00:00
![thoughtbot ](http://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg )
2011-04-13 17:31:27 +00:00
2015-03-09 17:00:23 +00:00
capybara-webkit is maintained and funded by thoughtbot, inc.
2011-03-09 22:55:40 +00:00
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
2015-03-09 17:00:23 +00:00
We love open source software!
See [our other projects][community]
or [hire us][hire] to help build your product.
2011-03-09 22:55:40 +00:00
2015-03-09 17:00:23 +00:00
[community]: https://thoughtbot.com/community?utm_source=github
[hire]: https://thoughtbot.com/hire-us?utm_source=github