looks_good 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cd9455572edfef123a293aebd03502a4e815e510908fe133a91e9e9fccd972b
-  data.tar.gz: a1401f4eaad2474d9af5ec46a22bbed8c4262fbd5f3444500a28e19ff5c8657b
+  metadata.gz: ff1696e76f2276ae9b96d74505ebff99c4d1b41dde86ffe565225354993f62b2
+  data.tar.gz: 2bad07472729c2969028d42da9633501ec1dd10e863a4a36dc63859b91e6f55f
 SHA512:
-  metadata.gz: 515f1c537da45eaf7992e892484214ff8ddaecd0a970f39600be7dffb1502be020d2d08e7fdbbb152f448ebfc5e05b4ba452fc0037ab81a655132f51fcba31bd
-  data.tar.gz: e0e0db06a07aed3a2465e53064586fa8e774b330f564986f067f3fe71ff457eafea63a1f6f913bb9834dcad8e9c11dbc242a5c07f405d41e54f84fec523e06db
+  metadata.gz: 6af65669990d48a70a62f91fe254c26a1e1d76667e58e98b5ae60484c659cc58da02049ff94f0cf03a9c7218481b3e17b1295f9ec389c062aff0bf94f109577c
+  data.tar.gz: 38ec9cd144372e32c9ff3b16c55caf9a8a9fc2ea27e8a0c85a5176920c4e7fd8c83a3b8f5effefba0d768619a3cb6cc0e4cbdd4881ccbf7084105477fca0cae9

data/README.md

@@ -63,6 +63,7 @@ you can override any of the defaults with a config block.
             c.sleep_between_tries = 0.5
             c.browser_folders = false
             c.scale_amount = 0.5
+            c.fuzz = "10%"
           end
 
 
@@ -80,7 +81,10 @@ Also created are subfolders:
 - sets how many times looks_good will try and match the element against the reference image. Handy to reduce fragility of tests due to animations and load times. Defaults to 1.
 
 #### default_within
-- a float between 0 and 1 that sets the default tolerance for visual differences. default is 0.01 (1%)
+- a float between 0 and 1 that sets the default tolerance for visual differences. default is 0.00001, which is strict but not absolute 0. Larger screenshots will be less sensitive to subtle differences as a percentage. 
+
+#### fuzz
+- allows pixels to not need to match exactly. a string percentage value, provided to imagemagick as fuzz value for comparison. default is "10%"
 
 #### scale_amount
 - Retina mac screenshots are 2x actual size, so this scales them to be 1:1. default is 0.5, set to 1 to disable. 

data/lib/looks_good/capture_element.rb

@@ -39,7 +39,7 @@ module LooksGood
     end
 
     def self.crop_element(image, element_to_crop, position)
-      cropped_element = image.scale(LooksGood::Configuration.scale_amount).crop(position[:x], position[:y], position[:width], position[:height])
+      cropped_element = image.scale!(LooksGood::Configuration.scale_amount).crop!(position[:x], position[:y], position[:width], position[:height])
     end
 
   end

data/lib/looks_good/comparison.rb

@@ -1,7 +1,8 @@
+require 'mini_magick'
 module LooksGood
   class Comparison
 
-    attr_accessor :diff_image, :actual_image, :expected_image
+    attr_accessor :diff_image, :diff_image_file, :actual_image, :expected_image
 
     def initialize(actual_image, expected_image, within=LooksGood::Configuration.default_within)
       @actual_image = actual_image
@@ -9,8 +10,8 @@ module LooksGood
       @comparison = compare_image
       @within = within
       # within is a float of % image difference between the two images
-      @match = @comparison[1] <= @within
-      @diff_image =LooksGood::Image.new(@comparison.first, @expected_image.file_name) unless @matches
+      @match = @comparison <= @within
+      @diff_image =LooksGood::Image.new(@diff_image_file, @expected_image.file_name)
     end
 
     def matches?
@@ -22,7 +23,7 @@ module LooksGood
     end
 
     def percent_difference
-      @comparison[1]
+      @comparison
     end
 
     def compare_image
@@ -31,10 +32,7 @@ module LooksGood
 
     def compare_images_with_same_size
       images_to_compare = prep_images_for_comparison
-      images_to_compare.first.compare_channel(images_to_compare.last, Magick::PeakAbsoluteErrorMetric, Magick::AllChannels) do
-        self.highlight_color = Magick::Pixel.new(65300,100,0,38000)
-        self.lowlight_color = Magick::Pixel.new(0,65300,1000,60000)
-      end
+      mini_compare(images_to_compare)
     end
 
     def compare_images_with_different_size
@@ -46,16 +44,36 @@ module LooksGood
         expanded_image.background_color = 'white'
         expanded_image
       end
-    images_to_compare.first.compare_channel(images_to_compare.last, Magick::PeakAbsoluteErrorMetric) do |img|
-        img.highlight_color = Magick::Pixel.new(65300,100,0,38000)
-        img.lowlight_color = Magick::Pixel.new(0,65300,1000,60000)
-      end
+      mini_compare(images_to_compare)
     end
 
     def compare_images_with_same_size?
       @actual_image.image.rows == @expected_image.image.rows && @actual_image.image.columns == @expected_image.image.columns
     end
 
+    # drop in refactor to utilize mini_magick. 
+    # returns a float % of difference 
+    # TODO: remove rmagick
+    def mini_compare(images)
+      actual_image, expected_image = images
+      actual_image.write(actual_image.filename)
+      pixel_difference_count = nil
+      MiniMagick::Tool::Compare.new(whiny: false) do |comp|
+        comp.fuzz(LooksGood::Configuration.fuzz)  
+        comp.metric("AE")
+        comp << actual_image.filename  
+        comp << expected_image.filename
+        diff_file_name = File.join(LooksGood::Configuration.path(:diff), @actual_image.file_name)
+        FileUtils::mkdir_p(File.dirname(diff_file_name)) unless File.exists?(diff_file_name)
+        comp << diff_file_name
+        comp.call do |stdout, stderr, status|
+         pixel_difference_count = stderr
+        end
+        @diff_image_file = Magick::Image.read(diff_file_name).first
+      end
+      pixel_difference_count.to_f / (expected_image.rows * expected_image.columns)
+    end
+
     def prep_images_for_comparison
       [
           @actual_image,

data/lib/looks_good/configuration.rb

@@ -5,7 +5,7 @@ module LooksGood
 
     class << self
 
-      attr_accessor :reference_image_path, :max_no_tries, :sleep_between_tries, :browser_folders, :default_within
+      attr_accessor :fuzz, :reference_image_path, :max_no_tries, :sleep_between_tries, :browser_folders, :default_within
 
       attr_reader :paths
 
@@ -15,7 +15,7 @@ module LooksGood
       end
 
       def default_within
-        @default_within ||= 0.01 # 1%
+        @default_within ||= 0.00001
       end
 
       # allows retina mac screenshots to be scaled to expected size
@@ -27,6 +27,10 @@ module LooksGood
         @max_no_tries ||= 1
       end
 
+      def fuzz
+        @fuzz ||= "10%"
+      end
+
       def sleep_between_tries
         @sleep_between_tries ||= 0.1
       end

data/lib/looks_good/image.rb

@@ -29,6 +29,8 @@ module LooksGood
 
   class ImageFromElement < Image
 
+    attr_accessor :image
+    
     def initialize(element, file_name)
       super(image, file_name)
       @element = element

data/lib/looks_good/version.rb

@@ -1,3 +1,3 @@
 module LooksGood
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/looks_good.rb

@@ -35,7 +35,6 @@ module LooksGood
         matches = comparison.matches?
         if !matches
           comparison.actual_image.save(:candidate)
-          save_image_as_diff(comparison.diff_image)
           result_hash[:message] = %Q[view a visual diff image: open #{comparison.diff_image.path(:diff)}\n
 HOW TO FIX:\n 
 - cp #{comparison.diff_image.path(:candidate)} #{@expected_reference_file}
@@ -67,11 +66,6 @@ or
       @comparison
     end
 
-    def save_image_as_diff(image)
-      image.save(:diff)
-     
-    end
-
     def save_image_as_candidate(image)
       image.save(:candidate)
       raise "The design reference #{image.file_name} does not exist, #{image.path(:candidate)} " +
@@ -79,6 +73,7 @@ or
     end
 
     def save_reference
+      sleep 0.5 # ensures page/browser stability of focus effects etc inherent in browsers
       ImageFromElement.new(@actual_element,@expected_reference_filename).verify_and_save
     end
 

data/looks_good.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency('rmagick', ['>=2.15.4'])
+  s.add_runtime_dependency('mini_magick', ['>=4.11.0'])
   s.add_runtime_dependency('capybara',['>=2.6.0'])
 
   s.add_development_dependency('rake',['>=0.9.2'])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: looks_good
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Russell Jennings
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.15.4
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.11.0
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement