percy-capybara 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b9ab13cdb41b837b527594bbe81b6558b62fc5e
-  data.tar.gz: 8a1cb46009774c52c868d8b14ef404b4d3d913a9
+  metadata.gz: f6b29e232904e95b181e02e0381bd459dfd09a49
+  data.tar.gz: e6c802f2770ba1ab8201838b315945adc3b54cf3
 SHA512:
-  metadata.gz: 054078223dae7d409556cae8f308763e3552c5491e29e443a2411f928a23a5272e182e02c9c72b488eedf8f2b593b0830a2580ce7271ef15c4179a42a3f2a078
-  data.tar.gz: 8145c3640a24875a8c10907194a9839da7c3958f97700d6ab338d20aadb65c9e571a04905b583715da78555b072b0f07e7c39c6b73301c7273c28fc3359c49a9
+  metadata.gz: 634f54da9d0ca8f752dc4c3f22fe151072b6064cd8045cb4a7ae280e624dd1090fa5591c898fa57ef83eec37b92049ecafaf44adcd9ef4e84d5af2a0b1b326b7
+  data.tar.gz: 997c23094a26023115a2a3245d3429329829e9136c84f3370aa9d54c75e40f6ccc8a233ab8078ac1acfbbb07bcb764443a832bee2ae3c6e15b316bb1aad83506

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

@@ -11,7 +11,7 @@ module Percy
         URL_REGEX = Regexp.new(
           # protocol identifier
           "(?:(?:https?:)?//)" +
-          "(?:" +
+          "(" +
             # IP address exclusion
             # private & local networks
             "(?!(?:10|127)(?:\\.\\d{1,3}){3})" +
@@ -30,16 +30,19 @@ module Percy
             "(?:(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)" +
             # domain name
             "(?:\\.(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)*" +
-            # TLD identifier
-            "(?:\\.(?:[a-z\\u00a1-\\uffff]{2,}))" +
           ")" +
           # port number
           "(?::\\d{2,5})?" +
           # resource path
           "(?:/[^\\s\"']*)?"
         )
-        PATH_REGEX = /\/[^\\s\"']*/
+        PATH_REGEX = /\A\/[^\\s\"']*/
         DATA_URL_REGEX = /\Adata:/
+        LOCAL_HOSTNAMES = [
+          'localhost',
+          '127.0.0.1',
+          '0.0.0.0',
+        ].freeze
 
         # Takes a snapshot of the given page HTML and its assets.
         #
@@ -135,7 +138,7 @@ module Percy
           resource_urls = _evaluate_script(page, script)
 
           resource_urls.each do |url|
-            next if !_is_valid_url?(url)
+            next if !_should_include_url?(url)
             response = _fetch_resource_url(url)
             next if !response
             sha = Digest::SHA256.hexdigest(response.body)
@@ -201,16 +204,16 @@ module Percy
           end
 
           image_urls.each do |image_url|
-            next if !_is_valid_url?(image_url)
-
             # If url references are blank, browsers will often fill them with the current page's
             # URL, which makes no sense and will never be renderable. Strip these.
-            next if image_url == page.current_url
+            next if image_url == page.current_url || image_url.strip.empty?
 
             # Make the resource URL absolute to the current page. If it is already absolute, this
             # will have no effect.
             resource_url = URI.join(page.current_url, image_url).to_s
 
+            next if !_should_include_url?(resource_url)
+
             # Fetch the images.
             # TODO(fotinakis): this can be pretty inefficient for image-heavy pages because the
             # browser has already loaded them once and this fetch cannot easily leverage the
@@ -228,9 +231,19 @@ module Percy
         private :_get_image_resources
 
         # @private
-        def _is_valid_url?(url)
+        def _should_include_url?(url)
           # It is a URL or a path, but not a data URI.
-          (URL_REGEX.match(url) || PATH_REGEX.match(url)) && !DATA_URL_REGEX.match(url)
+          url_match = URL_REGEX.match(url)
+          data_url_match = DATA_URL_REGEX.match(url)
+          result = (url_match || PATH_REGEX.match(url)) && !data_url_match
+
+          # Is not a remote URL.
+          if url_match && !data_url_match
+            host = url_match[1]
+            result = LOCAL_HOSTNAMES.include?(host)
+          end
+
+          !!result
         end
 
         # @private

data/lib/percy/capybara/version.rb

@@ -1,5 +1,5 @@
 module Percy
   module Capybara
-    VERSION = '0.2.5'
+    VERSION = '0.3.0'
   end
 end

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

@@ -24,7 +24,7 @@ RSpec.describe Percy::Capybara::Client::Snapshots, type: :feature do
   end
   after(:all) { Process.kill('INT', @process.pid) }
 
-  before(:each) do
+  before(:each, js: true) do
     # Special setting for capybara-webkit. If clients are using capybara-webkit they would
     # also have to have this setting enabled since apparently all resources are blocked by default.
     page.driver.respond_to?(:allow_url) && page.driver.allow_url('*')
@@ -38,6 +38,40 @@ RSpec.describe Percy::Capybara::Client::Snapshots, type: :feature do
     end
   end
 
+  describe '#_should_include_url?' do
+    it 'returns true for valid, local URLs' do
+      expect(capybara_client._should_include_url?('http://localhost/')).to eq(true)
+      expect(capybara_client._should_include_url?('http://localhost:123/')).to eq(true)
+      expect(capybara_client._should_include_url?('http://localhost/foo')).to eq(true)
+      expect(capybara_client._should_include_url?('http://localhost:123/foo')).to eq(true)
+      expect(capybara_client._should_include_url?('http://localhost/foo/test.html')).to eq(true)
+      expect(capybara_client._should_include_url?('http://127.0.0.1/')).to eq(true)
+      expect(capybara_client._should_include_url?('http://127.0.0.1:123/')).to eq(true)
+      expect(capybara_client._should_include_url?('http://127.0.0.1/foo')).to eq(true)
+      expect(capybara_client._should_include_url?('http://127.0.0.1:123/foo')).to eq(true)
+      expect(capybara_client._should_include_url?('http://127.0.0.1/foo/test.html')).to eq(true)
+      expect(capybara_client._should_include_url?('http://0.0.0.0/foo/test.html')).to eq(true)
+      # Also works for paths:
+      expect(capybara_client._should_include_url?('/')).to eq(true)
+      expect(capybara_client._should_include_url?('/foo')).to eq(true)
+      expect(capybara_client._should_include_url?('/foo/test.png')).to eq(true)
+    end
+    it 'returns false for invalid URLs' do
+      expect(capybara_client._should_include_url?('')).to eq(false)
+      expect(capybara_client._should_include_url?('http://local host/foo')).to eq(false)
+      expect(capybara_client._should_include_url?('bad-url/')).to eq(false)
+      expect(capybara_client._should_include_url?('bad-url/foo/test.html')).to eq(false)
+    end
+    it 'returns false for data URLs' do
+      expect(capybara_client._should_include_url?('data:image/gif;base64,R0')).to eq(false)
+    end
+    it 'returns false for remote URLs' do
+      expect(capybara_client._should_include_url?('http://foo/')).to eq(false)
+      expect(capybara_client._should_include_url?('http://example.com/')).to eq(false)
+      expect(capybara_client._should_include_url?('http://example.com/foo')).to eq(false)
+      expect(capybara_client._should_include_url?('https://example.com/foo')).to eq(false)
+    end
+  end
   describe '#_get_root_html_resource', type: :feature, js: true do
     it 'includes the root DOM HTML' do
       visit '/'
@@ -82,12 +116,7 @@ RSpec.describe Percy::Capybara::Client::Snapshots, type: :feature do
       expect(resource.content).to include(".colored-by-level2-imports { color: red; }")
       expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
 
-      resource = find_resource(
-        resources, /https:\/\/maxcdn.bootstrapcdn.com\/bootstrap\/3.3.4\/css\/bootstrap.min.css/)
-      expect(resource.content).to include('Bootstrap v3.3.4 (http://getbootstrap.com)')
-      expect(resource.sha).to eq(Digest::SHA256.hexdigest(resource.content))
-
-      expect(resources.length).to eq(7)
+      expect(resources.length).to eq(6)
       expect(resources.collect(&:mimetype).uniq).to eq(['text/css'])
       expect(resources.collect(&:is_root).uniq).to match_array([nil])
     end
@@ -122,13 +151,6 @@ RSpec.describe Percy::Capybara::Client::Snapshots, type: :feature do
       expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
       expect(resource.sha).to eq(expected_sha)
 
-      resource = find_resource(resources, /http:\/\/i.imgur.com\/Umkjdao.png/)
-      content = Faraday.get('http://i.imgur.com/Umkjdao.png').body
-      expect(resource.mimetype).to eq('image/png')
-      expected_sha = Digest::SHA256.hexdigest(content)
-      expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
-      expect(resource.sha).to eq(expected_sha)
-
       resource = find_resource(resources, /http:\/\/localhost:\d+\/images\/bg-relative\.png/)
       content = File.read(File.expand_path('../testdata/images/bg-relative.png', __FILE__))
       expect(resource.mimetype).to eq('image/png')
@@ -143,13 +165,6 @@ RSpec.describe Percy::Capybara::Client::Snapshots, type: :feature do
       expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
       expect(resource.sha).to eq(expected_sha)
 
-      resource = find_resource(resources, /http:\/\/i.imgur.com\/5mLoBs1.png/)
-      content = Faraday.get('http://i.imgur.com/5mLoBs1.png').body
-      expect(resource.mimetype).to eq('image/png')
-      expected_sha = Digest::SHA256.hexdigest(content)
-      expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
-      expect(resource.sha).to eq(expected_sha)
-
       resource = find_resource(resources, /http:\/\/localhost:\d+\/images\/bg-stacked\.png/)
       content = File.read(File.expand_path('../testdata/images/bg-stacked.png', __FILE__))
       expect(resource.mimetype).to eq('image/png')
@@ -157,13 +172,6 @@ RSpec.describe Percy::Capybara::Client::Snapshots, type: :feature do
       expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
       expect(resource.sha).to eq(expected_sha)
 
-      resource = find_resource(resources, /http:\/\/i.imgur.com\/61AQuplb.jpg/)
-      content = Faraday.get('http://i.imgur.com/61AQuplb.jpg').body
-      expect(resource.mimetype).to eq('image/jpeg')
-      expected_sha = Digest::SHA256.hexdigest(content)
-      expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
-      expect(resource.sha).to eq(expected_sha)
-
       resource = find_resource(resources, /http:\/\/localhost:\d+\/images\/srcset-base\.png/)
       content = File.read(File.expand_path('../testdata/images/srcset-base.png', __FILE__))
       expect(resource.mimetype).to eq('image/png')
@@ -185,7 +193,20 @@ RSpec.describe Percy::Capybara::Client::Snapshots, type: :feature do
       expect(Digest::SHA256.hexdigest(resource.content)).to eq(expected_sha)
       expect(resource.sha).to eq(expected_sha)
 
-      expect(resources.length).to eq(12)
+      resource_urls = resources.collect(&:resource_url).map do |url|
+        url.gsub(/localhost:\d+/, 'localhost')
+      end
+      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"
+      ])
       expect(resources.collect(&:is_root).uniq).to match_array([nil])
     end
   end

data/spec/lib/percy/capybara/client/testdata/test-css.html

@@ -4,6 +4,8 @@
   <link href="../css/base.css" rel="stylesheet" type="text/css">
   <link href="/css/simple-imports.css" rel="stylesheet" type="text/css">
   <link href="/css/level0-imports.css" rel="stylesheet" type="text/css">
+
+  <!-- remote resource, ignored -->
   <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css" rel="stylesheet" type="text/css">
   <style>
     .colored-by-inline { color: red; }

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

@@ -9,7 +9,7 @@
   <h2>img local PNG (relative to root)</h2>
   <img src="/images/img-relative-to-root.png">
 
-  <h2>img PNG (remote)</h2>
+  <h2>img PNG (remote, ignored)</h2>
   <img src="http://i.imgur.com/Umkjdao.png">
 
   <h2>img SVG (relative)</h2>
@@ -21,7 +21,7 @@
   <h2>CSS background-image (relative to root)</h2>
   <div style="background-image: url(/images/bg-relative-to-root.png); width: 200px; height: 200px;"></div>
 
-  <h2>CSS background-image (remote)</h2>
+  <h2>CSS background-image (remote, ignored)</h2>
   <div style="background-image: url(http://i.imgur.com/5mLoBs1.png); width: 408px; height: 376px;"></div>
 
   <h2>img data-uri (ignored)</h2>
@@ -30,7 +30,7 @@
   <h2>CSS background-image data-uri (ignored)</h2>
   <div style="background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAABkCAMAAABHPGVmAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAZQTFRFVyxjAAAAmU4baAAAACNJREFUeNrswYEAAAAAw6D5U1/hAFUBAAAAAAAAAAAAjwkwACd0AAGLtJfaAAAAAElFTkSuQmCC); width: 100px; height: 100px;"></div>
 
-  <h2>CSS background stacked (local and remote)</h2>
+  <h2>CSS background stacked (local and remote, remote ignored)</h2>
   <div style="background: url(/images/bg-stacked.png) 200px 200px no-repeat, url('http://i.imgur.com/61AQuplb.jpg'); width: 100px; height: 100px;"></div>
 
   <h2>img srcset</h2>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-capybara
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: percy-client
@@ -204,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Percy::Capybara