Contents

# encoding: UTF-8
require 'rspec'
require_relative './diff/rmagick'

module Simulacrum
  # The Comparator class is responsible for comparing and handling
  # processing of screenshots and candidates
  class Comparator
    include RSpec::Core::Pending

    attr_reader :component, :diff

    def initialize(component)
      @component = component
      component.render
    end

    def test
      # If the component has a reference then we should diff the candidate
      # image against the reference
      if component.reference?
        # If there is a diff between the candidate and the reference then we
        # should save both the candidate and diff images and fail the test
        (pass?) ? pass : fail

      # Otherwise we should just write the captured candidate to disk, and mark
      # the spec as being pending until the user works out if the candidate is
      # OK by renaming candidate.png to reference.png
      else
        skip
      end
    end

    def diff
      @diff ||= Simulacrum::RMagicDiff.new(component.reference_path,
                                           component.candidate_path)
    end

    private

    def pass
      component.remove_candidate
      component.remove_diff
      true
    end

    def fail
      diff.save(component.diff_path)
      false
    end

    def skip
      nil
    end

    def pass?
      diff.delta <= component.delta_threshold
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
simulacrum-0.3.2	lib/simulacrum/comparator.rb
simulacrum-0.3.1	lib/simulacrum/comparator.rb
simulacrum-0.3.0	lib/simulacrum/comparator.rb