capybara-screenshot-diff 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4b74b3421312a6837944115244ae03eb5b59b65b28dd21fed17ad9f13672b32
-  data.tar.gz: 9d60292db9261447214601ff3e498adb81cb5ce51899db8c19f18ac66ea53d6c
+  metadata.gz: 36a36588af46fa270b2ceefd1961ff3d5c1038c19207228d318335bc89bfb25a
+  data.tar.gz: dfc8f5c3e53a90d20a0495aa711de8673f911921ccf8a80f2f65424ea80aba2a
 SHA512:
-  metadata.gz: c529cfbf50e5b11251d4c44115713a99aac84c712dc62770d6cdc735adeba814ffc62e68acaa2fdf8e77fc6171b37269b37fbb2d669915a80a44c4d9ef7a523a
-  data.tar.gz: 9b6f02f0c296a53fca5acba02b36b838bc83ac8616606029f44122a08537b930e122ce1398ec152f2dfc02e65b207042ba24c37f899cb7d6586c2588c6cd60f6
+  metadata.gz: 297bfe8a02628427201a60a3c3411f10310baa9e6501af8564b8b7b752aabb8f0e6ebd287eb2e8b20e0c8e3818c00badb7ef2978c8b471958fca16fe4b6d1bfd
+  data.tar.gz: 6bd4276e3cf6f1f8a5b2d59eaf8d4121c49c598824463b7112f83f7434d9b744724edf95cd933c3ea2a61e4946926cdfac1b4745536952cbde48ebcb31532be6

data/.gitattributes

@@ -0,0 +1,4 @@
+*.gemspec diff=ruby
+*.rake    diff=ruby
+*.rb      diff=ruby
+*.md      diff=md

data/.github/workflows/test.yml

@@ -0,0 +1,129 @@
+name: Test
+
+on:
+  push:
+    branches: [ $default-branch ]
+  pull_request:
+
+env:
+  BUNDLE_GEMFILE: 'gemfiles/rails61_gems.rb'
+  FERRUM_PROCESS_TIMEOUT: '15'
+  WD_CACHE_TIME: '864000' # 10 days
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+
+      - name: Run Standard Ruby linter
+        run: bin/standardrb --no-fix --fail-fast
+
+  test:
+    name: Functional Testing
+    runs-on: ubuntu-20.04 # In order to install libvips 8.9+ version
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+
+      - name: Install libvips
+        run: sudo apt install libvips libvips-dev libvips-tools
+
+      - name: Run Tests with coverage
+        run: bundle exec rake test
+        env:
+          COVERAGE: enabled
+
+      - name: Upload Screenshots
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v2
+        with:
+          path: test/fixtures/app/doc/screenshots/
+
+      - name: Upload Coverage
+        uses: actions/upload-artifact@v2
+        with:
+          name: coverage
+          path: coverage
+
+  matrix:
+    name: Test Integration
+    needs: [ 'test', 'lint' ]
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        ruby-version: [ '2.7', '2.6', '2.5', 'jruby' ]
+        gemfile:
+          - 'rails61_gems.rb'
+          - 'rails60_gems.rb'
+          - 'rails52.gemfile'
+          - 'rails51.gemfile'
+          - 'rails50.gemfile'
+          - 'rails42.gemfile'
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Install libvips
+        run: sudo apt install libvips libvips-dev libvips-tools
+
+      - name: Run tests
+        run: bundle exec rake test
+
+  matrix_screenshot_driver:
+    name: Test Integration
+    needs: [ 'test', 'lint' ]
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        screenshot-driver: [ 'vips', 'chunky_png' ]
+        capybara-driver: [ 'selenium_headless', 'selenium_chrome_headless' ]
+        include:
+          - screenshot-driver: 'chunky_png'
+            capybara-driver: 'cuprite'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+
+      - name: Install libvips
+        run: sudo apt install libvips libvips-dev libvips-tools
+
+      - name: Run tests
+        run: bundle exec rake test:integration
+        env:
+          SCREENSHOT_DRIVER: ${{ matrix.screenshot-driver }}
+          CAPYBARA_DRIVER: ${{ matrix.capybara-driver }}

data/.gitignore

@@ -2,11 +2,11 @@
 /.bundle/
 /.idea
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /gemfiles/*.lock
+/gems.locked
 /pkg/
 /spec/reports/
 /tmp/

data/.standard.yml

@@ -0,0 +1,11 @@
+fix: true               # default: false
+parallel: true          # default: false
+format: progress        # default: Standard::Formatter
+ruby_version: 2.5       # default: RUBY_VERSION
+default_ignores: false  # default: true
+
+ignore:                 # default: []
+  - 'gemfiles/**/*':
+    - Security/Eval
+  - 'gemfiles/vendor/**/*'
+  - 'vendor/**/*'

data/Dockerfile

@@ -0,0 +1,60 @@
+# Usage:
+#
+#   $ docker build . -t csd
+#   $ docker run -v $(pwd):/app -ti csd rake test
+
+ARG RUBY_VERSION=2.7.2
+
+FROM circleci/ruby:2.7.2-node-browsers
+
+RUN \
+  # Install dependencies
+  sudo apt-get update && \
+  DEBIAN_FRONTEND=noninteractive sudo apt-get install -y \
+    automake \
+    build-essential \
+    curl \
+    fftw3-dev \
+    gettext \
+    gobject-introspection \
+    gtk-doc-tools \
+    libexif-dev \
+    libfftw3-dev \
+    libgif-dev \
+    libglib2.0-dev \
+    libgsf-1-dev \
+    libgtk2.0-dev \
+    libmagickwand-dev \
+    libmatio-dev \
+    libopenexr-dev \
+    libopenslide-dev \
+    liborc-0.4-dev \
+    libpango1.0-dev \
+    libpoppler-glib-dev \
+    librsvg2-dev \
+    libtiff5-dev \
+    libwebp-dev \
+    libxml2-dev \
+    swig
+
+
+WORKDIR /app
+RUN sudo chmod a+w -R /app
+
+ADD ./bin/install-vips /app/bin/
+RUN sudo /app/bin/install-vips
+
+ADD ./lib/capybara/screenshot/diff/version.rb /app/lib/capybara/screenshot/diff/
+ADD ./capybara-screenshot-diff.gemspec /app/
+ADD ./gems.rb /app/
+
+RUN bundle install
+
+RUN \
+  # Clean up
+  sudo apt-get remove -y curl automake build-essential && \
+  sudo apt-get autoremove -y && \
+  sudo apt-get autoclean && \
+  sudo apt-get clean && \
+  sudo rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+

data/README.md

@@ -27,6 +27,10 @@ Or install it yourself as:
 
     $ gem install capybara-screenshot-diff
 
+### Requirements
+
+* [for :vips driver] libvips 8.9 or later, see the [libvips install instructions](https://libvips.github.io/libvips/install.html)
+
 ## Usage
 
 ### Minitest
@@ -164,6 +168,24 @@ doc
 ```
 
 
+#### Setting `screenshot_section` and/or `screenshot_group` for all tests
+
+Setting the `screenshot_section` and/or `screenshot_group` for all tests can be
+done in the super class setup:
+
+```ruby
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  setup do
+    screenshot_section class_name.underscore.sub(/(_feature|_system)?_test$/, '')
+    screenshot_group name[5..-1]
+  end
+end
+```
+
+`screenshot_section` and/or `screenshot_group` can still be overridden in each
+test.
+
+
 
 ### Multiple Capybara drivers
 
@@ -274,7 +296,7 @@ configuration options that that are relevant.
 The most likely one you'll want to modify is ...
 
 ```ruby
-Capybara::Screenshot::Diff.save_path = "other/path"
+Capybara::Screenshot.save_path = "other/path"
 ```
 
 The `save_path` option is relative to `Capybara::Screenshot.root`.
@@ -295,10 +317,29 @@ shot will be taken and compared to the first.  This is repeated until two
 subsequent screen shots are identical.
 
 ```ruby
-Capybara::Screenshot.stability_time_limit = 0.5
+Capybara::Screenshot.stability_time_limit = 0.1
 ```
 
+This can be overridden on a single screenshot:
 
+```ruby
+test 'stability_time_limit' do
+  visit '/'
+  screenshot 'index', stability_time_limit: 0.5
+end
+```
+
+### Maximum wait limit
+
+When the `stability_time_limit` is set, but no stable screenshot can be taken, a timeout occurs.
+The timeout occurs after `Capybara.default_max_wait_time`, but can be overridden by an option.
+
+```ruby
+test 'max wait time' do
+  visit '/'
+  screenshot 'index', wait: 20.seconds
+end
+```
 
 ### Removing focus from the active element
 
@@ -415,10 +456,70 @@ If you need to ignore multiple areas, you can supply an array of arrays:
 screenshot 'index', skip_area: [[0, 0, 64, 48], [17, 6, 27, 16]]
 ```
 
+### Available Image Processing Drivers
+
+There are several image processing supported by this gem.
+There are several options to setup active driver: `:auto`, `:chunky_png` and `:vips`.
+
+* `:auto` - will try to load `:vips` if there is gem `ruby-vips`, in other cases will load `:chunky_png`
+* `:chunky_png` and `:vips` will load correspondent driver  
+
+### Enable VIPS image processing
+
+[Vips](https://www.rubydoc.info/gems/ruby-vips/Vips/Image) driver provides a faster comparison,
+and could be enabled by adding `ruby-vips` to `Gemfile`.
+
+If need to setup explicitly Vips driver, there are several ways to do this:
+
+  * Globally: `Capybara::Screenshot::Diff.driver = :vips`  
+  * Per screenshot option: `screenshot 'index', driver: :vips`  
+
+With enabled VIPS there are new alternatives to process differences, which easier to find and support.
+For example, `shift_distance_limit` is very heavy operation. Instead better to use `median_filter_window_size`. 
+
+#### Tolerance level (vips only)
+
+You can set a “tolerance” anywhere from 0% to 100%. This is the amount of change that's allowable.
+If the screenshot has changed by more than that amount, it'll flag it as a failure.
+
+This is alternative to "Allowed difference size", only the difference that area calculates including valid pixels.
+But "tolerance" compares only different pixels.
+
+You can use the `tolerance` option to the `screenshot` method to set level:
+
+```ruby
+test 'unstable area' do
+  visit '/'
+  screenshot 'index', tolerance: 0.3
+end
+```
+
+You can also set this globally:
+
+```ruby
+Capybara::Screenshot::Diff.tolerance = 0.3
+```
+
+#### Median filter size (vips only)
+
+This is an alternative to "Allowed shift distance", but much faster.
+You can find more about this strategy on [Median Filter](https://en.wikipedia.org/wiki/Median_filter).
+Think about this like smoothing of the image, before comparison.
+
+You can use the `median_filter_window_size` option to the `screenshot` method to set level:
+
+```ruby
+test 'unstable area' do
+  visit '/'
+  screenshot 'index', median_filter_window_size: 2
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake test` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
@@ -426,7 +527,9 @@ To release a new version, update the version number in `lib/capybara/screenshot/
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/donv/capybara-screenshot-diff. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/donv/capybara-screenshot-diff.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/Rakefile

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 task default: :test
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new
-task test: %i[rubocop:auto_correct]
+Rake::TestTask.new("test:integration") do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/integration/**/*_test.rb"]
+end

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'capybara/screenshot/diff'
+require "bundler/setup"
+require "capybara/screenshot/diff"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'capybara/screenshot/diff'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start

data/bin/install-vips

@@ -0,0 +1,11 @@
+#!/bin/bash 
+
+set -e
+
+version=${VIPS_VERSION:-8.10.0}
+
+wget "https://github.com/libvips/libvips/releases/download/v$version/vips-$version.tar.gz"
+tar xf "vips-$version.tar.gz"
+cd "vips-$version"
+CXXFLAGS=-D_GLIBCXX_USE_CXX11_ABI=0 ./configure --enable-debug=no --without-python "$*"
+make && make install && ldconfig