image_compare 1.0.0.pre.dev → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a67b91873ee2ca3ec939803ef3ff7c7e116ce75e48d4643340aae67f48c59225
-  data.tar.gz: 2795771468140989921e1ec9afffa2f9616f5363df7106e050ebcb36871659b0
+  metadata.gz: c9267d7bfce2137312246ee71c78be6123829c8d85306a6514fac4a5177fc1ed
+  data.tar.gz: 594a599fe736f30a8b92c28729e05db90c375ce9a3bf2c90056f5044a1151743
 SHA512:
-  metadata.gz: 39a0d7d0bc330345bc4a9624bbbd721f7206db5d5c0d5900bfaa78bb0eec90dd9c03598d683c7f165a78549a8d311edaa7e206b5773abe96672479b25a322851
-  data.tar.gz: 3fc93372828b8354867e63ac3e80cd2998fdd025ef9e3601a239d952f7ec0bfbdff3cd148bd03c4feb1a2c9cddf0be73c39da65ad55276639f3ac392886af1fa
+  metadata.gz: 980ef7ed37029399bb9fa7563b5f916bf466c44de53eecb433eed25841c5af37c4093cf59f4f1df45434c839b67e859a5d50294765e9d9c265bae45c54df6e2f
+  data.tar.gz: 17e44c8a2009a67e9a62ffc36d5cf68aa2e8c9c74d43ea4b34f090873c5461a10a023fb0802e5ea41cbd188c56b97dbda6fabc9384d67cdb1aee4899750e74fb

data/README.md

@@ -36,6 +36,14 @@ 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' />
 
+### 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 src='https://raw.githubusercontent.com/instantink/image_compare/master/spec/fixtures/color_diff.png' width='300' />
+
 ### Base (RGB) mode
 
 Compare pixels by values, resulting score is a ratio of unequal pixels.
@@ -61,12 +69,17 @@ Resulting diff contains grayscale version of the first image with different pixe
 ## 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,7 +87,7 @@ 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
 
@@ -103,9 +116,58 @@ 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
+
+# or
+
+cmp = ImageCompare::Matcher.new exclude_rect: [200, 150, 275, 200]
+res = cmp.compare(path_1, path_2)
+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)
 ```
 `[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_1, path_2)
+res.difference_image.save(new_path)
+
+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.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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImageCompare
-  VERSION = '1.0.0-dev'
+  VERSION = '1.0.0'
 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.0
 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-27 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: