Capybara::ScreenshotConfig

Gem Version Code Climate

Easier Capybara screenshot configuration gem.

RETIREMENT

This gem is originally created to make Capybara screenshot configuration easier and unify screenshot save paths. Howerver, the directory can be specified by setting Capybara.save_path.

require "capybara/poltergeist"
Capybara.javascript_driver = :poltergeist
Capybara.save_path = "screenshot"

This gem is no longer maintained. Please use Capybara.save_path.

Installation

Add this line to your application's Gemfile:

gem 'capybara-screenshot_config'

And then execute:

$ bundle

Or install it yourself as:

$ gem install capybara-screenshot_config

Requirement

  • capybara 2.x or more
  • poltergeist for Capybara javascript_driver

Usage

Setup poltergeist

require "capybara/poltergeist"
Capybara.javascript_driver = :poltergeist

For more information, see here.

ScreenshotConfig configuration

Capybara::ScreenshotConfig.configure do |config|
  config.save_dir = "screenshot" # [String]  screenshot save directory
  config.full     = true         # [Boolean] full screenshot
end

save_screenshot

describe 'screenshot', js: true do
  it { page.save_screenshot "screenshot.png" }
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capybara-screenshot_config.