Gnawrnip

Gnawrnip is a TurnipFormatter Add-on that provides put a screenshot (like animation gif) to report use Capybara

Build Status Coverage Status Code Climate Dependency Status

Requirements

  • Ruby
    • ~> 1.9.3
    • ~> 2.0.0
  • RubyGems
    • capybara ~> 2.1.0
    • turnip_formatter
    • rmagick ( optional )

Installation

Add this line to your application's Gemfile:

gem 'gnawrnip'

And then execute:

$ bundle

Or install it yourself as:

$ gem install gnawrnip

Setup

In your test setup file add:

require 'gnawrnip'
Gnawrnip.ready!

Customization

You can do to customize a screenshot.

Gnawrnip.configure do |c|
  c.photographer_driver = :js
  c.frame_interval = 1000 # milliseconds
  c.frame_size = [640, 360] # width, height
end

Gnawrnip.ready!

Gnawrnip.readty! must be issued after Gnawrnip.configure in setup file.

  • photographer_driver (Symbol) A driver that make screenshot like animation GIF.

    • :js: use jQuery and image files. The size of the report file tends to be large this driver

    • :rmagick: Make pure animation GIF using RMagick. This driver is requires Gem rmagick. Add this line to your application's Gemfile:

      gem 'rmagick'

  • frame_interval (Integer) A time (millisecond) between each image in an animation. Default is 1000 (1sec)

  • frame_size (Array) A size of screenshot (width, height). Default is nil (nil means that use Capybara.current_driver.browser size) .

    • This option is enabled only when the photographer_driver = :rmagick.

As example, see example/spec/spec_helper.rb .

Example

see https://github.com/gongo/gnawrnip/tree/master/example

License

MIT License. see LICENSE.txt