heimdallr-viz 0.0.1.b1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17dda904ced17916217050c50dbd54808d270234
+  data.tar.gz: 6bf55f94803f473d609bf4796f5641b0f3f3d48e
+SHA512:
+  metadata.gz: c2e7d711ca954d142d1b9e351749f9605ec0f362ce95b273379c53bf904d13e81a6b0b84436c9c6fb37589ce2de3b5fdd3a07d68ad16e06061e288a069d3f9a1
+  data.tar.gz: eebf1d230e48e90fce259d0db5166c58dfaa7509aa323e546c51c2659d04adc21540109cc565eefa1cca85ee032c4ad94eed37993c419de23c5b0106231df187

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  Exclude:
+    - 'Rakefile'
+    - 'Guardfile'
+    - '*.gemspec'
+    - '**/*.rake'
+  
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 2.2
+  
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    heimdallr-viz (0.0.1.b1)
+      rmagick (~> 2.16.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    bundler-audit (0.6.0)
+      bundler (~> 1.2)
+      thor (~> 0.18)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.1)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    require_all (2.0.0)
+    rmagick (2.16.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    terminal-notifier (2.0.0)
+    terminal-notifier-guard (1.7.0)
+    thor (0.20.0)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  bundler-audit (~> 0.6.0)
+  guard-rspec (~> 4.7, >= 4.7.3)
+  heimdallr-viz!
+  pry (~> 0.11)
+  rake (~> 10.0)
+  require_all (~> 2.0, >= 2.0.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.58.2)
+  terminal-notifier (~> 2.0, >= 2.0.0)
+  terminal-notifier-guard (~> 1.6, >= 1.6.0)
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,25 @@
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Sarah
+
+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,51 @@
+# heimdallr-viz
+
+[![Build Status](https://travis-ci.org/araneforseti/heimdallr-viz.svg?branch=master)](https://travis-ci.org/araneforseti/heimdallr-viz)
+
+Ruby gem for aiding visual regression by taking partial screenshots of components using selenium selectors and comparing them to images of the expected look
+
+## Requirements
+
+* ImageMagick v6
+
+## Usage
+
+Create heimdallr with the selenium driver so it can "see" the page you navigate to, then pass it the information for the elements it is checking on the page.
+
+Example:
+
+```ruby
+@heimdallr = HeimdallrViz::Viz.new driver: @browser
+page_elements = [
+  {
+    element_name: 'chart',
+    element_selector: { id: '#chart' },
+    prior_image: 'images/chart.png'
+  },
+  {
+    element_name: 'tab',
+    element_selector: { xpath: '//*[@id="tab"]' },
+    prior_image: 'images/ship.png'
+  },
+  {
+    element_name: 'logo',
+    element_selector: { class: '#logo' },
+    prior_image: 'images/logo.png'
+  }
+]
+result = @heimdallr.check_visuals(page_elements)
+```
+
+Heimdallr will output images used for comparison to `heimdallr-report`, which can be changed:
+
+```ruby
+@heimdallr.output_dir = 'new directory'
+```
+
+## Contributing
+
+Contributions welcome; simply open a PR with the improvement you want to make!
+
+Find an issue not yet logged? Raise something on the github repo!
+
+Curious about where this project is going? Check out the [backlog](https://trello.com/b/g5AbHzjh/heimdallr-viz)!

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/changelog.txt

@@ -0,0 +1,5 @@
+0.0.1.b1
+
+Creating features:
+  - Comparing specified image to a component based on selenium selector
+  - Outputs images used for comparison in directory to enable debugging

data/heimdallr-viz.gemspec

@@ -0,0 +1,44 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heimdallr-viz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'heimdallr-viz'
+  spec.version       = HeimdallrViz::VERSION
+  spec.authors       = ['arane']
+  spec.email         = ['arane9@gmail.com']
+
+  spec.summary       = 'Tool to help visual regression'
+  spec.description   = 'Visual regression framework enabling ruby-selenium based projects to use their page objects to capture visual regression'
+  spec.homepage      = 'https://github.com/araneforseti/heimdallr-viz'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  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_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'bundler-audit', '~>0.6.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7', '>= 4.7.3'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'require_all', '~> 2.0', '>= 2.0.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.58.2'
+  spec.add_development_dependency 'terminal-notifier', '~> 2.0', '>= 2.0.0'
+  spec.add_development_dependency 'terminal-notifier-guard', '~> 1.6', '>= 1.6.0'
+
+  spec.add_runtime_dependency 'rmagick', '~> 2.16.0', '>= 2.16.0'
+end

data/lib/heimdallr-viz.rb

@@ -0,0 +1,89 @@
+require 'pry'
+require 'rmagick'
+# Framework for visual regression
+module HeimdallrViz
+  # Class for creating the visual shots
+  class Viz
+    attr_accessor :driver
+    attr_accessor :output_dir
+    attr_accessor :working_dir
+
+    def initialize(driver:)
+      self.driver = driver
+      self.output_dir = 'heimdallr-report'
+      Dir.mkdir output_dir unless File.exist? output_dir
+    end
+
+    def check_visuals(elements)
+      all_same = true
+      elements.each do |element|
+        all_same = false unless check_visual(element)
+      end
+      all_same
+    end
+
+    def check_visual(element_name:, element_selector:, prior_image:)
+      self.working_dir = "#{output_dir}/#{element_name}"
+      Dir.mkdir working_dir unless File.exist? working_dir
+      element = driver.find_element(element_selector)
+      screenshot = take_screenshot
+      new_image = component_image(element, screenshot)
+      unless same_image(new_image, prior_image).zero?
+        create_comparison_map(new_image, prior_image)
+        return false
+      end
+      true
+    end
+
+    def take_screenshot
+      screenshot_file = "#{working_dir}/screen.png"
+      driver.save_screenshot(screenshot_file)
+      Magick::Image.read(screenshot_file)[0]
+    end
+
+    def component_image(element, image)
+      width = element.size.width * 2
+      height = element.size.height * 2
+      location = element.location
+      x = location.x * 2
+      y = location.y * 2
+
+      highlight(image: image, x: x, y: y, width: width, height: height)
+      crop_image(image: image, x: x, y: y, width: width, height: height)
+    end
+
+    def crop_image(image:, x:, y:, width:, height:)
+      cropped = image.crop(x, y, width, height)
+      cropped.write("#{working_dir}/actual.png")
+      "#{working_dir}/actual.png"
+    end
+
+    def highlight(image:, x:, y:, width:, height:)
+      area = Magick::Image.new(width, height) do
+        self.background_color = 'yellow'
+      end
+      # area.alpha(Magick::ActivateAlphaChannel)
+      area.opacity = 0.7 * Magick::QuantumRange
+      # highlighted = image.composite(area, x, y, Magick::SoftLightCompositeOp)
+      highlighted = image.dissolve(area, 0.9, 1.0, x, y)
+      highlighted.write("#{working_dir}/areas_of_interest.png")
+    end
+
+    def same_image(new_image_file, prior_image_file)
+      new_image = Magick::Image.read(new_image_file)
+      prior_image = Magick::Image.read(prior_image_file)
+      prior_image[0].write("#{working_dir}/expected.png")
+      new_image <=> prior_image
+    end
+
+    def create_comparison_map(new_image_file, prior_image_file)
+      new_image = Magick::Image.read(new_image_file)[0]
+      prior_image = Magick::Image.read(prior_image_file)[0]
+      difference = prior_image.composite(new_image,
+                                         0,
+                                         0,
+                                         Magick::DifferenceCompositeOp)
+      difference.write("#{working_dir}/difference.png")
+    end
+  end
+end

data/lib/heimdallr-viz/comparitor.rb

@@ -0,0 +1,61 @@
+require 'rmagick'
+
+module HeimdallrViz
+  class Comparitor
+    def compare(expected:, actual:)
+      expected_image = read_image expected
+      actual_image = read_image actual
+      (expected_image <=> actual_image).zero?
+    end
+
+    def compare_with_pixel_threshold(expected:,
+                                     actual:,
+                                     threshold:)
+      result = difference(expected, actual)
+      result < threshold
+    end
+
+    def compare_with_percent_threshold(expected:,
+                                       actual:,
+                                       threshold:)
+      result = percent_diff(expected, actual)
+      result < threshold
+    end
+
+    def difference(expected, actual)
+      expected_image = read_image expected
+      actual_image = read_image actual
+      expected_pixels = compute_pixels expected_image
+      actual_pixels = compute_pixels actual_image
+      result = calculate_difference(expected_pixels, actual_pixels)
+      result.size
+    end
+
+    def percent_diff(expected_file, actual_file)
+      diff = difference(expected_file, actual_file)
+      expected_pixels = (read_image expected_file).export_pixels.size
+      ((100.0 * diff) / expected_pixels).round
+    end
+
+    def read_image(file)
+      Magick::Image.read(file)[0]
+    end
+
+    def compute_pixels(image)
+      result = {}
+      pixels = image.export_pixels
+      pixels.each_with_index do |p, index|
+        result[index] = p
+      end
+      result
+    end
+
+    def calculate_difference(expected, actual)
+      diff = {}
+      expected.each do |index, pixel|
+        diff[index] = pixel unless actual[index] == pixel
+      end
+      diff
+    end
+  end
+end

data/lib/heimdallr-viz/version.rb

@@ -0,0 +1,3 @@
+module HeimdallrViz
+  VERSION = '0.0.1.b1'.freeze
+end

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: heimdallr-viz
+version: !ruby/object:Gem::Version
+  version: 0.0.1.b1
+platform: ruby
+authors:
+- arane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !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: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.2
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+description: Visual regression framework enabling ruby-selenium based projects to
+  use their page objects to capture visual regression
+email:
+- arane9@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- changelog.txt
+- heimdallr-viz.gemspec
+- lib/heimdallr-viz.rb
+- lib/heimdallr-viz/comparitor.rb
+- lib/heimdallr-viz/version.rb
+homepage: https://github.com/araneforseti/heimdallr-viz
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Tool to help visual regression
+test_files: []