dotdiff 2.0.2-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc7d6d30ec1acd29d43fdef9b82ba35411e0277f
+  data.tar.gz: cf7af469474460e3d1905cc351dbce3b03c386ab
+SHA512:
+  metadata.gz: 80d3131f8d56dbb9fbbd6c1b39a35cddf9146138eba8938d1889082cdf4d5f44b01c64a6685b363524fca75b96428a0fa9c9c3e5717bbcf00f6abe5a45b70a6a
+  data.tar.gz: 81422794c94c3e438074014a22e97183f8a07f9321f2eb5dfff532df4a40d168e78c8c5479bc9feaa9713cd1dbb47f3e74d8db3a40e4b8c42c6198852add1dd2

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,100 @@
+# Dotdiff
+
+Dotdiff is a very basic wrapper around imåge magick compare program which works with both Capybara
+and RSpec to capture and compare the images with a simple rspec matcher.
+
+It is now also possible to snapshot a particular element on the page just by using the standard
+capybara finders - which once the element is found will query the browser for its dimensions and
+placement on the page and use that metadata to crop using chunky_png from a full page snapshot.
+
+It can also hide certain elements via executing javascript for elements which can change with
+different display suchas username or user specific details, but only for full page screenshots.
+
+## 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
+
+### Dependencies
+First ensure to install image magick binary which is available via apt-get or brew
+
+In your spec/spec_helper
+```
+require 'dotdiff'
+```
+
+If you want the rspec_matcher require the following as well
+```
+require 'dotdiff/rspec_matcher'
+```
+
+### Configuration
+In an initializer you can configure certain options example shown below within Dotdiff
+
+```ruby
+DotDiff.configure do |config|
+  config.image_magick_diff_bin = `which compare`
+  config.pixel_threshold = 120
+  config.image_magick_options = '-metric AE'
+  config.image_store_path = File.join('/home', 'user', 'images')
+  config.xpath_elements_to_hide = ["id('main')"]
+  config.failure_image_path = File.join('/home', 'user', 'failure_comparisions')
+  config.max_wait_time = 2
+end
+```
+
+### Spec usage
+
+For a full page screenshot you can use the below;
+
+```ruby
+expect(page).to match_image('HomePage', subdir: 'Normitec')
+```
+
+For a specific element screenshot you can use like so;
+
+```ruby
+expect(find('#login-form')).to match_image('LoginForm', subdir: 'Normitec')
+```
+
+The only difference for the element specific is passing a specific element in the `expect` parameter.
+
+## Configuration Options
+
+| Config                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                         | Example                                               | Default                        | Required |
+|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|--------------------------------|----------|
+| image_magick_diff_bin    | Location of the image magick compare binary file                                                                                                                                                                                                                                                                                                                                                                                                         | `which compare`                          | N/A                            | Yes      |
+| image_store_path       | The root path to store the base images                                                                                                                                                                                                                                                                                                                                                                                                              | File.join('/home', 'user','images')                   | nil                            | Yes      |
+| xpath_elements_to_hide | When taking full page screenshots it will hide elements specified that might change each time and re-shows them after the screenshot.  It doesn't use this option for taking screenshots of specific elements.                                                                                                                                                                                                                                      | ["id('main')", "//div[contains(@class, 'formy'])[1]"] | []                             | No       |
+| failure_image_path     | When a comparison occurs and the perceptual_diff binary returns a failure with the message. It will dump the new image taken for comparison to this directory.  If not supplied it will not move the images from the temporary location that it is generated at.                                                                                                                                                                                    | File.join('/home', 'user','failures')                 | nil                            | No       |
+| max_wait_time          | This is similar to the Capybara#default_max_wait_time if you have a high value such as 10, as its possible that the  global xpath_elements_to_hide might not always exist it will wait the full time - therefore you can drop it for the hiding and showing of the elements.  In this example it would wait up 20 seconds in total 10 for hiding and 10 seconds for re-showing - that is if the element isn't even going to be present on the page. | 2                                                     | Capybara#default_max_wait_time | No       |
+| pixel_threshold       |  This validates the output from compare is within your specified threshold    | 120  | 100  | No      |
+| image_magick_options  |  This allows you to pass some custom options to image magick    | '-fuzz 10% -metric RSME'  | '-fuzz 5% -metric AE'  | No      |
+## 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 still 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

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,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dotdiff/version'
+
+is_java = RUBY_PLATFORM == 'java'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dotdiff"
+  spec.version       = DotDiff::VERSION
+  spec.authors       = ["Jon Normington"]
+  spec.email         = ["jnormington@users.noreply.github.com"]
+  spec.platform      = 'java' if is_java
+
+  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"]
+
+  if is_java
+    spec.add_runtime_dependency "rmagick4j", '~> 0.4.0'
+  else
+    spec.add_runtime_dependency "rmagick", '~> 2.15'
+  end
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "capybara", "~> 2.6"
+end

data/lib/dotdiff.rb

@@ -0,0 +1,51 @@
+require 'dotdiff/version'
+
+require 'shellwords'
+require 'tmpdir'
+require 'fileutils'
+
+require 'dotdiff/command_wrapper'
+require 'dotdiff/element_handler'
+
+require 'dotdiff/element_meta'
+require 'dotdiff/image/cropper'
+require 'dotdiff/snapshot'
+require 'dotdiff/comparer'
+
+module DotDiff
+  class << self
+    attr_accessor :resave_base_image, :failure_image_path,
+      :image_store_path, :overwrite_on_resave, :xpath_elements_to_hide,
+      :max_wait_time
+
+    attr_writer :image_magick_options, :pixel_threshold, :image_magick_diff_bin
+
+    def configure
+      yield self
+    end
+
+    def resave_base_image
+      @resave_base_image ||= false
+    end
+
+    def xpath_elements_to_hide
+      @xpath_elements_to_hide ||= []
+    end
+
+    def image_magick_options
+      @image_magick_options ||= '-fuzz 5% -metric AE'
+    end
+
+    def image_magick_diff_bin
+      @image_magick_diff_bin.to_s.strip
+    end
+
+    def pixel_threshold
+      @pixel_threshold ||= 100
+    end
+
+    def max_wait_time
+      @max_wait_time || Capybara.default_max_wait_time
+    end
+  end
+end

data/lib/dotdiff/command_wrapper.rb

@@ -0,0 +1,52 @@
+require 'shellwords'
+
+module DotDiff
+  class CommandWrapper
+    attr_reader :message
+
+    def run(base_image, new_image, diff_image_path)
+      output = run_command(base_image, new_image, diff_image_path)
+
+      @ran_checks = true
+
+      begin
+        pixels = Float(output)
+
+        if pixels && pixels <= DotDiff.pixel_threshold
+          @failed = false
+        else
+          @failed = true
+          @message = "Images are #{pixels} pixels different"
+        end
+      rescue ArgumentError => e
+        @failed = true
+        @message = output
+      end
+    end
+
+    def passed?
+      !failed?
+    end
+
+    def failed?
+      @ran_checks && @failed
+    end
+
+    def ran_checks
+      @ran_checks
+    end
+
+    private
+
+    # For the tests
+    def run_command(base_image, new_image, diff_image_path)
+      `#{command(base_image, new_image, diff_image_path)}`.strip
+    end
+
+    def command(base_image, new_image, diff_image_path)
+      "#{DotDiff.image_magick_diff_bin} #{DotDiff.image_magick_options} " \
+      "#{Shellwords.escape(base_image)} #{Shellwords.escape(new_image)} " \
+      "#{Shellwords.escape(diff_image_path)} 2>&1"
+    end
+  end
+end

data/lib/dotdiff/comparer.rb

@@ -0,0 +1,58 @@
+module DotDiff
+  class Comparer
+    attr_reader :element, :page, :snapshot
+
+    def initialize(element, page, snapshot)
+      @page = page
+      @element = element
+      @snapshot = snapshot
+    end
+
+    def result
+      if element.is_a?(Capybara::Session)
+        compare_page
+      elsif element.is_a?(Capybara::Node::Base)
+        compare_element
+      else
+        raise ArgumentError, "Unknown element class received: #{element.class.name}"
+      end
+    end
+
+    private
+
+    def compare_element(element_meta = ElementMeta.new(page, element))
+      snapshot.capture_from_browser(false, nil)
+      snapshot.crop_and_resave(element_meta)
+
+      if !File.exists?(snapshot.basefile)
+        snapshot.resave_cropped_file
+        [true, snapshot.basefile]
+      else
+        compare(snapshot.cropped_file)
+      end
+    end
+
+    def compare_page
+      snapshot.capture_from_browser
+
+      if !File.exists?(snapshot.basefile)
+        snapshot.resave_fullscreen_file
+        [true, snapshot.basefile]
+      else
+        compare(snapshot.fullscreen_file)
+      end
+    end
+
+    def compare(compare_to_image)
+      result = CommandWrapper.new
+      result.run(snapshot.basefile, compare_to_image, snapshot.diff_file)
+
+      if result.failed? && DotDiff.failure_image_path
+        FileUtils.mkdir_p(snapshot.failure_path)
+        FileUtils.mv(compare_to_image, snapshot.new_file, force: true)
+      end
+
+      [result.passed?, result.message]
+    end
+  end
+end

data/lib/dotdiff/element_handler.rb

@@ -0,0 +1,39 @@
+module DotDiff
+  class ElementHandler
+    attr_accessor :driver
+
+    def initialize(driver, elements = DotDiff.xpath_elements_to_hide)
+      @driver = driver
+      @elements = elements
+    end
+
+    def hide
+      elements.each do |xpath|
+        if element_exists?(xpath)
+          driver.execute_script("#{js_element(xpath)}.style.visibility = 'hidden'")
+        end
+      end
+    end
+
+    def show
+      elements.each do |xpath|
+        if element_exists?(xpath)
+          driver.execute_script("#{js_element(xpath)}.style.visibility = ''")
+        end
+      end
+    end
+
+    def js_element(xpath)
+      "document.evaluate(\"#{xpath}\", "\
+      "document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue"
+    end
+
+    def element_exists?(xpath)
+      driver.find(:xpath, xpath, wait: DotDiff.max_wait_time, visible: :all) rescue nil
+    end
+
+    def elements
+      @elements ||= []
+    end
+  end
+end

data/lib/dotdiff/element_meta.rb

@@ -0,0 +1,45 @@
+module DotDiff
+  class ElementMeta
+    attr_reader :page, :element_xpath
+
+    def initialize(page, element)
+      @element_xpath = element.path
+      @page = page
+    end
+
+    def rectangle
+      @rectangle ||= Rectangle.new(@page, @element_xpath)
+    end
+
+    class Rectangle
+      attr_reader :rect
+
+      def initialize(page, xpath)
+        @rect = get_rect(page, xpath)
+      end
+
+      def method_missing(name, *args, &block)
+        if %w(x y width height).include?(name.to_s)
+          case name
+            when :x then rect['left']
+            when :y then rect['top']
+            else rect[name.to_s]
+          end
+        else
+          super
+        end
+      end
+
+      private
+
+      def js_query(xpath)
+        "document.evaluate(\"#{xpath}\", document, null, XPathResult."\
+        "FIRST_ORDERED_NODE_TYPE, null).singleNodeValue.getBoundingClientRect()"
+      end
+
+      def get_rect(page, xpath)
+        page.evaluate_script(js_query(xpath))
+      end
+    end
+  end
+end

data/lib/dotdiff/image/cropper.rb

@@ -0,0 +1,45 @@
+require 'rmagick'
+
+module DotDiff
+  module Image
+    module Cropper
+      def crop_and_resave(element)
+        image = load_image(fullscreen_file)
+        image.crop!(
+          element.rectangle.x,
+          element.rectangle.y,
+          width(element, image),
+          height(element, image)
+        )
+
+        image.write(cropped_file)
+      end
+
+      def load_image(file)
+        Magick::Image.read(file).first
+      end
+
+      def height(element, image)
+        element_height = element.rectangle.height + element.rectangle.y
+        image_height = image.rows
+
+        if element_height > image_height
+          image_height - element.rectangle.y
+        else
+          element.rectangle.height
+        end
+      end
+
+      def width(element, image)
+        element_width = element.rectangle.width + element.rectangle.x
+        image_width = image.columns
+
+        if element_width > image_width
+          image_width - element.rectangle.x
+        else
+          element.rectangle.width
+        end
+      end
+    end
+  end
+end

data/lib/dotdiff/rspec_matcher.rb

@@ -0,0 +1,17 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :match_image do |filename, opts = {}|
+  match do |page_or_element|
+    options = Hash(opts).merge(filename: filename, page: page)
+
+    snapshot = DotDiff::Snapshot.new(options)
+    comparer = DotDiff::Comparer.new(page_or_element, page, snapshot)
+
+    result, @message = comparer.result
+    result == true
+  end
+
+  failure_message do |page_or_element|
+    "expected #{page_or_element.class} to match image but failed with: #{@message}"
+  end
+end

data/lib/dotdiff/snapshot.rb

@@ -0,0 +1,89 @@
+module DotDiff
+  class Snapshot
+    include Image::Cropper
+
+    attr_reader :base_filename, :subdir, :rootdir, :page, :use_custom_screenshot
+
+    IMAGE_EXT = 'png'.freeze
+
+    def initialize(options = {})
+      opts = { rootdir: DotDiff.image_store_path }.merge(Hash(options))
+      @base_filename = opts[:filename]
+      @subdir = opts[:subdir].to_s
+      @rootdir = opts[:rootdir].to_s
+      @page = opts[:page]
+      @fullscreen = opts[:fullscreen_file]
+      @use_custom_screenshot = opts[:use_custom_screenshot]
+    end
+
+    def fullscreen_file
+      @fullscreen ||= File.join(Dir.tmpdir, subdir, base_filename)
+    end
+
+    def cropped_file
+      @cropped ||= File.join(Dir.tmpdir, subdir, "#{base_filename(false)}_cropped.#{IMAGE_EXT}")
+    end
+
+    def basefile
+      File.join(rootdir, subdir.to_s, base_filename)
+    end
+
+    def base_filename(with_extension=true)
+      filename  = File.basename(@base_filename)
+      extension = File.extname(filename)
+      rtn_file  = @base_filename
+
+      if with_extension
+        rtn_file = "#{@base_filename}.#{IMAGE_EXT}" if extension.empty?
+      else
+        rtn_file = @base_filename.sub(extension, '') unless extension.empty?
+      end
+
+      rtn_file
+    end
+
+    def failure_path
+      File.join(DotDiff.failure_image_path.to_s, subdir)
+    end
+
+    def new_file
+      File.join(failure_path, "#{base_filename(false)}.new.#{IMAGE_EXT}" )
+    end
+
+    def diff_file
+      File.join(failure_path, "#{base_filename(false)}.diff.#{IMAGE_EXT}")
+    end
+
+    def capture_from_browser(hide_and_show = true, element_handler = ElementHandler.new(page))
+      return fullscreen_file if use_custom_screenshot
+
+      if hide_and_show
+        element_handler.hide
+        page.save_screenshot(fullscreen_file)
+        element_handler.show
+      else
+        page.save_screenshot(fullscreen_file)
+      end
+    end
+
+    def resave_cropped_file
+      resave_base_file(:cropped)
+    end
+
+    def resave_fullscreen_file
+      resave_base_file(:fullscreen)
+    end
+
+    private
+
+    def resave_base_file(version)
+      FileUtils.mkdir_p(File.join(DotDiff.image_store_path, subdir))
+
+      if !File.exists?(basefile) || DotDiff.overwrite_on_resave
+        FileUtils.mv(self.send("#{version}_file"), basefile, force: true)
+      else
+        FileUtils.mv(self.send("#{version}_file"), "#{basefile}.r2", force: true)
+      end
+    end
+  end
+end

data/lib/dotdiff/version.rb

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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: dotdiff
+version: !ruby/object:Gem::Version
+  version: 2.0.2
+platform: java
+authors:
+- Jon Normington
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2017-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  name: rmagick4j
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  name: capybara
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+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/comparer.rb
+- lib/dotdiff/element_handler.rb
+- lib/dotdiff/element_meta.rb
+- lib/dotdiff/image/cropper.rb
+- lib/dotdiff/rspec_matcher.rb
+- lib/dotdiff/snapshot.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.6.8
+signing_key:
+specification_version: 4
+summary: Preceptual diff wrapper for capybara and rspec image regression specs
+test_files: []