capybara-screenshot 0.3.16 → 0.3.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33e1c6bb97161f57ea5a4cef1a33e9c4e6c10bb2
-  data.tar.gz: d68d3f14e2dff0186a1623d7224322310e639f54
+  metadata.gz: 678f842e8fe6edb010eb0e94d90138e9bb90ef67
+  data.tar.gz: bc639f571a2dbf76550d295585687141969ab5e4
 SHA512:
-  metadata.gz: 69bce13964bfcefbc65f23cabee234ee6b836b37668a2d2eddce6b27009fe01a0e46160d1f7f24abbf8c4923fa95686b72a949e62ba1ea0e1e2de6fee52a7b6d
-  data.tar.gz: 5dffc2d2b2e0f62ee100d9e04efedef9bad21135ac1cb7c2bdd8a4530211420163858f5fafe089c367959cffb40a7b990306e3a2401beab405c95d3076dd360d
+  metadata.gz: 33ad229a3130437ff4fd1846d3e9e25eaaad5b00d5875f5f6ff01f644e262624118558ce343f32d5c7fde3413e8edb7583f7d9665307f88c7917db60253e3669
+  data.tar.gz: 68c243d32ae3bb3d36f91c2f9580baeedbd51f5349360d9f95347b0a4ae26551bf49acc1334bc44c7db8751e9238027cc2b92cad323d783174ef262fa292fe7b

data/.travis.yml

@@ -2,4 +2,6 @@ language: ruby
 script: "bundle exec rspec"
 rvm:
   - 1.9.3
-  - jruby-19mode # JRuby in 1.9 mode
+  - 2.0.0
+  - 2.1.1
+  - jruby-19mode # JRuby in 1.9 mode

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+2 March 2014 - 0.3.16 -> 0.3.17
+-----------
+
+* Added support for RSpec 3 and cleaned up the logging so there is less noise within the test results when a driver does not support a particular format.
+* Updated Travis to test against Ruby 2.0 and Ruby 2.1
+
+Thanks to https://github.com/noniq
+
 7 January 2014
 -----------
 

data/README.md

@@ -87,13 +87,18 @@ add another driver configuration like so
 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,
+If you want to control the screenshot filename for a specific test library, 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(' ', '-').gsub(/^.*\/spec\//,'')}"
 	  end
 
+By default capybara-screenshot will append a timestamp to the basename. If you want to disable this behavior set the following option:
+
+    Capybara::Screenshot.append_timestamp = false
+
+
 Custom screenshot directory
 --------------------------
 By default screenshots are saved to the current working directory. If you want to customize the location, override the file path as:

data/lib/capybara-screenshot.rb

@@ -5,12 +5,14 @@ module Capybara
       attr_accessor :registered_drivers
       attr_accessor :filename_prefix_formatters
       attr_accessor :append_screenshot_path
+      attr_accessor :append_timestamp
     end
 
     self.autosave_on_failure = true
     self.registered_drivers = {}
     self.filename_prefix_formatters = {}
     self.append_screenshot_path = true
+    self.append_timestamp = true
 
     def self.screenshot_and_save_page
       saver = Saver.new(Capybara, Capybara.page)
@@ -64,18 +66,19 @@ module Capybara
   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|
@@ -99,7 +102,11 @@ Capybara::Screenshot.class_eval do
   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
 

data/lib/capybara-screenshot/rspec.rb

@@ -1,6 +1,10 @@
 RSpec.configure do |config|
   # use the before hook to add an after hook that runs last
-  config.after do
+  config.after do |example_from_block_arg|
+
+    # RSpec 3 no longer defines `example`, but passes the example as block argument instead
+    example = respond_to?(:example) ? self.example : example_from_block_arg
+
     if Capybara.page.respond_to?(:save_page) # Capybara DSL method has been included for a feature we can snapshot
       if Capybara.page.current_url != '' && Capybara::Screenshot.autosave_on_failure && example.exception
         filename_prefix = Capybara::Screenshot.filename_prefix_for(:rspec, example)
@@ -9,7 +13,8 @@ RSpec.configure do |config|
         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

data/lib/capybara-screenshot/saver.rb

@@ -6,7 +6,9 @@ module Capybara
       def initialize(capybara, page, html_save=true, filename_prefix='screenshot')
         @capybara, @page, @html_save = capybara, page, html_save
         time_now = Time.now
-        @file_base_name = "#{filename_prefix}_#{time_now.strftime('%Y-%m-%d-%H-%M-%S.')}#{'%03d' % (time_now.usec/1000).to_i}"
+        timestamp = "#{time_now.strftime('%Y-%m-%d-%H-%M-%S.')}#{'%03d' % (time_now.usec/1000).to_i}"
+        @file_base_name = filename_prefix
+        @file_base_name = "#{@file_base_name}_#{timestamp}" if Capybara::Screenshot.append_timestamp
       end
 
       def save
@@ -26,16 +28,17 @@ module Capybara
             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
 
@@ -47,6 +50,14 @@ module Capybara
         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

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = "0.3.16"
+    VERSION = "0.3.17"
   end
 end

data/spec/capybara-screenshot/saver_spec.rb

@@ -84,6 +84,15 @@ describe Capybara::Screenshot::Saver do
       saver.save
     end
 
+    it "should not append timestamp if append_timestamp is false " do
+      default_config = Capybara::Screenshot.append_timestamp
+      Capybara::Screenshot.append_timestamp = false
+      driver_mock.should_receive(:render).with(/screenshot.png$/)
+
+      saver.save
+      Capybara::Screenshot.append_timestamp = default_config
+    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(/#{capybara_root}\/custom-prefix_#{timestamp}\.png$/)
@@ -97,14 +106,17 @@ describe Capybara::Screenshot::Saver do
     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
@@ -118,6 +130,7 @@ describe Capybara::Screenshot::Saver do
       browser_mock.should_receive(:save_screenshot).with(screenshot_path)
 
       saver.save
+      saver.screenshot_saved?.should be_true
     end
   end
 
@@ -130,6 +143,7 @@ describe Capybara::Screenshot::Saver do
       driver_mock.should_receive(:render).with(screenshot_path, {:full => true})
 
       saver.save
+      saver.screenshot_saved?.should be_true
     end
   end
 
@@ -147,6 +161,7 @@ describe Capybara::Screenshot::Saver do
         driver_mock.should_receive(:render).with(screenshot_path)
 
         saver.save
+        saver.screenshot_saved?.should be_true
       end
     end
 
@@ -159,6 +174,7 @@ describe Capybara::Screenshot::Saver do
         driver_mock.should_receive(:save_screenshot).with(screenshot_path)
 
         saver.save
+        saver.screenshot_saved?.should be_true
       end
     end
   end
@@ -172,6 +188,7 @@ describe Capybara::Screenshot::Saver do
       driver_mock.should_receive(:render).with(screenshot_path)
 
       saver.save
+      saver.screenshot_saved?.should be_true
     end
   end
 
@@ -185,6 +202,7 @@ describe Capybara::Screenshot::Saver do
       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
@@ -192,6 +210,29 @@ describe Capybara::Screenshot::Saver do
       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

metadata

@@ -1,75 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: 0.3.16
+  version: 0.3.17
 platform: ruby
 authors:
 - Matthew O'Riordan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
+date: 2014-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: When a Cucumber step fails, it is useful to create a screenshot image
@@ -80,9 +80,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -111,17 +111,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: capybara-screenshot
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Automatically create snapshots when Cucumber steps fail with Capybara and
@@ -131,4 +131,3 @@ test_files:
 - spec/capybara-screenshot/saver_spec.rb
 - spec/capybara-screenshot_spec.rb
 - spec/spec_helper.rb
-has_rdoc: