percy-capybara 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53f2668e01507cd49c909945a6435742c47a808c
-  data.tar.gz: 4fb5f9a5c161cc8a0a6f86147d488a30a76d93c1
+  metadata.gz: 6c4cebeea7c67b0a6fbd86628017792847e7ba8a
+  data.tar.gz: bcdefb57b54838500ab9c849b3b4a25910114d8e
 SHA512:
-  metadata.gz: 60e77918f3676584e6b9e55945e5faff86d42ec0d440c58f4bb8e0bf555bcb898394ea0974e6392935d23dcb58927f2998e1efea39bc1c852db76072d895b187
-  data.tar.gz: 8ff66916392f263cb3df3ed72b1ac88c6c1da9368daf11f72cd5a909d8f1f65877c1bc77e0aa45ede761a95ff3a0e44e5d05c5b17bd6f36ab7d7eb4df4e3ca74
+  metadata.gz: 72d5dc24fa6e916e0eb2f7986841a7575661707929f2a31abe15cf8451e6848b604c8a3aee09a942d92e1d9dac06ddf8208af501ff7c447d8f4f470954f76dbc
+  data.tar.gz: fb152dd45ec55df52ee62c28610e0d5fd5cb8e9a708f06ecc1fbc5483b38a7472af85341d0cc391a0388905615d383b1d140922c243d962006d4152e791cc5e4

data/Gemfile

@@ -12,3 +12,7 @@ group :test do
   gem 'rubocop', '~> 0.48.0'
   gem 'rubocop-rspec'
 end
+
+group :test, :development do
+  gem 'pry'
+end

data/RELEASING.md

@@ -0,0 +1,17 @@
+# Releasing
+
+1. Update version.rb file accordingly.
+1. Tag the release: `git tag vVERSION`
+1. Push changes: `git push --tags`
+1. Ensure tests have passed on that tag
+1. [Update the release notes](https://github.com/percy/percy-capybara/releases) on GitHub
+1. Build and publish:
+
+```bash
+bundle exec rake build
+gem push pkg/percy-capybara-X.XX.XX.gem
+```
+
+* Announce the new release,
+   making sure to say "thank you" to the contributors
+   who helped shape this version!

data/lib/percy/capybara.rb

@@ -6,8 +6,8 @@ require 'percy/capybara/client'
 module Percy
   module Capybara
     # @see Percy::Capybara::Client
-    def self.capybara_client
-      @capybara_client ||= Percy::Capybara::Client.new
+    def self.capybara_client(options = {})
+      @capybara_client ||= Percy::Capybara::Client.new(options)
     end
 
     # {include:Percy::Capybara::Client::Snapshots#snapshot}
@@ -54,8 +54,7 @@ module Percy
     end
 
     def self.use_loader(loader, options = {})
-      capybara_client.loader = loader
-      capybara_client.loader_options = options
+      capybara_client(loader: loader, 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/client/user_agent'
 require 'percy/capybara/loaders/filesystem_loader'
 require 'percy/capybara/loaders/native_loader'
 require 'percy/capybara/loaders/sprockets_loader'
@@ -10,6 +11,7 @@ module Percy
     class Client
       include Percy::Capybara::Client::Builds
       include Percy::Capybara::Client::Snapshots
+      include Percy::Capybara::Client::UserAgent
 
       class Error < RuntimeError; end
       class BuildNotInitializedError < Error; end
@@ -25,10 +27,12 @@ module Percy
       def initialize(options = {})
         @failed = false
 
-        @client = options[:client] || Percy.client
         @enabled = options[:enabled]
-
         @loader_options = options[:loader_options] || {}
+        @loader = options[:loader]
+
+        @client = options[:client] || \
+          Percy.client(client_info: _client_info, environment_info: _environment_info)
 
         return unless defined?(Rails)
 

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

@@ -0,0 +1,37 @@
+module Percy
+  module Capybara
+    class Client
+      module UserAgent
+        def _client_info
+          "percy-capybara/#{VERSION}"
+        end
+
+        def _environment_info
+          [
+            "percy-capybara-loader/#{loader}",
+            "rails/#{_rails_version}",
+            "sinatra/#{_sinatra_version}",
+            "ember-cli-rails/#{_ember_cli_rails_version}",
+          ].reject do |info|
+            info =~ %r{\/$} # reject if version is empty
+          end.join('; ')
+        end
+
+        def _ember_cli_rails_version
+          return unless defined? EmberCli
+
+          require 'ember_cli/version'
+          EmberCli::VERSION
+        end
+
+        def _rails_version
+          Rails.version if defined? Rails
+        end
+
+        def _sinatra_version
+          Sinatra::VERSION if defined? Sinatra
+        end
+      end
+    end
+  end
+end

data/lib/percy/capybara/version.rb

@@ -1,5 +1,5 @@
 module Percy
   module Capybara
-    VERSION = '3.1.0'.freeze
+    VERSION = '3.1.1'.freeze
   end
 end

data/percy-capybara.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'percy-client', '~> 1.12'
+  spec.add_dependency 'percy-client', '~> 1.13'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'capybara', '~> 2.4'
   spec.add_development_dependency 'poltergeist'
   spec.add_development_dependency 'selenium-webdriver'

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

@@ -0,0 +1,45 @@
+RSpec.describe Percy::Capybara::Client::UserAgent do
+  subject(:client) do
+    Percy::Capybara::Client.new(
+      enabled: true,
+      sprockets_environment: 'test',
+      sprockets_options: 'test',
+    )
+  end
+
+  describe '#_environment_info' do
+    subject(:environment_info) { client._environment_info }
+
+    context 'an app with Rails, Sinatra and Ember Cli Rails' do
+      it 'returns full environment information' do
+        expect(client).to receive(:_rails_version).at_least(:once).times.and_return('4.2')
+        expect(client).to receive(:_sinatra_version).at_least(:once).and_return('2.0.0')
+        expect(client).to receive(:_ember_cli_rails_version).at_least(:once).and_return('0.9')
+
+        expect(environment_info).to eq('rails/4.2; sinatra/2.0.0; ember-cli-rails/0.9')
+      end
+    end
+
+    context 'an app with no known frameworks being used' do
+      it 'returns no environment information' do
+        expect(environment_info).to be_empty
+      end
+    end
+
+    context 'a loader is configured' do
+      before { client.loader = :sprockets_loader }
+
+      it 'includes loader information' do
+        expect(environment_info).to eq('percy-capybara-loader/sprockets_loader')
+      end
+    end
+  end
+
+  describe '#_client_info' do
+    subject(:client_info) { client._client_info }
+
+    it 'includes client information' do
+      expect(client_info).to eq("percy-capybara/#{Percy::Capybara::VERSION}")
+    end
+  end
+end

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

@@ -1,9 +1,4 @@
 RSpec.describe Percy::Capybara::Client do
-  it 'accepts and memoizes a client arg' do
-    client = Percy::Client.new
-    capybara_client = Percy::Capybara::Client.new(client: client)
-    expect(capybara_client.client).to eq(client)
-  end
   describe '#enabled?' do
     context 'when required environment variables set' do
       before { set_required_env_variables }
@@ -13,14 +8,17 @@ RSpec.describe Percy::Capybara::Client do
         ENV['PERCY_ENABLE'] = '1'
         expect(Percy::Capybara::Client.new.enabled?).to eq(true)
       end
+
       it 'is true when PERCY_ENABLE is not set' do
         ENV.delete 'PERCY_ENABLE'
         expect(Percy::Capybara::Client.new.enabled?).to eq(true)
       end
+
       it 'is false when PERCY_ENABLE is 0' do
         ENV['PERCY_ENABLE'] = '0'
         expect(Percy::Capybara::Client.new.enabled?).to eq(false)
       end
+
       it 'raises error if PERCY_TOKEN is set but PERCY_PROJECT is not' do
         ENV.delete 'PERCY_PROJECT'
         expect { Percy::Capybara::Client.new.enabled? }.to raise_error(RuntimeError)
@@ -34,64 +32,90 @@ RSpec.describe Percy::Capybara::Client do
         ENV.delete 'PERCY_ENABLE'
         expect(Percy::Capybara::Client.new.enabled?).to eq(false)
       end
+
       it 'is false when PERCY_ENABLE is 1' do
         ENV['PERCY_ENABLE'] = '1'
         expect(Percy::Capybara::Client.new.enabled?).to eq(false)
       end
     end
   end
+
   describe '#failed?' do
     it 'is false by default' do
       expect(Percy::Capybara::Client.new.failed?).to eq(false)
     end
   end
+
   describe '#rescue_connection_failures' do
     let(:capybara_client) { Percy::Capybara::Client.new(enabled: true) }
 
     it 'returns block result on success' do
-      result = capybara_client.rescue_connection_failures do
-        true
-      end
+      result = capybara_client.rescue_connection_failures { true }
+
       expect(result).to eq(true)
       expect(capybara_client.enabled?).to eq(true)
       expect(capybara_client.failed?).to eq(false)
     end
+
     it 'makes block safe from server errors' do
       result = capybara_client.rescue_connection_failures do
         raise Percy::Client::ServerError.new(500, 'POST', '', '')
       end
+
       expect(result).to eq(nil)
       expect(capybara_client.enabled?).to eq(false)
       expect(capybara_client.failed?).to eq(true)
     end
+
     it 'makes block safe from quota exceeded errors' do
       result = capybara_client.rescue_connection_failures do
         raise Percy::Client::PaymentRequiredError.new(409, 'POST', '', '')
       end
+
       expect(result).to eq(nil)
       expect(capybara_client.enabled?).to eq(false)
       expect(capybara_client.failed?).to eq(true)
     end
+
     it 'makes block safe from ConnectionFailed' do
       result = capybara_client.rescue_connection_failures do
         raise Percy::Client::ConnectionFailed
       end
+
       expect(result).to eq(nil)
       expect(capybara_client.enabled?).to eq(false)
       expect(capybara_client.failed?).to eq(true)
     end
+
     it 'makes block safe from TimeoutError' do
       result = capybara_client.rescue_connection_failures do
         raise Percy::Client::TimeoutError
       end
+
       expect(result).to eq(nil)
       expect(capybara_client.enabled?).to eq(false)
       expect(capybara_client.failed?).to eq(true)
     end
+
     it 'requires a block' do
       expect { capybara_client.rescue_connection_failures }.to raise_error(ArgumentError)
     end
   end
+
+  describe '#initialize' do
+    let(:capybara_client) { Percy::Capybara::Client.new }
+
+    it 'accepts and memoizes a client arg' do
+      client = Percy::Client.new
+      capybara_client = Percy::Capybara::Client.new(client: client)
+      expect(capybara_client.client).to eq(client)
+    end
+
+    it 'passes client info down to the lower level Percy client' do
+      expect(capybara_client.client.client_info).to eq("percy-capybara/#{Percy::Capybara::VERSION}")
+    end
+  end
+
   describe '#initialize_loader' do
     let(:capybara_client) { Percy::Capybara::Client.new }
 

data/spec/lib/percy/capybara_spec.rb

@@ -83,12 +83,16 @@ RSpec.describe Percy::Capybara do
 
     it 'sets the current capybara client\'s loader' do
       expect(Percy::Capybara.capybara_client.loader).not_to be
+      Percy::Capybara.reset!
+
       Percy::Capybara.use_loader(DummyLoader)
       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.reset!
+
       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)

data/spec/spec_helper.rb

@@ -38,7 +38,7 @@ RSpec.configure do |config|
     Capybara::Poltergeist::Driver.new(app, timeout: 1, url_blacklist: ['i.imgur.com'])
   end
 
-  config.before(:each) do
+  config.before do
     WebMock.disable_net_connect!(allow_localhost: true)
   end
   config.before(:each, type: :feature) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-capybara
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-17 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: percy-client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -182,12 +182,14 @@ files:
 - Guardfile
 - LICENSE
 - README.md
+- RELEASING.md
 - Rakefile
 - lib/percy/capybara.rb
 - lib/percy/capybara/anywhere.rb
 - lib/percy/capybara/client.rb
 - lib/percy/capybara/client/builds.rb
 - lib/percy/capybara/client/snapshots.rb
+- lib/percy/capybara/client/user_agent.rb
 - lib/percy/capybara/httpfetcher.rb
 - lib/percy/capybara/loaders/base_loader.rb
 - lib/percy/capybara/loaders/ember_cli_rails_loader.rb
@@ -206,7 +208,6 @@ files:
 - spec/lib/percy/capybara/client/ember_test_data/ember-cli/frontend/percy-frontend-public.svg
 - spec/lib/percy/capybara/client/rails_public_test_data/large-file-skipped.png
 - spec/lib/percy/capybara/client/rails_public_test_data/percy-from-public.svg
-- spec/lib/percy/capybara/client/rails_public_test_data/symlink_to_images
 - spec/lib/percy/capybara/client/snapshots_spec.rb
 - spec/lib/percy/capybara/client/symlink_test_data/test.png
 - spec/lib/percy/capybara/client/test_data/assets/css/digested-f3420c6aee71c137a3ca39727052811bae84b2f37d898f4db242e20656a1579e.css
@@ -237,6 +238,7 @@ files:
 - spec/lib/percy/capybara/client/test_data/test-iframe.html
 - spec/lib/percy/capybara/client/test_data/test-images.html
 - spec/lib/percy/capybara/client/test_data/test-localtest-me-images.html
+- spec/lib/percy/capybara/client/user_agent_spec.rb
 - spec/lib/percy/capybara/client_spec.rb
 - spec/lib/percy/capybara/http_fetcher_spec.rb
 - spec/lib/percy/capybara/loaders/base_loader_spec.rb
@@ -267,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: Percy::Capybara
@@ -281,7 +283,6 @@ test_files:
 - spec/lib/percy/capybara/client/ember_test_data/ember-cli/frontend/percy-frontend-public.svg
 - spec/lib/percy/capybara/client/rails_public_test_data/large-file-skipped.png
 - spec/lib/percy/capybara/client/rails_public_test_data/percy-from-public.svg
-- spec/lib/percy/capybara/client/rails_public_test_data/symlink_to_images
 - spec/lib/percy/capybara/client/snapshots_spec.rb
 - spec/lib/percy/capybara/client/symlink_test_data/test.png
 - spec/lib/percy/capybara/client/test_data/assets/css/digested-f3420c6aee71c137a3ca39727052811bae84b2f37d898f4db242e20656a1579e.css
@@ -312,6 +313,7 @@ test_files:
 - spec/lib/percy/capybara/client/test_data/test-iframe.html
 - spec/lib/percy/capybara/client/test_data/test-images.html
 - spec/lib/percy/capybara/client/test_data/test-localtest-me-images.html
+- spec/lib/percy/capybara/client/user_agent_spec.rb
 - spec/lib/percy/capybara/client_spec.rb
 - spec/lib/percy/capybara/http_fetcher_spec.rb
 - spec/lib/percy/capybara/loaders/base_loader_spec.rb

data/spec/lib/percy/capybara/client/rails_public_test_data/symlink_to_images

@@ -1 +0,0 @@
-spec/lib/percy/capybara/client/rails_public_test_data/../symlink_test_data