2011-02-28 11:01:34 -05:00
capybara-webkit
===============
2011-03-09 17:55:40 -05:00
A [capybara ](https://github.com/jnicklas/capybara ) driver that uses [WebKit ](http://webkit.org ) via [QtWebKit ](http://doc.qt.nokia.com/4.7/qtwebkit.html ).
2011-02-28 11:01:34 -05:00
2011-09-17 11:10:47 -04:00
Qt Dependency
2011-09-14 17:14:03 -04:00
-------------
2011-02-28 11:01:34 -05:00
2011-08-27 20:35:58 -04: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
2011-09-14 17:14:03 -04:00
install the gem. You can find instructions for downloading and installing QT on
the [capybara-webkit wiki ](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-QT )
2011-04-13 14:55:54 -04:00
2011-10-01 13:03:07 -04:00
Reporting Issues
----------------
Without access to your application code we can't easily debug most crashes or
2011-10-06 18:56:20 -04:00
generic failures, so we've included a debug version of the driver that prints a
2011-10-01 13:03:07 -04:00
log of what happened during each test. Before filing a crash bug, please see
[Reporting Crashes ](https://github.com/thoughtbot/capybara-webkit/wiki/Reporting-Crashes ).
You're much more likely to get a fix if you follow those instructions.
2012-01-13 11:44:20 -05:00
If you are having compiling issues please post to the [mailing list ](http://groups.google.com/group/capybara-webkit ).
2011-06-05 17:49:16 -04:00
CI
--
If you're like us, you'll be using capybara-webkit on CI.
2011-04-13 14:55:54 -04:00
2011-04-14 16:48:53 -04: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, or try out the [headless gem ](https://github.com/leonid-shevtsov/headless ).
2011-04-13 12:17:59 -04:00
2011-03-09 17:55:40 -05:00
Usage
-----
Add the capybara-webkit gem to your Gemfile:
gem "capybara-webkit"
Set your Capybara Javascript driver to webkit:
Capybara.javascript_driver = :webkit
2011-11-01 15:36:24 -04:00
In cucumber, tag scenarios with @javascript to run them using a headless WebKit browser.
2011-03-09 17:55:40 -05:00
2011-11-01 15:36:24 -04:00
In RSpec, use the :js => true flag.
2012-01-13 13:10:02 -05:00
Take note of the transactional fixtures section of the [capybara README ](https://github.com/jnicklas/capybara/blob/master/README.md ).
2011-11-01 15:19:28 -04:00
2011-07-22 16:59:13 -04:00
Contributing
------------
See the CONTRIBUTING document.
2011-03-09 17:55:40 -05:00
About
-----
2011-11-01 17:00:28 -04:00
The capybara WebKit driver is maintained by Joe Ferris and Matt Mongeau. It was written by [thoughtbot, inc ](http://thoughtbot.com/community ) with the help of numerous [contributions from the open source community ](https://github.com/thoughtbot/capybara-webkit/contributors ).
2011-03-09 17:55:40 -05:00
2011-07-03 09:39:47 -04:00
Code for rendering the current webpage to a PNG is borrowed from Phantom.js' implementation.
2011-04-13 13:31:27 -04:00
2011-03-09 17:55:40 -05:00
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
License
-------
2011-08-27 20:35:58 -04:00
capybara-webkit is Copyright (c) 2011 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.
