screenshot_capybara.rb

# Allows you to run rspec with SCREENSHOT=1 to take screenshots.
# The images are stored under tmp/screenshots/
#
module ScreenshotHelpers
  SCREENSHOT_KEY = 'SCREENSHOT'
  DIR_PATH = Rails.root.join('tmp', 'screenshots')

  # @example
  #   screenshot("dashboard_clean_slate")
  #   screenshot("shopping_cart_multiple_items")
  #
  def screenshot(name)
    return unless ScreenshotHelpers.screenshots_enabled?
    filename = [name, 'png'].join('.')
    path = DIR_PATH.join(filename)
    page.save_screenshot(path)
  end

  class << self
    def screenshots_enabled?
      !['', '0', 'false'].include?(ENV[SCREENSHOT_KEY].to_s)
    end

    def screenshots_enabled_message
      "\u{1F4F8}  Screenshots are enabled! Unset #{SCREENSHOT_KEY} to disable."
    end
  end
end

RSpec.configure do |config|
  config.include ScreenshotHelpers, type: :feature

  config.before :suite do
    if ScreenshotHelpers.screenshots_enabled?
      Capybara.default_driver = Capybara.javascript_driver
      puts ScreenshotHelpers.screenshots_enabled_message
    end
  end
end