percy-capybara 4.3.3 → 5.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 717ca7b919d62141b87ac78e8e4df1a8a47770456afbd41e03aa264fbb1d50c8
-  data.tar.gz: 5056d828fa6d4780f135302346a9db2d1de372ccc79a12fd0c425ea95b0109ae
+  metadata.gz: 41d7750c08015a049fe7e96a1bef9fa66e63ab4f8d46470745dca33785381938
+  data.tar.gz: 134b1bb862eddc96233205c664ec06e2573a6eff10aa17c8a182ca6740c98510
 SHA512:
-  metadata.gz: 39c1cb571277f052fd9650174b616f6fc1e35dab61a5aa54bd0cca9d9241ee056a3e92ba88d40a208792397c0fc64e4f3e54803104dea296ba85a365876d85b7
-  data.tar.gz: bd59a0f4e2614cdc0c09f9ee9496ac0257d6743ae6b54e3168468f0bc13686f8fb0737722499e0fdff47e241624cd3ec66906769174348433a1bc60eee9e7cca
+  metadata.gz: c136d0dab551741667317aad40b5309d6153bca15add7a12923327340b5810e181b0b6234e6f6c8b522a8ff6bc63f852fac3a1a76661e4b7b2775da985420e01
+  data.tar.gz: 90ff43e7d90292c828703b9220c03e798dfbffbe23f10a71317035605baed181fc4ece0d5720fca27fc41c966069243cd0e7a321afe9b7cd611092b1c62dc70c

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: /
+  schedule:
+    interval: weekly
+  commit-message:
+    prefix: ⬆️

data/.github/release-drafter.yml

@@ -0,0 +1,31 @@
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+categories:
+  - title: '💥 Breaking Changes'
+    labels:
+      - breaking
+  - title: '✨ Enhancements'
+    labels:
+      - feature
+      - enhancement
+  - title: '🐛 Bug Fixes'
+    labels:
+      - fix
+      - bugfix
+      - bug
+  - title: '🏗  Maintenance'
+    labels:
+      - chore
+      - dependencies
+change-title-escapes: '\<*_&#@'
+version-resolver:
+  major:
+    labels:
+      - breaking
+  minor:
+    labels:
+      - feature
+      - enhancement
+  default: patch
+template: '$CHANGES'
+prerelease: true

data/.github/workflows/changelog.yml

@@ -0,0 +1,11 @@
+name: Changelog
+on:
+  push:
+    branches: [master]
+jobs:
+  update_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: release-drafter/release-drafter@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+name: Lint
+on:
+  push:
+    branches: [master]
+  pull_request:
+  workflow_dispatch:
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+          bundler-cache: true
+      - uses: actions/cache@v2
+        with:
+          path: "./vendor/bundle"
+          key: v1/${{ runner.os }}/ruby-2.6/${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: v1/${{ runner.os }}/ruby-2.6/
+      - run: bundle exec rubocop

data/.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Release
+on:
+  release:
+    types: [published]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+          bundler-cache: true
+      - uses: actions/cache@v2
+        with:
+          path: "./vendor/bundle"
+          key: v1/${{ runner.os }}/ruby-2.6/${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: v1/${{ runner.os }}/ruby-2.6/
+      - uses: cadwallion/publish-rubygems-action@master
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RELEASE_COMMAND: make release

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Test
+on:
+  push:
+    branches: [master]
+  pull_request:
+  workflow_dispatch:
+jobs:
+  test:
+    name: Test
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        ruby: ['2.6', '2.7']
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+          bundler-cache: true
+      - uses: actions/cache@v2
+        with:
+          path: "./vendor/bundle"
+          key: v1/${{ runner.os }}/ruby-${{ matrix.ruby }}/${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: v1/${{ runner.os }}/ruby-${{ matrix.ruby }}/
+      - run: bundle exec rspec

data/.rubocop.yml

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

data/Gemfile

@@ -10,4 +10,7 @@ gem 'guard-rspec', require: false
 
 group :test, :development do
   gem 'pry'
+  gem 'puma'
+  gem 'webmock'
+  gem 'simplecov', require: false
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Perceptual Inc.
+Copyright (c) 2021 Perceptual Inc.
 
 The MIT License (MIT)
 

data/Makefile

@@ -0,0 +1,3 @@
+release:
+	rake build
+	gem push pkg/percy-capybara-*

data/README.md

@@ -1,6 +1,100 @@
-# Percy Capybara
+# percy-capybara
+[![Gem Version](https://badge.fury.io/rb/percy-capybara.svg)](https://badge.fury.io/rb/percy-capybara)
+![Test](https://github.com/percy/percy-capybara/workflows/Test/badge.svg)
 
-[![CircleCI](https://circleci.com/gh/percy/percy-capybara.svg?style=svg)](https://circleci.com/gh/percy/percy-capybara)
-[![Gem Version](https://badge.fury.io/rb/percy-capybara.svg)](http://badge.fury.io/rb/percy-capybara)
+[Percy](https://percy.io) visual testing for Ruby Selenium.
 
-#### Docs here: [https://docs.percy.io/docs/capybara](https://docs.percy.io/docs/capybara)
+## Installation
+
+npm install `@percy/cli`:
+
+```sh-session
+$ npm install --save-dev @percy/cli
+```
+
+gem install `percy-capybara` package:
+
+```ssh-session
+$ gem install percy-capybara
+```
+
+## Usage
+
+In your test setup file, require `percy/capybara`. For example if you're using
+rspec, you would add the following to your `spec_helper.rb` file:
+
+``` ruby
+require 'percy/capybara'
+```
+
+Now you can use `page.percy_snapshot` to capture snapshots.
+
+> Note: you may need to add `js: true` to your specs, depending on your driver setup
+
+```ruby
+describe 'my feature, type: :feature do
+  it 'renders the page' do
+    visit 'https://example.com'
+    page.percy_snapshot('Capybara snapshot')
+  end
+end
+```
+
+Running the test above normally will result in the following log:
+
+```sh-session
+[percy] Percy is not running, disabling snapshots
+```
+
+When running with [`percy
+exec`](https://github.com/percy/cli/tree/master/packages/cli-exec#percy-exec), and your project's
+`PERCY_TOKEN`, a new Percy build will be created and snapshots will be uploaded to your project.
+
+```sh-session
+$ export PERCY_TOKEN=[your-project-token]
+$ percy exec -- [test command]
+[percy] Percy has started!
+[percy] Created build #1: https://percy.io/[your-project]
+[percy] Snapshot taken "Capybara example"
+[percy] Stopping percy...
+[percy] Finalized build #1: https://percy.io/[your-project]
+[percy] Done!
+```
+
+## Configuration
+
+`page.snapshot(name[, options])`
+
+- `name` (**required**) - The snapshot name; must be unique to each snapshot
+- `options` - [See per-snapshot configuration options](https://docs.percy.io/docs/cli-configuration#per-snapshot-configuration)
+
+## Upgrading
+
+### Manually
+
+#### Require change
+
+The name of the require has changed from `require 'percy'` to `require
+'percy/capybara'`. This is to avoid conflict with our [Ruby Selenium SDK's](https://github.com/percy/percy-selenium-ruby)
+require statement.
+
+#### Installing `@percy/cli` & removing `@percy/agent`
+
+If you're coming from a 4.x version of this package, make sure to install `@percy/cli` after
+upgrading to retain any existing scripts that reference the Percy CLI
+command. You will also want to uninstall `@percy/agent`, as it's been replaced
+by `@percy/cli`.
+
+```sh-session
+$ npm uninstall @percy/agent
+$ npm install --save-dev @percy/cli
+```
+
+#### Migrating config
+
+If you have a previous Percy configuration file, migrate it to the newest version with the
+[`config:migrate`](https://github.com/percy/cli/tree/master/packages/cli-config#percy-configmigrate-filepath-output) command:
+
+```sh-session
+$ percy config:migrate
+```

data/lib/percy/capybara.rb

@@ -0,0 +1,111 @@
+require 'net/http'
+require 'uri'
+require 'capybara/dsl'
+
+module PercyCapybara
+  include Capybara::DSL
+
+  CLIENT_INFO = "percy-capybara/#{VERSION}".freeze
+  ENV_INFO = "capybara/#{Capybara::VERSION} ruby/#{RUBY_VERSION}".freeze
+
+  PERCY_DEBUG = ENV['PERCY_LOGLEVEL'] == 'debug'
+  PERCY_SERVER_ADDRESS = ENV['PERCY_SERVER_ADDRESS'] || 'http://localhost:5338'
+  PERCY_LABEL = "[\u001b[35m" + (PERCY_DEBUG ? 'percy:capybara' : 'percy') + "\u001b[39m]"
+
+  private_constant :CLIENT_INFO
+  private_constant :ENV_INFO
+
+  # Take a DOM snapshot and post it to the snapshot endpoint
+  def percy_snapshot(name, options = {})
+    return unless percy_enabled?
+
+    begin
+      page.evaluate_script(fetch_percy_dom)
+      dom_snapshot =
+        page.evaluate_script("(function() { return PercyDOM.serialize(#{options.to_json}) })()")
+
+      response = fetch('percy/snapshot',
+        name: name,
+        url: page.current_url,
+        dom_snapshot: dom_snapshot,
+        client_info: CLIENT_INFO,
+        environment_info: ENV_INFO,)
+
+      unless response.body.to_json['success']
+        raise StandardError, data['error']
+      end
+    rescue StandardError => e
+      log("Could not take DOM snapshot '#{name}'")
+
+      if PERCY_DEBUG then log(e) end
+    end
+  end
+
+  # Determine if the Percy server is running, caching the result so it is only checked once
+  private def percy_enabled?
+    return @percy_enabled unless @percy_enabled.nil?
+
+    begin
+      response = fetch('percy/healthcheck')
+      version = response['x-percy-core-version']
+
+      if version.nil?
+        log('You may be using @percy/agent ' \
+            'which is no longer supported by this SDK. ' \
+            'Please uninstall @percy/agent and install @percy/cli instead. ' \
+            'https://docs.percy.io/docs/migrating-to-percy-cli')
+        @percy_enabled = false
+        return false
+      end
+
+      if version.split('.')[0] != '1'
+        log("Unsupported Percy CLI version, #{version}")
+        @percy_enabled = false
+        return false
+      end
+
+      @percy_enabled = true
+      true
+    rescue StandardError => e
+      log('Percy is not running, disabling snapshots')
+
+      if PERCY_DEBUG then log(e) end
+      @percy_enabled = false
+      false
+    end
+  end
+
+  # Fetch the @percy/dom script, caching the result so it is only fetched once
+  private def fetch_percy_dom
+    return @percy_dom unless @percy_dom.nil?
+
+    response = fetch('percy/dom.js')
+    @percy_dom = response.body
+  end
+
+  private def log(msg)
+    puts "#{PERCY_LABEL} #{msg}"
+  end
+
+  # Make an HTTP request (GET,POST) using Ruby's Net::HTTP. If `data` is present,
+  # `fetch` will POST as JSON.
+  private def fetch(url, data = nil)
+    uri = URI("#{PERCY_SERVER_ADDRESS}/#{url}")
+
+    response = if data
+      Net::HTTP.post(uri, data.to_json)
+    else
+      Net::HTTP.get_response(uri)
+    end
+
+    unless response.is_a? Net::HTTPSuccess
+      raise StandardError, "Failed with HTTP error code: #{response.code}"
+    end
+
+    response
+  end
+end
+
+# Add the `percy_snapshot` method to the the Capybara session class
+# `page.percy_snapshot('name', { options })`
+Capybara::Session.class_eval { include PercyCapybara }

data/lib/percy/version.rb

@@ -0,0 +1,3 @@
+module PercyCapybara
+  VERSION = '5.0.0.pre.1'.freeze
+end

data/percy-capybara.gemspec

@@ -1,17 +1,18 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'version'
+require 'percy/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'percy-capybara'
-  spec.version       = Percy::VERSION
+  spec.version       = PercyCapybara::VERSION
   spec.authors       = ['Perceptual Inc.']
   spec.email         = ['team@percy.io']
   spec.summary       = %q{Percy}
   spec.description   = %q{}
   spec.homepage      = ''
   spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.3.0'
 
   spec.metadata = {
     'bug_tracker_uri' => 'https://github.com/percy/percy-capybara/issues',
@@ -23,10 +24,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'capybara', '>= 3'
+
+  spec.add_development_dependency 'selenium-webdriver', '>= 4.0.0.beta1'
   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/fixture/index.html

@@ -0,0 +1 @@
+<html><head><title>I am a page</title></head><body>Snapshot me</body></html>