percy-cli 1.2.7 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7df8ccf2d597885ee3005eef4f11eacdb2ceb365
-  data.tar.gz: 24e3aadbe605bcb00c59722269e315b05861cc23
+  metadata.gz: 6db66b9860cd6126388ee95fb61d4fe3467ed9af
+  data.tar.gz: ca3ea469e64d7f93f71c5845bfb598e1fd8f20c9
 SHA512:
-  metadata.gz: 5603b957334f02c8f066ae1f1d762ff2e48d6f2eaf50909d2897378bba674cd8691f6b1681812f113b55ec22a45c1f4f970be360ee19e8293a54bede8d74b7f3
-  data.tar.gz: d343aee9eefac3f5fcca8f2480e1c1f42e795e7316a2e6aa10e03f5a8ad884c0bf9d5aff42eb6f6a73b196d9656ac67f66ced148317979571423d4ead88c7d3f
+  metadata.gz: 811bd7fc706dd7cce1cc5aee82b42fb17f094812210155419553c9998632267227cffb93049a515fc0a02675be9fcf631fbc50ea7efc325bd104810dc203d2e5
+  data.tar.gz: c148eacd3898e0ab43d9aa9b5703d8b4b3c9336fbe1f48b83120fd1c90880a708dd3dcde04d15474f0b5e618d09c046ef22a006a648459dc6041c2ddbab5ec19

data/.rubocop.yml

@@ -0,0 +1,79 @@
+require: rubocop-rspec
+inherit_from: .rubocop_todo.yml
+AllCops:
+  Include:
+    - Rakefile
+    - lib/**/*.rake
+  Exclude:
+    - 'vendor/**/*'
+    - '*.gemspec'
+
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/CaseIndentation:
+  EnforcedStyle: end
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# Disable Style/NumericLiterals so numbers don't need underscores
+Style/NumericLiterals:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/RedundantBegin:
+  Enabled: false
+
+Style/RegexpLiteral:
+  EnforcedStyle: slashes
+  AllowInnerSlashes: true
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/NotToNot:
+  Enabled: false
+
+
+# Will be able to do this in >= v1.11
+# RSpec/DescribedClass:
+#   EnforcedStyle: explicit

data/.rubocop_todo.yml

@@ -0,0 +1,63 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-02-09 21:30:53 -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: 1
+Lint/AmbiguousOperator:
+  Exclude:
+    - 'lib/percy/cli.rb'
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 81
+
+# Offense count: 4
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 139
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+# Offense count: 5
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 61
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 159
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Offense count: 6
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/percy/cli/snapshot_spec.rb'
+
+# Offense count: 11
+RSpec/MultipleExpectations:
+  Max: 6
+
+# Offense count: 1
+# Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  Exclude:
+    - 'lib/percy/cli.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'lib/percy/cli/snapshot.rb'

data/.travis.yml

@@ -3,4 +3,9 @@ rvm:
   - 2.1
   - 2.2
   - ruby-head
-script: bundle exec rspec
+before_install:
+  - gem update --system
+  - gem update bundler
+script:
+  - bundle exec rspec
+  - bundle exec rubocop -D

data/Gemfile

@@ -1,4 +1,9 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in percy-cli.gemspec
-gemspec
+gemspec
+
+group :test do
+  gem 'rubocop'
+  gem 'rubocop-rspec'
+end

data/Rakefile

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

data/lib/percy/cli.rb

@@ -32,8 +32,8 @@ module Percy
         c.option \
           '--baseurl PATH',
           String,
-          'The live URL base path. Defaults to "/". Set this if your site is hosted in ' +
-          'a subdirectory in production that does not exist locally. If using Jekyll, this ' +
+          'The live URL base path. Defaults to "/". Set this if your site is hosted in ' \
+          'a subdirectory in production that does not exist locally. If using Jekyll, this ' \
           'should be the same as your "baseurl" config.'
         c.option \
           '--strip_prefix PATH',
@@ -54,17 +54,18 @@ module Percy
         c.option \
           '--snapshot_limit NUM',
           Integer,
-          "Max number of snapshots to upload, useful for testing. Default is unlimited."
+          'Max number of snapshots to upload, useful for testing. Default is unlimited.'
         c.option \
           '--[no-]enable_javascript',
-          "Whether or not to enable JavaScript when rendering all snapshots. Default false."
+          'Whether or not to enable JavaScript when rendering all snapshots. Default false.'
         c.option \
           '--include_all',
-          "Whether to include all files in the directory as resources. By default only common website related file types are included."
+          "Whether to include all files in the directory as resources. By default only common ' +
+          'website related file types are included."
         c.option \
           '--threads NUM',
           Integer,
-          "Number of threads in pools for snapshot and resource uploads. " +
+          'Number of threads in pools for snapshot and resource uploads. ' \
           "Defaults to #{DEFAULT_NUM_THREADS}, max #{MAX_NUM_THREADS}."
 
         c.action do |args, options|
@@ -88,5 +89,3 @@ module Percy
     end
   end
 end
-
-

data/lib/percy/cli/snapshot.rb

@@ -11,11 +11,12 @@ module Percy
     module Snapshot
       # Static resource types that an HTML file might load and that we want to upload for rendering.
       STATIC_RESOURCE_EXTENSIONS = [
-        '.css', '.js', '.jpg', '.jpeg', '.gif', '.ico', '.png', '.bmp', '.pict', '.tif', '.tiff', '.ttf',
-        '.eot', '.woff', '.otf', '.svg', '.svgz', '.webp', '.ps',
+        '.css', '.js', '.jpg', '.jpeg', '.gif', '.ico', '.png', '.bmp', '.pict', '.tif', '.tiff',
+        '.ttf', '.eot', '.woff', '.otf', '.svg', '.svgz', '.webp', '.ps',
       ].freeze
 
       DEFAULT_SNAPSHOTS_REGEX = /\.(html|htm)$/
+      MAX_FILESIZE_BYTES = 15 * 1024**2 # 15 MB.
 
       def run_snapshot(root_dir, options = {})
         repo = options[:repo] || Percy.config.repo
@@ -27,7 +28,7 @@ module Percy
         enable_javascript = !!options[:enable_javascript]
         include_all = !!options[:include_all]
         widths = options[:widths].map { |w| Integer(w) }
-        raise ArgumentError.new('baseurl must start with /') if baseurl[0] != '/'
+        raise ArgumentError, 'baseurl must start with /' if baseurl[0] != '/'
 
         base_resource_options = {strip_prefix: strip_prefix, baseurl: baseurl}
 
@@ -39,7 +40,7 @@ module Percy
         all_resources = root_resources + build_resources
 
         if root_resources.empty?
-          say "No root resource files found. Are there HTML files in the given directory?"
+          say 'No root resource files found. Are there HTML files in the given directory?'
           exit(-1)
         end
 
@@ -52,7 +53,7 @@ module Percy
           build = Percy.create_build(repo, resources: build_resources)
 
           say 'Uploading build resources...'
-          upload_missing_resources(build, build, all_resources, {num_threads: num_threads})
+          upload_missing_resources(build, build, all_resources, num_threads: num_threads)
 
           build
         end
@@ -66,7 +67,7 @@ module Percy
           break if snapshot_limit && i + 1 > snapshot_limit
           snapshot_thread_pool.process do
             output_lock.synchronize do
-              say "Uploading snapshot (#{i+1}/#{total}): #{root_resource.resource_url}"
+              say "Uploading snapshot (#{i + 1}/#{total}): #{root_resource.resource_url}"
             end
             rescue_connection_failures do
               snapshot = Percy.create_snapshot(
@@ -75,7 +76,7 @@ module Percy
                 enable_javascript: enable_javascript,
                 widths: widths,
               )
-              upload_missing_resources(build, snapshot, all_resources, {num_threads: num_threads})
+              upload_missing_resources(build, snapshot, all_resources, num_threads: num_threads)
               Percy.finalize_snapshot(snapshot['data']['id'])
             end
           end
@@ -87,7 +88,7 @@ module Percy
         say 'Finalizing build...'
         rescue_connection_failures { Percy.finalize_build(build['data']['id']) }
         return if failed?
-        say "Done! Percy is now processing, you can view the visual diffs here:"
+        say 'Done! Percy is now processing, you can view the visual diffs here:'
         say build['data']['attributes']['web-url']
       end
 
@@ -97,16 +98,16 @@ module Percy
         !!@failed
       end
 
-      def rescue_connection_failures(&block)
-        raise ArgumentError.new('block is requried') if !block_given?
+      def rescue_connection_failures
+        raise ArgumentError, 'block is requried' unless block_given?
         begin
-          block.call
-        rescue Percy::Client::ServerError,  # Rescue server errors.
-            Percy::Client::UnauthorizedError,  # Rescue unauthorized errors (no auth creds setup).
-            Percy::Client::PaymentRequiredError,  # Rescue quota exceeded errors.
-            Percy::Client::ConflictError,  # Rescue project disabled errors and others.
-            Percy::Client::ConnectionFailed,  # Rescue some networking errors.
-            Percy::Client::TimeoutError => e
+          yield
+        rescue Percy::Client::ServerError, # Rescue server errors.
+               Percy::Client::UnauthorizedError, # Rescue unauthorized errors (no auth creds setup).
+               Percy::Client::PaymentRequiredError, # Rescue quota exceeded errors.
+               Percy::Client::ConflictError, # Rescue project disabled errors and others.
+               Percy::Client::ConnectionFailed, # Rescue some networking errors.
+               Percy::Client::TimeoutError => e
           Percy.logger.error(e)
           @failed = true
           nil
@@ -114,33 +115,11 @@ module Percy
       end
 
       def find_root_paths(dir_path, options = {})
-        snapshots_regex = options[:snapshots_regex] || DEFAULT_SNAPSHOTS_REGEX
-
-        file_paths = []
-        _find_files(dir_path).each do |path|
-          # Skip git files.
-          next if path.match(/\/\.git\//)
-          # Skip files that don't match the snapshots_regex.
-          next if !path.match(snapshots_regex)
-          file_paths << path
-        end
-        file_paths
+        find_files(dir_path).select { |path| include_root_path?(path, options) }
       end
 
       def find_resource_paths(dir_path, options = {})
-        file_paths = []
-        _find_files(dir_path).each do |path|
-          # Skip git files.
-          next if path.match(/\/\.git\//)
-
-          if !options[:include_all]
-            # Only include files with the above static extensions.
-            next if !Percy::Cli::STATIC_RESOURCE_EXTENSIONS.include?(File.extname(path))
-          end
-
-          file_paths << path
-        end
-        file_paths
+        find_files(dir_path).select { |path| include_resource_path?(path, options) }
       end
 
       def maybe_add_protocol(url)
@@ -157,10 +136,12 @@ module Percy
 
         paths.each do |path|
           sha = Digest::SHA256.hexdigest(File.read(path))
+          next if File.size(path) > MAX_FILESIZE_BYTES
           resource_url = URI.escape(File.join(baseurl, path.sub(strip_prefix, '')))
 
           resources << Percy::Client::Resource.new(
-            resource_url, sha: sha, is_root: options[:is_root], path: path)
+            resource_url, sha: sha, is_root: options[:is_root], path: path,
+          )
         end
         resources
       end
@@ -182,13 +163,13 @@ module Percy
           uploader_thread_pool.process do
             missing_resource_sha = missing_resource['id']
             resource = potential_resources.find { |r| r.sha == missing_resource_sha }
-            path = resource.resource_url
             output_lock.synchronize do
               bar.increment resource_url: resource.resource_url
             end
 
-            # Remote resources are stored in 'content', local resources are read from the filesystem.
-            content = resource.content || File.read("#{resource.path}")
+            # Remote resources are stored in 'content', local resources are
+            # read from the filesystem.
+            content = resource.content || File.read(resource.path.to_s)
 
             Percy.upload_resource(build['data']['id'], content)
           end
@@ -198,16 +179,30 @@ module Percy
       end
 
       # A file find method that follows directory and file symlinks.
-      def _find_files(*paths)
+      def find_files(*paths)
         paths.flatten!
         paths.map! { |p| Pathname.new(p) }
-        files = paths.select { |p| p.file? }
+        files = paths.select(&:file?)
         (paths - files).each do |dir|
-          files << _find_files(dir.children)
+          files << find_files(dir.children)
         end
-        files.flatten.map { |path| path.to_s }
+        files.flatten.map(&:to_s)
+      end
+
+      def include_resource_path?(path, options)
+        # Skip git files.
+        return false if path =~ /\/\.git\//
+        return true if options[:include_all]
+        Percy::Cli::STATIC_RESOURCE_EXTENSIONS.include?(File.extname(path))
+      end
+
+      def include_root_path?(path, options)
+        # Skip git files.
+        return false if path =~ /\/\.git\//
+        # Skip files that don't match the snapshots_regex.
+        snapshots_regex = options[:snapshots_regex] || DEFAULT_SNAPSHOTS_REGEX
+        path.match(snapshots_regex)
       end
-      private :_find_files
     end
   end
 end

data/lib/percy/cli/version.rb

@@ -1,5 +1,5 @@
 module Percy
   class Cli
-    VERSION = '1.2.7'
+    VERSION = '1.2.8'.freeze
   end
 end

data/percy-cli.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'percy/cli/version'
@@ -19,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'commander', '~> 4.3'
-  spec.add_dependency 'percy-client', '~> 1.4'
+  spec.add_dependency 'percy-client', '~> 1.12'
   spec.add_dependency 'thread', '~> 0.2'
 
   spec.add_development_dependency 'bundler', '~> 1.7'

data/spec/percy/cli/snapshot_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe Percy::Cli::Snapshot do
   end
   describe '#rescue_connection_failures' do
     let(:cli) { Percy::Cli.new }
+
     it 'returns block result on success' do
       result = cli.send(:rescue_connection_failures) do
         true
@@ -62,30 +63,36 @@ RSpec.describe Percy::Cli::Snapshot do
   describe '#find_root_paths' do
     it 'returns only the HTML files in the directory' do
       paths = Percy::Cli.new.send(:find_root_paths, root_dir)
-      expect(paths).to match_array([
-        File.join(root_dir, 'index.html'),
-        File.join(root_dir, 'subdir/test.html'),
-        # Make sure file symlinks are followed.
-        File.join(root_dir, 'subdir/test_symlink.html'),
-        # Make sure directory symlinks are followed.
-        File.join(root_dir, 'subdir_symlink/test.html'),
-        File.join(root_dir, 'subdir_symlink/test_symlink.html'),
-      ])
+      expect(paths).to match_array(
+        [
+          File.join(root_dir, 'index.html'),
+          File.join(root_dir, 'subdir/test.html'),
+          # Make sure file symlinks are followed.
+          File.join(root_dir, 'subdir/test_symlink.html'),
+          # Make sure directory symlinks are followed.
+          File.join(root_dir, 'subdir_symlink/test.html'),
+          File.join(root_dir, 'subdir_symlink/test_symlink.html'),
+        ],
+      )
     end
   end
   describe '#find_resource_paths' do
     it 'returns only the related static files in the directory' do
       paths = Percy::Cli.new.send(:find_resource_paths, root_dir)
-      expect(paths).to match_array([
-        File.join(root_dir, 'css/base.css'),
-        File.join(root_dir, 'css/test with spaces.css'),
-        File.join(root_dir, 'images/jellybeans.png'),
-        # Make sure file symlinks are followed.
-        File.join(root_dir, 'images/jellybeans-symlink.png'),
-        # Make sure directory symlinks are followed.
-        File.join(root_dir, 'images_symlink/jellybeans.png'),
-        File.join(root_dir, 'images_symlink/jellybeans-symlink.png'),
-      ])
+      expect(paths).to match_array(
+        [
+          File.join(root_dir, 'css/base.css'),
+          File.join(root_dir, 'css/test with spaces.css'),
+          File.join(root_dir, 'images/jellybeans.png'),
+          File.join(root_dir, 'images/large-file-skipped.png'),
+          # Make sure file symlinks are followed.
+          File.join(root_dir, 'images/jellybeans-symlink.png'),
+          # Make sure directory symlinks are followed.
+          File.join(root_dir, 'images_symlink/jellybeans.png'),
+          File.join(root_dir, 'images_symlink/large-file-skipped.png'),
+          File.join(root_dir, 'images_symlink/jellybeans-symlink.png'),
+        ],
+      )
     end
   end
   describe '#list_resources' do

data/spec/spec_helper.rb

@@ -26,9 +26,11 @@ RSpec.configure do |config|
   Kernel.srand config.seed
 
   config.before(:each) do
-    WebMock.disable_net_connect!(allow: [
-      'maxcdn.bootstrapcdn.com',
-      'ajax.googleapis.com',
-    ])
+    WebMock.disable_net_connect!(
+      allow: [
+        'maxcdn.bootstrapcdn.com',
+        'ajax.googleapis.com',
+      ],
+    )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-cli
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.2.8
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2017-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: thread
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +118,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -134,6 +136,7 @@ files:
 - spec/percy/cli/testdata/css/unrelated-no-extension
 - spec/percy/cli/testdata/images/jellybeans-symlink.png
 - spec/percy/cli/testdata/images/jellybeans.png
+- spec/percy/cli/testdata/images/large-file-skipped.png
 - spec/percy/cli/testdata/images_symlink
 - spec/percy/cli/testdata/index.html
 - spec/percy/cli/testdata/subdir/test.html
@@ -160,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Percy command-line interface
@@ -171,6 +174,7 @@ test_files:
 - spec/percy/cli/testdata/css/unrelated-no-extension
 - spec/percy/cli/testdata/images/jellybeans-symlink.png
 - spec/percy/cli/testdata/images/jellybeans.png
+- spec/percy/cli/testdata/images/large-file-skipped.png
 - spec/percy/cli/testdata/images_symlink
 - spec/percy/cli/testdata/index.html
 - spec/percy/cli/testdata/subdir/test.html