Merge pull request #76 from noniq/improve-output

Improve output and reduce clutter

lib/capybara-screenshot.rb

@@ -66,18 +66,19 @@ def self.register_filename_prefix_formatter(test_type, &block)
   end
 end
 
-# Register driver renderers
+# Register driver renderers.
+# The block should return `:not_supported` if a screenshot could not be saved.
 Capybara::Screenshot.class_eval do
   register_driver(:default) do |driver, path|
     driver.render(path)
   end
 
   register_driver(:rack_test) do |driver, path|
-    warn "Rack::Test capybara driver has no ability to output screen shots. Skipping."
+    :not_supported
   end
 
   register_driver(:mechanize) do |driver, path|
-    warn "Mechanize capybara driver has no ability to output screen shots. Skipping."
+    :not_supported
   end
 
   register_driver(:selenium) do |driver, path|
@@ -101,7 +102,11 @@ def self.register_filename_prefix_formatter(test_type, &block)
   end
 
   register_driver(:terminus) do |driver, path|
-    driver.save_screenshot(path) if driver.respond_to?(:save_screenshot)
+    if driver.respond_to?(:save_screenshot)
+      driver.save_screenshot(path)
+    else
+      :not_supported
+    end
   end
 end
 

lib/capybara-screenshot/rspec.rb

@@ -13,7 +13,8 @@
         saver.save
 
         if Capybara::Screenshot.append_screenshot_path
-          example.metadata[:full_description] += "\n     Screenshot: #{saver.screenshot_path}"
+          example.metadata[:full_description] += "\n     Screenshot: #{saver.screenshot_path}" if saver.screenshot_saved?
+          example.metadata[:full_description] += "\n     HTML page: #{saver.html_path}" if saver.html_saved?
         end
       end
     end

lib/capybara-screenshot/saver.rb

@@ -28,16 +28,17 @@ def save_html
             capybara.save_page("#{path}")
           end
         end
-        warn "Saved file #{path}"
+        @html_saved = true
       end
 
       def save_screenshot
         path = screenshot_path
         clear_save_and_open_page_path do
-          Capybara::Screenshot.registered_drivers.fetch(capybara.current_driver) { |driver_name|
+          result = 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."
             Capybara::Screenshot.registered_drivers[:default]
           }.call(page.driver, path)
+          @screenshot_saved = result != :not_supported
         end
       end
 
@@ -49,6 +50,14 @@ def screenshot_path
         File.join(Capybara::Screenshot.capybara_root, "#{file_base_name}.png")
       end
 
+      def html_saved?
+        @html_saved
+      end
+
+      def screenshot_saved?
+        @screenshot_saved
+      end
+
       # If Capybara.save_and_open_page_path is set then
       # the html_path or screenshot_path can be appended to this path in
       # some versions of Capybara instead of using it as an absolute path

spec/capybara-screenshot/saver_spec.rb

@@ -106,14 +106,17 @@
     capybara_mock.should_not_receive(:save_page)
 
     saver.save
+    saver.html_saved?.should be_false
   end
 
-  it 'should save if current_path is empty' do
+  it 'should not 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
+    saver.screenshot_saved?.should be_false
+    saver.html_saved?.should be_false
   end
 
   describe "with selenium driver" do
@@ -127,6 +130,7 @@
       browser_mock.should_receive(:save_screenshot).with(screenshot_path)
 
       saver.save
+      saver.screenshot_saved?.should be_true
     end
   end
 
@@ -139,6 +143,7 @@
       driver_mock.should_receive(:render).with(screenshot_path, {:full => true})
 
       saver.save
+      saver.screenshot_saved?.should be_true
     end
   end
 
@@ -156,6 +161,7 @@
         driver_mock.should_receive(:render).with(screenshot_path)
 
         saver.save
+        saver.screenshot_saved?.should be_true
       end
     end
 
@@ -168,6 +174,7 @@
         driver_mock.should_receive(:save_screenshot).with(screenshot_path)
 
         saver.save
+        saver.screenshot_saved?.should be_true
       end
     end
   end
@@ -181,6 +188,7 @@
       driver_mock.should_receive(:render).with(screenshot_path)
 
       saver.save
+      saver.screenshot_saved?.should be_true
     end
   end
 
@@ -194,13 +202,37 @@
       driver_mock.should_receive(:render).with(screenshot_path)
 
       saver.save
+      saver.screenshot_saved?.should be_true
     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
+      saver.screenshot_saved?.should be_true
+    end
+
+    describe "with rack_test driver" do
+      before do
+        capybara_mock.stub(:current_driver).and_return(:rack_test)
+      end
+
+      it 'should indicate that a screenshot could not be saved' do
+        saver.save
+        saver.screenshot_saved?.should be_false
+      end
+    end
+
+    describe "with mechanize driver" do
+      before do
+        capybara_mock.stub(:current_driver).and_return(:mechanize)
+      end
+
+      it 'should indicate that a screenshot could not be saved' do
+        saver.save
+        saver.screenshot_saved?.should be_false
+      end
     end
   end
 end