percy-capybara 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c2619a9098477489f443eed78751adf81401c66
-  data.tar.gz: 0c41b94845f31ddd1fe133c49749cd2bd76b36af
+  metadata.gz: faafc67e726d7df13e2553551a48e84f1a305be3
+  data.tar.gz: dd4544479963729d3a813dfde0596a59c041a07d
 SHA512:
-  metadata.gz: 0dc1613a5a0614815620e004be594d50a833e0ffc2dda8633b9c61ab41a750062fc88f4aea5e7e81b0ba408060637eff0fc28bfd1f20d0727e863a7b1190b78a
-  data.tar.gz: 7f58f3e80ceffcb84feea0403f0f93bfe6d94e66cfbfeb15dd152ba03ebc82907783bb9c8495a6ed289bf0d8509405ae5119a05d2813155d1817314f0933cea4
+  metadata.gz: eeebe611d3e3314a7c51a3da0949c9093f8726aa97169b53957712d3ee8cb5e3bd2befffbd8d9ff913d130af4938e69b947e7d193411fffbe5fa2e1e177ff91d
+  data.tar.gz: b4f548b486353e57ceb41447e18096e16cfe26fa6698a4ba8d8a6d63b8ec519737011804d02eb3410acf3662132e56fc9a7d2bce6cca11e91b9ec5ab8b02c1bd

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

@@ -2,14 +2,44 @@ module Percy
   module Capybara
     class Client
       module Builds
-        def current_build(options = {})
+        def initialize_build(options = {})
           return if !enabled?  # Silently skip if the client is disabled.
-          @current_build ||= client.create_build(client.config.repo, options)
+          return @current_build if build_initialized?
+
+          # Gather build resources to upload with build.
+          start = Time.now
+          build_resources = options[:build_resources] || initialize_loader.build_resources
+          options[:resources] = build_resources if !build_resources.empty?
+
+          # Extra debug info.
+          build_resources.each { |br| Percy.logger.debug { "Build resource: #{br.resource_url}" } }
+          Percy.logger.debug { "All build resources loaded (#{Time.now - start}s)" }
+
+          @current_build = client.create_build(client.config.repo, options)
+          _upload_missing_build_resources(build_resources) if !build_resources.empty?
           @current_build
         end
-        alias_method :initialize_build, :current_build
 
-        def upload_missing_build_resources(build_resources)
+        def current_build
+          return if !enabled?  # Silently skip if the client is disabled.
+          @current_build
+        end
+
+        def build_initialized?
+          !!@current_build
+        end
+
+        def finalize_current_build
+          return if !enabled?  # Silently skip if the client is disabled.
+          if !build_initialized?
+            raise Percy::Capybara::Client::BuildNotInitializedError.new(
+              'Failed to finalize build because no build has been initialized.')
+          end
+          client.finalize_build(current_build['data']['id'])
+        end
+
+        # @private
+        def _upload_missing_build_resources(build_resources)
           # Upload any missing build resources.
           new_build_resources = current_build['data'] &&
             current_build['data']['relationships'] &&
@@ -28,19 +58,7 @@ module Percy
           end
           new_build_resources.length
         end
-
-        def build_initialized?
-          !!@current_build
-        end
-
-        def finalize_current_build
-          return if !enabled?  # Silently skip if the client is disabled.
-          if !build_initialized?
-            raise Percy::Capybara::Client::BuildNotInitializedError.new(
-              'Failed to finalize build because no build has been initialized.')
-          end
-          client.finalize_build(current_build['data']['id'])
-        end
+        private :_upload_missing_build_resources
       end
     end
   end

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

@@ -26,7 +26,14 @@ module Percy
           Percy.logger.debug { "Snapshot started (name: #{name.inspect})" }
 
           # If this is the first snapshot, create the build and upload build resources.
+          # DEPRECATED: this flow is for the pre-parallel world.
           if !build_initialized?
+            Percy.logger.warn do
+              "DEPRECATED: percy-capybara will remove implicitly created builds. You should " +
+              "update your usage to call initialize_build explicitly at the start of a test " +
+              "suite, or to use the Percy RSpec setup to do it for you."
+            end
+
             start = Time.now
             build_resources = loader.build_resources
             if Percy.config.debug
@@ -36,7 +43,7 @@ module Percy
             end
             Percy.logger.debug { "All build resources loaded (#{Time.now - start}s)" }
             initialize_build(resources: build_resources)
-            upload_missing_build_resources(build_resources)
+            _upload_missing_build_resources(build_resources)
           end
 
           start = Time.now

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

@@ -63,6 +63,11 @@ module Percy
           current_url = page.current_url
           url_match = URL_REGEX.match(current_url)
           return url_match[4] if url_match
+
+          # Special case: prepend a slash to the path to force a valid URL for things like
+          # "about:srcdoc" iframe srcdoc pages.
+          current_url = "/#{current_url}" if current_url[0] != '/'
+
           current_url
         end
       end

data/lib/percy/capybara/rspec.rb

@@ -1,5 +1,6 @@
 require 'rspec/core'
 
 RSpec.configure do |config|
+  config.before(:suite) { Percy::Capybara.initialize_build }
   config.after(:suite) { Percy::Capybara.finalize_build }
 end

data/lib/percy/capybara/version.rb

@@ -1,5 +1,5 @@
 module Percy
   module Capybara
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end
 end

data/percy-capybara.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'percy-client', '>= 0.8.0'
+  spec.add_dependency 'percy-client', '>= 0.10.0'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'

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

@@ -1,13 +1,37 @@
 RSpec.describe Percy::Capybara::Client::Builds do
-  let(:capybara_client) { Percy::Capybara::Client.new(enabled: true) }
+  let(:enabled) { true }
+  let(:capybara_client) { Percy::Capybara::Client.new(enabled: enabled) }
 
+  describe '#initialize_build' do
+    context 'percy is not enabled' do
+      let(:enabled) { false }
+      it 'returns nil if not enabled' do
+        expect(capybara_client.initialize_build).to be_nil
+      end
+    end
+    it 'initializes and returns a build' do
+      mock_response = {
+        'data' => {
+          'id' => '123',
+          'type' => 'builds',
+        },
+      }
+      stub_request(:post, 'https://percy.io/api/v1/repos/percy/percy-capybara/builds/')
+        .to_return(status: 201, body: mock_response.to_json)
+      expect(capybara_client.initialize_build).to eq(mock_response)
+    end
+  end
   describe '#current_build' do
-    it 'returns the current build or creates a new one' do
+    it 'returns nil if no build has been initialized' do
+      expect(capybara_client.current_build).to be_nil
+    end
+    it 'returns the current build' do
       mock_double = double('build')
       expect(capybara_client.client).to receive(:create_build)
         .with(capybara_client.client.config.repo, {})
         .and_return(mock_double)
         .once
+      capybara_client.initialize_build
 
       current_build = capybara_client.current_build
       expect(current_build).to eq(mock_double)
@@ -15,7 +39,31 @@ RSpec.describe Percy::Capybara::Client::Builds do
       expect(current_build).to eq(mock_double)
     end
   end
-  describe '#upload_missing_build_resources', type: :feature, js: true do
+  describe '#build_initialized?' do
+    it 'is false before a build is initialized and true afterward' do
+      expect(capybara_client.client).to receive(:create_build).and_return(double('build'))
+      expect(capybara_client.build_initialized?).to be_falsey
+
+      capybara_client.initialize_build
+      expect(capybara_client.build_initialized?).to be_truthy
+    end
+  end
+  describe '#finalize_current_build' do
+    it 'finalizes the current build' do
+      build_data = {'data' => {'id' => 123}}
+      expect(capybara_client.client).to receive(:create_build).and_return(build_data)
+      capybara_client.initialize_build
+
+      expect(capybara_client.client).to receive(:finalize_build).with(123)
+      capybara_client.finalize_current_build
+    end
+    it 'raises an error if no current build exists' do
+      expect do
+        capybara_client.finalize_current_build
+      end.to raise_error(Percy::Capybara::Client::BuildNotInitializedError)
+    end
+  end
+  describe '#_upload_missing_build_resources', type: :feature, js: true do
     before(:each) { setup_sprockets(capybara_client) }
 
     it 'returns 0 if there are no missing build resources to upload' do
@@ -27,9 +75,10 @@ RSpec.describe Percy::Capybara::Client::Builds do
       }
       stub_request(:post, 'https://percy.io/api/v1/repos/percy/percy-capybara/builds/')
         .to_return(status: 201, body: mock_response.to_json)
+      capybara_client.initialize_build
 
       loader = capybara_client.initialize_loader
-      expect(capybara_client.upload_missing_build_resources(loader.build_resources)).to eq(0)
+      expect(capybara_client.send(:_upload_missing_build_resources, loader.build_resources)).to eq(0)
     end
     it 'uploads missing resources and returns the number uploaded' do
       visit '/'
@@ -55,37 +104,14 @@ RSpec.describe Percy::Capybara::Client::Builds do
       # Stub create build.
       stub_request(:post, 'https://percy.io/api/v1/repos/percy/percy-capybara/builds/')
         .to_return(status: 201, body: mock_response.to_json)
-      capybara_client.initialize_build
 
       # Stub resource upload.
       stub_request(:post, "https://percy.io/api/v1/builds/123/resources/")
         .to_return(status: 201, body: {success: true}.to_json)
-      result = capybara_client.upload_missing_build_resources(loader.build_resources)
-      expect(result).to eq(1)
-    end
-  end
-  describe '#build_initialized?' do
-    it 'is false before a build is initialized and true afterward' do
-      expect(capybara_client.client).to receive(:create_build).and_return(double('build'))
-      expect(capybara_client.build_initialized?).to be_falsey
-
       capybara_client.initialize_build
-      expect(capybara_client.build_initialized?).to be_truthy
+      result = capybara_client.send(:_upload_missing_build_resources, loader.build_resources)
+      expect(result).to eq(1)
     end
   end
-  describe '#finalize_current_build' do
-    it 'finalizes the current build' do
-      build_data = {'data' => {'id' => 123}}
-      expect(capybara_client.client).to receive(:create_build).and_return(build_data)
-      capybara_client.initialize_build
 
-      expect(capybara_client.client).to receive(:finalize_build).with(123)
-      capybara_client.finalize_current_build
-    end
-    it 'raises an error if no current build exists' do
-      expect do
-        capybara_client.finalize_current_build
-      end.to raise_error(Percy::Capybara::Client::BuildNotInitializedError)
-    end
-  end
 end

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

@@ -45,6 +45,10 @@ RSpec.describe Percy::Capybara::Loaders::BaseLoader do
       expect(page_double).to receive(:current_url).and_return('http://www.example.com/')
       loader = described_class.new(page: page_double)
       expect(loader.current_path).to eq('/')
+
+      expect(page_double).to receive(:current_url).and_return('about:srcdoc')
+      loader = described_class.new(page: page_double)
+      expect(loader.current_path).to eq('/about:srcdoc')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-capybara
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2015-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: percy-client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement