dotdiff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee81e4a430c00cb04ad15b616dc3b4e2ab24a338
+  data.tar.gz: 769f09a70a309d0ab64bf02b1891bb64974778a6
+SHA512:
+  metadata.gz: fa3f58f8dfc35765d45e3c95724cd3d3e92cdb529da542a534c85b9291308aee325c590f0b3f56d8016b974cfb0474768ac2ff7e3ee66ae495cef3f850ecaff4
+  data.tar.gz: 61de0f39159498cd6c3d3b828d91fb86f4c3333b3395c558beb2d72707255a3158851867fe84efd38c78bf1d820fa8dfbdc5d6389b8cf305b2d11e01fce14aa5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jon Normington
+
+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,94 @@
+# Dotdiff
+
+Dotdiff is a very basic wrapper around [perceptual-diff](http://pdiff.sourceforge.net/) which works with both Capybara and RSpec to capture and compare the images with a simple rspec matcher. Which can also hide certain elements via executing javascript for elements which can change with different display suchas username or user specific details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dotdiff'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dotdiff
+
+## Usage
+
+First ensure to install perceptualdiff binary which is available via apt-get and brew or via http://pdiff.sourceforge.net/
+
+In your spec/spec_helper
+```
+require 'dotdiff'
+```
+
+If you want the rspec_matcher require the following as well
+```
+require 'dotdiff/rspec_matcher'
+```
+
+In an initializer you can configure certain options example shown below within Dotdiff
+
+```ruby
+DotDiff.configure do |config|
+  config.perceptual_diff_bin = `which perceptualdiff`.strip
+  config.image_store_path = File.expand_path('../../spec/fixtures/images', __FILE__)
+  config.js_elements_to_hide = [
+    "document.getElementsByClassName('drop-menu-toggle')[0]",
+    "document.getElementsById('username-title')",
+  ]
+  config.failure_image_path = '/home/user/spec_image_failures'
+
+end
+```
+
+Basic usage in your spec is just the line below;
+
+```ruby
+expect(page).to match_image('GooglePage', subdir: 'Google')
+```
+
+It does the following;
+
+It builds the base_image_file location with DotDiff.image_store_path + subdir + filename + .png
+
+It then checks if that file exists;
+ - If it doesn't exist it or `resave_base_image` is passed;
+    - it hides any elements defined in `js_elements_to_hide`
+    - uses `Capybara::Session#save_screenshot` to create a screenshot
+    - it then un-hides any elements defined as above
+    - returns that compare was successfull
+
+Also if resave_base_image is passed and DotDiff.overwrite_on_resave is false it creates an r2 version so that you can compare with the original or if the file is deleted it will just write the same file.
+
+ - If the `base_image_file` exists and resave_base_image is false;
+    - it hides any elements defined in `js_elements_to_hide`
+    - uses `Capybara::Session#save_screenshot` to create a screenshot in a tmpdir to compare against the base_image
+    - runs the command and observes the result
+    - it then un-hides any elements defined as above
+    - if failure_image_path is defined it moves the new captured image to that path named as the original file
+    - returns both the result and stdout failure message
+
+A failure message might look like the following `expected to match image but failed with: FAIL: Images are 120 pixels visibly different`
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jnormington/dotdiff.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Whats left to do
+
+Its not fully completed yet but is usable in its current state.
+ - Improve the message output to extract just the fail line
+ - Add an integration spec
+ - Other things as it crops up

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dotdiff"
+
+# 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/dotdiff.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dotdiff/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dotdiff"
+  spec.version       = DotDiff::VERSION
+  spec.authors       = ["Jon Normington"]
+  spec.email         = ["jnormington@users.noreply.github.com"]
+
+  spec.summary       = "Preceptual diff wrapper for capybara and rspec image regression specs"
+  spec.description   = [spec.summary, "which is great for graphs and charts where checking"\
+                                      "the DOM is either impossible to not worth it."].join(' ')
+  spec.homepage      = "https://github.com/jnormington/dotdiff"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/dotdiff.rb

@@ -0,0 +1,27 @@
+require 'dotdiff/version'
+
+require 'shellwords'
+require 'tmpdir'
+
+require 'dotdiff/command_wrapper'
+require 'dotdiff/image'
+require 'dotdiff/element_handler'
+
+module DotDiff
+ class << self
+   attr_accessor :perceptual_diff_bin, :resave_base_image, :failure_image_path,
+                 :image_store_path, :overwrite_on_resave, :js_elements_to_hide
+
+   def configure
+     yield self
+   end
+
+   def resave_base_image
+     @resave_base_image ||= false
+   end
+
+   def js_elements_to_hide
+     @js_elements_to_hide ||= []
+   end
+ end
+end

data/lib/dotdiff/command_wrapper.rb

@@ -0,0 +1,39 @@
+require 'shellwords'
+
+module DotDiff
+  class CommandWrapper
+    attr_reader :message
+
+    def run(base_image, new_image)
+      output = `#{command(base_image, new_image)}`
+
+      @ran_checks = true
+
+      if output.include?('PASS:')
+        @failed = false
+      else
+        @failed = true
+        @message = output.split("\n").join(' ')
+      end
+    end
+
+    def passed?
+      !failed?
+    end
+
+    def failed?
+      @ran_checks && @failed
+    end
+
+    def ran_checks
+      @ran_checks
+    end
+
+    private
+
+    def command(base_image, new_image)
+      "#{DotDiff.perceptual_diff_bin} #{Shellwords.escape(base_image)} "\
+        "#{Shellwords.escape(new_image)} -verbose"
+    end
+  end
+end

data/lib/dotdiff/element_handler.rb

@@ -0,0 +1,26 @@
+module DotDiff
+  class ElementHandler
+    attr_accessor :driver
+
+    def initialize(driver, elements = DotDiff.js_elements_to_hide)
+      @driver = driver
+      @elements = elements
+    end
+
+    def hide
+      elements.each do |elem|
+        driver.execute_script("#{elem}.style.visibility = 'hidden'")
+      end
+    end
+
+    def show
+      elements.each do |elem|
+        driver.execute_script("#{elem}.style.visibility = ''")
+      end
+    end
+
+    def elements
+      @elements ||= []
+    end
+  end
+end

data/lib/dotdiff/image.rb

@@ -0,0 +1,80 @@
+require 'fileutils'
+
+module DotDiff
+  class Image
+    attr_accessor :driver, :resave_base_image, :subdir, :file_name
+
+    def initialize(opts = {})
+      Hash(opts).each do |key, value|
+        if self.respond_to?("#{key}=")
+          self.send("#{key}=", value)
+        end
+      end
+    end
+
+    def compare
+      outcome = []
+
+      if !File.exists?(base_image_file) || resave_base_image
+        path = capture_and_resave_base_image
+        outcome = [true, path]
+      else
+        compare_to_image = capture_from_browser
+        result = CommandWrapper.new
+
+        element_handler.hide
+        result.run(base_image_file, compare_to_image)
+        element_handler.show
+
+        if result.failed? && DotDiff.failure_image_path
+          FileUtils.mkdir_p(File.join(DotDiff.failure_image_path, subdir.to_s))
+          file_name = File.basename(compare_to_image)
+
+          FileUtils.mv(compare_to_image,
+            File.join(DotDiff.failure_image_path, subdir.to_s, file_name), force: true)
+        end
+
+        outcome = [result.passed?, result.message]
+      end
+
+      outcome
+    end
+
+    def resave_base_image
+      @resave_base_image.nil? ? DotDiff.resave_base_image : @resave_base_image
+    end
+
+    def base_image_file
+      @file_name = "#{file_name}.png" unless file_name.include?('.png')
+
+      File.join(DotDiff.image_store_path, subdir.to_s, file_name)
+    end
+
+    private
+
+    def element_handler
+      @elemnt_handler ||= ElementHandler.new(driver)
+    end
+
+    def capture_from_browser
+      tmp_screenshot_file = File.join(Dir.tmpdir, File.basename(base_image_file))
+
+      element_handler.hide
+      driver.save_screenshot(tmp_screenshot_file)
+      element_handler.show
+
+      tmp_screenshot_file
+    end
+
+    def capture_and_resave_base_image
+      tmp_image = capture_from_browser
+      FileUtils.mkdir_p(File.join(DotDiff.image_store_path, subdir))
+
+      if !File.exists?(base_image_file) || DotDiff.overwrite_on_resave
+        FileUtils.mv(tmp_image, base_image_file, force: true)
+      else
+        FileUtils.mv(tmp_image, "#{base_image_file}.r2", force: true)
+      end
+    end
+  end
+end

data/lib/dotdiff/rspec_matcher.rb

@@ -0,0 +1,15 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :match_image do |filename, opts = {}|
+  match do |page|
+    image = DotDiff::Image.new(Hash(opts).merge!(file_name: filename, driver: page))
+
+    result, @message = image.compare
+    result == true
+  end
+
+
+  failure_message do |actual|
+    "expected to match image but failed with: #{@message}"
+  end
+end

data/lib/dotdiff/version.rb

@@ -0,0 +1,3 @@
+module DotDiff
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: dotdiff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Normington
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-10 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Preceptual diff wrapper for capybara and rspec image regression specs
+  which is great for graphs and charts where checkingthe DOM is either impossible
+  to not worth it.
+email:
+- jnormington@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dotdiff.gemspec
+- lib/dotdiff.rb
+- lib/dotdiff/command_wrapper.rb
+- lib/dotdiff/element_handler.rb
+- lib/dotdiff/image.rb
+- lib/dotdiff/rspec_matcher.rb
+- lib/dotdiff/version.rb
+homepage: https://github.com/jnormington/dotdiff
+licenses:
+- MIT
+metadata: {}
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Preceptual diff wrapper for capybara and rspec image regression specs
+test_files: []