capybara-screenshot-diff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c7078265d4d0fc01429989f9b8d67a60773ccab
+  data.tar.gz: 0bee455268a6e5ecf65549a22ff35c85c5b56327
+SHA512:
+  metadata.gz: 9003b9fb66fa3e2206ee771d288963d26a85a2bb26b0d643dc357b5647e5b5915083b44e547daf6e2cafa4aba5791853b9496c8dce3a79372214da1a50a13343
+  data.tar.gz: 8fcfca1b48a99fa3b14b8b1270d48af12ecd1dc9f30ffc002c0fdaaff79fdfb728cb3e6516fb2724aec7ca921ede6dc00a9165607c2d4f7e024776f446423aec

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from: .rubocop_todo.yml
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+
+Style/SignalException:
+  EnforcedStyle: semantic

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - jruby-9.0.4.0
+  - jruby-9.0.5.0
+  - jruby-head
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capybara-screenshot-diff.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Uwe Kubosch
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,207 @@
+# Capybara::Screenshot::Diff
+
+Ever wondered what your project looked like two years ago?  To answer that, you
+start taking screen shots during your tests.  Capybara provides the
+`save_screenshot` method for this.  Very good.
+
+Ever introduced a graphical chnage unintended?  Never want it to happen again?
+Then this gem is gfor you!  Use this gem to detect changes in your pages by
+taking screen shots and comparing them to the previous revision.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capybara-screenshot-diff'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara-screenshot-diff
+
+## Usage
+
+Add `screenshot '<my_feature>'` to your tests.  The screenshot will be saved in
+the `doc/screenshots` directory.
+
+Change your existing `save_screenshot` calls to `screenshot`
+
+```ruby
+test 'my useful feature' do
+  visit '/'
+  screenshot 'welcome_index'
+  click_button 'Useful feature'
+  screenshot 'feature_index'
+  click_button 'Perform action'
+  screenshot 'action_performed'
+end
+```
+
+This will produce a sequence of images like this
+
+```
+doc
+  screenshots
+    action_performed
+    feature_index
+    welcome_index
+```
+
+To store the screen shot history, add the `doc/screenshots` directory to your
+ version control system (git, svn, etc).
+
+### Screenshot groups
+
+Commonly it is useful to group screenshots around a feature, and record them as
+a sequence.  To do this, add a `screenshot_group` call to the start of your
+test.
+
+```ruby
+test 'my useful feature' do
+  screenshot_group 'useful_feature'
+  visit '/'
+  screenshot 'welcome_index'
+  click_button 'Useful feature'
+  screenshot 'feature_index'
+  click_button 'Perform action'
+  screenshot 'action_performed'
+end
+```
+
+This will produce a sequence of images like this
+
+```
+doc
+  screenshots
+    useful_feature
+      00-welcome_index
+      01-feature_index
+      02-action_performed
+```
+
+### Multiple Capybara drivers
+
+Often it is useful to test your app using different browsers.  To avoid the
+screenshots for different Capybara drivers to overwrite each other, set
+
+```ruby
+Capybara::Screenshot.add_driver_path = true
+```
+
+The example above will then save your screenshots like this
+(for poltergeist and selenium):
+
+```
+doc
+  screenshots
+    poltergeist
+      useful_feature
+        00-welcome_index
+        01-feature_index
+        02-action_performed
+    selenium
+      useful_feature
+        00-welcome_index
+        01-feature_index
+        02-action_performed
+```
+
+### Multiple OSs
+
+If you run your tests on multiple operating systems, you will most likely find
+the screen shots differ.  To avoid the screenshots for different OSs to
+overwrite each other, set
+
+```ruby
+Capybara::Screenshot.add_os_path = true
+```
+
+The example above will then save your screenshots like this
+(for Linux and Windows):
+
+```
+doc
+  screenshots
+    linux
+      useful_feature
+        00-welcome_index
+        01-feature_index
+        02-action_performed
+    windows
+      useful_feature
+        00-welcome_index
+        01-feature_index
+        02-action_performed
+```
+
+If you combine this config with the `add_driver_path` config, the driver will be
+put in front of the OS name.
+
+### Screen size
+
+You can specify the desired screen size using
+
+```ruby
+Capybara::Screenshot.window_size = [1024, 768]
+```
+
+This will force the screen shots to the given size, and skip taking screen shots
+unless the desired window size can be achieved.
+
+### Disabling screen shots
+
+If you want to skip taking screen shots, set
+
+```ruby
+Capybara::Screenshot.enabled = false
+```
+
+You can of course set this by an environment variable
+
+```ruby
+Capybara::Screenshot.enabled = ENV['TAKE_SCREENSHOTS']
+```
+
+### Disabling diff
+
+If you want to skip the assertion for change in the screen shot, set
+
+```ruby
+Capybara::Screenshot::Diff.enabled = false
+```
+
+Using an environment variable
+
+```ruby
+Capybara::Screenshot::Diff.enabled = ENV['COMPARE_SCREENSHOTS']
+```
+
+### Screen shot save path
+
+If you would like the screen shots to be saved in a different location set
+
+```ruby
+Capybara::Screenshot.save_path = "#{Rails.root}/doc/gui"
+```
+
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+task default: [:test, :rubocop]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new
+
+Rake::Task[:test].enhance [:rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capybara-screenshot-diff.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capybara/screenshot/diff/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capybara-screenshot-diff'
+  spec.version       = Capybara::Screenshot::Diff::VERSION
+  spec.authors       = ['Uwe Kubosch']
+  spec.email         = ['uwe@kubosch.no']
+
+  spec.summary       = 'Track your GUI changes with diff assertions'
+  spec.description   = 'Save screen shots and track changes with graphical diff'
+  spec.homepage      = 'https://github.com/donv/capybara-screenshot-diff'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  else
+    fail 'RubyGems 2.0 or newer is required to protect against public gem push.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0")
+      .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'capybara', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'rubocop', '~> 0.39'
+end

data/lib/capybara/screenshot/diff.rb

@@ -0,0 +1,18 @@
+require 'capybara/screenshot/diff/version'
+require 'capybara/screenshot/diff/image_compare'
+require 'capybara/screenshot/diff/capybara_setup'
+
+module Capybara
+  module Screenshot
+    mattr_accessor :enabled
+    mattr_accessor :window_size
+    mattr_accessor :add_driver_path
+    mattr_accessor :add_os_path
+
+    # Module to track screen shot changes
+    module Diff
+      mattr_accessor :enabled
+      self.enabled = true
+    end
+  end
+end

data/lib/capybara/screenshot/diff/capybara_setup.rb

@@ -0,0 +1,108 @@
+require 'capybara'
+require 'capybara/screenshot/diff/image_compare'
+
+# Add the `screenshot`method to ActionDispatch::IntegrationTest
+class ActionDispatch::IntegrationTest
+  ON_WINDOWS = RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+  SILENCE_ERRORS = ON_WINDOWS ? '2>nul' : '2>/dev/null'
+
+  def self.os_name
+    case RbConfig::CONFIG['host_os']
+    when /darwin/
+      'macos'
+    when /mswin|mingw|cygwin/
+      'windows'
+    when /linux/
+      'linux'
+    else
+      'unknown'
+    end
+  end
+
+  def self.screenshot_dir
+    parts = ['doc/screenshots']
+    parts << Capybara.default_driver.to_s if Capybara::Screenshot.add_driver_path
+    parts << os_name if Capybara::Screenshot.add_os_path
+    File.join parts
+  end
+
+  def self.screenshot_dir_abs
+    "#{Rails.root}/#{screenshot_dir}".freeze
+  end
+
+  setup do
+    if Capybara::Screenshot.window_size
+      if Capybara.default_driver == :selenium
+        page.driver.browser.manage.window.resize_to(*Capybara::Screenshot.window_size)
+      else
+        page.driver.resize(*Capybara::Screenshot.window_size)
+      end
+    end
+  end
+
+  teardown do
+    if Capybara::Screenshot::Diff.enabled && @test_screenshots
+      @test_screenshots.each { |args| assert_image_not_changed(*args) }
+    end
+    fail(@test_screenshot_errors.join("\n\n")) if @test_screenshot_errors
+  end
+
+  def screenshot_group(name)
+    @screenshot_group = name
+    @screenshot_counter = 0
+    FileUtils.rm_rf "#{self.class.screenshot_dir_abs}/#{name}" if name.present?
+  end
+
+  def screenshot(name)
+    return unless Capybara::Screenshot.enabled || (Capybara::Screenshot.enabled.nil? && Capybara::Screenshot::Diff.enabled)
+    if Capybara.default_driver == :selenium && Capybara::Screenshot.window_size
+      return unless page.driver.browser.manage.window
+          .size == Selenium::WebDriver::Dimension.new(*Capybara::Screenshot.window_size)
+    end
+    if @screenshot_counter
+      name = "#{'%02i' % @screenshot_counter}_#{name}"
+      @screenshot_counter += 1
+    end
+    name = "#{@screenshot_group}/#{name}" if @screenshot_group.present?
+    file_name = "#{self.class.screenshot_dir_abs}/#{name}.png"
+    org_name = "#{self.class.screenshot_dir_abs}/#{name}_0.png~"
+    new_name = "#{self.class.screenshot_dir_abs}/#{name}_1.png~"
+
+    FileUtils.mkdir_p File.dirname(file_name)
+    svn_file_name = "#{self.class.screenshot_dir_abs}/.svn/text-base/#{name}.png.svn-base"
+    if File.exist?(svn_file_name)
+      committed_file_name = svn_file_name
+    else
+      svn_info = `svn info #{file_name} #{SILENCE_ERRORS}`
+      if svn_info.present?
+        wc_root = svn_info.slice /(?<=Working Copy Root Path: ).*$/
+        checksum = svn_info.slice /(?<=Checksum: ).*$/
+        if checksum
+          committed_file_name = "#{wc_root}/.svn/pristine/#{checksum[0..1]}/#{checksum}.svn-base"
+        end
+      else
+        committed_file_name = org_name
+        `git show HEAD~0:#{self.class.screenshot_dir}/#{name}.png > #{committed_file_name} #{SILENCE_ERRORS}`
+        if File.size(committed_file_name) == 0
+          FileUtils.rm_f committed_file_name
+        end
+      end
+    end
+    old_file_size = nil
+    loop do
+      page.save_screenshot(file_name)
+      break if old_file_size == File.size(file_name)
+      old_file_size = File.size(file_name)
+      sleep 0.5
+    end
+    return unless File.exist?(committed_file_name)
+    (@test_screenshots ||= []) << [caller[0], name, file_name, committed_file_name, new_name, org_name]
+  end
+
+  def assert_image_not_changed(caller, name, file_name, committed_file_name, new_name, org_name)
+    if Capybara::Screenshot::Diff::ImageCompare.compare(file_name, committed_file_name, Capybara::Screenshot.window_size)
+      (@test_screenshot_errors ||= []) <<
+          "Screenshot does not match for #{name.inspect}\n#{file_name}\n#{org_name}\n#{new_name}\nat #{caller}"
+    end
+  end
+end

data/lib/capybara/screenshot/diff/image_compare.rb

@@ -0,0 +1,120 @@
+require 'chunky_png'
+
+module Capybara
+  module Screenshot
+    module Diff
+      class ImageCompare
+        include ChunkyPNG::Color
+
+        def self.compare(file_name, old_file_name, dimensions = nil)
+          name = file_name.chomp('.png')
+          org_file_name = "#{name}_0.png~"
+          new_file_name = "#{name}_1.png~"
+
+          return nil unless File.exist? old_file_name
+
+          images = load_images(old_file_name, file_name)
+
+          unless images
+            clean_tmp_files(new_file_name, org_file_name)
+            return false
+          end
+
+          crop_images(images, dimensions) if dimensions
+          org_img = images.first
+          new_img = images.last
+          if sizes_changed?(org_img, new_img, name)
+            save_images(new_file_name, new_img, org_file_name, org_img)
+            return true
+          end
+
+          if org_img.pixels == new_img.pixels
+            clean_tmp_files(new_file_name, org_file_name)
+            return false
+          end
+
+          bottom, left, right, top = find_diff_rectangle(org_img, new_img)
+          draw_rectangles(images, bottom, left, right, top)
+          save_images(new_file_name, new_img, org_file_name, org_img)
+          true
+        end
+
+        def self.save_images(new_file_name, new_img, org_file_name, org_img)
+          org_img.save(org_file_name)
+          new_img.save(new_file_name)
+        end
+
+        def self.clean_tmp_files(new_file_name, org_file_name)
+          File.delete(org_file_name) if File.exists?(org_file_name)
+          File.delete(new_file_name) if File.exists?(new_file_name)
+        end
+
+        private
+
+        def self.load_images(old_file_name, file_name)
+          old_file = File.read(old_file_name)
+          new_file = File.read(file_name)
+
+          return false if old_file == new_file
+
+          [ChunkyPNG::Image.from_blob(old_file), ChunkyPNG::Image.from_blob(new_file)]
+        end
+
+        def self.sizes_changed?(org_image, new_image, name)
+          if org_image.dimension != new_image.dimension
+            puts "Image size has changed for #{name}: #{[org_image, new_image].map { |i| "#{i.width}x#{i.height}" }.join(' => ')}"
+            return true
+          end
+        end
+
+        def self.crop_images(images, dimensions)
+          images.map! do |i|
+            if i.dimension.to_a == dimensions || i.width < dimensions[0] || i.height < dimensions[1]
+              i
+            else
+              i.crop(0, 0, *dimensions)
+            end
+          end
+        end
+
+        def self.draw_rectangles(images, bottom, left, right, top)
+          (1..2).each do |i|
+            images.each do |image|
+              image.rect(left - 1, top - 1, right + 1, bottom + 1, ChunkyPNG::Color.rgb(255, 0, 0))
+            end
+          end
+        end
+
+        def self.find_diff_rectangle(org_img, new_img)
+          top = bottom = nil
+          left = org_img.width
+          right = -1
+          org_img.height.times do |y|
+            (0...left).find do |x|
+              if org_img[x, y] != new_img[x, y]
+                top ||= y
+                bottom = y
+                left = x
+                right = x if x > right
+              end
+            end
+            (org_img.width - 1).step(right + 1, -1).find do |x|
+              if org_img[x, y] != new_img[x, y]
+                bottom = y
+                right = x
+              end
+            end
+          end
+          (org_img.height - 1).step(bottom + 1, -1).find do |y|
+            ((left + 1)..(right - 1)).find do |x|
+              if org_img[x, y] != new_img[x, y]
+                bottom = y
+              end
+            end
+          end
+          return bottom, left, right, top
+        end
+      end
+    end
+  end
+end

data/lib/capybara/screenshot/diff/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Capybara
+  module Screenshot
+    module Diff
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: capybara-screenshot-diff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Uwe Kubosch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+description: Save screen shots and track changes with graphical diff
+email:
+- uwe@kubosch.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capybara-screenshot-diff.gemspec
+- lib/capybara/screenshot/diff.rb
+- lib/capybara/screenshot/diff/capybara_setup.rb
+- lib/capybara/screenshot/diff/image_compare.rb
+- lib/capybara/screenshot/diff/version.rb
+homepage: https://github.com/donv/capybara-screenshot-diff
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Track your GUI changes with diff assertions
+test_files: []