capybara-screenshot 0.2 → 0.2.1

data/lib/capybara-screenshot.rb

@@ -3,10 +3,12 @@ module Capybara
     class << self
       attr_accessor :autosave_on_failure
       attr_accessor :registered_drivers
+      attr_accessor :filename_prefix_formatters
     end
 
     self.autosave_on_failure = true
     self.registered_drivers = {}
+    self.filename_prefix_formatters = {}
 
     def self.screen_shot_and_save_page
       saver = Saver.new(Capybara, Capybara.page)
@@ -23,6 +25,12 @@ module Capybara
       {:html => saver.html_path, :image => saver.screenshot_path}
     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)
 
@@ -43,20 +51,38 @@ module Capybara
     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
   end
 end
 
-Capybara::Screenshot.register_driver(:selenium) do |driver, path|
-  driver.browser.save_screenshot(path)
-end 
+# Register driver renderers
+Capybara::Screenshot.class_eval do
+  register_driver(:default) do |driver, path|
+    driver.render(path)
+  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 
 
-Capybara::Screenshot.register_driver(:poltergeist) do |driver, path|
-  driver.render(path, :full => true)
-end 
+  register_driver(:webkit) do |driver, path|
+    driver.render(path)
+  end 
+end
 
-Capybara::Screenshot.register_driver(:webkit) do |driver, path|
-  driver.render(path)
-end 
+# Register filename prefix formatters
+Capybara::Screenshot.class_eval do
+  register_filename_prefix_formatter(:default) do |test|
+    'screenshot'
+  end
+end
 
 require 'capybara-screenshot/saver'
 

data/lib/capybara-screenshot/cucumber.rb

@@ -17,7 +17,9 @@ World(Capybara::Screenshot::Cucumber)
 
 After do |scenario|
   if Capybara::Screenshot.autosave_on_failure && scenario.failed?
-    saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page)
+    filename_prefix = Capybara::Screenshot.filename_prefix_for(:cucumber, scenario)
+
+    saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
     saver.save
 
     # Trying to embed the screenshot into our output."

data/lib/capybara-screenshot/minitest.rb

@@ -10,10 +10,13 @@ if defined?(ActionDispatch::IntegrationTest)
       ActionDispatch::IntegrationTest.send method do |context|
         # 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 Capybara::Screenshot.autosave_on_failure && @passed.blank?
-            Capybara::Screenshot.screen_shot_and_save_page
-          end
+        failed = context.instance_variable_get(:@passed).blank?
+
+        if Capybara::Screenshot.autosave_on_failure && failed
+          filename_prefix = Capybara::Screenshot.filename_prefix_for(:minitest, context)
+
+          saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+          saver.save
         end
       end
     rescue NoMethodError

data/lib/capybara-screenshot/rspec.rb

@@ -1,7 +1,9 @@
 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)
+      filename_prefix = Capybara::Screenshot.filename_prefix_for(:rspec, example)
+
+      saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
       saver.save
 
       example.metadata[:full_description] += "\n     Screenshot: #{saver.screenshot_path}"

data/lib/capybara-screenshot/saver.rb

@@ -3,9 +3,9 @@ module Capybara
     class Saver
       attr_reader :capybara, :page, :file_base_name
 
-      def initialize(capybara, page, html_save=true)
+      def initialize(capybara, page, html_save=true, filename_prefix='screenshot')
         @capybara, @page, @html_save = capybara, page, html_save
-        @file_base_name = "screenshot-#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}"
+        @file_base_name = "#{filename_prefix}-#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}"
       end
 
       def save
@@ -22,16 +22,10 @@ module Capybara
       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
+        Capybara::Screenshot.registered_drivers.fetch(capybara.current_driver) { |driver_name|
           warn "capybara-screenshot could not detect a screenshot driver for '#{capybara.current_driver}'. Saving with default with unknown results."
-          save_with_default
-        end
-      end
-
-      def save_with_default
-        page.driver.render(screenshot_path)
+          Capybara::Screenshot.registered_drivers[:default]
+        }.call(page.driver, screenshot_path)
       end
 
       def html_path

data/lib/capybara-screenshot/version.rb

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

data/spec/capybara-screenshot/saver_spec.rb

@@ -16,7 +16,8 @@ describe Capybara::Screenshot::Saver do
   end
 
   let(:capybara_root) { '/tmp' }
-  let(:file_basename) { "screenshot-2012-06-07-08-09-10" }
+  let(:timestamp) { '2012-06-07-08-09-10' }
+  let(:file_basename) { "screenshot-#{timestamp}" }
   let(:screenshot_path) { "#{capybara_root}/#{file_basename}.png" }
   
   let(:driver_mock) { mock('Capybara driver').as_null_object }
@@ -30,16 +31,41 @@ describe Capybara::Screenshot::Saver do
 
   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
+  context 'html filename' do
+    it 'should have default format of "screenshot-Y-M-D-H-M-S.html"' do
+      capybara_mock.should_receive(:save_page).with('body', "#{file_basename}.html")
+      
+      saver.save
+    end
+
+    it 'should use name argument as prefix' do
+      saver = Capybara::Screenshot::Saver.new(capybara_mock, page_mock, true, 'custom-prefix')
+
+      capybara_mock.should_receive(:save_page).with('body', "custom-prefix-#{timestamp}.html")
+      
+      saver.save
+    end
   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)
+  context 'screenshot image path' do
+    it 'should be in capybara root output' do
+      driver_mock.should_receive(:render).with(/^#{capybara_root}\//)
 
-    saver.save
+      saver.save
+    end
+
+    it 'should have default filename format of "screenshot-Y-M-D-H-M-S.png"' do
+      driver_mock.should_receive(:render).with(/#{file_basename}\.png$/)
+
+      saver.save
+    end
+
+    it 'should use filename prefix argument as basename prefix' do
+      saver = Capybara::Screenshot::Saver.new(capybara_mock, page_mock, true, 'custom-prefix')
+      driver_mock.should_receive(:render).with(/custom-prefix-#{timestamp}\.png$/)
+
+      saver.save
+    end
   end
 
   it 'should not save html if false passed as html argument' do

data/spec/capybara-screenshot_spec.rb

@@ -1,15 +1,15 @@
 require 'spec_helper'
 
 describe Capybara::Screenshot do
-  before(:all) do
-    @original_drivers = Capybara::Screenshot.registered_drivers
-  end
+  describe ".register_driver" do
+    before(:all) do
+      @original_drivers = Capybara::Screenshot.registered_drivers.dup
+    end
 
-  after(:all) do
-    Capybara::Screenshot.registered_drivers = @original_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
@@ -17,4 +17,27 @@ describe Capybara::Screenshot do
       Capybara::Screenshot.registered_drivers[:foo].should eq block
     end
   end
+
+  describe ".register_filename_prefix_formatter" do
+    before(:all) do
+      @original_formatters = Capybara::Screenshot.filename_prefix_formatters.dup
+    end
+
+    after(:all) do
+      Capybara::Screenshot.filename_prefix_formatters = @original_formatters
+    end
+
+    it 'should store test type with block' do
+      block = lambda { |arg| }
+      Capybara::Screenshot.register_filename_prefix_formatter :foo, &block
+
+      Capybara::Screenshot.filename_prefix_formatters[:foo].should eq block
+    end
+  end
+
+  describe ".filename_prefix_for" do
+    it 'should return "screenshot" for undefined formatter' do
+      Capybara::Screenshot.filename_prefix_for(:foo, mock('test')).should eq 'screenshot'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-20 00:00:00.000000000 Z
+date: 2012-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -98,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1087741615674543132
+      hash: 866292530487117762
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1087741615674543132
+      hash: 866292530487117762
 requirements: []
 rubyforge_project: capybara-screenshot
 rubygems_version: 1.8.24