leifcr-capybara-screenshot 1.0.14

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,39 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "capybara-screenshot/version"
+
+Gem::Specification.new do |s|
+  s.name        = "leifcr-capybara-screenshot"
+  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.add_development_dependency 'aws-sdk'
+
+  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.3.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rack", "~> 1.0"
+gem "rake", "~> 10.0"
+gem "appraisal", "~> 2.0"
+gem "aruba", "~> 0.14.0"
+gem "cucumber", "~>1.3.0"
+
+gemspec :path => "../"

data/gemfiles/cucumber.2.4.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rack", "~> 1.0"
+gem "rake", "~> 10.0"
+gem "appraisal", "~> 2.0"
+gem "aruba", "~> 0.14.0"
+gem "cucumber", "~>2.4.0"
+
+gemspec :path => "../"

data/gemfiles/latest.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rack", "~> 1.0"
+gem "rake", "~> 10.0"
+gem "appraisal", "~> 2.0"
+gem "aruba", "~> 0.14.0"
+
+gemspec :path => "../"

data/gemfiles/rspec.3.0.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rack", "~> 1.0"
+gem "rake", "~> 10.0"
+gem "appraisal", "~> 2.0"
+gem "aruba", "~> 0.14.0"
+gem "rspec", "3.0"
+
+gemspec :path => "../"

data/gemfiles/spinach.0.8.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rack", "~> 1.0"
+gem "rake", "~> 10.0"
+gem "appraisal", "~> 2.0"
+gem "aruba", "~> 0.14.0"
+gem "spinach", "~>0.8.0"
+
+gemspec :path => "../"

data/lib/capybara-screenshot/callbacks.rb

@@ -0,0 +1,44 @@
+module Capybara
+  module Screenshot
+    module Callbacks
+      class CallbackSet < Array
+        def call *args
+          each do |callback|
+            callback.call *args
+          end
+        end
+      end
+
+      module ClassMethods
+        def callbacks
+          @callbacks ||= {}
+        end
+
+        def define_callback name
+          callbacks[name] ||= CallbackSet.new
+
+          define_singleton_method name do |&block|
+            callbacks[name] << block
+          end
+        end
+
+        def run_callbacks name, *args
+          if cb_set = callbacks[name]
+            cb_set.call *args
+          end
+        end
+      end
+
+      module InstanceMethods
+        def run_callbacks name, *args
+          self.class.run_callbacks name, *args
+        end
+      end
+
+      def self.included receiver
+        receiver.extend         ClassMethods
+        receiver.send :include, InstanceMethods
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/capybara.rb

@@ -0,0 +1,26 @@
+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,&blk)
+      original_session_name = Capybara.session_name
+      Capybara::Screenshot.final_session_name = name
+      using_session_without_screenshot(name,&blk)
+      Capybara::Screenshot.final_session_name = original_session_name
+    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,28 @@
+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.new_saver(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}
+        saver.display_image
+        #this will embed the image in the HTML report, embed() is defined in cucumber
+        encoded_img = Base64.encode64(image)
+        embed(encoded_img, 'image/png;base64', "Screenshot of the error")
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/helpers.rb

@@ -0,0 +1,28 @@
+class CapybaraScreenshot
+  module Helpers
+    extend self
+
+    COLORS =
+      {
+        "black"   => 0,
+        "red"     => 1,
+        "green"   => 2,
+        "yellow"  => 3,
+        "blue"    => 4,
+        "purple"  => 5,
+        "magenta" => 5,
+        "cyan"    => 6,
+        "white"   => 7
+      }
+
+      COLORS.each_pair do |color, value|
+        define_method color do |text|
+          "\033[0;#{30+value}m#{text}\033[0m"
+        end
+
+        define_method "bright_#{color}" do |text|
+          "\033[1;#{30+value}m#{text}\033[0m"
+        end
+      end
+  end
+end

data/lib/capybara-screenshot/minitest.rb

@@ -0,0 +1,36 @@
+require "capybara-screenshot"
+
+module Capybara::Screenshot::MiniTestPlugin
+  def before_setup
+    super
+    Capybara::Screenshot.final_session_name = nil
+  end
+
+  def before_teardown
+    super
+    if self.class.ancestors.map(&:to_s).include?('Capybara::DSL')
+      if Capybara::Screenshot.autosave_on_failure && !passed? && !skipped?
+        Capybara.using_session(Capybara::Screenshot.final_session_name) do
+          filename_prefix = Capybara::Screenshot.filename_prefix_for(:minitest, self)
+
+          saver = Capybara::Screenshot.new_saver(Capybara, Capybara.page, true, filename_prefix)
+          saver.save
+          saver.output_screenshot_path
+        end
+      end
+    end
+  end
+end
+
+begin
+  Minitest.const_get('Test')
+  class Minitest::Test
+    include Capybara::Screenshot::MiniTestPlugin
+  end
+rescue NameError => e
+  class MiniTest::Unit::TestCase
+    include Capybara::Screenshot::MiniTestPlugin
+  end
+end
+
+

data/lib/capybara-screenshot/pruner.rb

@@ -0,0 +1,48 @@
+module Capybara
+  module Screenshot
+    class Pruner
+      attr_reader :strategy
+
+      def initialize(strategy)
+        @strategy = strategy
+
+        @strategy_proc = case strategy
+        when :keep_all
+          lambda { }
+        when :keep_last_run
+          lambda { prune_with_last_run_strategy }
+        when Hash
+          raise ArgumentError, ":keep key is required" unless strategy[:keep]
+          raise ArgumentError, ":keep must be a Integer" unless strategy[:keep].kind_of?(Integer)
+          raise ArgumentError, ":keep value must be number greater than zero" unless strategy[:keep].to_i > 0
+          lambda { 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('*.{html,png}', 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

data/lib/capybara-screenshot/rspec/base_reporter.rb

@@ -0,0 +1,21 @@
+module Capybara
+  module Screenshot
+    module RSpec
+      module BaseReporter
+
+        # Automatically set up method aliases (very much like ActiveSupport's `alias_method_chain`) 
+        # when the module gets included.
+        def enhance_with_screenshot(method)
+          with_method, without_method = "#{method}_with_screenshot", "#{method}_without_screenshot"
+          define_singleton_method :included do |mod|
+            if mod.method_defined?(method) || mod.private_method_defined?(method)
+              mod.send :alias_method, without_method, method
+              mod.send :alias_method, method, with_method
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/rspec/html_embed_reporter.rb

@@ -0,0 +1,25 @@
+require 'capybara-screenshot/rspec/base_reporter'
+require 'base64'
+
+module Capybara
+  module Screenshot
+    module RSpec
+      module HtmlEmbedReporter
+        extend BaseReporter
+        enhance_with_screenshot :extra_failure_content
+
+        def extra_failure_content_with_screenshot(exception)
+          result  = extra_failure_content_without_screenshot(exception)
+          example = @failed_examples.last
+          # Ignores saved html file, only saved image will be embedded (if present)
+          if (screenshot = example.metadata[:screenshot]) && screenshot[:image]
+            image = File.binread(screenshot[:image])
+            encoded_img = Base64.encode64(image)
+            result += "<img src='data:image/png;base64,#{encoded_img}' style='display: block'>"
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/rspec/html_link_reporter.rb

@@ -0,0 +1,37 @@
+require 'capybara-screenshot/rspec/base_reporter'
+require 'cgi'
+require 'uri'
+
+module Capybara
+  module Screenshot
+    module RSpec
+      module HtmlLinkReporter
+        extend BaseReporter
+        enhance_with_screenshot :extra_failure_content
+
+        def extra_failure_content_with_screenshot(exception)
+          result  = extra_failure_content_without_screenshot(exception)
+          example = @failed_examples.last
+          if (screenshot = example.metadata[:screenshot])
+            result << "<p>Saved files: "
+            result << link_to_screenshot("HTML page",  screenshot[:html]) if screenshot[:html]
+            result << link_to_screenshot("Screenshot", screenshot[:image]) if screenshot[:image]
+            result << "</p>"
+          end
+          result
+        end
+
+        def link_to_screenshot(title, path)
+          url = URI.escape("file://#{path}")
+          title = CGI.escape_html(title)
+          attributes = attributes_for_screenshot_link(url).map { |name, val| %{#{name}="#{CGI.escape_html(val)}"} }.join(" ")
+          "<a #{attributes}>#{title}</a>"
+        end
+
+        def attributes_for_screenshot_link(url)
+          {"href" => url, "style" => "margin-right: 10px; font-weight: bold"}
+        end
+      end
+    end
+  end
+end