ojo 0.0.2 → 1.0.0

data/lib/ojo/screenshot.rb

@@ -12,9 +12,9 @@ module Ojo
 
   def self.screenshot(group_name, base_name)
     raise 'No screenshot method defined for Ojo.screenshoter!' unless @screenshotter
-    raise 'No screenshot location defined for Ojo.location!' unless @location
+    raise 'No screenshot location defined for Ojo.location!' unless ::Ojo.configuration.location
 
-    filename = File.join(location, group_name, "#{base_name}.png")
+    filename = File.join(::Ojo.configuration.location, group_name, "#{base_name}.png")
 
     @screenshotter.call filename
   end

data/lib/ojo/version.rb

@@ -1,3 +1,3 @@
 module Ojo
-  VERSION = '0.0.2'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/tasks/ojo.rake

@@ -6,53 +6,28 @@ namespace :ojo do
     branch_1 = args.fetch(:branch_1, nil)
     branch_2 = args.fetch(:branch_2, nil)
 
-    unless branch_1 && branch_2
-      branches = Ojo.get_data_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.compare(branch_1, branch_2)
-    Ojo.display_to_console results[1]
+    Ojo::Manager.new.compare(branch_1, branch_2)
   end
 
   desc 'show ojo location setting'
   task :location => :environment do |t|
-    puts Ojo.location
+    Ojo::Manager.new.location
   end
 
   desc 'list ojo data sets'
   task :list => :environment do |t|
-    data_sets = Ojo.get_data_sets_available
-    Ojo.display_data_sets(data_sets)
+    Ojo::Manager.new.data_sets
   end
 
   namespace :clear do
     desc 'clear ojo results only'
     task :diff => :environment do |t|
-      FileUtils.rm_rf File.join(Ojo.location, 'diff')
+      Ojo::Manager.new.clear_diff
     end
 
     desc 'clear all ojo files INCLUDING all data sets'
     task :all => :environment do |t|
-      data_sets = Ojo.get_data_sets_available
-      FileUtils.rm_rf File.join(Ojo.location, 'diff')
-      data_sets.each { |d| FileUtils.rm_rf(File.join(Ojo.location, d)) }
+      Ojo::Manager.new.clear_all
     end
 
   end

data/test/phantom/browser_test.rb

@@ -2,8 +2,7 @@ require 'phantom_test_helper'
 
 class TestAppTest < OjoApp::PhantomTestCase
   def test_index_page
-    index_page = PageObjects::TestApp::IndexPage.visit
-
+    PageObjects::TestApp::IndexPage.visit
     Ojo.screenshot(branch_name, __method__)
   end
 end

data/test/test_app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    ojo (0.0.1)
+    ojo (0.0.2)
       collimator
       open4
 

data/test/test_app/config/initializers/ojo_initializer.rb

@@ -1 +1,3 @@
-Ojo.location = File.join(Rails.root, 'tmp', 'ojo_data')
+::Ojo.configure do |c|
+  c.location = File.join(Rails.root, 'tmp', 'ojo_data')
+end

data/test/test_helper.rb

@@ -1,3 +1,8 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
 require 'rubygems'
 require 'bundler'
 
@@ -27,6 +32,8 @@ require 'open4'
 
 require File.expand_path('../../lib/ojo', __FILE__)
 
+Ojo.configure
+
 module Ojo
   class OjoTestCase < Minitest::Test
 
@@ -54,6 +61,29 @@ module Ojo
       raise "generate image: #{err}" unless status.success?
     end
 
+    def create_location_directories
+      @location = File.absolute_path('../../tmp', __FILE__)
+      @branch_1 = File.join(@location, 'branch_1')
+      @branch_2 = File.join(@location, 'branch_2')
+
+      FileUtils.mkdir_p(@branch_1)
+      FileUtils.mkdir_p(@branch_2)
+
+      ::Ojo.configuration.location = @location
+    end
+
+    def remove_location_directories
+      FileUtils.rm_rf Dir[File.join(@location, '*')]
+    end
+
+    def capture_output
+      out = StringIO.new
+      $stdout = out
+      yield
+      return out
+    ensure
+      $stdout = STDOUT
+    end
 
   end
 end

data/test/unit/comparison_test.rb

@@ -7,6 +7,7 @@ class ComparisonTest < Ojo::OjoTestCase
     create_location_directories
     Collimator::ProgressBar.stubs(:put_current_progress)
     Collimator::ProgressBar.stubs(:complete)
+    @ojo = Ojo::Ojo.new
   end
 
   def teardown
@@ -29,7 +30,7 @@ class ComparisonTest < Ojo::OjoTestCase
     generate_image_with_shapes(file_2, '200x200', shapes)
     assert File.exist?(file_2)
 
-    r = Ojo.compare('branch_1', 'branch_2')
+    r = @ojo.compare('branch_1', 'branch_2')
 
     assert r[0], 'the all_pass status'
     assert_equal @location, r[1][:location]
@@ -62,7 +63,7 @@ class ComparisonTest < Ojo::OjoTestCase
     generate_image_with_shapes(file_2, '200x200', shapes)
     assert File.exist?(file_2)
 
-    r = Ojo.compare('branch_1', 'branch_2')
+    r = @ojo.compare('branch_1', 'branch_2')
 
     refute r[0], 'the all_pass status'
     assert_equal @location, r[1][:location]
@@ -84,14 +85,14 @@ class ComparisonTest < Ojo::OjoTestCase
     shapes << "rectangle 30,10 100,60"
 
     file_1 = File.join(@branch_1, 'test_one.png')
-    generate_image_with_shapes(file_1, '200x200', shapes)
+    generate_image_with_shapes(file_1, '205x200', shapes)
     assert File.exist?(file_1)
 
     file_2 = File.join(@branch_2, 'test_one.png')
     generate_image_with_shapes(file_2, '200x210', shapes)
     assert File.exist?(file_2)
 
-    r = Ojo.compare('branch_1', 'branch_2')
+    r = @ojo.compare('branch_1', 'branch_2')
 
     refute r[0], 'the all_pass status'
     assert_equal @location, r[1][:location]
@@ -123,7 +124,7 @@ class ComparisonTest < Ojo::OjoTestCase
     file_2_3 = File.join(@branch_2, 'file_three.png')
     generate_image_with_shapes(file_2_3, '200x220', shapes)
 
-    r = Ojo.compare('branch_1', 'branch_2')
+    r = @ojo.compare('branch_1', 'branch_2')
 
     assert r[0], 'the all_pass status'
     assert_equal @location, r[1][:location]
@@ -136,7 +137,7 @@ class ComparisonTest < Ojo::OjoTestCase
     generate_image_with_shapes(file_1_4, '50x50', ["rectangle 22,12 24,14"])
     generate_image_with_shapes(file_2_4, '50x50', ["rectangle 20,10 22,12"])
 
-    r = Ojo.compare('branch_1', 'branch_2')
+    r = @ojo.compare('branch_1', 'branch_2')
 
     refute r[0], 'the all_pass status'
     assert_equal @location, r[1][:location]
@@ -156,7 +157,7 @@ class ComparisonTest < Ojo::OjoTestCase
     assert_equal nil,   r[1][:results][File.basename(file_2_3)][:same]
     assert_equal false, r[1][:results][File.basename(file_1_4)][:same]
 
-    diff_location = File.join(Ojo.location, 'diff')
+    diff_location = File.join(Ojo.configuration.location, 'diff')
     assert_equal 1, Dir[File.join(diff_location, '*.png')].count
     refute File.exist?(File.join(diff_location, File.basename(file_1_1)))
     refute File.exist?(File.join(diff_location, File.basename(file_1_2)))
@@ -164,22 +165,4 @@ class ComparisonTest < Ojo::OjoTestCase
     assert File.exist?(File.join(diff_location, File.basename(file_1_4)))
   end
 
-  private
-
-  def create_location_directories
-    @location = File.expand_path('../../tmp')
-    @branch_1 = File.join(@location, 'branch_1')
-    @branch_2 = File.join(@location, 'branch_2')
-
-    FileUtils.mkdir_p(@branch_1)
-    FileUtils.mkdir_p(@branch_2)
-
-    Ojo.location = @location
-  end
-
-  def remove_location_directories
-    FileUtils.rm_rf(@branch_1)
-    FileUtils.rm_rf(@branch_2)
-    FileUtils.rm_rf(File.join(@location, 'diff'))
-  end
 end

data/test/unit/config_test.rb

@@ -3,7 +3,7 @@ require_relative '../test_helper'
 class ConfigTest < Ojo::OjoTestCase
 
   def test_locations
-    Ojo.location = File.expand_path('../../tmp')
-    assert_equal File.expand_path('../../tmp'), Ojo.location
+    Ojo.configuration.location = File.expand_path('../../tmp')
+    assert_equal File.expand_path('../../tmp'), Ojo.configuration.location
   end
 end

data/test/unit/data_sets_test.rb

@@ -0,0 +1,38 @@
+require_relative '../test_helper'
+
+class DataSetsTest < Ojo::OjoTestCase
+  def setup
+    create_location_directories
+    @data_sets = ::Ojo::DataSets.new
+  end
+
+  def teardown
+    remove_location_directories
+  end
+
+  def test_data_sets
+    sets_available = @data_sets.sets_available
+
+    assert_equal 2, sets_available.length
+    assert_includes sets_available, 'branch_1'
+    assert_includes sets_available, 'branch_2'
+  end
+
+  def test_data_sets__lots
+    branch_3 = File.join(@location, 'branch_3')
+    branch_4 = File.join(@location, 'branch_4')
+    diff = File.join(@location, 'diff')
+
+    FileUtils.mkdir_p(branch_3)
+    FileUtils.mkdir_p(branch_4)
+    FileUtils.mkdir_p(diff)
+
+    sets_available = @data_sets.sets_available
+    assert_equal 4, sets_available.length
+    assert_includes sets_available, 'branch_1'
+    assert_includes sets_available, 'branch_2'
+    assert_includes sets_available, 'branch_3'
+    assert_includes sets_available, 'branch_4'
+    refute_includes sets_available, 'diff'
+  end
+end

data/test/unit/files_test.rb

@@ -5,7 +5,7 @@ class FilesTest < Ojo::OjoTestCase
     files_src_1 = %w(one two three four five)
     files_src_2 = files_src_1.dup
 
-    all_files = Ojo.send(:compile_file_lists, files_src_1, files_src_2)
+    all_files = Ojo::Ojo.new.send(:compile_file_lists, files_src_1, files_src_2)
 
     assert_equal files_src_1, all_files
     assert_equal files_src_2, all_files
@@ -15,7 +15,7 @@ class FilesTest < Ojo::OjoTestCase
     files_src_1 = %w(one two three four five)
     files_src_2 = %w(six seven eight)
 
-    all_files = Ojo.send(:compile_file_lists, files_src_1, files_src_2)
+    all_files = Ojo::Ojo.new.send(:compile_file_lists, files_src_1, files_src_2)
 
     assert_equal %w(one two three four five six seven eight), all_files
   end
@@ -24,7 +24,7 @@ class FilesTest < Ojo::OjoTestCase
     files_src_1 = %w(one two three four five)
     files_src_2 = %w(four five six seven)
 
-    all_files = Ojo.send(:compile_file_lists, files_src_1, files_src_2)
+    all_files = Ojo::Ojo.new.send(:compile_file_lists, files_src_1, files_src_2)
 
     assert_equal %w(one two three four five six seven), all_files
   end

data/test/unit/image_magician_test.rb

@@ -0,0 +1,34 @@
+require_relative '../test_helper'
+
+class ImageMagicianTest < Ojo::OjoTestCase
+
+  def setup
+    @image_magician = ::Ojo::ImageMagician.new
+  end
+
+  def test_get_color_values
+    raw = raw_string('1', '22', '303', '4044')
+    color_values = @image_magician.send(:get_color_values, raw)
+
+    assert_equal '1', color_values[:red]
+    assert_equal '22', color_values[:green]
+    assert_equal '303', color_values[:blue]
+    assert_equal '4044', color_values[:all]
+  end
+
+  def test_unpack_comparison_result
+    assert @image_magician.unpack_comparison_result(raw_string('0', '0', '0', '0')),         'all colors equal 0'
+
+    refute @image_magician.unpack_comparison_result(raw_string('123', '234', '345', '456')), 'all colors greater than 0'
+    refute @image_magician.unpack_comparison_result(raw_string('123', '0', '0', '0')),       'red greater than 0'
+    refute @image_magician.unpack_comparison_result(raw_string('0', '234', '0', '0')),       'green greater than 0'
+    refute @image_magician.unpack_comparison_result(raw_string('0', '0', '345', '0')),       'blue greater than 0'
+    refute @image_magician.unpack_comparison_result(raw_string('0', '0', '0', '456')),       "'all' greater than 0"
+  end
+
+  private
+
+  def raw_string(red, green, blue, all)
+    "/Users/someone/branch_1/test_one.png PNG 200x200 200x200+0+0 16-bit sRGB 1.04KB 0.000u 0:00.000\n/Users/someone/branch_2/test_one.png PNG 200x200 200x200+0+0 16-bit sRGB 1.05KB 0.000u 0:00.000\nImage: /Users/someone/branch_1/test_one.png\n  Channel distortion: AE\n    red: #{red}\n    green: #{green}\n    blue: #{blue}\n    all: #{all}\n/Users/someone/branch_1/test_one.png=>/Users/someone/diff/test_one.png PNG 200x200 200x200+0+0 16-bit sRGB 6c 1.18KB 0.010u 0:00.000\n"
+  end
+end

data/test/unit/manager_test.rb

@@ -0,0 +1,163 @@
+require_relative '../test_helper'
+
+class ManagerTest < Ojo::OjoTestCase
+
+  def setup
+    create_location_directories
+    @manager = ::Ojo::Manager.new
+  end
+
+  def teardown
+    remove_location_directories
+    $stdout = STDOUT
+  end
+
+  def test_locations
+    out = capture_output do
+      @manager.location
+    end
+
+    assert_match Ojo.configuration.location, out.string.strip
+  end
+
+  def test_data_sets
+    out = capture_output do
+      @manager.data_sets
+    end
+
+    sa = out.string.split("\n")
+
+    assert_equal '~~~~~~~~~~~~~~~~~~~~ Ojo ~~~~~~~~~~~~~~~~~~~~', sa[0]
+    assert_equal 'Data sets that can be compared:',               sa[1]
+    assert_equal '  branch_1',                                    sa[2]
+    assert_equal '  branch_2',                                    sa[3]
+    assert_equal '~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~', sa[4]
+  end
+
+  def test_clear__diff
+    make_some_temp_files
+
+    assert File.exist?(@temp_diff_filename)
+    assert File.exist?(@filename_1)
+    assert File.exist?(@filename_2)
+
+    @manager.clear_diff
+
+    refute File.exist?(@temp_diff_filename)
+    assert File.exist?(@filename_1)
+    assert File.exist?(@filename_2)
+  end
+
+  def test_clear__all
+    make_some_temp_files
+
+    assert File.exist?(@temp_diff_filename)
+    assert File.exist?(@filename_1)
+    assert File.exist?(@filename_2)
+
+    @manager.clear_all
+
+    refute File.exist?(@temp_diff_filename)
+    refute File.exist?(@filename_1)
+    refute File.exist?(@filename_2)
+  end
+
+  def test_compare
+    make_some_real_files
+    Collimator::ProgressBar.stubs(:put_current_progress)
+    Collimator::ProgressBar.stubs(:complete)
+
+    branch_1_name = @branch_1.split('/').last
+    branch_2_name = @branch_2.split('/').last
+
+    out = capture_output do
+      Date.stub :today, Date.parse('1/10/2014') do
+        @manager.compare branch_1_name, branch_2_name
+      end
+    end
+
+    assert_compare_output out.string, %w(branch_1 branch_2)
+  end
+
+  def test_compare__missing_branch_names
+    make_some_real_files
+    Collimator::ProgressBar.stubs(:put_current_progress)
+    Collimator::ProgressBar.stubs(:complete)
+
+    branch_1_name = @branch_1.split('/').last
+    branch_2_name = @branch_2.split('/').last
+
+    out = capture_output do
+      Date.stub :today, Date.parse('1/10/2014') do
+        @manager.compare nil, branch_2_name
+      end
+    end
+    assert_compare_output out.string, %w(branch_1 branch_2)
+
+    out = capture_output do
+      Date.stub :today, Date.parse('1/10/2014') do
+        @manager.compare branch_1_name, nil
+      end
+    end
+    assert_compare_output out.string, %w(branch_1 branch_2)
+
+    branch_1a = File.join(@location, 'branch_1a')
+    FileUtils.mkdir_p(branch_1a)
+    file_1a = File.join(branch_1a, 'test_one.png')
+    generate_one_real_file file_1a
+
+    out = capture_output do
+      Date.stub :today, Date.parse('1/10/2014') do
+        @manager.compare nil, nil
+      end
+    end
+    assert_compare_output out.string, %w(branch_1 branch_1a)
+  end
+
+  private
+
+  def assert_compare_output(output_string, branch_names)
+    sa = output_string.split("\n")
+
+    assert_equal '+-----------------------------------------------------------------------------------------------------------------------------------------+', sa[0]
+    assert_match 'Ojo v.',                                                                                                                                      sa[1]
+    assert_match 'file location:',                                                                                                                              sa[2]
+    assert_equal '|                                                               10/01/2014                                                                |', sa[3]
+    assert_equal '+-----------------------------------------------------------------------------------------------------------------------------------------+', sa[4]
+    assert_match branch_names.first,                                                                                                                            sa[5]
+    assert_match branch_names.last,                                                                                                                             sa[5]
+    assert_equal '|--------------------------------------------------------------+--------------------------------------------------------------+-----------|', sa[6]
+    assert_equal "|  \e[1;32mtest_one.png\e[0m                                                |  \e[1;32mtest_one.png\e[0m                                                |   \e[1;32mPASS\e[0m    |", sa[7]
+    assert_equal '+-----------------------------------------------------------------------------------------------------------------------------------------+', sa[8]
+    assert_equal '|                                                            Results: All Same                                                            |', sa[9]
+    assert_match 'Difference Files at',                                                                                                                         sa[10]
+    assert_equal '+-----------------------------------------------------------------------------------------------------------------------------------------+', sa[11]
+  end
+
+  def make_some_real_files
+    file_1 = File.join(@branch_1, 'test_one.png')
+    file_2 = File.join(@branch_2, 'test_one.png')
+    generate_one_real_file file_1
+    generate_one_real_file file_2
+  end
+
+  def generate_one_real_file(name)
+    shapes = []
+    shapes << "rectangle 20,0 190,190"
+    shapes << "rectangle 30,10 100,60"
+
+    generate_image_with_shapes(name, '200x200', shapes)
+  end
+
+  def make_some_temp_files
+    @temp_diff_location = File.join(Ojo.configuration.location, 'diff')
+    @temp_diff_filename = File.join(@temp_diff_location, 'some_test_diff.txt')
+    FileUtils.mkdir_p @temp_diff_location
+    File.open(@temp_diff_filename, 'w') { |f| f.write '' }
+
+    @filename_1 = File.join(@branch_1, 'some_test.txt')
+    @filename_2 = File.join(@branch_2, 'some_test.txt')
+    File.open(@filename_1, 'w') { |f| f.write '' }
+    File.open(@filename_2, 'w') { |f| f.write '' }
+  end
+end