percy-capybara 2.3.6 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09d303f9090ad8ce75b13714c58bcec25d711602
-  data.tar.gz: 108512d47e2d4e67e84cdfa2b9456e5368ac58a2
+  metadata.gz: bb10aec66c3c56197c20d065c40d832e877a6f6c
+  data.tar.gz: c0ceaad44d882dd332bc311f9487254ebddd629e
 SHA512:
-  metadata.gz: 67e7111b3708fbad2de5475ee88e8f74b9f47b25a30b66ba06e32372df70d15ccc8fb3d0e43052eeee3b82d1189209326c292691585c8d20b35a0205913184a2
-  data.tar.gz: 2dd5b305baaa6f592c84218537f2d1a125b9a78ffbc6d59bfcf1cf442fba38719edc6006494de46ae6bc6134f900f0f8390feb56515f82e988d731fd7104f42d
+  metadata.gz: 8c77f2d2408b130ae4ddc0da23a4dc57ab2cfb17eeb7d0f70f95856bfd4b5f0d48c55f9098c002c5ff43e233621ab7329034b089dbb8943e132f15b1698a58d8
+  data.tar.gz: 61edd95f68244f5d7b63d169a9da0b95be1743c5ebfeaf96f9f226721467ec059f38d76722bd4b53e4dccf7ee562de2e818fd36647d6e40f0ee8d69df223a310

data/lib/percy/capybara.rb

@@ -53,8 +53,9 @@ module Percy
       capybara_client.disable!
     end
 
-    def self.use_loader(loader)
-      capybara_client.custom_loader = loader
+    def self.use_loader(loader, options = {})
+      capybara_client.loader = loader
+      capybara_client.loader_options = options
     end
   end
 end

data/lib/percy/capybara/client.rb

@@ -1,5 +1,6 @@
 require 'percy/capybara/client/builds'
 require 'percy/capybara/client/snapshots'
+require 'percy/capybara/loaders/filesystem_loader'
 require 'percy/capybara/loaders/native_loader'
 require 'percy/capybara/loaders/sprockets_loader'
 
@@ -17,7 +18,8 @@ module Percy
 
       attr_accessor :sprockets_environment
       attr_accessor :sprockets_options
-      attr_accessor :custom_loader
+      attr_accessor :loader
+      attr_accessor :loader_options
 
       def initialize(options = {})
         @failed = false
@@ -25,6 +27,8 @@ module Percy
         @client = options[:client] || Percy.client
         @enabled = options[:enabled]
 
+        @loader_options = options[:loader_options] || {}
+
         if defined?(Rails)
           @sprockets_environment = options[:sprockets_environment] || Rails.application.assets
           @sprockets_options = options[:sprockets_options] || Rails.application.config.assets
@@ -80,17 +84,34 @@ module Percy
       end
 
       def initialize_loader(options = {})
-        if custom_loader
-          Percy.logger.debug { 'Using a custom loader to discover assets.' }
-          custom_loader.new(options)
+        merged_options = loader_options.merge(options)
+        if loader
+          case loader
+          when :filesystem
+            Percy.logger.debug { 'Using filesystem_loader to discover assets.' }
+            Percy::Capybara::Loaders::FilesystemLoader.new(merged_options)
+          when :native
+            Percy.logger.debug { 'Using native_loader to discover assets (slow).' }
+            Percy::Capybara::Loaders::NativeLoader.new(merged_options)
+          else
+            Percy.logger.debug { 'Using a custom loader to discover assets.' }
+            loader.new(merged_options)
+          end
         elsif sprockets_environment && sprockets_options
           Percy.logger.debug { 'Using sprockets_loader to discover assets.' }
-          options[:sprockets_environment] = sprockets_environment
-          options[:sprockets_options] = sprockets_options
-          Percy::Capybara::Loaders::SprocketsLoader.new(options)
+          merged_options[:sprockets_environment] = sprockets_environment
+          merged_options[:sprockets_options] = sprockets_options
+          Percy::Capybara::Loaders::SprocketsLoader.new(merged_options)
         else
+          unless @warned_about_native_loader
+            Percy.logger.warn \
+              '[DEPRECATED] The native_loader is deprecated and will be opt-in in a future release. ' +
+              'You should move to the faster, more reliable filesystem_loader. See the docs for ' +
+              'Non-Rails frameworks: https://percy.io/docs/clients/ruby/capybara '
+            @warned_about_native_loader = true
+          end
           Percy.logger.debug { 'Using native_loader to discover assets (slower).' }
-          Percy::Capybara::Loaders::NativeLoader.new(options)
+          Percy::Capybara::Loaders::NativeLoader.new(merged_options)
         end
       end
     end

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

@@ -0,0 +1,59 @@
+require 'percy/capybara/loaders/base_loader'
+require 'digest'
+require 'find'
+require 'pathname'
+
+module Percy
+  module Capybara
+    module Loaders
+
+      # Resource loader that looks for resources in the specified folder.
+      class FilesystemLoader < BaseLoader
+        SKIP_RESOURCE_EXTENSIONS = [
+          '.map',  # Ignore source maps.
+          '.gz',  # Ignore gzipped files.
+        ]
+        MAX_FILESIZE_BYTES = 15 * 1024**2  # 15 MB.
+
+        def initialize(options = {})
+          # @assets_dir should point to a _compiled_ static assets directory, not source assets.
+          @assets_dir = options[:assets_dir]
+          @base_url = options[:base_url] || ''
+
+          raise ArgumentError.new('assets_dir is required') if @assets_dir.nil? || @assets_dir == ''
+          if !Pathname.new(@assets_dir).absolute?
+            raise ArgumentError.new("assets_dir needs to be an absolute path. Received: #{@assets_dir}")
+          end
+          if !Dir.exist?(@assets_dir)
+            raise ArgumentError.new("assets_dir provided was not found. Received: #{@assets_dir}")
+          end
+
+          super
+        end
+
+        def snapshot_resources
+          [root_html_resource]
+        end
+
+        def build_resources
+          resources = []
+          Find.find(@assets_dir).each do |path|
+            # Skip directories.
+            next if !FileTest.file?(path)
+            # Skip certain extensions.
+            next if SKIP_RESOURCE_EXTENSIONS.include?(File.extname(path))
+            # Skip large files, these are hopefully downloads and not used in page rendering.
+            next if File.size(path) > MAX_FILESIZE_BYTES
+
+            # Replace the assets_dir with the base_url to generate the resource_url
+            resource_url = path.sub(@assets_dir, @base_url)
+
+            sha = Digest::SHA256.hexdigest(File.read(path))
+            resources << Percy::Client::Resource.new(resource_url, sha: sha, path: path)
+          end
+          resources
+        end
+      end
+    end
+  end
+end

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

@@ -47,7 +47,7 @@ module Percy
 
             if defined?(ActionController)
               # Ask Rails where this asset is (this handles asset_hosts, digest paths, etc.).
-              resource_url = ActionController::Base.helpers.asset_path(logical_path)
+              resource_url = ActionController::Base.helpers.assets_dir(logical_path)
             else
               # TODO: more robust support for Sprockets usage outside Rails, ie Sinatra.
               # How do we find the correct path in that case?

data/lib/percy/capybara/version.rb

@@ -1,5 +1,5 @@
 module Percy
   module Capybara
-    VERSION = '2.3.6'
+    VERSION = '2.4.0'
   end
 end

data/spec/lib/percy/capybara/client_spec.rb

@@ -94,10 +94,27 @@ RSpec.describe Percy::Capybara::Client do
   describe '#initialize_loader' do
     let(:capybara_client) { Percy::Capybara::Client.new }
 
-    context 'when a custom loader has been set' do
+    context 'when loader has been set to :native' do
+      it 'returns a NativeLoader' do
+        capybara_client.loader = :native
+        loader = capybara_client.initialize_loader
+        expect(loader.class).to eq(Percy::Capybara::Loaders::NativeLoader)
+      end
+    end
+
+    context 'when loader has been set to :filesystem' do
+      it 'returns a FilesystemLoader' do
+        capybara_client.loader = :filesystem
+        capybara_client.loader_options = {assets_dir: '/', base_url: '/'}
+        loader = capybara_client.initialize_loader
+        expect(loader.class).to eq(Percy::Capybara::Loaders::FilesystemLoader)
+      end
+    end
+
+    context 'when loader has been set to a class' do
       it 'returns an instance of the clients custom loader' do
         class DummyLoader < Percy::Capybara::Loaders::NativeLoader; end
-        capybara_client.custom_loader = DummyLoader
+        capybara_client.loader = DummyLoader
         loader = capybara_client.initialize_loader
         expect(loader.class).to eq(DummyLoader)
       end
@@ -117,5 +134,17 @@ RSpec.describe Percy::Capybara::Client do
         expect(capybara_client.initialize_loader.class).to eq(Percy::Capybara::Loaders::NativeLoader)
       end
     end
+
+    context 'when loader_options are set' do
+      let(:loader_class) { Percy::Capybara::Loaders::FilesystemLoader }
+      let(:options) { {assets_dir: 'xyz'} }
+
+      it 'initializes the loader with them' do
+        capybara_client.loader = :filesystem
+        capybara_client.loader_options = options
+        expect(loader_class).to receive(:new).with(options).once
+        capybara_client.initialize_loader
+      end
+    end
   end
 end

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

@@ -0,0 +1,113 @@
+RSpec.describe Percy::Capybara::Loaders::FilesystemLoader do
+  let(:fake_page) { OpenStruct.new(current_url: 'http://localhost/foo') }
+  let(:assets_dir) { File.expand_path('../../client/testdata', __FILE__) }
+  let(:base_url) { '/url-prefix' }
+  let(:loader) { described_class.new(base_url: base_url, assets_dir: assets_dir, page: fake_page) }
+
+  describe 'initialize' do
+    context 'assets_dir not specified' do
+      let(:assets_dir) { nil }
+      it 'raises an error' do
+        expect { loader }.to raise_error(ArgumentError)
+      end
+    end
+    context 'assets_dir is not an absolute path' do
+      let(:assets_dir) { '../../client/testdata' }
+      it 'raises an error' do
+        expect { loader }.to raise_error(ArgumentError)
+      end
+    end
+    context 'assets_dir doesn\'t exist' do
+      let(:assets_dir) { File.expand_path("../../client/testdata-doesnt-exist", __FILE__) }
+      it 'raises an error' do
+        expect { loader }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#snapshot_resources', type: :feature, js: true do
+    it 'returns the root HTML' do
+      visit '/'
+      loader = described_class.new(base_url: base_url, assets_dir: assets_dir, page: page)
+      expect(loader.snapshot_resources.collect(&:resource_url)).to match_array(['/'])
+    end
+    it 'returns the visited html resource' do
+      visit '/test-css.html'
+      loader = described_class.new(base_url: base_url, assets_dir: assets_dir, page: page)
+      resource_urls = loader.snapshot_resources.collect(&:resource_url)
+      expect(resource_urls).to match_array(['/test-css.html'])
+    end
+  end
+
+  describe '#build_resources' do
+    context 'assets_dir including all test files' do
+      it 'returns all included assets as resources' do
+        actual_paths = loader.build_resources.collect { |resource| resource.path.gsub(assets_dir, '') }
+        expected_paths = [
+          '/assets/css/digested-f3420c6aee71c137a3ca39727052811bae84b2f37d898f4db242e20656a1579e.css',
+          '/css/base.css',
+          '/css/digested.css',
+          '/css/imports.css',
+          '/css/level0-imports.css',
+          '/css/level1-imports.css',
+          '/css/level2-imports.css',
+          '/css/simple-imports.css',
+          '/iframe.html',
+          '/images/bg-relative-to-root.png',
+          '/images/bg-relative.png',
+          '/images/bg-stacked.png',
+          '/images/img-relative-to-root.png',
+          '/images/img-relative.png',
+          '/images/percy.svg',
+          '/images/srcset-base.png',
+          '/images/srcset-first.png',
+          '/images/srcset-second.png',
+          '/index.html',
+          '/js/base.js',
+          '/public/percy-from-public.svg',
+          '/test-css.html',
+          '/test-iframe.html',
+          '/test-images.html',
+          '/test-localtest-me-images.html',
+        ]
+        expect(actual_paths).to eq(expected_paths)
+
+        expected_urls = loader.build_resources.collect { |resource| resource.resource_url }
+        actual_urls = [
+          '/url-prefix/assets/css/digested-f3420c6aee71c137a3ca39727052811bae84b2f37d898f4db242e20656a1579e.css',
+          '/url-prefix/css/base.css',
+          '/url-prefix/css/digested.css',
+          '/url-prefix/css/imports.css',
+          '/url-prefix/css/level0-imports.css',
+          '/url-prefix/css/level1-imports.css',
+          '/url-prefix/css/level2-imports.css',
+          '/url-prefix/css/simple-imports.css',
+          '/url-prefix/iframe.html',
+          '/url-prefix/images/bg-relative-to-root.png',
+          '/url-prefix/images/bg-relative.png',
+          '/url-prefix/images/bg-stacked.png',
+          '/url-prefix/images/img-relative-to-root.png',
+          '/url-prefix/images/img-relative.png',
+          '/url-prefix/images/percy.svg',
+          '/url-prefix/images/srcset-base.png',
+          '/url-prefix/images/srcset-first.png',
+          '/url-prefix/images/srcset-second.png',
+          '/url-prefix/index.html',
+          '/url-prefix/js/base.js',
+          '/url-prefix/public/percy-from-public.svg',
+          '/url-prefix/test-css.html',
+          '/url-prefix/test-iframe.html',
+          '/url-prefix/test-images.html',
+          '/url-prefix/test-localtest-me-images.html',
+        ]
+        expect(actual_urls).to eq(expected_urls)
+      end
+    end
+    context 'assets_dir with only skippable resources' do
+      let(:assets_dir) { File.expand_path('../../client/testdata/assets/images', __FILE__) }
+      it 'returns an empty list' do
+        expect(loader.build_resources).to eq([])
+      end
+    end
+  end
+end

data/spec/lib/percy/capybara_spec.rb

@@ -70,7 +70,7 @@ RSpec.describe Percy::Capybara do
   end
   describe '#disable!' do
     it 'sets the current capybara_client to disabled' do
-      capybara_client = Percy::Capybara::Client.new(enabled:true)
+      capybara_client = Percy::Capybara::Client.new(enabled: true)
       expect(Percy::Capybara).to receive(:capybara_client)
         .and_return(capybara_client).exactly(3).times
       expect(Percy::Capybara.capybara_client.enabled?).to eq(true)
@@ -81,10 +81,17 @@ RSpec.describe Percy::Capybara do
   describe '#use_loader' do
     class DummyLoader < Percy::Capybara::Loaders::NativeLoader; end
 
-    it 'sets the current capybara clients custom loader' do
-      expect(Percy::Capybara.capybara_client.custom_loader).to_not be
+    it 'sets the current capybara client\'s loader' do
+      expect(Percy::Capybara.capybara_client.loader).to_not be
       Percy::Capybara.use_loader(DummyLoader)
-      expect(Percy::Capybara.capybara_client.custom_loader).to be
+      expect(Percy::Capybara.capybara_client.loader).to be
+    end
+
+    it 'sets the current capybara client\'s loader options' do
+      expect(Percy::Capybara.capybara_client.loader_options).to eq({})
+      Percy::Capybara.use_loader(DummyLoader, {test_option: 3})
+      expect(Percy::Capybara.capybara_client.loader_options).to be
+      expect(Percy::Capybara.capybara_client.loader_options[:test_option]).to eq(3)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-capybara
 version: !ruby/object:Gem::Version
-  version: 2.3.6
+  version: 2.4.0
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-26 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: percy-client
@@ -187,6 +187,7 @@ files:
 - lib/percy/capybara/client/snapshots.rb
 - lib/percy/capybara/httpfetcher.rb
 - lib/percy/capybara/loaders/base_loader.rb
+- lib/percy/capybara/loaders/filesystem_loader.rb
 - lib/percy/capybara/loaders/native_loader.rb
 - lib/percy/capybara/loaders/sprockets_loader.rb
 - lib/percy/capybara/rspec.rb
@@ -225,6 +226,7 @@ files:
 - spec/lib/percy/capybara/client_spec.rb
 - spec/lib/percy/capybara/httpfetcher_spec.rb
 - spec/lib/percy/capybara/loaders/base_loader_spec.rb
+- spec/lib/percy/capybara/loaders/filesystem_loader_spec.rb
 - spec/lib/percy/capybara/loaders/native_loader_spec.rb
 - spec/lib/percy/capybara/loaders/sprockets_loader_spec.rb
 - spec/lib/percy/capybara_spec.rb
@@ -250,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: Percy::Capybara
@@ -288,6 +290,7 @@ test_files:
 - spec/lib/percy/capybara/client_spec.rb
 - spec/lib/percy/capybara/httpfetcher_spec.rb
 - spec/lib/percy/capybara/loaders/base_loader_spec.rb
+- spec/lib/percy/capybara/loaders/filesystem_loader_spec.rb
 - spec/lib/percy/capybara/loaders/native_loader_spec.rb
 - spec/lib/percy/capybara/loaders/sprockets_loader_spec.rb
 - spec/lib/percy/capybara_spec.rb