percy-capybara 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a138585a2c8cb1eda5cad2d69fe5462824f99718
-  data.tar.gz: 454f5f69e67bee8a859d8bc678c4c66e2d3b9376
+  metadata.gz: e3dce95f1470e064a58efea7de8c8e324ce26cd2
+  data.tar.gz: 25cc759cc54c27a9519b42bf4e582e86d1879f85
 SHA512:
-  metadata.gz: a7a87b43488b3c31826f6162c547aa926c2ee097e2650e10186ef53ed480d04d73c2c39bbd48502f86172c179529ec3dcd8d4ea5efc19d85570cc4159e2882bd
-  data.tar.gz: 9976e107091eb0476bceccdbf80039e360287dd3d375a78caf3a8a2eba31068fa5c69bb5bbe99195284907de7dae0897fc289c7ece78d261aea4a2015974e487
+  metadata.gz: fcc5c0a05c238b73155485b9bd3917755f647bdfc0945f502e156b65f4495c18d35678ba7eb158bc122a764173e924bd77eb371930cb594a70e3cd39bc32ba13
+  data.tar.gz: 6ea4f3b98cade21c21b6fa20500db0d974679b484fdf881171787660efd07122dee0ba0168f56240802a6dbcf3db67821fa2a9d4fd35c0751e3aad13f61541b8

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

@@ -3,6 +3,7 @@ module Percy
     class Client
       module Builds
         def current_build
+          return if !enabled?  # Silently skip if the client is disabled.
           @current_build ||= client.create_build(client.config.repo)
         end
         alias_method :initialize_build, :current_build
@@ -12,6 +13,7 @@ module Percy
         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.')

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

@@ -15,6 +15,7 @@ module Percy
         #   builds. By default this is the URL of the page, but can be customized if the URL does not
         #   entirely identify the current state.
         def snapshot(page, options = {})
+          return if !enabled?  # Silently skip if the client is disabled.
           name = options[:name]
           current_build_id = current_build['data']['id']
           resource_map = _find_resources(page)

data/lib/percy/capybara/client.rb

@@ -15,6 +15,12 @@ module Percy
 
       def initialize(options = {})
         @client = options[:client] || Percy.client
+        @enabled = options[:enabled]
+      end
+
+      def enabled?
+        # Only enable if in supported CI environment or local dev with PERCY_ENABLE=1.
+        @enabled ||= !Percy::Client::Environment.current_ci.nil? || ENV['PERCY_ENABLE'] == '1'
       end
     end
   end

data/lib/percy/capybara/version.rb

@@ -1,5 +1,5 @@
 module Percy
   module Capybara
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

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

@@ -1,5 +1,5 @@
 RSpec.describe Percy::Capybara::Client::Builds do
-  let(:capybara_client) { Percy::Capybara::Client.new }
+  let(:capybara_client) { Percy::Capybara::Client.new(enabled: true) }
 
   describe '#current_build' do
     it 'returns the current build or creates a new one' do

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

@@ -2,7 +2,7 @@ require 'json'
 require 'digest'
 
 RSpec.describe Percy::Capybara::Client::Snapshots, type: :feature do
-  let(:capybara_client) { Percy::Capybara::Client.new }
+  let(:capybara_client) { Percy::Capybara::Client.new(enabled: true) }
 
   # Start a temp webserver that serves the testdata directory.
   # You can test this server manually by running:

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

@@ -0,0 +1,32 @@
+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
+    before(:each) do
+      @original_env = ENV['TRAVIS_BUILD_ID']
+      ENV['TRAVIS_BUILD_ID'] = nil
+    end
+    after(:each) do
+      ENV['TRAVIS_BUILD_ID'] = @original_env
+      ENV['PERCY_ENABLE'] = nil
+    end
+
+    context 'in supported CI environment' do
+      it 'is true' do
+        ENV['TRAVIS_BUILD_ID'] = '123'
+        expect(Percy::Capybara::Client.new.enabled?).to be_truthy
+      end
+    end
+    it 'is false by default for local dev environments or unknown CI environments' do
+      expect(Percy::Capybara::Client.new.enabled?).to be_falsey
+    end
+    it 'is true if PERCY_ENABLE=1 is set' do
+      ENV['PERCY_ENABLE'] = '1'
+      expect(Percy::Capybara::Client.new.enabled?).to be_truthy
+    end
+  end
+end
+

data/spec/lib/percy/capybara_spec.rb

@@ -1,5 +1,15 @@
 RSpec.describe Percy::Capybara do
-  before(:each) { Percy::Capybara.reset }
+  before(:each) do
+    Percy::Capybara.reset
+    @original_env = ENV['TRAVIS_BUILD_ID']
+    ENV['PERCY_ENABLE'] = '1'
+    ENV['TRAVIS_BUILD_ID'] = nil
+  end
+  after(:each) do
+    ENV['TRAVIS_BUILD_ID'] = @original_env
+    ENV['PERCY_ENABLE'] = nil
+  end
+
 
   describe '#capybara_client' do
     it 'returns the current client or creates a new one' do
@@ -18,8 +28,13 @@ RSpec.describe Percy::Capybara do
       expect(capybara_client).to receive(:snapshot).with(mock_page, name: '/foo.html (modal)').once
       Percy::Capybara.snapshot(mock_page, name: '/foo.html (modal)')
     end
+    it 'silently skips if not enabled' do
+      ENV['PERCY_ENABLE'] = nil
+      mock_page = double('page')
+      Percy::Capybara.snapshot(mock_page)
+    end
   end
-  describe '#snapshot' do
+  describe '#initialize_build' do
     it 'delegates to Percy::Capybara::Client' do
       capybara_client = Percy::Capybara.capybara_client
       expect(capybara_client).to receive(:initialize_build).once
@@ -38,6 +53,14 @@ RSpec.describe Percy::Capybara do
       expect(capybara_client).to receive(:finalize_current_build).once
       Percy::Capybara.finalize_build
     end
+    it 'silently skips if not enabled' do
+      ENV['PERCY_ENABLE'] = nil
+      capybara_client = Percy::Capybara.capybara_client
+      expect(capybara_client.client).to_not receive(:create_build)
+      Percy::Capybara.initialize_build
+      expect(capybara_client).to_not receive(:finalize_current_build)
+      Percy::Capybara.finalize_build
+    end
   end
   describe '#reset' do
     it 'clears the current capybara_client' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-capybara
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-25 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: percy-client
@@ -179,6 +179,7 @@ files:
 - spec/lib/percy/capybara/client/testdata/index.html
 - spec/lib/percy/capybara/client/testdata/test-css.html
 - spec/lib/percy/capybara/client/testdata/test-images.html
+- spec/lib/percy/capybara/client_spec.rb
 - spec/lib/percy/capybara/httpfetcher_spec.rb
 - spec/lib/percy/capybara_spec.rb
 - spec/spec_helper.rb
@@ -228,8 +229,8 @@ test_files:
 - spec/lib/percy/capybara/client/testdata/index.html
 - spec/lib/percy/capybara/client/testdata/test-css.html
 - spec/lib/percy/capybara/client/testdata/test-images.html
+- spec/lib/percy/capybara/client_spec.rb
 - spec/lib/percy/capybara/httpfetcher_spec.rb
 - spec/lib/percy/capybara_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_helpers.rb
-has_rdoc: