image_compare 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fddeaa634a928ccfeed4d71797a78d9f8201bc5df036275181ac10addd6a315c
-  data.tar.gz: 43128e9a8fb1c95d246808bdd746ab8023ee984a754e3690b411eb17768399e1
+  metadata.gz: efc745c05f8c87808311a102dc55c92e030de6ce85a6512aed95161a817258ce
+  data.tar.gz: a243eda35bc9edf3313a8d34c7ad71ae2a066f3553faada189a58ea9db04c1e6
 SHA512:
-  metadata.gz: dbc5a9c8c6a9b4f34ea24d9259cc0913aa12672dfa10e279134a477a0331b079bd51c1355e1d09b3b0e6a4008ee19c8feda0baa04e3465899b6e001453c15533
-  data.tar.gz: e5cd324880f6f97459eb0b290a3764934f750852d234f775d32ccfbe060cd73152307db6d175f3c120592686e74e9c0509308546f68534c7d741ded33ee99e16
+  metadata.gz: 6009fd283629fc28bc28e5ed4a4e74dcf39946e23d16dd0bb03a35ca98fb069f8a5a3279d5b46cd3373550d80cccc7a5fda0c360277062a092c220ba4415827e
+  data.tar.gz: 3ea374f5b4c3e184ee34f9c0ff3aa36c8a400e3923bafa34bd90ca66b79c2da080f606bf31fb31d717496bf045f091eba9d6a7df96eb0283517587615f019233

data/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## main
 - 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

@@ -8,7 +8,7 @@ This is an utility library for image regression testing.
 
 ## Installation
 
-Add this line to your application"s Gemfile:
+Add this line to your application's Gemfile:
 
 ```ruby
 gem "image_compare"
@@ -33,10 +33,19 @@ ImageCompare supports different ways (_modes_) of comparing images.
 
 Source images used in examples:
 
+a1.png
+
 <img alt="a.png" src="spec/fixtures/a.png" />
+
+b.png
+
 <img alt="b.png" src="spec/fixtures/b.png" />
 
-### Color
+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).
 
@@ -44,27 +53,27 @@ Resulting diff contains version of the first image with different pixels highlig
 
 <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
 
@@ -111,19 +120,18 @@ 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]
+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
@@ -185,7 +193,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/instan
 - `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 examples/performance.rb` Create the "gemfile.local" file with the content below to run the performance tests:
 ```ruby
 # frozen_string_literal: true
 

data/lib/image_compare/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImageCompare
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: image_compare
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - cristianofmc
@@ -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: