web_image_compare 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 946232f6d4774b842da3cf33c43af3f6a5bc6e03
+  data.tar.gz: 822d61b410e368b681d88fa65a8b14df8db39fb4
+SHA512:
+  metadata.gz: e28570f844338d4312feb12d572e25c3908db9b8ffa4b729e0d0d9a53bac72ce4a1d93cc5fbdcfaa5cf082a4183c4d66639c49323ddb19601ef09af937ec68cc
+  data.tar.gz: 7f6553c1f8f48dd2ac0f8f1e6ff6639604af1518a5eb7b5ecc9943086fce76a9189c2e639087afe0aa5148db7ead6fc16adb0bc64a7dabf08f1093e350807431

data/.editorconfig

@@ -0,0 +1,11 @@
+# EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.rb]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,27 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea/
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+
+# Image result from the tests
+spec/images/*.png_result
+
+Gemfile.lock
+report.html
+bwviziaapi.log
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# Compare Image tool
+A tool to compare images from web elements. It is designed to work with Web elements from Capybara (from now on all the references to web elements will be relative to the web elments from capybara) and PNG images.
+
+
+## What it does?
+With this tool it is possible crop or hide web elements before perform the image comparison.
+The crop operation is based on the web element location and in the crop operation already available in the chunky_png gem.
+The hide feature, is basically, overlap the specific web elment with a black rectangule. It can be used to hide web elements that are always changing, like for example clocks.
+
+## Usage
+To use the compare image tool you just have to require the web image compare tool, create an object from WebImageCompare class and then, perform the image comparison calling the 'process_image' method.
+
+The first argument of the 'process_image' method is to define one of two modes:
+ true  - it will record the pattern that will be used in posterior comparisons and it desn't perform any comparison;
+ false - it will perform the image comparison between the pattern image and the new image, both identified when the object was initialized;
+
+The second argument is an hash than can have two keys (both of them should be symbols):
+  crop - should be the element by which the image will be cropped
+  hide - Should be an array with all the elements to hide
+
+The result of the image comparison process, wil be the percentual difference between the two images.
+
+
+###Example:
+
+```ruby
+require 'WebImageCompare'
+require 'capybara' # as mentioned the gem works with web elements from capybara
+
+# Inizialize the browser and navigate to the web page desired
+# with capybara
+
+elements = {
+  crop: elem_to_crop'
+  hide: [elem_to_hide_1, elem_to_hide_2]
+}
+
+compare_image = WebImageCompare.new(img_pattern_path, img_to_compare_path)
+compare_image.process_image(record_mode, elements)
+```
+
+##Tests
+
+There are a number of unit tests which are included as part of this project, please run:
+
+```
+rspec spec
+```
+
+Please note that a number of tests still need to be added so I don't currently have complete coverage, subject to workload these will be slowly added over the next few months.
+
+
+## Limitations
+It has the same limitations as the chunky_png, since it is based on it.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+# This is the same as running 'bundle exec rake'
+# All gems will be required at the correct version
+Bundler.setup
+
+require 'ava/rake_task'
+Ava::RakeTask.gem
+
+task :version do
+  puts CompImgTool::Version.version(true)
+end

data/lib/chunky_png/operations.rb

@@ -0,0 +1,44 @@
+module ChunkyPNG
+  # Class Canvas
+  class Canvas
+    # Module operations
+    module Operations
+      include ChunkyPNG::Color
+
+      # Performs the image comparison pixel by pixel
+      #
+      # @param [String] result_img complete path to where is intended save the image
+      # @return [Float] Percentual difference between the two images
+      # @return [Array] Difference image
+      def compare_imgs(pattern_img)
+        fail('height doesn\'t match betwwen the two images') unless pattern_img.height == height
+        fail('width doesn\'t match betwwen the two images') unless pattern_img.width == width
+
+        output = ChunkyPNG::Image.new(pattern_img.width, pattern_img.height, WHITE)
+
+        diff = [0]
+        pattern_img.height.times do |y|
+          pattern_img.row(y).each_with_index do |pixel, x|
+            next if pixel == self[x, y]
+            score = pixel_difference(pixel, self[x, y])
+            output[x, y] = ChunkyPNG.grayscale(MAX - (score * MAX).round)
+            diff << score
+          end
+        end
+
+        # Returns percentage difference and difference image
+        [diff.inject { |a, e| a + e } / pattern_img.pixels.length * 100, output]
+      end
+    end
+
+    private
+
+    def pixel_difference(pixel_1, pixel_2)
+      Math.sqrt(
+          (r(pixel_1) - r(pixel_2))**2 +
+              (g(pixel_1) - g(pixel_2))**2 +
+              (b(pixel_1) - b(pixel_2))**2
+      ) / Math.sqrt(MAX**2 * 3)
+    end
+  end
+end

data/lib/web_image_compare/version.rb

@@ -0,0 +1,23 @@
+module CmpImgTool
+  # BW config api Version
+  module Version
+    # The current gem version
+    VERSION = '0.0.1'
+    # The date version was updated
+    DATE    = '2016-02-03'
+    # Debug output that will contain ruby information
+    MSG     = 'Version %s %s (running on %s-%s)'
+
+    module_function
+
+    # Outputs the current gem version
+    def version(debug = false)
+      if debug
+        format(MSG, VERSION, DATE, RUBY_ENGINE,
+               RUBY_VERSION)
+      else
+        VERSION
+      end
+    end
+  end
+end

data/lib/web_image_compare.rb

@@ -0,0 +1,66 @@
+require 'chunky_png'
+require_relative 'chunky_png/operations'
+
+# Compare image class
+class WebImageCompare
+  include ChunkyPNG::Color
+
+  # initialize the object with the path for the two images
+  #
+  # @param pattern_file_path [String] Path for the pattern image
+  # @param img_to_compare_path [String] Path for the image that it is to compare
+  def initialize(pattern_file_path, img_to_compare_path)
+    @img_to_compare_path  = img_to_compare_path
+    @pattern_img_path     = pattern_file_path
+    @pattern_img          = ChunkyPNG::Image.from_file(pattern_file_path) if File.file?(pattern_file_path)
+    @img_to_compare       = ChunkyPNG::Image.from_file(img_to_compare_path) if File.file?(img_to_compare_path)
+  end
+
+  # Performs the actions to obtain the final image and then
+  # performs the image comparison
+  #
+  # @param record_mode [Boolean] true - saves the pattern image, false - performs the image comparison
+  # @param elements [Hash] Elements to hide or?and crop
+  # @return [Float] Percentual difference between the two images
+  def process_image(record_mode, elements = {})
+    # hide the elements if necessary
+    hide_all_elements(elements[:hide], @img_to_compare) if elements[:hide]
+
+    # crop the element if necessary
+    crop_element(elements[:crop]) if elements[:crop]
+
+    diff_perc = nil
+    if record_mode
+      @img_to_compare.save(@pattern_img_path)
+      return 0
+    else
+      diff_perc, result_img = @img_to_compare.compare_imgs(@pattern_img)
+      @img_to_compare.save("#{@img_to_compare_path}")
+      result_img.save("#{@img_to_compare_path}_result")
+    end
+    diff_perc
+  end
+
+  private
+
+  def hide_all_elements(elements, image)
+    elements.each do |element|
+      x1, y1, x2, y2 = coordinates(element)
+      image = image.rect(x1, y1, x1 + x2, y1 + y2, ChunkyPNG::Color::BLACK, ChunkyPNG::Color::BLACK)
+    end
+  end
+
+  def crop_element(element_to_crop)
+    x1, y1, x2, y2 = coordinates(element_to_crop)
+    @img_to_compare.crop!(x1, y1, x2, y2)
+  end
+
+  def coordinates(element)
+    coordinates = []
+    coordinates[0] = element.native.location.x.round
+    coordinates[1] = element.native.location.y.round
+    coordinates[2] = element.native.size.width.round
+    coordinates[3] = element.native.size.height.round
+    coordinates
+  end
+end

data/spec/web_image_compare_spec.rb

@@ -0,0 +1,18 @@
+require 'web_image_compare'
+
+describe WebImageCompare do
+  describe '.new' do
+    it 'is a WebImageCompare instance' do
+      image_path = File.dirname(__FILE__) +  '/images/example_image.png'
+      expect(WebImageCompare.new(image_path, image_path)).to be_a WebImageCompare
+    end
+  end
+
+  describe '.process_image' do
+    it 'is a perfect match' do
+      image_path = File.dirname(__FILE__) +  '/images/example_image.png'
+      compare_image = WebImageCompare.new(image_path, image_path)
+      compare_image.process_image(false, {}).should eq(0.0)
+    end
+  end
+end

data/web_image_compare.gemspec

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) +  '/lib/web_image_compare/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'web_image_compare'
+  s.summary     = 'Web'
+  s.description = 'A tool to compare images base in web elements'
+  s.author      = 'Rui Nunes'
+  s.email       = 'rui@brandwatch.com'
+  s.license     = 'MIT'
+  s.homepage    = 'https://github.com/Rui-Pedro-Nunes/web-image-compare.git'
+
+  s.date    = CmpImgTool::Version::DATE
+  s.version = CmpImgTool::Version::VERSION
+  s.version = "#{s.version}.pre.#{ENV['BUILD_NUMBER']}" if ENV['PRE_RELEASE']
+
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+  s.add_development_dependency 'rubocop', '~> 0.24', '>= 0.24.1'
+  s.add_development_dependency 'rake', '~> 10.4'
+  s.add_development_dependency 'yard', '~> 0.8'
+
+  s.add_runtime_dependency 'oily_png', '~> 1.2'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: web_image_compare
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rui Nunes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.24.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.24.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: oily_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: A tool to compare images base in web elements
+email: rui@brandwatch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/chunky_png/operations.rb
+- lib/web_image_compare.rb
+- lib/web_image_compare/version.rb
+- spec/images/example_image.png
+- spec/web_image_compare_spec.rb
+- web_image_compare.gemspec
+homepage: https://github.com/Rui-Pedro-Nunes/web-image-compare.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Web
+test_files:
+- spec/images/example_image.png
+- spec/web_image_compare_spec.rb
+has_rdoc: