capybara-screenshot 1.0.2 → 1.0.3

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+1 October 2014 - 1.0.2 -> 1.0.3
+-----------
+
+* Added ability to prune screenshots automatically, see https://github.com/mattheworiordan/capybara-screenshot/pull/100
+
+Thanks to [Anton Kolomiychuk](https://github.com/akolomiychuk) for his contribution.
+
 27 September 2014 - 1.0.1 -> 1.0.2
 -----------
 

data/README.md

@@ -162,6 +162,19 @@ Capybara.save_and_open_page_path = "/file/path"
 ```
 
 
+Pruning old screenshots automatically
+--------------------------
+By default screenshots are saved indefinitely into `$APPLICATION_ROOT/tmp/capybara`.  If you want screenshots to be automatically pruned on a new failure, then you can specify one of the following prune strategies as follows:
+
+```ruby
+# Keep only the screenshots generated from the last failing test suite
+Capybara::ScreenShot.prune_strategy = :keep_last_run
+
+# Keep up to the number of screenshots specified in the hash
+Capybara::ScreenShot.prune_strategy = { keep: 20 }
+```
+
+
 Information about screenshots in RSpec output
 ---------------------------------------------
 

data/lib/capybara-screenshot.rb

@@ -7,6 +7,7 @@ module Capybara
       attr_accessor :append_timestamp
       attr_accessor :webkit_options
       attr_writer   :final_session_name
+      attr_accessor :prune_strategy
     end
 
     self.autosave_on_failure = true
@@ -14,6 +15,7 @@ module Capybara
     self.filename_prefix_formatters = {}
     self.append_timestamp = true
     self.webkit_options = {}
+    self.prune_strategy = :keep_all
 
     def self.append_screenshot_path=(value)
       $stderr.puts "WARNING: Capybara::Screenshot.append_screenshot_path is deprecated. " +
@@ -74,6 +76,19 @@ module Capybara
     def self.final_session_name
       @final_session_name || Capybara.session_name || :default
     end
+
+    # Prune screenshots based on prune_strategy
+    # Will run only once unless force:true
+    def self.prune(options = {})
+      reset_prune_history if options[:force]
+      Capybara::Screenshot::Pruner.new(Capybara::Screenshot.prune_strategy).prune_old_screenshots unless @pruned_previous_screenshots
+      @pruned_previous_screenshots = true
+    end
+
+    # Reset prune history allowing further prunining on next failure
+    def self.reset_prune_history
+      @pruned_previous_screenshots = nil
+    end
   end
 end
 
@@ -133,5 +148,4 @@ require 'capybara/util/save_and_open_page' if Capybara::VERSION.match(/^\d+/)[0]
 
 require 'capybara-screenshot/saver'
 require 'capybara-screenshot/capybara'
-
-
+require 'capybara-screenshot/pruner'

data/lib/capybara-screenshot/minitest.rb

@@ -8,14 +8,15 @@ module Capybara::Screenshot::MiniTestPlugin
 
   def after_teardown
     super
-    if self.class.ancestors.map(&:to_s).include?('ActionDispatch::IntegrationTest') &&
-      Capybara::Screenshot.autosave_on_failure && !passed?
-      Capybara.using_session(Capybara::Screenshot.final_session_name) do
-        filename_prefix = Capybara::Screenshot.filename_prefix_for(:minitest, self)
+    if self.class.ancestors.map(&:to_s).include?('ActionDispatch::IntegrationTest')
+      if Capybara::Screenshot.autosave_on_failure && !passed?
+        Capybara.using_session(Capybara::Screenshot.final_session_name) do
+          filename_prefix = Capybara::Screenshot.filename_prefix_for(:minitest, self)
 
-        saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
-        saver.save
-        saver.output_screenshot_path
+          saver = Capybara::Screenshot::Saver.new(Capybara, Capybara.page, true, filename_prefix)
+          saver.save
+          saver.output_screenshot_path
+        end
       end
     end
   end

data/lib/capybara-screenshot/pruner.rb

@@ -0,0 +1,47 @@
+module Capybara
+  module Screenshot
+    class Pruner
+      attr_reader :strategy
+
+      def initialize(strategy)
+        @strategy = strategy
+
+        @strategy_proc = case strategy
+        when :keep_all
+          -> { }
+        when :keep_last_run
+          -> { prune_with_last_run_strategy }
+        when Hash
+          raise ArgumentError, ":keep key is required" unless strategy[:keep]
+          raise ArgumentError, ":keep value must be number greater than zero" unless strategy[:keep].to_i > 0
+          -> { prune_with_numeric_strategy(strategy[:keep].to_i) }
+        else
+          fail "Invalid prune strategy #{strategy}. `:keep_all`or `{ keep: 10 }` are valid examples."
+        end
+      end
+
+      def prune_old_screenshots
+        strategy_proc.call
+      end
+
+      private
+      attr_reader :strategy_proc
+
+      def wildcard_path
+        File.expand_path('*', Screenshot.capybara_root)
+      end
+
+      def prune_with_last_run_strategy
+        FileUtils.rm_rf(Dir.glob(wildcard_path))
+      end
+
+      def prune_with_numeric_strategy(count)
+        files = Dir.glob(wildcard_path).sort_by do |file_name|
+          File.mtime(File.expand_path(file_name, Screenshot.capybara_root))
+        end
+
+        FileUtils.rm_rf(files[0...-count])
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/saver.rb

@@ -11,13 +11,14 @@ module Capybara
   module Screenshot
     class Saver
       attr_reader :capybara, :page, :file_base_name
-
       def initialize(capybara, page, html_save=true, filename_prefix='screenshot')
         @capybara, @page, @html_save = capybara, page, html_save
         time_now = Time.now
         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
+
+        Capybara::Screenshot.prune
       end
 
       def save

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

data/spec/cucumber/cucumber_spec.rb

@@ -1,14 +1,20 @@
 require "spec_helper"
 
 describe "Using Capybara::Screenshot with Cucumber" do
-  include Aruba::Api
   include CommonSetup
 
   before do
     clean_current_dir
   end
 
+  let(:cmd) { 'bundle exec cucumber' }
+
   def run_failing_case(failure_message, code)
+    run_case code
+    expect(output_from(cmd)).to match(failure_message)
+  end
+
+  def run_case(code, options = {})
     write_file('features/support/env.rb', <<-RUBY)
       #{ensure_load_paths_valid}
       require 'cucumber/support/env.rb'
@@ -23,38 +29,65 @@ describe "Using Capybara::Screenshot with Cucumber" do
     RUBY
 
     write_file('features/cucumber.feature', code)
-    cmd = 'bundle exec cucumber'
+
     run_simple_with_retry cmd, false
-    expect(output_from(cmd)).to match failure_message
+
+    expect(output_from(cmd)).to_not include('failed)') if options[:assert_all_passed]
   end
 
-  it "saves a screenshot on failure" do
-    run_failing_case(%q{Unable to find link or button "you'll never find me"}, <<-CUCUMBER)
+  it 'saves a screenshot on failure' do
+    run_failing_case %q{Unable to find link or button "you'll never find me"}, <<-CUCUMBER
       Feature: Failure
         Scenario: Failure
           Given I visit "/"
           And I click on a missing link
     CUCUMBER
-    check_file_content('tmp/my_screenshot.html', 'This is the root page', true)
+    check_file_content 'tmp/my_screenshot.html', 'This is the root page', true
   end
 
-  it "saves a screenshot on an error" do
-    run_failing_case(%q{you can't handle me}, <<-CUCUMBER)
+  it 'saves a screenshot on an error' do
+    run_failing_case %q{you can't handle me}, <<-CUCUMBER
       Feature: Failure
         Scenario: Failure
           Given I visit "/"
           And I trigger an unhandled exception
     CUCUMBER
-    check_file_content('tmp/my_screenshot.html', 'This is the root page', true)
+    check_file_content 'tmp/my_screenshot.html', 'This is the root page', true
   end
 
-  it "saves a screenshot for the correct session for failures using_session" do
+  it 'saves a screenshot for the correct session for failures using_session' do
     run_failing_case(%q{Unable to find link or button "you'll never find me"}, <<-CUCUMBER)
       Feature: Failure
         Scenario: Failure in different session
           Given I visit "/"
           And I click on a missing link on a different page in a different session
     CUCUMBER
-    check_file_content('tmp/my_screenshot.html', 'This is a different page', true)
+    check_file_content 'tmp/my_screenshot.html', 'This is a different page', true
+  end
+
+  context 'pruning' do
+    before do
+      create_screenshot_for_pruning
+      configure_prune_strategy :last_run
+    end
+
+    it 'on failure it prunes previous screenshots when strategy is set' do
+      run_failing_case %q{Unable to find link or button "you'll never find me"}, <<-CUCUMBER
+        Feature: Prune
+          Scenario: Screenshots are pruned if strategy is set
+            Given I visit "/"
+            And I click on a missing link
+      CUCUMBER
+      assert_screenshot_pruned
+    end
+
+    it 'on success it never prunes' do
+      run_case <<-CUCUMBER, assert_all_passed: true
+        Feature: Prune
+          Scenario: Screenshots are pruned if strategy is set
+            Given I visit "/"
+      CUCUMBER
+      assert_screenshot_not_pruned
+    end
   end
 end

data/spec/feature/minitest_spec.rb

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe "Using Capybara::Screenshot with MiniTest" do
-  include Aruba::Api
   include CommonSetup
 
   before do
@@ -31,7 +30,7 @@ describe "Using Capybara::Screenshot with MiniTest" do
     expect(output_from(cmd)).to include %q{Unable to find link or button "you'll never find me"}
   end
 
-  it "saves a screenshot on failure" do
+  it 'saves a screenshot on failure' do
     run_failing_case <<-RUBY
       module ActionDispatch
         class IntegrationTest < Minitest::Unit::TestCase; end
@@ -47,7 +46,7 @@ describe "Using Capybara::Screenshot with MiniTest" do
         end
       end
     RUBY
-    check_file_content('tmp/my_screenshot.html', 'This is the root page', true)
+    check_file_content 'tmp/my_screenshot.html', 'This is the root page', true
   end
 
   it "does not save a screenshot for tests that don't inherit from ActionDispatch::IntegrationTest" do
@@ -65,7 +64,7 @@ describe "Using Capybara::Screenshot with MiniTest" do
     check_file_presence(%w{tmp/my_screenshot.html}, false)
   end
 
-  it "saves a screenshot for the correct session for failures using_session" do
+  it 'saves a screenshot for the correct session for failures using_session' do
     run_failing_case <<-RUBY
       module ActionDispatch
         class IntegrationTest < Minitest::Unit::TestCase; end
@@ -85,6 +84,27 @@ describe "Using Capybara::Screenshot with MiniTest" do
         end
       end
     RUBY
-    check_file_content('tmp/my_screenshot.html', 'This is a different page', true)
+    check_file_content 'tmp/my_screenshot.html', 'This is a different page', true
+  end
+
+  it 'prunes screenshots on failure' do
+    create_screenshot_for_pruning
+    configure_prune_strategy :last_run
+    run_failing_case <<-RUBY
+      module ActionDispatch
+        class IntegrationTest < Minitest::Unit::TestCase; end
+      end
+
+      class TestFailure < ActionDispatch::IntegrationTest
+        include Capybara::DSL
+
+        def test_failure
+          visit '/'
+          assert(page.body.include?('This is the root page'))
+          click_on "you'll never find me"
+        end
+      end
+    RUBY
+    assert_screenshot_pruned
   end
 end

data/spec/feature/testunit_spec.rb

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe "Using Capybara::Screenshot with Test::Unit" do
-  include Aruba::Api
   include CommonSetup
 
   before do
@@ -38,16 +37,16 @@ describe "Using Capybara::Screenshot with Test::Unit" do
   end
 
   it "saves a screenshot on failure for any test in path 'test/integration'" do
-    run_failing_case(<<-RUBY, 'test/integration')
+    run_failing_case <<-RUBY, 'test/integration'
       visit '/'
       assert(page.body.include?('This is the root page'))
       click_on "you'll never find me"
     RUBY
-    check_file_content('tmp/my_screenshot.html', 'This is the root page', true)
+    check_file_content 'tmp/my_screenshot.html', 'This is the root page', true
   end
 
   it "does not generate a screenshot for tests that are not in 'test/integration'" do
-    run_failing_case(<<-RUBY, 'test/something-else')
+    run_failing_case <<-RUBY, 'test/something-else'
       visit '/'
       assert(page.body.include?('This is the root page'))
       click_on "you'll never find me"
@@ -56,8 +55,8 @@ describe "Using Capybara::Screenshot with Test::Unit" do
     check_file_presence(%w{tmp/my_screenshot.html}, false)
   end
 
-  it "saves a screenshot for the correct session for failures using_session" do
-    run_failing_case(<<-RUBY, 'test/integration')
+  it 'saves a screenshot for the correct session for failures using_session' do
+    run_failing_case <<-RUBY, 'test/integration'
       visit '/'
       assert(page.body.include?('This is the root page'))
       using_session :different_session do
@@ -66,6 +65,17 @@ describe "Using Capybara::Screenshot with Test::Unit" do
         click_on "you'll never find me"
       end
     RUBY
-    check_file_content('tmp/my_screenshot.html', 'This is a different page', true)
+    check_file_content 'tmp/my_screenshot.html', 'This is a different page', true
+  end
+
+  it 'prunes screenshots on failure' do
+    create_screenshot_for_pruning
+    configure_prune_strategy :last_run
+    run_failing_case <<-RUBY, 'test/integration'
+      visit '/'
+      assert(page.body.include?('This is the root page'))
+      click_on "you'll never find me"
+    RUBY
+    assert_screenshot_pruned
   end
 end

data/spec/rspec/rspec_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 
 describe Capybara::Screenshot::RSpec do
   describe "used with RSpec" do
-    include Aruba::Api
     include CommonSetup
 
     before do
@@ -10,6 +9,17 @@ describe Capybara::Screenshot::RSpec do
     end
 
     def run_failing_case(code, error_message, format=nil)
+      run_case code, format: format
+
+      cmd = cmd_with_format(format)
+      if error_message.kind_of?(Regexp)
+        expect(output_from(cmd)).to match(error_message)
+      else
+        expect(output_from(cmd)).to include(error_message)
+      end
+    end
+
+    def run_case(code, options = {})
       write_file('spec/test_failure.rb', <<-RUBY)
         #{ensure_load_paths_valid}
         require 'rspec'
@@ -22,17 +32,17 @@ describe Capybara::Screenshot::RSpec do
         #{code}
       RUBY
 
-      cmd = "bundle exec rspec #{"--format #{format} " if format}spec/test_failure.rb"
+      cmd = cmd_with_format(options[:format])
       run_simple_with_retry cmd, false
 
-      if error_message.kind_of?(Regexp)
-        expect(output_from(cmd)).to match(error_message)
-      else
-        expect(output_from(cmd)).to include(error_message)
-      end
+      expect(output_from(cmd)).to include('0 failures') if options[:assert_all_passed]
+    end
+
+    def cmd_with_format(format)
+      "bundle exec rspec #{"--format #{format} " if format}spec/test_failure.rb"
     end
 
-    it "saves a screenshot on failure" do
+    it 'saves a screenshot on failure' do
       run_failing_case <<-RUBY, %q{Unable to find link or button "you'll never find me"}
         feature 'screenshot with failure' do
           scenario 'click on a missing link' do
@@ -46,8 +56,8 @@ describe Capybara::Screenshot::RSpec do
     end
 
     formatters = {
-      progress:      "HTML screenshot:",
-      documentation: "HTML screenshot:",
+      progress:      'HTML screenshot:',
+      documentation: 'HTML screenshot:',
       html:          %r{<a href="file://\./tmp/screenshot\.html"[^>]*>HTML page</a>}
     }
 
@@ -81,7 +91,7 @@ describe Capybara::Screenshot::RSpec do
       check_file_presence(%w{tmp/screenshot.html}, false)
     end
 
-    it "saves a screenshot for the correct session for failures using_session" do
+    it 'saves a screenshot for the correct session for failures using_session' do
       run_failing_case <<-RUBY, %q{Unable to find link or button "you'll never find me"}
         feature 'screenshot with failure' do
           scenario 'click on a missing link' do
@@ -97,5 +107,53 @@ describe Capybara::Screenshot::RSpec do
       RUBY
       check_file_content('tmp/screenshot.html', 'This is a different page', true)
     end
+
+    context 'pruning' do
+      before do
+        create_screenshot_for_pruning
+        configure_prune_strategy :last_run
+      end
+
+      it 'on failure it prunes previous screenshots when strategy is set' do
+        run_failing_case <<-RUBY, 'HTML screenshot:', :progress
+          feature 'screenshot with failure' do
+            scenario 'click on a missing link' do
+              visit '/'
+              click_on "you'll never find me"
+            end
+          end
+        RUBY
+        assert_screenshot_pruned
+      end
+
+      it 'on success it never prunes' do
+        run_case <<-CUCUMBER, assert_all_passed: true
+          feature 'screenshot without failure' do
+            scenario 'click on a link' do
+              visit '/'
+            end
+          end
+        CUCUMBER
+        assert_screenshot_not_pruned
+      end
+    end
+
+    context 'no pruning by default' do
+      before do
+        create_screenshot_for_pruning
+      end
+
+      it 'on failure it leaves existing screenshots' do
+        run_failing_case <<-RUBY, 'HTML screenshot:', :progress
+          feature 'screenshot with failure' do
+            scenario 'click on a missing link' do
+              visit '/'
+              click_on "you'll never find me"
+            end
+          end
+        RUBY
+        assert_screenshot_not_pruned
+      end
+    end
   end
 end

data/spec/spinach/spinach_spec.rb

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe "Using Capybara::Screenshot with Spinach" do
-  include Aruba::Api
   include CommonSetup
 
   before do
@@ -50,4 +49,16 @@ describe "Using Capybara::Screenshot with Spinach" do
     GHERKIN
     check_file_content('tmp/my_screenshot.html', 'This is a different page', true)
   end
+
+  it 'on failure it prunes previous screenshots when strategy is set' do
+    create_screenshot_for_pruning
+    configure_prune_strategy :last_run
+    run_failing_case(%q{Unable to find link or button "you'll never find me"}, <<-GHERKIN)
+      Feature: Failure
+        Scenario: Failure
+          Given I visit "/"
+          And I click on a missing link
+    GHERKIN
+    assert_screenshot_pruned
+  end
 end

data/spec/support/common_setup.rb

@@ -1,5 +1,9 @@
 module CommonSetup
   def self.included(target)
+    target.class_eval do
+      include Aruba::Api
+    end
+
     target.let(:gem_root) { File.expand_path('../..', File.dirname(__FILE__)) }
 
     target.let(:ensure_load_paths_valid) do
@@ -10,12 +14,16 @@ module CommonSetup
       RUBY
     end
 
+    target.let(:screenshot_path) { 'tmp' }
+    target.let(:screenshot_for_pruning_path) { "#{screenshot_path}/old_screenshot.html" }
+
     target.let(:setup_test_app) do
       <<-RUBY
         require 'support/test_app'
-        Capybara.save_and_open_page_path = 'tmp'
+        Capybara.save_and_open_page_path = '#{screenshot_path}'
         Capybara.app = TestApp
         Capybara::Screenshot.append_timestamp = false
+        #{@additional_setup_steps}
       RUBY
     end
 
@@ -31,5 +39,21 @@ module CommonSetup
       puts "run_simple(#{args.join(', ')}) failed. Will retry once. `#{e.message}`"
       run_simple(*args)
     end
+
+    def configure_prune_strategy(strategy)
+       @additional_setup_steps = "Capybara::Screenshot.prune_strategy = :keep_last_run"
+    end
+
+    def create_screenshot_for_pruning
+      write_file screenshot_for_pruning_path, '<html></html>'
+    end
+
+    def assert_screenshot_pruned
+      check_file_presence Array(screenshot_for_pruning_path), false
+    end
+
+    def assert_screenshot_not_pruned
+      check_file_presence Array(screenshot_for_pruning_path), true
+    end
   end
 end

data/spec/unit/capybara-screenshot_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Capybara::Screenshot do
-  describe ".register_driver" do
+  describe '.register_driver' do
     before(:all) do
       @original_drivers = Capybara::Screenshot.registered_drivers.dup
     end
@@ -18,7 +18,7 @@ describe Capybara::Screenshot do
     end
   end
 
-  describe ".register_filename_prefix_formatter" do
+  describe '.register_filename_prefix_formatter' do
     before(:all) do
       @original_formatters = Capybara::Screenshot.filename_prefix_formatters.dup
     end
@@ -35,7 +35,7 @@ describe Capybara::Screenshot do
     end
   end
 
-  describe ".filename_prefix_for" do
+  describe '.filename_prefix_for' do
     it 'returns "screenshot" for undefined formatter' do
       expect(Capybara::Screenshot.filename_prefix_for(:foo, double('test'))).to eql('screenshot')
     end
@@ -57,4 +57,32 @@ describe Capybara::Screenshot do
       end
     end
   end
+
+  describe '#prune' do
+    before do
+      Capybara::Screenshot.reset_prune_history
+    end
+
+    it 'prunes once by default' do
+      expect(Capybara::Screenshot::Pruner).to receive(:new).and_call_original.once
+      3.times { Capybara::Screenshot.prune }
+    end
+
+    it 'prunes every time if option force: true' do
+      expect(Capybara::Screenshot::Pruner).to receive(:new).and_call_original.exactly(3).times
+      3.times { Capybara::Screenshot.prune(force: true) }
+    end
+
+    context 'prune strategy' do
+      let(:prune_strategy) { { keep: 100 } }
+      before do
+        Capybara::Screenshot.prune_strategy = prune_strategy
+      end
+
+      it 'is passed to initializer' do
+        expect(Capybara::Screenshot::Pruner).to receive(:new).with(prune_strategy).and_call_original
+        Capybara::Screenshot.prune
+      end
+    end
+  end
 end

data/spec/unit/pruner_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe Capybara::Screenshot::Pruner do
+  describe '#initialize' do
+    let(:pruner) { Capybara::Screenshot::Pruner.new(strategy) }
+
+    context 'accepts generic strategies:' do
+      [:keep_all, :keep_last_run].each do |strategy_sym|
+        let(:strategy) { strategy_sym }
+
+        it ":#{strategy_sym}" do
+          expect(pruner.strategy).to eq(strategy)
+        end
+      end
+    end
+
+    context 'keep:int' do
+      let(:strategy) { { keep: 50 } }
+
+      it 'is a suitable strategy' do
+        expect(pruner.strategy).to eq(strategy)
+      end
+    end
+
+    context 'invalid strategy' do
+      context 'symbol' do
+        let(:strategy) { :invalid_strategy }
+
+        it 'raises an error' do
+          expect { pruner }.to raise_error
+        end
+      end
+
+      context 'keep:sym' do
+        let(:strategy) { { keep: :symbol } }
+
+        it 'raises an error' do
+          expect { pruner }.to raise_error
+        end
+      end
+    end
+  end
+
+  describe '#prune_old_screenshots' do
+    let(:capybara_root)   { Capybara::Screenshot.capybara_root }
+    let(:remaining_files) { Dir.glob(File.expand_path('*', capybara_root)).sort }
+    let(:files_created)   { [] }
+    let(:files_count)     { 8 }
+    let(:pruner)         { Capybara::Screenshot::Pruner.new(strategy) }
+
+    before do
+      allow(Capybara::Screenshot).to receive(:capybara_root).and_return(Dir.mktmpdir.to_s)
+
+      files_count.times do |i|
+        files_created << FileUtils.touch("#{capybara_root}/#{i}").first.tap do |file_name|
+          File.utime(Time.now, Time.now - files_count + i, file_name)
+        end
+      end
+
+      pruner.prune_old_screenshots
+    end
+
+    after do
+      FileUtils.rm_rf capybara_root
+    end
+
+    context 'with :keep_all strategy' do
+      let(:strategy) { :keep_all }
+
+      it 'should not remove screens' do
+        expect(remaining_files).to eq(files_created)
+      end
+    end
+
+    context 'with :keep_last_run strategy' do
+      let(:strategy) { :keep_last_run }
+
+      it 'should remove all screens' do
+        expect(remaining_files).to be_empty
+      end
+
+      context 'when dir is missing' do
+        before { FileUtils.rm_rf(Capybara::Screenshot.capybara_root) }
+
+        it 'should not raise error' do
+          expect { pruner.prune_old_screenshots }.to_not raise_error
+        end
+      end
+    end
+
+    context 'with :keep strategy' do
+      let(:keep_count) { 3 }
+      let(:strategy) { { keep: keep_count } }
+
+      it 'should keep specified number of screens' do
+        expect(remaining_files).to eq(files_created.last(keep_count))
+      end
+
+      context 'when dir is missing' do
+        before { FileUtils.rm_rf(Capybara::Screenshot.capybara_root) }
+
+        it 'should not raise error when dir is missing' do
+          expect { pruner.prune_old_screenshots }.to_not raise_error
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,176 +1,200 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
+  prerelease: 
 platform: ruby
 authors:
 - Matthew O'Riordan
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-27 00:00:00.000000000 Z
+date: 2014-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.0'
     - - <
       - !ruby/object:Gem::Version
         version: '3'
-  name: capybara
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     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
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: launchy
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: colored
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: colored
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: rspec
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: timecop
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: cucumber
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: aruba
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: sinatra
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: test-unit
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: spinach
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: spinach
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: minitest
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: When a Cucumber step fails, it is useful to create a screenshot image and HTML file of the current page
+description: When a Cucumber step fails, it is useful to create a screenshot image
+  and HTML file of the current page
 email:
 - matthew.oriordan@gmail.com
 executables: []
@@ -199,6 +223,7 @@ files:
 - lib/capybara-screenshot/capybara.rb
 - lib/capybara-screenshot/cucumber.rb
 - lib/capybara-screenshot/minitest.rb
+- lib/capybara-screenshot/pruner.rb
 - lib/capybara-screenshot/rspec.rb
 - lib/capybara-screenshot/rspec/base_reporter.rb
 - lib/capybara-screenshot/rspec/html_embed_reporter.rb
@@ -225,6 +250,7 @@ files:
 - spec/unit/capybara-screenshot_rspec_spec.rb
 - spec/unit/capybara-screenshot_spec.rb
 - spec/unit/capybara_spec.rb
+- spec/unit/pruner_spec.rb
 - spec/unit/rspec_reporters/html_embed_reporter_spec.rb
 - spec/unit/rspec_reporters/html_link_reporter_spec.rb
 - spec/unit/rspec_reporters/text_reporter_spec.rb
@@ -233,27 +259,35 @@ files:
 homepage: http://github.com/mattheworiordan/capybara-screenshot
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 696952700666398309
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 696952700666398309
 requirements: []
 rubyforge_project: capybara-screenshot
-rubygems_version: 2.1.9
-signing_key:
-specification_version: 4
-summary: Automatically create snapshots when Cucumber steps fail with Capybara and Rails
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Automatically create snapshots when Cucumber steps fail with Capybara and
+  Rails
 test_files:
 - spec/cucumber/cucumber_spec.rb
 - spec/cucumber/step_definitions/step_definitions.rb
@@ -271,6 +305,7 @@ test_files:
 - spec/unit/capybara-screenshot_rspec_spec.rb
 - spec/unit/capybara-screenshot_spec.rb
 - spec/unit/capybara_spec.rb
+- spec/unit/pruner_spec.rb
 - spec/unit/rspec_reporters/html_embed_reporter_spec.rb
 - spec/unit/rspec_reporters/html_link_reporter_spec.rb
 - spec/unit/rspec_reporters/text_reporter_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: ea0f0f79b26cc47c17432e0d436e6c5c11fe1d01
-  data.tar.gz: cf7a0fdcf2f73c7dda324ab4f06eeacf0af4b4fd
-SHA512:
-  metadata.gz: 8c9b5f03a37755b78be62e9b5619e23200d6ee7017a7b21d2c33a75dc127632e431707e349572511aba2e900af51597674e47cdf1604312b1b7f6056fda3c600
-  data.tar.gz: d3c4e74a8b4c7c58a6770695ceb8d5d174253f82cafbb19408f127bda0d1bad9077e16d5cb838fe3bd8ca7a7192f2b27c722bc4258dc8a37b3e95a52ef7ba1e0