capybara-screenshot 1.0.13 → 1.0.26

data/spec/unit/saver_spec.rb

@@ -21,11 +21,14 @@ describe Capybara::Screenshot::Saver do
   let(:screenshot_path) { "#{capybara_root}/#{file_basename}.png" }
 
   let(:driver_mock) { double('Capybara driver').as_null_object }
-  let(:page_mock) { double('Capybara session page', :body => 'body', :driver => driver_mock).as_null_object }
+  let(:page_mock) {
+    double('Capybara session page', :body => 'body', :driver => driver_mock).as_null_object.tap do |m|
+      allow(m).to receive(:current_path).and_return('/')
+    end
+  }
   let(:capybara_mock) {
     double(Capybara).as_null_object.tap do |m|
       allow(m).to receive(:current_driver).and_return(:default)
-      allow(m).to receive(:current_path).and_return('/')
     end
   }
 
@@ -109,27 +112,93 @@ describe Capybara::Screenshot::Saver do
     expect(saver).to_not be_html_saved
   end
 
-  it 'does not save if current_path is empty' do
-    allow(capybara_mock).to receive(:current_path).and_return(nil)
-    expect(capybara_mock).to_not receive(:save_page)
-    expect(driver_mock).to_not receive(:render)
+  context 'the current_path is empty' do
+    before(:each) do
+      allow(page_mock).to receive(:current_path).and_return(nil)
+    end
 
-    saver.save
-    expect(saver).to_not be_screenshot_saved
-    expect(saver).to_not be_html_saved
+    it 'does not save' do
+      expect(capybara_mock).to_not receive(:save_page)
+      expect(driver_mock).to_not receive(:render)
+
+      saver.save
+      expect(saver).to_not be_screenshot_saved
+      expect(saver).to_not be_html_saved
+    end
+
+    it 'prints a warning' do
+      expect(saver).to receive(:warn).with(
+        'WARN: Screenshot could not be saved. `page.current_path` is empty.',
+      )
+      saver.save
+    end
   end
 
-  context 'when saving a screenshot fails' do
+  context 'when save_html raises' do
+    before(:each) do
+      allow(saver).to receive(:save_html).and_raise(NoMethodError.new('some error'))
+    end
+
+    it 'prints warning message' do
+      expect(saver).to receive(:warn).with(
+        'WARN: HTML source could not be saved. An exception is raised: #<NoMethodError: some error>.',
+      )
+      saver.save
+    end
+
+    it 'tries to save screenshot' do
+      expect(saver).to receive(:save_screenshot)
+      saver.save
+    end
+  end
+
+  context 'when save_screenshot raises' do
+    before(:each) do
+      allow(saver).to receive(:save_screenshot).and_raise(NoMethodError.new('some error'))
+    end
+
+    it 'prints warning message' do
+      expect(saver).to receive(:warn).with(
+        'WARN: Screenshot could not be saved. An exception is raised: #<NoMethodError: some error>.',
+      )
+      saver.save
+    end
+
+    it 'tries to save screenshot' do
+      expect(saver).to receive(:save_html)
+      saver.save
+    end
+  end
+
+  context 'when current_path raises' do
+    before(:each) do
+      allow(page_mock).to receive(:current_path).and_raise(NoMethodError.new('some error'))
+    end
+
+    it 'prints warning message' do
+      expect(saver).to receive(:warn).with(
+        'WARN: Screenshot could not be saved. `page.current_path` raised exception: #<NoMethodError: some error>.',
+      )
+      saver.save
+    end
+
+    it 'does not print extra warning message' do
+      expect(saver).not_to receive(:warn).with(/is empty/)
+      saver.save
+    end
+
     it 'still restores the original value of Capybara.save_and_open_page_path' do
-      Capybara.save_and_open_page_path = 'tmp/bananas'
+      Capybara::Screenshot.capybara_tmp_path = 'tmp/bananas'
 
-      expect(capybara_mock).to receive(:save_page).and_raise
+      allow(page_mock).to receive(:current_path).and_raise
 
-      expect {
-        saver.save
-      }.to raise_error(RuntimeError)
+      saver.save
 
-      expect(Capybara.save_and_open_page_path).to eq('tmp/bananas')
+      if Capybara.respond_to?(:save_path)
+        expect(Capybara.save_path).to eq('tmp/bananas')
+      else
+        expect(Capybara.save_and_open_page_path).to eq('tmp/bananas')
+      end
     end
   end
 
@@ -154,6 +223,40 @@ describe Capybara::Screenshot::Saver do
     end
   end
 
+  describe 'callbacks' do
+    let(:saver) { Capybara::Screenshot::Saver.new(capybara_mock, page_mock) }
+
+    before do
+      allow(saver).to receive(:html_path) { 'page.html' }
+      allow(saver).to receive(:screenshot_path) { 'screenshot.png' }
+    end
+
+    before :all do
+      Capybara::Screenshot.after_save_html do |path|
+        puts "after_save_html ran with #{path}"
+      end
+      Capybara::Screenshot.after_save_screenshot do |path|
+        puts "after_save_screenshot ran with #{path}"
+      end
+    end
+
+    after :all do
+      Capybara::Screenshot::Saver.instance_eval { @callbacks = nil }
+    end
+
+    it 'runs after_save_html callbacks' do
+      expect do
+        saver.save
+      end.to output(/after_save_html ran with page\.html/).to_stdout
+    end
+
+    it 'runs after_save_screenshot callbacks' do
+      expect do
+        saver.save
+      end.to output(/after_save_screenshot ran with screenshot\.png/).to_stdout
+    end
+  end
+
   describe "with selenium driver" do
     before do
       allow(capybara_mock).to receive(:current_driver).and_return(:selenium)
@@ -195,6 +298,19 @@ describe Capybara::Screenshot::Saver do
     end
   end
 
+  describe "with cuprite driver" do
+    before do
+      allow(capybara_mock).to receive(:current_driver).and_return(:cuprite)
+    end
+
+    it 'saves driver render with :full => true' do
+      expect(driver_mock).to receive(:render).with(screenshot_path, {:full => true})
+
+      saver.save
+      expect(saver).to be_screenshot_saved
+    end
+  end
+
   describe "with webkit driver" do
     before do
       allow(capybara_mock).to receive(:current_driver).and_return(:webkit)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.0.26
 platform: ruby
 authors:
 - Matthew O'Riordan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2022-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -19,7 +19,7 @@ dependencies:
         version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '1.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +157,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -188,15 +188,14 @@ files:
 - README.md
 - Rakefile
 - capybara-screenshot.gemspec
-- gemfiles/cucumber.1.2.gemfile
-- gemfiles/cucumber.1.3.0.gemfile
+- gemfiles/cucumber.1.3.gemfile
+- gemfiles/cucumber.2.4.gemfile
 - gemfiles/latest.gemfile
-- gemfiles/rspec.2.14.gemfile
-- gemfiles/rspec.2.99.gemfile
 - gemfiles/rspec.3.0.gemfile
-- gemfiles/spinach.0.7.gemfile
-- gemfiles/spinach.0.8.0.gemfile
+- gemfiles/rspec.3.3.gemfile
+- gemfiles/spinach.0.8.gemfile
 - lib/capybara-screenshot.rb
+- lib/capybara-screenshot/callbacks.rb
 - lib/capybara-screenshot/capybara.rb
 - lib/capybara-screenshot/cucumber.rb
 - lib/capybara-screenshot/helpers.rb
@@ -241,8 +240,12 @@ files:
 homepage: http://github.com/mattheworiordan/capybara-screenshot
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/mattheworiordan/capybara-screenshot/issues
+  changelog_uri: https://github.com/mattheworiordan/capybara-screenshot/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/capybara-screenshot/1.0.26
+  source_code_uri: https://github.com/mattheworiordan/capybara-screenshot/tree/v1.0.26
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -257,9 +260,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: capybara-screenshot
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Automatically create snapshots when Cucumber steps fail with Capybara and
   Rails

data/gemfiles/cucumber.1.2.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rake"
-gem "appraisal"
-gem "cucumber", "1.2"
-
-gemspec :path => "../"

data/gemfiles/cucumber.1.3.0.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rake"
-gem "appraisal"
-gem "cucumber", "1.3.0"
-
-gemspec :path => "../"

data/gemfiles/rspec.2.14.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rake"
-gem "appraisal"
-gem "rspec", "2.14"
-
-gemspec :path => "../"

data/gemfiles/rspec.2.99.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rake"
-gem "appraisal"
-gem "rspec", "2.99"
-
-gemspec :path => "../"

data/gemfiles/spinach.0.7.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rake"
-gem "appraisal"
-gem "spinach", "0.7"
-
-gemspec :path => "../"

data/gemfiles/spinach.0.8.0.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rake"
-gem "appraisal"
-gem "spinach", "0.8.0"
-
-gemspec :path => "../"