compatriot 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e100d57f0086c254d7fcd46b1d615dc3ec7570a1
-  data.tar.gz: 3a474ae56359208e474ea4742b3092797e9a13e4
+  metadata.gz: b42a702d988c48093abc7cd8fe13b09d02f3943b
+  data.tar.gz: a7c9af901dc60c45d98b18a798fc5f2d81ecdac7
 SHA512:
-  metadata.gz: 1f712342dfd796f65140fadb0251325d2e44f91d698f3c58859b721b010f3ca9ddd538ff0c8eb8275860b928ddeb2bf046c46c6cca9f6c16cfc63cfce7e91c53
-  data.tar.gz: bed0d7c8323e728fa30cadbb044b9ebe8e92829978da39516f7396fa650c91e4cf2b06a402dd0a20f8d50437cb7702438d65a19d0888bb63822875e1097b18fa
+  metadata.gz: 5f179d47804b164b070ae0b94e3d7fbe08757e4e9e8b797147e4d6dd2852347b8d26657af4bfe58d33b89577d61c06cadb066e70f34afa50af544f27df5b2d22
+  data.tar.gz: 08f1c1500a97095a027b3330ea2c0329e4f3f55012f6f1cac52549cb9f5248806940ae832751d164e4fc620117ccb014be6773cf2d4bc1e216af9af02decc433

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 .DS_STORE
 spec/sample_app/chromedriver.log
 TAGS
+screenshots

data/.travis.yml

@@ -1,4 +1,13 @@
-before_script: "sh -e /etc/init.d/xvfb start && sudo add-apt-repository ppa:chromium-daily/dev && sudo aptitude update && sudo aptitude -y -q install unzip chromium-browser"
-script: "bundle exec rake travis"
+before_script:
+  - "mkdir -p /tmp/bin"
+  - "cd /tmp/bin && wget http://chromium.googlecode.com/files/chromedriver_linux32_16.0.902.0.zip && unzip chromedriver_linux32_16.0.902.0.zip && cd -"
+  - "export PATH=/tmp/bin:$PATH "
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"
+  - sleep 3 # give xvfb some time to start
+script: "bundle exec rake test"
 rvm:
   - 2.1.7
+  - 2.2.4
+sudo: false
+

data/README.md

@@ -1,6 +1,6 @@
 Compatriot
 ==========
-[![Build Status](https://secure.travis-ci.org/clnclarinet/compatriot.png?branch=master)](http://travis-ci.org/clnclarinet/compatriot)
+[![Build Status](https://secure.travis-ci.org/carols10cents/compatriot.png?branch=master)](http://travis-ci.org/carols10cents/compatriot)
 
 **Compat**ibility + **riot**! It's the **friend** that helps with browser compatibility!
 This Ruby gem makes cross-browser testing less painful.

data/Rakefile

@@ -14,13 +14,3 @@ desc "Run tests"
 task :spec do
   task("test").execute
 end
-
-task :travis do
-  puts "Grabbing chromedriver..."
-  mkdir_p "/tmp/bin"
-  system "cd /tmp/bin && wget http://chromium.googlecode.com/files/chromedriver_linux32_16.0.902.0.zip && unzip chromedriver_linux32_16.0.902.0.zip"
-
-  puts "Starting to run tests..."
-  system("export PATH=/tmp/bin:$PATH && export DISPLAY=:99.0 && bundle exec rake test && bundle exec cucumber features")
-  raise "`rake test` failed!" unless $?.exitstatus == 0
-end

data/bin/colordiff

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/compatriot/image_differ/color_differ'
+
+Compatriot::ColorDiffer.diff_to_file(ARGV[0], ARGV[1], ARGV[2])

data/compatriot.gemspec

@@ -2,15 +2,14 @@
 require File.expand_path('../lib/compatriot/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Carol Nichols"]
-  gem.email         = ["carol.nichols@gmail.com"]
-  gem.description   = 'Finds likely UI browser cross-compatibility issues.'
+  gem.authors       = ["Carol (Nichols || Goulding)", "Jeff Koenig"]
+  gem.email         = ["carol.nichols@gmail.com", "jkoenig311@gmail.com"]
+  gem.description   = 'Compare screenshots in your tests!'
   gem.summary       = %q{
-    Runs a command in multiple browsers using selenium then compares the
-    screenshots and presents those likely to have cross-browser incompatibilities.
+    Add assertions that screenshots taken during your tests do not differ from a base image. Test that the page looks the same as the last test run or that the page looks the same in multiple browsers!
   }
 
-  gem.homepage      = "https://github.com/clnclarinet/compatriot"
+  gem.homepage      = "https://github.com/carols10cents/compatriot"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
@@ -23,12 +22,11 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'minitest', '~> 5.8', '>= 5.8.2'
   gem.add_development_dependency 'sinatra', '~> 1.4', '>= 1.4.6'
   gem.add_development_dependency 'mocha', '~> 1.1', '>= 1.1.0'
-  gem.add_development_dependency 'cucumber', '~> 2.1', '>= 2.1.0'
-  gem.add_development_dependency 'aruba', '~> 0.10.0'
-  gem.add_development_dependency 'relish', '~> 0.7.1'
+  gem.add_development_dependency 'pry'
 
   gem.add_runtime_dependency 'capybara', '~> 2.5', '>= 2.5.0'
   gem.add_runtime_dependency 'selenium-webdriver', '~> 2.48', '>= 2.48.1'
   gem.add_runtime_dependency 'rake', '~> 10.4', '>= 10.4.2'
   gem.add_runtime_dependency 'chunky_png', '~> 1.3', '>= 1.3.5'
+  gem.add_runtime_dependency 'oily_png', '~> 1.2.0'
 end

data/lib/compatriot.rb

@@ -6,10 +6,51 @@ require "compatriot/image_differ/image_differ"
 
 module Compatriot
   class << self
-    attr_accessor :app
+    attr_accessor :app, :screenshot_directory
+
+    def configure
+      yield self
+    end
 
     def run(paths)
       Compatriot::Runner.start(app, paths)
     end
+
+    def take_screenshot(page, test, description)
+      filename = filename_for_test(test, description)
+      control_image_path = filepath_for_screenshot('control', filename)
+      variable_image_path = filepath_for_screenshot('variable', filename)
+
+      if File.exist?(control_image_path)
+        screenshot_type = 'variable'
+      else
+        screenshot_type = 'control'
+      end
+      temp = page.save_screenshot filepath_for_screenshot(screenshot_type, filename)
+    end
+
+    def percentage_changed(page, test, description = '')
+      variable_img_path = take_screenshot(page, test, description)
+      control_img_path = filepath_for_screenshot('control', filename_for_test(test, description))
+      diff = Compatriot::ColorDiffer.diff(variable_img_path, control_img_path, self.screenshot_directory + '/')
+      variable_image = ChunkyPNG::Image.from_file(variable_img_path)
+      Compatriot::ColorDiffer.color_difference_percentage(variable_image, diff)
+    end
+
+    def filename_for_test(test, description)
+      test_name = test.name.match(/test_[0-9]+_(.*)/)[1]
+      class_name = test.class.name
+      filename = class_name + '_' + test_name
+      filename += '_' + description unless description.empty?
+      filename.tr(' ', '_').downcase + '.png'
+    end
+
+    def filepath_for_screenshot(type, filename)
+      File.expand_path(self.screenshot_directory + '/' + type + '/' + filename)
+    end
+  end
+
+  Compatriot.configure do |config|
+    config.screenshot_directory = './compatriot/screenshots'
   end
-end
+end

data/lib/compatriot/image_differ/color_differ.rb

@@ -1,9 +1,28 @@
-require 'chunky_png'
+require 'oily_png'
 include ChunkyPNG::Color
 
 module Compatriot
   class ColorDiffer
 
+    def self.diff_to_file(filename1, filename2, output_filename)
+      image1 = ChunkyPNG::Image.from_file(filename1)
+      image2 = ChunkyPNG::Image.from_file(filename2)
+
+      output = ChunkyPNG::Image.new(image1.width, image1.height, WHITE)
+      diff = []
+
+      each_pixel(image1) do |x, y|
+        pixel1 = image1[x,y]
+        pixel2 = image2[x,y]
+        unless pixel1 == pixel2
+          output[x,y], score = color_difference_of_pixels(pixel1, pixel2)
+          diff << score
+        end
+      end
+
+      output.save(output_filename)
+    end
+
     def self.diff(filename1, filename2, results_directory)
       image1 = ChunkyPNG::Image.from_file(filename1)
       image2 = ChunkyPNG::Image.from_file(filename2)
@@ -22,6 +41,8 @@ module Compatriot
       end
 
       save_diff_image(output, filename1, filename2)
+
+      diff
     end
 
     def self.save_diff_image(output, filename1, filename2)
@@ -31,10 +52,16 @@ module Compatriot
         "diffs",
         filename
       )
+      create_directory_if_necessary(path)
       output.save(path)
       File.join("diffs", filename)
     end
 
+    def self.create_directory_if_necessary(file)
+      dir = File.dirname(file)
+      FileUtils.mkdir_p(dir) unless File.directory?(dir)
+    end
+
     def self.diff_name(image1, image2)
       browser1 = File.basename(File.dirname(image1))
       browser2 = File.basename(File.dirname(image2))
@@ -53,10 +80,9 @@ module Compatriot
     end
 
     # Not called anywhere
-    def color_difference_total_score
-      pixels_total = image1.width * image1.height
-      pixels_changed = diff.length
-      pixels_changed_percentage = (diff.inject {|sum, value| sum + value} / pixels_total) * 100
+    def self.color_difference_percentage(image, diff)
+      return 0 if diff.length == 0
+      (diff.reduce(:+) / image.pixels.length) * 100
     end
 
     def self.each_pixel(image)
@@ -67,4 +93,4 @@ module Compatriot
       end
     end
   end
-end
+end

data/lib/compatriot/version.rb

@@ -1,3 +1,3 @@
 module Compatriot
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/unit/compatriot_spec.rb

@@ -0,0 +1,91 @@
+require_relative '../spec_helper'
+require 'pry'
+
+describe Compatriot do
+  let(:class_stub)   { stub_everything('class', name: 'important_test') }
+  let(:stubbed_test) { stub_everything('test', name: 'test_001_will do something important', class: class_stub) }
+  let(:page)         { Page.new }
+
+  SCREENSHOTS_DIR      = './tmp/test/screenshots'
+  CONTROL_IMG_FILENAME = 'important_test_will_do_something_important_and_has_a_description.png'
+  CONTROL_IMG          = "#{SCREENSHOTS_DIR}/control/#{CONTROL_IMG_FILENAME}"
+  CONTROL_IMG2         = "#{SCREENSHOTS_DIR}/control/important_test_will_do_something_important_another.png"
+  VARIABLE_IMG         = "#{SCREENSHOTS_DIR}/variable/important_test_will_do_something_important_and_has_a_description.png"
+  DIFF_IMG             = "#{SCREENSHOTS_DIR}/diffs/color_variable_vs_control_important_test_will_do_something_important_and_has_a_description.png"
+
+  class Page
+    def save_screenshot filepath
+      root_dir = File.join(File.dirname(__FILE__), '../')
+      image_name = filepath.include?('control') ? '1' : '2'
+      src_img = root_dir + "/images/#{image_name}.png"
+      filepath_dir = File.dirname(filepath)
+      FileUtils.mkdir_p(filepath_dir) unless File.directory?(filepath_dir)
+      FileUtils.cp(src_img, filepath)
+      filepath
+    end
+  end
+
+  def setup_control_image
+    Page.new.save_screenshot CONTROL_IMG
+  end
+
+  before do
+    FileUtils.remove_dir(SCREENSHOTS_DIR) if File.directory?(SCREENSHOTS_DIR)
+    Compatriot.configure do |config| 
+      config.screenshot_directory = SCREENSHOTS_DIR
+    end
+  end
+
+  describe 'no control image is found' do
+    it 'it will create one' do
+      Compatriot.take_screenshot(page, stubbed_test, 'and has a description')
+      Compatriot.take_screenshot(page, stubbed_test, 'another')
+
+      assert File.exist?(CONTROL_IMG), 'control image not found'
+      assert File.exist?(CONTROL_IMG2), 'control image not found'
+    end
+  end
+
+  describe 'control image is found' do
+    before do
+      setup_control_image
+    end
+
+    it 'stores a variable image' do
+      Compatriot.take_screenshot(page, stubbed_test, 'and has a description')
+      assert File.exist?(VARIABLE_IMG)
+    end
+
+    it 'stores the image difference' do
+      Compatriot.percentage_changed(page, stubbed_test, 'and has a description')
+      assert File.exist?(DIFF_IMG)
+    end
+
+    it 'returns the percentage difference' do
+      result = Compatriot.percentage_changed(page, stubbed_test, 'and has a description')
+      assert_equal(0.81, result.round(2))
+    end
+
+    it 'returns 0 % if there is no difference' do
+      Compatriot::ColorDiffer.stubs(:diff).returns([])
+      result = Compatriot.percentage_changed(page, stubbed_test, 'and has a description')
+      assert_equal(0.0, result.round(2))
+    end
+  end
+
+  describe 'configuration' do
+    before do
+      @screenshot_directory = 'tmp/test_configuration'
+      @control_file = @screenshot_directory + '/control/' + CONTROL_IMG_FILENAME
+      Compatriot.configure do |config|
+        config.screenshot_directory = @screenshot_directory
+      end
+      FileUtils.remove_dir(@screenshot_directory) if File.directory?(SCREENSHOTS_DIR)
+    end
+
+    it 'can set the screenshot directory' do
+      Compatriot.take_screenshot(page, stubbed_test, 'and has a description')
+      assert File.exist?(@control_file), 'control image not found'
+    end
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: compatriot
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
-- Carol Nichols
+- Carol (Nichols || Goulding)
+- Jeff Koenig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -71,53 +72,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-- !ruby/object:Gem::Dependency
-  name: relish
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -198,10 +165,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.5
-description: Finds likely UI browser cross-compatibility issues.
+- !ruby/object:Gem::Dependency
+  name: oily_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Compare screenshots in your tests!
 email:
 - carol.nichols@gmail.com
-executables: []
+- jkoenig311@gmail.com
+executables:
+- colordiff
 extensions: []
 extra_rdoc_files: []
 files:
@@ -213,11 +196,9 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/colordiff
 - compatriot.gemspec
 - examples/compatriot_tests.rb
-- features/list_of_urls.feature
-- features/step_definitions/cli_steps.rb
-- features/support/env.rb
 - lib/compatriot.rb
 - lib/compatriot/browser.rb
 - lib/compatriot/image_differ/color_differ.rb
@@ -225,14 +206,17 @@ files:
 - lib/compatriot/results_presenter.rb
 - lib/compatriot/runner.rb
 - lib/compatriot/version.rb
+- spec/images/1.png
+- spec/images/2.png
 - spec/sample_app/public/images/smileyface.jpg
 - spec/sample_app/sample_app.rb
 - spec/spec_helper.rb
 - spec/unit/browser_spec.rb
+- spec/unit/compatriot_spec.rb
 - spec/unit/image_differ/color_differ_spec.rb
 - spec/unit/image_differ/image_differ_spec.rb
 - spec/unit/runner_spec.rb
-homepage: https://github.com/clnclarinet/compatriot
+homepage: https://github.com/carols10cents/compatriot
 licenses:
 - MIT
 metadata: {}
@@ -255,16 +239,17 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Runs a command in multiple browsers using selenium then compares the screenshots
-  and presents those likely to have cross-browser incompatibilities.
+summary: Add assertions that screenshots taken during your tests do not differ from
+  a base image. Test that the page looks the same as the last test run or that the
+  page looks the same in multiple browsers!
 test_files:
-- features/list_of_urls.feature
-- features/step_definitions/cli_steps.rb
-- features/support/env.rb
+- spec/images/1.png
+- spec/images/2.png
 - spec/sample_app/public/images/smileyface.jpg
 - spec/sample_app/sample_app.rb
 - spec/spec_helper.rb
 - spec/unit/browser_spec.rb
+- spec/unit/compatriot_spec.rb
 - spec/unit/image_differ/color_differ_spec.rb
 - spec/unit/image_differ/image_differ_spec.rb
 - spec/unit/runner_spec.rb

data/features/list_of_urls.feature

@@ -1,31 +0,0 @@
-Feature: list_of_urls
-
-  Passing a list of URLs to Compatriot.run will visit each of them in each browser and take a screenshot.
-
-  Scenario: List of URLs
-    Given a Sinatra app named "simple_app.rb" with:
-      """ruby
-        get '/' do
-          'Hello'
-        end
-
-        get '/goodbye' do
-          'Goodbye'
-        end
-      """
-    And a file named "compatriot_urls.rb" with:
-      """ruby
-      $:.unshift(File.expand_path('../../lib', File.dirname(__FILE__)))
-      require 'compatriot'
-      require_relative 'simple_app'
-      Compatriot.app = SimpleApp
-      Compatriot.run(%w[
-        /
-        /goodbye
-      ])
-
-      """
-    And the directory "tmp/results" does not exist
-    When I run `ruby compatriot_urls.rb`
-    Then "tmp/results" should have 1 subdirectory
-    And there should be results for 2 screenshots

data/features/step_definitions/cli_steps.rb

@@ -1,60 +0,0 @@
-module CompatriotHelpers
-  def create_sinatra_app(file_name, content)
-    app_class = camelize(file_name.gsub(/\.rb$/, ''))
-    beginning_sinatra_app = <<-HERE
-require 'sinatra/base'
-require 'rack'
-require 'yaml'
-
-class #{app_class} < Sinatra::Base
-  set :root, File.dirname(__FILE__)
-  set :static, true
-HERE
-
-    ending_sinatra_app = <<-HERE
-
-end
-
-if __FILE__ == $0
-  Rack::Handler::WEBrick.run #{app_class}, :Port => 8070
-end
-HERE
-    beginning_sinatra_app + content + ending_sinatra_app
-  end
-
-  def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
-    if first_letter_in_uppercase
-      lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
-    else
-      lower_case_and_underscored_word.to_s[0].chr.downcase + camelize(lower_case_and_underscored_word)[1..-1]
-    end
-  end
-end
-World(CompatriotHelpers)
-
-Given /^a Sinatra app named "([^"]*)" with:$/ do |file_name, content|
-  write_file(file_name, create_sinatra_app(file_name, content))
-end
-
-Then /^"([^"]*)" should have (\d+) subdir/ do |directory, subdirectory_count|
-  cd('.') {
-    expect((Dir.entries(directory) - [".", ".."]).size).to eql subdirectory_count.to_i
-  }
-end
-
-Then /^there should be results for (\d+) screenshots?$/ do |screenshot_count|
-  screenshot_count = screenshot_count.to_i
-  results_tmp_dir = "tmp/results"
-  cd('.') {
-    current_results_dir = (Dir.entries(results_tmp_dir) - [".", ".."]).first
-    current_results_dir = File.join(results_tmp_dir, current_results_dir)
-
-    firefox_dir = File.join(current_results_dir, "firefox")
-    chrome_dir  = File.join(current_results_dir, "chrome")
-    diffs_dir   = File.join(current_results_dir, "diffs")
-
-    expect(Dir.glob(File.join(firefox_dir, "*.png")).size).to eql 2
-    expect(Dir.glob(File.join(chrome_dir, "*.png")).size).to eql 2
-    expect(Dir.glob(File.join(diffs_dir, "*.png")).size).to eql 2
-  }
-end

data/features/support/env.rb

@@ -1,5 +0,0 @@
-require 'aruba/cucumber'
-
-Aruba.configure do |config|
-  config.exit_timeout = 60
-end