capybara-screenshot 0.2.4 → 0.3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+30 Oct 2012 - Significant version bump 0.3
+-----------
+
+After some consideration, and continued problems with load order of capybara-screenshot in relation to other required gems, the commits from @adzap in the pull request https://github.com/mattheworiordan/capybara-screenshot/pull/29 have been incorporated.  Moving forwards, for every testing framework you use, you will be required to add an explicit require.
+
+
 15 Feb 2012
 -----------
 

data/README.md

@@ -5,34 +5,55 @@ Using this gem, whenever a [Capybara](https://github.com/jnicklas/capybara) test
 
 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.
 
-Usage
+Installation
 -----
 
-    gem install capybara-screenshot
+### Step 1
 
-or update your Gemfile to include `capybara-screenshot` at the bottom (order respected as of Bundler 0.10):
+Using Bundler, add the following to your Gemfile
 
     gem 'capybara-screenshot', :group => :test
 
+or install manually using Ruby Gems:
+
+    gem install capybara-screenshot
+
+### Step 2
+
+For **Cucumber**, in env.rb or a support file, please add:
+
+    require 'capybara-screenshot/cucumber'
+
+For **RSpec**, in spec_helper.rb or a support file, after the require for 'capybara/rspec', please add:
+
+    # you should require 'capybara/rspec' first
+    require 'capybara-screenshot/rspec'
+
+For **Minitest**, typically in 'test/test_helper.rb', please add:
+
+    require 'capybara-screenshot/minitest'
+
+Manual screenshots
+----
+
 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. This
 can be more useful if you disable the auto-generate on failure feature with the following config
 
 	Capybara::Screenshot.autosave_on_failure = false
 
-Anywhere the Capybara DSL methods (visit, click etc.) are available so too will are the screenshot methods.
+Anywhere the Capybara DSL methods (visit, click etc.) are available so too are the screenshot methods.
 
-	screen_shot_and_save_page
+	screenshot_and_save_page
 
 Or for screenshot only, which will automatically open the image.
 
-	screen_shot_and_open_image
+	screenshot_and_open_image
 
 These are just calls on the main library methods.
 
-	Capybara::Screenshot.screen_shot_and_save_page
-
-	Capybara::Screenshot.screen_shot_and_open_image
+    Capybara::Screenshot.screenshot_and_save_page
+    Capybara::Screenshot.screenshot_and_open_image
 
 
 Driver configuration
@@ -70,17 +91,14 @@ Example application
 -------------------
 
 A simple Rails 3.1 example application has been set up at [https://github.com/mattheworiordan/capybara-screenshot-test-rails-3.1](https://github.com/mattheworiordan/capybara-screenshot-test-rails-3.1)
-Git clone the app, and then run Cucumber `rake cucumber`, RSpec `rspec spec/**/*_spec.rb` and Minitest `rake test` and expect intentional failures.
+Git clone the app, and then run Cucumber `rake cucumber`, RSpec `rake spec` 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
+If you have recently upgraded from v0.2, or you find that screen shots are not automatically being generated, then it's most likely you have not included the necessary `require` statement for your testing framework described above.  As of version 0.3, without the explicit require, Capybara-Screenshot will not automatically take screen shots.  Please re-read the installation instructions above.
 
 [Raise an issue on the Capybara-Screenshot issue tracker](https://github.com/mattheworiordan/capybara-screenshot/issues) if you are still having problems.
 
@@ -103,4 +121,4 @@ This gem was written by **Matthew O'Riordan**
 License
 -------
 
-Copyright © 2012 Matthew O'Riordan, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.
+Copyright © 2012 Matthew O'Riordan, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.

data/lib/capybara-screenshot.rb

@@ -10,19 +10,24 @@ module Capybara
     self.registered_drivers = {}
     self.filename_prefix_formatters = {}
 
-    def self.screen_shot_and_save_page
+    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.screen_shot_and_open_image
+    def self.screenshot_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}
+      {: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)
@@ -92,14 +97,6 @@ Capybara::Screenshot.class_eval do
   end
 end
 
+require 'capybara/dsl'
 require 'capybara-screenshot/saver'
-require 'capybara-screenshot/capybara'
-
-# do nothing if Cucumber is not being used
-if defined?(Cucumber::RbSupport::RbDsl)
-  require 'capybara/cucumber'
-  require 'capybara-screenshot/cucumber'
-end
-
-require 'capybara-screenshot/rspec' if defined?(RSpec)
-require 'capybara-screenshot/minitest' if defined?(MiniTest)
+require 'capybara-screenshot/capybara'

data/lib/capybara-screenshot/capybara.rb

@@ -3,12 +3,12 @@ module Capybara
     # Adds class methods to Capybara module and gets mixed into
     # the current scope during Cucumber and RSpec tests
 
-    def screen_shot_and_save_page
-      Capybara::Screenshot.screen_shot_and_save_page
+    def screenshot_and_save_page
+      Capybara::Screenshot.screenshot_and_save_page
     end
 
-    def screen_shot_and_open_image
-      Capybara::Screenshot.screen_shot_and_open_image
+    def screenshot_and_open_image
+      Capybara::Screenshot.screenshot_and_open_image
     end
   end
-end
+end

data/lib/capybara-screenshot/minitest.rb

@@ -1,26 +1,24 @@
-if defined?(ActionDispatch::IntegrationTest)
-  method = if ActionDispatch::IntegrationTest.respond_to? :teardown
-    :teardown
-  elsif ActionDispatch::IntegrationTest.respond_to? :add_tear_down_hook
-    :add_tear_down_hook
-  end
+method = if ActionDispatch::IntegrationTest.respond_to? :teardown
+  :teardown
+elsif ActionDispatch::IntegrationTest.respond_to? :add_tear_down_hook
+  :add_tear_down_hook
+end
 
-  unless method.nil?
-    begin
-      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
-        failed = context.instance_variable_get(:@passed).blank?
+unless method.nil?
+  begin
+    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
+      failed = context.instance_variable_get(:@passed).blank?
 
-        if Capybara::Screenshot.autosave_on_failure && failed
-          filename_prefix = Capybara::Screenshot.filename_prefix_for(:minitest, context)
+      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
+        saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+        saver.save
       end
-    rescue NoMethodError
-      # do nothing, teardown for minitest not available
     end
+  rescue NoMethodError
+    # do nothing, teardown for minitest not available
   end
 end

data/lib/capybara-screenshot/rspec.rb

@@ -1,43 +1,13 @@
 RSpec.configure do |config|
   # use the before hook to add an after hook that runs last
-  config.before(:type => :request) do
-    Capybara::Screenshot::RSpec.add_after(example.example_group) do
-      if Capybara::Screenshot.autosave_on_failure && example.exception
-        filename_prefix = Capybara::Screenshot.filename_prefix_for(:rspec, example)
+  config.after(:type => :request) 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}"
-      end
+      example.metadata[:full_description] += "\n     Screenshot: #{saver.screenshot_path}"
     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 RSpec
-      @@example_groups = []
-      def self.add_after(example_group, &block)
-        unless (@@example_groups & self_and_parents(example_group)).count > 0
-          example_group.after :each, &block
-          @@example_groups << example_group
-        end
-      end
-
-      private
-        # Return an array of current ExampleGroup and all parent ExampleGroups other than Core which has no metadata
-        def self.self_and_parents(example_group, children = [])
-          parent_is_core = example_group.superclass.metadata.nil? rescue true # don't ever raise an error if RSpec API changes in the future, lets rather do multiple screen shots as a side effect
-          if parent_is_core
-            children << example_group
-            children
-          else
-            children << example_group
-            self_and_parents(example_group.superclass, children)
-          end
-        end
-    end
-  end
-end
+end

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = "0.2.4"
+    VERSION = "0.3"
   end
 end

data/spec/capybara-screenshot/capybara_spec.rb

@@ -4,14 +4,14 @@ 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)
+      ::Capybara.should respond_to(:screenshot_and_save_page)
+      ::Capybara.should respond_to(:screenshot_and_open_image)
     end
 
     context 'request type example', :type => :request do
       it 'should have access to screen shot instance methods' do
-        self.should respond_to(:screen_shot_and_save_page)
-        self.should respond_to(:screen_shot_and_open_image)
+        self.should respond_to(:screenshot_and_save_page)
+        self.should respond_to(:screenshot_and_open_image)
       end
     end
 	end

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@
 
 $: << '../lib'
 require 'capybara-screenshot'
+require 'capybara-screenshot/rspec'
 require 'timecop'
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
+date: 2012-10-30 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: -2394325955606346377
+      hash: 1964539847270937869
 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: -2394325955606346377
+      hash: 1964539847270937869
 requirements: []
 rubyforge_project: capybara-screenshot
 rubygems_version: 1.8.24