capybara-screenshot 1.0.21 → 1.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2839e0fb312bb63dc21c79ccc62cf03e1f0c2108
-  data.tar.gz: 1b35c96876b2fa3f13e2e582ad15c334225b4e9e
+  metadata.gz: b82c5c74da4902799ac9a61f9eb37449a928254e
+  data.tar.gz: 8052ba2b86c41f32539463afeddfe07cb275eb0a
 SHA512:
-  metadata.gz: 0a381fbb702a47367f84b50a93391e885c8fbb3650dfb8f8efa3f4064dd06ffcdf85251ebc175fb7ffdce6ac2134110da1f993076cf441a8b9bc52c1e0c7d3ef
-  data.tar.gz: 3a991f0ba8200bb4452b43e5024c6f293eefc81c5cccda07c628da3311d786b61101de4c9c6d489a68bc4489a2da3cee72f5def87885f82b3282a269fd5ce591
+  metadata.gz: 7a4fc4c95398c92bec5387f27521623c2ca6c5d7b6dbf07bfa614e63012ccc31625488baf52b6471bdf6d27e8c5254a0af149e7cb3fc220c4b64ce4239fbdbcf
+  data.tar.gz: 74fc5fb1271e9d7faaf23271719085ea6302a3b74124d764b1d4f5c6b55109329dfc368e1588466cf99d077a071d4cf77ebe40a8b3f68b140522f2442333f655

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+21 Oct 2018 - 1.0.21 -> 1.0.22
+
+* [Support for S3 URL in HTML screenshots](https://github.com/mattheworiordan/capybara-screenshot/pull/239)
+* [Fix for partial Rails environments](https://github.com/mattheworiordan/capybara-screenshot/pull/238)
+* [Capybara 3 support in CI](https://github.com/mattheworiordan/capybara-screenshot/pull/236)
+
 03 May 2018 - 1.0.20 -> 1.0.21
 
 * [Bug fix: Fix Ruby version compares in Gemspec](https://github.com/mattheworiordan/capybara-screenshot/pull/231)

data/lib/capybara-screenshot.rb

@@ -58,7 +58,7 @@ module Capybara
     end
 
     def self.capybara_root
-      @capybara_root ||= if defined?(::Rails) && ::Rails.root.present?
+      @capybara_root ||= if defined?(::Rails) && ::Rails.respond_to?(:root) && ::Rails.root.present?
         ::Rails.root.join capybara_tmp_path
       elsif defined?(Padrino)
         File.expand_path(capybara_tmp_path, Padrino.root)
@@ -106,11 +106,11 @@ module Capybara
     end
 
     def self.after_save_html &block
-      Saver.after_save_html &block
+      Saver.after_save_html(&block)
     end
 
     def self.after_save_screenshot &block
-      Saver.after_save_screenshot &block
+      Saver.after_save_screenshot(&block)
     end
 
     private

data/lib/capybara-screenshot/callbacks.rb

@@ -4,7 +4,7 @@ module Capybara
       class CallbackSet < Array
         def call *args
           each do |callback|
-            callback.call *args
+            callback.call(*args)
           end
         end
       end
@@ -24,7 +24,7 @@ module Capybara
 
         def run_callbacks name, *args
           if cb_set = callbacks[name]
-            cb_set.call *args
+            cb_set.call(*args)
           end
         end
       end

data/lib/capybara-screenshot/capybara.rb

@@ -1,5 +1,3 @@
-require "capybara-screenshot"
-
 module Capybara
   module DSL
     # Adds class methods to Capybara module and gets mixed into

data/lib/capybara-screenshot/minitest.rb

@@ -27,7 +27,7 @@ begin
   class Minitest::Test
     include Capybara::Screenshot::MiniTestPlugin
   end
-rescue NameError => e
+rescue NameError
   class MiniTest::Unit::TestCase
     include Capybara::Screenshot::MiniTestPlugin
   end

data/lib/capybara-screenshot/pruner.rb

@@ -26,7 +26,10 @@ module Capybara
       end
 
       private
-      attr_reader :strategy_proc
+      
+      def strategy_proc
+        @strategy_proc
+      end
 
       def wildcard_path
         File.expand_path('*.{html,png}', Screenshot.capybara_root)

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

@@ -3,7 +3,7 @@ module Capybara
     module RSpec
       module BaseReporter
 
-        # Automatically set up method aliases (very much like ActiveSupport's `alias_method_chain`) 
+        # 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"
@@ -14,7 +14,6 @@ module Capybara
             end
           end
         end
-
       end
     end
   end

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

@@ -1,5 +1,6 @@
 require 'capybara-screenshot/rspec/base_reporter'
 require 'base64'
+require 'uri'
 
 module Capybara
   module Screenshot
@@ -13,12 +14,22 @@ module Capybara
           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'>"
+            result += "<img src='#{image_tag_source(screenshot[:image])}' style='display: block'>"
           end
           result
         end
+
+        private
+
+        def image_tag_source(path)
+          if URI.regexp(%w[http https]) =~ path
+            path
+          else
+            image = File.binread(path)
+            encoded_img = Base64.encode64(image)
+            "data:image/png;base64,#{encoded_img}"
+          end
+        end
       end
     end
   end

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

@@ -26,8 +26,8 @@ module Capybara
         private
         def output_screenshot_info(example)
           return unless (screenshot = example.metadata[:screenshot])
-          output.puts(long_padding + CapybaraScreenshot::Helpers.yellow("HTML screenshot: file://#{screenshot[:html]}")) if screenshot[:html]
-          output.puts(long_padding + CapybaraScreenshot::Helpers.yellow("Image screenshot: file://#{screenshot[:image]}")) if screenshot[:image]
+          output.puts(long_padding + CapybaraScreenshot::Helpers.yellow("HTML screenshot: #{screenshot[:html]}")) if screenshot[:html]
+          output.puts(long_padding + CapybaraScreenshot::Helpers.yellow("Image screenshot: #{screenshot[:image]}")) if screenshot[:image]
         end
 
         def long_padding

data/lib/capybara-screenshot/s3_saver.rb

@@ -5,6 +5,8 @@ module Capybara
     class S3Saver
       DEFAULT_REGION = 'us-east-1'
 
+      attr_accessor :html_path, :screenshot_path
+
       def initialize(saver, s3_client, bucket_name, object_configuration, options={})
         @saver = saver
         @s3_client = s3_client
@@ -31,11 +33,13 @@ module Capybara
       end
 
       def save_and_upload_screenshot
-        save_and do |local_file_path|
+        save_and do |type, local_file_path|
           File.open(local_file_path) do |file|
+            s3_upload_path = "#{@key_prefix}#{File.basename(local_file_path)}"
+
             object_payload = {
               bucket: bucket_name,
-              key: "#{@key_prefix}#{File.basename(local_file_path)}",
+              key: s3_upload_path,
               body: file
             }
 
@@ -44,6 +48,10 @@ module Capybara
             s3_client.put_object(
                 object_payload
             )
+
+            s3_region = s3_client.get_bucket_location(bucket: bucket_name).location_constraint
+
+            send("#{type}_path=", "https://#{bucket_name}.s3-#{s3_region}.amazonaws.com/#{s3_upload_path}")
           end
         end
       end
@@ -66,8 +74,8 @@ module Capybara
       def save_and
         saver.save
 
-        yield(saver.html_path) if block_given? && saver.html_saved?
-        yield(saver.screenshot_path) if block_given? && saver.screenshot_saved?
+        yield(:html, saver.html_path) if block_given? && saver.html_saved?
+        yield(:screenshot, saver.screenshot_path) if block_given? && saver.screenshot_saved?
       end
     end
   end

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = '1.0.21'
+    VERSION = '1.0.22'
   end
 end

data/spec/cucumber/cucumber_spec.rb

@@ -32,7 +32,7 @@ describe "Using Capybara::Screenshot with Cucumber" do
   end
 
   it 'saves a screenshot on failure' do
-    run_failing_case %q{Unable to find visible link or button "you'll never find me"}, <<-CUCUMBER
+    run_failing_case %q{Unable to find (visible )?link or button "you'll never find me"}, <<-CUCUMBER
       Feature: Failure
         Scenario: Failure
           Given I visit "/"
@@ -52,7 +52,7 @@ describe "Using Capybara::Screenshot with Cucumber" do
   end
 
   it 'saves a screenshot for the correct session for failures using_session' do
-    run_failing_case(%q{Unable to find visible link or button "you'll never find me"}, <<-CUCUMBER)
+    run_failing_case(%q{Unable to find (visible )?link or button "you'll never find me"}, <<-CUCUMBER)
       Feature: Failure
         Scenario: Failure in different session
           Given I visit "/"
@@ -68,7 +68,7 @@ describe "Using Capybara::Screenshot with Cucumber" do
     end
 
     it 'on failure it prunes previous screenshots when strategy is set' do
-      run_failing_case %q{Unable to find visible link or button "you'll never find me"}, <<-CUCUMBER
+      run_failing_case %q{Unable to find (visible )?link or button "you'll never find me"}, <<-CUCUMBER
         Feature: Prune
           Scenario: Screenshots are pruned if strategy is set
             Given I visit "/"

data/spec/feature/minitest_spec.rb

@@ -23,7 +23,7 @@ describe "Using Capybara::Screenshot with MiniTest" do
 
     cmd = 'bundle exec ruby test_failure.rb'
     run_simple_with_retry cmd, false
-    expect(last_command_started.output).to include %q{Unable to find visible link or button "you'll never find me"}
+    expect(last_command_started.output).to match %r{Unable to find (visible )?link or button "you'll never find me"}
   end
 
   it 'saves a screenshot on failure' do

data/spec/feature/testunit_spec.rb

@@ -14,7 +14,7 @@ describe "Using Capybara::Screenshot with Test::Unit" do
 
       #{setup_test_app}
       Capybara::Screenshot.register_filename_prefix_formatter(:testunit) do | fault |
-        raise "expected fault" unless fault.exception.message.include? %q{Unable to find visible link or button "you'll never find me"}
+        raise "expected fault" unless fault.exception.message.match %r{Unable to find (visible )?link or button "you'll never find me"}
         'my_screenshot'
       end
 
@@ -29,7 +29,7 @@ describe "Using Capybara::Screenshot with Test::Unit" do
 
     cmd = "bundle exec ruby #{integration_path}/test_failure.rb"
     run_simple_with_retry cmd, false
-    expect(last_command_started.output).to include %q{Unable to find visible link or button "you'll never find me"}
+    expect(last_command_started.output).to match %r{Unable to find (visible )?link or button "you'll never find me"}
   end
 
   it "saves a screenshot on failure for any test in path 'test/integration'" do

data/spec/rspec/rspec_spec.rb

@@ -41,7 +41,7 @@ describe Capybara::Screenshot::RSpec, :type => :aruba do
     end
 
     it 'saves a screenshot when browser action fails' do
-      run_failing_case <<-RUBY, %q{Unable to find visible link or button "you'll never find me"}
+      run_failing_case <<-RUBY, %r{Unable to find (visible )?link or button "you'll never find me"}
         feature 'screenshot with failure' do
           scenario 'click on a missing link' do
             visit '/'
@@ -103,7 +103,7 @@ describe Capybara::Screenshot::RSpec, :type => :aruba do
     end
 
     it 'saves a screenshot for the correct session for failures using_session' do
-      run_failing_case <<-RUBY, %q{Unable to find visible link or button "you'll never find me"}
+      run_failing_case <<-RUBY, %r{Unable to find (visible )?link or button "you'll never find me"}
         feature 'screenshot with failure' do
           scenario 'click on a missing link' do
             visit '/'

data/spec/spinach/spinach_spec.rb

@@ -17,7 +17,7 @@ describe "Using Capybara::Screenshot with Spinach" do
   end
 
   it "saves a screenshot on failure" do
-    run_failing_case(%q{Unable to find visible link or button "you'll never find me"}, <<-GHERKIN)
+    run_failing_case(%q{Unable to find (visible )?link or button "you'll never find me"}, <<-GHERKIN)
       Feature: Failure
         Scenario: Failure
           Given I visit "/"
@@ -37,7 +37,7 @@ describe "Using Capybara::Screenshot with Spinach" do
   end
 
   it "saves a screenshot for the correct session for failures using_session" do
-    run_failing_case(%q{Unable to find visible link or button "you'll never find me"}, <<-GHERKIN)
+    run_failing_case(%q{Unable to find (visible )?link or button "you'll never find me"}, <<-GHERKIN)
       Feature: Failure
         Scenario: Failure in different session
           Given I visit "/"
@@ -49,7 +49,7 @@ describe "Using Capybara::Screenshot with Spinach" do
   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 visible link or button "you'll never find me"}, <<-GHERKIN)
+    run_failing_case(%q{Unable to find (visible )?link or button "you'll never find me"}, <<-GHERKIN)
       Feature: Failure
         Scenario: Failure
           Given I visit "/"

data/spec/unit/rspec_reporters/html_embed_reporter_spec.rb

@@ -15,4 +15,17 @@ describe Capybara::Screenshot::RSpec::HtmlEmbedReporter do
       expect(content_without_styles).to eql("original content<img src='data:image/png;base64,#{encoded_image_data}'>")
     end
   end
+
+  context 'when an image was saved to s3' do
+    let(:s3_image_url) { "http://s3.amazon.com/path/to/image" }
+
+    before do
+      set_example double("example", metadata: {screenshot: {image: s3_image_url}})
+    end
+
+    it 'embeds the image URL into the content' do
+      content_without_styles = @reporter.extra_failure_content(nil).gsub(/ ?style='.*?' ?/, "")
+      expect(content_without_styles).to eql("original content<img src='#{s3_image_url}'>")
+    end
+  end
 end

data/spec/unit/rspec_reporters/text_reporter_spec.rb

@@ -64,20 +64,20 @@ describe Capybara::Screenshot::RSpec::TextReporter do
   end
 
   context 'when a html file was saved' do
-    let(:example) { example_failed_method_argument_double(screenshot: { html: "path/to/html" }) }
+    let(:example) { example_failed_method_argument_double(screenshot: { html: "/path/to/html" }) }
 
     it 'appends the html file path to the original output' do
       @reporter.send(example_failed_method, example)
-      expect(@reporter.output.string).to eql("original failure info\n  #{CapybaraScreenshot::Helpers.yellow("HTML screenshot: file://path/to/html")}\n")
+      expect(@reporter.output.string).to eql("original failure info\n  #{CapybaraScreenshot::Helpers.yellow("HTML screenshot: /path/to/html")}\n")
     end
   end
 
   context 'when a html file and an image were saved' do
-    let(:example) { example_failed_method_argument_double(screenshot: { html: "path/to/html", image: "path/to/image" }) }
+    let(:example) { example_failed_method_argument_double(screenshot: { html: "/path/to/html", image: "/path/to/image" }) }
 
     it 'appends the image path to the original output' do
       @reporter.send(example_failed_method, example)
-      expect(@reporter.output.string).to eql("original failure info\n  #{CapybaraScreenshot::Helpers.yellow("HTML screenshot: file://path/to/html")}\n  #{CapybaraScreenshot::Helpers.yellow("Image screenshot: file://path/to/image")}\n")
+      expect(@reporter.output.string).to eql("original failure info\n  #{CapybaraScreenshot::Helpers.yellow("HTML screenshot: /path/to/html")}\n  #{CapybaraScreenshot::Helpers.yellow("Image screenshot: /path/to/image")}\n")
     end
   end
 
@@ -91,8 +91,8 @@ describe Capybara::Screenshot::RSpec::TextReporter do
     end
     old_reporter = old_reporter_class.new
     old_reporter.singleton_class.send :include, described_class
-    example = example_failed_method_argument_double(screenshot: { html: "path/to/html" })
+    example = example_failed_method_argument_double(screenshot: { html: "/path/to/html" })
     old_reporter.send(example_failed_method, example)
-    expect(old_reporter.output.string).to eql("original failure info\n  #{CapybaraScreenshot::Helpers.yellow("HTML screenshot: file://path/to/html")}\n")
+    expect(old_reporter.output.string).to eql("original failure info\n  #{CapybaraScreenshot::Helpers.yellow("HTML screenshot: /path/to/html")}\n")
   end
 end

data/spec/unit/s3_saver_spec.rb

@@ -11,6 +11,12 @@ describe Capybara::Screenshot::S3Saver do
   let(:s3_saver) { described_class.new(saver, s3_client, bucket_name, s3_object_configuration) }
   let(:s3_saver_with_key_prefix) { described_class.new(saver, s3_client, bucket_name, s3_object_configuration, key_prefix: key_prefix) }
 
+  let(:region) { double('region') }
+
+  before do
+    allow(s3_client).to receive(:get_bucket_location).and_return(double(:bucket_location_response, location_constraint: region))
+  end
+
   describe '.new_with_configuration' do
     let(:access_key_id) { double('access_key_id') }
     let(:secret_access_key) { double('secret_access_key') }
@@ -21,7 +27,6 @@ describe Capybara::Screenshot::S3Saver do
       }
     }
 
-    let(:region) { double('region') }
     let(:s3_client_credentials) {
       s3_client_credentials_using_defaults.merge(region: region)
     }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: 1.0.21
+  version: 1.0.22
 platform: ruby
 authors:
 - Matthew O'Riordan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2018-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara