pixel_matcher 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e709cf7a1171cf3646e11ee33fdd847c90d9eb087b61bcfedaa760d7b3fbf46
-  data.tar.gz: 1cecb8fa4d4af025d8c0cef94f6f6598d1a8feefeb93a22fb60538705be50ff5
+  metadata.gz: 9878d36f90fea82db8e1d5411b36b5d72d20d8353de7829ac7d90774ceb49396
+  data.tar.gz: f7bfb4d812e76a101ff2405af772c2d6706ff899c05d606984cb71c75440c181
 SHA512:
-  metadata.gz: 2322258ac93036c4e42731e2ed58fe62fbdef5bc98e2c60bcd0c27bd43025f66be3ceb05615847c3c93aa98cb19fa49933427d49a04784046ba7997b87deed2f
-  data.tar.gz: c9a92b95861ad934c8e0f90d0c5fbe70806ceab5c3b740a093cd820e8abf04b2b18ecfac2f3f29e7858e355b3b207a1c8d31af32b5b51d1fc911bb9ff9c055ed
+  metadata.gz: 12546f60584e1c87744457e5eb8961cd5ceca0b27fefff265f1014c22cc9aee4c8559ce6023aabde4fdc30593774da2fecb981e3428939e9a34f6797dffe1f68
+  data.tar.gz: a2a76e6ffa2e0acb99434fbd336be3b70b4488ac9cf2903aba1af358bce04091209b2dc17d3eb6c3385483b25bacea0c047c09af31d30261785f8a1136b2c993

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+/vendor/bundle

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pixel_matcher (0.0.5)
+    pixel_matcher (0.0.6)
       rmagick (~> 4.0)
 
 GEM

data/README.md

@@ -1,8 +1,15 @@
 # PixelMatcher
+![](https://ruby-gem-downloads-badge.herokuapp.com/pixel_matcher)
+[![Gem Version](https://badge.fury.io/rb/pixel_matcher.svg)](https://badge.fury.io/rb/pixel_matcher)
+[![Build Status](https://travis-ci.org/ksk001100/pixel_matcher.svg?branch=master)](https://travis-ci.org/ksk001100/pixel_matcher)
+![](https://img.shields.io/github/issues/ksk001100/pixel_matcher.svg)
+![](https://img.shields.io/github/forks/ksk001100/pixel_matcher.svg)
+![](https://img.shields.io/github/license/ksk001100/pixel_matcher.svg)
+
 
 Library to compare images and generate difference image files
 
-![](images/screen_shot.jpeg)
+![](images/generate.png)
 
 ## Installation
 
@@ -28,18 +35,21 @@ require 'pixel_matcher'
 # from rmagick image
 require 'rmagick'
 diff = PixelMatcher::DiffImage.new(Magick::Image.read('img1.png').first, Magick::Image.read('img2.png').first)
-diff.export_diff('diff.png')
-diff.export_gray_scale('gray_scale.png')
+diff.export('diff.png') # or mode: :only
+diff.export('gray_scale.png', mode: :gray_scale)
+diff.export('compare.png', mode: :compare)
 
 # from file path
 diff = PixelMatcher::DiffImage.from_path('img1.png', 'img2.png')
-diff.export_diff('diff.png')
-diff.export_gray_scale('gray_scale.png')
+diff.export('diff.png') # or mode: :only
+diff.export('gray_scale.png', mode: :gray_scale)
+diff.export('compare.png', mode: :compare)
 
 # from blob
 diff = PixelMatcher::DiffImage.from_blob(File.read('img1.png'), File.read('img2.png'))
-diff.export_diff('diff.png')
-diff.export_gray_scale('gray_scale.png')
+diff.export('diff.png') # or mode: :only
+diff.export('gray_scale.png', mode: :gray_scale)
+diff.export('compare.png', mode: :compare)
 ```
 
 

data/lib/pixel_matcher.rb

@@ -2,5 +2,15 @@ require "pixel_matcher/version"
 require 'pixel_matcher/diff_image'
 
 module PixelMatcher
-  class SizeMismatchError < StandardError; end
+  class SizeMismatchError < StandardError
+    def initialize(msg = 'Image size mismatch...')
+      super
+    end
+  end
+
+  class ModeMismatchError < StandardError
+    def initialize(msg = 'Undefined mode...')
+      super
+    end
+  end
 end

data/lib/pixel_matcher/diff_image.rb

@@ -2,30 +2,50 @@ require 'rmagick'
 
 module PixelMatcher
   class DiffImage < Magick::Image
-    def initialize(img1, img2)
-      self.class.image_size_validate(img1, img2)
-      @img1 = img1
-      @img2 = img2
-      super(@img1.columns, @img1.rows) { self.background_color = 'none' }
+    def initialize(original, changed)
+      self.class.image_size_validate!(original, changed)
+
+      @original = original
+      @changed = changed
+      super(@original.columns, @original.rows) { self.background_color = 'none' }
       store_diff
     end
 
     def self.from_path(path1, path2)
-      img1 = Magick::Image.read(path1).first
-      img2 = Magick::Image.read(path2).first
-      new(img1, img2)
+      original = Magick::Image.read(path1).first
+      changed = Magick::Image.read(path2).first
+      new(original, changed)
     end
 
     def self.from_blob(bin1, bin2)
-      img1 = Magick::Image.from_blob(bin1).first
-      img2 = Magick::Image.from_blob(bin2).first
-      new(img1, img2)
+      original = Magick::Image.from_blob(bin1).first
+      changed = Magick::Image.from_blob(bin2).first
+      new(original, changed)
+    end
+
+    def export(output_path, mode: :only)
+      case mode
+      when :only then export_diff(output_path)
+      when :gray_scale then export_gray_scale(output_path)
+      when :compare then export_compare(output_path)
+      else self.class.mode_validate!
+      end
     end
 
-    def self.image_size_validate(img1, img2)
-      return if [img1.columns, img1.rows] == [img2.columns, img2.rows]
+    private
+
+    def store_diff
+      @original.columns.times do |i|
+        @original.rows.times do |j|
+          next if eq_pixel?(i, j)
+
+          store_pixels(i, j, 1, 1, [@original.pixel_color(i, j)])
+        end
+      end
+    end
 
-      raise PixelMatcher::SizeMismatchError, 'Image size mismatch'
+    def eq_pixel?(column, row)
+      @original.pixel_color(column, row) == @changed.pixel_color(column, row)
     end
 
     def export_diff(output_path)
@@ -34,26 +54,29 @@ module PixelMatcher
     end
 
     def export_gray_scale(output_path)
-      gray_scale = @img1.clone.quantize(256, Magick::GRAYColorspace)
-      gray_scale.composite!(self, Magick::CenterGravity, 0, 0, Magick::OverCompositeOp);
+      gray_scale = @original.clone.quantize(256, Magick::GRAYColorspace)
+      gray_scale.composite!(self, Magick::CenterGravity, 0, 0, Magick::OverCompositeOp)
       gray_scale.write(output_path)
       self
     end
 
-    private
+    def export_compare(output_path)
+      @changed.compare_channel(@original, Magick::MeanSquaredErrorMetric)
+              .first
+              .write(output_path)
+      self
+    end
 
-    def store_diff
-      @img1.columns.times do |i|
-        @img1.rows.times do |j|
-          next if eq_pixel?(i, j)
+    class << self
+      def image_size_validate!(original, changed)
+        return if [original.columns, original.rows] == [changed.columns, changed.rows]
 
-          store_pixels(i, j, 1, 1, [@img1.pixel_color(i, j)])
-        end
+        raise PixelMatcher::SizeMismatchError
       end
-    end
 
-    def eq_pixel?(column, row)
-      @img1.pixel_color(column, row) == @img2.pixel_color(column, row)
+      def mode_validate!
+        raise PixelMatcher::ModeMismatchError
+      end
     end
   end
 end

data/lib/pixel_matcher/version.rb

@@ -1,3 +1,3 @@
 module PixelMatcher
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pixel_matcher
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - ksk001100
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2020-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick
@@ -114,7 +114,7 @@ files:
 - bin/console
 - bin/setup
 - exe/pixel_matcher
-- images/screen_shot.jpeg
+- images/generate.png
 - lib/pixel_matcher.rb
 - lib/pixel_matcher/diff_image.rb
 - lib/pixel_matcher/version.rb