percy-capybara 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb10aec66c3c56197c20d065c40d832e877a6f6c
-  data.tar.gz: c0ceaad44d882dd332bc311f9487254ebddd629e
+  metadata.gz: 1ffda7d1edb1b8af63b836b222198c91f5b4123b
+  data.tar.gz: 0a4530980562b8eee91a122ccb605c10376d8d9f
 SHA512:
-  metadata.gz: 8c77f2d2408b130ae4ddc0da23a4dc57ab2cfb17eeb7d0f70f95856bfd4b5f0d48c55f9098c002c5ff43e233621ab7329034b089dbb8943e132f15b1698a58d8
-  data.tar.gz: 61edd95f68244f5d7b63d169a9da0b95be1743c5ebfeaf96f9f226721467ec059f38d76722bd4b53e4dccf7ee562de2e818fd36647d6e40f0ee8d69df223a310
+  metadata.gz: 0b80f67fc99db1389d5c3dbc9b3e743d4ccc3ba87cde1db6e6397e056457a3d85a20233ecdff8d291108a66f0e00848f56642e899f85c2d96259e48b4e3a0442
+  data.tar.gz: 84c9e112198d7d43f46519d639ae9dc9ee620fac769331a5e43eccdaeb253f507bc51c2dc91bf3c826dae0f08034d0dd954b950986fc03621936a97a145c3558

data/.rubocop.yml

@@ -0,0 +1,42 @@
+require: rubocop-rspec
+inherit_from: .rubocop_todo.yml
+AllCops:
+  Include:
+    - Rakefile
+    - lib/**/*.rake
+
+Metrics/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+
+
+# Will be able to do this in >= v1.11
+# RSpec/DescribedClass:
+#   EnforcedStyle: explicit

data/.rubocop_todo.yml

@@ -0,0 +1,98 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-02-08 20:09:02 -0800 using RuboCop version 0.47.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 8
+Metrics/AbcSize:
+  Max: 54
+
+# Offense count: 27
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 227
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 164
+
+# Offense count: 5
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 11
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 57
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Offense count: 43
+# Configuration parameters: SkipBlocks.
+RSpec/DescribedClass:
+  Exclude:
+    - 'spec/lib/percy/capybara/client_spec.rb'
+    - 'spec/lib/percy/capybara/http_fetcher_spec.rb'
+    - 'spec/lib/percy/capybara_spec.rb'
+
+# Offense count: 29
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/lib/percy/capybara/client/builds_spec.rb'
+    - 'spec/lib/percy/capybara/client/snapshots_spec.rb'
+    - 'spec/lib/percy/capybara/client_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'
+
+# Offense count: 1
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/lib/percy/capybara_spec.rb'
+
+# Offense count: 42
+RSpec/MultipleExpectations:
+  Max: 29
+
+# Offense count: 1
+# Configuration parameters: Max.
+RSpec/NestedGroups:
+  Exclude:
+    - 'spec/lib/percy/capybara/loaders/sprockets_loader_spec.rb'
+
+# Offense count: 10
+# Configuration parameters: IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/lib/percy/capybara/client/builds_spec.rb'
+    - 'spec/lib/percy/capybara/client_spec.rb'
+    - 'spec/lib/percy/capybara/loaders/base_loader_spec.rb'
+    - 'spec/lib/percy/capybara/loaders/sprockets_loader_spec.rb'
+    - 'spec/lib/percy/capybara_spec.rb'
+    - 'spec/support/test_helpers.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'lib/percy/capybara/loaders/native_loader.rb'
+    - 'spec/lib/percy/capybara/loaders/native_loader_spec.rb'
+    - 'spec/lib/percy/capybara/loaders/sprockets_loader_spec.rb'
+    - 'spec/support/test_helpers.rb'
+
+# Offense count: 1
+Style/StructInheritance:
+  Exclude:
+    - 'lib/percy/capybara/httpfetcher.rb'

data/.travis.yml

@@ -10,5 +10,8 @@ matrix:
   allow_failures:
   - rvm: ruby-head
 before_install:
+  - gem update --system
   - gem update bundler
-script: xvfb-run bundle exec rspec
+script:
+  - xvfb-run bundle exec rspec
+  - bundle exec rubocop -D

data/Gemfile

@@ -6,4 +6,9 @@ gemspec
 gem 'guard-rspec', require: false
 
 # (for development)
-# gem 'percy-client', path: '~/src/percy-client'
+# gem 'percy-client', path: '~/src/percy-client'
+
+group :test do
+  gem 'rubocop'
+  gem 'rubocop-rspec'
+end

data/Rakefile

@@ -1,2 +1 @@
 require 'bundler/gem_tasks'
-

data/lib/percy/capybara.rb

@@ -36,7 +36,7 @@ module Percy
     #
     # @see Percy::Capybara::Client::Builds#finalize_current_build
     def self.finalize_build
-      return if !capybara_client.build_initialized?
+      return unless capybara_client.build_initialized?
       capybara_client.finalize_current_build
     end
 
@@ -45,7 +45,7 @@ module Percy
       @capybara_client = nil
     end
     # The 'reset' method is deprecated and will be removed: use the reset! method instead.
-    class << self; alias_method :reset, :reset!; end;
+    class << self; alias reset reset!; end
 
     # Manually disable Percy for the current capybara client. This can also be done with the
     # PERCY_ENABLE=0 environment variable.

data/lib/percy/capybara/client.rb

@@ -10,7 +10,7 @@ module Percy
       include Percy::Capybara::Client::Builds
       include Percy::Capybara::Client::Snapshots
 
-      class Error < Exception; end
+      class Error < RuntimeError; end
       class BuildNotInitializedError < Error; end
       class WebMockBlockingConnectionsError < Error; end
 
@@ -29,26 +29,24 @@ module Percy
 
         @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
-        end
+        return unless defined?(Rails)
+
+        @sprockets_environment = options[:sprockets_environment] || Rails.application.assets
+        @sprockets_options = options[:sprockets_options] || Rails.application.config.assets
       end
 
       # Check that environment variables required for Percy::Client are set
       def required_environment_variables_set?
         if !ENV['PERCY_TOKEN'].nil? && ENV['PERCY_PROJECT'].nil?
-          raise RuntimeError.new(
-            '[percy] It looks like you were trying to enable Percy because PERCY_TOKEN is set, ' +
-            'but you are missing the PERCY_PROJECT environment variable!'
-          )
+          raise '[percy] It looks like you were trying to enable Percy because PERCY_TOKEN ' \
+            'is set, but you are missing the PERCY_PROJECT environment variable!'
         end
 
         !(ENV['PERCY_PROJECT'].nil? || ENV['PERCY_TOKEN'].nil?)
       end
 
       def enabled?
-        return @enabled if !@enabled.nil?
+        return @enabled unless @enabled.nil?
 
         # Disable if PERCY_ENABLE is set to 0
         return @enabled = false if ENV['PERCY_ENABLE'] == '0'
@@ -57,21 +55,21 @@ module Percy
         return @enabled = true if required_environment_variables_set?
 
         # Disable otherwise
-        return @enabled = false
+        @enabled = false
       end
 
       def disable!
         @enabled = false
       end
 
-      def rescue_connection_failures(&block)
-        raise ArgumentError.new('block is required') if !block_given?
+      def rescue_connection_failures
+        raise ArgumentError, 'block is required' unless block_given?
         begin
-          block.call
-        rescue Percy::Client::ServerError,  # Rescue server errors.
-            Percy::Client::PaymentRequiredError,  # Rescue quota exceeded errors.
-            Percy::Client::ConnectionFailed,  # Rescue some networking errors.
-            Percy::Client::TimeoutError => e
+          yield
+        rescue Percy::Client::ServerError, # Rescue server errors.
+               Percy::Client::PaymentRequiredError, # Rescue quota exceeded errors.
+               Percy::Client::ConnectionFailed, # Rescue some networking errors.
+               Percy::Client::TimeoutError => e
           Percy.logger.error(e)
           @enabled = false
           @failed = true
@@ -80,7 +78,7 @@ module Percy
       end
 
       def failed?
-        return !!@failed
+        !!@failed
       end
 
       def initialize_loader(options = {})
@@ -105,9 +103,9 @@ module Percy
         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 '
+              '[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).' }

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

@@ -3,13 +3,13 @@ module Percy
     class Client
       module Builds
         def initialize_build(options = {})
-          return if !enabled?  # Silently skip if the client is disabled.
+          return unless enabled? # Silently skip if the client is disabled.
           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?
+          options[:resources] = build_resources unless build_resources.empty?
 
           # Extra debug info.
           build_resources.each { |br| Percy.logger.debug { "Build resource: #{br.resource_url}" } }
@@ -17,17 +17,17 @@ module Percy
 
           rescue_connection_failures do
             @current_build = client.create_build(client.config.repo, options)
-            _upload_missing_build_resources(build_resources) if !build_resources.empty?
+            _upload_missing_build_resources(build_resources) unless build_resources.empty?
           end
           if failed?
-            Percy.logger.error { "Percy build failed! Check log above for errors." }
+            Percy.logger.error { 'Percy build failed! Check log above for errors.' }
             return
           end
           @current_build
         end
 
         def current_build
-          return if !enabled?  # Silently skip if the client is disabled.
+          return unless enabled?  # Silently skip if the client is disabled.
           @current_build
         end
 
@@ -37,16 +37,16 @@ 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.')
+          return unless enabled?  # Silently skip if the client is disabled.
+          unless build_initialized?
+            raise Percy::Capybara::Client::BuildNotInitializedError,
+                  'Failed to finalize build because no build has been initialized.'
           end
           result = rescue_connection_failures do
             client.finalize_build(current_build['data']['id'])
           end
           if failed?
-            Percy.logger.error { "Percy build failed! Check log above for errors." }
+            Percy.logger.error { 'Percy build failed! Check log above for errors.' }
             return
           end
           result
@@ -59,15 +59,15 @@ module Percy
             current_build['data']['relationships'] &&
             current_build['data']['relationships']['missing-resources'] &&
             current_build['data']['relationships']['missing-resources']['data']
-          return 0 if !new_build_resources
+          return 0 unless new_build_resources
 
           new_build_resources.each_with_index do |missing_resource, i|
             sha = missing_resource['id']
             resource = build_resources.find { |r| r.sha == sha }
             content = resource.content || File.read(resource.path)
             client.upload_resource(current_build['data']['id'], content)
-            if i % 10 == 0
-              puts "[percy] Uploading #{i+1} of #{new_build_resources.length} new resources..."
+            if (i % 10).zero?
+              puts "[percy] Uploading #{i + 1} of #{new_build_resources.length} new resources..."
             end
           end
           new_build_resources.length

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

@@ -8,18 +8,16 @@ module Percy
         #
         # @param [Capybara::Session] page The Capybara page to snapshot.
         # @param [Hash] options
-        # @option options [String] :name A unique name for the current page that identifies it across
-        #   builds. By default this is the URL of the page, but can be customized if the URL does not
-        #   entirely identify the current state.
+        # @option options [String] :name A unique name for the current page that identifies
+        #   it across 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.
+          return unless enabled? # Silently skip if the client is disabled.
 
           if current_build.nil?
-            raise RuntimeError.new(
-              'Whoops! Percy is enabled, but Percy::Capybara.initialize_build was never called. ' +
-              'Did you forget to setup Percy in your spec_helper.rb? ' +
+            raise 'Whoops! Percy is enabled, but Percy::Capybara.initialize_build was never ' \
+              'called. Did you forget to setup Percy in your spec_helper.rb? ' \
               'See: https://percy.io/docs/clients/ruby/capybara'
-            )
           end
 
           loader = initialize_loader(page: page)
@@ -46,7 +44,8 @@ module Percy
               return
             end
 
-            snapshot['data']['relationships']['missing-resources']['data'].each do |missing_resource|
+            missing_resource_data = snapshot['data']['relationships']['missing-resources']['data']
+            missing_resource_data.each do |missing_resource|
               sha = missing_resource['id']
               client.upload_resource(current_build_id, resource_map[sha].content)
             end
@@ -56,7 +55,7 @@ module Percy
             client.finalize_snapshot(snapshot['data']['id'])
           end
           if failed?
-            Percy.logger.error { "Percy build failed! Check log above for errors." }
+            Percy.logger.error { 'Percy build failed! Check log above for errors.' }
             return
           end
           true

data/lib/percy/capybara/httpfetcher.rb

@@ -23,13 +23,13 @@ module Percy
         content_type = output.match(/< Content-Type:(.*)/i)
         content_type = content_type[1].strip if content_type
 
-        if File.exist?(temppath)
-          response = Percy::Capybara::HttpFetcher::Response.new(File.read(temppath), content_type)
-          # We've broken the tempfile so it won't get deleted when garbage collected. Delete!
-          File.delete(temppath)
-          return if response.body == ''
-          response
-        end
+        return unless File.exist?(temppath)
+
+        response = Percy::Capybara::HttpFetcher::Response.new(File.read(temppath), content_type)
+        # We've broken the tempfile so it won't get deleted when garbage collected. Delete!
+        File.delete(temppath)
+        return if response.body == ''
+        response
       end
     end
   end

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

@@ -5,29 +5,29 @@ module Percy
         # Modified version of Diego Perini's URL regex. https://gist.github.com/dperini/729294
         URL_REGEX = Regexp.new(
           # protocol identifier
-          "((?:https?:)?//)" +
-          "(" +
+          '((?:https?:)?//)' \
+          '(' +
             # IP address exclusion
             # private & local networks
-            "(?!(?:10|127)(?:\\.\\d{1,3}){3})" +
-            "(?!(?:169\\.254|192\\.168)(?:\\.\\d{1,3}){2})" +
-            "(?!172\\.(?:1[6-9]|2\\d|3[0-1])(?:\\.\\d{1,3}){2})" +
+            '(?!(?:10|127)(?:\\.\\d{1,3}){3})' \
+            '(?!(?:169\\.254|192\\.168)(?:\\.\\d{1,3}){2})' \
+            '(?!172\\.(?:1[6-9]|2\\d|3[0-1])(?:\\.\\d{1,3}){2})' +
             # IP address dotted notation octets
             # excludes loopback network 0.0.0.0
             # excludes reserved space >= 224.0.0.0
             # excludes network & broacast addresses
             # (first & last IP address of each class)
-            "(?:[1-9]\\d?|1\\d\\d|2[01]\\d|22[0-3])" +
-            "(?:\\.(?:1?\\d{1,2}|2[0-4]\\d|25[0-5])){2}" +
-            "(?:\\.(?:[1-9]\\d?|1\\d\\d|2[0-4]\\d|25[0-4]))" +
-          "|" +
+            '(?:[1-9]\\d?|1\\d\\d|2[01]\\d|22[0-3])' \
+            '(?:\\.(?:1?\\d{1,2}|2[0-4]\\d|25[0-5])){2}' \
+            '(?:\\.(?:[1-9]\\d?|1\\d\\d|2[0-4]\\d|25[0-4]))' \
+          '|' +
             # host name
-            "(?:(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)" +
+            '(?:(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)' +
             # domain name
-            "(?:\\.(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)*" +
-          ")" +
+            '(?:\\.(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)*' \
+          ')' +
           # port number
-          "(:\\d{2,5})?" +
+          '(:\\d{2,5})?' +
           # resource path
           "(/[^\\s\"']*)?"
         )
@@ -40,17 +40,18 @@ module Percy
         end
 
         def build_resources
-          raise NotImplementedError.new('subclass must implement abstract method')
+          raise NotImplementedError, 'subclass must implement abstract method'
         end
 
         def snapshot_resources
-          raise NotImplementedError.new('subclass must implement abstract method')
+          raise NotImplementedError, 'subclass must implement abstract method'
         end
 
         # @private
         def root_html_resource
           Percy::Client::Resource.new(
-            current_path, is_root: true, mimetype: 'text/html', content: page.html)
+            current_path, is_root: true, mimetype: 'text/html', content: page.html
+          )
         end
 
         # Transformed version of the current URL to be a relative path.