pxdoppelganger 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c51c60a2ee727316dda9cc0fc8b4c73edb6c19f9
+  data.tar.gz: 3d623cc945a162ebe82470b83977eb1b6e9dc0e5
+SHA512:
+  metadata.gz: 8b20cccc5c96cf628644bff2ce8e205ae1b64f5b77db311ab970e6d9175704475ed065f752ab225ebce6b0b9cd8ef698ad981b7da086bc5ba95068e64338d540
+  data.tar.gz: 839bf7efb354e0df470c6c9b303fb90cf3512edf9e7a3491c4cdaab01183f0894c1f9d567e0c3d59d9bc8e43ec1b9e285dbdef7836d7c6c2159b7a33dfb44fbc

data/.gitignore

@@ -0,0 +1,11 @@
+lib/images/**
+.idea/
+out.html
+
+*~
+chromedriver.log
+.ruby-version
+.DS_Store
+.kate-swp
+.ruby-gemset
+.swp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'chunky_png'
+gem 'oily_png'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    pxdoppelganger (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    chunky_png (1.3.4)
+    diff-lcs (1.2.5)
+    oily_png (1.2.0)
+      chunky_png (~> 1.3.1)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  chunky_png
+  oily_png
+  pxdoppelganger!
+  rspec
+
+BUNDLED WITH
+   1.10.5

data/README.md

@@ -0,0 +1,49 @@
+# pXdoppelganger
+
+## what can it do for me?
+
+* pXdoppelganger can compare two images for you.
+* pXdoppelganger converts the images into bitstreams and thus analyze every pixcel.
+* pXdoppelganger can tell you if those images are equal and what the percentual change is.
+* pXdoppelganger can also show you the "difference" image between the two images.
+
+## how do I use it?
+
+install the gem:
+```
+gem install pxdoppelganger
+```
+and use it:
+```
+require 'pxdoppelganger'
+```
+
+provide paths to images:
+```
+images = PXDoppelganger::Images.new('~/Downloads/Image1.png', '~/Downloads/Image2.png')
+```
+
+see if images are equal:
+```
+images.equal?
+=> true/false
+```
+
+get the difference of the two images (in percent):
+```
+images.difference
+=> 1.3849177058385036
+```
+
+save the difference-image:
+```
+images.save_difference_image('~Documents/analysis/diff_image.png')
+```
+
+## how do I contribute?
+
+open pull request
+
+## license
+
+MIT: http://opensource.org/licenses/MIT

data/bin/pxdoppelganger

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'pxdoppelganger'
+
+Deployment.new

data/lib/controller/analyzer.rb

@@ -0,0 +1,76 @@
+require 'oily_png'
+require 'chunky_png'
+require 'fileutils'
+include OilyPNG::Color
+include ChunkyPNG::Color
+
+class Analyzer
+
+  attr_accessor :difference, :difference_in_percent
+
+  def initialize(base_image, new_image)
+    raise 'The images need to be in png format' unless are_images_png?(base_image, new_image)
+    self.images = [
+        ChunkyPNG::Image.from_file(base_image),
+        ChunkyPNG::Image.from_file(new_image),
+    ]
+    raise_different_size unless images_have_same_width?
+    self.difference = difference_analyzer
+    self.difference_in_percent = percent_calculator(difference)
+  end
+
+  def save_output(path)
+    @output.save(path)
+  end
+
+  private
+
+  attr_accessor :images
+
+  def are_images_png?(base, new)
+    true if (base.downcase.include? 'png') && (new.downcase.include? 'png')
+  end
+
+  def images_have_same_width?
+    images.first.width == images.last.width
+  end
+
+  def raise_different_size
+    raise "The images do not have the same width."
+  end
+
+  def difference_analyzer
+    @output = ChunkyPNG::Image.new(images.first.width, images.first.height, WHITE)
+    difference = []
+    images.first.height.times do |y|
+      images.first.row(y).each_with_index do |pixel, x|
+        begin
+          unless pixel == images.last[x,y]
+            score = Math.sqrt(
+                (r(images.last[x,y]) - r(pixel)) ** 2 +
+                (g(images.last[x,y]) - g(pixel)) ** 2 +
+                (b(images.last[x,y]) - b(pixel)) ** 2
+            ) / Math.sqrt(MAX ** 2 * 3)
+
+            @output[x,y] = grayscale(MAX - (score * MAX).round)
+            difference << score
+          end
+        rescue ChunkyPNG::OutOfBounds
+          # "out of bound error"
+          # in Y-Direction (= one image is longer than the other)
+          # if webpages change, they may have a different vertical length
+        end
+      end
+    end
+    difference
+  end
+
+  def percent_calculator(difference)
+    if difference == []
+      0
+    else
+      ((difference.inject {|sum, value| sum + value} / images.first.pixels.length) * 100).to_f
+    end
+  end
+
+end

data/lib/pxdoppelganger.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'controller/analyzer'
+
+module PXDoppelganger
+
+  class Images
+
+    def initialize(base_image, new_image)
+      @result = Analyzer.new(base_image, new_image)
+    end
+
+    def equal?
+      @result.difference == []
+    end
+
+    def difference
+      @result.difference_in_percent
+    end
+
+    def save_difference_image(path)
+      @result.save_output(path)
+    end
+
+  end
+
+end

data/lib/pxdoppelganger/version.rb

@@ -0,0 +1,13 @@
+module PXDoppelganger
+  class Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 1
+
+    class << self
+      def to_s
+        [MAJOR, MINOR, PATCH].join('.')
+      end
+    end
+  end
+end

data/pxdoppelganger.gemspec

@@ -0,0 +1,16 @@
+require File.expand_path('../lib/pxdoppelganger/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors = %w(Finn Lorbeer)
+  gem.version = PXDoppelganger::Version
+  gem.name = 'pxdoppelganger'
+  gem.platform = Gem::Platform::RUBY
+  gem.require_paths = %w(lib)
+  gem.license = 'MIT'
+  gem.email = %w(finn.von.friesland@googlemail.com)
+  gem.summary = "pXdoppelganger will help you in your automated design regression testing"
+  gem.description = %q{pXdoppelganger compares two images and can tell you the exact difference (in % of pixels changed). If you compare two screenshots of you app before and after a release, it will help you to automate your design regression tests. It follows the suggestions of image comparison by in Jeff Kreeftmeijers blog: jeffkreeftmeijer.com/2011/comparing-images-and-creating-image-diffs/}
+  gem.homepage = 'https://www.otto.de'
+  gem.files = `git ls-files`.split($\)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+end

data/tests/rspec/analyzer_spec.rb

@@ -0,0 +1,74 @@
+require 'rspec'
+require 'fileutils'
+require '../../lib/controller/analyzer'
+
+describe '#analyzer' do
+
+  PATH_TO_OTTO_LOGO = '../images/ottologo.png'
+  PATH_TO_DIFFERENT_LOGO = '../images/ottologo2.png'
+  DIFFERENCE_IMAGE = '../images/otto_DIFF.png'
+
+  after(:each) { FileUtils.rm DIFFERENCE_IMAGE if File.exist? (DIFFERENCE_IMAGE) }
+
+  it "should throw an exception if the images is not png" do
+    expect {
+      Analyzer.new('some_wrong/path.JPG', 'another_wrong/path.JPG')
+    }.to raise_error("The images need to be in png format")
+  end
+
+  it "should throw an exception if the image cannot be found" do
+    expect {
+      Analyzer.new('some_wrong/path.png', 'another_wrong/path.PNG')
+    }.to raise_error(Errno::ENOENT)
+  end
+
+  it "should throw an exception if the images do not have the same width" do
+    expect {
+      Analyzer.new(PATH_TO_OTTO_LOGO, '../images/ottologosmall.png')
+    }.to raise_error("The images do not have the same width.")
+  end
+
+  it "should return an empty array if both analyzed images are the same" do
+    analyzer = Analyzer.new(PATH_TO_OTTO_LOGO, PATH_TO_OTTO_LOGO)
+    expect(
+        analyzer.difference.empty?
+    ).to be(true)
+  end
+
+  it "should return 0% change if both analyzed images are the same" do
+    analyzer = Analyzer.new(PATH_TO_OTTO_LOGO, PATH_TO_OTTO_LOGO)
+    expect(
+        analyzer.difference_in_percent
+    ).to eq(0)
+  end
+
+  it "should return a not empty array if both analyzed images are not the same" do
+    analyzer = Analyzer.new(PATH_TO_OTTO_LOGO, PATH_TO_DIFFERENT_LOGO)
+    expect(
+        analyzer.difference.empty?
+    ).to be(false)
+  end
+
+  it "should return x% change if the analyzed images are not the same" do
+    analyzer = Analyzer.new(PATH_TO_OTTO_LOGO, PATH_TO_DIFFERENT_LOGO)
+    expect(
+        analyzer.difference_in_percent.round(2)
+    ).to eq(1.38)
+  end
+
+  it "should create an output image" do
+    analyzer = Analyzer.new(PATH_TO_OTTO_LOGO, PATH_TO_DIFFERENT_LOGO)
+    expect(
+        analyzer.save_output(DIFFERENCE_IMAGE)
+    ).to be_a(File)
+  end
+
+  it "should save an output image" do
+    analyzer = Analyzer.new(PATH_TO_OTTO_LOGO, PATH_TO_DIFFERENT_LOGO)
+    analyzer.save_output(DIFFERENCE_IMAGE)
+    expect(
+        File.exist? (DIFFERENCE_IMAGE)
+    ).to be(true)
+  end
+
+end

data/tests/rspec/pxdoppelganger_spec.rb

@@ -0,0 +1,58 @@
+require 'rspec'
+require '../../lib/controller/analyzer'
+require '../../lib/pxdoppelganger'
+
+PATH_TO_OTTO_LOGO = '../images/ottologo.png'
+PATH_TO_DIFFERENT_LOGO = '../images/ottologo2.png'
+DIFFERENCE_IMAGE = '../images/otto_DIFF.png'
+
+describe '#equal?' do
+
+  it 'returns "true" if two images are equal' do
+    pxdoppelganger = PXDoppelganger::Images.new(
+        PATH_TO_OTTO_LOGO, PATH_TO_OTTO_LOGO
+    )
+    expect(
+        pxdoppelganger.equal?
+    ).to be(true)
+  end
+
+  it 'returns "false" if two images are equal' do
+    pxdoppelganger = PXDoppelganger::Images.new(
+        PATH_TO_OTTO_LOGO, PATH_TO_DIFFERENT_LOGO
+    )
+    expect(
+        pxdoppelganger.equal?
+    ).to be(false)
+  end
+
+end
+
+describe '#difference' do
+
+  it 'returns the %-difference of two images' do
+    pxdoppelganger = PXDoppelganger::Images.new(
+        PATH_TO_OTTO_LOGO, PATH_TO_DIFFERENT_LOGO
+    )
+    expect(
+        pxdoppelganger.difference.round(2)
+    ).to eq(1.38)
+  end
+
+end
+
+describe '#save_difference_image' do
+
+  after(:each) { FileUtils.rm DIFFERENCE_IMAGE if File.exist? (DIFFERENCE_IMAGE) }
+
+  it 'saves the difference image' do
+    pxdoppelganger = PXDoppelganger::Images.new(
+        PATH_TO_OTTO_LOGO, PATH_TO_DIFFERENT_LOGO
+    )
+    pxdoppelganger.save_difference_image(DIFFERENCE_IMAGE)
+    expect(
+        File.exist? (DIFFERENCE_IMAGE)
+    ).to be(true)
+  end
+
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: pxdoppelganger
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Finn
+- Lorbeer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-21 00:00:00.000000000 Z
+dependencies: []
+description: 'pXdoppelganger compares two images and can tell you the exact difference
+  (in % of pixels changed). If you compare two screenshots of you app before and after
+  a release, it will help you to automate your design regression tests. It follows
+  the suggestions of image comparison by in Jeff Kreeftmeijers blog: jeffkreeftmeijer.com/2011/comparing-images-and-creating-image-diffs/'
+email:
+- finn.von.friesland@googlemail.com
+executables:
+- pxdoppelganger
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/pxdoppelganger
+- lib/controller/analyzer.rb
+- lib/pxdoppelganger.rb
+- lib/pxdoppelganger/version.rb
+- pxdoppelganger.gemspec
+- tests/images/ottologo.png
+- tests/images/ottologo2.png
+- tests/images/ottologosmall.png
+- tests/rspec/analyzer_spec.rb
+- tests/rspec/pxdoppelganger_spec.rb
+homepage: https://www.otto.de
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: pXdoppelganger will help you in your automated design regression testing
+test_files: []