capybara-screenshot-nocolor 1.0.5

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+rspec_rake_task = RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]
+
+def target_gem
+  gem_file = ENV['BUNDLE_GEMFILE'] || ''
+  targets = %w(cucumber spinach rspec)
+
+  target = gem_file.match(/(#{targets.join('|')})/)
+  if target && targets.include?(target[1])
+    target[1].to_sym
+  else
+    []
+  end
+end
+
+namespace :travis do
+  task :ci => target_gem do
+    Rake::Task['spec'].invoke
+  end
+
+  task :cucumber do
+    rspec_rake_task.pattern = 'spec/cucumber'
+  end
+
+  task :spinach do
+    rspec_rake_task.pattern = 'spec/spinach'
+  end
+
+  task :rspec do
+    rspec_rake_task.pattern = 'spec/rspec'
+  end
+end

data/capybara-screenshot.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "capybara-screenshot/version"
+
+Gem::Specification.new do |s|
+  s.name        = "capybara-screenshot-nocolor"
+  s.version     = Capybara::Screenshot::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Matthew O'Riordan"]
+  s.email       = ["matthew.oriordan@gmail.com"]
+  s.homepage    = "http://github.com/mattheworiordan/capybara-screenshot"
+  s.summary     = %q{Automatically create snapshots when Cucumber steps fail with Capybara and Rails}
+  s.description = %q{When a Cucumber step fails, it is useful to create a screenshot image and HTML file of the current page}
+  s.license     = 'MIT'
+
+  s.rubyforge_project = "capybara-screenshot"
+
+  if RUBY_VERSION < "1.9"
+    s.add_dependency 'capybara', ['>= 1.0', '< 2']
+  else
+    s.add_dependency 'capybara', ['>= 1.0', '< 3']
+  end
+  s.add_dependency 'launchy'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'timecop'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'sinatra'
+  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'spinach'
+  s.add_development_dependency 'minitest'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/gemfiles/cucumber.1.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rake"
+gem "appraisal"
+gem "cucumber", "1.2"
+
+gemspec :path => "../"

data/gemfiles/cucumber.1.3.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rake"
+gem "appraisal"
+gem "cucumber", "1.3.0"
+
+gemspec :path => "../"

data/gemfiles/latest.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rake"
+gem "appraisal"
+
+gemspec :path => "../"

data/gemfiles/rspec.2.14.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rake"
+gem "appraisal"
+gem "rspec", "2.14"
+
+gemspec :path => "../"

data/gemfiles/rspec.2.99.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rake"
+gem "appraisal"
+gem "rspec", "2.99"
+
+gemspec :path => "../"

data/gemfiles/rspec.3.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rake"
+gem "appraisal"
+gem "rspec", "3.0"
+
+gemspec :path => "../"

data/gemfiles/spinach.0.7.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rake"
+gem "appraisal"
+gem "spinach", "0.7"
+
+gemspec :path => "../"

data/gemfiles/spinach.0.8.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rake"
+gem "appraisal"
+gem "spinach", "0.8.0"
+
+gemspec :path => "../"

data/lib/capybara-screenshot.rb

@@ -0,0 +1,157 @@
+module Capybara
+  module Screenshot
+    class << self
+      attr_accessor :autosave_on_failure
+      attr_accessor :registered_drivers
+      attr_accessor :filename_prefix_formatters
+      attr_accessor :append_timestamp
+      attr_accessor :append_random
+      attr_accessor :webkit_options
+      attr_writer   :final_session_name
+      attr_accessor :prune_strategy
+    end
+
+    self.autosave_on_failure = true
+    self.registered_drivers = {}
+    self.filename_prefix_formatters = {}
+    self.append_timestamp = true
+    self.append_random = false
+    self.webkit_options = {}
+    self.prune_strategy = :keep_all
+
+    def self.append_screenshot_path=(value)
+      $stderr.puts "WARNING: Capybara::Screenshot.append_screenshot_path is deprecated. " +
+        "Please use Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples instead."
+      RSpec.add_link_to_screenshot_for_failed_examples = value
+    end
+
+    def self.screenshot_and_save_page
+      saver = Saver.new(Capybara, Capybara.page)
+      saver.save
+      {:html => saver.html_path, :image => saver.screenshot_path}
+    end
+
+    def self.screenshot_and_open_image
+      require "launchy"
+
+      saver = Saver.new(Capybara, Capybara.page, false)
+      saver.save
+      Launchy.open saver.screenshot_path
+      {:html => nil, :image => saver.screenshot_path}
+    end
+
+    class << self
+      alias screen_shot_and_save_page screenshot_and_save_page
+      alias screen_shot_and_open_image screenshot_and_open_image
+    end
+
+    def self.filename_prefix_for(test_type, test)
+      filename_prefix_formatters.fetch(test_type) { |key|
+        filename_prefix_formatters[:default]
+      }.call(test)
+    end
+
+    def self.capybara_root
+      return @capybara_root if defined?(@capybara_root)
+      #If the path isn't set, default to the current directory
+      capybara_tmp_path = Capybara.save_and_open_page_path || '.'
+
+      @capybara = if defined?(::Rails)
+        ::Rails.root.join capybara_tmp_path
+      elsif defined?(Padrino)
+        Padrino.root capybara_tmp_path
+      elsif defined?(Sinatra)
+        File.join(Sinatra::Application.root, capybara_tmp_path)
+      else
+        capybara_tmp_path
+      end.to_s
+    end
+
+    def self.register_driver(driver, &block)
+      self.registered_drivers[driver] = block
+    end
+
+    def self.register_filename_prefix_formatter(test_type, &block)
+      self.filename_prefix_formatters[test_type] = block
+    end
+
+    def self.final_session_name
+      @final_session_name || Capybara.session_name || :default
+    end
+
+    # Prune screenshots based on prune_strategy
+    # Will run only once unless force:true
+    def self.prune(options = {})
+      reset_prune_history if options[:force]
+      Capybara::Screenshot::Pruner.new(Capybara::Screenshot.prune_strategy).prune_old_screenshots unless @pruned_previous_screenshots
+      @pruned_previous_screenshots = true
+    end
+
+    # Reset prune history allowing further prunining on next failure
+    def self.reset_prune_history
+      @pruned_previous_screenshots = nil
+    end
+  end
+end
+
+# Register driver renderers.
+# The block should return `:not_supported` if a screenshot could not be saved.
+Capybara::Screenshot.class_eval do
+  register_driver(:default) do |driver, path|
+    driver.render(path)
+  end
+
+  register_driver(:rack_test) do |driver, path|
+    :not_supported
+  end
+
+  register_driver(:mechanize) do |driver, path|
+    :not_supported
+  end
+
+  register_driver(:selenium) do |driver, path|
+    driver.browser.save_screenshot(path)
+  end
+
+  register_driver(:poltergeist) do |driver, path|
+    driver.render(path, :full => true)
+  end
+
+  register_driver(:poltergeist_billy) do |driver, path|
+    driver.render(path, :full => true)
+  end
+
+  register_driver(:webkit) do |driver, path|
+    if driver.respond_to?(:save_screenshot)
+      driver.save_screenshot(path, webkit_options)
+    else
+      driver.render(path)
+    end
+  end
+
+  register_driver(:webkit_debug) do |driver, path|
+    driver.render(path)
+  end
+
+  register_driver(:terminus) do |driver, path|
+    if driver.respond_to?(:save_screenshot)
+      driver.save_screenshot(path)
+    else
+      :not_supported
+    end
+  end
+end
+
+# Register filename prefix formatters
+Capybara::Screenshot.class_eval do
+  register_filename_prefix_formatter(:default) do |test|
+    'screenshot'
+  end
+end
+
+require 'capybara/dsl'
+require 'capybara/util/save_and_open_page' if Capybara::VERSION.match(/^\d+/)[0] == '1' # no longer needed in Capybara version 2
+
+require 'capybara-screenshot/saver'
+require 'capybara-screenshot/capybara'
+require 'capybara-screenshot/pruner'

data/lib/capybara-screenshot/capybara.rb

@@ -0,0 +1,28 @@
+require "capybara-screenshot"
+
+module Capybara
+  module DSL
+    # Adds class methods to Capybara module and gets mixed into
+    # the current scope during Cucumber and RSpec tests
+
+    def screenshot_and_save_page
+      Capybara::Screenshot.screenshot_and_save_page
+    end
+
+    def screenshot_and_open_image
+      Capybara::Screenshot.screenshot_and_open_image
+    end
+
+    def using_session_with_screenshot(name)
+      using_session_without_screenshot(name) do
+        original_session_name = Capybara.session_name
+        Capybara::Screenshot.final_session_name = name
+        yield
+        Capybara::Screenshot.final_session_name = original_session_name
+      end
+    end
+
+    alias_method :using_session_without_screenshot, :using_session
+    alias_method :using_session, :using_session_with_screenshot
+  end
+end

data/lib/capybara-screenshot/cucumber.rb

@@ -0,0 +1,27 @@
+require "capybara-screenshot"
+
+Before do |scenario|
+  Capybara::Screenshot.final_session_name = nil
+end
+
+After do |scenario|
+  if Capybara::Screenshot.autosave_on_failure && scenario.failed?
+    Capybara.using_session(Capybara::Screenshot.final_session_name) do
+      filename_prefix = Capybara::Screenshot.filename_prefix_for(:cucumber, scenario)
+
+      saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+      saver.save
+      saver.output_screenshot_path
+
+      # Trying to embed the screenshot into our output."
+      if File.exist?(saver.screenshot_path)
+        require "base64"
+        #encode the image into it's base64 representation
+        image = open(saver.screenshot_path, 'rb') {|io|io.read}
+        encoded_img = Base64.encode64(image)
+        #this will embed the image in the HTML report, embed() is defined in cucumber
+        embed(encoded_img, 'image/png;base64', "Screenshot of the error")
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/minitest.rb

@@ -0,0 +1,27 @@
+require "capybara-screenshot"
+
+module Capybara::Screenshot::MiniTestPlugin
+  def before_setup
+    super
+    Capybara::Screenshot.final_session_name = nil
+  end
+
+  def after_teardown
+    super
+    if self.class.ancestors.map(&:to_s).include?('ActionDispatch::IntegrationTest')
+      if Capybara::Screenshot.autosave_on_failure && !passed?
+        Capybara.using_session(Capybara::Screenshot.final_session_name) do
+          filename_prefix = Capybara::Screenshot.filename_prefix_for(:minitest, self)
+
+          saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+          saver.save
+          saver.output_screenshot_path
+        end
+      end
+    end
+  end
+end
+
+class MiniTest::Unit::TestCase
+  include Capybara::Screenshot::MiniTestPlugin
+end

data/lib/capybara-screenshot/pruner.rb

@@ -0,0 +1,47 @@
+module Capybara
+  module Screenshot
+    class Pruner
+      attr_reader :strategy
+
+      def initialize(strategy)
+        @strategy = strategy
+
+        @strategy_proc = case strategy
+        when :keep_all
+          -> { }
+        when :keep_last_run
+          -> { prune_with_last_run_strategy }
+        when Hash
+          raise ArgumentError, ":keep key is required" unless strategy[:keep]
+          raise ArgumentError, ":keep value must be number greater than zero" unless strategy[:keep].to_i > 0
+          -> { prune_with_numeric_strategy(strategy[:keep].to_i) }
+        else
+          fail "Invalid prune strategy #{strategy}. `:keep_all`or `{ keep: 10 }` are valid examples."
+        end
+      end
+
+      def prune_old_screenshots
+        strategy_proc.call
+      end
+
+      private
+      attr_reader :strategy_proc
+
+      def wildcard_path
+        File.expand_path('*', Screenshot.capybara_root)
+      end
+
+      def prune_with_last_run_strategy
+        FileUtils.rm_rf(Dir.glob(wildcard_path))
+      end
+
+      def prune_with_numeric_strategy(count)
+        files = Dir.glob(wildcard_path).sort_by do |file_name|
+          File.mtime(File.expand_path(file_name, Screenshot.capybara_root))
+        end
+
+        FileUtils.rm_rf(files[0...-count])
+      end
+    end
+  end
+end