capybara-screenshot 0.3.19 → 0.3.20

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTRkNjU5NmE5NGZkNDAyYjkxNjBkZjYyYTNjYjU2YzA4YTg4MTZlOQ==
+    ZWU2OWY4YzU2ZjQyYjIwNWM0MGEzOTA3Mjg4YjFiMTY5NTA1NTdhYQ==
   data.tar.gz: !binary |-
-    YzgzZGY1YTVhMGE0MDUzNWM4ODIwZWQ3Mzc4ZDU4ZDhkMzhmYWNjMA==
+    NmU0ZjcwMTYyMzlmOGYwYzYyODI1YmZlNjg1OGExMmI3ZTM0NDgyYw==
 SHA512:
   metadata.gz: !binary |-
-    ODEyN2Q0YTEwZTI0YjVmOWM5ZDkxMmUyNTVhYjgwNjMwYzhkZGUzMDk0MmJh
-    MDk1OWI2ZTAwOTJkNjRlYjc2NTJlYzY2ZjEyNzllODkyNzc5MzJkNmEwZjg5
-    MTJkOTQ0M2E3NjhlNzgyNjNiMmU2MGY5Y2VkYjgzYTQyOGRkMDg=
+    NTRiMDIxYmQ1NzkwNTIzM2RkOGMzNzE0MDJiMGE1OGM3MTk3ZDc1YmNiZDYx
+    ZTVhNDI0MjM0OGQ0YWQ0YTIyOWQ4M2Y5MWJmMGVjYmRmODZkMTYxOWIxNjQ5
+    MzRlZDI5NDIwMmI3NzE0ZDU5ZTE5NGI0ZmEyNTZlNmFlZjE4NzU=
   data.tar.gz: !binary |-
-    NDFiMzc5MzAzYWEyMzQxMzkzYzQ1NTk2NGQ1ZDdkMmRkZTA4Nzg1OGMwODE5
-    ODg0NjFiYThjOTQ0MGZlN2Q3NzZkYzEyNTA0OWU0MjhiMTc0Yzg4Mjk4Njc0
-    ZjJkYTQ0MTFlY2ZmNTYwOGM5M2FkNzZjZmY5OTBhZWMwMjhjMzQ=
+    YzhhMjc5MTQ1MGNlNjU4YWE2ZmZjNzNiNDAwM2I3M2I2ZDM3MTk5ODk3ZjVh
+    YTM3NjE5Yjk1MDBlMDM3Yjk3ODYyY2E5NTk0NDAxMTQ1N2RkNmIzMDZiMmU3
+    NGY5ZjI2ZmVlYzA1MzczN2E4ZDkyMjAzYjZhYzk1MzYzNmVjOGY=

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+11 July 2014 - 0.3.19 -> 0.3.20
+-----------
+
+* Added reporters to improve screenshot info in RSpec output
+* Added support for Webkit options such as width and height
+
+Thanks to https://github.com/multiplegeorges and https://github.com/noniq
+
 2 April 2014 - 0.3.18 -> 0.3.19
 -----------
 

data/README.md

@@ -32,6 +32,7 @@ For **Cucumber**, in env.rb or a support file, please add:
 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'
     require 'capybara-screenshot/rspec'
 
 For **Minitest**, typically in 'test/test_helper.rb', please add:
@@ -75,6 +76,10 @@ The gem supports the default rendering method for Capybara to generate the scree
 There are also some specific driver configurations for Selenium, Webkit, and Poltergeist. See [the definitions here](https://github.com/mattheworiordan/capybara-screenshot/blob/master/lib/capybara-screenshot.rb). The Rack::Test driver, Rails' default, does not allow
 rendering, so it has a driver definition as a noop.
 
+Capybara-webkit defaults to a screenshot size of 1000px by 10px. To specify a custom size, use the following option:
+
+    Capybara::Screenshot.webkit_options = {width: 1024, height: 768}
+
 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
 
@@ -106,14 +111,19 @@ By default screenshots are saved to the current working directory. If you want t
     Capybara.save_and_open_page_path = "/file/path"
 
 
-Screenshot path in RSpec metadata
----------------------------------
+Information about screenshots in RSpec output
+---------------------------------------------
+
+By default, capybara-screenshot extend RSpec’s formatters to include a link to the screenshot and/or saved html page for each failed spec. If you want to disable this feature completely (eg. to avoid problems with CI tools), use:
+
+    Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples = false
+
+It’s also possible to directly embed the screenshot image in the output if you’re using RSpec’s HtmlFormatter:
+
+    Capybara::Screenshot::RSpec::REPORTERS["RSpec::Core::Formatters::HtmlFormatter"] = Capybara::Screenshot::RSpec::HtmlEmbedReporter
 
-By default capybara-screenshot will append the screenshot path to a failing spec's full_description which effectively
-changes the name of the spec and breaks trend reporting using tools like CI Reporter.  You can turn off the default behavior
-with the following invocation
+If you want to further customize the information added to RSpec’s output, just implement your own reporter class and customize `Capybara::Screenshot::RSpec::REPORTERS` accordingly. See [rspec.rb](lib/capybara-screenshot/rspec.rb) for more info.
 
-    Capybara::Screenshot.append_screenshot_path = false
 
 Example application
 -------------------

data/lib/capybara-screenshot.rb

@@ -4,15 +4,21 @@ module Capybara
       attr_accessor :autosave_on_failure
       attr_accessor :registered_drivers
       attr_accessor :filename_prefix_formatters
-      attr_accessor :append_screenshot_path
       attr_accessor :append_timestamp
+      attr_accessor :webkit_options
     end
 
     self.autosave_on_failure = true
     self.registered_drivers = {}
     self.filename_prefix_formatters = {}
-    self.append_screenshot_path = true
     self.append_timestamp = true
+    self.webkit_options = {}
+
+    def self.append_screenshot_path=(value)
+      $stderr.puts "WARNING: Capybara::Screenshot.append_screenshot_path is deprecated. " +
+        "Please use Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples instead."
+      RSpec.add_link_to_screenshot_for_failed_examples = value
+    end
 
     def self.screenshot_and_save_page
       saver = Saver.new(Capybara, Capybara.page)
@@ -91,7 +97,7 @@ Capybara::Screenshot.class_eval do
 
   register_driver(:webkit) do |driver, path|
     if driver.respond_to?(:save_screenshot)
-      driver.save_screenshot(path)
+      driver.save_screenshot(path, webkit_options)
     else
       driver.render(path)
     end

data/lib/capybara-screenshot/rspec.rb

@@ -1,21 +1,81 @@
+require "capybara-screenshot/rspec/text_reporter"
+require "capybara-screenshot/rspec/html_link_reporter"
+require "capybara-screenshot/rspec/html_embed_reporter"
+require "capybara-screenshot/rspec/textmate_link_reporter"
+
+module Capybara
+  module Screenshot
+    module RSpec
+
+      # Reporters extend RSpec formatters to display information about screenshots for failed
+      # examples.
+      #
+      # Technically, a reporter is a module that gets injected into a RSpec formatter class.
+      # It uses method aliasing to extend some (usually just one) of the formatter's methods.
+      #
+      # Implementing a custom reporter is as simple as creating a module and setting up the
+      # appropriate aliases. Use `BaseReporter.enhance_with_screenshot` if you don't want
+      # to set up the aliases manually:
+      #
+      #   module MyReporter
+      #     extend Capybara::Screenshot::RSpec::BaseReporter
+      #
+      #     # Will replace the formatter's original `dump_failure_info` method with
+      #     # `dump_failure_info_with_screenshot` from this module:
+      #     enhance_with_screenshot :dump_failure_info
+      #
+      #     def dump_failure_info_with_screenshot(example)
+      #       dump_failure_info_without_screenshot(example) # call original implementation
+      #       ... # your additions here
+      #     end
+      #   end
+      #
+      # Finally customize `Capybara::Screenshot::RSpec::FORMATTERS` to make sure your reporter
+      # gets injected into the appropriate formatter.
+
+      REPORTERS = {
+        "RSpec::Core::Formatters::ProgressFormatter" => Capybara::Screenshot::RSpec::TextReporter,
+        "RSpec::Core::Formatters::HtmlFormatter"     => Capybara::Screenshot::RSpec::HtmlLinkReporter,
+        "RSpec::Core::Formatters::TextMateFormatter" => Capybara::Screenshot::RSpec::TextMateLinkReporter, # RSpec 2
+        "RSpec::Mate::Formatters::TextMateFormatter" => Capybara::Screenshot::RSpec::TextMateLinkReporter  # RSpec 3
+      }
+
+      class << self
+        attr_accessor :add_link_to_screenshot_for_failed_examples
+
+        def after_failed_example(example)
+          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)
+              saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+              saver.save
+
+              example.metadata[:screenshot] = {}
+              example.metadata[:screenshot][:html]  = saver.html_path if saver.html_saved?
+              example.metadata[:screenshot][:image] = saver.screenshot_path if saver.screenshot_saved?
+            end
+          end
+        end
+      end
+
+      self.add_link_to_screenshot_for_failed_examples = true
+    end
+  end
+end
+
 RSpec.configure do |config|
-  # use the before hook to add an after hook that runs last
   config.after do |example_from_block_arg|
-
     # RSpec 3 no longer defines `example`, but passes the example as block argument instead
     example = config.respond_to?(:expose_current_running_example_as) ? example_from_block_arg : self.example
 
-    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)
-
-        saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
-        saver.save
+    Capybara::Screenshot::RSpec.after_failed_example(example)
+  end
 
-        if Capybara::Screenshot.append_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
+  config.before(:suite) do
+    if Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples
+      RSpec.configuration.formatters.each do |formatter|
+        next unless (reporter_module = Capybara::Screenshot::RSpec::REPORTERS[formatter.class.to_s])
+        formatter.singleton_class.send :include, reporter_module
       end
     end
   end

data/lib/capybara-screenshot/rspec/base_reporter.rb

@@ -0,0 +1,21 @@
+module Capybara
+  module Screenshot
+    module RSpec
+      module BaseReporter
+
+        # Automatically set up method aliases (very much like ActiveSupport's `alias_method_chain`) 
+        # when the module gets included.
+        def enhance_with_screenshot(method)
+          with_method, without_method = "#{method}_with_screenshot", "#{method}_without_screenshot"
+          define_singleton_method :included do |mod|
+            if mod.method_defined?(method) || mod.private_method_defined?(method)
+              mod.send :alias_method, without_method, method
+              mod.send :alias_method, method, with_method
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/rspec/html_embed_reporter.rb

@@ -0,0 +1,25 @@
+require 'capybara-screenshot/rspec/base_reporter'
+require 'base64'
+
+module Capybara
+  module Screenshot
+    module RSpec
+      module HtmlEmbedReporter
+        extend BaseReporter
+        enhance_with_screenshot :extra_failure_content
+
+        def extra_failure_content_with_screenshot(exception)
+          result  = extra_failure_content_without_screenshot(exception)
+          example = @failed_examples.last
+          # Ignores saved html file, only saved image will be embedded (if present)
+          if (screenshot = example.metadata[:screenshot]) && screenshot[:image]
+            image = File.binread(screenshot[:image])
+            encoded_img = Base64.encode64(image)
+            result += "<img src='data:image/png;base64,#{encoded_img}' style='display: block'>"
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/rspec/html_link_reporter.rb

@@ -0,0 +1,37 @@
+require 'capybara-screenshot/rspec/base_reporter'
+require 'cgi'
+require 'uri'
+
+module Capybara
+  module Screenshot
+    module RSpec
+      module HtmlLinkReporter
+        extend BaseReporter
+        enhance_with_screenshot :extra_failure_content
+
+        def extra_failure_content_with_screenshot(exception)
+          result  = extra_failure_content_without_screenshot(exception)
+          example = @failed_examples.last
+          if (screenshot = example.metadata[:screenshot])
+            result << "<p>Saved files: "
+            result << link_to_screenshot("HTML page",  screenshot[:html]) if screenshot[:html]
+            result << link_to_screenshot("Screenshot", screenshot[:image]) if screenshot[:image]
+            result << "</p>"
+          end
+          result
+        end
+
+        def link_to_screenshot(title, path)
+          url = URI.escape("file://#{path}")
+          title = CGI.escape_html(title)
+          attributes = attributes_for_screenshot_link(url).map { |name, val| %{#{name}="#{CGI.escape_html(val)}"} }.join(" ")
+          "<a #{attributes}>#{title}</a>"
+        end
+
+        def attributes_for_screenshot_link(url)
+          {"href" => url, "style" => "margin-right: 10px; font-weight: bold"}
+        end
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/rspec/text_reporter.rb

@@ -0,0 +1,21 @@
+require 'capybara-screenshot/rspec/base_reporter'
+
+module Capybara
+  module Screenshot
+    module RSpec
+      module TextReporter
+        extend BaseReporter
+        enhance_with_screenshot :dump_failure_info
+
+        def dump_failure_info_with_screenshot(example)
+          dump_failure_info_without_screenshot(example)
+          return unless (screenshot = example.metadata[:screenshot])
+
+          colorize = lambda { |str| respond_to?(:failure_color, true) ? failure_color(str) : red(str) }
+          output.puts(long_padding + colorize["HTML page: #{screenshot[:html]}"]) if screenshot[:html]
+          output.puts(long_padding + colorize["Screenshot: #{screenshot[:image]}"]) if screenshot[:image]
+        end
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/rspec/textmate_link_reporter.rb

@@ -0,0 +1,19 @@
+require 'capybara-screenshot/rspec/base_reporter'
+require 'capybara-screenshot/rspec/html_link_reporter'
+require 'shellwords'
+
+module Capybara
+  module Screenshot
+    module RSpec
+      module TextMateLinkReporter
+        extend BaseReporter
+        include HtmlLinkReporter
+        enhance_with_screenshot :extra_failure_content
+
+        def attributes_for_screenshot_link(url)
+          super.merge("onclick" => "TextMate.system('open #{Shellwords.escape(url)}'); return false;")
+        end
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = "0.3.19"
+    VERSION = "0.3.20"
   end
 end

data/spec/capybara-screenshot/saver_spec.rb

@@ -166,12 +166,22 @@ describe Capybara::Screenshot::Saver do
     end
 
     context 'has save_screenshot method' do
+      let(:webkit_options){ {width: 800, height: 600} }
+
       before do
         driver_mock.stub(:respond_to?).with(:'save_screenshot').and_return(true)
       end
 
       it 'should save driver render' do
-        driver_mock.should_receive(:save_screenshot).with(screenshot_path)
+        driver_mock.should_receive(:save_screenshot).with(screenshot_path, {})
+
+        saver.save
+        saver.screenshot_saved?.should be_true
+      end
+
+      it 'should pass webkit_options to driver' do
+        Capybara::Screenshot.stub(:webkit_options).and_return( webkit_options )
+        driver_mock.should_receive(:save_screenshot).with(screenshot_path, webkit_options)
 
         saver.save
         saver.screenshot_saved?.should be_true

data/spec/capybara-screenshot_spec.rb

@@ -40,4 +40,21 @@ describe Capybara::Screenshot do
       Capybara::Screenshot.filename_prefix_for(:foo, double('test')).should eq 'screenshot'
     end
   end
+
+  describe '.append_screenshot_path' do
+    it 'prints a deprecation message and delegates to RSpec.add_link_to_screenshot_for_failed_examples' do
+      begin
+        original_stderr = $stderr
+        $stderr = StringIO.new
+        expect {
+          Capybara::Screenshot.append_screenshot_path = false
+        }.to change {
+          Capybara::Screenshot::RSpec.add_link_to_screenshot_for_failed_examples
+        }.from(true).to(false)
+        $stderr.string.should include("append_screenshot_path is deprecated")
+      ensure
+        $stderr = original_stderr
+      end
+    end
+  end
 end

data/spec/rspec/base_reporter_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot::RSpec::BaseReporter do
+  describe '#enhance_with_screenshot' do
+    it 'makes the original method available under an alias and replaces it with the enhanced method' do
+      reporter_module = Module.new do
+        extend Capybara::Screenshot::RSpec::BaseReporter
+        enhance_with_screenshot :foo
+        def foo_with_screenshot
+          [foo_without_screenshot, :enhanced]
+        end
+      end
+
+      klass = Class.new do
+        def foo
+          :original
+        end
+      end
+
+      klass.new.foo.should == :original
+      klass.send :include, reporter_module
+      klass.new.foo.should == [:original, :enhanced]
+    end
+  end
+end

data/spec/rspec/html_embed_reporter_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot::RSpec::HtmlEmbedReporter do
+  include_context 'html reporter'
+
+  context 'when an image was saved' do
+    before do
+      set_example double("example", metadata: {screenshot: {image: "path/to/image"}})
+    end
+
+    it 'embeds the image base64 encoded into the content' do
+      File.should_receive(:binread).with("path/to/image").and_return("image data")
+      encoded_image_data = Base64.encode64('image data')
+      content_without_styles = @reporter.extra_failure_content(nil).gsub(/ ?style='.*?' ?/, "")
+      content_without_styles.should == "original content<img src='data:image/png;base64,#{encoded_image_data}'>"
+    end
+  end
+end

data/spec/rspec/html_link_reporter_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot::RSpec::HtmlLinkReporter do
+  include_context 'html reporter'
+
+  context 'when a html file was saved' do
+    before do
+      set_example double("example", metadata: {screenshot: {html: "path/to/a html file"}})
+    end
+
+    it 'appends a link to the html to the original content' do
+      content_without_styles = @reporter.extra_failure_content(nil).gsub(/ ?style=".*?" ?/, "")
+      content_without_styles.should == %{original content<p>Saved files: <a href="file://path/to/a%20html%20file">HTML page</a></p>}
+    end
+  end
+
+  context 'when a html file and an image were saved' do
+    before do
+      set_example double("example", metadata: {screenshot: {html: "path/to/html", image: "path/to/an image"}})
+    end
+
+    it 'appends links to both files to the original content' do
+      content_without_styles = @reporter.extra_failure_content(nil).gsub(/ ?style=".*?" ?/, "")
+      content_without_styles.should == %{original content<p>Saved files: <a href="file://path/to/html">HTML page</a><a href="file://path/to/an%20image">Screenshot</a></p>}
+    end
+  end
+end

data/spec/rspec/text_reporter_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot::RSpec::TextReporter do
+  before do
+    # Mocking `RSpec::Core::Formatters::ProgressFormatter`, but only implementing the methods that
+    # are actually used in `TextReporter#dump_failure_info_with_screenshot`.
+    @reporter_class = Class.new do
+      attr_reader :output
+
+      def initialize
+        @output = StringIO.new
+      end
+
+      protected
+
+      def long_padding
+        "  "
+      end
+
+      def failure_color(str)
+        "colorized(#{str})"
+      end
+
+      private
+
+      def dump_failure_info(example)
+        output.puts "original failure info"
+      end
+    end
+
+    @reporter = @reporter_class.new
+    @reporter.singleton_class.send :include, described_class
+  end
+
+  context 'when there is no screenshot' do
+    let(:example) { double("example", metadata: {}) }
+
+    it 'doesnt change the original output of the reporter' do
+      @reporter.dump_failure_info(example)
+      @reporter.output.string.should == "original failure info\n"
+    end
+  end
+
+  context 'when a html file was saved' do
+    let(:example) { double("example", metadata: {screenshot: {html: "path/to/html"}}) }
+
+    it 'appends the html file path to the original output' do
+      @reporter.dump_failure_info(example)
+      @reporter.output.string.should == "original failure info\n  colorized(HTML page: path/to/html)\n"
+    end
+  end
+
+  context 'when a html file and an image were saved' do
+    let(:example) { double("example", metadata: {screenshot: {html: "path/to/html", image: "path/to/image"}}) }
+
+    it 'appends the image path to the original output' do
+      @reporter.dump_failure_info(example)
+      @reporter.output.string.should == "original failure info\n  colorized(HTML page: path/to/html)\n  colorized(Screenshot: path/to/image)\n"
+    end
+  end
+
+
+  it 'works with older RSpec formatters where `#red` is used instead of `#failure_color`' do
+    old_reporter_class = Class.new(@reporter_class) do
+      undef_method :failure_color
+      def red(str)
+        "red(#{str})"
+      end
+    end
+    old_reporter = old_reporter_class.new
+    old_reporter.singleton_class.send :include, described_class
+    example = double("example", metadata: {screenshot: {html: "path/to/html"}})
+    old_reporter.dump_failure_info(example)
+    old_reporter.output.string.should == "original failure info\n  red(HTML page: path/to/html)\n"
+  end
+end

data/spec/rspec/textmate_link_reporter_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot::RSpec::TextMateLinkReporter do
+  include_context 'html reporter'
+
+  context 'when a html file was saved' do
+    before do
+      set_example double("example", metadata: {screenshot: {html: "path/to/a html file"}})
+    end
+
+    it 'appends a link to the html to the original content' do
+      content_without_styles = @reporter.extra_failure_content(nil).gsub(/ ?style=".*?"/, "")
+      # Single quotes are handled differently by CGI.escape_html in Ruby 1.9 / Ruby 2, so to be
+      # compatible with both versions we can't hard code the final escaped string.
+      expected_onclick_handler = CGI.escape_html("TextMate.system('open file://path/to/a\\%20html\\%20file'); return false;")
+      content_without_styles.should == %{original content<p>} +
+        %{Saved files: <a href="file://path/to/a%20html%20file" onclick="#{expected_onclick_handler}">HTML page</a></p>}
+    end
+  end
+
+  context 'when a html file and an image were saved' do
+    before do
+      set_example double("example", metadata: {screenshot: {html: "path/to/html", image: "path/to/an image"}})
+    end
+
+    it 'appends links to both files to the original content' do
+      content_without_styles = @reporter.extra_failure_content(nil).gsub(/ ?style=".*?"/, "")
+      # Single quotes are handled differently by CGI.escape_html in Ruby 1.9 / Ruby 2, so to be
+      # compatible with both versions we can't hard code the final escaped string.
+      expected_onclick_handler_1 = CGI.escape_html("TextMate.system('open file://path/to/html'); return false;")
+      expected_onclick_handler_2 = CGI.escape_html("TextMate.system('open file://path/to/an\\%20image'); return false;")
+      content_without_styles.should == %{original content<p>} +
+        %{Saved files: <a href="file://path/to/html" onclick="#{expected_onclick_handler_1}">HTML page</a>} +
+        %{<a href="file://path/to/an%20image" onclick="#{expected_onclick_handler_2}">Screenshot</a></p>}
+    end
+  end
+end

data/spec/rspec_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot::RSpec do
+  describe '.after_failed_example' do
+    context 'for a failed example in a feature that can be snapshotted' do
+      before do
+        Capybara.page.stub(save_page: nil, current_url: "http://test.local")
+        Capybara::Screenshot::Saver.stub(new: mock_saver)
+      end
+      let(:example) { double("example", exception: Exception.new, metadata: {}) }
+      let(:mock_saver) { Capybara::Screenshot::Saver.new(Capybara, Capybara.page).tap { |saver| saver.stub(:save) } }
+
+      it 'instantiates a saver and calls `save` on it' do
+        mock_saver.should_receive(:save)
+        described_class.after_failed_example(example)
+      end
+
+      it 'extends the metadata with an empty hash for screenshot metadata' do
+        described_class.after_failed_example(example)
+        example.metadata.should have_key(:screenshot)
+        example.metadata[:screenshot].should == {}
+      end
+
+      context 'when a html file gets saved' do
+        before { mock_saver.stub(:html_saved? => true) }
+
+        it 'adds the html file path to the screenshot metadata' do
+          described_class.after_failed_example(example)
+          example.metadata[:screenshot][:html].should start_with("./screenshot")
+        end
+      end
+
+      context 'when an image gets saved' do
+        before { mock_saver.stub(:screenshot_saved? => true) }
+
+        it 'adds the image path to the screenshot metadata' do
+          described_class.after_failed_example(example)
+          example.metadata[:screenshot][:image].should start_with("./screenshot")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -10,6 +10,8 @@ require 'capybara-screenshot'
 require 'capybara-screenshot/rspec'
 require 'timecop'
 
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

data/spec/support/html_reporter_context.rb

@@ -0,0 +1,28 @@
+shared_context 'html reporter' do
+  def set_example(example)
+    @reporter.instance_variable_set :@failed_examples, [example]
+  end
+
+  before do
+    # Mocking `RSpec::Core::Formatters::HtmlFormatter`, but only implementing the things that
+    # are actually used in `HtmlLinkReporter#extra_failure_content_with_screenshot`.
+    @reporter_class = Class.new do
+      def extra_failure_content(exception)
+        "original content"
+      end
+    end
+
+    @reporter = @reporter_class.new
+    @reporter.singleton_class.send :include, described_class
+  end
+
+  context 'when there is no screenshot' do
+    before do
+      set_example double("example", metadata: {})
+    end
+
+    it 'doesnt change the original content of the reporter' do
+      @reporter.extra_failure_content(nil).should == "original content"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: 0.3.19
+  version: 0.3.20
 platform: ruby
 authors:
 - Matthew O'Riordan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-02 00:00:00.000000000 Z
+date: 2014-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -94,6 +94,11 @@ files:
 - lib/capybara-screenshot/cucumber.rb
 - lib/capybara-screenshot/minitest.rb
 - lib/capybara-screenshot/rspec.rb
+- lib/capybara-screenshot/rspec/base_reporter.rb
+- lib/capybara-screenshot/rspec/html_embed_reporter.rb
+- lib/capybara-screenshot/rspec/html_link_reporter.rb
+- lib/capybara-screenshot/rspec/text_reporter.rb
+- lib/capybara-screenshot/rspec/textmate_link_reporter.rb
 - lib/capybara-screenshot/saver.rb
 - lib/capybara-screenshot/spinach.rb
 - lib/capybara-screenshot/testunit.rb
@@ -101,7 +106,14 @@ files:
 - spec/capybara-screenshot/capybara_spec.rb
 - spec/capybara-screenshot/saver_spec.rb
 - spec/capybara-screenshot_spec.rb
+- spec/rspec/base_reporter_spec.rb
+- spec/rspec/html_embed_reporter_spec.rb
+- spec/rspec/html_link_reporter_spec.rb
+- spec/rspec/text_reporter_spec.rb
+- spec/rspec/textmate_link_reporter_spec.rb
+- spec/rspec_spec.rb
 - spec/spec_helper.rb
+- spec/support/html_reporter_context.rb
 homepage: http://github.com/mattheworiordan/capybara-screenshot
 licenses:
 - MIT
@@ -131,4 +143,11 @@ test_files:
 - spec/capybara-screenshot/capybara_spec.rb
 - spec/capybara-screenshot/saver_spec.rb
 - spec/capybara-screenshot_spec.rb
+- spec/rspec/base_reporter_spec.rb
+- spec/rspec/html_embed_reporter_spec.rb
+- spec/rspec/html_link_reporter_spec.rb
+- spec/rspec/text_reporter_spec.rb
+- spec/rspec/textmate_link_reporter_spec.rb
+- spec/rspec_spec.rb
 - spec/spec_helper.rb
+- spec/support/html_reporter_context.rb