percy-capybara 4.3.3 → 5.0.0.pre.5

data/.rubocop.yml

@@ -1,14 +0,0 @@
-inherit_gem:
-  percy-style:
-    - default.yml
-
-
-RSpec/InstanceVariable:
-  Exclude:
-    - spec/lib/percy/capybara_spec.rb
-
-RSpec/ContextWording:
-  Enabled: false
-
-AllCops:
-  TargetRubyVersion: 2.4

data/.yardopts

@@ -1,2 +0,0 @@
---protected
---no-private

data/CHANGELOG.md

@@ -1 +0,0 @@
-See [releases](https://github.com/percy/percy-capybara/releases).

data/DEVELOPING.md

@@ -1,26 +0,0 @@
-# Developing percy-capybara
-
-You'll need:
-* [Ruby](https://www.ruby-lang.org)
-* [Bundler](https://bundler.io/)
-* [npm](https://www.npmjs.com/), to manage our dependency on [`@percy/agent`](https://www.npmjs.com/package/@percy/agent)
-
-To install dependencies:
-```bash
-$ bundle install
-$ npm install
-```
-
-To run our test suite and create snapshots:
-```bash
-$ bundle exec rake snapshots
-```
-(You'll need a `PERCY_TOKEN` in your environment for snapshots to be uploaded to Percy for diffing.)
-
-If you want to run the test suite without uploading snapshots, you can run:
-```bash
-$ bundle exec rspec
-```
-
-For instructions on releasing, and on updating the vendored version of `percy-agent.js` in this repository, please refer to the [RELEASING](RELEASING.md) doc.
-

data/Gemfile

@@ -1,13 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in percy-capybara.gemspec
-gemspec
-
-gem 'guard-rspec', require: false
-
-# (for development)
-# gem 'percy-client', path: '~/src/percy-client'
-
-group :test, :development do
-  gem 'pry'
-end

data/Guardfile

@@ -1,14 +0,0 @@
-guard :rspec, cmd: 'bundle exec rspec' do
-  require 'guard/rspec/dsl'
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-end

data/RELEASING.md

@@ -1,23 +0,0 @@
-# Releasing
-
-1. `git checkout master`
-1. `git pull origin master`
-1. `git checkout -b X.X.X`
-1. Update version.rb file accordingly.
-1. Commit and push the version update
-1. Tag the release: `git tag vX.X.X`
-1. Push changes: `git push --tags`
-1. Ensure tests have passed on that tag
-1. Open up a pull request titled with the new version number
-1. Merge approved pull request
-1. Draft and publish a [new release on github](https://github.com/percy/percy-capybara/releases)
-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/Rakefile

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

data/lib/environment.rb

@@ -1,38 +0,0 @@
-require_relative './version'
-
-module Percy
-  def self.client_info
-    "percy-capybara/#{VERSION}"
-  end
-
-  def self.environment_info
-    env_strings = [
-      "rails/#{self._rails_version}",
-      "sinatra/#{self._sinatra_version}",
-      "capybara/#{self.capybara_version}",
-      "ember-cli-rails/#{self._ember_cli_rails_version}",
-    ].reject do |info|
-      info =~ /\/$/ # reject if version is empty
-    end
-    env_strings.empty? ? 'unknown' : env_strings.join('; ')
-  end
-
-  def self.capybara_version
-    Capybara::VERSION if defined? Capybara
-  end
-
-  def self._ember_cli_rails_version
-    return unless defined? EmberCli
-
-    require 'ember_cli/version'
-    EmberCli::VERSION
-  end
-
-  def self._rails_version
-    Rails.version if defined? Rails
-  end
-
-  def self._sinatra_version
-    Sinatra::VERSION if defined? Sinatra
-  end
-end

data/lib/percy.rb

@@ -1,142 +0,0 @@
-require 'logger'
-require 'net/http'
-require 'uri'
-require 'json'
-require 'environment'
-
-module Percy
-  # Takes a snapshot of the given page HTML and its assets.
-  #
-  # See https://docs.percy.io/v1/docs/configuration for detailed documentation on
-  # snapshot options.
-  #
-  # @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 [Array(Number)] :widths Widths, in pixels, that you'd like to capture for
-  #   this snapshot.
-  def self.snapshot(page, options = {})
-    return unless self._is_agent_running?
-
-    if !options.has_key?(:name)
-      options[:name] = page.current_url
-    end
-
-    domSnapshot = self._make_dom_snapshot(page, self._keys_to_json(options))
-    return unless domSnapshot
-
-    body = {
-      url: page.current_url,
-      domSnapshot: domSnapshot,
-      clientInfo: Percy.client_info,
-      environmentInfo: Percy.environment_info,
-    }
-
-    body = body.merge(self._keys_to_json(options))
-
-    if self._is_debug?
-      self._logger.info { "passed snapshot options: #{options}" }
-      self._logger.info { "snapshot object to POST: #{body}" }
-    end
-
-    self._post_snapshot_to_agent(body)
-  end
-
-  private
-
-  AGENT_HOST = 'localhost'
-  # Technically, the port is configurable when you run the agent. One day we might want
-  # to make the port configurable in this SDK as well.
-  AGENT_PORT = 5338
-  AGENT_JS_PATH= '/percy-agent.js'
-
-  def self._logger
-    unless defined?(@logger)
-      @logger = Logger.new(STDOUT)
-      @logger.formatter = proc do |_severity, _datetime, _progname, msg|
-        "[percy] #{msg} \n"
-      end
-    end
-    return @logger
-  end
-
-  def self._get_agent_js
-    begin
-      return Net::HTTP.get(AGENT_HOST, AGENT_JS_PATH, AGENT_PORT)
-    rescue => e
-      self._logger.error { "Could not load #{AGENT_JS_PATH}. Error: #{e}" }
-      return nil
-    end
-  end
-
-  def self._make_dom_snapshot(page, options)
-    agent_js = self._get_agent_js
-    return unless agent_js
-
-    begin
-      page.execute_script(agent_js)
-      domsnapshot_js = "return new window.PercyAgent({ handleAgentCommunication: false }).domSnapshot(document, #{options.to_json})"
-
-      # If we can use evalaute, use it (generally for capybara drivers)
-      # `execute_script` should work, but some Capybara drivers specifically return nil from this method
-      if page.respond_to?('evaluate_script')
-        dom_snapshot = page.evaluate_script("(function() { #{domsnapshot_js} })()")
-      else
-        # if the driver doesn't have evaluate, it's probably a selenium driver
-        dom_snapshot = page.execute_script(domsnapshot_js)
-      end
-
-      return dom_snapshot
-    rescue => e
-      self._logger.error { "DOM snapshotting failed. Error: #{e}" }
-      return nil
-    end
-  end
-
-  def self._post_snapshot_to_agent(body)
-    http = Net::HTTP.new(AGENT_HOST, AGENT_PORT)
-    request = Net::HTTP::Post.new('/percy/snapshot', { 'Content-Type': 'application/json' })
-    request.body = body.to_json
-
-    begin
-      response = http.request(request)
-    rescue => e
-      self._logger.error { "Percy rejected snapshot request. Error: #{e}" }
-    end
-  end
-
-  def self._is_agent_running?
-    begin
-      Net::HTTP.get(AGENT_HOST, '/percy/healthcheck', AGENT_PORT)
-      return true
-    rescue => e
-      if self._is_debug?
-        self._logger.error { "Healthcheck failed, Percy is not running: #{e}" }
-      end
-
-      return false
-    end
-  end
-
-  # For Ruby style, require snake_case args but transform them into camelCase for percy-agent.
-  def self._keys_to_json(options)
-    {
-      enable_javascript: :enableJavaScript,
-      min_height: :minHeight,
-      percy_css: :percyCSS,
-      request_headers: :requestHeaders,
-    }.each do |ruby_key, json_key|
-      if options.has_key? ruby_key
-        options[json_key] = options[ruby_key]
-        options.delete(ruby_key)
-      end
-    end
-    return options
-  end
-
-  def self._is_debug?
-    ENV['LOG_LEVEL'] == 'debug'
-  end
-end

data/lib/version.rb

@@ -1,3 +0,0 @@
-module Percy
-  VERSION = '4.3.3'.freeze
-end

data/package.json

@@ -1,6 +0,0 @@
-{
-  "private": true,
-  "devDependencies": {
-    "@percy/agent": "~0"
-  }
-}

data/percy-capybara.gemspec

@@ -1,32 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'percy-capybara'
-  spec.version       = Percy::VERSION
-  spec.authors       = ['Perceptual Inc.']
-  spec.email         = ['team@percy.io']
-  spec.summary       = %q{Percy}
-  spec.description   = %q{}
-  spec.homepage      = ''
-  spec.license       = 'MIT'
-
-  spec.metadata = {
-    'bug_tracker_uri' => 'https://github.com/percy/percy-capybara/issues',
-    'source_code_uri' => 'https://github.com/percy/percy-capybara',
-  }
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '>= 2.0'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'capybara', '~> 3.31'
-  spec.add_development_dependency 'selenium-webdriver'
-  spec.add_development_dependency 'percy-style', '~> 0.7.0'
-end

data/spec/lib/percy/environment_spec.rb

@@ -1,26 +0,0 @@
-RSpec.describe Percy do
-  subject(:our_module) { Percy }
-
-  describe '#environment_info' do
-    subject(:environment_info) { Percy.environment_info }
-
-    context 'an app with Rails, Sinatra and Ember Cli Rails' do
-      it 'returns full environment information' do
-        expect(our_module).to receive(:_rails_version).at_least(:once).times.and_return('4.2')
-        expect(our_module).to receive(:_sinatra_version).at_least(:once).and_return('2.0.0')
-        expect(our_module).to receive(:capybara_version).at_least(:once).and_return(Capybara::VERSION)
-        expect(our_module).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; capybara/#{Capybara::VERSION}; ember-cli-rails/0.9")
-      end
-    end
-  end
-
-  describe '#client_info' do
-    subject(:client_info) { Percy.client_info }
-
-    it 'includes client information' do
-      expect(client_info).to eq("percy-capybara/#{Percy::VERSION}")
-    end
-  end
-end

data/spec/lib/percy/percy_spec.rb

@@ -1,72 +0,0 @@
-# coding: utf-8
-RSpec.describe Percy, type: :feature do
-  TEST_CASE_GLOB =  File.join(File.dirname(__FILE__), "./capybara/client/test_data/test-*.html")
-
-  describe '#snapshot', type: :feature, js: true do
-    context 'with live sites' do
-      it 'snapshots simple HTTPS site' do
-        visit 'https://example.com'
-        Percy.snapshot(page)
-      end
-      it 'snapshots complex HTTPS site' do
-        visit 'https://polaris.shopify.com/'
-        Percy.snapshot(page)
-      end
-      it 'snapshots site with strict CSP' do
-        visit 'https://buildkite.com/'
-        Percy.snapshot(page)
-      end
-    end
-    context 'with different options' do
-      it 'can get a default name' do
-        visit 'http://example.com'
-        Percy.snapshot(page)
-      end
-      it 'uses query params and fragment for default name' do
-        visit 'http://example.com/?with_query'
-        Percy.snapshot(page)
-        visit 'http://example.com/?with_query_params#and-fragment'
-        Percy.snapshot(page)
-      end
-      it 'uses provided name' do
-        visit 'http://example.com'
-        Percy.snapshot(page, name: 'My very special snapshot 🌟')
-      end
-      it 'recognizes requested widths' do
-        visit 'http://example.com'
-        Percy.snapshot(page, { name: 'widths', widths: [768, 992, 1200] })
-      end
-      it 'recognizes minHeight' do
-        visit 'http://example.com'
-        Percy.snapshot(page, { name: 'minHeight', minHeight: 2000 })
-      end
-      it 'recognizes enable_javascript' do
-        visit 'http://example.com'
-        Percy.snapshot(page, { name: 'enableJavaScript', enable_javascript: true })
-      end
-      it 'recognizes percy_css' do
-        visit 'http://example.com'
-        Percy.snapshot(page, { name: 'percyCSS', percy_css: "body {background-color: purple }" })
-      end
-    end
-  end
-
-  describe '_keys_to_json' do
-    it 'transforms keys from snake_case to JSON-style' do
-      original = {
-        enable_javascript: true,
-        min_height: 2000,
-        percy_css: "iframe { display: none; }",
-        request_headers: { Authorization: "Basic abc123=" },
-      }
-      transformed = Percy._keys_to_json(original)
-      expect(transformed.has_key? 'enableJavaScript')
-      expect(transformed.has_key? 'percyCSS')
-      expect(transformed.has_key? 'minHeight')
-      expect(transformed['enableJavaScript']).to eq(original[:enable_javascript])
-      expect(transformed['minHeight']).to eq(original[:min_height])
-      expect(transformed['percyCSS']).to eq(original[:percy_css])
-      expect(transformed['requestHeaders']).to eq(original[:request_headers])
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,33 +0,0 @@
-require 'capybara/rspec'
-require 'selenium-webdriver'
-require 'percy'
-
-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!
-  # config.warnings = true
-
-  # 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
-
-  # See https://github.com/teamcapybara/capybara#selecting-the-driver for other options
-  Capybara.default_driver = :selenium_headless
-  Capybara.javascript_driver = :selenium_headless
-end