capybara-screenshot 0.2.2 → 0.2.3

data/README.md

@@ -1,7 +1,7 @@
 capybara-screenshot gem
 =======================
 
-Using this gem, whenever a [Capybara](https://github.com/jnicklas/capybara) test in [Cucumber](http://cukes.info/), [Rspec](https://www.relishapp.com/rspec) or Minitest  fails, the HTML for the failed page and a screenshot (when using [capybara-webkit](https://github.com/thoughtbot/capybara-webkit) or [Selenium](http://seleniumhq.org/)) is saved into $APPLICATION_ROOT/tmp/capybara.
+Using this gem, whenever a [Capybara](https://github.com/jnicklas/capybara) test in [Cucumber](http://cukes.info/), [Rspec](https://www.relishapp.com/rspec) or Minitest  fails, the HTML for the failed page and a screenshot (when using [capybara-webkit](https://github.com/thoughtbot/capybara-webkit), [Selenium](http://seleniumhq.org/) or [poltergeist](https://github.com/jonleighton/poltergeist)) is saved into $APPLICATION_ROOT/tmp/capybara.
 
 This is a huge help when trying to diagnose a problem in your failing steps as you can view the source code and potentially how the page looked at the time of the failure.
 
@@ -10,34 +10,60 @@ Usage
 
     gem install capybara-screenshot
 
-or update your Gemfile to include:
+or update your Gemfile to include `capybara-screenshot` at the bottom (order respected as of Bundler 0.10):
 
-    group :test do
-      gem 'capybara-screenshot'
-    end
-
-That's it!
+    gem 'capybara-screenshot', :group => :test
 
 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.
+if the failure occurs at a point where the screen shot is not as useful for debugging a rendering problem. This
+can be more useful if you disable the auto-generate on failure feature with the following config
+
+	Capybara::Screenshot.autosave_on_failure = false
 
-In Cucumber,
+Anywhere the Capybara DSL methods (visit, click etc.) are available so too will are the screenshot methods.
 
 	screen_shot_and_save_page
 
-Or for screenshot only, with image automatically opened
+Or for screenshot only, which will automatically open the image.
 
 	screen_shot_and_open_image
 
-Or anywhere, including specs and tests
-	
+These are just calls on the main library methods.
+
 	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
+Driver configuration
+--------------------
+
+The gem supports the default rendering method for Capybara to generate the screenshot, which is:
+
+	page.driver.render(path)
+
+There are also some specific driver configurations for Selenium, Webkit, and Poltergeist. See [https://github.com/mattheworiordan/capybara-screenshot/blob/master/lib/capybara-screenshot.rb](the definitions here). The Rack::Test driver, Rails' default, does not allow
+rendering, so it has a driver definition as a noop.
+
+If a driver is not found the default rendering will be used. If this doesn't work with your driver, then you can
+add another driver configuration like so
+
+	# The driver name should match the Capybara driver config name.
+	Capybara::Screenshot.register_driver(:exotic_browser_driver) do |driver, path|
+	  driver.super_dooper_render(path)
+	end
+
+
+Custom screenshot filename
+--------------------------
+
+If you want to control the screenshot filename for a specific test libarary, to inject the test name into it for example,
+you can override how the basename is generated for the file like so
+
+	Capybara::Screenshot.register_filename_prefix_formatter(:rspec) do |example|
+	    "screenshot-#{example.description.gsub(' ', '-')}"
+	  end
+	end
 
 
 Example application
@@ -47,6 +73,17 @@ A simple Rails 3.1 example application has been set up at [https://github.com/ma
 Git clone the app, and then run Cucumber `rake cucumber`, RSpec `rspec spec/**/*_spec.rb` and Minitest `rake test` and expect intentional failures.
 Now check the $APPLICATION_ROOT/tmp/capybara folder for the automatic screen shots generated from failed tests.
 
+Common problems
+---------------
+
+If you find that screen shots are not automatically being generated, then it's possible the `capybara-screenshot` gem is loading before your testing framework is loading, and thus unable to determine which framework to hook into.  Make sure you include `capybara-screenshot` gem last in your Gemfile (order is respected by Bundler as of 0.10).  Alternatively, manually require `capybara-screenshot` using one of the following based on your framework:
+
+    require 'capybara-screenshot/cucumber' # For Cucumber support
+    require 'capybara-screenshot/rspec' # For RSpec support
+    require 'capybara-screenshot/minitest' # For MiniSpec support
+
+[Raise an issue on the Capybara-Screenshot issue tracker](https://github.com/mattheworiordan/capybara-screenshot/issues) if you are still having problems.
+
 Repository
 ----------
 

data/lib/capybara-screenshot.rb

@@ -33,8 +33,8 @@ module Capybara
 
     def self.capybara_root
       return @capybara_root if defined?(@capybara_root)
-
-      capybara_tmp_path = Capybara.save_and_open_page_path.to_s
+      #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
@@ -70,15 +70,19 @@ Capybara::Screenshot.class_eval do
 
   register_driver(:selenium) do |driver, path|
     driver.browser.save_screenshot(path)
-  end 
+  end
 
   register_driver(:poltergeist) do |driver, path|
     driver.render(path, :full => true)
-  end 
+  end
 
   register_driver(:webkit) do |driver, path|
     driver.render(path)
-  end 
+  end
+
+  register_driver(:webkit_debug) do |driver, path|
+    driver.render(path)
+  end
 end
 
 # Register filename prefix formatters
@@ -97,16 +101,5 @@ if defined?(Cucumber::RbSupport::RbDsl)
   require 'capybara-screenshot/cucumber'
 end
 
-if defined?(RSpec)
-  # capybara rspec must be included first so that this config.after is added to
-  #   RSpec hooks afterwards, and thus executed first
-  require 'capybara/rspec'
-  require 'capybara-screenshot/rspec'
-end
-
-begin
-  require 'minitest/unit'
-  require 'capybara-screenshot/minitest'
-rescue LoadError
-  # mini test not available
-end
+require 'capybara-screenshot/rspec' if defined?(RSpec)
+require 'capybara-screenshot/minitest' if defined?(MiniTest)

data/lib/capybara-screenshot/rspec.rb

@@ -1,12 +1,30 @@
 RSpec.configure do |config|
-  config.after(:type => :request) do
-    if Capybara::Screenshot.autosave_on_failure && example.exception
-      filename_prefix = Capybara::Screenshot.filename_prefix_for(:rspec, example)
+  # use the before hook to add an after hook that runs last
+  config.before(:type => :request) do
+    Capybara::Screenshot::RSpecCache.add_after(example.example_group) do
+      if Capybara::Screenshot.autosave_on_failure && example.exception
+        filename_prefix = Capybara::Screenshot.filename_prefix_for(:rspec, example)
 
-      saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
-      saver.save
+        saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+        saver.save
 
-      example.metadata[:full_description] += "\n     Screenshot: #{saver.screenshot_path}"
+        example.metadata[:full_description] += "\n     Screenshot: #{saver.screenshot_path}"
+      end
     end
   end
-end
+end
+
+# keep a record of which example groups we've added an after hook to and add if one does not exist
+module Capybara
+  module Screenshot
+    class RSpecCache
+      @@example_groups = []
+      def self.add_after(example_group, &block)
+        unless @@example_groups.include?(example_group)
+          example_group.after :each, &block
+          @@example_groups << example_group
+        end
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
 end

data/spec/capybara-screenshot/capybara_spec.rb

@@ -1,6 +1,8 @@
+require 'capybara/dsl'
+
 module Capybara::Screenshot
 	describe Capybara do
-    
+
     it 'should add screen shot methods to the Capybara module' do
       ::Capybara.should respond_to(:screen_shot_and_save_page)
       ::Capybara.should respond_to(:screen_shot_and_open_image)

data/spec/capybara-screenshot/saver_spec.rb

@@ -19,10 +19,10 @@ describe Capybara::Screenshot::Saver do
   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 }
   let(:page_mock) { mock('Capybara session page', :body => 'body', :driver => driver_mock).as_null_object }
-  let(:capybara_mock) { 
+  let(:capybara_mock) {
     mock(Capybara).as_null_object.tap do |m|
       m.stub(:current_driver).and_return(:default)
       m.stub(:current_path).and_return('/')
@@ -34,7 +34,7 @@ describe Capybara::Screenshot::Saver do
   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
 
@@ -42,7 +42,7 @@ describe Capybara::Screenshot::Saver 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
@@ -80,7 +80,7 @@ describe Capybara::Screenshot::Saver do
     capybara_mock.should_not_receive(:save_page)
     driver_mock.should_not_receive(:render)
 
-    saver.save 
+    saver.save
   end
 
   describe "with selenium driver" do
@@ -93,7 +93,7 @@ describe Capybara::Screenshot::Saver do
       driver_mock.should_receive(:browser).and_return(browser_mock)
       browser_mock.should_receive(:save_screenshot).with(screenshot_path)
 
-      saver.save 
+      saver.save
     end
   end
 
@@ -105,7 +105,7 @@ describe Capybara::Screenshot::Saver do
     it 'should save driver render with :full => true' do
       driver_mock.should_receive(:render).with(screenshot_path, {:full => true})
 
-      saver.save 
+      saver.save
     end
   end
 
@@ -117,7 +117,19 @@ describe Capybara::Screenshot::Saver do
     it 'should save driver render' do
       driver_mock.should_receive(:render).with(screenshot_path)
 
-      saver.save 
+      saver.save
+    end
+  end
+
+  describe "with webkit debug driver" do
+    before do
+      capybara_mock.stub(:current_driver).and_return(:webkit_debug)
+    end
+
+    it 'should save driver render' do
+      driver_mock.should_receive(:render).with(screenshot_path)
+
+      saver.save
     end
   end
 
@@ -130,14 +142,14 @@ describe Capybara::Screenshot::Saver do
     it 'should save driver render' do
       driver_mock.should_receive(:render).with(screenshot_path)
 
-      saver.save 
+      saver.save
     end
 
     it 'should output warning about unknown results' do
-      # Not pure mock testing 
+      # Not pure mock testing
       saver.should_receive(:warn).with(/screenshot driver for 'unknown'.*unknown results/).and_return(nil)
 
-      saver.save 
+      saver.save
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2012-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -100,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2061536587505827239
+      hash: 2034660228649349470
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2061536587505827239
+      hash: 2034660228649349470
 requirements: []
 rubyforge_project: capybara-screenshot
 rubygems_version: 1.8.24