similatron 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ad680fcf560bab8fa96a85ecc6f5cecf7d32053c
+  data.tar.gz: f5eb8e425ffdf0118d4e54da4ffce28e5acbba35
+SHA512:
+  metadata.gz: 43f8ab420051ec7199ce5f678a17d3037e265b4c3f0f6b0dff6ab65bceed63d35645c284b63a9c4ae333cfb97ad17ecabd010f1c0b6dc9f4802fc5a3edaeb967
+  data.tar.gz: 52bc0875f0314d97f3de537fa28bba4a5bd8a3d080dc39cdcac29a8a095952083a2e5ab65113540d6baae740d2d08c9d90eb815aa84a3b5e92113125d59a2e75

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.vimrc

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,28 @@
+Style/Lambda:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Diego Guerra
+
+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,85 @@
+# Similatron
+
+The laziest way to test generated artifacts.
+
+`Similatron` compares files. It can make image, pdf, text or pure binary
+comparisons.
+
+It's designed to be used in tests, so:
+
+* If the files are different, it'll raise an exception
+* If the expected file doesn't yet exist, it'll copy the expected one over (so
+    you can build your tests post-hoc in one go)
+* It can create html/json reports after running, so you'll be able to inspect
+    differences in the actual files, and, when available, have access to
+    a file with the differences as computed.
+
+## Usage
+
+One of the simplest ways to use it is the following:
+
+```ruby
+
+after :all do
+  Similatron.complete
+end
+
+
+it "creates an image for an ugly face" do
+  expected = "spec/assets/expected_face.jpg"
+  actual = face_builder.ugly_face(:path => "tmp/ugly.jpg")
+
+  Similatron.compare(expected: expected, actual: actual)
+end
+
+```
+
+Depending on the files...
+
+* If the actual exists and is equal to the expected, the spec will pass.
+* If the expected face doesn't exist, `tmp/ugly.jpg` will be copied over, and
+    the spec will not fail.
+* Otherwise, the spec fails.
+
+Whenever the images are not equal, an html report is generated so you can
+check the reasons for the failure.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'similatron'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install similatron
+
+`Similatron` needs Imagemagick (to compare images), and a standard
+implementation of `diff`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/dgsuarez/similatron.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "similatron"
+
+# 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

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/lib/assets/report.html.erb

@@ -0,0 +1,37 @@
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+
+    <title>Similatron report</title>
+    <meta name="description" content="Similatron report">
+    <meta name="author" content="Similatron">
+  </head>
+
+  <body>
+    <p>
+      Did <%= comparisons.length %> checks with <%= failed_comparisons.length %> failures and <%= overwrite_comparisons.length %> new files.
+    </p>
+    <ul>
+    <% overwrite_comparisons.each do |comparison| %>
+      <li>
+        Original
+        <a href="<%= comparison.expected %>">Original</a> not found, copied
+        <a href="<%= comparison.actual %>">actual</a>.
+      </li>
+    <% end %>
+    </ul>
+
+    <ul>
+    <% failed_comparisons.each do |comparison| %>
+      <li>
+        Failed comparison:
+        Expected <a href="<%= comparison.expected %>">expected</a>
+        to equal <a href="<%= comparison.actual %>">actual</a>.
+        <% if comparison.diff %>
+          <a href="<%= comparison.diff %>">Diff</a>.
+        <% end %>
+      </li>
+    <% end %>
+    </ul>
+  </body>
+</html>

data/lib/similatron/binary_diff_comparison_engine.rb

@@ -0,0 +1,31 @@
+module Similatron
+  class BinaryDiffComparisonEngine < ComparisonEngine
+
+    def can_handle_mime?(_)
+      true
+    end
+
+    private
+
+    def command(expected, actual, _diff_path)
+      "#{executable_path} #{expected} #{actual}"
+    end
+
+    def default_executable_path
+      "diff"
+    end
+
+    def diff_extension
+      "notused"
+    end
+
+    def diff(_diff_path, _exec_result)
+      nil
+    end
+
+    def score(exec_result)
+      exec_result.status
+    end
+
+  end
+end

data/lib/similatron/comparison.rb

@@ -0,0 +1,46 @@
+module Similatron
+  class Comparison
+
+    attr_reader :expected, :actual, :diff, :score
+
+    def initialize(expected:, actual:, score:, diff: nil, overwrite: nil)
+      @expected = expected
+      @actual = actual
+      @diff = diff
+      @score = score
+      @overwrite = overwrite
+    end
+
+    def same?
+      @score.zero?
+    end
+
+    def overwrite?
+      @overwrite
+    end
+
+    def raise_when_different
+      return if same?
+
+      message_parts = [
+        "Found #{actual} different from #{expected}\n",
+        "Score: #{score}"
+      ]
+      message_parts << "\nDiff in #{diff}" if diff
+
+      raise StandardError, message_parts.join
+    end
+
+    def as_json
+      {
+        expected: expected,
+        actual: actual,
+        diff: diff,
+        score: score,
+        same: !!same?, # rubocop:disable Style/DoubleNegation
+        overwrite: !!overwrite? # rubocop:disable Style/DoubleNegation
+      }
+    end
+
+  end
+end

data/lib/similatron/comparison_engine.rb

@@ -0,0 +1,54 @@
+module Similatron
+  class ComparisonEngine
+    def initialize(executable_path: nil, diffs_path:)
+      @executable_path = executable_path || "diff"
+      @diffs_path = diffs_path
+    end
+
+    def compare(expected:, actual:)
+      diff_path = next_diff_path
+
+      command = command(expected, actual, diff_path)
+
+      exec_result = run(command)
+
+      Comparison.new(
+        expected: expected,
+        actual: actual,
+        score: score(exec_result),
+        diff: diff(diff_path, exec_result)
+      )
+    end
+
+    protected
+
+    attr_reader :diffs_path, :diff_index
+
+    def run(command)
+      exec_info = Open3.capture3(command)
+      Open3Result.new(*exec_info)
+    end
+
+    def next_diff_path
+      @diff_index ||= 0
+      @diff_index += 1
+
+      File.join(diffs_path, "diff_#{diff_index}.#{diff_extension}")
+    end
+
+    def executable_path
+      default_executable_path || @executable_path
+    end
+
+    class Open3Result
+      attr_reader :out, :err, :status
+
+      def initialize(out, err, status)
+        @out = out
+        @err = err
+        @status = status.exitstatus
+      end
+    end
+
+  end
+end

data/lib/similatron/diff_comparison_engine.rb

@@ -0,0 +1,39 @@
+module Similatron
+  class DiffComparisonEngine < ComparisonEngine
+
+    def can_handle_mime?(mime_type)
+      mime_type !~ /charset=binary/
+    end
+
+    private
+
+    def command(expected, actual, _diff_path)
+      "#{executable_path} #{expected} #{actual}"
+    end
+
+    def default_executable_path
+      "diff"
+    end
+
+    def diff_extension
+      "diff"
+    end
+
+    def diff(diff_path, exec_result)
+      if exec_result.status != 0
+        File.write(diff_path, exec_result.out)
+        diff_path
+      else # rubocop:disable Style/EmptyElse
+        nil
+      end
+    end
+
+    def score(exec_result)
+      return 0 if exec_result.status.zero?
+
+      lines = exec_result.out.split("\n")
+      lines.grep(/^>|</).size / 2.0
+    end
+
+  end
+end

data/lib/similatron/imagemagick_comparison_engine.rb

@@ -0,0 +1,37 @@
+module Similatron
+  class ImagemagickComparisonEngine < ComparisonEngine
+
+    def can_handle_mime?(mime_type)
+      [/image/, /application.pdf/].any? do |format|
+        mime_type =~ format
+      end
+    end
+
+    private
+
+    def default_executable_path
+      "compare"
+    end
+
+    def diff_extension
+      "jpg"
+    end
+
+    def command(expected, actual, diff_path)
+      "#{executable_path} -metric PSNR #{expected} #{actual} #{diff_path}"
+    end
+
+    def diff(diff_path, exec_result)
+      exec_result.status == 1 ? diff_path : nil
+    end
+
+    def score(exec_result)
+      if exec_result.status == 2
+        100
+      else
+        exec_result.err.to_i
+      end
+    end
+
+  end
+end

data/lib/similatron/run.rb

@@ -0,0 +1,109 @@
+module Similatron
+  class Run
+
+    attr_reader :comparisons
+
+    def start(base_path: "tmp")
+      run_id = SecureRandom.urlsafe_base64(8)
+      @run_path = File.join(base_path, "run_#{run_id}")
+
+      @engines = [
+        ImagemagickComparisonEngine.new(diffs_path: run_path),
+        DiffComparisonEngine.new(diffs_path: run_path),
+        BinaryDiffComparisonEngine.new(diffs_path: run_path)
+      ]
+
+      @comparisons = []
+      FileUtils.mkdir_p(run_path)
+    end
+
+    def complete
+      write_reports
+    end
+
+    def compare(expected:, actual:)
+      comparison = if File.exist?(expected)
+                     real_comparison(expected, actual)
+                   else
+                     copy_comparison(expected, actual)
+                   end
+      comparisons << comparison
+
+      comparison
+    end
+
+    def compare!(expected:, actual:)
+      comparison = compare(expected: expected, actual: actual)
+      comparison.raise_when_different
+    end
+
+    def summary
+      return "" if failed_comparisons.empty? && overwrite_comparisons.empty?
+      [
+        "Similatron report:",
+        "#{failed_comparisons.count} failures.",
+        "#{overwrite_comparisons.count} new files.",
+        "Report may be found in #{html_report_path}"
+      ].join("\n")
+    end
+
+    def json_report_path
+      File.join(run_path, "report.json")
+    end
+
+    def html_report_path
+      File.join(run_path, "report.html")
+    end
+
+    def failed_comparisons
+      comparisons.reject(&:same?)
+    end
+
+    def overwrite_comparisons
+      comparisons.select(&:overwrite?)
+    end
+
+    private
+
+    attr_reader :run_path, :engines
+
+    def copy_comparison(expected, actual)
+      FileUtils.cp(actual, expected)
+      Comparison.new(
+        overwrite: true,
+        expected: expected,
+        actual: actual,
+        score: 0
+      )
+    end
+
+    def best_engine(file)
+      mime_type = `file --mime -b #{file}`.chomp
+      engines.detect { |engine| engine.can_handle_mime?(mime_type) }
+    end
+
+    def real_comparison(expected, actual)
+      engine = best_engine(expected)
+
+      engine.compare(
+        expected: expected,
+        actual: actual
+      )
+    end
+
+    def to_json
+      comparisons.map(&:as_json).to_json
+    end
+
+    def to_html
+      template = ERB.new(File.read("lib/assets/report.html.erb"))
+      template.result(binding)
+    end
+
+    def write_reports
+      File.write(html_report_path, to_html)
+      File.write(json_report_path, to_json)
+    end
+
+  end
+end

data/lib/similatron/version.rb

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

data/lib/similatron.rb

@@ -0,0 +1,32 @@
+require "English"
+require 'securerandom'
+require 'open3'
+require 'json'
+require 'erb'
+
+require "similatron/version"
+require "similatron/comparison"
+require "similatron/comparison_engine"
+require "similatron/imagemagick_comparison_engine"
+require "similatron/diff_comparison_engine"
+require "similatron/binary_diff_comparison_engine"
+require "similatron/run"
+
+module Similatron
+  def self.compare(*args)
+    run.compare!(*args)
+  end
+
+  def self.complete
+    run.complete
+    puts run.summary
+  end
+
+  def self.run
+    @run ||= begin
+               run = Run.new
+               run.start
+               run
+             end
+  end
+end

data/similatron.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'similatron/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "similatron"
+  spec.version       = Similatron::VERSION
+  spec.authors       = ["Diego Guerra"]
+  spec.email         = ["diego.guerra.suarez@gmail.com"]
+
+  spec.summary       = 'Check image similarities'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: similatron
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Diego Guerra
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: 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'
+description: 
+email:
+- diego.guerra.suarez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/assets/report.html.erb
+- lib/similatron.rb
+- lib/similatron/binary_diff_comparison_engine.rb
+- lib/similatron/comparison.rb
+- lib/similatron/comparison_engine.rb
+- lib/similatron/diff_comparison_engine.rb
+- lib/similatron/imagemagick_comparison_engine.rb
+- lib/similatron/run.rb
+- lib/similatron/version.rb
+- similatron.gemspec
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Check image similarities
+test_files: []