capybara-screenshot 0.1.10 → 0.2

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+15 Feb 2012
+-----------
+
+Merged pull request https://github.com/mattheworiordan/capybara-screenshot/pull/14 to limit when capybara-screenshot is fired for RSpec
+
 30 Jan 2012
 -----------
 

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in capybara-screenshot.gemspec
 gemspec
+
+gem 'rake'

data/README.md

@@ -18,6 +18,28 @@ or update your Gemfile to include:
 
 That's it!
 
+If you require more control, you can generate the screenshot on demand rather than on failure. This is useful
+if the failure occurs at a point where the screen shot is not as useful for debugging a rendering problem.
+
+In Cucumber,
+
+	screen_shot_and_save_page
+
+Or for screenshot only, with image automatically opened
+
+	screen_shot_and_open_image
+
+Or anywhere, including specs and tests
+	
+	Capybara::Screenshot.screen_shot_and_save_page
+
+	Capybara::Screenshot.screen_shot_and_open_image
+
+This can be more useful if you disable the auto-generate on failure feature with the following config
+
+	Capybara::Screenshot.autosave_on_failure = false
+
+
 Example application
 -------------------
 

data/capybara-screenshot.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'capybara', '>= 1.0'
   s.add_development_dependency 'rspec', '~> 2.6'
+  s.add_development_dependency 'timecop'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/capybara-screenshot.rb

@@ -1,21 +1,69 @@
+module Capybara
+  module Screenshot
+    class << self
+      attr_accessor :autosave_on_failure
+      attr_accessor :registered_drivers
+    end
+
+    self.autosave_on_failure = true
+    self.registered_drivers = {}
+
+    def self.screen_shot_and_save_page
+      saver = Saver.new(Capybara, Capybara.page)
+      saver.save
+      {:html => saver.html_path, :image => saver.screenshot_path}
+    end
+
+    def self.screen_shot_and_open_image
+      require "launchy"
+
+      saver = Saver.new(Capybara, Capybara.page, false)
+      saver.save
+      Launchy.open saver.screenshot_path
+      {:html => saver.html_path, :image => saver.screenshot_path}
+    end
+
+    def self.capybara_root
+      return @capybara_root if defined?(@capybara_root)
+
+      capybara_tmp_path = Capybara.save_and_open_page_path.to_s
+
+      @capybara = if defined?(Rails)
+        Rails.root.join capybara_tmp_path
+      elsif defined?(Padrino)
+        Padrino.root capybara_tmp_path
+      elsif defined?(Sinatra)
+        # Sinatra support, untested
+        File.join(settings.root, capybara_tmp_path)
+      else
+        capybara_tmp_path
+      end.to_s
+    end
+
+    def self.register_driver(driver, &block)
+      self.registered_drivers[driver] = block
+    end
+  end
+end
+
+Capybara::Screenshot.register_driver(:selenium) do |driver, path|
+  driver.browser.save_screenshot(path)
+end 
+
+Capybara::Screenshot.register_driver(:poltergeist) do |driver, path|
+  driver.render(path, :full => true)
+end 
+
+Capybara::Screenshot.register_driver(:webkit) do |driver, path|
+  driver.render(path)
+end 
+
+require 'capybara-screenshot/saver'
+
 # do nothing if Cucumber is not being used
 if defined?(Cucumber::RbSupport::RbDsl)
   require 'capybara/cucumber'
   require 'capybara-screenshot/cucumber'
-
-  After do |scenario|
-    if scenario.failed?
-      screenshot_path = Capybara::Screenshot::Cucumber.screen_shot_and_save_page[:image]
-      # Trying to embed the screenshot into our output."
-      if File.exist?(screenshot_path)
-        require "base64"
-        #encode the image into it's base64 representation
-        encoded_img = Base64.encode64(IO.read(screenshot_path))
-        #this will embed the image in the HTML report, embed() is defined in cucumber
-        embed("data:image/png;base64,#{encoded_img}", 'image/png', "Screenshot of the error")
-      end
-    end
-  end
 end
 
 if defined?(RSpec)
@@ -23,11 +71,6 @@ if defined?(RSpec)
   #   RSpec hooks afterwards, and thus executed first
   require 'capybara/rspec'
   require 'capybara-screenshot/rspec'
-  RSpec.configure do |config|
-    config.after do
-      Capybara::Screenshot::RSpec.screen_shot_and_save_page if example.exception
-    end
-  end
 end
 
 begin
@@ -35,4 +78,4 @@ begin
   require 'capybara-screenshot/minitest'
 rescue LoadError
   # mini test not available
-end
+end

data/lib/capybara-screenshot/cucumber.rb

@@ -1,11 +1,32 @@
-require 'capybara-screenshot/saver'
-
 module Capybara
   module Screenshot
     module Cucumber
-      def self.screen_shot_and_save_page
-        Capybara::Screenshot::Saver.screen_shot_and_save_page Capybara, Capybara.body
+
+      def screen_shot_and_save_page
+        Capybara::Screenshot.screen_shot_and_save_page
+      end
+
+      def screen_shot_and_open_image
+        Capybara::Screenshot.screen_shot_and_open_image
       end
+      
+    end
+  end
+end
+World(Capybara::Screenshot::Cucumber)
+
+After do |scenario|
+  if Capybara::Screenshot.autosave_on_failure && scenario.failed?
+    saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page)
+    saver.save
+
+    # Trying to embed the screenshot into our output."
+    if File.exist?(saver.screenshot_path)
+      require "base64"
+      #encode the image into it's base64 representation
+      encoded_img = Base64.encode64(IO.read(saver.screenshot_path))
+      #this will embed the image in the HTML report, embed() is defined in cucumber
+      embed("data:image/png;base64,#{encoded_img}", 'image/png', "Screenshot of the error")
     end
   end
 end

data/lib/capybara-screenshot/minitest.rb

@@ -1,5 +1,3 @@
-require 'capybara-screenshot/saver'
-
 if defined?(ActionDispatch::IntegrationTest)
   method = if ActionDispatch::IntegrationTest.respond_to? :teardown
     :teardown
@@ -13,8 +11,8 @@ if defined?(ActionDispatch::IntegrationTest)
         # by adding the argument context, MiniTest passes the context of the test
         # which has an instance variable @passed indicating success / failure
         context.instance_eval do
-          if @passed.blank?
-            Capybara::Screenshot::Saver.screen_shot_and_save_page Capybara, Capybara.body
+          if Capybara::Screenshot.autosave_on_failure && @passed.blank?
+            Capybara::Screenshot.screen_shot_and_save_page
           end
         end
       end

data/lib/capybara-screenshot/rspec.rb

@@ -1,11 +1,10 @@
-require 'capybara-screenshot/saver'
+RSpec.configure do |config|
+  config.after(:type => :request) do
+    if Capybara::Screenshot.autosave_on_failure && example.exception
+      saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page)
+      saver.save
 
-module Capybara
-  module Screenshot
-    class RSpec
-      def self.screen_shot_and_save_page
-        Capybara::Screenshot::Saver.screen_shot_and_save_page Capybara, Capybara.body
-      end
+      example.metadata[:full_description] += "\n     Screenshot: #{saver.screenshot_path}"
     end
   end
 end

data/lib/capybara-screenshot/saver.rb

@@ -1,49 +1,47 @@
 module Capybara
   module Screenshot
-    module Saver
-      def self.screen_shot_and_save_page(capybara, body)
-        #Our default return values
-        html_path = nil
-        image_path = nil
+    class Saver
+      attr_reader :capybara, :page, :file_base_name
 
+      def initialize(capybara, page, html_save=true)
+        @capybara, @page, @html_save = capybara, page, html_save
+        @file_base_name = "screenshot-#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}"
+      end
+
+      def save
         # if current_path empty then nothing to screen shot as browser has not loaded any URL
-        unless capybara.current_path.to_s.empty?
-          require 'capybara/util/save_and_open_page'
-          file_base_name = "#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}"
-          #will save to the capybara.save_and_open_page_path
-          html_path = "{capybara.save_and_open_page_path}#{file_base_name}.html"
-          capybara.save_page(body, "#{file_base_name}.html")
-
-          #where should we save the screenshot to
-          if defined?(Rails)
-            screenshot_path = Rails.root.join "#{capybara.save_and_open_page_path}/#{file_base_name}.png"
-          elsif defined?(Padrino)
-            screenshot_path = Padrino.root "#{capybara.save_and_open_page_path}/#{file_base_name}.png"
-          elsif defined?(Sinatra)
-            # Sinatra support, untested
-            screenshot_path = File.join(settings.root, "#{capybara.save_and_open_page_path}/#{file_base_name}.png")
-          else
-            screenshot_path = File.join(capybara.save_and_open_page_path.to_s, "#{file_base_name}.png")
-          end
-
-          #We try to figure out how to call the screenshot method on the current driver
-          case capybara.current_driver
-          when :poltergeist
-            capybara.page.driver.render(screenshot_path, :full => true)
-          when :selenium
-            capybara.page.driver.browser.save_screenshot(screenshot_path)
-          else
-            #For other drivers that support a plain .render call and only expect the path as a parameter
-            #This includes e.g. capybara-webkit
-            if capybara.page.driver.respond_to?(:render)
-              capybara.page.driver.render(screenshot_path)
-            end
-          end
+        return if capybara.current_path.to_s.empty?
+
+        save_html if @html_save
+        save_screenshot
+      end
+
+      def save_html
+        require 'capybara/util/save_and_open_page'
+        capybara.save_page(page.body, "#{file_base_name}.html")
+      end
+
+      def save_screenshot
+        if Capybara::Screenshot.registered_drivers.has_key?(capybara.current_driver)
+          Capybara::Screenshot.registered_drivers[capybara.current_driver].call(page.driver, screenshot_path)
+        else
+          warn "capybara-screenshot could not detect a screenshot driver for '#{capybara.current_driver}'. Saving with default with unknown results."
+          save_with_default
         end
-        #we return the path to the html and the screenshot
-        {:html => html_path, :image => screenshot_path}
       end
+
+      def save_with_default
+        page.driver.render(screenshot_path)
+      end
+
+      def html_path
+        File.join(Capybara::Screenshot.capybara_root, "#{file_base_name}.html")
+      end
+
+      def screenshot_path
+        File.join(Capybara::Screenshot.capybara_root, "#{file_base_name}.png")
+      end
+
     end
   end
 end
-

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = "0.1.10"
+    VERSION = "0.2"
   end
 end

data/spec/capybara-screenshot/saver_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot::Saver do
+  before(:all) do
+    @original_drivers = Capybara::Screenshot.registered_drivers
+    Capybara::Screenshot.registered_drivers[:default] = lambda {|driver, path| driver.render(path) }
+  end
+
+  after(:all) do
+    Capybara::Screenshot.registered_drivers = @original_drivers
+  end
+
+  before do
+    Capybara::Screenshot.stub(:capybara_root).and_return(capybara_root)
+    Timecop.freeze(Time.local(2012, 6, 7, 8, 9, 10))
+  end
+
+  let(:capybara_root) { '/tmp' }
+  let(:file_basename) { "screenshot-2012-06-07-08-09-10" }
+  let(:screenshot_path) { "#{capybara_root}/#{file_basename}.png" }
+  
+  let(:driver_mock) { mock('Capybara driver').as_null_object }
+  let(:page_mock) { mock('Capybara session page', :body => 'body', :driver => driver_mock).as_null_object }
+  let(:capybara_mock) { 
+    mock(Capybara).as_null_object.tap do |m|
+      m.stub(:current_driver).and_return(:default)
+      m.stub(:current_path).and_return('/')
+    end
+  }
+
+  let(:saver) { Capybara::Screenshot::Saver.new(capybara_mock, page_mock) }
+
+  it 'should save html file with "screenshot-Y-M-D-H-M-S.html" format' do
+    capybara_mock.should_receive(:save_page).with('body', "#{file_basename}.html")
+    
+    saver.save
+  end
+
+  it 'should save screenshot file in capybara root output directory with format "screenshot-Y-M-D-H-M-S.png"' do
+    driver_mock.should_receive(:render).with(screenshot_path)
+
+    saver.save
+  end
+
+  it 'should not save html if false passed as html argument' do
+    saver = Capybara::Screenshot::Saver.new(capybara_mock, page_mock, false)
+    capybara_mock.should_not_receive(:save_page)
+
+    saver.save
+  end
+
+  it 'should save if current_path is empty' do
+    capybara_mock.stub(:current_path).and_return(nil)
+    capybara_mock.should_not_receive(:save_page)
+    driver_mock.should_not_receive(:render)
+
+    saver.save 
+  end
+
+  describe "with selenium driver" do
+    before do
+      capybara_mock.stub(:current_driver).and_return(:selenium)
+    end
+
+    it 'should save via browser' do
+      browser_mock = mock('browser')
+      driver_mock.should_receive(:browser).and_return(browser_mock)
+      browser_mock.should_receive(:save_screenshot).with(screenshot_path)
+
+      saver.save 
+    end
+  end
+
+  describe "with poltergeist driver" do
+    before do
+      capybara_mock.stub(:current_driver).and_return(:poltergeist)
+    end
+
+    it 'should save driver render with :full => true' do
+      driver_mock.should_receive(:render).with(screenshot_path, {:full => true})
+
+      saver.save 
+    end
+  end
+
+  describe "with webkit driver" do
+    before do
+      capybara_mock.stub(:current_driver).and_return(:webkit)
+    end
+
+    it 'should save driver render' do
+      driver_mock.should_receive(:render).with(screenshot_path)
+
+      saver.save 
+    end
+  end
+
+  describe "with unknown driver" do
+    before do
+      capybara_mock.stub(:current_driver).and_return(:unknown)
+      saver.stub(:warn).and_return(nil)
+    end
+
+    it 'should save driver render' do
+      driver_mock.should_receive(:render).with(screenshot_path)
+
+      saver.save 
+    end
+
+    it 'should output warning about unknown results' do
+      # Not pure mock testing 
+      saver.should_receive(:warn).with(/screenshot driver for 'unknown'.*unknown results/).and_return(nil)
+
+      saver.save 
+    end
+  end
+end

data/spec/capybara-screenshot_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot do
+  before(:all) do
+    @original_drivers = Capybara::Screenshot.registered_drivers
+  end
+
+  after(:all) do
+    Capybara::Screenshot.registered_drivers = @original_drivers
+  end
+
+  describe ".register_driver" do
+    it 'should store driver with block' do
+      block = lambda {}
+      Capybara::Screenshot.register_driver :foo, &block
+
+      Capybara::Screenshot.registered_drivers[:foo].should eq block
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+$: << '../lib'
+require 'capybara-screenshot'
+require 'timecop'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -1,64 +1,74 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: capybara-screenshot
-version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 10
-  version: 0.1.10
+version: !ruby/object:Gem::Version
+  version: '0.2'
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Matthew O'Riordan
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-30 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: capybara
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 6
-        version: "2.6"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: When a Cucumber step fails, it is useful to create a screenshot image and HTML file of the current page
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: When a Cucumber step fails, it is useful to create a screenshot image
+  and HTML file of the current page
+email:
 - matthew.oriordan@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .rspec
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -71,39 +81,41 @@ files:
 - lib/capybara-screenshot/rspec.rb
 - lib/capybara-screenshot/saver.rb
 - lib/capybara-screenshot/version.rb
-has_rdoc: true
+- spec/capybara-screenshot/saver_spec.rb
+- spec/capybara-screenshot_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/mattheworiordan/capybara-screenshot
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1087741615674543132
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 1087741615674543132
 requirements: []
-
 rubyforge_project: capybara-screenshot
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Automatically create snapshots when Cucumber steps fail with Capybara and Rails
-test_files: []
-
+summary: Automatically create snapshots when Cucumber steps fail with Capybara and
+  Rails
+test_files:
+- spec/capybara-screenshot/saver_spec.rb
+- spec/capybara-screenshot_spec.rb
+- spec/spec_helper.rb