ojo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b932f9e50044ba852bb5d1db5183ad97edb77df
+  data.tar.gz: dcb373b8c6220e1425d2fbfedfd9da682a5bbee7
+SHA512:
+  metadata.gz: 40157f1b72198c07ad7f0324290c3dd7c3a75088d7cb3308c5710def5e9437dfd9b6a097adf3b4eb101e9aeca5826d0a8c172c99a443347b9b5a2f067147f517
+  data.tar.gz: c605a2d3b905fd30846df10150e0fc729ef1f32af06986c10df4909d10eebcfb44bb275b1d728501fa20bd0c31b15b8e8adf0d0589dcd0fb4cb0311885f4ddf2

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+/test/test_app/tmp

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "2.1.2"

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ojo.gemspec
+gemspec
+
+gem 'minitest'
+gem 'minitest-reporters'
+gem 'mocha'
+gem 'awesome_print'
+gem 'rails', '3.2.16'
+gem 'poltergeist'
+gem 'capybara'
+gem 'ae_page_objects', '1.3.0'
+gem 'sqlite3'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 geordie
+
+MIT License
+
+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,106 @@
+# Ojo
+
+Ojo is not fancy. it just does a simple comparison of two sets of screenshots. the idea is that there is a set of tests or scripts that will compile the two sets (for example, one from a master branch and another from a feature branch). running the rake task that `Ojo` adds to the rails app will tell you if the two sets of files differ. the rake task is `ojo:compare[branch_1,branch_2]`.
+
+[![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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ojo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ojo
+
+## Usage
+
+### Initialization
+
+in a rails initializer do something like this to tell `Ojo` where the files to compare are.
+
+`Ojo.location = '/path/to/screenshots'`
+
+### Screenshotter
+
+you can use whatever method of taking the screenshots you would like. Ojo has a concept of a `screenshotter`. you can define it like so:
+
+    Ojo.screenshotter = lambda do |filename|
+      # what ever method of screenshot grabbing you would like
+      # for example, using Capybara...
+      page.save_screenshot(filename)
+    end
+
+then in your script/test you can do `Ojo.screenshot(data_set, screenshot)`. using the screenshotter is not necessary.
+
+    Ojo.screenshot('master', 'login_page')
+
+ really all you need to do is end up with two sets of PNG files that have the same filenames.
+
+### Comparison
+
+After both sets of data have been run, the `Ojo` rake task `ojo:compare[branch_1,branch_2]` can be run to compare the results. as an example, let's say we were making some changes to the login page. we might have an in work `login_page_update` branch that we want to compare to our `master` branch.
+
+#### Example data sets
+
+    /master
+       /current_user.png
+       /master_only.png
+       /signed_in.png
+       /test_home.png
+       /user.png
+    /login_page_update
+       /login_update_only.png
+       /current_user.png
+       /signed_in.png
+       /test_home.png
+       /user.png
+
+#### run
+
+    >> rake ojo:compare[master,login_page_update]
+    +-----------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                               Ojo v.0.0.1                                                               |
+    |                                        file location: /Users/geordie/src/faktory/tmp/appearance                                         |
+    |                                                               10/17/2014                                                                |
+    +-----------------------------------------------------------------------------------------------------------------------------------------+
+    |  master                                                      |  login_page_update                                           |  Results  |
+    |--------------------------------------------------------------+--------------------------------------------------------------+-----------|
+    |  current_user.png                                            |  current_user.png                                            |   FAIL    |
+    |  master_only.png                                             |                                                              |    --     |
+    |  signed_in.png                                               |  signed_in.png                                               |   PASS    |
+    |  test_home.png                                               |  test_home.png                                               |   PASS    |
+    |  user.png                                                    |  user.png                                                    |   FAIL    |
+    |                                                              |  login_update_only.png                                       |    --     |
+    +-----------------------------------------------------------------------------------------------------------------------------------------+
+    |                                               Results: 2 files were found to be different                                               |
+    |                                             Difference Files at /path/to/screenshots/diff                                               |
+    +-----------------------------------------------------------------------------------------------------------------------------------------+
+
+you can see here that not everything passed (or was exactly the same) in each test case. the `user` and `current_user` cases did not pass. to investigate why, you can look at the `diff` directory under `/path/to/screenshots/`. you will see what differences were found in each test case.
+
+in addition, you can see that there were extra files in each data set. other comparisons are not affected.
+
+### Rake Tasks
+
+    rake ojo:clear:all                   # clear all ojo files INCLUDING all data sets
+    rake ojo:clear:diff                  # clear ojo results only
+    rake ojo:compare[branch_1,branch_2]  # use ojo to compare two branches
+    rake ojo:list                        # list ojo data sets
+    rake ojo:location                    # show ojo location setting
+
+the `rake ojo:compare` task can be run without any arguments as well as explicitly stating the data sets/branch names. in this case, the first two valid data sets will be used.
+
+## Contributing
+
+1. Fork it ( https://github.com/QuantumGeordie/ojo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+require 'ojo'
+
+namespace :test do
+  desc 'unit tests'
+  Rake::TestTask.new :units do |t|
+    t.libs << '.'
+    t.libs << 'test'
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.verbose = false
+  end
+end
+
+task :test => [ 'test:units' ]
+
+task :default => :test

data/lib/ojo/comparison.rb

@@ -0,0 +1,88 @@
+module Ojo
+  require 'open4'
+  require 'fileutils'
+
+  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(self.location, 'diff'))
+
+    all_same = true
+    results = { :location => self.location, :branch_1 => branch_1, :branch_2 => branch_2, :results => {} }
+
+    ProgressBar.start({:min => 0, :max => all_files.count, :method => :percent, :step_size => 1})
+
+    all_files.each do |file|
+      diff_file = File.join(self.location, 'diff', File.basename(file))
+
+      file_1 = File.join(location, branch_1, file)
+      file_2 = File.join(location, branch_2, file)
+
+      file_1 = nil unless File.exist?(file_1)
+      file_2 = nil unless File.exist?(file_2)
+
+      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.delete(diff_file) if this_same
+
+      ProgressBar.increment
+    end
+
+    ProgressBar.complete
+    [all_same, results]
+  end
+
+  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)
+    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/)
+
+    outputs.map! do |o|
+      o.strip if o.strip.start_with?('red', 'green', 'blue', 'alpha', 'all')
+    end
+    outputs.compact!
+
+    same = true
+
+    outputs.each do |o|
+      parts = o.split(' ')
+      same = same && parts[1].to_f == 0
+    end
+
+    return same
+  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}"
+
+    output = nil
+    status = Open4::popen4(imagemagick_command) do |pid, stdin, stdout, stderr|
+      output = stderr.read
+    end
+
+    output
+  end
+
+end

data/lib/ojo/locations.rb

@@ -0,0 +1,26 @@
+module Ojo
+  @location = nil
+
+  def self.location=(location)
+    @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
+  end
+
+  def self.display_data_sets(data_sets)
+    puts '~'*20 + ' Ojo ' + '~'*20
+    puts 'Data sets that can be compared:'
+    data_sets.each{ |d| puts "  #{d}"}
+    puts '~'*45
+  end
+end

data/lib/ojo/output.rb

@@ -0,0 +1,90 @@
+module Ojo
+  def self.display_to_console(data)
+    format_table data
+
+    failure_count = 0
+
+    data[:results].each_key do |basename|
+      file_1 = file_basename(data[:results][basename][:file_1])
+      file_2 = file_basename(data[:results][basename][:file_2])
+
+      color       = :blue
+      result_text = '--'
+
+      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
+
+  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)
+
+    Table.tabulate
+  end
+
+  def self.file_basename(filename)
+    out = filename
+    out = File.basename(filename) unless out.nil?
+    out
+  end
+
+  def self.test_performed?(data)
+    !data[:same].nil?
+  end
+
+  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
+
+  def self.format_table(data)
+    format_table_header data
+
+    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 self.one_row(file_1, file_2, result_text, color)
+    max_printable_length = 50
+
+    formatted_file_1 = make_printable_name(file_1, max_printable_length)
+    formatted_file_2 = make_printable_name(file_2, max_printable_length)
+
+    row_data = [formatted_file_1, formatted_file_2, result_text]
+    Table.row(:data => row_data, :color => color)
+  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 self.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

data/lib/ojo/rails/engine.rb

@@ -0,0 +1,6 @@
+module Ojo
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/ojo/screenshot.rb

@@ -0,0 +1,21 @@
+module Ojo
+
+  @screenshotter = nil
+
+  def self.screenshotter=(screenshotter)
+    @screenshotter = screenshotter
+  end
+
+  def self.screenshotter
+    @screenshotter
+  end
+
+  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
+
+    filename = File.join(location, group_name, "#{base_name}.png")
+
+    @screenshotter.call filename
+  end
+end

data/lib/ojo/version.rb

@@ -0,0 +1,3 @@
+module Ojo
+  VERSION = '0.0.1'.freeze
+end

data/lib/ojo.rb

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

data/lib/tasks/ojo.rake

@@ -0,0 +1,59 @@
+require 'fileutils'
+
+namespace :ojo do
+  desc 'use ojo to compare two branches'
+  task :compare, [:branch_1, :branch_2] => :environment do |t, args|
+    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]
+  end
+
+  desc 'show ojo location setting'
+  task :location => :environment do |t|
+    puts Ojo.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)
+  end
+
+  namespace :clear do
+    desc 'clear ojo results only'
+    task :diff => :environment do |t|
+      FileUtils.rm_rf File.join(Ojo.location, '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)) }
+    end
+
+  end
+end

data/ojo.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'ojo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ojo"
+  spec.version       = Ojo::VERSION
+  spec.authors       = ["geordie"]
+  spec.email         = ["george.speake@gmail.com"]
+  spec.summary       = %q{ojo is the eyes of the appearance test}
+  spec.description   = %q{ojo will compare a few sets of screen shots and report results.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'collimator'
+  spec.add_dependency 'open4'
+end
+

data/test/page_objects/test_app/index_page.rb

@@ -0,0 +1,8 @@
+module PageObjects
+  module TestApp
+    class IndexPage < TestAppPage
+      path '/'
+
+    end
+  end
+end

data/test/page_objects/test_app/test_app_page.rb

@@ -0,0 +1,6 @@
+module PageObjects
+  module TestApp
+    class TestAppPage < ::AePageObjects::Document
+    end
+  end
+end

data/test/page_objects.rb

@@ -0,0 +1,13 @@
+require 'ae_page_objects'
+
+ActiveSupport::Dependencies.autoload_paths << 'test'
+
+module PageObjects
+  module TestApp
+    class Site < ::AePageObjects::Site
+
+    end
+  end
+end
+
+PageObjects::TestApp::Site.initialize!

data/test/phantom/browser_test.rb

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

data/test/phantom_test_helper.rb

@@ -0,0 +1,67 @@
+ENV['RAILS_ENV'] = 'test'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '.'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rails/all'
+require 'ojo'
+require 'test_app/test_app'
+
+require 'minitest/autorun'
+
+require 'awesome_print'
+
+require 'capybara/dsl'
+require 'capybara/rails'
+require 'capybara/poltergeist'
+
+require 'page_objects'
+
+Capybara.default_driver = :poltergeist
+Capybara.javascript_driver = :poltergeist
+
+
+module OjoApp
+  class PhantomTestCase < Minitest::Test
+    include Capybara::DSL
+
+    def setup
+      Ojo.screenshotter = lambda do |filename|
+        page.save_screenshot(filename)
+        puts "Screenshot taken and saved to #{filename}"
+      end
+      Capybara.reset!
+    end
+
+    def teardown
+      Capybara.reset!
+    end
+
+    private
+
+    def screenshot_path
+      File.join(Rails.root, 'tmp', 'screenshots')
+    end
+
+    def screenshot_file(name)
+      File.join(screenshot_path, branch_name, "#{name}.png")
+    end
+
+    def branch_name
+      `git rev-parse --abbrev-ref HEAD`.chomp
+    end
+
+  end
+end

data/test/test_app/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.16'
+gem 'json'
+gem 'sqlite3'
+
+group :test, :development do
+  gem 'ojo', :path => '../..'
+end