image_comparable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7dd1c3491049e7d44930c81867a598fa8cf65b6
+  data.tar.gz: d153baef87a76b6f7c3aa8f100d6c5e35bea355d
+SHA512:
+  metadata.gz: fdbbbfdee14b71dcd0b43697e704e85da09ee5f7e5b190ca4c00078d85faa4a7a9def84ab37cc2b4e693572779db60fd31847870714120e10624bf4a718ace8f
+  data.tar.gz: 2c7877a5f4b8de25ef895a647bfb0fc8ccedaa2b99b6ece09dc1d2a2ea2fc95abccb846760af6e47c752e3a15e7b712caf65931ec689956802ecc9de585c92ab

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+lib/diff_images/*
+coverage
+*.png

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at wellington.avelino@outlook.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in image_comparable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Wellington Avelino
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# ImageComparable
+
+
+Image comparable it's a gem inspired by [NAKAL](https://github.com/rajdeepv/nakal)
+
+The principal idea is providing an easy way to develop your visual regression tests,
+ Image Comparable 
+ use [Chunky::PNG](https://github.com/wvanbergen/chunky_png) a pure ruby lib to read and write images.
+
+
+# Features
+
+Compare pixel by pixel and generate an image_diff with the modifications
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'image_comparable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install image_comparable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/image_comparable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "image_comparable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/image_comparable.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'image_comparable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "image_comparable"
+  spec.version       = ImageComparable::VERSION
+  spec.authors       = ["Wellington Avelino"]
+  spec.email         = ["wellington.avelino@outlook.com"]
+
+  spec.summary       = %q{A gem to make visual test}
+  spec.description   = %q{An easy way to create your visual regression tests}
+  spec.homepage      = "https://github.com/wellavelino/image-comparable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "chunky_png", ">= 1.3.8"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 1.14"
+end

data/lib/image_comparable.rb

@@ -0,0 +1,21 @@
+require 'fileutils'
+
+require_relative "#{File.dirname(__FILE__)}/image_comparable/version"
+require_relative "#{File.dirname(__FILE__)}/image_comparable/matcher"
+require_relative "#{File.dirname(__FILE__)}/image_comparable/image"
+require_relative "#{File.dirname(__FILE__)}/image_comparable/image_diff"
+
+module ImageComparable
+  include ChunkyPNG::Color
+
+  class SizesMismatchError < StandardError
+  end
+
+  def self.execute(baseline, current_screen, acceptant_criteria)
+    return if baseline.nil?
+    return if current_screen.nil?
+    return if acceptant_criteria.nil?
+
+    Matcher.new.compare_screens(baseline, current_screen, acceptant_criteria)
+  end
+end

data/lib/image_comparable/image.rb

@@ -0,0 +1,18 @@
+module ImageComparable
+  class Image
+
+    attr_accessor :image
+
+    def initialize(path)
+      @image = ChunkyPNG::Image.from_file(path)
+    end
+
+    def size_match?(compare)
+      @image.height == compare.image.height &&
+          @image.width == compare.image.width
+    end
+
+    def delete_image!(image)
+    end
+  end
+end

data/lib/image_comparable/image_diff.rb

@@ -0,0 +1,49 @@
+class ImageDiff
+
+  def initialize(baseline, screenshot, acceptant_criteria)
+    @baseline   = baseline.image
+    @screenshot = screenshot.image
+
+    @diff = []
+    @baseline.height.times do |y|
+      @baseline.row(y).each_with_index do |pixel, x|
+        @diff << [x, y] unless pixel == @screenshot[x, y]
+      end
+    end
+
+    @x                  = @diff.map { |xy| xy[0] }
+    @y                  = @diff.map { |xy| xy[1] }
+    @acceptant_criteria = acceptant_criteria
+
+  end
+
+  def save
+    Dir.mkdir(path) unless Dir.exist?(path)
+
+    draw.save(File.join(path, file_name))
+    calculate_score(@diff, @screenshot, @acceptant_criteria)
+  end
+
+  def calculate_score(diff, screenshot, acceptant_criteria)
+    raise 'Acceptant criteria cannot be null' if acceptant_criteria.nil?
+
+    acceptant_criteria = acceptant_criteria.to_f
+    result             = (diff.length.to_f / screenshot.pixels.length) * 100
+
+    return unless result > acceptant_criteria
+    raise "The score result: #{result}%, is minor then " \
+            "acceptant_criteria: #{acceptant_criteria}%"
+  end
+
+  def draw
+    @screenshot.rect(@x.min, @y.min, @x.max, @y.max, ChunkyPNG::Color::BLACK)
+  end
+
+  def path
+    @path ||= File.join(FileUtils.pwd, 'diff_images')
+  end
+
+  def file_name
+    "#{Time.now.strftime('%Y%m%d')}_diff.png"
+  end
+end

data/lib/image_comparable/matcher.rb

@@ -0,0 +1,15 @@
+require 'chunky_png'
+
+class Matcher
+
+  def compare_screens(baseline_path, screenshot_path, acceptant_criteria)
+    baseline = ImageComparable::Image.new(baseline_path)
+    screenshot = ImageComparable::Image.new(screenshot_path)
+
+    raise 'cannot compare images with different sizes' unless
+        baseline.size_match? screenshot
+
+    ImageDiff.new(baseline, screenshot, acceptant_criteria).save
+  end
+
+end

data/lib/image_comparable/version.rb

@@ -0,0 +1,3 @@
+module ImageComparable
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: image_comparable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wellington Avelino
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+description: An easy way to create your visual regression tests
+email:
+- wellington.avelino@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- image_comparable.gemspec
+- lib/image_comparable.rb
+- lib/image_comparable/image.rb
+- lib/image_comparable/image_diff.rb
+- lib/image_comparable/matcher.rb
+- lib/image_comparable/version.rb
+homepage: https://github.com/wellavelino/image-comparable
+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.5.2
+signing_key: 
+specification_version: 4
+summary: A gem to make visual test
+test_files: []