percy-capybara 2.3.2 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 081b5260631b9369dc527a54f3645002493bf642
-  data.tar.gz: 39f8bb11b13526dee9f3b79ab6539434316a4210
+  metadata.gz: 4e5d969e6040123759001a610740fe46115eb5c8
+  data.tar.gz: 64345632abd3e80a2216bcd5f8b912be6c30718a
 SHA512:
-  metadata.gz: 44f8f17998d28fbccf9a738b9902d72e06647d4454e76646d3ace5fe3a482df0edd912d8784cfecf6272226222afbc958682efe845df2da72151a72c79b16ca4
-  data.tar.gz: 012a9b6fcec664d54893f74fc8dedac59f14723a126cf1b66a5b51aa7f3552b96ede8bbf64bc3483fc8546e69da957999c8e984f38a069899a23e589b914b758
+  metadata.gz: 4d876fa8b49fb2f66979cdaac78e7051ba294087f3747cf97cffc94240d48b8e503866d1ee9173cda6d4534cf3c4f6f12c4a1a42ebcfe4f180ae14708926ae73
+  data.tar.gz: 60be216d386341d9428a535406ba309116c086a5e1cc18e18b08218133fdcdd8f96f003f39dd4c857e5ffe1e1a1affb7066b9394934932a4b2d49f32f617c915

data/.gitignore

@@ -13,3 +13,4 @@
 *.rbc
 mkmf.log
 .DS_Store
+Gemfile.lock

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    percy-capybara (2.3.2)
+    percy-capybara (2.3.3)
       percy-client (~> 1.9)
 
 GEM

data/lib/percy/capybara/client/snapshots.rb

@@ -14,6 +14,14 @@ module Percy
         def snapshot(page, options = {})
           return if !enabled?  # Silently skip if the client is disabled.
 
+          if current_build.nil?
+            raise RuntimeError.new(
+              'Whoops! Percy is enabled, but Percy::Capybara.initialize_build was never called. ' +
+              'Did you forget to setup Percy in your spec_helper.rb? ' +
+              'See: https://percy.io/docs/clients/ruby/capybara'
+            )
+          end
+
           loader = initialize_loader(page: page)
 
           Percy.logger.debug { "Snapshot started (name: #{options[:name].inspect})" }

data/lib/percy/capybara/loaders/native_loader.rb

@@ -75,6 +75,7 @@ module Percy
           resource_urls.each do |url|
             next if !_should_include_url?(url)
             response = _fetch_resource_url(url)
+            _absolute_url_to_relative!(url, _current_host_port)
             next if !response
             sha = Digest::SHA256.hexdigest(response.body)
             resources << Percy::Client::Resource.new(
@@ -160,6 +161,7 @@ module Percy
             # browser's cache. However, often these images are probably local resources served by a
             # development server, so it may not be so bad. Re-evaluate if this becomes an issue.
             response = _fetch_resource_url(resource_url)
+            _absolute_url_to_relative!(resource_url, _current_host_port)
             next if !response
 
             sha = Digest::SHA256.hexdigest(response.body)
@@ -202,11 +204,29 @@ module Percy
           # Is not a remote URL.
           if url_match && !data_url_match
             host = url_match[2]
-            result = LOCAL_HOSTNAMES.include?(host)
+            result = LOCAL_HOSTNAMES.include?(host) || _same_server?(url, _current_host_port)
           end
 
           !!result
         end
+
+        # @priivate
+        def _current_host_port
+          url_match = URL_REGEX.match(page.current_url)
+          host_port = url_match[1] + url_match[2] + (url_match[3] || '')
+        end
+
+        # @private
+        def _same_server?(url, host_port)
+          url.start_with?(host_port + "/") || url == host_port
+        end
+
+        # @private
+        def _absolute_url_to_relative!(url, host_port)
+          url.gsub!(host_port + '/','/') if url.start_with?(host_port + "/")
+        end
+        private :_absolute_url_to_relative!
+
       end
     end
   end

data/lib/percy/capybara/version.rb

@@ -1,5 +1,5 @@
 module Percy
   module Capybara
-    VERSION = '2.3.2'
+    VERSION = '2.3.3'
   end
 end

data/spec/lib/percy/capybara/client/snapshots_spec.rb

@@ -65,6 +65,10 @@ RSpec.describe Percy::Capybara::Client::Snapshots, type: :feature do
           .and_call_original
         expect(capybara_client.snapshot(page)).to eq(true)
       end
+      it 'errors if build is not created' do
+        capybara_client = Percy::Capybara::Client.new(enabled: true)
+        expect { capybara_client.snapshot(page) }.to raise_error(RuntimeError)
+      end
       it 'passes through options to the percy client if given' do
         expect(capybara_client.client).to receive(:create_snapshot)
           .with(anything, anything, {name: 'foo', widths: [320, 1024], enable_javascript: true})

data/spec/lib/percy/capybara/client/testdata/test-localtest-me-images.html

@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html>
+  <title>Test Percy::Capybara</title>
+  <h1>Test images</h1>
+
+  <h2>img local PNG (relative)</h2>
+  <img src="/images/img-relative.png"></img>
+</html>

data/spec/lib/percy/capybara/loaders/native_loader_spec.rb

@@ -1,5 +1,6 @@
 RSpec.describe Percy::Capybara::Loaders::NativeLoader do
-  let(:loader) { described_class.new(page: nil) }
+  let(:fake_page) { OpenStruct.new(current_url: "http://localhost/foo")}
+  let(:loader) { described_class.new(page: fake_page) }
 
   describe '#build_resources' do
     it 'returns an empty list' do
@@ -15,37 +16,52 @@ RSpec.describe Percy::Capybara::Loaders::NativeLoader do
     it 'returns the root HTML and CSS resources' do
       visit '/test-css.html'
       loader = described_class.new(page: page)
-      resource_urls = loader.snapshot_resources.collect(&:resource_url).map do |url|
-        url.gsub(/localhost:\d+/, 'localhost')
-      end
+      resource_urls = loader.snapshot_resources.collect(&:resource_url)
       expect(resource_urls).to match_array([
         "/test-css.html",
-        "http://localhost/css/base.css",
-        "http://localhost/css/imports.css",
-        "http://localhost/css/level0-imports.css",
-        "http://localhost/css/level1-imports.css",
-        "http://localhost/css/level2-imports.css",
-        "http://localhost/css/simple-imports.css",
+        "/css/base.css",
+        "/css/imports.css",
+        "/css/level0-imports.css",
+        "/css/level1-imports.css",
+        "/css/level2-imports.css",
+        "/css/simple-imports.css",
       ])
     end
     it 'returns the root HTML and image resources' do
       visit '/test-images.html'
       loader = described_class.new(page: page)
-      resource_urls = loader.snapshot_resources.collect(&:resource_url).map do |url|
-        url.gsub(/localhost:\d+/, 'localhost')
-      end
+      resource_urls = loader.snapshot_resources.collect(&:resource_url)
       expect(resource_urls).to match_array([
         "/test-images.html",
-        "http://localhost/images/img-relative.png",
-        "http://localhost/images/img-relative-to-root.png",
-        "http://localhost/images/percy.svg",
-        "http://localhost/images/srcset-base.png",
-        "http://localhost/images/srcset-first.png",
-        "http://localhost/images/srcset-second.png",
-        "http://localhost/images/bg-relative.png",
-        "http://localhost/images/bg-relative-to-root.png",
-        "http://localhost/images/bg-stacked.png"
+        "/images/img-relative.png",
+        "/images/img-relative-to-root.png",
+        "/images/percy.svg",
+        "/images/srcset-base.png",
+        "/images/srcset-first.png",
+        "/images/srcset-second.png",
+        "/images/bg-relative.png",
+        "/images/bg-relative-to-root.png",
+        "/images/bg-stacked.png"
+      ])
+    end
+  end
+  describe "nonlocal.me", type: :feature, js: true do
+    before :each do
+      @orig_app_host = Capybara.app_host
+      Capybara.app_host = Capybara.app_host.gsub('http://localhost:', 'http://localtest.me:')
+    end
+    after :each do
+      Capybara.app_host = @orig_app_host
+    end
+    it 'returns the root HTML and image resources' do
+      visit '/test-localtest-me-images.html'
+      loader = described_class.new(page: page)
+      resource_urls = loader.snapshot_resources.collect(&:resource_url)
+      expect(resource_urls).to eq([
+        "/test-localtest-me-images.html",
+        "/images/img-relative.png"
       ])
+      expect(loader.snapshot_resources.collect(&:is_root)).to eq([true,nil])
     end
   end
   describe '#_should_include_url?' do
@@ -81,6 +97,23 @@ RSpec.describe Percy::Capybara::Loaders::NativeLoader do
       expect(loader._should_include_url?('http://example.com/foo')).to eq(false)
       expect(loader._should_include_url?('https://example.com/foo')).to eq(false)
     end
+    context "for nonlocal hosts" do
+      let(:fake_page) { OpenStruct.new(current_url: "http://foo:123/") }
+      it "returns true for the same host port" do
+        expect(loader._should_include_url?('http://foo:123/')).to eq(true)
+        expect(loader._should_include_url?('http://foo:123/bar')).to eq(true)
+      end
+      it "returns false for different port" do
+        expect(loader._should_include_url?('http://foo/')).to eq(false)
+        expect(loader._should_include_url?('http://foo/bar')).to eq(false)
+        expect(loader._should_include_url?('http://foo:1234/')).to eq(false)
+        expect(loader._should_include_url?('http://foo:1234/bar')).to eq(false)
+      end
+      it "returns false for different host" do
+        expect(loader._should_include_url?('http://afoo:123/')).to eq(false)
+        expect(loader._should_include_url?('http://afoo:123/bar')).to eq(false)
+      end
+    end
   end
   describe '#_get_css_resources', type: :feature, js: true do
     it 'includes all linked and imported stylesheets' do
@@ -204,19 +237,17 @@ RSpec.describe Percy::Capybara::Loaders::NativeLoader do
       expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
       expect(resource.sha).to eq(expected_sha)
 
-      resource_urls = resources.collect(&:resource_url).map do |url|
-        url.gsub(/localhost:\d+/, 'localhost')
-      end
+      resource_urls = resources.collect(&:resource_url)
       expect(resource_urls).to match_array([
-        "http://localhost/images/img-relative.png",
-        "http://localhost/images/img-relative-to-root.png",
-        "http://localhost/images/percy.svg",
-        "http://localhost/images/srcset-base.png",
-        "http://localhost/images/srcset-first.png",
-        "http://localhost/images/srcset-second.png",
-        "http://localhost/images/bg-relative.png",
-        "http://localhost/images/bg-relative-to-root.png",
-        "http://localhost/images/bg-stacked.png"
+        "/images/img-relative.png",
+        "/images/img-relative-to-root.png",
+        "/images/percy.svg",
+        "/images/srcset-base.png",
+        "/images/srcset-first.png",
+        "/images/srcset-second.png",
+        "/images/bg-relative.png",
+        "/images/bg-relative-to-root.png",
+        "/images/bg-stacked.png"
       ])
       expect(resources.collect(&:is_root).uniq).to match_array([nil])
     end

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ require 'percy/capybara'
 
 Capybara::Webkit.configure do |config|
   # config.allow_url("*")
+  config.allow_url('localtest.me')
   config.block_unknown_urls
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-capybara
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.3
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: percy-client
@@ -221,6 +221,7 @@ files:
 - spec/lib/percy/capybara/client/testdata/test-css.html
 - spec/lib/percy/capybara/client/testdata/test-iframe.html
 - spec/lib/percy/capybara/client/testdata/test-images.html
+- spec/lib/percy/capybara/client/testdata/test-localtest-me-images.html
 - spec/lib/percy/capybara/client_spec.rb
 - spec/lib/percy/capybara/httpfetcher_spec.rb
 - spec/lib/percy/capybara/loaders/base_loader_spec.rb
@@ -249,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Percy::Capybara
@@ -283,6 +284,7 @@ test_files:
 - spec/lib/percy/capybara/client/testdata/test-css.html
 - spec/lib/percy/capybara/client/testdata/test-iframe.html
 - spec/lib/percy/capybara/client/testdata/test-images.html
+- spec/lib/percy/capybara/client/testdata/test-localtest-me-images.html
 - spec/lib/percy/capybara/client_spec.rb
 - spec/lib/percy/capybara/httpfetcher_spec.rb
 - spec/lib/percy/capybara/loaders/base_loader_spec.rb