image_compare 1.0.0.pre.dev → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a67b91873ee2ca3ec939803ef3ff7c7e116ce75e48d4643340aae67f48c59225
-  data.tar.gz: 2795771468140989921e1ec9afffa2f9616f5363df7106e050ebcb36871659b0
+  metadata.gz: 9172a89fc7bd3779f58bf4291d045db2e9de6ce8e1d17d7eed9be6970c6faed9
+  data.tar.gz: f3d1a90a07c4d728ea51c2effd424d9a32b4567b53b59119a996637defebc4b7
 SHA512:
-  metadata.gz: 39a0d7d0bc330345bc4a9624bbbd721f7206db5d5c0d5900bfaa78bb0eec90dd9c03598d683c7f165a78549a8d311edaa7e206b5773abe96672479b25a322851
-  data.tar.gz: 3fc93372828b8354867e63ac3e80cd2998fdd025ef9e3601a239d952f7ec0bfbdff3cd148bd03c4feb1a2c9cddf0be73c39da65ad55276639f3ac392886af1fa
+  metadata.gz: c8a0fcbd0668b614592b65972d1326a7a2f2853da2a133150fd6d5d0e8153a46f7d986033cec071d6df6b6cdd6c5b0c7950cd76b07494dc6bd8e240ee4d928b3
+  data.tar.gz: 8c81cf6accfeb98d780ff3ed724834b5816c0d245186086d9b075e77f56a8f29f9d52d20fa4d01210bc5a8ddd36dfb7e7694ffc9e8024fc809e4a10b31437a42

data/README.md

@@ -33,15 +33,23 @@ ImageCompare supports different ways (_modes_) of comparing images.
 
 Source images used in examples:
 
-<img src='https://raw.githubusercontent.com/instantink/image_compare/master/spec/fixtures/a.png' width='300' />
-<img src='https://raw.githubusercontent.com/instantink/image_compare/master/spec/fixtures/b.png' width='300' />
+<img alt='a.png' src='spec/fixtures/a.png' />
+<img alt='b.png' src='spec/fixtures/b.png' />
+
+### Color
+
+Compare pixels, resulting score is a ratio of unequal pixels (with respect to provided tolerance).
+
+Resulting diff contains version of the first image with different pixels highlighted in red and red bounding box.
+
+<img alt='color_diff' src='spec/fixtures/color_diff.png' />
 
 ### Base (RGB) mode
 
 Compare pixels by values, resulting score is a ratio of unequal pixels.
 Resulting diff represents per-channel difference.
 
-<img src='https://raw.githubusercontent.com/instantink/image_compare/master/spec/fixtures/rgb_diff.png' width='300' />
+<img alt='rgb_diff.png' src='spec/fixtures/rgb_diff.png' width='480' />
 
 ### Grayscale mode
 
@@ -49,24 +57,29 @@ Compare pixels as grayscale (by brightness and alpha), resulting score is a rati
 
 Resulting diff contains grayscale version of the first image with different pixels highlighted in red and red bounding box.
 
-<img src='https://raw.githubusercontent.com/instantink/image_compare/master/spec/fixtures/grayscale_diff.png' width='300' />
+<img alt='grayscale_diff.png' src='spec/fixtures/grayscale_diff.png' width='480' />
 
 ### Delta
 
 Compare pixels using [Delta E](https://en.wikipedia.org/wiki/Color_difference) distance.
 Resulting diff contains grayscale version of the first image with different pixels highlighted in red (with respect to diff score).
 
-<img src='https://raw.githubusercontent.com/instantink/image_compare/master/spec/fixtures/delta_diff.png' width='300' />
+<img alt='delta_diff.png' src='spec/fixtures/delta_diff.png' width='480' />
 
 ## Usage
 
 ```ruby
-# create new matcher with default threshold equals to 0
-# and base (RGB) mode
+# Create new matcher with default threshold equals to 0
+# and base (Color) mode
 cmp = ImageCompare::Matcher.new
+cmp.mode #=> ImageCompare::Modes::Color
+
+# Create new matcher with default threshold equals to 0
+# and base (RGB) mode
+cmp = ImageCompare::Matcher.new mode: :rgb
 cmp.mode #=> ImageCompare::Modes::RGB
 
-# create matcher with specific threshold
+# Create matcher with specific threshold
 cmp = ImageCompare::Matcher.new threshold: 0.05
 cmp.threshold #=> 0.05
 
@@ -74,38 +87,91 @@ cmp.threshold #=> 0.05
 cmp = ImageCompare::Matcher.new lower_threshold: 0.01
 cmp.lower_threshold #=> 0.01
 
-# create zero-tolerance grayscale matcher
+# Create zero-tolerance grayscale matcher
 cmp = ImageCompare::Matcher.new mode: :grayscale, tolerance: 0
 cmp.mode #=> ImageCompare::Modes::Grayscale
 
-res = cmp.compare(path_1, path_2)
+res = cmp.compare('path/image1.png', 'path/image2.png')
 res #=> ImageCompare::Result
 res.match? #=> true
 res.score #=> 0.0
 
 # Return diff image object
 res.difference_image #=> ImageCompare::Image
-res.difference_image.save(new_path)
+res.difference_image.save(result)
 
 # without explicit matcher
-res = ImageCompare.compare(path_1, path_2, options)
+res = ImageCompare.compare('path/image1.png', 'path/image2.png', options)
+res.match? #=> true
+res.score #=> 0.0
 
 # equals to
-res = ImageCompare::Matcher.new(options).compare(path_1, path_2)
+res = ImageCompare::Matcher.new(options).compare('my_images_path/image1.png', 'my_images_path/image2.png')
+res.match? #=> true
+res.score #=> 0.0
 ```
 
 ## Excluding rectangle
 
-<img src='https://raw.githubusercontent.com/instantink/image_compare/master/spec/fixtures/a.png' width='300' />
-<img src='https://raw.githubusercontent.com/instantink/image_compare/master/spec/fixtures/a1.png' width='300' />
+<img alt='a.png' src='spec/fixtures/a.png' />
+<img alt='a1.png' src='spec/fixtures/a1.png' />
 
 You can exclude rectangle from comparing by passing `:exclude_rect` to `compare`.
 E.g., if `path_1` and `path_2` contain images above
 ```ruby
-ImageCompare.compare(path_1, path_2, exclude_rect: [200, 150, 275, 200]).match? # => true
+ImageCompare.compare('path/image1.png', 'path/image2.png', exclude_rect: [200, 150, 275, 200]).match? # => true
+
+# or
+
+cmp = ImageCompare::Matcher.new exclude_rect: [200, 150, 275, 200]
+res = cmp.compare('path/image1.png', 'path/image2.png')
+res #=> ImageCompare::Result
+res.match? #=> true
+res.score #=> 0.0
+
+# Return diff image object
+res.difference_image #=> ImageCompare::Image
+res.difference_image.save('path/diff.png')
 ```
 `[200, 150, 275, 200]` is array of two vertices of rectangle -- (200, 150) is left-top vertex and (275, 200) is right-bottom.
 
+### Cucumber + Capybara example
+`support/env.rb`:
+```ruby
+require 'image_compare'
+```
+
+`support/capybara_extensions.rb`:
+```ruby
+# frozen_string_literal: true
+
+Capybara::Node::Element.class_eval do
+  def rect_area
+    rect_area = self.evaluate_script('this.getBoundingClientRect()')
+
+    [
+      rect_area['left'].to_f.round,
+      rect_area['top'].to_f.round,
+      rect_area['right'].to_f.round,
+      rect_area['bottom'].to_f.round
+    ]
+  rescue StandardError => e
+    raise "Error getting element rect area: #{e.inspect}!"
+  end
+end
+```
+
+`steps/my_step.rb`:
+```ruby
+my_element = page.find('#my_element').rect_area
+
+cmp = ImageCompare::Matcher.new exclude_rect: my_element.rect_area
+res = cmp.compare('path/image1.png', 'path/image2.png')
+res.difference_image.save('path/diff.png')
+
+expect(res.match?).to eq(true)
+```
+
 ## Including rectangle
 
 You can set bounds of comparing by passing `:include_rect` to `compare` with array similar to previous example

data/lib/image_compare/matcher.rb

@@ -16,7 +16,7 @@ module ImageCompare
     attr_reader :mode
 
     def initialize(**options)
-      mode_type = options.delete(:mode) || :rgb
+      mode_type = options.delete(:mode) || :color
       raise ArgumentError, "Undefined mode: #{mode_type}" unless MODES.key?(mode_type)
       @mode = Modes.const_get(MODES[mode_type]).new(**options)
     end

data/lib/image_compare/modes/base.rb

@@ -22,8 +22,8 @@ module ImageCompare
         @bounds = Rectangle.new(*include_rect.bounds)
 
         b.compare_each_pixel(a, area: include_rect) do |b_pixel, a_pixel, x, y|
-          next if pixels_equal?(b_pixel, a_pixel)
           next if !exclude_rect.nil? && exclude_rect.contains_point?(x, y)
+          next if pixels_equal?(b_pixel, a_pixel)
           update_result(b_pixel, a_pixel, x, y)
         end
 

data/lib/image_compare/modes.rb

@@ -2,9 +2,9 @@
 
 module ImageCompare
   module Modes
-    require 'image_compare/modes/rgb'
-    require 'image_compare/modes/grayscale'
-    require 'image_compare/modes/delta'
     require 'image_compare/modes/color'
+    require 'image_compare/modes/delta'
+    require 'image_compare/modes/grayscale'
+    require 'image_compare/modes/rgb'
   end
 end

data/lib/image_compare/rectangle.rb

@@ -27,7 +27,9 @@ module ImageCompare
     end
 
     def contains_point?(x, y)
-      x.between?(left, right) && y.between?(top, bot)
+      (x >= left && y >= top && x <= right && y <= bot) ||
+      (x <= right && y <= top && x >= left && y >= bot) ||
+      (x.between?(right, left) && y.between?(bot, top))
     end
   end
 end

data/lib/image_compare/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImageCompare
-  VERSION = '1.0.0-dev'
+  VERSION = '1.0.1'
 end

data/lib/image_compare.rb

@@ -6,8 +6,8 @@ module ImageCompare
   class SizesMismatchError < StandardError
   end
 
-  require 'image_compare/matcher'
   require 'image_compare/color_methods'
+  require 'image_compare/matcher'
 
   def self.compare(path_a, path_b, **options)
     Matcher.new(**options).compare(path_a, path_b)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: image_compare
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.dev
+  version: 1.0.1
 platform: ruby
 authors:
 - cristianofmc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-24 00:00:00.000000000 Z
+date: 2023-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
@@ -99,9 +99,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.1
 signing_key: