capybara-screenshot 1.0.14 → 1.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71470cade862f24352d34e3d61d3e1d6e53ede52
-  data.tar.gz: abbee3986bf463c8b26526337255ec8397b2757d
+  metadata.gz: 17a6c4cc3fd164bb2b6f74448ef7b9ddf83b771c
+  data.tar.gz: fc743fe14f52cb0481a3aa545e9b5290420a4cd1
 SHA512:
-  metadata.gz: 6540046700e726903a13951d1fc8776da24d9db19a0096e65a3009404f66c3aea364727421b629a0292364d54bb19c207322694b198fcf52c3e64ca30019473b
-  data.tar.gz: b7c37d742286182baa7c97d767a12a0c162e465c32338e19407c02a70159046682cb7233bcdba7763b7923a0315b844bdc73792272ffcbecfb02a97eee393dc2
+  metadata.gz: 366222eb34fb0bdfa5bf53c5b27a7e00902c1e8300b6767a377ff6fa207eb1a5104d6cc868d7f69c1829f370ff90ebbde1940e8529b8ab694fb544b9ab5fc38d
+  data.tar.gz: 0c04abede37b6e6fc39a1f1d22a2d7429eada67a0d46bbb8ef59bf1ba53d35763d1d4b4c7361d8c21ffa52dc90e58e7de9421a2864effa8e71dae5c939e9b944

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+12 July 2017 - 1.0.14 -> 1.0.15
+
+* [SVG badges added](https://github.com/mattheworiordan/capybara-screenshot/pull/207)
+* [Ensure the reporter module is not loaded multiple times](https://github.com/mattheworiordan/capybara-screenshot/pull/205)
+* [S3 object config option](https://github.com/mattheworiordan/capybara-screenshot/pull/204)
+* [Saver can use injected page](https://github.com/mattheworiordan/capybara-screenshot/pull/181)
+* [After* callbacks](https://github.com/mattheworiordan/capybara-screenshot/pull/171)
+
 15 Sep 2016 - 1.0.13 -> 1.0.14
 
 * CI stable again - dropped CI support for older versions of Ruby and JRuby.  It is just too painful and there is no evidence that our users need this or that Capybara Screenshot is indeed broken.  It is better to have a reliable build system so that PRs can get merged in reliably and easily.

data/README.md

@@ -1,8 +1,8 @@
 capybara-screenshot gem
 =======================
 
-[![Build Status](https://travis-ci.org/mattheworiordan/capybara-screenshot.png)](https://travis-ci.org/mattheworiordan/capybara-screenshot)
-[![Code Climate](https://d3s6mut3hikguw.cloudfront.net/github/mattheworiordan/capybara-screenshot.png)](https://codeclimate.com/github/mattheworiordan/capybara-screenshot)
+[![Build Status](https://travis-ci.org/mattheworiordan/capybara-screenshot.svg)](https://travis-ci.org/mattheworiordan/capybara-screenshot)
+[![Code Climate](https://d3s6mut3hikguw.cloudfront.net/github/mattheworiordan/capybara-screenshot.svg)](https://codeclimate.com/github/mattheworiordan/capybara-screenshot)
 [![Gem Version](https://badge.fury.io/rb/capybara-screenshot.svg)](http://badge.fury.io/rb/capybara-screenshot)
 
 #### Capture a screen shot for every test failure automatically!
@@ -113,6 +113,22 @@ Capybara::Screenshot.screenshot_and_save_page
 Capybara::Screenshot.screenshot_and_open_image
 ```
 
+Better looking HTML screenshots
+-------------------------------
+
+By the default, HTML screenshots will not look very good when opened in a browser.  This happens because the browser can't correctly resolve relative paths like `<link href="/assets/...." />`, which stops CSS, images, etc... from beind loaded.  To get a nicer looking page, configure Capybara with:
+
+```ruby
+Capybara.asset_host = 'http://localhost:3000'
+```
+
+This will cause Capybara to add `<base>http://localhost:3000</base>` to the HTML file, which gives the browser enough information to resolve relative paths.  Next, start a rails server in development mode, on port 3000, to respond to requests for assets:
+
+```bash
+rails s -p 3000
+```
+
+Now when you open the page, you should have something that looks much better.  You can leave this setup in place and use the default HTML pages when you don't care about the presentation, or start the rails server when you need something better looking.  
 
 Driver configuration
 --------------------
@@ -198,6 +214,15 @@ Capybara::Screenshot.s3_configuration = {
 }
 ```
 
+It is also possible to specify the object parameters such as acl.
+Configure the capybara-screenshot with these options in this way:
+
+```ruby
+Capybara::Screenshot.s3_object_configuration = {
+  acl: 'public-read'
+}
+```
+
 
 Pruning old screenshots automatically
 --------------------------
@@ -211,6 +236,30 @@ Capybara::Screenshot.prune_strategy = :keep_last_run
 Capybara::Screenshot.prune_strategy = { keep: 20 }
 ```
 
+Callbacks
+---------
+
+You can hook your own logic into callbacks after the html/screenshot has been saved.
+
+```ruby
+# after Saver#save_html
+Capybara::Screenshot.after_save_html do |path|
+  mail = Mail.new do
+    delivery_method :sendmail
+    from     'capybara-screenshot@example.com'
+    to       'dev@example.com'
+    subject  'Capybara Screenshot'
+    add_file File.read path
+  end
+  mail.delivery_method :sendmail
+  mail.deliver
+end
+
+# after Saver#save_screenshot
+Capybara::Screenshot.after_save_screenshot do |path|
+  # ...
+end
+```
 
 Information about screenshots in RSpec output
 ---------------------------------------------

data/lib/capybara-screenshot.rb

@@ -10,6 +10,7 @@ module Capybara
       attr_writer   :final_session_name
       attr_accessor :prune_strategy
       attr_accessor :s3_configuration
+      attr_accessor :s3_object_configuration
     end
 
     self.autosave_on_failure = true
@@ -20,6 +21,7 @@ module Capybara
     self.webkit_options = {}
     self.prune_strategy = :keep_all
     self.s3_configuration = {}
+    self.s3_object_configuration = {}
 
     def self.append_screenshot_path=(value)
       $stderr.puts "WARNING: Capybara::Screenshot.append_screenshot_path is deprecated. " +
@@ -97,12 +99,20 @@ module Capybara
 
       unless s3_configuration.empty?
         require 'capybara-screenshot/s3_saver'
-        saver = S3Saver.new_with_configuration(saver, s3_configuration)
+        saver = S3Saver.new_with_configuration(saver, s3_configuration, s3_object_configuration)
       end
 
       return saver
     end
 
+    def self.after_save_html &block
+      Saver.after_save_html &block
+    end
+
+    def self.after_save_screenshot &block
+      Saver.after_save_screenshot &block
+    end
+
     private
 
     # If the path isn't set, default to the current directory

data/lib/capybara-screenshot/callbacks.rb

@@ -0,0 +1,44 @@
+module Capybara
+  module Screenshot
+    module Callbacks
+      class CallbackSet < Array
+        def call *args
+          each do |callback|
+            callback.call *args
+          end
+        end
+      end
+
+      module ClassMethods
+        def callbacks
+          @callbacks ||= {}
+        end
+
+        def define_callback name
+          callbacks[name] ||= CallbackSet.new
+
+          define_singleton_method name do |&block|
+            callbacks[name] << block
+          end
+        end
+
+        def run_callbacks name, *args
+          if cb_set = callbacks[name]
+            cb_set.call *args
+          end
+        end
+      end
+
+      module InstanceMethods
+        def run_callbacks name, *args
+          self.class.run_callbacks name, *args
+        end
+      end
+
+      def self.included receiver
+        receiver.extend         ClassMethods
+        receiver.send :include, InstanceMethods
+      end
+    end
+  end
+end

data/lib/capybara-screenshot/rspec.rb

@@ -88,6 +88,7 @@ RSpec.configure do |config|
     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])
+        next if formatter.singleton_class.included_modules.include?(reporter_module)
         formatter.singleton_class.send :include, reporter_module
       end
     end

data/lib/capybara-screenshot/s3_saver.rb

@@ -5,13 +5,14 @@ module Capybara
     class S3Saver
       DEFAULT_REGION = 'us-east-1'
 
-      def initialize(saver, s3_client, bucket_name)
+      def initialize(saver, s3_client, bucket_name, object_configuration)
         @saver = saver
         @s3_client = s3_client
         @bucket_name = bucket_name
+        @object_configuration = object_configuration
       end
 
-      def self.new_with_configuration(saver, configuration)
+      def self.new_with_configuration(saver, configuration, object_configuration)
         default_s3_client_credentials = {
           region: DEFAULT_REGION
         }
@@ -23,7 +24,7 @@ module Capybara
         s3_client = Aws::S3::Client.new(s3_client_credentials)
         bucket_name = configuration.fetch(:bucket_name)
 
-        new(saver, s3_client, bucket_name)
+        new(saver, s3_client, bucket_name, object_configuration)
       rescue KeyError
         raise "Invalid S3 Configuration #{configuration}. Please refer to the documentation for the necessary configurations."
       end
@@ -31,10 +32,16 @@ module Capybara
       def save_and_upload_screenshot
         save_and do |local_file_path|
           File.open(local_file_path) do |file|
+            object_payload = {
+              bucket: bucket_name,
+              key: File.basename(local_file_path),
+              body: file
+            }
+
+            object_payload.merge!(object_configuration) unless object_configuration.empty?
+
             s3_client.put_object(
-                bucket: bucket_name,
-                key: File.basename(local_file_path),
-                body: file
+                object_payload
             )
           end
         end
@@ -51,7 +58,8 @@ module Capybara
       private
       attr_reader :saver,
                   :s3_client,
-                  :bucket_name
+                  :bucket_name,
+                  :object_configuration
 
       def save_and
         saver.save

data/lib/capybara-screenshot/saver.rb

@@ -1,9 +1,16 @@
 require 'capybara-screenshot/helpers'
+require 'capybara-screenshot/callbacks'
 
 module Capybara
   module Screenshot
     class Saver
+      include Capybara::Screenshot::Callbacks
+
+      define_callback :after_save_html
+      define_callback :after_save_screenshot
+
       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
@@ -36,6 +43,7 @@ module Capybara
           end
         end
         @html_saved = true
+        run_callbacks :after_save_html, html_path if html_saved?
       end
 
       def save_screenshot
@@ -47,6 +55,7 @@ module Capybara
           }.call(page.driver, path)
           @screenshot_saved = result != :not_supported
         end
+        run_callbacks :after_save_screenshot, screenshot_path if screenshot_saved?
       end
 
       def html_path

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = '1.0.14'
+    VERSION = '1.0.15'
   end
 end

data/spec/cucumber/cucumber_spec.rb

@@ -3,10 +3,6 @@ require "spec_helper"
 describe "Using Capybara::Screenshot with Cucumber" do
   include CommonSetup
 
-  before do
-    setup_aruba
-  end
-
   let(:cmd) { 'cucumber' }
 
   def run_failing_case(failure_message, code)

data/spec/feature/minitest_spec.rb

@@ -3,10 +3,6 @@ require "spec_helper"
 describe "Using Capybara::Screenshot with MiniTest" do
   include CommonSetup
 
-  before do
-    setup_aruba
-  end
-
   def run_failing_case(code)
     write_file('test_failure.rb', <<-RUBY)
       #{ensure_load_paths_valid}

data/spec/feature/testunit_spec.rb

@@ -3,10 +3,6 @@ require "spec_helper"
 describe "Using Capybara::Screenshot with Test::Unit" do
   include CommonSetup
 
-  before do
-    setup_aruba
-  end
-
   def run_failing_case(code, integration_path = '.')
     write_file("#{integration_path}/test_failure.rb", <<-RUBY)
       #{ensure_load_paths_valid}

data/spec/rspec/rspec_spec.rb

@@ -5,7 +5,6 @@ describe Capybara::Screenshot::RSpec, :type => :aruba do
     include CommonSetup
 
     before do
-      setup_aruba
       Capybara::Screenshot.capybara_tmp_path = expand_path('tmp')
     end
 

data/spec/spinach/spinach_spec.rb

@@ -3,10 +3,6 @@ require "spec_helper"
 describe "Using Capybara::Screenshot with Spinach" do
   include CommonSetup
 
-  before do
-    setup_aruba
-  end
-
   def run_failing_case(failure_message, code)
     write_file('steps/failure.rb', <<-RUBY)
       #{ensure_load_paths_valid}

data/spec/support/aruba.rb

@@ -1,3 +1,2 @@
 require 'aruba/rspec'
-require 'aruba/api'
 require 'aruba/config/jruby'

data/spec/unit/capybara-screenshot_spec.rb

@@ -81,11 +81,12 @@ describe Capybara::Screenshot do
       args = double('args')
       s3_saver_double = double('s3_saver')
       s3_configuration = { hello: 'world' }
+      s3_object_configuration = {}
 
       Capybara::Screenshot.s3_configuration = s3_configuration
 
       expect(Capybara::Screenshot::Saver).to receive(:new).with(args).and_return(saver_double)
-      expect(Capybara::Screenshot::S3Saver).to receive(:new_with_configuration).with(saver_double, s3_configuration).and_return(s3_saver_double)
+      expect(Capybara::Screenshot::S3Saver).to receive(:new_with_configuration).with(saver_double, s3_configuration, s3_object_configuration).and_return(s3_saver_double)
 
       expect(Capybara::Screenshot.new_saver(args)).to eq(s3_saver_double)
     end

data/spec/unit/s3_saver_spec.rb

@@ -4,9 +4,10 @@ require 'capybara-screenshot/s3_saver'
 describe Capybara::Screenshot::S3Saver do
   let(:saver) { double('saver') }
   let(:bucket_name) { double('bucket_name') }
+  let(:s3_object_configuration) { {} }
   let(:s3_client) { double('s3_client') }
 
-  let(:s3_saver) { Capybara::Screenshot::S3Saver.new(saver, s3_client, bucket_name) }
+  let(:s3_saver) { Capybara::Screenshot::S3Saver.new(saver, s3_client, bucket_name, s3_object_configuration) }
 
   describe '.new_with_configuration' do
     let(:access_key_id) { double('access_key_id') }
@@ -30,10 +31,10 @@ describe Capybara::Screenshot::S3Saver do
       Capybara::Screenshot::S3Saver.new_with_configuration(saver, {
         s3_client_credentials: s3_client_credentials,
         bucket_name: bucket_name
-      })
+      }, s3_object_configuration)
 
       expect(Aws::S3::Client).to have_received(:new).with(s3_client_credentials)
-      expect(Capybara::Screenshot::S3Saver).to have_received(:new).with(saver, s3_client, bucket_name)
+      expect(Capybara::Screenshot::S3Saver).to have_received(:new).with(saver, s3_client, bucket_name, s3_object_configuration)
     end
 
     it 'defaults the region to us-east-1' do
@@ -45,13 +46,29 @@ describe Capybara::Screenshot::S3Saver do
       Capybara::Screenshot::S3Saver.new_with_configuration(saver, {
           s3_client_credentials: s3_client_credentials_using_defaults,
           bucket_name: bucket_name
-      })
+      }, s3_object_configuration)
 
       expect(Aws::S3::Client).to have_received(:new).with(
         s3_client_credentials.merge(region: default_region)
       )
 
-      expect(Capybara::Screenshot::S3Saver).to have_received(:new).with(saver, s3_client, bucket_name)
+      expect(Capybara::Screenshot::S3Saver).to have_received(:new).with(saver, s3_client, bucket_name, s3_object_configuration)
+    end
+
+    it 'stores the object configuration when passed' do
+      s3_object_configuration = { acl: 'public-read' }
+      Capybara::Screenshot.s3_object_configuration = { acl: 'public-read' }
+
+      allow(Aws::S3::Client).to receive(:new).and_return(s3_client)
+      allow(Capybara::Screenshot::S3Saver).to receive(:new)
+
+      Capybara::Screenshot::S3Saver.new_with_configuration(saver, {
+        s3_client_credentials: s3_client_credentials,
+        bucket_name: bucket_name
+      }, s3_object_configuration)
+
+      expect(Aws::S3::Client).to have_received(:new).with(s3_client_credentials)
+      expect(Capybara::Screenshot::S3Saver).to have_received(:new).with(saver, s3_client, bucket_name, s3_object_configuration)
     end
   end
 
@@ -103,6 +120,49 @@ describe Capybara::Screenshot::S3Saver do
 
       s3_saver.save
     end
+
+    describe 'save to s3 with object configuration' do
+      let(:s3_object_configuration) { { acl: 'public-read' } }
+      let(:s3_saver) { Capybara::Screenshot::S3Saver.new(saver, s3_client, bucket_name, s3_object_configuration) }
+
+      it 'uploads the html' do
+        html_path = '/foo/bar.html'
+        expect(saver).to receive(:html_path).and_return(html_path)
+        expect(saver).to receive(:html_saved?).and_return(true)
+
+        html_file = double('html_file')
+
+        expect(File).to receive(:open).with(html_path).and_yield(html_file)
+
+        expect(s3_client).to receive(:put_object).with(
+          bucket: bucket_name,
+          key: 'bar.html',
+          body: html_file,
+          acl: 'public-read'
+        )
+
+        s3_saver.save
+      end
+
+      it 'uploads the screenshot' do
+        screenshot_path = '/baz/bim.jpg'
+        expect(saver).to receive(:screenshot_path).and_return(screenshot_path)
+        expect(saver).to receive(:screenshot_saved?).and_return(true)
+
+        screenshot_file = double('screenshot_file')
+
+        expect(File).to receive(:open).with(screenshot_path).and_yield(screenshot_file)
+
+        expect(s3_client).to receive(:put_object).with(
+          bucket: bucket_name,
+          key: 'bim.jpg',
+          body: screenshot_file,
+          acl: 'public-read'
+        )
+
+        s3_saver.save
+      end
+    end
   end
 
   # Needed because we cannot depend on Verifying Doubles
@@ -129,4 +189,4 @@ describe Capybara::Screenshot::S3Saver do
       expect(saver).to have_received(:foo_bar).with(*args)
     end
   end
-end
+end

data/spec/unit/saver_spec.rb

@@ -161,6 +161,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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 1.0.15
 platform: ruby
 authors:
 - Matthew O'Riordan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -194,6 +194,7 @@ files:
 - gemfiles/rspec.3.0.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