dotdiff 1.2.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 88c24a6cd7b8664be57c3969cde582e2cac5c25c
-  data.tar.gz: 94542a6d703ee8fb50dcee720c116d2dad4a8cd0
+SHA256:
+  metadata.gz: 161e2aca53c1b747a6de45cd09ac975f56938d246e32886f7c7efc65cc7f0426
+  data.tar.gz: fc2878dc821b64da63222f2c5b8eb4bfb2f0b6a33d625556165d834d7c386f82
 SHA512:
-  metadata.gz: cc886b3a9d07766a64b0b7ee564447fbe629c37402e344c9138707ceabdc80110d62abc1d3b32138e9fc3b7d92e9dbb20089da0a93f60fbf7dc784cb978d0e86
-  data.tar.gz: ca193151f90733ab22239d964798f6c34f165fb441d8201fba3f3e2d5700f3b817777108e4359771e4ef9a86b18f896612846cff1ed118cd9b5420b573337e39
+  metadata.gz: 7b130dcea90f5dc4ca7d85d1154fe84e7209554b4b4b3e09d617e32ec858c256a3bc489e6ffb4e97b738bb02092e95ca225707940be4990f1be5889b50a77043
+  data.tar.gz: 5acf38c5ee36c8964041fd1e9b6c13dfdce58ecf15e0e3ae48b2188326c06f654f5c413d4564bdb63009d9bccc4607813d99b711f3966c02b12d36b2d9228dff

data/.rubocop.yml

@@ -0,0 +1,31 @@
+inherit_from: .rubocop_todo.yml
+
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.4
+  SuggestExtensions: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - describe
+    - context
+  Exclude:
+    - 'spec/unit/snapshot_spec.rb'
+
+Layout/LineLength:
+  Max: 120
+  IgnoredPatterns:
+    - !ruby/regexp /\A +(it|describe|context|shared_examples|include_examples|it_behaves_like) ["']/

data/.rubocop_todo.yml

@@ -0,0 +1,17 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-03-13 18:24:12 +0000 using RuboCop version 0.84.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 17
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 14

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in dotdiff.gemspec

data/README.md

@@ -1,15 +1,22 @@
 # 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.
+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 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.
+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:
 
+This is the same for JRuby platform as well (both MRI and JRuby versions of gem is uploaded)
+
 ```ruby
 gem 'dotdiff'
 ```
@@ -26,7 +33,7 @@ Or install it yourself as:
 ## Usage
 
 ### Dependencies
-First ensure to install perceptualdiff binary which is available via apt-get and brew or via http://pdiff.sourceforge.net/
+First ensure to install image magick binary which is available via apt-get or brew
 
 In your spec/spec_helper
 ```
@@ -43,11 +50,13 @@ In an initializer you can configure certain options example shown below within D
 
 ```ruby
 DotDiff.configure do |config|
-  config.perceptual_diff_bin = `which perceptualdiff`.strip
+  config.image_magick_diff_bin = `which compare`
+  config.pixel_threshold = { type: 'percent', value: 0.04 }
+  config.image_magick_options = '-metric AE'
   config.image_store_path = File.join('/home', 'user', 'images')
   config.xpath_elements_to_hide = ["id('main')"]
+  config.hide_elements_on_non_full_screen_screenshot = true
   config.failure_image_path = File.join('/home', 'user', 'failure_comparisions')
-  config.max_wait_time = 2
 end
 ```
 
@@ -71,11 +80,13 @@ The only difference for the element specific is passing a specific element in th
 
 | Config                 | Description                                                                                                                                                                                                                                                                                                                                                                                                                                         | Example                                               | Default                        | Required |
 |------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|--------------------------------|----------|
-| perceptual_diff_bin    | Location of the perceptual diff binary file                                                                                                                                                                                                                                                                                                                                                                                                         | `which perceptualdiff`.strip                          | N/A                            | Yes      |
+| 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       |
+| hide_elements_on_non_full_screen_screenshot | When taking non full page screenshots whether to also hide elements using `xpath_elements_to_hide` or not hide anything at all                                                                                    | true | false                             | 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_config which supports pixel or percent value | { type: 'percent', value: 0.03 } | { type: 'pixel', value: 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
 

data/Rakefile

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

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "dotdiff"
+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.
@@ -10,5 +11,5 @@ require "dotdiff"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/dotdiff.gemspec

@@ -1,29 +1,38 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $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.name          = 'dotdiff'
   spec.version       = DotDiff::VERSION
-  spec.authors       = ["Jon Normington"]
-  spec.email         = ["jnormington@users.noreply.github.com"]
+  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.summary       = 'Image regression wrapper for Capybara and RSpec using image'\
+                        'magick supporting both MRI and JRuby versions'
+  spec.description   = [spec.summary, 'which supports snap shoting both full page and'\
+                        "specific elements on a page where text checks isn't enough"].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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "rmagick", '~> 2.15'
+  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"
+  spec.add_development_dependency 'bundler', '>= 2'
+  spec.add_development_dependency 'capybara', '>= 2.6'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '>= 3.0'
 end

data/lib/dotdiff.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dotdiff/version'
 
 require 'shellwords'
@@ -9,29 +11,73 @@ require 'dotdiff/element_handler'
 
 require 'dotdiff/element_meta'
 require 'dotdiff/image/cropper'
+require 'dotdiff/image/container'
 require 'dotdiff/snapshot'
+
+require 'dotdiff/threshold_calculator'
+
+require 'dotdiff/comparible/base'
+require 'dotdiff/comparible/page_comparer'
+require 'dotdiff/comparible/element_comparer'
+
 require 'dotdiff/comparer'
 
 module DotDiff
- class << self
-   attr_accessor :perceptual_diff_bin, :resave_base_image, :failure_image_path,
-                 :image_store_path, :overwrite_on_resave, :xpath_elements_to_hide,
-                 :max_wait_time
+  class UnknownTypeError < StandardError; end
+  class InvalidValueError < StandardError; end
+
+  SUPPORTED_THRESHOLD_TYPES = %w[pixel percent].freeze
+
+  class << self
+    attr_accessor :failure_image_path, :image_store_path, :overwrite_on_resave
+
+    attr_writer :image_magick_options, :image_magick_diff_bin,
+                :resave_base_image, :xpath_elements_to_hide, :hide_elements_on_non_full_screen_screenshot
+
+    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 hide_elements_on_non_full_screen_screenshot
+      @hide_elements_on_non_full_screen_screenshot ||= false
+    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 ||= { type: 'pixel', value: 100 }
+    end
 
-   def configure
-     yield self
-   end
+    def pixel_threshold=(config)
+      unless config.class == Hash
+        Kernel.warn '[Dotdiff deprecation] Pass a hash options instead of integer to support pixel/percentage threshold'
+        @pixel_threshold = config
+        return
+      end
 
-   def resave_base_image
-     @resave_base_image ||= false
-   end
+      unless SUPPORTED_THRESHOLD_TYPES.include?(config.fetch(:type))
+        raise UnknownTypeError, "Unknown threshold type supports only: #{SUPPORTED_THRESHOLD_TYPES.join(',')}"
+      end
 
-   def xpath_elements_to_hide
-     @xpath_elements_to_hide ||= []
-   end
+      if config.fetch(:type) == 'percent' && config.fetch(:value) > 1
+        raise InvalidValueError, 'Percent value should be a float between 0 and 1'
+      end
 
-    def max_wait_time
-      @max_wait_time || Capybara.default_max_wait_time
+      @pixel_threshold = config
     end
   end
 end

data/lib/dotdiff/command_wrapper.rb

@@ -1,19 +1,20 @@
+# frozen_string_literal: true
+
 require 'shellwords'
 
 module DotDiff
   class CommandWrapper
-    attr_reader :message
-
-    def run(base_image, new_image)
-      output = `#{command(base_image, new_image)}`
+    attr_reader :message, :pixels
 
-      @ran_checks = true
+    def run(base_image, new_image, diff_image_path)
+      output = run_command(base_image, new_image, diff_image_path)
+      @message = output
 
-      if output.include?('PASS:')
+      begin
+        @pixels = Float(output)
         @failed = false
-      else
+      rescue ArgumentError
         @failed = true
-        @message = output.split("\n").join(' ')
       end
     end
 
@@ -22,18 +23,19 @@ module DotDiff
     end
 
     def failed?
-      @ran_checks && @failed
-    end
-
-    def ran_checks
-      @ran_checks
+      @failed
     end
 
     private
 
-    def command(base_image, new_image)
-      "#{DotDiff.perceptual_diff_bin} #{Shellwords.escape(base_image)} "\
-        "#{Shellwords.escape(new_image)} -verbose"
+    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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DotDiff
   class Comparer
     attr_reader :element, :page, :snapshot
@@ -10,49 +12,12 @@ module DotDiff
 
     def result
       if element.is_a?(Capybara::Session)
-        compare_page
+        DotDiff::Comparible::PageComparer.run(snapshot, nil)
       elsif element.is_a?(Capybara::Node::Base)
-        compare_element
+        DotDiff::Comparible::ElementComparer.run(snapshot, ElementMeta.new(page, 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)
-
-      if result.failed? && DotDiff.failure_image_path
-        FileUtils.mkdir_p(snapshot.failure_path)
-        FileUtils.mv(compare_to_image, snapshot.failure_file, force: true)
-      end
-
-      [result.passed?, result.message]
-    end
   end
 end

data/lib/dotdiff/comparible/base.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module DotDiff
+  module Comparible
+    class Base
+      def initialize(snapshot, element_meta)
+        @snapshot = snapshot
+        @element_meta = element_meta
+      end
+
+      def self.run(snapshot, element_meta)
+        new(snapshot, element_meta).run
+      end
+
+      private
+
+      attr_reader :snapshot, :element_meta, :new_image
+
+      def compare(compare_to_image)
+        @new_image = compare_to_image
+        return [false, img_container.dimensions_mismatch_msg] unless img_container.both_images_same_dimensions?
+
+        cmd = CommandWrapper.new
+        cmd.run(snapshot.basefile, new_image, snapshot.diff_file)
+        return [cmd.passed?, cmd.message] if cmd.failed?
+
+        calculate_result(cmd.pixels)
+      end
+
+      def calculate_result(diff_pixels)
+        calc = DotDiff::ThresholdCalculator.new(
+          DotDiff.pixel_threshold,
+          img_container.total_pixels,
+          diff_pixels
+        )
+
+        passed = calc.under_threshold?
+        write_failure_imgs if !passed && DotDiff.failure_image_path
+
+        [passed, calc.message]
+      end
+
+      def img_container
+        @img_container ||= DotDiff::Image::Container.new(
+          snapshot.basefile,
+          new_image
+        )
+      end
+
+      def write_failure_imgs
+        FileUtils.mkdir_p(snapshot.failure_path)
+        FileUtils.mv(new_image, snapshot.new_file, force: true)
+      end
+    end
+  end
+end

data/lib/dotdiff/comparible/element_comparer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DotDiff
+  module Comparible
+    class ElementComparer < Base
+      def run
+        take_snapshot_and_crop
+
+        if !File.exist?(snapshot.basefile)
+          snapshot.resave_cropped_file
+          [true, snapshot.basefile]
+        else
+          compare(snapshot.cropped_file)
+        end
+      end
+
+      private
+
+      def take_snapshot_and_crop
+        snapshot.capture_from_browser(DotDiff.hide_elements_on_non_full_screen_screenshot)
+        snapshot.crop_and_resave(element_meta)
+      end
+    end
+  end
+end

data/lib/dotdiff/comparible/page_comparer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module DotDiff
+  module Comparible
+    class PageComparer < Base
+      def run
+        snapshot.capture_from_browser(true)
+
+        if !File.exist?(snapshot.basefile)
+          snapshot.resave_fullscreen_file
+          [true, snapshot.basefile]
+        else
+          compare(snapshot.fullscreen_file)
+        end
+      end
+    end
+  end
+end

data/lib/dotdiff/element_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DotDiff
   class ElementHandler
     attr_accessor :driver
@@ -9,27 +11,28 @@ module DotDiff
 
     def hide
       elements.each do |xpath|
-        if element_exists?(xpath)
-          driver.execute_script("#{js_element(xpath)}.style.visibility = 'hidden'")
-        end
+        driver.execute_script(script(xpath, :hidden))
       end
     end
 
     def show
       elements.each do |xpath|
-        if element_exists?(xpath)
-          driver.execute_script("#{js_element(xpath)}.style.visibility = ''")
-        end
+        driver.execute_script(script(xpath, :''))
       end
     end
 
-    def js_element(xpath)
-      "document.evaluate(\"#{xpath}\", "\
-      "document, null, XPathResult.FIRST_ORDERED_NODE_TYPE, null).singleNodeValue"
-    end
+    def script(xpath, visibility)
+      xpath += if visibility == :hidden
+                 "[not(contains(@style, 'visibility'))]"
+               else
+                 "[contains(@style, 'visibility: hidden')]"
+               end
 
-    def element_exists?(xpath)
-      driver.find(:xpath, xpath, wait: DotDiff.max_wait_time, visible: :all) rescue nil
+      # this is done like so instead of a single pass over all elements due to a bug in Firefox:
+      # https://greasyfork.org/en/forum/discussion/12223/xpath-iteratenext-fails-in-firefox
+      "var elem; while (elem = document.evaluate(\"#{xpath}\", document, "\
+        'null, XPathResult.ORDERED_NODE_ITERATOR_TYPE, null).iterateNext()) '\
+        "{ elem.style.visibility = '#{visibility}'; }"
     end
 
     def elements

data/lib/dotdiff/element_meta.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DotDiff
   class ElementMeta
     attr_reader :page, :element_xpath
@@ -19,22 +21,26 @@ module DotDiff
       end
 
       def method_missing(name, *args, &block)
-        if %w(x y width height).include?(name.to_s)
+        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]
+          when :x then rect['left']
+          when :y then rect['top']
+          else rect[name.to_s]
           end
         else
           super
         end
       end
 
+      def respond_to_missing?(name, _include_private = false)
+        %w[x y width height].include?(name.to_s) || super
+      end
+
       private
 
       def js_query(xpath)
         "document.evaluate(\"#{xpath}\", document, null, XPathResult."\
-        "FIRST_ORDERED_NODE_TYPE, null).singleNodeValue.getBoundingClientRect()"
+        'FIRST_ORDERED_NODE_TYPE, null).singleNodeValue.getBoundingClientRect()'
       end
 
       def get_rect(page, xpath)

data/lib/dotdiff/image/container.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DotDiff
+  module Image
+    class Container
+      def initialize(baseimg_file, newimg_file)
+        @baseimg_file = baseimg_file
+        @newimg_file = newimg_file
+      end
+
+      def both_images_same_dimensions?
+        base_image.rows == new_image.rows &&
+          base_image.columns == new_image.columns
+      end
+
+      def total_pixels
+        base_image.rows * base_image.columns
+      end
+
+      def dimensions_mismatch_msg
+        <<~MSG
+          Images are not the same dimensions to be compared
+          Base file: #{base_image.columns}x#{base_image.rows}
+          New file:  #{new_image.columns}x#{new_image.rows}
+        MSG
+      end
+
+      private
+
+      attr_reader :baseimg_file, :newimg_file
+
+      def base_image
+        @base_image ||= Magick::Image.read(baseimg_file).first
+      end
+
+      def new_image
+        @new_image ||= Magick::Image.read(newimg_file).first
+      end
+    end
+  end
+end

data/lib/dotdiff/image/cropper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rmagick'
 
 module DotDiff
@@ -6,8 +8,8 @@ module DotDiff
       def crop_and_resave(element)
         image = load_image(fullscreen_file)
         image.crop!(
-          element.rectangle.x,
-          element.rectangle.y,
+          element.rectangle.x.floor,
+          element.rectangle.y.floor,
           width(element, image),
           height(element, image)
         )

data/lib/dotdiff/rspec_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/expectations'
 
 RSpec::Matchers.define :match_image do |filename, opts = {}|

data/lib/dotdiff/snapshot.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module DotDiff
   class Snapshot
     include Image::Cropper
 
-    attr_reader :base_filename, :subdir, :rootdir, :page
+    attr_reader :subdir, :rootdir, :page, :use_custom_screenshot
 
-    IMAGE_EXT = 'png'.freeze
+    IMAGE_EXT = 'png'
 
     def initialize(options = {})
       opts = { rootdir: DotDiff.image_store_path }.merge(Hash(options))
@@ -12,21 +14,23 @@ module DotDiff
       @subdir = opts[:subdir].to_s
       @rootdir = opts[:rootdir].to_s
       @page = opts[:page]
+      @fullscreen_file = opts[:fullscreen_file]
+      @use_custom_screenshot = opts[:use_custom_screenshot]
     end
 
     def fullscreen_file
-      @fullscreen ||= File.join(Dir.tmpdir, subdir, base_filename)
+      @fullscreen_file ||= File.join(Dir.tmpdir, subdir, base_filename)
     end
 
     def cropped_file
-      @cropped ||= File.join(Dir.tmpdir, subdir, "#{base_filename(false)}_cropped.#{IMAGE_EXT}")
+      @cropped_file ||= 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)
+    def base_filename(with_extension = true)
       filename  = File.basename(@base_filename)
       extension = File.extname(filename)
       rtn_file  = @base_filename
@@ -41,15 +45,23 @@ module DotDiff
     end
 
     def failure_path
-      File.join(DotDiff.failure_image_path, subdir)
+      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 failure_file
-      File.join(failure_path, "#{base_filename(false)}.new.#{IMAGE_EXT}" )
+    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))
+    def capture_from_browser(hide_and_show)
+      return fullscreen_file if use_custom_screenshot
+
       if hide_and_show
+        element_handler = ElementHandler.new(page)
+
         element_handler.hide
         page.save_screenshot(fullscreen_file)
         element_handler.show
@@ -71,10 +83,10 @@ module DotDiff
     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)
+      if !File.exist?(basefile) || DotDiff.overwrite_on_resave
+        FileUtils.mv(send("#{version}_file"), basefile, force: true)
       else
-        FileUtils.mv(self.send("#{version}_file"), "#{basefile}.r2", force: true)
+        FileUtils.mv(send("#{version}_file"), "#{basefile}.r2", force: true)
       end
     end
   end

data/lib/dotdiff/threshold_calculator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module DotDiff
+  class ThresholdCalculator
+    PIXEL = 'pixel'
+    PERCENT = 'percent'
+
+    def initialize(threshold_config, total_pixels, pixel_diff)
+      @threshold_config = threshold_config
+      @total_pixels = total_pixels
+      @pixel_diff = pixel_diff
+    end
+
+    def under_threshold?
+      return false if total_pixels.nil? || pixel_diff.nil?
+
+      case threshold_type
+      when PIXEL
+        @value = pixel_diff
+      when PERCENT
+        @value = pixel_diff / total_pixels.to_f
+      else
+        raise UnknownTypeError, "Unable to handle threshold type: #{threshold_type}"
+      end
+
+      value <= threshold_value
+    end
+
+    def message
+      "Outcome was '#{value}' difference for type '#{threshold_type}'"
+    end
+
+    private
+
+    attr_reader :threshold_config, :pixel_diff, :total_pixels, :value
+
+    def threshold_value
+      return threshold_config if threshold_config.class == Integer
+
+      threshold_config[:value]
+    end
+
+    def threshold_type
+      return PIXEL if threshold_config.class != Hash
+
+      threshold_config[:type].to_s
+    end
+  end
+end

data/lib/dotdiff/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DotDiff
-  VERSION = "1.2.1"
+  VERSION = '3.0.0'
 end

metadata

@@ -1,96 +1,98 @@
 --- !ruby/object:Gem::Specification
 name: dotdiff
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Jon Normington
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
   type: :development
   prerelease: false
   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.
+        version: '3.0'
+description: Image regression wrapper for Capybara and RSpec using imagemagick supporting
+  both MRI and JRuby versions which supports snap shoting both full page andspecific
+  elements on a page where text checks isn't enough
 email:
 - jnormington@users.noreply.github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -101,34 +103,39 @@ files:
 - lib/dotdiff.rb
 - lib/dotdiff/command_wrapper.rb
 - lib/dotdiff/comparer.rb
+- lib/dotdiff/comparible/base.rb
+- lib/dotdiff/comparible/element_comparer.rb
+- lib/dotdiff/comparible/page_comparer.rb
 - lib/dotdiff/element_handler.rb
 - lib/dotdiff/element_meta.rb
+- lib/dotdiff/image/container.rb
 - lib/dotdiff/image/cropper.rb
 - lib/dotdiff/rspec_matcher.rb
 - lib/dotdiff/snapshot.rb
+- lib/dotdiff/threshold_calculator.rb
 - lib/dotdiff/version.rb
 homepage: https://github.com/jnormington/dotdiff
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+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.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: Preceptual diff wrapper for capybara and rspec image regression specs
+summary: Image regression wrapper for Capybara and RSpec using imagemagick supporting
+  both MRI and JRuby versions
 test_files: []