dotdiff 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88c24a6cd7b8664be57c3969cde582e2cac5c25c
-  data.tar.gz: 94542a6d703ee8fb50dcee720c116d2dad4a8cd0
+  metadata.gz: 6c8aaffec17072161e9ad80103b90391e0eb415e
+  data.tar.gz: 29653119f66174a464a698ce08f9a2fef3b8a587
 SHA512:
-  metadata.gz: cc886b3a9d07766a64b0b7ee564447fbe629c37402e344c9138707ceabdc80110d62abc1d3b32138e9fc3b7d92e9dbb20089da0a93f60fbf7dc784cb978d0e86
-  data.tar.gz: ca193151f90733ab22239d964798f6c34f165fb441d8201fba3f3e2d5700f3b817777108e4359771e4ef9a86b18f896612846cff1ed118cd9b5420b573337e39
+  metadata.gz: c610941e322c2953bc4a7eccede499acd536a24833062098d1d2238b82572d47ed587fb832aa3d0d3ab05050a9efe70000d5f9d93e133edcfa024d154263ac92
+  data.tar.gz: eee9149c62f98364f31b17d67f5a1189193646bcee64b568dc9a8f0e5467cfe26c61a7a09253cf99313e6a46d70624bcabdcd2525c521f9246610d160b2a9a1d

data/README.md

@@ -1,10 +1,14 @@
 # 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
 
@@ -26,7 +30,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,7 +47,9 @@ 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 = 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')
@@ -71,12 +77,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       |
 | 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.

data/lib/dotdiff.rb

@@ -13,22 +13,36 @@ require 'dotdiff/snapshot'
 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
-
-   def configure
-     yield self
-   end
-
-   def resave_base_image
-     @resave_base_image ||= false
-   end
-
-   def xpath_elements_to_hide
-     @xpath_elements_to_hide ||= []
-   end
+  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

data/lib/dotdiff/command_wrapper.rb

@@ -4,16 +4,23 @@ module DotDiff
   class CommandWrapper
     attr_reader :message
 
-    def run(base_image, new_image)
-      output = `#{command(base_image, new_image)}`
+    def run(base_image, new_image, diff_image_path)
+      output = run_command(base_image, new_image, diff_image_path)
 
       @ran_checks = true
 
-      if output.include?('PASS:')
-        @failed = false
-      else
+      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.split("\n").join(' ')
+        @message = output
       end
     end
 
@@ -31,9 +38,15 @@ module DotDiff
 
     private
 
-    def command(base_image, new_image)
-      "#{DotDiff.perceptual_diff_bin} #{Shellwords.escape(base_image)} "\
-        "#{Shellwords.escape(new_image)} -verbose"
+    # 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

@@ -45,11 +45,11 @@ module DotDiff
 
     def compare(compare_to_image)
       result = CommandWrapper.new
-      result.run(snapshot.basefile, compare_to_image)
+      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.failure_file, force: true)
+        FileUtils.mv(compare_to_image, snapshot.new_file, force: true)
       end
 
       [result.passed?, result.message]

data/lib/dotdiff/snapshot.rb

@@ -2,7 +2,7 @@ module DotDiff
   class Snapshot
     include Image::Cropper
 
-    attr_reader :base_filename, :subdir, :rootdir, :page
+    attr_reader :base_filename, :subdir, :rootdir, :page, :use_custom_screenshot
 
     IMAGE_EXT = 'png'.freeze
 
@@ -12,6 +12,8 @@ module DotDiff
       @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
@@ -41,14 +43,20 @@ module DotDiff
     end
 
     def failure_path
-      File.join(DotDiff.failure_image_path, subdir)
+      File.join(DotDiff.failure_image_path.to_s, subdir)
     end
 
-    def failure_file
+    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)

data/lib/dotdiff/version.rb

@@ -1,3 +1,3 @@
 module DotDiff
-  VERSION = "1.2.1"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotdiff
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Jon Normington
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2016-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick