image_compare 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9172a89fc7bd3779f58bf4291d045db2e9de6ce8e1d17d7eed9be6970c6faed9
-  data.tar.gz: f3d1a90a07c4d728ea51c2effd424d9a32b4567b53b59119a996637defebc4b7
+  metadata.gz: efc745c05f8c87808311a102dc55c92e030de6ce85a6512aed95161a817258ce
+  data.tar.gz: a243eda35bc9edf3313a8d34c7ad71ae2a066f3553faada189a58ea9db04c1e6
 SHA512:
-  metadata.gz: c8a0fcbd0668b614592b65972d1326a7a2f2853da2a133150fd6d5d0e8153a46f7d986033cec071d6df6b6cdd6c5b0c7950cd76b07494dc6bd8e240ee4d928b3
-  data.tar.gz: 8c81cf6accfeb98d780ff3ed724834b5816c0d245186086d9b075e77f56a8f29f9d52d20fa4d01210bc5a8ddd36dfb7e7694ffc9e8024fc809e4a10b31437a42
+  metadata.gz: 6009fd283629fc28bc28e5ed4a4e74dcf39946e23d16dd0bb03a35ca98fb069f8a5a3279d5b46cd3373550d80cccc7a5fda0c360277062a092c220ba4415827e
+  data.tar.gz: 3ea374f5b4c3e184ee34f9c0ff3aa36c8a400e3923bafa34bd90ca66b79c2da080f606bf31fb31d717496bf045f091eba9d6a7df96eb0283517587615f019233

data/CHANGELOG.md

@@ -1,7 +1,9 @@
 # Change log
 
 ## main
-- Add Color mode to generate "normal" diff images ([@gsguma][], [@cristianofmc][])
+- v1.0.0: Add Color mode to generate "normal" diff images ([@gsguma][], [@cristianofmc][])
+- v1.0.1: Fix all code smells and integration tests ([@gsguma][])
+- v1.0.2: Fix gem documentation uri ([@gsguma][])
 
 [@gsguma]: https://github.com/gsguma
 [@cristianofmc]: https://github.com/cristianofmc

data/README.md

@@ -11,7 +11,7 @@ This is an utility library for image regression testing.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'image_compare'
+gem "image_compare"
 ```
 
 Or adding to your project:
@@ -20,7 +20,7 @@ Or adding to your project:
 # my-cool-gem.gemspec
 Gem::Specification.new do |spec|
   # ...
-  spec.add_dependency 'image_compare'
+  spec.add_dependency "image_compare"
   # ...
 end
 ```
@@ -33,38 +33,47 @@ ImageCompare supports different ways (_modes_) of comparing images.
 
 Source images used in examples:
 
-<img alt='a.png' src='spec/fixtures/a.png' />
-<img alt='b.png' src='spec/fixtures/b.png' />
+a1.png
 
-### Color
+<img alt="a.png" src="spec/fixtures/a.png" />
+
+b.png
+
+<img alt="b.png" src="spec/fixtures/b.png" />
+
+a1.png
+
+<img alt="a1.png" src="spec/fixtures/a1.png" />
+
+### Base (Color) mode (a.png X a1.png)
 
 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' />
+<img alt="color_diff" src="spec/fixtures/color_diff.png" />
 
-### Base (RGB) mode
+### RGB mode (a.png X b.png)
 
 Compare pixels by values, resulting score is a ratio of unequal pixels.
 Resulting diff represents per-channel difference.
 
-<img alt='rgb_diff.png' src='spec/fixtures/rgb_diff.png' width='480' />
+<img alt="rgb_diff.png" src="spec/fixtures/rgb_diff.png" />
 
-### Grayscale mode
+### Grayscale mode (a.png X a1.png)
 
 Compare pixels as grayscale (by brightness and alpha), resulting score is a ratio of unequal pixels (with respect to provided tolerance).
 
 Resulting diff contains grayscale version of the first image with different pixels highlighted in red and red bounding box.
 
-<img alt='grayscale_diff.png' src='spec/fixtures/grayscale_diff.png' width='480' />
+<img alt="grayscale_diff.png" src="spec/fixtures/grayscale_diff.png" />
 
-### Delta
+### Delta (a.png X a1.png)
 
 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 alt='delta_diff.png' src='spec/fixtures/delta_diff.png' width='480' />
+<img alt="delta_diff.png" src="spec/fixtures/delta_diff.png" />
 
 ## Usage
 
@@ -91,7 +100,7 @@ cmp.lower_threshold #=> 0.01
 cmp = ImageCompare::Matcher.new mode: :grayscale, tolerance: 0
 cmp.mode #=> ImageCompare::Modes::Grayscale
 
-res = cmp.compare('path/image1.png', 'path/image2.png')
+res = cmp.compare("path/image1.png", "path/image2.png")
 res #=> ImageCompare::Result
 res.match? #=> true
 res.score #=> 0.0
@@ -101,44 +110,43 @@ res.difference_image #=> ImageCompare::Image
 res.difference_image.save(result)
 
 # without explicit matcher
-res = ImageCompare.compare('path/image1.png', 'path/image2.png', 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('my_images_path/image1.png', 'my_images_path/image2.png')
+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
+## Excluding rectangle (a.png X a1.png)
 
-<img alt='a.png' src='spec/fixtures/a.png' />
-<img alt='a1.png' src='spec/fixtures/a1.png' />
+<img alt="a1.png" src="spec/fixtures/rgb_exclude_rect.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/image1.png', 'path/image2.png', exclude_rect: [200, 150, 275, 200]).match? # => true
+ImageCompare.compare("path/image1.png", "path/image2.png", mode: :rgb, 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')
+cmp = ImageCompare::Matcher.new mode: :rgb, 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')
+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'
+require "image_compare"
 ```
 
 `support/capybara_extensions.rb`:
@@ -147,15 +155,15 @@ require 'image_compare'
 
 Capybara::Node::Element.class_eval do
   def rect_area
-    rect_area = self.evaluate_script('this.getBoundingClientRect()')
+    rect_area = self.evaluate_script("this.getBoundingClientRect()") # rubocop:disable Style/RedundantSelf
 
     [
-      rect_area['left'].to_f.round,
-      rect_area['top'].to_f.round,
-      rect_area['right'].to_f.round,
-      rect_area['bottom'].to_f.round
+      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
+  rescue StandardError => e # rubocop:disable Style/RescueStandardError
     raise "Error getting element rect area: #{e.inspect}!"
   end
 end
@@ -163,11 +171,11 @@ end
 
 `steps/my_step.rb`:
 ```ruby
-my_element = page.find('#my_element').rect_area
+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')
+res = cmp.compare("path/image1.png", "path/image2.png")
+res.difference_image.save("path/diff.png")
 
 expect(res.match?).to eq(true)
 ```
@@ -180,6 +188,20 @@ You can set bounds of comparing by passing `:include_rect` to `compare` with arr
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/instantink/image_compare.
 
+### Running tests and code inspections
+
+- `rake rubocop`
+- `rake rubocop:md`
+- `rake spec`
+- `ruby examples/performance.rb` Create the "gemfile.local" file with the content below to run the performance tests:
+```ruby
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gem "benchmark-ips", "~> 2.7", ">= 2.7.2"
+```
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/image_compare/color_methods.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'chunky_png'
+require "chunky_png"
 
 begin
-  require 'oily_png' unless RUBY_PLATFORM == 'java'
+  require "oily_png" unless RUBY_PLATFORM == "java"
 rescue LoadError => _e
   nil
 end

data/lib/image_compare/image.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'image_compare/color_methods'
+require "image_compare/color_methods"
 
 module ImageCompare
   class Image < ChunkyPNG::Image

data/lib/image_compare/matcher.rb

@@ -2,15 +2,15 @@
 
 module ImageCompare
   class Matcher
-    require 'image_compare/image'
-    require 'image_compare/result'
-    require 'image_compare/modes'
+    require "image_compare/image"
+    require "image_compare/result"
+    require "image_compare/modes"
 
     MODES = {
-      rgb: 'RGB',
-      delta: 'Delta',
-      grayscale: 'Grayscale',
-      color: 'Color'
+      rgb: "RGB",
+      delta: "Delta",
+      grayscale: "Grayscale",
+      color: "Color"
     }.freeze
 
     attr_reader :mode
@@ -26,25 +26,27 @@ module ImageCompare
       b = Image.from_file(b) unless b.is_a?(Image)
 
       unless a.sizes_match?(b)
-        raise SizesMismatchError,
-              "Size mismatch: first image size: #{a.width}x#{a.height}, second image size: #{b.width}x#{b.height}"
+        raise(
+          SizesMismatchError,
+          "Size mismatch: first image size: #{a.width}x#{a.height}, second image size: #{b.width}x#{b.height}"
+        )
       end
 
       image_area = Rectangle.new(0, 0, a.width - 1, a.height - 1)
 
       unless mode.exclude_rect.nil?
         unless image_area.contains?(mode.exclude_rect)
-          raise ArgumentError, 'Bounds must be in image'
+          raise ArgumentError, "Bounds must be in image"
         end
       end
 
       unless mode.include_rect.nil?
         unless image_area.contains?(mode.include_rect)
-          raise ArgumentError, 'Bounds must be in image'
+          raise ArgumentError, "Bounds must be in image"
         end
         unless mode.exclude_rect.nil?
           unless mode.include_rect.contains?(mode.exclude_rect)
-            raise ArgumentError, 'Included area must contain excluded'
+            raise ArgumentError, "Included area must contain excluded"
           end
         end
       end

data/lib/image_compare/modes/base.rb

@@ -3,7 +3,7 @@
 module ImageCompare
   module Modes
     class Base
-      require 'image_compare/rectangle'
+      require "image_compare/rectangle"
       include ColorMethods
 
       attr_reader :result, :threshold, :lower_threshold, :bounds, :exclude_rect, :include_rect

data/lib/image_compare/modes/color.rb

@@ -2,7 +2,7 @@
 
 module ImageCompare
   module Modes
-    require 'image_compare/modes/base'
+    require "image_compare/modes/base"
 
     class Color < Base
       include ColorMethods
@@ -33,20 +33,20 @@ module ImageCompare
           left: bounds.bounds[0],
           top: bounds.bounds[1],
           right: bounds.bounds[2],
-          bot:  bounds.bounds[3]
+          bot: bounds.bounds[3]
         }
 
         exclude_area = {
           left: exclude_rect.bounds[0],
           top: exclude_rect.bounds[1],
           right: exclude_rect.bounds[2],
-          bot:  exclude_rect.bounds[3]
+          bot: exclude_rect.bounds[3]
         }
 
         diff_area[:left] <= exclude_area[:left] &&
-        diff_area[:top] <= exclude_area[:top] &&
-        diff_area[:right] >= exclude_area[:right] &&
-        diff_area[:bot] >= exclude_area[:bot]
+          diff_area[:top] <= exclude_area[:top] &&
+          diff_area[:right] >= exclude_area[:right] &&
+          diff_area[:bot] >= exclude_area[:bot]
       end
 
       def pixels_equal?(a, b)

data/lib/image_compare/modes/delta.rb

@@ -2,7 +2,7 @@
 
 module ImageCompare
   module Modes
-    require 'image_compare/modes/base'
+    require "image_compare/modes/base"
 
     class Delta < Base
       attr_reader :tolerance

data/lib/image_compare/modes/grayscale.rb

@@ -2,7 +2,7 @@
 
 module ImageCompare
   module Modes
-    require 'image_compare/modes/base'
+    require "image_compare/modes/base"
 
     class Grayscale < Base
       DEFAULT_TOLERANCE = 16

data/lib/image_compare/modes/rgb.rb

@@ -2,7 +2,7 @@
 
 module ImageCompare
   module Modes
-    require 'image_compare/modes/base'
+    require "image_compare/modes/base"
 
     class RGB < Base
       def pixels_equal?(a, b)

data/lib/image_compare/modes.rb

@@ -2,9 +2,9 @@
 
 module ImageCompare
   module Modes
-    require 'image_compare/modes/color'
-    require 'image_compare/modes/delta'
-    require 'image_compare/modes/grayscale'
-    require 'image_compare/modes/rgb'
+    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

@@ -28,8 +28,8 @@ module ImageCompare
 
     def contains_point?(x, y)
       (x >= left && y >= top && x <= right && y <= bot) ||
-      (x <= right && y <= top && x >= left && y >= bot) ||
-      (x.between?(right, left) && y.between?(bot, top))
+        (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.1'
+  VERSION = "1.0.3"
 end

data/lib/image_compare.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'image_compare/version'
+require "image_compare/version"
 
 module ImageCompare
   class SizesMismatchError < StandardError
   end
 
-  require 'image_compare/color_methods'
-  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.1
+  version: 1.0.3
 platform: ruby
 authors:
 - cristianofmc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-28 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chunky_png
@@ -85,7 +85,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/instantink/image_compare/issues
   changelog_uri: https://github.com/instantink/image_compare/blob/master/CHANGELOG.md
-  documentation_uri: https://github.com/instantink/image_compare
+  documentation_uri: https://www.rubydoc.info/gems/image_compare/1.0.3
   homepage_uri: https://github.com/instantink/image_compare
   source_code_uri: https://github.com/instantink/image_compare
 post_install_message: