looks_good 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33bfb614a176498eb6a13180459e40aff96fc328673ab0edd6cbcb2b4b28345f
-  data.tar.gz: 97b7efc3432c0b51b052bad9201e87a900791e57afdc9d2d9ef6444d654891bf
+  metadata.gz: 453e5498b4740e2fe1c415307921f1acaf410c7d6f6395ea531916249c30792a
+  data.tar.gz: 3f08a7bb2ccb8d860072783bc7dc3fd96fa528a8826d8d1a2f2e401bdb94cb99
 SHA512:
-  metadata.gz: 629f66d456631f91b36200dd03266c2de827dd6313ded03a49c01f0021b303f93b98f8c9f5525e831ba9412412ed908800fd831fc89282c16c155804ae8d0b79
-  data.tar.gz: 63c9fc8f12c8e25f4230e39298ab623b7b85e5b491679ae0a9c59f4bf6da9122cf1991a750df8376d81e482c8bb3063a7fce8f22b3812ee3fd97e83c3dcd97d7
+  metadata.gz: f9b731e277ff3015ef89693bb4595e7c4d1346bd244615e989e57ea4395a055d73239ec16cd88721052d8154b5edc38720f5ecff18a64d055dbf2408d8f92d9d
+  data.tar.gz: 58cd545954d8d637f5577184f2d2c39c57716c48ecf86237df7c86ba96b86b70a52d29a9978ab390714db1182cc1b75fb68ab5b3a8829ebdb4b60e22e3c68954

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
 
 
@@ -77,10 +78,13 @@ Also created are subfolders:
 - tmp/diff/ - will hold the visual diff images for inspection when comparison fails
 
 #### max_no_tries 
-- 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.
+- 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 2.
 
 #### 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.0001, 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

@@ -16,7 +16,7 @@ module LooksGood
     end
 
     def self.take_screenshot
-      temp_dir = LooksGood::Configuration.path(:temp)
+      temp_dir = LooksGood::Configuration.path(:tmp)
       FileUtils.mkdir_p(temp_dir) unless File.exists?(temp_dir)
       #captures the uncropped full screen
       begin
@@ -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.0001
       end
 
       # allows retina mac screenshots to be scaled to expected size
@@ -24,7 +24,11 @@ module LooksGood
       end
 
       def max_no_tries
-        @max_no_tries ||= 1
+        @max_no_tries ||= 2
+      end
+
+      def fuzz
+        @fuzz ||= "10%"
       end
 
       def sleep_between_tries
@@ -33,9 +37,9 @@ module LooksGood
 
       def path(type)
         paths =  {:reference => reference_image_path,
-                  :temp => File.join(reference_image_path, 'tmp', 'tmp'),
-                  :candidate => File.join(reference_image_path, 'temp', 'candidate'),
-                  :diff => File.join(reference_image_path, 'temp', 'diff')
+                  :tmp => File.join(reference_image_path, 'tmp', 'tmp'),
+                  :candidate => File.join(reference_image_path, 'tmp', 'candidate'),
+                  :diff => File.join(reference_image_path, 'tmp', 'diff')
                  }
         paths[type]
       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/matchers/look_like_matcher.rb

@@ -1,6 +1,6 @@
 require 'looks_good'
 
-RSpec::Matchers.define :look_like do |expected|
+RSpec::Matchers.define :look_like do |expected, within: LooksGood::Configuration.default_within|
   result = nil
   match do |actual|
     if expected.is_a?(Symbol)
@@ -8,7 +8,7 @@ RSpec::Matchers.define :look_like do |expected|
       path_to = called_by_file.split("_spec.rb").first.split("spec/").last
       expected = File.join(path_to, "#{expected}.png")
     end
-    result = LooksGood.check(expected, actual)
+    result = LooksGood.check(expected, actual, within: within)
     result[:result]
   end
 

data/lib/looks_good/version.rb

@@ -1,3 +1,3 @@
 module LooksGood
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 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,11 +73,12 @@ 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
 
     def cleanup
-      FileUtils.remove_dir(LooksGood::Configuration.path(:temp)) if File.directory?(LooksGood::Configuration.path(:temp))
+      FileUtils.remove_dir(LooksGood::Configuration.path(:tmp)) if File.directory?(LooksGood::Configuration.path(:tmp))
       FileUtils.remove_dir(LooksGood::Configuration.path(:diff)) if File.directory?(LooksGood::Configuration.path(:diff))
       FileUtils.remove_dir(LooksGood::Configuration.path(:candidate)) if File.directory?(LooksGood::Configuration.path(:candidate))
     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'])

data/spec/configuration_spec.rb

@@ -41,7 +41,7 @@ describe LooksGood::Configuration do
 
       it 'should return the directory for a type of image' do
         subject.reference_image_path = "a_path"
-        subject.path(:temp).should == 'a_path/temp'
+        subject.path(:tmp).should == 'a_path/tmp'
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: looks_good
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 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