capybara-screenshot 0.1.4 → 0.1.5

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+24 November 2011
+----------------
+
+Added support for:
+
+ * More platforms (Poltergeist)
+ * Removed Rails dependencies (bug)
+ * Added screenshot capability for Selenium
+ * Added support for embed for HTML reports
+
+Thanks to [https://github.com/rb2k](https://github.com/rb2k) for 2 [great commits](https://github.com/mattheworiordan/capybara-screenshot/pull/4)
+
 16 November 2011
 ----------------
 

data/lib/capybara-screenshot.rb

@@ -1,17 +1,20 @@
 # do nothing if Cucumber is not being used
 if defined?(Cucumber::RbSupport::RbDsl)
   require 'capybara/cucumber'
-  require 'capybara-screenshot/world'
-
-  module Capybara
-    module Screenshot
-    end
-  end
-
-  World(Capybara::Screenshot::World)
+  require 'capybara-screenshot/cucumber'
 
   After do |scenario|
-    screen_shot_and_save_page if scenario.failed?
+    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
 
@@ -30,6 +33,6 @@ end
 begin
   require 'minitest/unit'
   require 'capybara-screenshot/minitest'
-rescue
+rescue LoadError
   # mini test not available
 end

data/lib/capybara-screenshot/{world.rb → cucumber.rb}

@@ -2,8 +2,8 @@ require 'capybara-screenshot/saver'
 
 module Capybara
   module Screenshot
-    module World
-      def screen_shot_and_save_page
+    module Cucumber
+      def self.screen_shot_and_save_page
         Capybara::Screenshot::Saver.screen_shot_and_save_page Capybara, Capybara.body
       end
     end

data/lib/capybara-screenshot/saver.rb

@@ -1,22 +1,49 @@
 module Capybara
   module Screenshot
-    class Saver
+    module Saver
       def self.screen_shot_and_save_page(capybara, body)
-        unless capybara.current_path.blank?
+        #Our default return values
+        html_path = nil
+        image_path = nil
+
+        if capybara.current_path.to_s.empty?
+          puts "Current path is empty, can't take a screenshot"
+        else
           require 'capybara/util/save_and_open_page'
-          path = "/#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}"
-          capybara.save_page body, "#{path}.html"
-          if capybara.page.driver.respond_to?(:render)
-            path = if defined?(Rails)
-              Rails.root.join "#{capybara.save_and_open_page_path}#{path}.png"
-            else
-              # Sinatra support, untested
-              File.join settings.root "#{capybara.save_and_open_page_path}#{path}.png"
+          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?(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")
+            screenshot_path = "#{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
-            capybara.page.driver.render path
           end
         end
+        #we return the path to the html and the screenshot
+        {:html => html_path, :image => screenshot_path}
       end
     end
   end
-end
+end
+

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: capybara-screenshot
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Matthew O'Riordan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-21 00:00:00 +00:00
+date: 2011-11-24 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,11 +81,11 @@ files:
 - Rakefile
 - capybara-screenshot.gemspec
 - lib/capybara-screenshot.rb
+- lib/capybara-screenshot/cucumber.rb
 - lib/capybara-screenshot/minitest.rb
 - lib/capybara-screenshot/rspec.rb
 - lib/capybara-screenshot/saver.rb
 - lib/capybara-screenshot/version.rb
-- lib/capybara-screenshot/world.rb
 has_rdoc: true
 homepage: http://github.com/mattheworiordan/capybara-screenshot
 licenses: []