green_onion.rb

require "green_onion/version"
require "green_onion/screenshot"
require "green_onion/compare"
require "green_onion/configuration"
require "green_onion/errors"
require "green_onion/browser"
require "rainbow"

module GreenOnion
  class << self

    attr_reader :compare, :screenshot

    # Pass configure block to set Configuration object
    def configure
      yield configuration
    end

    def configuration
      @configuration ||= Configuration.new
    end

    # Bring the Screenshot and Compare classes together to create a skin
    def skin(url)
      @screenshot = Screenshot.new(
        :dir => @configuration.skins_dir,
        :skin_name => @configuration.skin_name,
        :browser => @configuration.browser
      )
      @compare = Compare.new

      @screenshot.test_screenshot(url)
    end

    # Finds the percentage of change between skins
    # Threshold can be set in configuration, or as an argument itself, and can be specific to an instance
    def skin_percentage(url, threshold=@configuration.threshold)
      raise Errors::ThresholdOutOfRange.new "The threshold need to be a number between 1 and 100" if threshold > 100
      skin(url)
      skin_picker(url, { :percentage => true }, threshold)
    end

    # Creates a diffed screenshot between skins
    def skin_visual(url)
      skin(url)
      skin_picker(url, { :visual => true })
    end

    # Creates a diffed screenshot between skins AND prints percentage changed
    def skin_visual_and_percentage(url, threshold=@configuration.threshold)
      raise Errors::ThresholdOutOfRange.new "The threshold need to be a number between 1 and 100" if threshold > 100
      skin(url)
      skin_picker(url, { :percentage => true, :visual => true }, threshold)
    end

    def skin_picker(url, type, threshold=100)
      if(@screenshot.paths_hash.length > 1)
        puts "\n" + url.color(:cyan)
        if type[:percentage]
          @compare.percentage_diff(@screenshot.paths_hash[:original], @screenshot.paths_hash[:fresh])
          threshold_alert(@compare.percentage_changed, threshold)
        end
        if type[:visual]
          @compare.visual_diff(@screenshot.paths_hash[:original], @screenshot.paths_hash[:fresh])
        end
      else
        puts "\n#{url}".color(:cyan) + " has been saved to #{@screenshot.paths_hash[:original]}".color(:yellow)
      end
    end

    # This is used in skin_percentage to raise error if a set of skins are ok or not
    def threshold_alert(actual, threshold)
      if actual > threshold
        abort "#{actual - threshold}% above threshold set @ #{threshold}%".color(:red) + 
        "\npixels changed (%):     #{@compare.percentage_changed}%" +
        "\npixels changed/total:  #{@compare.changed_px}/#{@compare.total_px}"
      else
        puts "pixels changed/total:  #{@compare.changed_px}/#{@compare.total_px}"
      end
    end

  end
end