ojo 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1507dfd7d37a94f8869aedfad8a794085050ded5
-  data.tar.gz: d76df5592c3427e336c82ac0aa7bd78640bc2a14
+  metadata.gz: 9fb122efa0d57d0f24c768e2ddd60877062746bf
+  data.tar.gz: 372a6fdbe461d6aa7b519bf4bbd4182a2df03e4f
 SHA512:
-  metadata.gz: 64b39c3507560aebbb5af6da31ae2c59e7f912b531ce55bb47c740ba0bacc833583aaeb481ff4532f03ab5ad3e994a66dbb084e495abb631e3c410a18bdfa767
-  data.tar.gz: acdf69ac9f811cfa2ab18ed741c2d967d14162776797f02b55e8dd786b9fc6584d83975e07b0fa6b1d03ad66ce3c665a2e8ce5f8190e6b5125f070f47832dba8
+  metadata.gz: 336ea819a2118e57a750a404a8ed0256aaa8c5c1c3970d7c958be4d3cc065e1e42c3518294472fe92686aaf68046949d277215d8cc772b81393a58fabd337ca0
+  data.tar.gz: b63f2c1b6cbcb0ead4b42404f1411839963d88ab5be0e4cf18d161c02b8a2814813a4e7050782091903010f38c8a8068a134fb5257d07cf2a44986585b5c669c

data/.gitignore

@@ -14,3 +14,4 @@
 mkmf.log
 
 /test/test_app/tmp
+/test/test_app/log

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.2
+ruby-2.1.5

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
-  - "2.1.2"
+  - "2.1.5"
+addons:
+  code_climate:
+    repo_token: f0b4c444b697cf8dd7fb56fe8f02fda41af6699511ca954e4c51a9ba33163abb

data/Gemfile

@@ -12,3 +12,7 @@ gem 'poltergeist'
 gem 'capybara'
 gem 'ae_page_objects', '1.3.0'
 gem 'sqlite3'
+
+group :test do
+  gem 'codeclimate-test-reporter', require: nil
+end

data/README.md

@@ -4,6 +4,7 @@ Ojo is not fancy. it just does a simple comparison of two sets of screenshots. t
 
 [![Build Status](https://travis-ci.org/QuantumGeordie/ojo.svg)](https://travis-ci.org/QuantumGeordie/ojo)
 [![Code Climate](https://codeclimate.com/github/QuantumGeordie/ojo/badges/gpa.svg)](https://codeclimate.com/github/QuantumGeordie/ojo)
+[![Test Coverage](https://codeclimate.com/github/QuantumGeordie/ojo/badges/coverage.svg)](https://codeclimate.com/github/QuantumGeordie/ojo)
 
 ## Installation
 
@@ -25,7 +26,9 @@ Or install it yourself as:
 
 in a rails initializer do something like this to tell `Ojo` where the files to compare are.
 
-`Ojo.location = '/path/to/screenshots'`
+    Ojo.configure do |config|
+      config.location = '/path/to/screenshots'
+    end
 
 ### Screenshotter
 

data/lib/ojo.rb

@@ -1,13 +1,17 @@
+require 'collimator'
+
 require 'ojo/rails/engine' if defined?(Rails)
 require 'ojo/version'
 require 'ojo/comparison'
 require 'ojo/locations'
 require 'ojo/output'
 require 'ojo/screenshot'
-
-require 'collimator'
+require 'ojo/configuration'
+require 'ojo/file_sizer'
+require 'ojo/image_magician'
+require 'ojo/data_sets'
+require 'ojo/manager'
 
 module Ojo
   include Collimator
-
 end

data/lib/ojo/comparison.rb

@@ -1,88 +1,66 @@
 module Ojo
-  require 'open4'
-  require 'fileutils'
+  class Ojo
+    def compare(branch_1, branch_2)
+      all_files = compile_file_lists(get_branch_files(branch_1), get_branch_files(branch_2))
 
-  def self.compare(branch_1, branch_2)
-    all_files = compile_file_lists(get_branch_files(branch_1), get_branch_files(branch_2))
+      FileUtils.mkdir_p(File.join(::Ojo.configuration.location, 'diff'))
 
-    FileUtils.mkdir_p(File.join(self.location, 'diff'))
+      all_same = true
+      results = { :location => ::Ojo.configuration.location, :branch_1 => branch_1, :branch_2 => branch_2, :results => {} }
 
-    all_same = true
-    results = { :location => self.location, :branch_1 => branch_1, :branch_2 => branch_2, :results => {} }
+      ::Ojo::ProgressBar.start({:min => 0, :max => all_files.count, :method => :percent, :step_size => 1})
 
-    ProgressBar.start({:min => 0, :max => all_files.count, :method => :percent, :step_size => 1})
+      all_files.each do |file|
+        diff_file = File.join(::Ojo.configuration.location, 'diff', File.basename(file))
 
-    all_files.each do |file|
-      diff_file = File.join(self.location, 'diff', File.basename(file))
+        file_1 = make_comparable_filename(branch_1, file)
+        file_2 = make_comparable_filename(branch_2, file)
 
-      file_1 = File.join(location, branch_1, file)
-      file_2 = File.join(location, branch_2, file)
+        this_same = compare_one_set(file_1, file_2, diff_file)
+        results[:results][file] = { :same => this_same, :file_1 => file_1, :file_2 => file_2 }
+        all_same = all_same && (this_same != false)
 
-      file_1 = nil unless File.exist?(file_1)
-      file_2 = nil unless File.exist?(file_2)
+        File.delete(diff_file) if this_same
 
-      this_same = compare_one_set(file_1, file_2, diff_file)
-      results[:results][file] = { :same => this_same, :file_1 => file_1, :file_2 => file_2 }
-      all_same = all_same && (this_same != false)
+        ::Ojo::ProgressBar.increment
+      end
 
-      File.delete(diff_file) if this_same
-
-      ProgressBar.increment
+      ::Ojo::ProgressBar.complete
+      [all_same, results]
     end
 
-    ProgressBar.complete
-    [all_same, results]
-  end
-
-  private
+    private
 
-  def self.compare_one_set(file_1, file_2, diff_file)
-    same = nil
-    if file_1 && file_2
-      comparison_results = run_comparison(file_1, file_2, 'ae', '2%', diff_file)
-      same = unpack_comparison_results(comparison_results)
+    def make_comparable_filename(branch, file_base)
+      name = File.join(::Ojo.configuration.location, branch, file_base)
+      name = nil unless File.exist?(name)
+      name
     end
-    same
-  end
-
-  def self.get_branch_files(branch_name)
-    Dir[File.join(self.location, branch_name, '*.png')].map{ |f| File.basename(f) }
-  end
-
-  def self.compile_file_lists(files_1, files_2)
-    all_files = files_1.dup
-    all_files + files_2.select{ |f2| !files_1.include?(f2) }
-  end
-
-  def self.unpack_comparison_results(packed)
-    return false if packed.include?('image widths or heights differ')
 
-    outputs = packed.split(/\n/)
+    def compare_one_set(file_1, file_2, diff_file)
+      same = nil
+      if file_1 && file_2
+        ::Ojo::FileSizer.new.make_files_same_size(file_1, file_2)
 
-    outputs.map! do |o|
-      o.strip if o.strip.start_with?('red', 'green', 'blue', 'alpha', 'all')
+        same = compare_files(file_1, file_2, ::Ojo.configuration.metric, ::Ojo.configuration.fuzz, diff_file)
+      end
+      same
     end
-    outputs.compact!
 
-    same = true
-
-    outputs.each do |o|
-      parts = o.split(' ')
-      same = same && parts[1].to_f == 0
+    def get_branch_files(branch_name)
+      Dir[File.join(::Ojo.configuration.location, branch_name, '*.png')].map{ |f| File.basename(f) }
     end
 
-    return same
-  end
+    def compile_file_lists(files_1, files_2)
+      all_files = files_1.dup
+      all_files + files_2.select{ |f2| !files_1.include?(f2) }
+    end
 
-  def self.run_comparison(file_1, file_2, metric, fuzz_factor, resulting_file)
-    imagemagick_command = "compare -verbose -metric #{metric} -fuzz #{fuzz_factor} #{file_1} #{file_2} #{resulting_file}"
+    def compare_files(file_1, file_2, metric, fuzz_factor, resulting_file)
+      im = "compare -verbose -metric #{metric} -fuzz #{fuzz_factor} #{file_1} #{file_2} #{resulting_file}"
+      raw_result = ::Ojo::ImageMagician.new.make_magic(im)
 
-    output = nil
-    status = Open4::popen4(imagemagick_command) do |pid, stdin, stdout, stderr|
-      output = stderr.read
+      ::Ojo::ImageMagician.new.unpack_comparison_result raw_result
     end
-
-    output
   end
-
 end

data/lib/ojo/configuration.rb

@@ -0,0 +1,22 @@
+module Ojo
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  class Configuration
+    attr_accessor :fuzz
+    attr_accessor :location
+    attr_accessor :metric
+
+    def initialize
+      @location  = nil
+      @fuzz      = '2%'
+      @metric    = 'ae'
+    end
+  end
+end

data/lib/ojo/data_sets.rb

@@ -0,0 +1,11 @@
+module Ojo
+  class DataSets
+    def sets_available
+      data_sets = []
+      if ::Ojo.configuration.location
+        data_sets = Dir[File.join(::Ojo.configuration.location, '*')].select{ |d| File.directory?(d) && File.basename(d) != 'diff' }.map{ |d| File.basename(d) }.sort
+      end
+      data_sets
+    end
+  end
+end

data/lib/ojo/file_sizer.rb

@@ -0,0 +1,52 @@
+module Ojo
+  class FileSizer
+    def make_files_same_size(file_1, file_2)
+      dim_1 = get_file_dimensions(file_1)
+      dim_2 = get_file_dimensions(file_2)
+
+      unless dim_1 == dim_2
+        x, y = max_dimensions(dim_1, dim_2)
+        add_extra_to_file x, y, file_1
+        add_extra_to_file x, y, file_2
+      end
+    end
+
+    private
+
+    def get_file_dimensions(file)
+      im = "identify -format '%[fx:w]x%[fx:h]' #{file}"
+
+      output = nil
+      status = Open4::popen4(im) do |pid, stdin, stdout, stderr|
+        output = stdout.read
+      end
+      raise "problem getting dimensions of #{file}" unless status.success?
+      output.chomp
+    end
+
+    def add_extra_to_file(x, y, filename)
+      basename = File.basename(filename, '.*')
+      temp_filename = File.join(File.dirname(filename), "#{basename}_tmp.png")
+      make_canvas x, y, temp_filename
+
+      im = "convert #{temp_filename} #{filename} -composite #{temp_filename}"
+      ::Ojo::ImageMagician.new.make_magic(im)
+
+      FileUtils.mv(temp_filename, filename)
+    end
+
+    def max_dimensions(dim_1, dim_2)
+      x1, y1 = dim_1.split('x')
+      x2, y2 = dim_2.split('x')
+
+      x = [x1, x2].max
+      y = [y1, y2].max
+      [x, y]
+    end
+
+    def make_canvas(x, y, filename)
+      im = "convert -size #{x}x#{y} canvas:yellow #{filename}"
+      ::Ojo::ImageMagician.new.make_magic(im)
+    end
+  end
+end

data/lib/ojo/image_magician.rb

@@ -0,0 +1,40 @@
+module Ojo
+  class ImageMagician
+    def make_magic(command_string)
+      output = nil
+      status = Open4::popen4(command_string) do |pid, stdin, stdout, stderr|
+        output = stderr.read
+      end
+      output
+    end
+
+    def unpack_comparison_result(packed)
+      return false if packed.include?('image widths or heights differ')
+
+      color_values = get_color_values(packed)
+
+      same = true
+      color_values.each_pair do |color, value|
+        same = same && value.to_f == 0
+      end
+
+      return same
+    end
+
+    private
+
+    def get_color_values(raw)
+      # raw looks like
+      # "/Users/geordie/src/gems/ojo/tmp/branch_1/test_one.png PNG 200x200 200x200+0+0 16-bit sRGB 1.04KB 0.000u 0:00.000\n/Users/geordie/src/gems/ojo/tmp/branch_2/test_one.png PNG 200x200 200x200+0+0 16-bit sRGB 1.05KB 0.000u 0:00.000\nImage: /Users/geordie/src/gems/ojo/tmp/branch_1/test_one.png\n  Channel distortion: AE\n    red: 944\n    green: 944\n    blue: 944\n    all: 944\n/Users/geordie/src/gems/ojo/tmp/branch_1/test_one.png=>/Users/geordie/src/gems/ojo/tmp/diff/test_one.png PNG 200x200 200x200+0+0 16-bit sRGB 6c 1.18KB 0.010u 0:00.000\n"
+      outputs = raw.split(/\n/).select { |o| o.strip.start_with?('red', 'green', 'blue', 'alpha', 'all') }
+
+      out_hash = {}
+      outputs.each do |line|
+        k, v = line.strip.split(':')
+        out_hash[k.to_sym] = v.strip
+      end
+
+      out_hash
+    end
+  end
+end

data/lib/ojo/locations.rb

@@ -1,20 +1,11 @@
 module Ojo
-  @location = nil
-
   def self.location=(location)
-    @location = location
+    ::Ojo.configure unless ::Ojo.configuration
+    ::Ojo.configuration.location = location
   end
 
   def self.location
-    @location
-  end
-
-  def self.get_data_sets_available
-    data_sets = []
-    if @location
-      data_sets = Dir[File.join(location, '*')].select{ |d| File.directory?(d) && File.basename(d) != 'diff' }.map{ |d| File.basename(d) }
-    end
-    data_sets
+    ::Ojo.configuration.location
   end
 
   def self.display_data_sets(data_sets)

data/lib/ojo/manager.rb

@@ -0,0 +1,49 @@
+module Ojo
+  class Manager
+    def location
+      puts "Ojo file location: #{::Ojo.configuration.location}"
+    end
+
+    def data_sets
+      data_sets = ::Ojo::DataSets.new.sets_available
+      ::Ojo.display_data_sets(data_sets)
+    end
+
+    def clear_diff
+      FileUtils.rm_rf File.join(::Ojo.configuration.location, 'diff')
+    end
+
+    def clear_all
+      data_sets = ::Ojo::DataSets.new.sets_available
+      FileUtils.rm_rf File.join(::Ojo.configuration.location, 'diff')
+      data_sets.each { |d| FileUtils.rm_rf(File.join(::Ojo.configuration.location, d)) }
+    end
+
+    def compare(branch_1, branch_2)
+      unless branch_1 && branch_2
+        branches = ::Ojo::DataSets.new.sets_available
+        unless branch_1
+          branches.each do |branch|
+            if branch != branch_2
+              branch_1 = branch
+              break
+            end
+          end
+        end
+
+        unless branch_2
+          branches.each do |branch|
+            if branch != branch_1
+              branch_2 = branch
+              break
+            end
+          end
+        end
+      end
+
+      results = ::Ojo::Ojo.new.compare(branch_1, branch_2)
+      ::Ojo::Output.new.display_to_console results[1]
+    end
+
+  end
+end

data/lib/ojo/output.rb

@@ -1,90 +1,94 @@
 module Ojo
-  def self.display_to_console(data)
-    format_table data
+  class Output
+    include Collimator::Table
 
-    failure_count = 0
+    def display_to_console(data)
+      format_table data
 
-    data[:results].each_key do |basename|
-      file_1 = file_basename(data[:results][basename][:file_1])
-      file_2 = file_basename(data[:results][basename][:file_2])
+      failure_count = 0
 
-      color       = :blue
-      result_text = '--'
+      data[:results].each_key do |basename|
+        file_1 = file_basename(data[:results][basename][:file_1])
+        file_2 = file_basename(data[:results][basename][:file_2])
 
-      if test_performed?(data[:results][basename])
-        same = data[:results][basename][:same]
-        color = same ? :green : :red
-        result_text = same ? 'PASS' : 'FAIL'
-        failure_count += 1 unless same
-      end
-
-      one_row file_1, file_2, result_text, color
-    end
-    format_table_footer failure_count, data
-  end
-
-  private
+        color       = :blue
+        result_text = '--'
 
-  def self.format_table_footer(failure_count, data)
-    Table.footer(results_message(failure_count == 0, failure_count), :justification => :center)
-    Table.footer("Difference Files at #{File.join(data[:location], 'diff')}", :justification => :center)
+        if test_performed?(data[:results][basename])
+          same = data[:results][basename][:same]
+          color = same ? :green : :red
+          result_text = same ? 'PASS' : 'FAIL'
+          failure_count += 1 unless same
+        end
 
-    Table.tabulate
-  end
+        one_row file_1, file_2, result_text, color
+      end
+      format_table_footer failure_count, data
+    end
 
-  def self.file_basename(filename)
-    out = filename
-    out = File.basename(filename) unless out.nil?
-    out
-  end
+    private
 
-  def self.test_performed?(data)
-    !data[:same].nil?
-  end
+    def format_table_footer(failure_count, data)
+      Collimator::Table.footer(results_message(failure_count == 0, failure_count), :justification => :center)
+      Collimator::Table.footer("Difference Files at #{File.join(data[:location], 'diff')}", :justification => :center)
 
-  def self.format_table_header(data)
-    Table.header("Ojo v.#{VERSION}")
-    Table.header("file location: #{data[:location]}")
-    Table.header(Date.today.strftime('%m/%d/%Y'))
-  end
+      Collimator::Table.tabulate
+    end
 
-  def self.format_table(data)
-    format_table_header data
+    def file_basename(filename)
+      out = filename
+      out = File.basename(filename) unless out.nil?
+      out
+    end
 
-    Table.column(data[:branch_1], :width => 60, :padding => 2, :justification => :left)
-    Table.column(data[:branch_2], :width => 60, :padding => 2, :justification => :left)
-    Table.column('Results', :width => 11, :justification => :center)
-  end
+    def test_performed?(data)
+      !data[:same].nil?
+    end
 
-  def self.one_row(file_1, file_2, result_text, color)
-    max_printable_length = 50
+    def format_table_header(data)
+      Collimator::Table.header("Ojo v.#{VERSION}")
+      Collimator::Table.header("file location: #{data[:location]}")
+      Collimator::Table.header(Date.today.strftime('%m/%d/%Y'))
+    end
 
-    formatted_file_1 = make_printable_name(file_1, max_printable_length)
-    formatted_file_2 = make_printable_name(file_2, max_printable_length)
+    def format_table(data)
+      format_table_header data
 
-    row_data = [formatted_file_1, formatted_file_2, result_text]
-    Table.row(:data => row_data, :color => color)
-  end
+      Collimator::Table.column(data[:branch_1], :width => 60, :padding => 2, :justification => :left)
+      Collimator::Table.column(data[:branch_2], :width => 60, :padding => 2, :justification => :left)
+      Collimator::Table.column('Results', :width => 11, :justification => :center)
+    end
 
-  def self.results_message(same, failure_count)
-    results_message = ['Results: ']
-    results_message << 'All Same' if same
-    results_message << "#{failure_count} file#{failure_count > 1 ? 's were' : ' was'} found to be different" unless same
-    results_message.join('')
-  end
+    def one_row(file_1, file_2, result_text, color)
+      max_printable_length = 50
 
-  def self.make_printable_name(input, max_length)
-    output = input || ''
+      formatted_file_1 = make_printable_name(file_1, max_printable_length)
+      formatted_file_2 = make_printable_name(file_2, max_printable_length)
 
-    if output.length > max_length
-      how_much_too_long = output.length - max_length
-      center_of_string = output.length / 2
-      front_of_new_string = output[0..(center_of_string - how_much_too_long/2 - 3)]
-      back_of_new_string = output[(center_of_string + how_much_too_long/2 + 3)..output.length]
+      row_data = [formatted_file_1, formatted_file_2, result_text]
+      Collimator::Table.row(:data => row_data, :color => color)
+    end
 
-      output = "#{front_of_new_string}....#{back_of_new_string}"
+    def results_message(same, failure_count)
+      results_message = ['Results: ']
+      results_message << 'All Same' if same
+      results_message << "#{failure_count} file#{failure_count > 1 ? 's were' : ' was'} found to be different" unless same
+      results_message.join('')
     end
 
-    output
+    def make_printable_name(input, max_length)
+      output = input || ''
+  
+      if output.length > max_length
+        how_much_too_long = output.length - max_length
+        center_of_string = output.length / 2
+        front_of_new_string = output[0..(center_of_string - how_much_too_long/2 - 3)]
+        back_of_new_string = output[(center_of_string + how_much_too_long/2 + 3)..output.length]
+  
+        output = "#{front_of_new_string}....#{back_of_new_string}"
+      end
+  
+      output
+    end
   end
 end