percy-cli 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b424e941cc250a7a550f938ae216a99c51400ec
-  data.tar.gz: 5bf813f4abe4ced40d3b7f213801b33caa39d0ea
+  metadata.gz: a79b07a50003692a4126836dca74ca72787c479c
+  data.tar.gz: 44b4607a5fe3267aae10e772c7b7057f33ded2eb
 SHA512:
-  metadata.gz: a2e75cec943b3e4919590d256e562f129350a1a0775c34ea3de40e206e9300b105d2091b70f56b3a8a2baec0712222d47d3e2b2b20f5526058c41ee5251e6751
-  data.tar.gz: db17492803a3c36a5a34c30f033590f54f4305137adf3155ec212051b2931a8097564984642ee387db2c22cc7fc01593833e7623b803e0ee8e631a27bdf8a24a
+  metadata.gz: 29b2632be605f99a12265a798b7afb40552934bc7445f514a48723ed9842d84672d1524a2f7f1f32fdc1f2615043ed96d14bdb526c3165961a03a0e5590a4549
+  data.tar.gz: 14b7f5941ca563a9bf5c3df841638a162d5c16dd3e3ede57fc644e9fe1190d39ba63dc6e10893f6e6a1e3a644c387e6f652a0bad0f57b0a1035b0b829cd57639

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format d

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.1
+  - 2.2.2
+  - ruby-head
+script: bundle exec rspec

data/bin/percy

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'commander'
 require 'percy/cli'
 
-puts 'test'
+Percy::Cli.new.run if $0 == __FILE__

data/lib/percy/cli/snapshot.rb

@@ -0,0 +1,212 @@
+require 'find'
+require 'digest'
+require 'uri'
+
+module Percy
+  class Cli
+    module Snapshot
+      # Static resource types that an HTML file might load and that we want to upload for rendering.
+      STATIC_RESOURCE_EXTENSIONS = [
+        '.css', '.jpg', '.jpeg', '.gif', '.ico', '.png', '.bmp', '.pict', '.tif', '.tiff', '.ttf',
+        '.eot', '.woff', '.otf', '.svg', '.svgz', '.webp', '.ps',
+      ].freeze
+
+      DEFAULT_SNAPSHOTS_REGEX = /\.(html|htm)$/
+
+      # Modified version of Diego Perini's URL regex. https://gist.github.com/dperini/729294
+      REMOTE_URL_REGEX_STRING = (
+        # protocol identifier
+        "(?:(?: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})" +
+          # 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]))" +
+        "|" +
+          # host name
+          "(?:(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)" +
+          # domain name
+          "(?:\\.(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)*" +
+          # TLD identifier
+          "(?:\\.(?:[a-z\\u00a1-\\uffff]{2,}))" +
+        ")" +
+        # port number
+        "(?::\\d{2,5})?" +
+        # resource path
+        "(?:/[^\\s\"']*)?"
+      )
+      HTML_REMOTE_URL_REGEX = Regexp.new("<link.*?href=['\"](" + REMOTE_URL_REGEX_STRING + ")")
+
+      # Match all url("https://...") calls, with whitespace and quote variatinos.
+      CSS_REMOTE_URL_REGEX = Regexp.new(
+        "url\\s*\\([\"'\s]*(" + REMOTE_URL_REGEX_STRING + ")[\"'\s]*\\)"
+      )
+
+      def run_snapshot(root_dir, options = {})
+        repo = options[:repo] || Percy.config.repo
+        strip_prefix = File.absolute_path(options[:strip_prefix] || root_dir)
+        autoload_remote_resources = options[:autoload_remote_resources] || false
+
+        # Create a Percy build for the snapshots.
+        build = Percy.create_build(repo)
+
+        # Find all the static files in the given root directory.
+        root_paths = find_root_paths(root_dir, snapshots_regex: options[:snapshots_regex])
+        resource_paths = find_resource_paths(root_dir)
+        root_resources = build_resources(root_paths, strip_prefix, is_root: true)
+        related_resources = build_resources(resource_paths, strip_prefix)
+
+        if autoload_remote_resources
+          remote_urls = find_remote_urls(root_paths + resource_paths)
+          related_resources += build_remote_resources(remote_urls)
+        end
+
+        # Upload a snapshot for every root resource, and associate the related_resources.
+        root_resources.each_with_index do |root_resource, i|
+          say "Uploading snapshot (#{i+1}/#{root_resources.length}): #{root_resource.resource_url}"
+          upload_snapshot(build, root_resource, related_resources)
+        end
+
+        # Finalize the build.
+        Percy.finalize_build(build['data']['id'])
+      end
+
+      private
+
+      def find_root_paths(dir_path, options = {})
+        snapshots_regex = options[:snapshots_regex] || DEFAULT_SNAPSHOTS_REGEX
+
+        file_paths = []
+        Find.find(dir_path).each do |relative_path|
+          path = File.absolute_path(relative_path)
+          # Skip directories.
+          next if !FileTest.file?(path)
+          # Skip files that don't match the snapshots_regex.
+          next if !path.match(snapshots_regex)
+          file_paths << path
+        end
+        file_paths
+      end
+
+      def find_resource_paths(dir_path)
+        file_paths = []
+        Find.find(dir_path).each do |relative_path|
+          path = File.absolute_path(relative_path)
+
+          # Skip directories.
+          next if !FileTest.file?(path)
+          # Skip dot files.
+          next if path.match(/\/\./)
+          # Only include files with the above static extensions.
+          next if !Percy::Cli::STATIC_RESOURCE_EXTENSIONS.include?(File.extname(path))
+
+          file_paths << path
+        end
+        file_paths
+      end
+
+      def find_remote_urls(file_paths)
+        urls = []
+        file_paths.each do |path|
+          extension = File.extname(path)
+          case extension
+          when '.html'
+            content = File.read(path)
+            urls += content.scan(HTML_REMOTE_URL_REGEX).map { |match| maybe_add_protocol(match[0]) }
+          when '.css'
+            content = File.read(path)
+            urls += content.scan(CSS_REMOTE_URL_REGEX).map { |match| maybe_add_protocol(match[0]) }
+          end
+        end
+        urls.uniq
+      end
+
+      def maybe_add_protocol(url)
+        url[0..1] == '//' ? "http:#{url}" : url
+      end
+
+      def build_resources(paths, strip_prefix, options = {})
+        resources = []
+
+        # Strip trailing slash from strip_prefix.
+        strip_prefix = strip_prefix[0..-2] if strip_prefix[-1] == '/'
+
+        paths.each do |path|
+          sha = Digest::SHA256.hexdigest(File.read(path))
+          resource_url = URI.escape(path.sub(strip_prefix, ''))
+          resources << Percy::Client::Resource.new(
+            resource_url, sha: sha, is_root: options[:is_root], path: path)
+        end
+        resources
+      end
+
+      def build_remote_resources(remote_urls)
+        resources = []
+
+        bar = Commander::UI::ProgressBar.new(
+          remote_urls.length,
+          title: 'Fetching remote resources...',
+          format: ':title |:progress_bar| :percent_complete% complete - :url',
+          width: 40,
+          complete_message: nil,
+        )
+
+        remote_urls.each do |url|
+          bar.increment url: url
+          begin
+            response = Faraday.get(url)
+          rescue Faraday::Error::ConnectionFailed => e
+            say_error e
+            next
+          end
+          if response.status != 200
+            say_error "Remote resource failed, skipping: #{url}"
+            next
+          end
+
+          sha = Digest::SHA256.hexdigest(response.body)
+          resources << Percy::Client::Resource.new(url, sha: sha, content: response.body)
+        end
+        resources
+      end
+
+      def upload_snapshot(build, root_resource, related_resources)
+        all_resources = [root_resource] + related_resources
+
+        # Create the snapshot for this page. For simplicity, include all non-HTML resources in the
+        # snapshot as related resources. May seem inefficient, but they will only be uploaded once.
+        snapshot = Percy.create_snapshot(build['data']['id'], all_resources)
+
+        # Upload the content for any missing resources.
+        missing_resources = snapshot['data']['relationships']['missing-resources']['data']
+        bar = Commander::UI::ProgressBar.new(
+          missing_resources.length,
+          title: 'Uploading resources...',
+          format: ':title |:progress_bar| :percent_complete% complete - :resource_url',
+          width: 40,
+          complete_message: nil,
+        )
+        missing_resources.each do |missing_resource|
+          missing_resource_sha = missing_resource['id']
+          resource = all_resources.find { |r| r.sha == missing_resource_sha }
+          path = resource.resource_url
+          bar.increment resource_url: resource.resource_url
+
+          # Remote resources are stored in 'content', local resources are read from the filesystem.
+          content = resource.content || File.read("#{resource.path}")
+
+          Percy.upload_resource(build['data']['id'], content)
+        end
+      end
+    end
+  end
+end

data/lib/percy/cli/version.rb

@@ -1,5 +1,5 @@
 module Percy
-  module Cli
-    VERSION = "0.0.1"
+  class Cli
+    VERSION = '0.0.2'
   end
 end

data/lib/percy/cli.rb

@@ -1,6 +1,63 @@
-require "percy/cli/version"
+require 'commander'
+require 'percy'
+require 'percy/cli/version'
+require 'percy/cli/snapshot'
 
 module Percy
-  module Cli
+  class Cli
+    include Commander::Methods
+    include Percy::Cli::Snapshot
+
+    def say(*args)
+      $terminal.say(*args)
+    end
+
+    def say_error(*args)
+      STDERR.puts *args
+    end
+
+    def run
+      program :name, 'Percy CLI'
+      program :version, Percy::Cli::VERSION
+      program :description, 'Command-line interface for Percy (https://percy.io).'
+      program :help_formatter, :compact
+      default_command :help
+
+      command :snapshot do |c|
+        c.syntax = 'snapshot <root_dir>'
+        c.description = 'Snapshot a folder of static files.'
+        c.option \
+          '--strip_prefix PATH',
+          String,
+          'Directory path to strip from generated URLs. Defaults to the given root directory.'
+        c.option \
+          '--repo STRING',
+          String,
+          'Full GitHub repo slug (owner/repo-name). Defaults to the local git repo origin URL.'
+        c.option \
+          '--snapshots_regex REGEX',
+          String,
+          'Regular expression for matching the files to snapshot. Defaults to: "\.(html|htm)$"'
+        c.option \
+          '--autoload_remote_resources',
+          'Attempts to parse HTML and CSS for remote resources, fetch them, and include in ' +
+          'snapshots. This can be very useful if your static website relies on remote resources.'
+
+        c.action do |args, options|
+          options.default autoload_remote_resources: false
+          raise OptionParser::MissingArgument, 'root folder path is required' if args.empty?
+          if args.length > 1
+            raise OptionParser::MissingArgument, 'only a single root folder path can be given'
+          end
+          root_dir = args.first
+
+          run_snapshot(root_dir, options.__hash__)
+        end
+      end
+
+      run!
+    end
   end
 end
+
+

data/percy-cli.gemspec

@@ -18,8 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'commander', '~> 4'
   spec.add_dependency 'percy-client', '~> 0.2'
+  spec.add_dependency 'faraday', '>= 0.8'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'webmock', '~> 1'
 end

data/spec/percy/cli/snapshot_spec.rb

@@ -0,0 +1,107 @@
+require 'digest'
+
+RSpec.describe Percy::Cli::Snapshot do
+  let(:root_dir) { File.expand_path('../testdata/', __FILE__) }
+
+  describe '#run_snapshot' do
+    xit 'snapshots a root directory of static files' do
+      # TODO(fotinakis): tests for this.
+    end
+  end
+  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'),
+      ])
+    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'),
+      ])
+    end
+  end
+  describe '#find_remote_urls' do
+    it 'returns remote resources referenced throughout the static website' do
+      root_paths = Percy::Cli.new.send(:find_root_paths, root_dir)
+      resource_paths = Percy::Cli.new.send(:find_resource_paths, root_dir)
+
+      remote_urls = Percy::Cli.new.send(:find_remote_urls, root_paths + resource_paths)
+      expect(remote_urls).to match_array([
+        # In index.html:
+        'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css',
+        'http://example.com:12345/test-no-protocol.css',
+        'http://example.com:12345/test-duplicate.css',
+        'http://example.com:12345/test-query-param.css?v=1',
+        'http://example.com:12345/test-single-quotes.css',
+        'http://example.com:12345/test-diff-tag-order.css',
+
+        # In base.css:
+        'http://ajax.googleapis.com/ajax/libs/jqueryui/1.11.4/themes/smoothness/jquery-ui.css',
+      ])
+    end
+  end
+  describe '#build_resources' do
+    it 'returns resource objects' do
+      paths = [File.join(root_dir, 'css/base.css')]
+      resources = Percy::Cli.new.send(:build_resources, paths, root_dir)
+
+      expect(resources.length).to eq(1)
+      expect(resources.first.sha).to eq(Digest::SHA256.hexdigest(File.read(paths.first)))
+      expect(resources.first.is_root).to be_nil
+      expect(resources.first.content).to be_nil
+      expect(resources.first.path).to eq(paths.first)
+    end
+    it 'returns resource objects with is_root set if given' do
+      paths = [File.join(root_dir, 'index.html')]
+      resources = Percy::Cli.new.send(:build_resources, paths, root_dir, is_root: true)
+
+      expect(resources.length).to eq(1)
+      expect(resources.first.resource_url).to eq('/index.html')
+      expect(resources.first.sha).to eq(Digest::SHA256.hexdigest(File.read(paths.first)))
+      expect(resources.first.is_root).to be_truthy
+      expect(resources.first.content).to be_nil
+      expect(resources.first.path).to eq(paths.first)
+    end
+    it 'encodes the resource_url' do
+      paths = [File.join(root_dir, 'css/test with spaces.css')]
+      resources = Percy::Cli.new.send(:build_resources, paths, root_dir)
+
+      expect(resources.length).to eq(1)
+      expect(resources.first.resource_url).to eq('/css/test%20with%20spaces.css')
+      expect(resources.first.sha).to eq(Digest::SHA256.hexdigest(File.read(paths.first)))
+      expect(resources.first.is_root).to be_nil
+      expect(resources.first.content).to be_nil
+      expect(resources.first.path).to eq(paths.first)
+    end
+  end
+  describe '#build_remote_resources' do
+    it 'fetches the remote URLs and creates resource objects' do
+      urls = [
+        'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css',
+        'http://example.com:12345/test-failure.css',
+      ]
+      stub_request(:get, 'http://example.com:12345/test-failure.css').to_return(status: 400)
+
+      resources = Percy::Cli.new.send(:build_remote_resources, urls)
+
+      expect(resources.length).to eq(1)
+      expect(resources[0].resource_url).to eq(urls[0])
+      expect(resources[0].sha).to be
+      expect(resources[0].is_root).to be_nil
+      expect(resources[0].content).to be
+      expect(resources[0].path).to be_nil
+    end
+  end
+  describe '#upload_snapshot' do
+    xit 'uploads the given resources to the build' do
+      # TODO(fotinakis): tests for this.
+    end
+  end
+end

data/spec/percy/cli/testdata/css/base.css

@@ -0,0 +1,4 @@
+@import url( //ajax.googleapis.com/ajax/libs/jqueryui/1.11.4/themes/smoothness/jquery-ui.css);
+@import url('/local/not-included.css');
+
+h1 { color: red; }

data/spec/percy/cli/testdata/css/test with spaces.css

@@ -0,0 +1 @@
+h1 { color: blue; }

data/spec/percy/cli/testdata/index.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+  <title>Test Percy CLI</title>
+  <link href="css/base.css" rel="stylesheet" type="text/css">
+  <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css" rel="stylesheet" type="text/css">
+  <link href="//example.com:12345/test-no-protocol.css" rel="stylesheet" type="text/css">
+  <link href='http://example.com:12345/test-single-quotes.css' rel="stylesheet" type="text/css">
+  <link href="http://example.com:12345/test-query-param.css?v=1" rel="stylesheet" type="text/css">
+
+  <link href="http://example.com:12345/test-duplicate.css" rel="stylesheet" type="text/css">
+  <link href="http://example.com:12345/test-duplicate.css" rel="stylesheet" type="text/css">
+
+  <link rel="stylesheet" type="text/css" href="http://example.com:12345/test-diff-tag-order.css">
+
+  <h1>Hello World!</h1>
+
+  Just some text, should not be included:
+  http://example.com/should-not-be-included.css
+</html>

data/spec/percy/cli/testdata/subdir/test.html

@@ -0,0 +1 @@
+<!DOCTYPE html><html>Hello World!</html>

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'percy/cli'
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4.
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  config.before(:each) do
+    WebMock.disable_net_connect!(allow: [
+      'maxcdn.bootstrapcdn.com',
+      'ajax.googleapis.com',
+    ])
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: percy-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-06-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: percy-client
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 description: ''
 email:
 - team@percy.io
@@ -61,14 +117,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/percy
 - lib/percy/cli.rb
+- lib/percy/cli/snapshot.rb
 - lib/percy/cli/version.rb
 - percy-cli.gemspec
+- spec/percy/cli/snapshot_spec.rb
+- spec/percy/cli/testdata/css/base.css
+- spec/percy/cli/testdata/css/test with spaces.css
+- spec/percy/cli/testdata/css/unrelated-no-extension
+- spec/percy/cli/testdata/images/jellybeans.png
+- spec/percy/cli/testdata/index.html
+- spec/percy/cli/testdata/subdir/test.html
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -93,5 +160,13 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Percy command-line interface
-test_files: []
+test_files:
+- spec/percy/cli/snapshot_spec.rb
+- spec/percy/cli/testdata/css/base.css
+- spec/percy/cli/testdata/css/test with spaces.css
+- spec/percy/cli/testdata/css/unrelated-no-extension
+- spec/percy/cli/testdata/images/jellybeans.png
+- spec/percy/cli/testdata/index.html
+- spec/percy/cli/testdata/subdir/test.html
+- spec/spec_helper.rb
 has_rdoc: