no-regrets 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19b04a4a36f665feef72458c32705b3289db89b1
+  data.tar.gz: 45212b45681d1fd064939a8c5dc492e497226b16
+SHA512:
+  metadata.gz: 0ca51809da3a62084f29266f24a24afe086da2a3c23cefeb005ad42f170dba05be91f895248c7fb6e5dfa0e5eac7342cb7369b483216ce024334a2bb50abfff6
+  data.tar.gz: 2a9f286ae537366e3dc125ea90a982de404ce51d8c9e667e294be50878b6e064798c6d34ac3d6dbcbbb907e58de642f644152abfb57ae03cbef5a4dc73fe739a

data/lib/no_regrets/image_diff.rb

@@ -0,0 +1,27 @@
+require 'chunky_png'
+
+class NoRegrets
+  class ImageDiff
+
+    def self.generate_diff(old_screenshot_path, new_screenshot_path, diff_path)
+      images = [
+        ChunkyPNG::Image.from_file(old_screenshot_path),
+        ChunkyPNG::Image.from_file(new_screenshot_path)
+      ]
+
+      diff = []
+
+      images.first.height.times do |y|
+        images.first.row(y).each_with_index do |pixel, x|
+          diff << [x,y] unless pixel == images.last[x,y]
+        end
+      end
+
+      x, y = diff.map{ |xy| xy[0] }, diff.map{ |xy| xy[1] }
+
+      images.last.rect(x.min, y.min, x.max, y.max, ChunkyPNG::Color.rgb(255,0,0))
+      images.last.save(diff_path)
+    end
+  end
+
+end

data/lib/no_regrets.rb

@@ -0,0 +1,96 @@
+require 'digest'
+require 'launchy'
+require_relative "no_regrets/image_diff"
+
+class NoRegrets
+
+  class ScreenshotMismatchError < StandardError
+  end
+
+  def self.check_screenshot_for_regressions(screenshot_name)
+    new(screenshot_name).check_screenshot_for_regressions
+  end
+
+  def check_screenshot_for_regressions
+    path = Capybara.current_session.save_screenshot("#{screenshot_name}.png")
+    sha1 = Digest::SHA1.hexdigest(File.read(path))
+    if !File.exists?(cache_file_path(sha1))
+      FileUtils.mkdir_p(cache_dir)
+      FileUtils.cp(path, cache_file_path(sha1))
+    end
+
+    if old_sha1 && old_sha1 != sha1
+      raise_error(path, sha1)
+    end
+
+    FileUtils.rm(path)
+    if !fingerprints[screenshot_name]
+      puts "Saving a new screenshot fingerprint for \"#{screenshot_name}\" in #{fingerprint_file_path}"
+    end
+    fingerprints[screenshot_name] = sha1
+    File.write(fingerprint_file_path, fingerprints.to_yaml)
+  end
+
+  def initialize(screenshot_name)
+    @screenshot_name = screenshot_name
+  end
+
+  private
+
+  attr_reader :screenshot_name
+
+  def fingerprints
+    @fingerprints ||= File.exists?(fingerprint_file_path) ? YAML.load(File.read(fingerprint_file_path)) : {}
+  end
+
+  def raise_error(new_screenshot_path, new_sha1)
+    error_message = <<~ERROR_MESSAGE
+      The screenshot \"#{screenshot_name}\" has changed.
+      You can view the new screenshot by opening #{new_screenshot_path}.
+
+      If this was expected, you can remove this line:
+      #{screenshot_name}: #{fingerprints[screenshot_name]}
+      from the file #{fingerprint_file_path}, run this test again, and commit the result.
+    ERROR_MESSAGE
+
+    if diffable?(new_sha1)
+      error_message << "You can see the diff"
+
+      diff_path = "#{diff_dir}/#{screenshot_name}.png"
+      FileUtils.mkdir_p(diff_dir)
+      ImageDiff.generate_diff(
+        cache_file_path(old_sha1),
+        cache_file_path(new_sha1),
+        diff_path
+      )
+      Launchy.open(diff_path)
+    end
+
+    raise ScreenshotMismatchError, error_message
+  end
+
+  def old_sha1
+    fingerprints[screenshot_name]
+  end
+
+  def fingerprint_file_path
+    'spec/support/no_regret_fingerprints.yml'
+  end
+
+  def diffable?(new_sha1)
+    File.exists?(cache_file_path(old_sha1)) && File.exists?(cache_file_path(new_sha1))
+  end
+
+  def cache_file_path(sha1)
+    "#{cache_dir}/#{sha1}.png"
+  end
+
+  def cache_dir
+    "#{Capybara.save_path.to_s}/no_regrets"
+  end
+
+  def diff_dir
+    "#{cache_dir}/diffs"
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: no-regrets
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Victor Mours
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: victor@ahaoho.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/no_regrets.rb
+- lib/no_regrets/image_diff.rb
+homepage: 
+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.5
+signing_key: 
+specification_version: 4
+summary: Visual regression testing for Capybara specs
+test_files: []
+has_rdoc: